get https://{BASE_URL_PROD}/v4/order/public/book/
Get a list of order prices by pair (e.g. BTC_USDT). Returns a list of order prices, 2 arrays for Bids and Asks; lowest first for Asks, highest first for Bids; leveled by order prices, but no more levels than specified by the level
parameter.
This is a public
route, no need for authorization.
Data dictionary
Name | Type | Parameter type | Required | Range | Description |
---|---|---|---|---|---|
pair | string | PATH | YES | - | A trading pair as per the list from /v4/markets/public/getAll |
level | int | QUERY | NO | 5, 10, 20, 50, 100, 500, 1000 | Amount of price levels for existing orders in the response |
📘️ Parameter
level
defaults to 1000 if not provided.
Exemplary request
Please try this request for a start: {{baseURL}}/v4/order/public/book/BTC_USDT?level=5
Response structure
You will receive a JSON in the response with data
object, structured like this example:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"asks": [ // An array of sell orders
[
"16950", // Sell price, level 1
"0.001" // Sell quantity, level 1
],
[
"17000", // Sell price, level 2
"0.01" // Sell quantity, level 2
]
],
"bids": [ // An array of buy orders
[
"16700", // Sell price, level 1
"0.01" // Sell quantity, level 1
],
[
"16000", // Sell price, level 2
"0.001" // Sell quantity, level 2
]
]
}
Errors
Status | Error code | Message | Parameter | Description |
---|---|---|---|---|
404 | NotFoundException | Cannot GET /v4/order/public/book/{pair} | pair | Sent pair as QUERY parameter, please send as PATH parameter instead. More info here |
500 | WrongRequestException | level must be one of the following values: 5, 10, 20, 50, 100, 500, 1000 | level | Ensure limit is within the provided range |