Order book
get_order_bookOrder book levels for one perpetual futures contract on one exchange, best first, as [price, size]. Use to judge liquidity before a large market order. Not for the best price across exchanges (use compare_venue_prices). Inputs: symbol, venue (without an account: hyperliquid only), depth (1-50 levels). Prices in USD per coin, sizes in the base coin. Next: preview_order.
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_order_book"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | Levels per side | |
| venue | No | Venue: sandbox, hyperliquid, okx, bybit or binance. Omitted: the agent's only venue, else hyperliquid if connected, else your only connected exchange, else the sandbox | |
| symbol | Yes | Base coin, e.g. BTC |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asks | Yes | [price (USD per coin), size (in the base coin (e.g. BTC), not USD)], best first | |
| bids | Yes | [price (USD per coin), size (in the base coin (e.g. BTC), not USD)], best first | |
| venue | Yes | Venue name | |
| symbol | Yes | Base coin | |
| deprecation | No | Present only while this tool is deprecated: replacement, removal_date, changelog |