API

Every brandfetch.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Brands

get

brands.get Get brand logos, colors, fonts, and company details by domain, ticker, ISIN, crypto symbol, or Brand ID Risk: read

await corsair.brandfetch.api.brands.get({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	Domain (nike.com), Brand ID (id_0dwKPKT), ISIN, ticker (NKE), or crypto symbol (BTC)
`identifierType`	`domain \| ticker \| isin \| crypto`	No	Explicit identifier type. Omit to use auto-detect (domain → ticker → ISIN → crypto).
`allowNsfw`	`boolean`	No	When true, return NSFW brands. When false, NSFW brands 404. Unset uses Brandfetch default.

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`domain`	`string`	Yes	—
`claimed`	`boolean`	Yes	—
`description`	`string`	No	—
`longDescription`	`string`	No	—
`links`	`object[]`	Yes	—
`logos`	`object[]`	Yes	—
`colors`	`object[]`	Yes	—
`fonts`	`object[]`	Yes	—
`images`	`object[]`	Yes	—
`qualityScore`	`number`	Yes	—
`company`	`object`	No	—
`isNsfw`	`boolean`	Yes	—
`urn`	`string`	Yes	—

links full type

{
  name: string,
  url: string
}[]

logos full type

{
  theme?: dark | light | null,
  formats: {
    src?: string,
    format?: svg | webp | png | jpeg,
    height?: number | null,
    width?: number | null,
    size?: number,
    background?: transparent | null
  }[],
  tags: any[],
  type: icon | logo | symbol | other
}[]

colors full type

{
  hex: string,
  type: accent | dark | light | brand,
  brightness: number
}[]

fonts full type

{
  name?: string | null,
  type: title | body,
  origin?: google | custom | system,
  originId?: string | null,
  weights?: any[]
}[]

images full type

{
  formats: {
    src?: string,
    format?: svg | webp | png | jpeg,
    height?: number | null,
    width?: number | null,
    size?: number,
    background?: transparent | null
  }[],
  tags: any[],
  type: banner | other | picture,
  pictureMetadata?: {
    score: number,
    rank: number,
    naturalWidth: number,
    naturalHeight: number,
    alt: string,
    sourceUrl: string,
    imageCategory?: string | null,
    categoryConfidence?: number | null
  } | null
}[]

company full type

{
  employees?: number | null,
  financialIdentifiers?: {
    isin?: string[],
    ticker?: string[]
  } | null,
  foundedYear?: number | null,
  industries?: {
    id: string,
    score?: number,
    slug: string,
    name: string,
    emoji?: string,
    parent?: {
      id: string,
      slug: string,
      name: string,
      emoji?: string
    } | {
      id: string,
      slug: string,
      name: string,
      emoji?: string
    }[] | null
  }[],
  kind?: string | null,
  location?: {
    city?: string | null,
    country?: string | null,
    countryCode?: string | null,
    region?: string | null,
    state?: string | null,
    subregion?: string | null
  }
}

getCompany

brands.getCompany Get firmographic company data for a brand identifier Risk: read

await corsair.brandfetch.api.brands.getCompany({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	Domain (nike.com), Brand ID (id_0dwKPKT), ISIN, ticker (NKE), or crypto symbol (BTC)
`identifierType`	`domain \| ticker \| isin \| crypto`	No	Explicit identifier type. Omit to use auto-detect (domain → ticker → ISIN → crypto).
`allowNsfw`	`boolean`	No	When true, return NSFW brands. When false, NSFW brands 404. Unset uses Brandfetch default.

Output

Name	Type	Required	Description
`employees`	`number`	No	—
`financialIdentifiers`	`object`	No	—
`foundedYear`	`number`	No	—
`industries`	`object[]`	No	—
`kind`	`string`	No	—
`location`	`object`	No	—

financialIdentifiers full type

{
  isin?: string[],
  ticker?: string[]
}

industries full type

{
  id: string,
  score?: number,
  slug: string,
  name: string,
  emoji?: string,
  parent?: {
    id: string,
    slug: string,
    name: string,
    emoji?: string
  } | {
    id: string,
    slug: string,
    name: string,
    emoji?: string
  }[] | null
}[]

location full type

{
  city?: string | null,
  country?: string | null,
  countryCode?: string | null,
  region?: string | null,
  state?: string | null,
  subregion?: string | null
}

search

brands.search Search brands by name for autocomplete (requires client ID) Risk: read

await corsair.brandfetch.api.brands.search({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Brand name to search for
`clientId`	`string`	No	Brandfetch client ID. Falls back to plugin options / stored key.

Output: object[]

Output full type

{
  icon?: string | null,
  name?: string | null,
  domain: string,
  claimed: boolean,
  brandId: string
}[]

Graphql

getVersion

graphql.getVersion Get the Brandfetch GraphQL API version Risk: read

await corsair.brandfetch.api.graphql.getVersion({});

Input: empty object Output

Name	Type	Required	Description
`version`	`string`	Yes	—

Logos

get

logos.get Build a Brandfetch Logo CDN URL (requires client ID) Risk: read

await corsair.brandfetch.api.logos.get({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	Domain (nike.com), Brand ID (id_0dwKPKT), ISIN, ticker (NKE), or crypto symbol (BTC)
`identifierType`	`domain \| ticker \| isin \| crypto`	No	Explicit identifier type. Omit to use auto-detect (domain → ticker → ISIN → crypto).
`clientId`	`string`	No	—
`logoType`	`icon \| logo \| symbol`	No	CDN asset type. Defaults to icon.
`theme`	`light \| dark`	No	—
`fallback`	`404 \| brandfetch \| transparent \| lettermark`	No	—
`w`	`number`	No	Width in pixels
`h`	`number`	No	Height in pixels

Output

Name	Type	Required	Description
`url`	`string`	Yes	—

Taxonomy

get

taxonomy.get Get Brandfetch industries, countries, and geographic regions Risk: read

await corsair.brandfetch.api.taxonomy.get({});

Input: empty object Output

Name	Type	Required	Description
`industries`	`object[]`	Yes	—
`countries`	`object[]`	Yes	—
`geographicRegions`	`object[]`	Yes	—

industries full type

{
  id: string,
  urn?: string,
  name: string,
  slug: string,
  emoji?: string,
  depth?: number,
  banner?: string | null,
  parent?: {
    id: string,
    urn?: string,
    name: string,
    slug: string,
    emoji?: string,
    depth?: number,
    banner?: string | null
  } | null,
  children?: {
    id: string,
    urn?: string,
    name: string,
    slug: string,
    emoji?: string,
    depth?: number,
    banner?: string | null
  }[]
}[]

countries full type

{
  code: string,
  name: string,
  slug: string,
  emoji?: string,
  latitude?: number,
  longitude?: number
}[]

geographicRegions full type

{
  name: string,
  slug: string,
  emoji?: string,
  depth?: number,
  parent?: {
    name: string,
    slug: string
  } | null
}[]

Transactions

get

transactions.get Match a payment descriptor to merchant brand data Risk: read

await corsair.brandfetch.api.transactions.get({});

Input

Name	Type	Required	Description
`transactionLabel`	`string`	Yes	Raw transaction text from a credit-card statement
`countryCode`	`string`	Yes	ISO 3166-1 alpha-2 country code where the transaction took place

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`domain`	`string`	Yes	—
`claimed`	`boolean`	Yes	—
`description`	`string`	No	—
`longDescription`	`string`	No	—
`links`	`object[]`	Yes	—
`logos`	`object[]`	Yes	—
`colors`	`object[]`	Yes	—
`fonts`	`object[]`	Yes	—
`images`	`object[]`	Yes	—
`qualityScore`	`number`	Yes	—
`company`	`object`	No	—
`isNsfw`	`boolean`	Yes	—
`urn`	`string`	Yes	—

links full type

{
  name: string,
  url: string
}[]

logos full type

{
  theme?: dark | light | null,
  formats: {
    src?: string,
    format?: svg | webp | png | jpeg,
    height?: number | null,
    width?: number | null,
    size?: number,
    background?: transparent | null
  }[],
  tags: any[],
  type: icon | logo | symbol | other
}[]

colors full type

{
  hex: string,
  type: accent | dark | light | brand,
  brightness: number
}[]

fonts full type

{
  name?: string | null,
  type: title | body,
  origin?: google | custom | system,
  originId?: string | null,
  weights?: any[]
}[]

images full type

{
  formats: {
    src?: string,
    format?: svg | webp | png | jpeg,
    height?: number | null,
    width?: number | null,
    size?: number,
    background?: transparent | null
  }[],
  tags: any[],
  type: banner | other | picture,
  pictureMetadata?: {
    score: number,
    rank: number,
    naturalWidth: number,
    naturalHeight: number,
    alt: string,
    sourceUrl: string,
    imageCategory?: string | null,
    categoryConfidence?: number | null
  } | null
}[]

company full type

{
  employees?: number | null,
  financialIdentifiers?: {
    isin?: string[],
    ticker?: string[]
  } | null,
  foundedYear?: number | null,
  industries?: {
    id: string,
    score?: number,
    slug: string,
    name: string,
    emoji?: string,
    parent?: {
      id: string,
      slug: string,
      name: string,
      emoji?: string
    } | {
      id: string,
      slug: string,
      name: string,
      emoji?: string
    }[] | null
  }[],
  kind?: string | null,
  location?: {
    city?: string | null,
    country?: string | null,
    countryCode?: string | null,
    region?: string | null,
    state?: string | null,
    subregion?: string | null
  }
}

Webhooks

list

webhooks.list List registered Brandfetch webhooks Risk: read

await corsair.brandfetch.api.webhooks.list({});

Input

Name	Type	Required	Description
`first`	`number`	No	Page size. GraphQL default is 10.
`after`	`string`	No	Cursor from the previous pageInfo.endCursor

Output

Name	Type	Required	Description
`nodes`	`object[]`	Yes	—
`pageInfo`	`object`	Yes	—

nodes full type

{
  urn: string,
  url: string,
  description?: string | null,
  enabled: boolean,
  events: string[],
  createdAt?: string,
  updatedAt?: string
}[]

pageInfo full type

{
  hasNextPage: boolean,
  endCursor?: string | null
}

listEvents

webhooks.listEvents List webhook event types that can be subscribed to Risk: read

await corsair.brandfetch.api.webhooks.listEvents({});

Input: empty object Output

Name	Type	Required	Description
`subscribableEvents`	`object[]`	Yes	—

subscribableEvents full type

{
  namespace: string,
  name: string,
  description: string,
  subscriptionScope: string
}[]

Overview

Plugins

Brands

get

getCompany

search

Graphql

getVersion

Logos

get

Taxonomy

get

Transactions

get

Webhooks

list

listEvents

​Brands

​get

​getCompany

​search

​Graphql

​getVersion

​Logos

​get

​Taxonomy

​get

​Transactions

​get

​Webhooks

​list

​listEvents

Brands

get

getCompany

search

Graphql

getVersion

Logos

get

Taxonomy

get

Transactions

get

Webhooks

list

listEvents