Orderbook

Retrieve amount of liquidity at each price level for a provided ticker.

Rate limits

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

See more details in API Rate limits

Request

Get orderbook

GET [GATEWAY_V2_ENDPOINT]/orderbook?ticker_id={ticker_id}&depth={depth}

Request Parameters

Parameter	Type	Required	Description
ticker_id	string	Yes	Identifier of a ticker with delimiter to separate base/target.
depth	number	Yes	Number of price levels to retrieve.

Response

{
    "ticker_id": "ETH-PERP_USDC",
    "bids": [
        [
            1612.3,
            0.31
        ],
        [
            1612.0,
            0.93
        ],
        [
            1611.5,
            1.55
        ],
        [
            1610.8,
            2.17
        ]
    ],
    "asks": [
        [
            1612.9,
            0.93
        ],
        [
            1613.4,
            1.55
        ],
        [
            1614.1,
            2.17
        ]
    ],
    "timestamp": 1694375362016
}

Response Fields

Field Name	Type	Nullable	Description
ticker_id	string	No	Identifier of a ticker with delimiter to separate base/target.
bids	decimal[]	No	An array containing 2 elements. The offer price (first element) and quantity for each bid order (second element).
asks	decimal[]	No	An array containing 2 elements. The ask price (first element) and quantity for each ask order (second element).
timestamp	integer	No	Unix timestamp in milliseconds for when the last updated time occurred.