Auto-complete Brand
Changed onFind up to 10 brands by name or domain, ordered by popularity. Optionally filter by country and primary language; both filters must match when provided together. Results include description, country, and language when available. Use the returned domain to retrieve a full brand profile.
Request
- Base URL: https://api.context.dev/v1
- URL: https://api.context.dev/v1/brand/search
- Auth: HTTP bearer
Query parameters
Search term, matched against the fields selected by queryBy (e.g. 'stripe', 'stripe.com', 'stri').
Only return brands in this country, as an uppercase ISO 3166-1 alpha-2 code such as US or GB.
Only return brands with this primary language, such as english or french.
Whether the search term matches by prefix, so partial words match as they are typed (e.g. 'stri' matches Stripe). Set to false to match whole words only.
Fields to match the search term against, as a comma-separated list or repeated parameter: 'name', 'domain', or both. Defaults to both.
Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no typo tolerance).
Labels for filtering usage in the dashboard.
Comma-separated labels for filtering usage, e.g. production,team-alpha.
[ "production", "team-alpha" ]
Response
Successful response
Example response
{
"results": [
{
"domain": "stripe.com",
"name": "Stripe",
"description": "Stripe designs athletic footwear and apparel.",
"country": "US",
"language": "english",
"logo": "https://logos.context.dev/?publicClientId=brandLL_1a2b3c&domain=stripe.com"
}
],
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
}Changes
- warning
added the new
NO_PUBLISHED_MARKDOWNenum value to theresponse property for the response status - warning
added the new
NO_PUBLISHED_MARKDOWNenum value to theresponse property for the response status - warning
added the new
NO_PUBLISHED_MARKDOWNenum value to theresponse property for the response status
- warning
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info