Look up a brand - Logo.dev

Authorizations

Authorization

string

header

required

Your secret key (sk_), as Bearer sk_.... Call the Logo API only from your server.

Query Parameters

domain

string

A company domain. Reduced to its registrable domain, so www.stripe.com looks up stripe.com. Send exactly one identifier.

Example:

"stripe.com"

ticker

string

The stock or ETF symbol, in any case, with no exchange prefix: aapl and AAPL return the same brand. A bare symbol resolves against US exchanges. For a listing on another exchange, add the exchange suffix, such as 7203.T. Send exactly one identifier.

Example:

"aapl"

isin

string

An ISIN. Case-insensitive. Send exactly one identifier.

Example:

"US0378331005"

crypto

string

A crypto token symbol. Case-insensitive. Send exactly one identifier.

Example:

"BTC"

name

string

A brand name. Resolved to the top search match. Send exactly one identifier.

Example:

"Stripe"

nosubscribe

enum<string>

Send true to skip the automatic subscription to this brand. Only matters when webhooks are enabled on your account.

Available options:

true

merchant

string

A card-statement merchant descriptor. Announced but not yet enabled for any account, so it currently answers 403. Send exactly one identifier.

Example:

"SQ *BLUE BOTTLE COFFEE"

Response

The brand is ready.

data

object

required

Hide child attributes

data.object

string

required

Allowed value: "brand"

data.id

string

required

The brand's id. Stable across domain changes; use it to key your records.

Example:

"brand_4x0wr3g0000g00400000000004"

data.slug

string

required

Readable label for display. It can change and is not accepted for lookups; use id.

data.domain

string | null

required

The brand's own domain, which can differ from the one you sent. null for brands with no website, such as some crypto tokens.

data.status

string

required

Allowed value: "ready"

data.name

string

required

data.description

string | null

required

data.indexed_at

string<date-time>

required

When the record was last refreshed.

data.is_profane

boolean

required

true when the brand may carry NSFW imagery.

data.socials

object

required

Profile URLs keyed by network. Networks with no profile are omitted.

Hide child attributes

data.socials.{key}

string<uri>

data.colors

object[]

required

Brand colors, most dominant first.

Hide child attributes

data.colors.r

integer

required

Required range: 0 <= x <= 255

data.colors.g

integer

required

Required range: 0 <= x <= 255

data.colors.b

integer

required

Required range: 0 <= x <= 255

data.colors.hex

string

required

Example:

"#635bff"

data.colors.oklch

object

required

Hide child attributes

data.colors.oklch.l

number

required

Lightness, 0 to 1.

data.colors.oklch.c

number

required

Chroma. Usually below 0.4.

data.colors.oklch.h

number

required

Hue in degrees, 0 to 360. 0 when chroma is 0.

data.logo

object | null

required

The primary logo. null when the brand has none.

Hide child attributes

data.logo.url

string<uri>

required

Temporary signed download URL. It stops working at expires_at: download and host the image yourself. Add size, format (png, jpg, webp), or theme (light, dark) to format the download. Downloads do not count toward CDN image usage.

data.logo.etag

string

required

Identifies this version of the source image, and is the same on every route. Save it and download again only when it changes.

data.logo.blurhash

string

required

Compact blurred placeholder for the image.

data.logo.source

object

required

The source file behind the image.

Hide child attributes

data.logo.source.width

integer

required

data.logo.source.height

integer

required

data.logo.source.has_transparency

boolean

required

data.logo.source.is_vector

boolean

required

data.logo.source.format

enum<string>

Omitted when the format is not recognized.

Available options:

png,

jpg,

svg,

webp,

gif,

ico,

avif

data.logo.last_updated_at

string<date-time> | null

required

When the image last changed. null if it has not changed since the brand was indexed.

data.logo.expires_at

string<date-time>

required

When url stops working, about 24 hours after the request.

data.brandmark

object | null

required

The wide logo lockup: the symbol and wordmark together for most brands, or the wordmark alone for pure-type brands. null when the brand has none. See brandmark.

Hide child attributes

data.brandmark.url

string<uri>

required

data.brandmark.etag

string

required

Identifies this version of the source image, and is the same on every route. Save it and download again only when it changes.

data.brandmark.blurhash

string

required

Compact blurred placeholder for the image.

data.brandmark.source

object

required

The source file behind the image.

Hide child attributes

data.brandmark.source.width

integer

required

data.brandmark.source.height

integer

required

data.brandmark.source.has_transparency

boolean

required

data.brandmark.source.is_vector

boolean

required

data.brandmark.source.format

enum<string>

Omitted when the format is not recognized.

Available options:

png,

jpg,

svg,

webp,

gif,

ico,

avif

data.brandmark.last_updated_at

string<date-time> | null

required

When the image last changed. null if it has not changed since the brand was indexed.

data.brandmark.expires_at

string<date-time>

required

When url stops working, about 24 hours after the request.

Banner images. Empty when there are none.

Hide child attributes

Identifies this version of the source image, and is the same on every route. Save it and download again only when it changes.

Compact blurred placeholder for the image.

The source file behind the image.

Hide child attributes

Omitted when the format is not recognized.

Available options:

png,

jpg,

svg,

webp,

gif,

ico,

avif

When the image last changed. null if it has not changed since the brand was indexed.

When url stops working, about 24 hours after the request.

metadata

object

required

Hide child attributes

metadata.request_id

string

required

Unique id for this request. Also sent as the Request-Id header.

Example:

"request_01k6z8m2a4b5c6d7e8f9g0h1j2"

metadata.resolution

object

Brand and image lookups only.

Hide child attributes

metadata.resolution.type

enum<string>

required

Which identifier the request used.

Available options:

domain,

ticker,

isin,

crypto,

name,

brand_id

metadata.resolution.value

string

required

The identifier after normalization: the registrable domain, an upper-cased ticker, and so on.

metadata.resolution.method

enum<string>

required

How the identifier reached the brand. direct is a brand id or a domain that is its own brand; domain went through an alias or redirect; security is a ticker or ISIN; crypto is a crypto token symbol; search is a name lookup. Empty on a cached miss.

Available options:

direct,

domain,

security,

crypto,

search,

metadata.resolution.context

object

required

Reserved for brands involved in a merchant lookup. Always {} today.

metadata.pending

object

202 responses only.

Hide child attributes

metadata.pending.reason

enum<string>

required

indexing is a brand's first crawl; resolving means the identifier is still being matched to a brand.

Available options:

indexing,

resolving

metadata.pending.message

string

required

metadata.pending.retry_after_seconds

integer

required

Wait this long before retrying. Matches the Retry-After header.

Example:

30

metadata.pending.expires_in_seconds

integer

required

Stop polling after this long.

Example:

300

metadata.pending.webhook

boolean

required

Whether a brand.indexed webhook event carrying this request's request_id will be sent when the lookup settles.

metadata.pending.doc_url

string<uri>

required

metadata.subscription

object

Present when a brand lookup (GET /v2/brands or GET /v2/brands/{id}) ran the automatic subscribe: webhooks are on for the account, and nosubscribe is not true. See automatic subscriptions.

Hide child attributes

metadata.subscription.status

enum<string>

required

subscribed: the account is subscribed to the brand. quota_exceeded: the account is at its plan's subscription limit, so the brand was not subscribed. The lookup is answered and billed either way.

Available options:

subscribed,

quota_exceeded

metadata.subscription.message

string

Why the subscribe was refused. Only with quota_exceeded.

Get your API keys

Authorizations

Query Parameters

Response