LogoRouterDocs

Logo endpoint

CDN and REST semantics for raster + SVG logos, query parameters, response headers, and legacy aliases.

Canonical surfaces:

GET https://img.logorouter.com/{domain}?size=128&format=webp
GET https://api.logorouter.com/api/{domain}?size=128
GET https://api.logorouter.com/v1/{domain}               # Dashboard + SDK compat alias (same semantics)
GET https://api.logorouter.com/v1/logos/{domain}

Prefer img.logorouter.com in <img> embeds whenever you rely on ?token= publishable keys — the API hostname is optimised for deterministic server fetches (Authorization / x-api-key).

Operation-level docs (parameters, responses, examples) live inline in openapi.json under the getLogoByDomain operation.

Query reference

Aligned with openapi.json component parameters (always re-fetch in CI):

ParameterValues / shapeBehaviour
domain (path)Public hostname (stripe.com)Normalised apex; CDN path segment mirrors REST.
size16 … 2048 (defaults 128)Edge length clamp versus plan entitlement.
formatpng, webp, jpg, jpeg, svgRaster vs vector selection; CDN may downgrade gracefully.
retinaboolean (false)Signals double-density exports when artefacts exist or can be synthesized.
themelight, dark — default lightMonochrome / monogram thematic variants tied to deterministic sprite rules.
fallbackmonogram (default), 404, placeholderWhat to synthesize when authoritative artwork is unavailable.
greyscaleboolean (false)Final-step desaturate for subdued UI treatments.
refreshboolean (false)Bypass warm layers when entitlement allows (secret tiers / feature flags only).

Anonymous previews honour the CDN demo envelope (~≤128 px) with shared IP throttles. Attach any key (publishable acceptable for raster GET routes) once you graduate from prototypes.

Legacy Clearbit ergonomics survive under:

GET https://api.logorouter.com/api/clearbit/logo/{domain}?size=128

Response headers worth logging

HeaderMeaning
X-Cache, Cache-Control, CDN-Cache-ControlHot/cold tiers + TTL hints tuned per response class.
X-Source / x-lr-source lineageHelps explain whether bytes came from cache, deterministic fallback generator, upstream fetch, etc.
X-FallbackPresent when synthesized monograms or placeholder artwork satisfied the request path.
X-RateLimit-*, Retry-AfterQuota signalling on both success envelopes and RFC 9457 problem bodies.

Rate limiting & failures

Exceeded quotas return application/problem+json with mirrored limit headers wherever possible. Honour Retry-After with jitter before hammering dashboards.

Operational deep dive: Fallbacks · Brand colors pairing.

On this page