Raw schema
{
"type": "object",
"properties": {
"view": {
"type": "string",
"enum": [
"open_interest",
"symbol_metrics",
"size_breakdown",
"positions",
"indices",
"large_fills",
"hourly",
"funding_rates"
],
"default": "open_interest",
"description": "What to read. `open_interest`: open interest per symbol beside the venue's own figure. `symbol_metrics`: the hourly open-interest, position-count and bias series of one symbol. `size_breakdown`: one symbol's positioning by position-size bucket. `positions`: individual position rows in key order (not by size; `sort=size` for the biggest of one symbol), current or historical (historical rows carry `label_causal`, the previous hour's label, for a backtest without lookahead). `indices`: the smart money and whale-vs-shrimp indices plus whale and smart bias of one symbol: the newest snapshot and an hourly series. `large_fills`: one symbol's large fills (from $50k) of the last day, newest first, as the website's Whale Activity feed. `hourly`: hourly close, open interest, funding rate and premium of up to 64 symbols at once. `funding_rates`: the latest funding rate of every perp, or with `symbol` one perp's hourly funding history. Default `open_interest`."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. On `positions` it is a filter; bound a historical read by it or by `wallet`. On `funding_rates` it switches from the board of every perp to that perp's hourly history; HIP-3 markets (`xyz:TSLA`) included. Used by view: symbol_metrics, size_breakdown, positions, indices, large_fills, funding_rates. Required by view: symbol_metrics, size_breakdown, indices, large_fills."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. On `positions`, setting it switches to history (`end` alone does not). On `hourly` (also epoch seconds or ms) it is inclusive and overrides `days`. On `funding_rates` it bounds a `symbol`'s history (inclusive) and is refused without `symbol`. Used by view: symbol_metrics, positions, indices, hourly, funding_rates."
},
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. On `positions` it needs `start` and is refused without it. On `hourly` it is exclusive and defaults to now. On `funding_rates` it is inclusive and needs `symbol`. Used by view: symbol_metrics, positions, indices, hourly, funding_rates."
},
"axis": {
"type": "string",
"enum": [
"size",
"pnl",
"pnl_abs"
],
"description": "Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. On `symbol_metrics` omit it to sum all cohorts; with `cohort` it slices one, and a `pnl` slice uses TODAY's grading for past hours (look-ahead: use hl_cohort_metrics with label_basis=point_in_time for research). Default by view: positions size. Used by view: symbol_metrics, positions."
},
"cohort": {
"type": "string",
"description": "One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for all wallets. Used by view: symbol_metrics, positions."
},
"opened_within": {
"type": "string",
"enum": [
"24h",
"7d",
"30d",
"all"
],
"default": "all",
"description": "Only positions opened within this window: `24h`, `7d`, `30d` or `all`; positions with no known open time are left out of every bounded window. Used by view: symbol_metrics."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Rows per page. On `indices`: max hourly rows, newest first; `has_more` says older ones exist, page back with `end` = the oldest `ts` minus 1 second. On `large_fills`: max fills, newest first; the source holds at most 200 per symbol, which is the default, and `has_more` says a lower `limit` cut rows. Default by view: symbol_metrics 500, positions 100, indices 5000, large_fills 200, funding_rates 500. Max by view: symbol_metrics 5000, positions 5000, indices 5000, large_fills 1000, funding_rates 5000. Used by view: symbol_metrics, positions, indices, large_fills, funding_rates."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Refused with `sort=size`. On `funding_rates` resend the same `symbol`, `sort` and `order`. Used by view: symbol_metrics, positions, funding_rates."
},
"label_basis": {
"type": "string",
"enum": [
"current"
],
"description": "`current` only: this series resolves the cohort label at query time, so `point_in_time` is refused by name; use hl_cohort_metrics for it. Used by view: symbol_metrics."
},
"wallet": {
"type": "string",
"description": "One wallet's positions only. Used by view: positions."
},
"open_only": {
"type": [
"boolean",
"string"
],
"default": true,
"description": "`true` (default) = the latest open positions. Passing `start` switches to the historical snapshots whatever this says; `false` without `start` is refused. Used by view: positions."
},
"sort": {
"type": "string",
"enum": [
"size",
"oi",
"rate",
"abs_rate"
],
"description": "`positions`: `size` = the biggest current positions of ONE `symbol` first (by notional, then wallet, then direction), each row carrying the wallet's native `account_value`. Needs `symbol`, `limit` at most 500, no `cursor` and no `start`/`end`. Omit it for key order. `funding_rates` (the board, no `symbol`): `oi` (open interest in USD, the default), `rate` or `abs_rate` (the size of the rate whatever its sign). Used by view: positions, funding_rates."
},
"resolution": {
"type": "string",
"enum": [
"5m",
"1h"
],
"description": "`positions` history only (needs `start`): `5m` = every snapshot, ~5 minutes apart; `1h` = the last snapshot of each hour, ~12x fewer rows. Default `1h` when `wallet` is given, `5m` otherwise; a `5m` read of one wallet is limited to 48 hours. Used by view: positions."
},
"hours": {
"type": [
"integer",
"string"
],
"description": "`indices`: window length in hours when `start` is omitted, ending at `end` or now. `large_fills`: how far back to look, at most 24. Default by view: indices 168, large_fills 24. Max by view: indices 8760, large_fills 24. Used by view: indices, large_fills."
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 50000,
"description": "`large_fills` only: smallest fill in USD. 50000 is also the minimum: nothing smaller is held. Used by view: large_fills."
},
"symbols": {
"type": "string",
"description": "Comma-separated perp tickers, e.g. `BTC,ETH,SOL`; at most 64. Used by view: hourly. Required by view: hourly."
},
"days": {
"type": [
"integer",
"string"
],
"default": 120,
"description": "Window length in days back from `end`, 1 to 400. `start` overrides it. Used by view: hourly."
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc",
"description": "`funding_rates` only: `desc` (default: the board largest first, a history newest hour first) or `asc`. Used by view: funding_rates."
}
},
"required": []
}