Skip to main content
GET
Search Websites

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
query
string
required

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

Required string length: 1 - 200
​
limit
integer
default:5

Maximum number of websites to return.

Required range: 1 <= x <= 20
​
category_ids
string[] | null

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.

​
country
enum<string> | null

ISO 3166-1 alpha-2 country code that best_commission_rate is scoped to. Defaults to 'US' when unset. ISO 3166-1 alpha-2 country code (plus the pan-region EU).

Available options:
US,
GB,
EU,
AU,
CA,
IE,
DE,
AT,
FR,
BE,
IT,
ES,
NL,
SE,
FI,
PT,
CZ,
GR,
RO

Response

Successful Response

​
websites
Website · object[]
required

Websites matching the query, ordered by relevance.