Home Documentation Status Contact Support Sign In / Sign Up Get API Key

Tabicon API Documentation

Fetch icons from any website with one GET request. Suitable for directory sites, content aggregators, CMS backends, and SaaS consoles. Structured by parameters, examples, and status codes for efficient integration.

GET /api/get?url=example.com&size=128&key=YOUR_KEY
Quick Start Parameters Response Status

Quick Start

Successful requests return image/png and can be used directly as an URL. Validation failures return corresponding status codes and plain-text reasons. Accessing /api/get without url returns service health text.

GET https://www.favicon.org.cn/api/get?url=TARGET_SITE_DOMAIN&size=128&key=YOUR_KEY
<img src="https://www.favicon.org.cn/api/get?url=TARGET_SITE_DOMAIN&size=128&key=YOUR_KEY" alt="Favicon of TARGET_SITE_DOMAIN" />

Parameters

url Required
Target domain or URL, e.g. `apple.com` or `https://github.com`.
size Optional
Output size supports `16/32/48/64/96/128/256/512`. Default is `64`; unsupported values automatically fallback to `64`.
key Optional
API key. A valid key is required by default; only optional when guest mode is enabled and a default demo key is configured.

Response Status

  • 200 Request succeeded; returns `image/png` icon data.
  • 400 Invalid parameter: malformed `url`.
  • 403 Unauthorized or policy rejected (missing/invalid key, private-network URL, whitelist mismatch).
  • 404 No available icon found on target site.
  • 426 Target policy requires HTTPS.
  • 429 Too many requests. Please retry later.
  • 500 Internal service error (cache path/write failure).
Back to Home View Service Status Contact Support