Skip to content

Favicon API

The Favicon API returns a site favicon as an image. It is useful when you want to display a website icon directly from a URL.

Response Format

This endpoint returns an image, not JSON. The image is generated from the url query parameter.

Request Parameter:

  • url (string), required, the website URL to fetch the favicon from.

Authentication Methods

This endpoint is publicly accessible and does not require authentication.

Characteristics:

  • No authentication required
  • Direct image output
  • Useful for website previews and embeds
  • Returns the favicon for the supplied site URL

Usage:

curl "https://api.tylermwise.uk/v1/favicon?url=https://tylermwise.uk"

Endpoint

GET /v1/favicon

Example Request

curl "https://api.tylermwise.uk/v1/favicon?url=https://tylermwise.uk"

Direct URL Example

https://api.tylermwise.uk/v1/favicon?url=https://tylermwise.uk

HTML Embed Example

<img src="https://api.tylermwise.uk/v1/favicon?url=https://tylermwise.uk" alt="Favicon for tylermwise.uk">

Query Parameters

Parameter Type Required Description
url string Yes The website URL to fetch the favicon from.

Notes

  • The endpoint returns the favicon image for the target website.
  • You can embed the URL directly in an <img> tag.
  • This is useful for profile cards, directory listings, and site previews.

HTTP Status Codes

Standard responses may include:

  • 200 - Success.
  • 400 - Bad Request.
  • 429 - Too Many Requests.
  • 500 - Internal Server Error.

Versioning

This page documents version 1 of the Favicon API, available under the /v1/ path.