API Reference
Base URL for all API requests:Authentication
All endpoints require an API key passed in theX-API-Key header. See Authentication for details.
Request format
- All requests use standard query parameters
- Responses are JSON
- Timestamps are ISO 8601 format (UTC)
- Pagination uses
limitandoffsetparameters
Response format
All responses follow this structure: Success (market list):Common error codes
| Code | HTTP Status | Description |
|---|---|---|
VALIDATION_ERROR | 400 | Invalid request parameters |
UNAUTHORIZED | 401 | Missing or invalid API key |
TIER_ACCESS_DENIED | 403 | Feature requires a higher plan |
RESOURCE_NOT_FOUND | 404 | Market or resource not found |
RATE_LIMIT_EXCEEDED | 429 | Too many requests |
INTERNAL_ERROR | 500 | Server error |
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/markets | List markets with filtering and pagination |
GET | /v1/markets/{slug} | Get a single market by slug |
GET | /v1/markets/{slug}/snapshots | Get snapshots for a market |