Skip to navigation
API ReferenceWebsites

Search Websites

Search websites by retailer name or domain, optionally within categories. Category filtering matches within each category's top 1,000 websites.

Authentication

x-api-keystring
API Key authentication via header

Headers

X-Channel3-LanguagestringOptional
X-Channel3-CountrystringOptional
X-Channel3-CurrencystringOptional
X-Channel3-Length-UnitstringOptional
X-Channel3-Weight-UnitstringOptional

Query parameters

querystringRequired1-200 characters

Free-text query (e.g. 'Nordstrom', 'nike.com').

limitintegerOptional1-20Defaults to 5
Maximum number of websites to return.
category_idslist of strings or nullOptional
If provided, only websites selling in these categories will be matched. Accepts category slugs. Categories that do not exist, or that are not available for search, are rejected with a 422.
countryenum or nullOptional

ISO 3166-1 alpha-2 country code that best_commission_rate is scoped to. Defaults to 'US' when unset.

Response

Successful Response
websiteslist of objects
Websites matching the query, ordered by relevance.

Errors

401
Unauthorized Error
402
Payment Required Error
422
Unprocessable Entity Error
500
Internal Server Error