Skip to main content
GET

Get your API keys

Your dashboard has a publishable key for the Logo CDN and a secret key for the Logo API. Every plan includes both.
Returns a logo image. Put the identifier in the path. The query parameters work the same for every lookup.
  • For a ticker outside the US, add the exchange suffix, such as 7203.T.
  • URL-encode a name that has spaces or special characters. /name also takes strategy: match (the default) for the closest name, or suggest for the most popular prefix match.
  • A lookup with no logo returns a generated monogram, unless you set fallback=404. A malformed ticker, crypto symbol, exchange, or index returns 400.

Authorizations

​
token
string
query
required

Your publishable key (pk_). Safe in client-side code. Works only with the Logo CDN.

Path Parameters

​
domain
string
required

The company's domain, such as stripe.com. For another lookup, replace /{domain} with a path from the table.

Example:

"stripe.com"

Query Parameters

​
size
integer
default:128

Width and height in pixels. Aspect ratio is preserved. Max 800: a larger value is clipped to 800. retina=true doubles the result after the clip. Keep raster formats at or below 600.

Required range: x >= 1
​
height
integer

Height in pixels (short form: h). Overrides the height taken from size when set; the image is fit within width × height with aspect ratio preserved. Max 800 (larger is clipped).

Required range: 1 <= x <= 800
​
width
integer

Width in pixels (short form: w). Overrides the width taken from size when set; the image is fit within width × height with aspect ratio preserved. Max 800 (larger is clipped).

Required range: 1 <= x <= 800
​
format
enum<string>
default:jpg

Image format.

Available options:
jpg,
png,
webp
​
theme
enum<string>
default:light

Adjusts logo colors for a light or a dark background. auto is the same as light. Works on logos with transparency, so set format=png or format=webp with it. Do not send theme=dark with jpg, the default format: the request can return 404.

Available options:
auto,
light,
dark
​
greyscale
boolean
default:false

Return a black-and-white version of the logo. The American spelling grayscale is also accepted.

​
retina
boolean
default:false

Render at 2x the requested size for high-density displays.

​
fallback
enum<string>
default:monogram

Behavior when no logo is found. monogram returns a generated monogram with HTTP 200; 404 returns HTTP 404 instead.

Available options:
monogram,
404
​
redirect
enum<string>
default:follow

What to return when the domain reaches a brand only through a redirect to another domain, such as an old domain that now points to a new company. follow returns the logo of the domain it redirects to. 404 returns 404 instead, whatever fallback is set to. See skip domains that redirect.

Available options:
follow,
404

Response

The logo image. When no logo exists and fallback is monogram (the default), a generated monogram is returned with this same 200 status.

The response is of type file.