# Website Metadata and Favicon API
Retrieve website metadata and a verified favicon URL.
## API Overview
- **HTTP Protocol:** HTTPS
- **HTTP Method:** GET
- **HTTP Endpoint:** https://api.gugudata.io/v1/websitetools/favicon
- **Response Type:** application/json; charset=utf-8
- **DEMO Endpoint:** https://api.gugudata.io/v1/websitetools/favicon/demo
- **Live Demo:** https://gugudata.io/demo/favicon
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/favicon/llm
- **Raw Markdown:** https://gugudata.io/details/favicon/llm.md
## Remote MCP
- **MCP Endpoint:** https://mcp.gugudata.io/mcp
- **MCP Guide:** https://gugudata.io/mcp/
- **Authorization:** OAuth authorization opens in the browser; do not paste appkeys into MCP clients.
- **Tool Scope:** MCP clients receive GuGuData API tools available to the authorized account.
## Data & API Features
- Four-field website profile: Receive the page title, verified favicon URL, description, and keywords in one compact response.
- Verified favicon links: Use a real, accessible image URL instead of an unusable inline or placeholder icon value.
- Graceful no-icon results: Keep the available page metadata and receive favicon: null when no usable website icon exists.
- Domains and webpage URLs: Look up bare domains or public HTTP(S) pages, including internationalized domain names.
- Richer previews and profiles: Improve bookmarks, link cards, company records, directories, and discovery interfaces.
- Predictable automation behavior: Handle invalid input and unavailable websites with clear outcomes for production workflows.
## API Request Parameters
| Name | Type | Is Required | Default Value | Remark |
| --- | --- | --- | --- | --- |
| appkey | string | true | YOUR_APPKEY | API key used to authenticate the request. |
| url | string | true | https://gugudata.io/ | Public HTTP or HTTPS webpage URL or domain. Domains without a scheme use HTTPS. |
## API Response Parameters
| Name | Type | Remark |
| --- | --- | --- |
| dataStatus.requestParameter | string | Privacy-safe summary of the normalized request. |
| dataStatus.statusCode | integer | Application-level status code. |
| dataStatus.status | string | Application-level result status. |
| dataStatus.statusDescription | string | Human-readable application status message. |
| dataStatus.responseDateTime | string | Time at which the response was generated. |
| dataStatus.dataTotalCount | integer | Number of matching or returned records for this request. |
| data.title | string | Website title, or an empty string when unavailable. |
| data.favicon | string \| null | Verified public favicon URL, or null when no usable icon is available. |
| data.description | string | Website meta description, or an empty string when unavailable. |
| data.keywords | string | Website meta keywords, or an empty string when unavailable. |
## API Response Status Codes
| Status Code | Explanation of Status Code | Remarks |
| --- | --- | --- |
| 200 | Request processed successfully. | Some endpoints expose a separate application-level status field in the response body, such as `dataStatus.statusCode`. |
| 400 | Invalid request parameters or request format. | Check required fields, data types, and request body format. |
| 401 | Missing or unknown application key. | Provide a valid `appkey` with the request. |
| 403 | The application key is recognized but access is not allowed. | The key may be expired, inactive, or not permitted for the requested API. |
| 429 | Request rate or trial usage limit exceeded. | Reduce request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue. |
| 500 | Internal service error. | Retry later or contact support if the error persists. |
| 503 | Upstream service unavailable. | Retry later; the requested upstream dependency is temporarily unavailable. |
## cURL Example
```bash
curl --location 'https://api.gugudata.io/v1/websitetools/favicon?appkey=YOUR_APPKEY&url=https%3A%2F%2Fgugudata.io%2F'
```