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.
Path Parameters
- symbol_id string required
Symbol identifier for requested timeseries (from the Metadata -> Symbols)
Query Parameters
- time_start string
Starting time in ISO 8601 (required)
- time_end string
Timeseries ending time in ISO 8601 (optional, if not supplied then the data is returned to the end or when result elements count reaches the limit)
- limit int32
Default value:
100
Amount of items to return (optional, mininum 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_levels int32
Maximum amount of levels from each side of the book to include in response (optional)
- 200
successful operation
- text/plain
- application/json
- text/json
- application/x-msgpack
- Schema
- Example (from schema)
- Example response
Schema
- Array [
- symbol_id string nullable
The symbol identifier.
- time_exchange date-time
The exchange time of the order book.
- time_coinapi date-time
The CoinAPI time when the order book was received.
- asks nullable
The asks made by market makers.
- bids nullable
The bids made by market makers.
- ]
[
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.221Z",
"time_coinapi": "2024-04-29T10:40:58.221Z"
}
]
[
{
"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 [
- symbol_id string nullable
The symbol identifier.
- time_exchange date-time
The exchange time of the order book.
- time_coinapi date-time
The CoinAPI time when the order book was received.
- asks nullable
The asks made by market makers.
- bids nullable
The bids made by market makers.
- ]
[
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.221Z",
"time_coinapi": "2024-04-29T10:40:58.221Z"
}
]
[
{
"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 [
- symbol_id string nullable
The symbol identifier.
- time_exchange date-time
The exchange time of the order book.
- time_coinapi date-time
The CoinAPI time when the order book was received.
- asks nullable
The asks made by market makers.
- bids nullable
The bids made by market makers.
- ]
[
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.221Z",
"time_coinapi": "2024-04-29T10:40:58.221Z"
}
]
[
{
"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 [
- symbol_id string nullable
The symbol identifier.
- time_exchange date-time
The exchange time of the order book.
- time_coinapi date-time
The CoinAPI time when the order book was received.
- asks nullable
The asks made by market makers.
- bids nullable
The bids made by market makers.
- ]
[
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.221Z",
"time_coinapi": "2024-04-29T10:40:58.221Z"
}
]
[
{
"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
}
]
}
]