Historical data
GET/v1/orderbooks/:symbol_id/history
Get historical order book snapshots for a specific symbol within time range, returned in time ascending order.
The historical order book data via the REST API is currently limited by a number of updates and to the maximum number of 20 levels.
The 'time_start' and 'time_end' parameters are deprecated and will be removed in future versions. Please use the 'date' parameter instead for querying data for a specific day.
Request
Path Parameters
Symbol identifier for requested timeseries (from the Metadata -> Symbols)
Query Parameters
Date in ISO 8601, returned data is for the whole given day (preferred method, required if 'time_start' is not provided)
Starting time in ISO 8601 (deprecated, use 'date' instead)
Timeseries ending time in ISO 8601 (deprecated, use 'date' instead)
Default value: 100
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)
Maximum amount of levels from each side of the book to include in response (optional)
Responses
- 200
successful operation
- text/plain
- application/json
- text/json
- application/x-msgpack
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The asks made by market makers.
The bids made by market makers.
[
{
"symbol_id": "string",
"time_exchange": "2024-12-20T13:27:16.769Z",
"time_coinapi": "2024-12-20T13:27:16.769Z"
}
]
[
{
"symbol_id": "BITSTAMP_SPOT_BTC_USD",
"time_exchange": "2013-09-28T22:40:50.0000000Z",
"time_coinapi": "2017-03-18T22:42:21.3763342Z",
"asks": [
{
"price": 456.35,
"size": 123
},
{
"price": 456.36,
"size": 23
}
],
"bids": [
{
"price": 456.1,
"size": 42
},
{
"price": 456.09,
"size": 5
}
]
}
]
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The asks made by market makers.
The bids made by market makers.
[
{
"symbol_id": "string",
"time_exchange": "2024-12-20T13:27:16.769Z",
"time_coinapi": "2024-12-20T13:27:16.769Z"
}
]
[
{
"symbol_id": "BITSTAMP_SPOT_BTC_USD",
"time_exchange": "2013-09-28T22:40:50.0000000Z",
"time_coinapi": "2017-03-18T22:42:21.3763342Z",
"asks": [
{
"price": 456.35,
"size": 123
},
{
"price": 456.36,
"size": 23
}
],
"bids": [
{
"price": 456.1,
"size": 42
},
{
"price": 456.09,
"size": 5
}
]
}
]
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The asks made by market makers.
The bids made by market makers.
[
{
"symbol_id": "string",
"time_exchange": "2024-12-20T13:27:16.769Z",
"time_coinapi": "2024-12-20T13:27:16.769Z"
}
]
[
{
"symbol_id": "BITSTAMP_SPOT_BTC_USD",
"time_exchange": "2013-09-28T22:40:50.0000000Z",
"time_coinapi": "2017-03-18T22:42:21.3763342Z",
"asks": [
{
"price": 456.35,
"size": 123
},
{
"price": 456.36,
"size": 23
}
],
"bids": [
{
"price": 456.1,
"size": 42
},
{
"price": 456.09,
"size": 5
}
]
}
]
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The asks made by market makers.
The bids made by market makers.
[
{
"symbol_id": "string",
"time_exchange": "2024-12-20T13:27:16.769Z",
"time_coinapi": "2024-12-20T13:27:16.769Z"
}
]
[
{
"symbol_id": "BITSTAMP_SPOT_BTC_USD",
"time_exchange": "2013-09-28T22:40:50.0000000Z",
"time_coinapi": "2017-03-18T22:42:21.3763342Z",
"asks": [
{
"price": 456.35,
"size": 123
},
{
"price": 456.36,
"size": 23
}
],
"bids": [
{
"price": 456.1,
"size": 42
},
{
"price": 456.09,
"size": 5
}
]
}
]