API reference

One endpoint, three knobs, two auth modes.

Endpoint

GET https://dev-api.clearlogo.dev/logo/:domain

:domain is a bare hostname (no scheme, no path), e.g. github.com. Returns image/png.

Name	Type	Default	Notes
size	number	256	Output dimension in px. Square. Min 16, max 1024.
content	number	80	Logo footprint inside the canvas (50–100, step 5).
bg	white \| black \| transparent	white	Fallback only. Original background wins when present.`transparent` is beta.
token	pk_live_…	—	Public key for browser usage. Origin/Referer must match an allowed domain on the key.

Anonymous use is allowed at low rates. For production, attach a key:

Browser (pk_live)

<img
  src="https://dev-api.clearlogo.dev/logo/example.com
    ?token=pk_live_xxxxxxxx"
  alt="" />

Server (sk_live)

curl \
  -H "Authorization: Bearer sk_live_xxx" \
  "https://dev-api.clearlogo.dev/logo/example.com"

Per-key limits are returned in X-RateLimit-* headers. When exceeded the API responds with 429 and a Retry-After hint.