live_official_oi
Retrieve official open interest, mark price, and 24h volume per DEX from Hyperliquid. Use to verify computed OI or get ground truth data per venue.
Instructions
Official per-dex open interest for a coin, sourced from Hyperliquid's Info API (not derived from live_positions). Returns hourly snapshots with open interest, mark price, and 24h notional volume. Use when an agent needs venue-reported ground truth, per-dex breakdown, or wants to cross-check computed OI against official numbers. Default 7 days, max 30 days.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| useToonFormat | No | Return data in compact toon format (default: true). Set to false for standard JSON. | |
| coin | Yes | Coin symbol (e.g. BTC, ETH, SOL). Use the bare ticker — dex is supplied via the 'dex' parameter, not prefix. | |
| hours | No | Number of hours of history (default 168 = 7 days, max 720 = 30 days) | |
| dex | No | Which dex's official OI to return. Defaults to 'hl' (native Hyperliquid). | hl |