Files
ritmex-bot/docs/nado/developer-resources/api/v2/orderbook.md
T

2.1 KiB

Orderbook

Rate limits

  • 2400 requests/min or 40 requests/sec per IP address. (weight = 1)

{% hint style="info" %} See more details in API Rate limits {% endhint %}

Request

{% tabs %} {% tab title="Get orderbook" %} GET [GATEWAY_V2_ENDPOINT]/orderbook?ticker_id={ticker_id}&depth={depth} {% endtab %} {% endtabs %}

Request Parameters

ParameterTypeRequiredDescription
ticker_idstringYesIdentifier of a ticker with delimiter to separate base/target.
depthnumberYesNumber of price levels to retrieve.

Response

{
    "product_id": 1,
    "ticker_id": "BTC-PERP_USDT0",
    "bids": [
        [
            116215.0,
            0.128
        ],
        [
            116214.0,
            0.172
        ]
    ],
    "asks": [
        [
            116225.0,
            0.043
        ],
        [
            116226.0,
            0.172
        ]
    ],
    "timestamp": 1757913317944
}

Response Fields

Field NameTypeNullableDescription
product_idu32NoUnique identifier for the product.
ticker_idstringNoIdentifier of a ticker with delimiter to separate base/target.
bidsdecimal[]NoAn array containing 2 elements. The offer price (first element) and quantity for each bid order (second element).
asksdecimal[]NoAn array containing 2 elements. The ask price (first element) and quantity for each ask order (second element).
timestampintegerNoUnix timestamp in milliseconds for when the last updated time occurred.