Skip to main content
GET
Brand Search
Free on Pro and Scale 1 Credit on Free and Starter

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>. Keys have full access by default.

Query Parameters

query
string
required

Search term, matched against the fields selected by queryBy (e.g. 'nike', 'nike.com', 'nik').

Required string length: 1 - 100
autocomplete
boolean
default:true

Whether the search term matches by prefix, so partial words match as they are typed (e.g. 'nik' matches Nike). Set to false to match whole words only.

queryBy
enum<string>[]

Fields to match the search term against, as a comma-separated list or repeated parameter: 'name', 'domain', or both. Defaults to both.

Minimum array length: 1
Available options:
name,
domain
typoTolerance
integer
default:0

Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no typo tolerance).

Required range: 0 <= x <= 2
tags
string[]

Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 characters. Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

results
object[]
required

Up to 10 matching brands, name matches first, then domain matches, most popular first within each group. Empty when nothing matches.

Maximum array length: 10
request_id
string<uuid>
required

Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credit usage, included whenever a valid API key is provided.