Search Brands

Search indexed brands by name or domain and return up to 10 lightweight prefix matches for autocomplete.

GET /brand/search

JavaScript

JavaScript

import ContextDev from 'context.dev';

const client = new ContextDev({
  apiKey: process.env['CONTEXT_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.brand.search({ query: 'x' });

console.log(response.results);

200

{
  "results": [
    {
      "domain": "nike.com",
      "name": "Nike",
      "logo": "https://logos.context.dev/?publicClientId=pub_1a2b3c&domain=nike.com"
    }
  ],
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

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>, where <API_KEY> is your api key.

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[]

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. 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:

["production", "team-alpha"]

Response

200

application/json

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

Show child attributes

key_metadata · object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Show child attributes