get_orderbook
Retrieve the current order book snapshot with computed spread, including top bids/asks, spread amount, and percentage, using live WebSocket data when available.
Instructions
Get the current order book snapshot with computed spread.
Returns top-depth bids/asks (capped at 100), spread and
spread_pct, plus freshness fields. Uses the live WebSocket buffer
when warm, otherwise REST.
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": "get_orderbook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | ||
| symbol | Yes | ||
| exchange | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||