Current depth of the order book
GET /v1/orderbooks/:symbol_id/depth/current
Retrieves the current depth of the order book for the specified symbol.
Path Parameters
- symbol_id string required
The symbol ID (from the Metadata -> Symbols)
Query Parameters
- limit_levels int32
The maximum number of levels to include in the response.
- 200
successful operation
- text/plain
- application/json
- text/json
- application/x-msgpack
- Schema
- Example (from schema)
Schema
- 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.
- ask_levels int64
The number of ask levels in the order book.
- bid_levels int64
The number of bid levels in the order book.
- ask_depth double
The depth of the ask side of the order book.
- bid_depth double
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.220Z",
"time_coinapi": "2024-04-29T10:40:58.220Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}
- Schema
- Example (from schema)
Schema
- 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.
- ask_levels int64
The number of ask levels in the order book.
- bid_levels int64
The number of bid levels in the order book.
- ask_depth double
The depth of the ask side of the order book.
- bid_depth double
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.220Z",
"time_coinapi": "2024-04-29T10:40:58.220Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}
- Schema
- Example (from schema)
Schema
- 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.
- ask_levels int64
The number of ask levels in the order book.
- bid_levels int64
The number of bid levels in the order book.
- ask_depth double
The depth of the ask side of the order book.
- bid_depth double
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.220Z",
"time_coinapi": "2024-04-29T10:40:58.220Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}
- Schema
- Example (from schema)
Schema
- 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.
- ask_levels int64
The number of ask levels in the order book.
- bid_levels int64
The number of bid levels in the order book.
- ask_depth double
The depth of the ask side of the order book.
- bid_depth double
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-04-29T10:40:58.220Z",
"time_coinapi": "2024-04-29T10:40:58.220Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}