Get a Perps order book
get_perps_bookRetrieve a perpetual futures order book with best bid and ask levels first; specify instrument ID and depth, with prices in pUSD and quantities in base units.
Instructions
A Perps order book, best levels first. Prices in pUSD, quantities in base units.
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": {
"instrument_id": "<instrument_id>"
},
"name": "get_perps_book"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | Levels per side. | |
| instrument_id | Yes | Perps instrument id, e.g. 1. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asks | Yes | ||
| bids | Yes | ||
| best_ask | No | ||
| best_bid | No | ||
| sequence | No | ||
| timestamp | No | ||
| instrument_id | Yes |