Quick start
These snippets call Amazon product details. Subscribe to the Amazon data first (the Free plan works). For other products, see their operation documentation.
Set ZOXDATA_API_KEY in your local environment to a key for the Amazon product before running a snippet. The example automatically uses the current website origin. Run it in your own terminal and keep your key private.
curl "https://api.zoxdata.com/reddit/v1/subreddit?subreddit=python" \ -H "x-api-key: $ZOX_KEY"
Authentication
Authenticate with X-API-Key. Each account has one Key for all the data it subscribes to; view or regenerate it in the console.
The console uses a session Cookie and CSRF token. API Keys are managed separately; signing out does not revoke your Keys.
Status and usage
- 200
- Success; one request is deducted from the subscription.
- 202
- Processing; reserves one call. Query GET /v1/requests/REQUEST_ID with an active Key for the same account and product.
- 401 / 403
- Authentication failed or the data is not subscribed. Check that the Key is current and the product is subscribed.
- 409
- Not subscribed, quota used up or operation unavailable. Check the error code.
- 410
- The successful result has passed its 24-hour retention period. The original request will not run again.
- 429
- A request-rate or pending-request limit was reached. Wait according to Retry-After.
- 502
- When data.status=failed the call failed and its reserved request was returned. After a network failure, look up the original result by request_id.
Keep the response X-Request-Id for troubleshooting. View aggregate call volume, error rate and response duration in the console.
Operations and examples
The catalog includes operations, parameters and response examples. The playground returns database-backed examples without contacting external sites.
Live collection, email, payments and commercial plans are not connected yet. Add scenario: "failure" or "delayed" to test failure release, asynchronous queries and recovery.