v3

latestOpenAPI 3.0.4MIT License2026-08-055029423.0 KB
Order Book

Historical data

Get historical order book snapshots for a specific symbol within time range, returned in time ascending order.

:::info The historical order book data via the REST API is currently limited by a number of updates and to the maximum number of 50 levels. :::

This endpoint supports hourly granularity for APITP data with automatic fallback to daily data for older records. Timestamps are normalized to hour boundaries, and data is fetched per hour with precise filtering to your exact time range.

:::tip For querying a full day of data, use the 'date' parameter. For specific time ranges (including cross-day or multi-hour queries), use 'time_start' and 'time_end'. :::

get/v1/orderbooks/{symbol_id}/history

Path parameters

symbol_idstring required

Symbol identifier for requested timeseries (from the Metadata -> Symbols)

Query parameters

datestring

Date in ISO 8601, returned data is for the whole given day (required if 'time_start' is not provided)

time_startstring

Starting time in ISO 8601 (supports hourly precision, e.g., 2026-01-16T11:00:00Z)

time_endstring

Timeseries ending time in ISO 8601 (optional, supports cross-day queries)

limitinteger

Amount of items to return (optional, minimum is 1, maximum is 100000, default value is 100, if the parameter is used then every 100 output items are counted as one request)

limit_levelsinteger

Maximum amount of levels from each side of the book to include in response (optional, maximum is 50)

Response

successful operation

symbol_idstring nullable

Gets or sets the symbol identifier.

time_exchangestring date-time

Gets or sets the exchange time of the order book.

time_coinapistring date-time

Gets or sets the CoinAPI time when the order book was received.

{"stackTrail":"components:schemas:v1.OrderBook:properties:asks","oasType":"schema","type":"unknown","description":"Gets or sets the asks made by market makers.","nullable":true}
{"stackTrail":"components:schemas:v1.OrderBook:properties:bids","oasType":"schema","type":"unknown","description":"Gets or sets the bids made by market makers.","nullable":true}