Skip to main content
POST
Get brand data from a transaction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
transactionLabel
string
required

The raw transaction text.

Example:

"STARBUCKS 1523 OMAHA NE"

countryCode
string
required

An ISO 3166-1 alpha-2 country code indicating the country where the transaction took place.

Example:

"US"

Response

Successful request. A request paid with MPP whose response was lost can be retried with the same credential and the same body for two minutes: it is served from the payment already taken and not charged again. The credential pays for that transaction only: presented with another transactionLabel or countryCode, it is refused with a 402 whose reason is credential_spent.

id
string

Unique identifier for the brand

name
string | null

Brand name

domain
string

Brand website URL

claimed
boolean

Set to true if the owner of the brand claimed its brand profile on Brandfetch

description
string | null

Brand description

longDescription
string | null

Brand long description

Social media links of the brand

logo
string | null

Shortcut field for the brand's logo: the address of the best match from logos. The image is a WebP up to 512 px on its longer side. A dark logo is picked over a light one, for light backgrounds; the address names the theme it serves. null when the brand has no logo, and for brands with isNsfw: true.

Fetch the address as it is given. Its c parameter is a client ID signed for your API key. The client ID is required, and a request without it is refused. Its t parameter changes when the image does, so you can cache the image for as long as you like. The image does not count towards your quota. If the logo is gone when you fetch it, the address returns 404.

symbol
string | null

Shortcut field for the brand's symbol: the address of the best match from logos. The image is a WebP up to 512 px on its longer side. A dark symbol is picked over a light one, for light backgrounds; the address names the theme it serves. null when the brand has no symbol, and for brands with isNsfw: true.

Fetch the address as it is given. Its c parameter is a client ID signed for your API key. The client ID is required, and a request without it is refused. Its t parameter changes when the image does, so you can cache the image for as long as you like. The image does not count towards your quota. If the symbol is gone when you fetch it, the address returns 404.

icon
string | null

Shortcut field for the brand's icon: the address of the best match from logos. The image is a square WebP up to 128 px. A brand without an icon gets one made from its symbol or logo. When no icon can be made, the address returns a lettermark: the brand's initial on a plain square. null when the brand has no icon, symbol or logo, and for brands with isNsfw: true.

Fetch the address as it is given. Its c parameter is a client ID signed for your API key. The client ID is required, and a request without it is refused. Its t parameter changes when the image does, so you can cache the image for as long as you like. The image does not count towards your quota.

banner
string | null

Shortcut field for the brand's banner: the address of the best match from images. The image is a WebP up to 1500 px wide. null when the brand has no banner, and for brands with isNsfw: true.

Fetch the address as it is given. Its c parameter is a client ID signed for your API key. The client ID is required, and a request without it is refused. Its t parameter changes when the image does, so you can cache the image for as long as you like. The image does not count towards your quota. If the banner is gone when you fetch it, the address returns 404.

logos
object[]

Logos, symbols & icons of the brand

colors
object[]

Accent, dark, light & palette colors of the brand

fonts
object[]

Title & body fonts of the brand

images
object[]

Banner, picture & other images of the brand

qualityScore
number

Score between 0-1 which indicates the quality of the data for the given brand. Useful when you don't want to show lower quality brands to your users.

Lower 3rd is poor quality, middle 3rd is OK quality, upper 3rd is high quality. Lower scores indicate that a brand is less likely to be "real". For example, where google.com will score high, my-random-blog.com will score between 0.3-0.4. The score factors in things like data-recency, whether the brand has been claimed, if it has been manually verified by our team, the brand's domain ranking on the web, as well as other factors.

Don't rely on a fixed score for any given brand. The way we calculate this score may change over time as we add new factors, or tweak the weights of existing ones such that a score for a given brand may change. However, they will remain aligned such that scores divide quality into thirds: low, medium, high.

company
object

The company object returns firmographic data related to the brand

isNsfw
boolean

true when the brand is for adult content, e.g. is not safe for work

urn
string

Uniform Resource Name for the brand

screenshot
object | null

The brand's homepage screenshot. null when Brandfetch holds no screenshot of the homepage yet, and for brands with isNsfw: true.

The screenshot shows the top of the homepage at a desktop viewport, as Brandfetch saw it on its last visit. It is not a full-page capture. Fetch url as it is given: its c parameter is a client ID signed for your API key, and the image does not count towards your quota. A request that drops the client ID is refused. t is the time of capture, so the address changes when Brandfetch takes a new screenshot.

palette
object | null

The brand's color palette. Present only when the request sets palette=true or palette=1. When a brand has no palette yet, the first request builds one from the brand's last crawl without a new render. Then themes and onPairs can be empty until the next crawl. When Brandfetch finds no color that it can defend as the brand's color, no color has the role primary.