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.
Request
Path Parameters
The symbol ID (from the Metadata -> Symbols)
Query Parameters
The maximum number of levels to include in the response.
Responses
- 200
successful operation
- text/plain
- application/json
- text/json
- application/x-msgpack
- Schema
- Example (from schema)
Schema
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The number of ask levels in the order book.
The number of bid levels in the order book.
The depth of the ask side of the order book.
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-10-21T10:29:26.699Z",
"time_coinapi": "2024-10-21T10:29:26.699Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}
- Schema
- Example (from schema)
Schema
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The number of ask levels in the order book.
The number of bid levels in the order book.
The depth of the ask side of the order book.
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-10-21T10:29:26.700Z",
"time_coinapi": "2024-10-21T10:29:26.700Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}
- Schema
- Example (from schema)
Schema
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The number of ask levels in the order book.
The number of bid levels in the order book.
The depth of the ask side of the order book.
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-10-21T10:29:26.700Z",
"time_coinapi": "2024-10-21T10:29:26.700Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}
- Schema
- Example (from schema)
Schema
The symbol identifier.
The exchange time of the order book.
The CoinAPI time when the order book was received.
The number of ask levels in the order book.
The number of bid levels in the order book.
The depth of the ask side of the order book.
The depth of the bid side of the order book.
{
"symbol_id": "string",
"time_exchange": "2024-10-21T10:29:26.700Z",
"time_coinapi": "2024-10-21T10:29:26.700Z",
"ask_levels": 0,
"bid_levels": 0,
"ask_depth": 0,
"bid_depth": 0
}