Favicons_
Fetch favicons from remote websites for link previews and bookmark displays.
2 min read
The favicon endpoint retrieves favicons from remote websites. This is useful for displaying website icons in link previews, bookmarks, and social sharing interfaces.
Get favicon
Retrieve a favicon from a remote website URL.
Parameters
The getFavicon method accepts the following parameters:
| Parameter | Type | Description |
|---|---|---|
| url | string | The URL of the website to fetch the favicon from. Must be a valid HTTP or HTTPS URL. |
| width | integer | The width of the output image in pixels. Accepts values between 0-2000. |
| height | integer | The height of the output image in pixels. Accepts values between 0-2000. |
Favicon retrieval
The service automatically attempts to retrieve favicons from common locations on the target website, including standard favicon paths and HTML meta tags.
Use cases
Favicons are commonly used for:
- Link previews: Display website icons in link preview cards and social sharing
- Bookmarks: Show website icons in bookmark lists and collections
- Referral tracking: Display source website icons in analytics and referral reports
- Content aggregation: Show website icons in RSS feed readers and content aggregators
- Social media: Display website icons in social media link previews and embeds
Was this page helpful?
Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.