Order Book Stop Map (L4)
book_stop_mapBucket untriggered stop and take-profit orders by distance from mid price in 0.25% steps to show where size may fire and nearest triggers within a chosen range.
Instructions
Answers: where are the stops, and how much size fires if price gets there? Buckets every untriggered stop / take-profit order by distance from mid in 0.25 % steps, out to within_pct, reporting per bucket the count, size, reduce-only share, stop vs take-profit split and side split — plus totals below and above mid, the nearest trigger each side, and how many sit beyond the window. Example: 'what is stacked under BTC within 2 %?' — book_stop_map('BTC', within_pct=2) and read totals_below plus the negative buckets. Note totals_below / totals_above / nearest_* always cover EVERY trigger on the coin, while buckets is the within_pct window. Snapshot-derived: refreshed every 60 s, latest-only (no history), and as_of_height is the L1 block the answer is true at — check age_s before citing it. market_orderbook remains the aggregated L2 view; this is the L4 one. Coin is case-sensitive in the node's own spelling (BTC, xyz:GOLD, #28200) and is passed through unchanged — 'btc' will 404. Pro tier.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | Yes | Coin in the node's own spelling, CASE-SENSITIVE: BTC, HYPE, xyz:GOLD, cash:TSLA, #28200. Not normalized — 'btc' returns 404. Use list_markets to discover exact spellings. Spot pairs (names containing '/', e.g. PURR/USDC) are not addressable on this route. | |
| within_pct | No | Half-width of the bucketed window, in percent of mid. The stored map always covers ±10 %; this slices it. | |
| useToonFormat | No | Return data in compact toon format (default: true). Set to false for standard JSON. |