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.
Get Started
Endpoints
Complete reference of all available endpoints
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Complete reference of all available endpoints
curl GET /api/v1/products/search
| 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) |
curl GET /api/v1/products/:id
| Parameter | Type | Description |
|---|---|---|
| id | string | Product ID |
| Parameter | Type | Description |
|---|---|---|
| include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
curl GET /api/v1/products?url={url}
| Parameter | Type | Description |
|---|---|---|
| url | string | The product URL to fetch |
| include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
GET /health