All API endpoints are protected with API key authentication. You must
include a valid API key in the Authorization header with each request.
Email us and we’ll help you get set up.
Authentication
To authenticate with the API, include your API key in theAuthorization
header of your requests.
Example
Obtaining an API Key
Email us to obtain an API key and we’ll help you get set up. API keys should be kept secure and not shared.Product Search
Query Parameters
Parameter | Type | Description |
---|---|---|
q | string | Search query text (required) |
brand_url | string | Base brand URL to filter by, e.g., nike.com (optional) |
limit | number | Maximum number of results (default: 20) |
include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
Get a Product by ID
Path Parameters
Parameter | Type | Description |
---|---|---|
id | string | Product ID |
Query Parameters
Parameter | Type | Description |
---|---|---|
include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
Filter Products by URL
Query Parameters
Parameter | Type | Description |
---|---|---|
url | string | The product URL to fetch |
include_raw_data | boolean | Include raw html/json data from pdp (default: false) |