getSpreadOrderbook
Retrieve current bid/ask depth for a spread symbol to assess liquidity before placing orders. Returns up to 25 price levels per side with sequence for WebSocket correlation.
Instructions
Retrieve spread orderbook depth data for a specific spread combination symbol. Returns a snapshot of bid and ask price levels, along with sequence and timestamp fields for correlation with WebSocket streams.
Use this endpoint when you need to:
Inspect current bid/ask depth before placing a spread order
Fetch the best bid/ask price and available size at each level
Correlate with the WebSocket orderbook stream using the
u(update ID) field
Returns up to 25 price levels per side. Use limit=1 (default) for best bid/ask only;
increase limit for deeper analysis.
Do not use this endpoint for 24h stats or last traded price — use getSpreadTickers instead.
Notes:
Bids are sorted in descending order by price
Asks are sorted in ascending order by price
The
ufield correlates with the WebSocket orderbook stream update IDNo authentication required
Agent hint: Use this endpoint to get current bid/ask depth for a spread symbol.
The symbol must be a valid spread combination — obtain it from getSpreadInstrumentsInfo if unknown.
Use limit=1 (default) for best bid/ask only; increase limit for deeper order book analysis.
Do not use this for 24h stats or last price — use getSpreadTickers for that.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"symbol": "<symbol>"
},
"name": "getSpreadOrderbook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| symbol | Yes |