Skip to main content
HEAD
Check availability and prefetch a brand
A HEAD request is the availability check: 200 when Brandfetch already holds the brand, 202 when it does not and a crawl has been queued, 404 when nothing can be fetched for the identifier, including a brand that has been removed. HEAD takes no allowNsfw parameter: a held brand answers 200 however a later GET is filtered. It never consumes a credit, and it is available on paid plans only, so a free plan receives 403 with the header x-bf-error: paid_plan_required. A 503 with x-bf-error: temporarily_unavailable means the crawl could not be queued; retry later.Use it to warm a brand ahead of time, for example at signup with the new user’s email address, so the GET that renders your brand screen is answered from our store instead of waiting on a live crawl. See Prefetching brands.The same check works on the explicit domain route, HEAD /v2/brands/domain/{domain}.

Authorizations

Authorization
string
header
required

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

Path Parameters

identifier
string
required

Same identifier formats as GET /v2/brands/{identifier}: domain, email address, brand ID, stock or ETF ticker, ISIN, or crypto symbol. Only a domain, or the registrable domain of an email address, can have a crawl queued for it; the other kinds answer 200 or 404.

Response

The brand is held. A GET answers from the store.