Order book: spread, depth, slippage
reservoir_orderbookQuery minute-by-minute top-20 L2 order books to retrieve mid, spread, USD depth within chosen bps, optional order-size slippage, window medians, or a full book at a given minute.
Instructions
Minute-by-minute top-20 L2 books: mid, spread, USD depth within N bps, optional slippage for an order size, medians over the window, and the full book at a given minute (max 31 days).
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": {
"market": "<market>"
},
"name": "reservoir_orderbook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| at | No | Return the full top-20 book nearest this time instead of a window. | |
| end | No | UTC. A date ("2026-10-26"), date-time ("2026-10-26T14:00:00Z"), relative ("7d", "24h") or Unix ms. A date-only end includes that whole day. Default: the newest day in Reservoir. | |
| every | No | Sampling of the returned series. | 1h |
| start | No | UTC. A date ("2026-10-26"), date-time ("2026-10-26T14:00:00Z"), relative ("7d", "24h") or Unix ms. A date-only end includes that whole day. Default: the newest day in Reservoir. | |
| market | Yes | Market as Reservoir names it: "BTC" (Hyperliquid perp), "xyz:MSFT" (HIP-3 perp), "@107" or "PURR/USDC" (spot), "#114940" (HIP-4). Case is fixed automatically for perps. | |
| depth_bps | No | Depth bands in bps from mid (default [10, 50, 100]). | |
| notional_usd | No | Also compute buy and sell slippage for a market order of this size. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||