# Website Favicon Extraction API Documentation


# Get Any Site Title and Favicon API

> **Category**: Web Tools  
> **Endpoint**: GET [https://api.gugudata.io/v1/websitetools/favicon](https://api.gugudata.io/v1/websitetools/favicon)  
> **Description**: Parses a website's title and favicon.

## Overview

The **Get Any Site Title and Favicon API** by [GuGuData](https://gugudata.io/) is a convenient tool that **retrieves a site's title** and **favicon URL** in milliseconds. Its flexible parsing mechanism supports **multiple site configuration rules**, ensuring compatibility with various web pages. This API is particularly helpful for building link previews, bookmark managers, or any application requiring quick access to a site's **essential branding elements**.

**Key highlights**:

- **Supports any URL** – Automatically handles different favicon path conventions.
- **Site title & favicon** – Provides the primary title and a direct link to the favicon image.
- **HTTPS/TLS ready** – Fully compatible with TLS v1.0 to v1.3 and Apple ATS.
- **CDN-based architecture** – Nationwide multi-node deployment ensures speed and reliability.

## Demo URL

[https://api.gugudata.io/v1/websitetools/favicon/demo](https://api.gugudata.io/v1/websitetools/favicon/demo)

## Request Parameters

Send a **GET** request to the endpoint with the following query parameters:

| **Parameter** | **Type** | **Required** | **Default Value** | **Description**                                                    |
| :-----------: | :------: | :----------: | :---------------: | :----------------------------------------------------------------- |
|   `appkey`    | `string` |     Yes      |   `YOUR_APPKEY`   | Your unique APPKEY from GuGuData's Developer Center.               |
|     `url`     | `string` |     Yes      |   `YOUR_VALUE`    | A valid, accessible website URL from which to extract information. |

## Response Parameters

The API returns JSON containing the site's title and favicon. Below is a summary of the main fields:

|         **Parameter**          | **Type**  | **Required** |               **Description**                |
| :----------------------------: | :-------: | :----------: | :------------------------------------------: |
| `dataStatus.requestParameter`  | `string`  |     Yes      |         The requested URL parameter.         |
|    `dataStatus.statusCode`     | `integer` |     Yes      |            The HTTP status code.             |
|      `dataStatus.status`       | `string`  |     Yes      |  The request status (e.g., _OK_, _Error_).   |
| `dataStatus.statusDescription` | `string`  |     Yes      |     A description of the request status.     |
| `dataStatus.responseDateTime`  | `string`  |     Yes      |    The timestamp when data was returned.     |
|  `dataStatus.dataTotalCount`   | `integer` |     Yes      |   The total number of returned data items.   |
|          `data.title`          | `string`  |     Yes      |            The site's main title.            |
|         `data.favicon`         | `string`  |     Yes      | A direct URL pointing to the site's favicon. |

## Error Codes

You may encounter the following error codes:

| **Error Code** |     **Error Content**     | **Notes**                                                        |
| :------------: | :-----------------------: | :--------------------------------------------------------------- |
|     `200`      |       Normal return       | Indicates a successful request.                                  |
|     `400`      |      Parameter error      | Check for valid parameters (e.g., missing or malformed `url`).   |
|     `429`      | Request frequency limited | Exceeded the rate limit of 100 requests per second.              |
|     `403`      |    Account in arrears     | Resolve any payment issues to restore account functionality.     |
|     `402`      |       APPKEY error        | Verify your APPKEY matches the one in your Developer Center.     |
|     `500`      |    API response error     | A generic server error; retry or contact support if it persists. |

## Features

1. **Fetch titles and favicons from any site** – Automatically adapts to various site structures.
2. **Direct site link for the favicon** – No further parsing required.
3. **Full HTTPS (TLS v1.0–v1.3) support** – Ensures secure communication.
4. **Apple ATS compatibility** – Perfect for iOS/macOS integrations.
5. **Nationwide multi-node CDN** – Low-latency responses and high availability.
6. **Ultra-fast response** – Built on load-balanced servers for handling high concurrency.

## Additional Notes for Developers

- **Favicon extraction**: Dynamically locates the optimal favicon link, including unconventional naming or paths.
- **Flexible usage**: Ideal for social media preview, bookmark tools, or content indexing.
- **HTTPS**: Recommended for maximum data privacy and reliability.

## Getting Started

1. **Sign up at [GuGuData.io](https://gugudata.io/)** – Obtain your `appkey`.
2. **Construct a GET request** – Include `appkey` and `url` in the query parameters.
3. **Check the JSON response** – Extract the site's title and favicon link.
4. **Integrate** – Use these details in link previews, bookmark listings, or site dashboards.

## About GuGuData

[**GuGuData**](https://gugudata.io/) has delivered **high-performance APIs** globally for nearly a decade. Our suite of solutions spans [SSL Certificate Parsing](https://gugudata.io/), [DNS Lookups](https://gugudata.io/), [Content Extraction](https://gugudata.io/), and more. We meticulously **organize, clean, and integrate** large data sets, allowing clients to focus on growth and innovation.

**Key Highlights**:

- **Nine years in business** – Proven track record of reliability and innovation.
- **4.2k+ APIs** – An extensive library of data-driven functionalities.
- **95% happy customers** – Committed to excellence in both product and support.

Leverage the **Get Any Site Title and Favicon API** to **accelerate** website link preview generation or content management workflows. Visit [our official site](https://gugudata.io/) to discover more data solutions from GuGuData.

