GET /api/v1/orderbook
Returns the current live orderbook snapshot for a market, or historical
orderbook snapshots when you pass a time range.
Supports two modes:
- Live snapshot (default): Returns the current orderbook from the exchange.
- Historical snapshots (
start_ts): Returns a paginated series of L2 orderbook snapshots over a time range from S3 Parquet files. Historical data is tier-gated (Free: 5 days, Pro: 30 days, Scale: unlimited).
Error Semantics
403means your API key is not authorized for the request.501means historical snapshots are not configured on this server.503means the upstream exchange is temporarily unavailable.
Parameters
Canonical selector. Provide either
parsec_id or both exchange + market_id.Exchange selector used with
market_id.Exchange-native market ID used with
exchange.Outcome to fetch, typically
yes or no for binary markets.Max price levels per side (live mode, range: 1-100) or max snapshots (historical mode, default 500, max 1000).
Alias for
limit. If both are provided, limit takes precedence.Unix seconds start timestamp (inclusive). When present, switches to historical mode and returns orderbook snapshots instead of a live snapshot. Defaults to 1 day before
end_ts if only end_ts is provided. Historical data is tier-gated (Free: 5 days, Pro: 30 days, Scale: unlimited).Unix seconds end timestamp. Defaults to now in historical mode.
Pagination cursor from a previous historical response.
Response
Live Mode (default)
Historical Mode
Returned whenstart_ts is provided.
Examples
Historical snapshots (1 hour window)
Paginate through historical snapshots
Data availability: Historical orderbook snapshots are served from S3 Parquet files. Snapshot frequency varies by market. For real-time orderbook data, use the live endpoint (omit
start_ts) or the WebSocket API.