API Documentation
Everything you need to start retrieving structured product data.
Quick Start
1. Create an account and generate an API key from your dashboard.
2. Include your API key in the Authorization header of every request.
3. Call any endpoint. All responses return JSON.
Authentication
All API requests require authentication via a bearer token. Include your API key in the Authorization HTTP header.
API keys are generated from your dashboard. Each key can be named, revoked, and monitored independently.
Base URL
All endpoints are served from the following base URL:
All requests must be made over HTTPS.
eBay — Product Search
/v1/ebay/search
Search eBay product listings by keyword. Supports optional category filtering and pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search keyword |
| categoryId | string | No | eBay category ID to scope results |
| page | integer | No | Page number (default: 1) |
eBay — Product Details
/v1/ebay/product/{id}
Retrieve detailed information about a specific eBay product by its item ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | eBay item ID (path parameter) |
eBay — Categories
/v1/ebay/categories
Retrieve the full eBay category structure. Use category IDs to scope your product searches.
Shopify — Collection Products
/v1/shopify/collection
Retrieve products from a Shopify storefront collection.
| Parameter | Type | Required | Description |
|---|---|---|---|
| shop | string | Yes | Shop identifier |
| collection | string | Yes | Collection handle |
| page | integer | No | Page number (default: 1) |
| size | integer | No | Items per page (default: 48, max: 250) |
Shopify — Cross-Store Search
/v1/shopify/search
Search for products across indexed Shopify storefronts.
| Parameter | Type | Required | Description |
|---|---|---|---|
| keywords | string | Yes | Search term |
| page | integer | No | Page number (default: 1) |
| size | integer | No | Items per page |
Shopify — Item Details
/v1/shopify/item
Retrieve detailed product information by internal Shopify product ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Shopify product ID |
Pagination
Endpoints that return lists support pagination via page and size parameters. Paginated responses include metadata in the response envelope.
Error Codes
| Status | Meaning |
|---|---|
| 200 | Success — response contains the requested data |
| 401 | Unauthorized — missing or invalid Authorization header |
| 402 | Payment Required — no active subscription |
| 403 | Forbidden — API key is disabled or invalid |
| 429 | Too Many Requests — request quota exhausted |
| 5xx | Server error — try your request again |
Rate Limits
Requests are counted against your plan's quota. Each API call consumes one request. Unused requests do not roll over between billing cycles. When your quota is exhausted, the API returns HTTP 429 until your next cycle or plan upgrade.
Cache Behavior
Responses are cached for 5 minutes. Repeated requests for the same resource within the cache window return the cached data without consuming additional quota. The cached field in the response indicates whether the data was served from cache.