{"openapi":"3.1.0","info":{"title":"Hyperdash Data API","version":"v1","description":"Hyperliquid data from Hyperdash's own nodes and stored datasets; requests never call Hyperliquid's public API. Every response reports the credits it cost."},"servers":[{"url":"https://data.hyperdash.com"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"hdk_sk_live_v1_… or hdk_sk_test_v1_…"}},"schemas":{"Problem":{"type":"object","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string"},"detail":{"type":"string"},"hint":{"type":"string"},"request_id":{"type":"string"}}}}},"paths":{"/v1/markets/{coin}/candles":{"get":{"operationId":"getCandles","summary":"Candles for one market (1m … 1M)","description":"Ascending candles in [start_time, end_time). 1m: range ≤ 7 days. Sub-minute (1s, 15s, 30s): the last ~23 hours only, buckets with trades only, range ≤ 1 day. Coarser intervals: range ≤ 7 days (< 1h bars), 30 days (< 1d) or 365 days (1d and coarser); ≤ 5,000 bars per page (meta.forming flags an unfinished last bar). Page with the cursor. HIP-4 outcome markets: coin = #<outcome id><side> (e.g. #232960). Trades follow Hyperliquid's candles: spot borrow liquidations by the backstop (off-book at 0.99 × mark) and internal vault netting are not trades; trades with a liquidated party count in `v` and `n` but set prices only in a bar that has nothing else (`liq_only`); open and close are the first and last trade: in execution order where bars come from Hyperdash's node archive (the live window, and intervals other than 1m within the archive); bars from the durable 1m store (1m older than about 30 minutes, coarser intervals older than the archive) order trades inside one millisecond by taker order and sweep position, which matches the execution order on all but about 0.05 % of bar edges.\n\nPricing: base + per row; ×2 above 24 h. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA, #232960 (an outcome side; URL-encode # as %23).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.#]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"1m (exact archive, ≤ 7 days per call), 1s / 15s / 30s (last ~23 h, ≤ 1 day per call) or 3m, 5m, 15m, 30m, 1h, 2h, 4h, 8h, 12h, 1d, 3d, 1w, 1M (range ≤ 7 / 30 / 365 days by bar size).","schema":{"type":"string","default":"1m","enum":["1s","15s","30s","1m","3m","5m","15m","30m","1h","2h","4h","8h","12h","1d","3d","1w","1M"]}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Minute start, epoch ms"},"o":{"type":"string","description":"Open (decimal string; may carry extra trailing zeros)"},"h":{"type":"string","description":"High (decimal string; may carry extra trailing zeros)"},"l":{"type":"string","description":"Low (decimal string; may carry extra trailing zeros)"},"c":{"type":"string","description":"Close (decimal string; may carry extra trailing zeros)"},"v":{"type":"string","description":"Base volume (decimal string; may carry extra trailing zeros)"},"q":{"type":["string","null"],"description":"Quote volume (USD) (decimal string; may carry extra trailing zeros)"},"n":{"type":"integer","description":"Trades"},"liq_only":{"type":["boolean","null"],"description":"Prices of the bar come only from liquidation fills (true), from regular trades (false), or unknown (null: 1m bars older than the live window, and bars before 2025-07-28)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/candles?limit=60'"}]}},"/v1/accounts/{address}/fills":{"get":{"operationId":"getAccountFills","summary":"Fills of one wallet","description":"Ascending by (time, coin, tid) in [start_time, end_time]: every raw fill (each match with each resting order is its own row). `aggregate=true`: ascending by (time, order id), one fill per order per block as hyperdash.com shows them (Hyperliquid's aggregateByTime: an order's partial fills in one block merged — size, fee, builder fee, deployer fee, priority gas and closed PnL summed, size-weighted price, the first fill's tid, start position and direction), read from Hyperdash's node fill store, so counts are lower than raw. Range ≤ 7 days; page with the cursor.\n\nPricing: base + per row; ×2 above 24 h. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"aggregate","in":"query","required":false,"description":"true: merge each order's partial fills of one block into one fill (as hyperdash.com). Default: raw fills.","schema":{"type":"string","default":"false","enum":["false","true"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"B (buy) or A (sell)"},"px":{"type":"string","description":"Price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (decimal string; may carry extra trailing zeros)"},"dir":{"type":"string","description":"Open Long, Close Short, …"},"start_position":{"type":"string","description":"Position before this fill (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":"string","description":"Realized PnL (decimal string; may carry extra trailing zeros)"},"fee":{"type":"string","description":"Fee (decimal string; may carry extra trailing zeros)"},"fee_token":{"type":"string","description":"Fee asset"},"crossed":{"type":"boolean","description":"Taker"},"hash":{"type":"string","description":"Transaction hash"},"oid":{"type":"string","description":"Order id"},"tid":{"type":"string","description":"Trade id"},"twap_id":{"type":["string","null"],"description":"TWAP id"},"builder":{"type":["string","null"],"description":"Builder code (address) the order was sent with; null if none. Recorded from 2025-07-28: null on earlier fills"},"builder_fee":{"type":["string","null"],"description":"Builder fee, in fee_token and included in fee; null without a builder or when the node did not report it (decimal string; may carry extra trailing zeros)"},"cloid":{"type":["string","null"],"description":"Client order id the order was placed with; null if none. Stored fills (and aggregate=true older than 12 h): from 2025-07-28 (null before)"},"liquidated_user":{"type":["string","null"],"description":"This fill is part of a liquidation: the liquidated wallet (both legs carry it: equal to the wallet = its own liquidation). Null otherwise. Stored fills (and aggregate=true older than 12 h): from 2025-03-22"},"liquidation_mark_px":{"type":["string","null"],"description":"Mark price the liquidation was triggered at (decimal string; may carry extra trailing zeros)"},"liquidation_method":{"type":["string","null"],"description":"market or backstop"},"deployer_fee":{"type":["string","null"],"description":"HIP-3 deployer's share of the fee (in fee_token, part of fee; negative on a maker rebate); null on core markets. Stored fills (and aggregate=true older than 12 h): from 2025-07-28, but the node fill carries it only from 2026-03-21 09:33 UTC (null on earlier HIP-3 fills). aggregate=true: the sum over the merged fills that carry one (decimal string; may carry extra trailing zeros)"},"priority_gas":{"type":["string","null"],"description":"Priority gas paid for the order (HYPE); null if none. Stored fills (and aggregate=true older than 12 h): from 2026-04-13. aggregate=true: the sum over the merged fills that carry one (decimal string; may carry extra trailing zeros)"},"sub_builders":{"type":["string","null"],"description":"Sub-builders sharing this fill's builder fee: JSON array [{\"address\", \"share\"}], share in 1/100,000 of the builder fee; null if none or the list failed the node's validation. Stored fills: from 2026-10-26"},"tx_index":{"type":["integer","null"],"description":"Index of the fill's transaction in its block (orders fills of one millisecond); null on stored fills (not recorded)"},"block_number":{"type":["integer","null"],"description":"Height of the node block that carried the fill. Raw (stored) fills only, from 2025-07-28 (null before); null on aggregate=true and the fills stream"},"block_time":{"type":["integer","null"],"description":"Time of that block, epoch ms (equals the fill's time on every fill checked). Same coverage as block_number"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/fills?limit=100'"}]}},"/v1/accounts/{address}/positions":{"get":{"operationId":"getAccountPositions","summary":"Open positions of one wallet on one dex","description":"Live clearinghouse state for one dex: the core exchange by default, or a HIP-3 builder dex via `dex`. One dex per call. meta.margin: the dex's margin summary (account value, notional, raw USD, margin used, withdrawable) and its cross-margin part. Rows also carry `leverage` {type, value} and `cum_funding` {all_time, since_open, since_change} as nested objects (the original shape), with the same values as the flat fields.\n\nPricing: base + per position + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"dex","in":"query","required":false,"description":"Builder dex (e.g. xyz). Omit for the core exchange.","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"size":{"type":"string","description":"Signed size (negative = short) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"position_value":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (decimal string; may carry extra trailing zeros)"},"return_on_equity":{"type":"string","description":"ROE (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"margin_used":{"type":"string","description":"Margin used (decimal string; may carry extra trailing zeros)"},"max_leverage":{"type":"integer","description":"Max leverage"},"leverage_type":{"type":"string","description":"cross or isolated"},"leverage_value":{"type":"integer","description":"Leverage"},"leverage_raw_usd":{"type":["string","null"],"description":"Isolated positions: the raw USD (margin) allocated to the position (decimal string; may carry extra trailing zeros)"},"cum_funding_all_time":{"type":"string","description":"Funding paid on this market, all time (positive = paid) (decimal string; may carry extra trailing zeros)"},"cum_funding_since_open":{"type":"string","description":"Funding paid since the position opened (decimal string; may carry extra trailing zeros)"},"cum_funding_since_change":{"type":"string","description":"Funding paid since the position size last changed (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/positions?dex=xyz'"}]}},"/v1/markets":{"get":{"operationId":"listMarkets","summary":"Perp markets with live context","description":"All perp markets of one dex (core exchange by default) with live prices, funding, open interest and volume. HIP-3 dexes are computed by Hyperdash from its own nodes: `mark_px` there is Hyperdash's estimate (`mark_px_estimated`; usually within 0.05 % of the exchange's mark, but it can stay at the oracle and differ by about 1 % on a market trading away from it) and the predicted `funding` is null until Hyperdash's computation is verified against the exchange's samples (`funding_unverified`; `last_settled_funding` carries the rate settled at the last hour).\n\nPricing: base + two node reads. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"dex","in":"query","required":false,"description":"Builder dex (e.g. xyz). Omit for the core exchange.","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market (HIP-3 markets are prefixed, e.g. xyz:TSLA)"},"sz_decimals":{"type":"integer","description":"Size decimals"},"max_leverage":{"type":"integer","description":"Max leverage"},"mark_px":{"type":["string","null"],"description":"Mark price (decimal string; may carry extra trailing zeros)"},"oracle_px":{"type":["string","null"],"description":"Oracle price (decimal string; may carry extra trailing zeros)"},"mid_px":{"type":["string","null"],"description":"Book mid (decimal string; may carry extra trailing zeros)"},"funding":{"type":["string","null"],"description":"Current hourly funding rate (decimal string; may carry extra trailing zeros)"},"premium":{"type":["string","null"],"description":"Premium (decimal string; may carry extra trailing zeros)"},"open_interest":{"type":["string","null"],"description":"Open interest (base units) (decimal string; may carry extra trailing zeros)"},"prev_day_px":{"type":["string","null"],"description":"Price 24 h ago (decimal string; may carry extra trailing zeros)"},"day_ntl_vlm":{"type":["string","null"],"description":"24 h notional volume (USD) (decimal string; may carry extra trailing zeros)"},"day_base_vlm":{"type":["string","null"],"description":"24 h base volume (decimal string; may carry extra trailing zeros)"},"impact_bid_px":{"type":["string","null"],"description":"Impact bid (decimal string; may carry extra trailing zeros)"},"impact_ask_px":{"type":["string","null"],"description":"Impact ask (decimal string; may carry extra trailing zeros)"},"is_delisted":{"type":"boolean","description":"Delisted"},"margin_table_id":{"type":["integer","null"],"description":"Margin table (see /v1/markets/margin-tables)"},"only_isolated":{"type":"boolean","description":"Isolated margin only (no cross)"},"margin_mode":{"type":["string","null"],"description":"Margin mode the node sets on restricted markets (e.g. strictIsolated, noCross); null = normal"},"growth_mode":{"type":["string","null"],"description":"HIP-3 growth mode (enabled / disabled); null on the core exchange"},"deployer_fee_scale":{"type":["string","null"],"description":"HIP-3 deployer fee scale (multiplies the deployer's fee share); null on the core exchange (decimal string; may carry extra trailing zeros)"},"last_fee_scale_change_time":{"type":["integer","null"],"description":"HIP-3: last change of the deployer fee scale (epoch ms)"},"mark_px_estimated":{"type":"boolean","description":"true: Hyperdash estimates this mark itself rather than reading the exchange's mark (some HIP-3 markets); false = not flagged"},"funding_unverified":{"type":"boolean","description":"true: `funding` (the predicted rate) is null because Hyperdash computes it itself and has not verified it against the exchange's own samples (today every live HIP-3 market, and core markets whose premium rule is not reproduced yet, e.g. XTEN); see last_settled_funding for the rate settled at the last hour; false = not flagged"},"prev_day_px_seeded":{"type":"boolean","description":"true: prev_day_px comes from a one-time seed (the market had no trade in Hyperdash's history window); false = not flagged"},"volume_inexact":{"type":"boolean","description":"true: the 24 h volumes are approximate; false = not flagged, which is no accuracy guarantee"},"last_settled_funding":{"type":["string","null"],"description":"HIP-3, when Hyperdash computes the context itself: the last settled hourly funding rate (not the predicted `funding`); null otherwise (decimal string; may carry extra trailing zeros)"},"last_settled_funding_time":{"type":["integer","null"],"description":"Time of last_settled_funding (epoch ms); null when not set"},"collateral_token":{"type":["integer","null"],"description":"Collateral token of the dex (spot token index; 0 = USDC)"},"at_oi_cap":{"type":"boolean","description":"At its open-interest cap (new positions only reduce)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets'"}]}},"/v1/markets/{coin}/twaps":{"get":{"operationId":"listMarketTwaps","summary":"Active TWAPs of one market","description":"Every running (or trigger-waiting) TWAP order of one core-exchange perp from the latest node state snapshot: wallet, side, total / executed / remaining size, executed notional, progress, duration, next slice. Largest first; at most 100 per answer (and your plan's wallet-list cap). meta.snapshot_id identifies the node state. The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Core-exchange perp, e.g. BTC, kPEPE (HIP-3 markets are not covered).","schema":{"type":"string","pattern":"^(?![Aa][Ll][Ll]$)[A-Za-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet running the TWAP"},"twap_id":{"type":"string","description":"TWAP id (decimal string: 64-bit)"},"side":{"type":"string","description":"buy or sell"},"total_sz":{"type":"string","description":"Total size (base) (decimal string; may carry extra trailing zeros)"},"executed_sz":{"type":"string","description":"Executed size (decimal string; may carry extra trailing zeros)"},"remaining_sz":{"type":"string","description":"Remaining size (decimal string; may carry extra trailing zeros)"},"executed_notional":{"type":"string","description":"Executed notional (USD) (decimal string; may carry extra trailing zeros)"},"progress_pct":{"type":"string","description":"Progress (0-100) (decimal string; may carry extra trailing zeros)"},"duration_s":{"type":"integer","description":"Duration (s)"},"start_time":{"type":"integer","description":"Start, epoch ms"},"reduce_only":{"type":"boolean","description":"Reduce-only"},"randomize":{"type":"boolean","description":"Randomized slices"},"next_slice_time":{"type":["string","null"],"description":"Next slice (ISO-8601)"},"slices_done":{"type":"integer","description":"Slices executed"},"waiting":{"type":"boolean","description":"Waiting for its trigger"},"stop_px":{"type":["string","null"],"description":"Stop price: a buy TWAP stops once the price reaches it from below, a sell from above. HL announced (2026-10-29) that it will pause there instead and resume when the price comes back. (decimal string; may carry extra trailing zeros)"},"trigger_px":{"type":["string","null"],"description":"Trigger price of a TWAP waiting to start (decimal string; may carry extra trailing zeros)"},"trigger_above":{"type":["boolean","null"],"description":"Starts when the price rises above (true) or falls below (false) trigger_px"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/twaps'"}]}},"/v1/spot/{token}/twaps":{"get":{"operationId":"listSpotTwaps","summary":"Active TWAPs of one spot token","description":"Every running (or trigger-waiting) TWAP order on one spot token's pairs from the latest node state snapshot: wallet, pair, side, total / executed / remaining size, executed notional, progress, duration, next slice. Largest first; at most 100 per answer (and your plan's wallet-list cap). meta.snapshot_id identifies the node state. The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["spot"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"token","in":"path","required":true,"description":"Spot token name, e.g. HYPE, PURR.","schema":{"type":"string","pattern":"^(?![Aa][Ll][Ll]$)[A-Za-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet running the TWAP"},"twap_id":{"type":"string","description":"TWAP id (decimal string: 64-bit)"},"pair":{"type":["string","null"],"description":"Spot pair, e.g. HYPE/USDC"},"pair_id":{"type":["string","null"],"description":"Spot pair id, e.g. @107"},"side":{"type":"string","description":"buy or sell"},"total_sz":{"type":"string","description":"Total size (base) (decimal string; may carry extra trailing zeros)"},"executed_sz":{"type":"string","description":"Executed size (decimal string; may carry extra trailing zeros)"},"remaining_sz":{"type":"string","description":"Remaining size (decimal string; may carry extra trailing zeros)"},"executed_notional":{"type":"string","description":"Executed notional (quote) (decimal string; may carry extra trailing zeros)"},"progress_pct":{"type":"string","description":"Progress (0-100) (decimal string; may carry extra trailing zeros)"},"duration_s":{"type":"integer","description":"Duration (s)"},"start_time":{"type":"integer","description":"Start, epoch ms"},"reduce_only":{"type":"boolean","description":"Reduce-only"},"randomize":{"type":"boolean","description":"Randomized slices"},"next_slice_time":{"type":["string","null"],"description":"Next slice (ISO-8601)"},"slices_done":{"type":"integer","description":"Slices executed"},"waiting":{"type":"boolean","description":"Waiting for its trigger"},"stop_px":{"type":["string","null"],"description":"Stop price: a buy TWAP stops once the price reaches it from below, a sell from above. HL announced (2026-10-29) that it will pause there instead and resume when the price comes back. (decimal string; may carry extra trailing zeros)"},"trigger_px":{"type":["string","null"],"description":"Trigger price of a TWAP waiting to start (decimal string; may carry extra trailing zeros)"},"trigger_above":{"type":["boolean","null"],"description":"Starts when the price rises above (true) or falls below (false) trigger_px"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/spot/HYPE/twaps'"}]}},"/v1/markets/{coin}/twap-levels":{"get":{"operationId":"getMarketTwapLevels","summary":"TWAP stop and trigger levels of one market","description":"Where running TWAP flow switches off and waiting TWAP flow switches on, from the latest node state snapshot (meta.snapshot_id): one row per price level, kind and side. kind=stop: running TWAPs that stop once the price reaches px (a buy from below, a sell from above; HL announced it will pause them there instead and resume when the price comes back). kind=trigger: TWAPs waiting to start once the price moves above / below px (a waiting TWAP's stop applies once it has started). Each row sums the TWAPs' remaining size and their average size per minute (remaining size over the remaining scheduled time, both at the snapshot's cut — meta.as_of = meta.snapshot_time, null when unknown; a running TWAP of an undated snapshot counts its time left in its own 30 s slices —; a waiting TWAP: its size over its duration). The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected. Aggregated, no wallets. Highest price first; meta.levels counts every level and meta.truncated is true when more than 500 exist. meta adds the market's unconditional TWAP flow: running buy / sell TWAPs, their remaining size and average size per minute, and how many wait for a trigger.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Core-exchange perp, e.g. BTC, kPEPE (HIP-3 markets are not covered).","schema":{"type":"string","pattern":"^(?![Aa][Ll][Ll]$)[A-Za-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"px":{"type":"string","description":"Price level (decimal string; may carry extra trailing zeros)"},"kind":{"type":"string","description":"stop (flow switches off here) or trigger (flow switches on here)"},"side":{"type":"string","description":"buy or sell"},"when":{"type":"string","description":"above or below: the TWAPs act once the price moves above / below px"},"twaps":{"type":"integer","description":"TWAPs at this level"},"remaining_sz":{"type":"string","description":"Size they still have to trade (base) (decimal string; may carry extra trailing zeros)"},"remaining_notional":{"type":"string","description":"remaining_sz × px (quote) (decimal string; may carry extra trailing zeros)"},"flow_sz_per_min":{"type":"string","description":"Average size per minute they trade (base) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/twap-levels'"}]}},"/v1/spot/{token}/twap-levels":{"get":{"operationId":"getSpotTwapLevels","summary":"TWAP stop and trigger levels of one spot token","description":"Where running TWAP flow switches off and waiting TWAP flow switches on, from the latest node state snapshot (meta.snapshot_id): one row per price level, kind and side. kind=stop: running TWAPs that stop once the price reaches px (a buy from below, a sell from above; HL announced it will pause them there instead and resume when the price comes back). kind=trigger: TWAPs waiting to start once the price moves above / below px (a waiting TWAP's stop applies once it has started). Each row sums the TWAPs' remaining size and their average size per minute (remaining size over the remaining scheduled time, both at the snapshot's cut — meta.as_of = meta.snapshot_time, null when unknown; a running TWAP of an undated snapshot counts its time left in its own 30 s slices —; a waiting TWAP: its size over its duration). The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected. Aggregated, no wallets. Highest price first; meta.levels counts every level and meta.truncated is true when more than 500 exist. Levels are per spot pair of the token (px and notional in that pair's quote). meta adds the unconditional TWAP flow as for markets.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["spot"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"token","in":"path","required":true,"description":"Spot token name, e.g. HYPE, PURR.","schema":{"type":"string","pattern":"^(?![Aa][Ll][Ll]$)[A-Za-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"px":{"type":"string","description":"Price level (decimal string; may carry extra trailing zeros)"},"kind":{"type":"string","description":"stop (flow switches off here) or trigger (flow switches on here)"},"side":{"type":"string","description":"buy or sell"},"when":{"type":"string","description":"above or below: the TWAPs act once the price moves above / below px"},"pair":{"type":["string","null"],"description":"Spot pair, e.g. HYPE/USDC (px in its quote)"},"twaps":{"type":"integer","description":"TWAPs at this level"},"remaining_sz":{"type":"string","description":"Size they still have to trade (base) (decimal string; may carry extra trailing zeros)"},"remaining_notional":{"type":"string","description":"remaining_sz × px (quote) (decimal string; may carry extra trailing zeros)"},"flow_sz_per_min":{"type":"string","description":"Average size per minute they trade (base) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/spot/HYPE/twap-levels'"}]}},"/v1/markets/twap-pressure/active":{"get":{"operationId":"getActiveTwapPressure","summary":"Net pressure of the TWAPs running now","description":"hyperdash.com's Net TWAP Pressure table: per core-exchange perp, the remaining size of every TWAP running at the latest node state snapshot (meta.snapshot_id; meta.as_of = meta.snapshot_time, when it was cut, null when unknown), priced at the TWAP's own average fill price, or at the live mid when it has no fill yet: buy and sell notional, net = buy − sell, and the number of TWAPs. TWAPs waiting for a trigger are not counted (meta.waiting_twaps; their levels: GET /v1/markets/{coin}/twap-levels). Markets whose buy + sell notional is under `min_volume` are left out (default $1M, as the site; a fixed choice of 0, $1M or $10M). Ranked by |net|. Aggregates only: no wallets (one market's TWAPs with their wallets: GET /v1/markets/{coin}/twaps). For FILLED TWAP flow over a window: GET /v1/markets/twap-pressure. HIP-3 markets are not covered (the snapshot holds core perps). The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected.\n\nPricing: base + per row + node reads. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"market","in":"query","required":false,"description":"One core perp, e.g. BTC, kPEPE (case-insensitive; omit for every market).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"min_volume","in":"query","required":false,"description":"Smallest buy + sell notional (USD): 0 (any), 1000000 or 10000000.","schema":{"type":"string","default":"1000000","enum":["0","1000000","10000000"]}},{"name":"limit","in":"query","required":false,"description":"Markets.","schema":{"type":"integer","minimum":1,"maximum":500,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"buy_notional":{"type":"string","description":"Remaining size of the running buy TWAPs × their average fill price (USD) (decimal string; may carry extra trailing zeros)"},"sell_notional":{"type":"string","description":"Remaining size of the running sell TWAPs × their average fill price (USD) (decimal string; may carry extra trailing zeros)"},"net_notional":{"type":"string","description":"buy_notional − sell_notional (USD) (decimal string; may carry extra trailing zeros)"},"twaps":{"type":"integer","description":"Running TWAPs counted"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/twap-pressure/active?min_volume=0'"}]}},"/v1/markets/{coin}/book/orders":{"get":{"operationId":"getL4Book","summary":"Order-level (L4) book near the mid","description":"Every order resting within ±`band_bps` of the mid (up to ±2 %; up to ±10 % where the bounded order-book selection is live — a wider band than the deployment allows is a 400), WITH its owner wallet, order id, placement time and TIF, from Hyperdash's own nodes: nearest to the mid first, bids and asks interleaved; at most `limit` orders (and your plan's wallet-list cap). Queue order: within one side and price, list order IS the queue position (front first) — do not re-sort by `time` (placement time, not queue-entry time). Which of these orders bought queue priority: POST /v1/markets/{coin}/alo-priority/lookup with their oids. meta: mid, band, node time/height, total orders per side in the band and whether the answer was cut. The mid comes from the market's live L2 book, so a market takes one of your workspace's order-book slots exactly as GET /v1/markets/{coin}/book (same cap, same 429 and Retry-After, same 503 while its book has no level). Growth plans and above.\n\nPricing: base + per order + one facade read. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA, @107.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"band_bps","in":"query","required":false,"description":"Half-width of the price band around the mid, in basis points (50 = ±0.5 %). Above 200 only where the deployment enables it (400 otherwise).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":50}},{"name":"limit","in":"query","required":false,"description":"Orders (both sides).","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","description":"bid or ask"},"px":{"type":"string","description":"Limit price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Remaining size (base) (decimal string; may carry extra trailing zeros)"},"orig_sz":{"type":["string","null"],"description":"Size the order was placed with (sz is what still rests; they differ once it was partly filled) (decimal string; may carry extra trailing zeros)"},"oid":{"type":["string","null"],"description":"Order id (decimal string; see alo-priority/lookup)"},"user":{"type":["string","null"],"description":"Owner wallet"},"time":{"type":["integer","null"],"description":"Placement time, epoch ms (not queue-entry time: the queue is the list order within a price)"},"tif":{"type":["string","null"],"description":"Time in force (Alo, Gtc, Ioc or FrontendMarket; null when the node reports none)"},"order_type":{"type":["string","null"],"description":"Order type"},"reduce_only":{"type":"boolean","description":"Reduce-only"},"is_trigger":{"type":"boolean","description":"Trigger order"},"trigger_px":{"type":["string","null"],"description":"Trigger price (trigger orders) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/book/orders?band_bps=20&limit=200'"}]}},"/v1/markets/margin-tables":{"get":{"operationId":"listMarginTables","summary":"Tiered margin tables","description":"Margin tables of one dex (core exchange by default): one row per tier — from `lower_bound` (position notional, USD) the max leverage drops to `max_leverage`. Markets reference a table by `margin_table_id` in /v1/markets.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"dex","in":"query","required":false,"description":"Builder dex (e.g. xyz). Omit for the core exchange.","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"table_id":{"type":"integer","description":"Margin table id"},"description":{"type":["string","null"],"description":"Table description"},"tier":{"type":"integer","description":"Tier, 0 = smallest positions"},"lower_bound":{"type":"string","description":"Position notional (USD) where the tier starts (decimal string; may carry extra trailing zeros)"},"max_leverage":{"type":"integer","description":"Max leverage in the tier"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/margin-tables'"}]}},"/v1/lending/reserves":{"get":{"operationId":"listLendingReserves","summary":"Borrow/lend reserves","description":"HyperCore borrow/lend reserve of every token: supply and borrow APR, utilization, supplied, borrowed and available balance, oracle price and loan-to-value.\n\nPricing: base + two node reads. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["lending"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"token":{"type":["string","null"],"description":"Token name"},"token_index":{"type":"integer","description":"Token index"},"supply_apr":{"type":"string","description":"Supply rate (yearly, fraction) (decimal string; may carry extra trailing zeros)"},"borrow_apr":{"type":"string","description":"Borrow rate (yearly, fraction) (decimal string; may carry extra trailing zeros)"},"utilization":{"type":"string","description":"Borrowed / supplied (decimal string; may carry extra trailing zeros)"},"total_supplied":{"type":"string","description":"Supplied (token units) (decimal string; may carry extra trailing zeros)"},"total_borrowed":{"type":"string","description":"Borrowed (token units) (decimal string; may carry extra trailing zeros)"},"available":{"type":"string","description":"Available to borrow (token units) (decimal string; may carry extra trailing zeros)"},"oracle_px":{"type":"string","description":"Oracle price (USD) (decimal string; may carry extra trailing zeros)"},"ltv":{"type":"string","description":"Loan-to-value as collateral (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/lending/reserves'"}]}},"/v1/network/deploy-auctions":{"get":{"operationId":"listDeployAuctions","summary":"Perp and spot deploy gas auctions","description":"Current Dutch gas auctions for deploying a HIP-3 perp dex/market (`perp`), a spot token (`spot`) and a spot pair (`spot_pair`): start, duration, start and current gas (HYPE), end gas once settled.\n\nPricing: base + three node reads. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 3 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"perp, spot or spot_pair"},"start_time":{"type":"integer","description":"Auction start, epoch ms"},"duration_s":{"type":"integer","description":"Duration (s)"},"start_gas":{"type":"string","description":"Starting gas (HYPE) (decimal string; may carry extra trailing zeros)"},"current_gas":{"type":["string","null"],"description":"Current gas (HYPE) (decimal string; may carry extra trailing zeros)"},"end_gas":{"type":["string","null"],"description":"Final gas when the auction ended (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/deploy-auctions'"}]}},"/v1/markets/{coin}/book":{"get":{"operationId":"getOrderBook","summary":"Order book snapshot (20 levels)","description":"Current L2 order book of one market from Hyperdash's own nodes: one row per level, bids best-first then asks best-first. meta.time = the node's book time. A market nobody is following yet is started for you (its first call waits up to 3 s). A workspace can keep a few markets live that nobody else follows (currently 2, shared with its book subscriptions and L4 reads; one stays yours for 15 minutes after your last use; markets others keep live don't count); past that, or when the deployment's order-book capacity is full, the call is refused with rate_limited (Retry-After = when your first market's slot frees, up to 15 min; 60 s when the deployment is full). An unknown market is a 404 at once. A book with no level on either side is never served as the answer: 503 unavailable with Retry-After — its feed is still starting, or nothing rests in it.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 40 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA, @107.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","description":"bid or ask"},"level":{"type":"integer","description":"0 = best"},"px":{"type":"string","description":"Price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size at the level (decimal string; may carry extra trailing zeros)"},"orders":{"type":"integer","description":"Orders at the level"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/book'"}]}},"/v1/markets/mids":{"get":{"operationId":"listMids","summary":"Mid price of every market","description":"Live mid of every market Hyperdash's order books track: core and builder-dex (HIP-3, e.g. xyz:NVDA) perps, spot pairs (@index) and outcomes (#…). Book mid; crossed books fall back to mark.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 20,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market (spot pairs as @index or PURR/USDC)"},"mid":{"type":"string","description":"Mid price (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/mids'"}]}},"/v1/spot/markets":{"get":{"operationId":"listSpotMarkets","summary":"Spot markets with live context","description":"Every spot pair with base/quote tokens, live mark and mid, 24 h volume and supply.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 5,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["spot"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Pair id as used by the API (@index or PURR/USDC)"},"name":{"type":"string","description":"Pair name"},"base":{"type":"string","description":"Base token"},"quote":{"type":"string","description":"Quote token"},"is_canonical":{"type":"boolean","description":"Canonical pair"},"index":{"type":["integer","null"],"description":"Pair index (the pair is @index)"},"base_token_index":{"type":["integer","null"],"description":"Base token index (see /v1/spot/tokens)"},"quote_token_index":{"type":["integer","null"],"description":"Quote token index (see /v1/spot/tokens)"},"mark_px":{"type":["string","null"],"description":"Mark price (decimal string; may carry extra trailing zeros)"},"mid_px":{"type":["string","null"],"description":"Mid price (decimal string; may carry extra trailing zeros)"},"prev_day_px":{"type":["string","null"],"description":"Price 24 h ago (decimal string; may carry extra trailing zeros)"},"day_ntl_vlm":{"type":["string","null"],"description":"24 h notional volume (decimal string; may carry extra trailing zeros)"},"day_base_vlm":{"type":["string","null"],"description":"24 h base volume (decimal string; may carry extra trailing zeros)"},"circulating_supply":{"type":["string","null"],"description":"Circulating supply of the base token (decimal string; may carry extra trailing zeros)"},"total_supply":{"type":["string","null"],"description":"Total supply of the base token (decimal string; may carry extra trailing zeros)"},"mark_px_estimated":{"type":"boolean","description":"true: Hyperdash estimates this mark itself (median of best bid, best ask and last trade); false = not flagged"},"day_stats_lagged":{"type":"boolean","description":"true: prev_day_px and the 24 h volumes come from Hyperdash's own fills, while the exchange refreshes a pair's day stats lazily, so they can differ from its figures at a given instant; false = not flagged"},"prev_day_px_seeded":{"type":"boolean","description":"true: prev_day_px comes from a one-time seed (no trade in Hyperdash's history window); false = not flagged"},"volume_inexact":{"type":"boolean","description":"true: the 24 h volumes are approximate; false = not flagged, which is no accuracy guarantee"},"book_pending":{"type":"boolean","description":"true: Hyperdash's copy of the pair's order book is incomplete at this instant (an order whose status had not arrived yet), so mark_px and mid_px are null for this pair; false = not flagged"},"supply_as_of":{"type":["integer","null"],"description":"When Hyperdash computes supply itself: the node-state snapshot the supply comes from (epoch ms); null otherwise"},"supply_approx":{"type":"boolean","description":"true: the supply is approximate (HYPE: staking balances and future emissions are not all in the node state, so total supply may be null); false = not flagged"},"supply_unavailable":{"type":"boolean","description":"true: Hyperdash has no usable supply for the base token (in-house supply off, stale or missing from the latest node-state snapshot), so the supplies are null; false = not flagged"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/spot/markets'"}]}},"/v1/spot/tokens":{"get":{"operationId":"listSpotTokens","summary":"Spot tokens","description":"Every spot token (spot metadata from our own nodes): index, token id, decimals, its HyperEVM contract, deployer fee share and label.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 5,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["spot"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Token"},"index":{"type":"integer","description":"Token index (base_token_index / quote_token_index on /v1/spot/markets)"},"token_id":{"type":["string","null"],"description":"Token id (0x + 32 hex)"},"full_name":{"type":["string","null"],"description":"Full name, if the deployer set one"},"sz_decimals":{"type":"integer","description":"Size decimals"},"wei_decimals":{"type":"integer","description":"Wei decimals (on HyperCore)"},"is_canonical":{"type":"boolean","description":"Canonical token"},"evm_contract":{"type":["string","null"],"description":"Linked HyperEVM ERC-20 contract; null if not linked"},"evm_extra_wei_decimals":{"type":["integer","null"],"description":"Extra decimals of the EVM contract over wei_decimals (may be negative)"},"deployer_trading_fee_share":{"type":["string","null"],"description":"Share of trading fees paid to the token deployer (decimal string; may carry extra trailing zeros)"},"deployer_label":{"type":["string","null"],"description":"Deployer label, when set"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/spot/tokens'"}]}},"/v1/dexs":{"get":{"operationId":"listDexs","summary":"HIP-3 builder dexs","description":"Builder-deployed perp dexs (HIP-3): name, deployer, fee recipient, number of markets.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["dexs"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Dex name (use as `dex`)"},"full_name":{"type":["string","null"],"description":"Display name"},"deployer":{"type":["string","null"],"description":"Deployer wallet"},"oracle_updater":{"type":["string","null"],"description":"Oracle updater wallet"},"fee_recipient":{"type":["string","null"],"description":"Fee recipient wallet"},"markets":{"type":"integer","description":"Markets with an open-interest cap"},"sub_deployers":{"type":["string","null"],"description":"Wallets allowed to act for the deployer: JSON object action (registerAsset, setOracle, …) → wallets"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/dexs'"}]}},"/v1/dexs/{dex}/markets":{"get":{"operationId":"listDexMarkets","summary":"Per-market settings of one HIP-3 dex","description":"Every market of one builder dex with its open-interest cap and the deployer's funding overrides (multiplier, interest rate, clamp), from the node's dex state. Settings a market does not override are null. Live prices: GET /v1/markets?dex=….\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["dexs"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"dex","in":"path","required":true,"description":"Builder dex (e.g. xyz; see GET /v1/dexs).","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market (prefixed, e.g. xyz:TSLA)"},"oi_cap":{"type":["string","null"],"description":"Open-interest cap (USD notional) (decimal string; may carry extra trailing zeros)"},"funding_multiplier":{"type":["string","null"],"description":"Funding multiplier set by the deployer (decimal string; may carry extra trailing zeros)"},"funding_interest_rate":{"type":["string","null"],"description":"Funding interest rate set by the deployer (decimal string; may carry extra trailing zeros)"},"funding_clamp":{"type":["string","null"],"description":"Funding clamp set by the deployer (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/dexs/xyz/markets'"}]}},"/v1/markets/catalog":{"get":{"operationId":"listMarketCatalog","summary":"Every market's category, sector and asset class","description":"The taxonomy hyperdash.com uses for its leaderboard and OI filters, for every market of the main dex and the HIP-3 dexes: category (btc, eth_majors, hype, memes, equities, indices, commodities, fx, other), sector (majors, memes, alts, stocks, indices, commodities, fx; empty until a row's next sync) and asset class (crypto, stocks, indices, commodities, fx), and the market's display name on hyperdash.com (null until the market's next sync). Refreshed by the site's category sync (`updated_at`), which is run by hand: a market listed after the last sync is missing here until the next one, and GET /v1/markets/open-interest/by-category counts it as `unmapped`.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 5,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"category","in":"query","required":false,"description":"Only this category.","schema":{"type":"string","enum":["btc","eth_majors","hype","memes","equities","indices","commodities","fx","other"]}},{"name":"sector","in":"query","required":false,"description":"Only this sector.","schema":{"type":"string","enum":["majors","memes","alts","stocks","indices","commodities","fx"]}},{"name":"asset_class","in":"query","required":false,"description":"Only this asset class.","schema":{"type":"string","enum":["crypto","stocks","indices","commodities","fx"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"category":{"type":"string","description":"Category"},"sector":{"type":["string","null"],"description":"Sector"},"asset_class":{"type":"string","description":"Asset class"},"display_name":{"type":["string","null"],"description":"Display name on hyperdash.com (null until synced)"},"updated_at":{"type":"integer","description":"Synced at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/catalog?asset_class=stocks'"}]}},"/v1/dexs/{dex}/limits":{"get":{"operationId":"getDexLimits","summary":"A builder dex's open-interest and transfer limits","description":"One HIP-3 dex's limits from our node: the open-interest cap per market (rows), and in meta the dex's total OI cap, the size cap per perp and the largest transfer notional.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["dexs"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"dex","in":"path","required":true,"description":"HIP-3 dex name, e.g. xyz.","schema":{"type":"string","pattern":"^[a-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"oi_cap":{"type":"string","description":"Open-interest cap (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/dexs/xyz/limits'"}]}},"/v1/dexs/{dex}/status":{"get":{"operationId":"getDexStatus","summary":"A builder dex's net deposits","description":"One HIP-3 dex's status from our node: total net USDC deposited into it.\n\nPricing: base + one node read. Scope: `markets:read`.","tags":["dexs"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"dex","in":"path","required":true,"description":"HIP-3 dex name, e.g. xyz.","schema":{"type":"string","pattern":"^[a-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"dex":{"type":"string","description":"Dex"},"total_net_deposit":{"type":"string","description":"Total net deposit (USDC) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/dexs/xyz/status'"}]}},"/v1/markets/max-market-order-notionals":{"get":{"operationId":"listMaxMarketOrderNotionals","summary":"Largest market order per leverage tier","description":"The largest notional one market order may have, per maximum-leverage tier of the market (from our node).\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 50 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"max_leverage":{"type":"integer","description":"Market's maximum leverage"},"max_notional":{"type":"string","description":"Largest market-order notional (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/max-market-order-notionals'"}]}},"/v1/network/exchange-status":{"get":{"operationId":"getExchangeStatus","summary":"Exchange special statuses","description":"The exchange's special statuses (e.g. halts or maintenance flags, as published by the node; null when none) and the node time.\n\nPricing: base + one node read. Scope: `markets:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"special_statuses":{"type":["string","null"],"description":"Special statuses (JSON; null when none)"},"time":{"type":"integer","description":"Node time, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/exchange-status'"}]}},"/v1/outcomes/definitions":{"get":{"operationId":"listOutcomeDefinitions","summary":"HIP-4 outcome and question definitions (live)","description":"Every HIP-4 outcome (or question) as our node holds it right now: outcomes with their name, description (template fields), side names, quote token, deployer venue and fee scale; questions (events) with their name, description, fallback outcome and named outcomes. /outcomes/markets adds status, expiry, open interest and settlement.\n\nPricing: base + one node read. Scope: `markets:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"kind","in":"query","required":false,"description":"outcomes or questions.","schema":{"type":"string","default":"outcomes","enum":["outcomes","questions"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 5000).","schema":{"type":"integer","minimum":1,"maximum":5000,"default":5000}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"outcome":{"type":["integer","null"],"description":"Outcome id (outcomes)"},"question":{"type":["integer","null"],"description":"Question id (questions)"},"name":{"type":"string","description":"Name"},"description":{"type":["string","null"],"description":"Description as published"},"side_names":{"type":["string","null"],"description":"Side names (JSON array; outcomes)"},"quote_token":{"type":["string","null"],"description":"Quote token (outcomes)"},"venue":{"type":["string","null"],"description":"Deployer venue (outcomes)"},"deployer_fee_scale":{"type":["string","null"],"description":"Deployer fee scale (outcomes) (decimal string; may carry extra trailing zeros)"},"fallback_outcome":{"type":["integer","null"],"description":"Fallback outcome (questions)"},"named_outcomes":{"type":["string","null"],"description":"Outcome ids (JSON array; questions)"},"settled_named_outcomes":{"type":["string","null"],"description":"Settled outcome ids (JSON array; questions)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/definitions?kind=questions'"}]}},"/v1/spot/tokens/{token_id}/supply":{"get":{"operationId":"getTokenSupply","summary":"Token supply (node state)","description":"One spot token from our node's state: max supply and the balance sums behind circulating supply (wei strings: circulating ≈ balances_total_wei − nc_spot_wei; HYPE also has staked HYPE outside spot balances; for USDC, nc_spot_wei includes the HyperEVM bridge reserve), the deployer, deploy time and gas, and the deployer's trading-fee share. From our nodes' state snapshots (validators, tokens and vaults hourly; referrers daily), first published 2026-11-05 20:40 UTC. An answer always comes from one complete snapshot; none complete and fresh: 503 unavailable, retry later.\n\nPricing: base. Scope: `markets:read`.","tags":["spot"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"token_id","in":"path","required":true,"description":"Token id (GET /v1/spot/tokens).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"token_id":{"type":"integer","description":"Token id"},"name":{"type":"string","description":"Name"},"full_name":{"type":["string","null"],"description":"Full name"},"sz_decimals":{"type":"integer","description":"Size decimals"},"wei_decimals":{"type":"integer","description":"Wei decimals"},"evm_contract":{"type":["string","null"],"description":"EVM contract"},"evm_extra_wei_decimals":{"type":["integer","null"],"description":"Extra wei decimals on the EVM side"},"deployer":{"type":["string","null"],"description":"Deployer"},"deploy_time":{"type":["integer","null"],"description":"Deployed, epoch ms"},"deploy_gas_wei":{"type":["string","null"],"description":"Deploy gas paid (wei)"},"deploy_gas_token":{"type":["integer","null"],"description":"Token the deploy gas was paid in"},"deployer_trading_fee_share":{"type":["string","null"],"description":"Deployer's share of trading fees (0–1) (decimal string; may carry extra trailing zeros)"},"max_supply_wei":{"type":["string","null"],"description":"Max supply (wei) as the node's state records it (token_to_max_supply); null when it records none (USDC). Built-in tokens can differ from Hyperliquid's tokenDetails: PURR (token 1) is 600,000,000 here, 1,000,000,000 there"},"balances_total_wei":{"type":"string","description":"Sum of spot balances, system and bridge accounts included (wei)"},"non_circulating_balance_wei":{"type":"string","description":"Spot balances of the token's non-circulating users (wei)"},"non_circulating_users":{"type":["integer","null"],"description":"Non-circulating users (count)"},"nc_spot_wei":{"type":["string","null"],"description":"Spot balances of the non-circulating users plus 0x0 and 0x…dead; for USDC (token 0) also its HyperEVM system address 0x2000…0000, the Core side of the EVM bridge reserve (wei)"},"staking_delegated_wei":{"type":["string","null"],"description":"Delegated HYPE (wei; HYPE only)"},"snapshot_time":{"type":"integer","description":"Node-state snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/spot/tokens/150/supply'"}]}},"/v1/accounts/{address}":{"get":{"operationId":"getAccount","summary":"Margin summary and equity of one wallet","description":"Perp account value, notional, margin used and withdrawable for one dex (core exchange by default), and the wallet's equity as hyperdash.com shows it (every perp dex + spot at mid + staked HYPE; unified and portfolio-margin accounts: spot + staked HYPE), with its spot and staking parts.\n\nPricing: base (reads every dex) + up to five node reads (state, role, staking, prices). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"dex","in":"query","required":false,"description":"Builder dex (e.g. xyz). Omit for the core exchange.","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"account_value":{"type":"string","description":"Perp account value on this dex (USD): Hyperliquid's marginSummary, perp margin only (no spot, other dexes or staking; see equity) (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":"string","description":"Total position notional (decimal string; may carry extra trailing zeros)"},"total_raw_usd":{"type":"string","description":"Raw USD balance (decimal string; may carry extra trailing zeros)"},"total_margin_used":{"type":"string","description":"Margin used (decimal string; may carry extra trailing zeros)"},"cross_account_value":{"type":"string","description":"Cross-margin account value (decimal string; may carry extra trailing zeros)"},"cross_maintenance_margin_used":{"type":["string","null"],"description":"Cross maintenance margin used (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":"string","description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"positions":{"type":"integer","description":"Open positions"},"as_of":{"type":"integer","description":"Node state time (epoch ms)"},"role":{"type":["string","null"],"description":"user, agent, vault, subAccount or missing"},"master":{"type":["string","null"],"description":"subAccount: the master wallet; null otherwise"},"agent_of":{"type":["string","null"],"description":"agent: the wallet it trades for; null otherwise"},"abstraction":{"type":["string","null"],"description":"Account abstraction mode (disabled, unifiedAccount, portfolioMargin, …)"},"equity":{"type":["string","null"],"description":"Account equity (USD) as hyperdash.com shows it: perp account value on every perp dex + spot balances at their mids + staked HYPE. Unified and portfolio-margin accounts: spot + staked HYPE only (their perp margin is drawn from the spot balances). Null when a price could not be read. (decimal string; may carry extra trailing zeros)"},"spot_value":{"type":["string","null"],"description":"Spot balances at their mids (USD): USDC = 1, other tokens at their USDC pair's mid; tokens without a market (e.g. outcome shares) count 0. (decimal string; may carry extra trailing zeros)"},"staked_value":{"type":["string","null"],"description":"Staked HYPE (delegated + undelegated + pending withdrawals) at the HYPE mid (USD) (decimal string; may carry extra trailing zeros)"},"cross_total_notional":{"type":["string","null"],"description":"Cross-margin position notional (decimal string; may carry extra trailing zeros)"},"cross_total_raw_usd":{"type":["string","null"],"description":"Cross-margin raw USD (decimal string; may carry extra trailing zeros)"},"cross_total_margin_used":{"type":["string","null"],"description":"Cross margin used (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…'"}]}},"/v1/accounts/batch":{"get":{"operationId":"getAccountsBatch","summary":"Account summaries of up to 25 wallets","description":"Margin summary of each wallet in `addresses` (comma-separated, up to 25) on one dex: perp account value, notional, margin, withdrawable, open positions; plus each wallet's equity over every dex and spot (staked HYPE not included). Wallets the node could not read are listed in `meta.unavailable` (no row). Every wallet counts as queried (extraction limits). For more wallets per call use POST /v1/accounts/batch.\n\nPricing: base + per wallet read (wallets in meta.unavailable are not billed) + up to three node reads. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 25 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"addresses","in":"query","required":true,"description":"Comma-separated wallets (0x + 40 hex), up to 25; a repeated wallet counts once (one row).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}(,0x[0-9a-fA-F]{40}){0,24}$"}},{"name":"dex","in":"query","required":false,"description":"Builder dex (e.g. xyz). Omit for the core exchange.","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"account_value":{"type":["string","null"],"description":"Perp account value on the requested dex (USD; core exchange by default): perp margin only, see equity (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":["string","null"],"description":"Total position notional (decimal string; may carry extra trailing zeros)"},"total_margin_used":{"type":["string","null"],"description":"Margin used (decimal string; may carry extra trailing zeros)"},"cross_maintenance_margin_used":{"type":["string","null"],"description":"Cross maintenance margin used (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":["string","null"],"description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"positions":{"type":["integer","null"],"description":"Open positions"},"as_of":{"type":["integer","null"],"description":"Node state time (epoch ms)"},"equity":{"type":["string","null"],"description":"Account equity (USD) as hyperdash.com shows it: perp account value on every perp dex + spot balances at their mids + staked HYPE. Unified and portfolio-margin accounts: spot + staked HYPE only (their perp margin is drawn from the spot balances). Null when a price could not be read. Staked HYPE is not read here (see GET /v1/accounts/{address}). (decimal string; may carry extra trailing zeros)"},"spot_value":{"type":["string","null"],"description":"Spot balances at their mids (USD): USDC = 1, other tokens at their USDC pair's mid; tokens without a market (e.g. outcome shares) count 0. (decimal string; may carry extra trailing zeros)"},"staked_value":{"type":["string","null"],"description":"Always null here: staked HYPE is not read in this call, and equity leaves it out (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/batch?addresses=0x…,0x…'"}]},"post":{"operationId":"postAccountsBatch","summary":"Account summaries of many wallets","description":"Same rows as GET /v1/accounts/batch (margin summary on one dex, equity over every dex and spot) for up to your plan's batch size per call (Lite 50, Starter 250, Growth 1,000, Scale and Enterprise 10,000), sent as a JSON body {\"addresses\": [...], \"dex\"?: \"xyz\"}. Wallets the node could not read are listed in `meta.unavailable` (no row). Every wallet counts as queried: new wallets beyond your plan's daily / 30-day allowance are refused before anything runs (429 extraction_limit).\n\nPricing: base + per wallet read (wallets in meta.unavailable are not billed). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["addresses"],"properties":{"addresses":{"type":"array","items":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"},"minItems":1,"maxItems":10000,"description":"Wallets (0x + 40 hex); a repeated wallet counts once (one row); at most your plan's batch size (Lite 50, Starter 250, Growth 1,000, Scale and Enterprise 10,000)."},"dex":{"type":"string","pattern":"^[a-z0-9]{1,16}$","description":"Builder dex (e.g. xyz). Omit for the core exchange."}}}}}},"parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"account_value":{"type":["string","null"],"description":"Perp account value on the requested dex (USD; core exchange by default): perp margin only, see equity (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":["string","null"],"description":"Total position notional (decimal string; may carry extra trailing zeros)"},"total_margin_used":{"type":["string","null"],"description":"Margin used (decimal string; may carry extra trailing zeros)"},"cross_maintenance_margin_used":{"type":["string","null"],"description":"Cross maintenance margin used (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":["string","null"],"description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"positions":{"type":["integer","null"],"description":"Open positions"},"as_of":{"type":["integer","null"],"description":"Node state time (epoch ms)"},"equity":{"type":["string","null"],"description":"Account equity (USD) as hyperdash.com shows it: perp account value on every perp dex + spot balances at their mids + staked HYPE. Unified and portfolio-margin accounts: spot + staked HYPE only (their perp margin is drawn from the spot balances). Null when a price could not be read. Staked HYPE is not read here (see GET /v1/accounts/{address}). (decimal string; may carry extra trailing zeros)"},"spot_value":{"type":["string","null"],"description":"Spot balances at their mids (USD): USDC = 1, other tokens at their USDC pair's mid; tokens without a market (e.g. outcome shares) count 0. (decimal string; may carry extra trailing zeros)"},"staked_value":{"type":["string","null"],"description":"Always null here: staked HYPE is not read in this call, and equity leaves it out (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -X POST -H 'Authorization: Bearer $HD_KEY' -H 'content-type: application/json' -d '{\"addresses\":[\"0x…\",\"0x…\"]}' 'https://data.hyperdash.com/v1/accounts/batch'"}]}},"/v1/accounts/batch/portfolio":{"get":{"operationId":"getAccountsBatchPortfolio","summary":"Portfolio summaries of up to 25 wallets","description":"Perp and spot summary of each wallet in `addresses` (comma-separated, up to 25): abstraction mode, core-exchange perp account value, notional, withdrawable, maintenance margin, open positions, spot balances and spot USDC, and equity over every dex and spot (staked HYPE not included), from one consistent node read per wallet. Unreadable wallets in `meta.unavailable`. Every wallet counts as queried. For more wallets per call use POST.\n\nPricing: base + per wallet read (wallets in meta.unavailable are not billed). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"addresses","in":"query","required":true,"description":"Comma-separated wallets (0x + 40 hex), up to 25; a repeated wallet counts once (one row).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}(,0x[0-9a-fA-F]{40}){0,24}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"abstraction":{"type":["string","null"],"description":"Account abstraction mode (default, unifiedAccount, portfolioMargin, …)"},"account_value":{"type":["string","null"],"description":"Perp account value on the core exchange (USD): perp margin only, see equity (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":["string","null"],"description":"Total perp position notional (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":["string","null"],"description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"maintenance_margin":{"type":["string","null"],"description":"Cross maintenance margin used (decimal string; may carry extra trailing zeros)"},"perp_positions":{"type":["integer","null"],"description":"Open perp positions"},"spot_balances":{"type":["integer","null"],"description":"Non-zero spot balances"},"spot_usdc":{"type":["string","null"],"description":"Spot USDC balance (decimal string; may carry extra trailing zeros)"},"as_of":{"type":["integer","null"],"description":"Node state time (epoch ms)"},"equity":{"type":["string","null"],"description":"Account equity (USD) as hyperdash.com shows it: perp account value on every perp dex + spot balances at their mids + staked HYPE. Unified and portfolio-margin accounts: spot + staked HYPE only (their perp margin is drawn from the spot balances). Null when a price could not be read. Staked HYPE is not read here (see GET /v1/accounts/{address}). (decimal string; may carry extra trailing zeros)"},"spot_value":{"type":["string","null"],"description":"Spot balances at their mids (USD): USDC = 1, other tokens at their USDC pair's mid; tokens without a market (e.g. outcome shares) count 0. (decimal string; may carry extra trailing zeros)"},"staked_value":{"type":["string","null"],"description":"Always null here: staked HYPE is not read in this call, and equity leaves it out (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/batch/portfolio?addresses=0x…,0x…'"}]},"post":{"operationId":"postAccountsBatchPortfolio","summary":"Portfolio summaries of many wallets","description":"Same rows as GET /v1/accounts/batch/portfolio for up to your plan's batch size per call (Lite 50, Starter 250, Growth 1,000, Scale and Enterprise 10,000), JSON body {\"addresses\": [...]}. Unreadable wallets in `meta.unavailable`. Every wallet counts as queried (429 extraction_limit beyond your new-wallet allowance, before anything runs).\n\nPricing: base + per wallet read (wallets in meta.unavailable are not billed). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["addresses"],"properties":{"addresses":{"type":"array","items":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"},"minItems":1,"maxItems":10000,"description":"Wallets (0x + 40 hex); a repeated wallet counts once (one row); at most your plan's batch size (Lite 50, Starter 250, Growth 1,000, Scale and Enterprise 10,000)."}}}}}},"parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"abstraction":{"type":["string","null"],"description":"Account abstraction mode (default, unifiedAccount, portfolioMargin, …)"},"account_value":{"type":["string","null"],"description":"Perp account value on the core exchange (USD): perp margin only, see equity (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":["string","null"],"description":"Total perp position notional (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":["string","null"],"description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"maintenance_margin":{"type":["string","null"],"description":"Cross maintenance margin used (decimal string; may carry extra trailing zeros)"},"perp_positions":{"type":["integer","null"],"description":"Open perp positions"},"spot_balances":{"type":["integer","null"],"description":"Non-zero spot balances"},"spot_usdc":{"type":["string","null"],"description":"Spot USDC balance (decimal string; may carry extra trailing zeros)"},"as_of":{"type":["integer","null"],"description":"Node state time (epoch ms)"},"equity":{"type":["string","null"],"description":"Account equity (USD) as hyperdash.com shows it: perp account value on every perp dex + spot balances at their mids + staked HYPE. Unified and portfolio-margin accounts: spot + staked HYPE only (their perp margin is drawn from the spot balances). Null when a price could not be read. Staked HYPE is not read here (see GET /v1/accounts/{address}). (decimal string; may carry extra trailing zeros)"},"spot_value":{"type":["string","null"],"description":"Spot balances at their mids (USD): USDC = 1, other tokens at their USDC pair's mid; tokens without a market (e.g. outcome shares) count 0. (decimal string; may carry extra trailing zeros)"},"staked_value":{"type":["string","null"],"description":"Always null here: staked HYPE is not read in this call, and equity leaves it out (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -X POST -H 'Authorization: Bearer $HD_KEY' -H 'content-type: application/json' -d '{\"addresses\":[\"0x…\"]}' 'https://data.hyperdash.com/v1/accounts/batch/portfolio'"}]}},"/v1/accounts/{address}/positions/all-dexes":{"get":{"operationId":"getAccountAllDexes","summary":"Margin summary on every dex","description":"One row per perp dex (core exchange = \"native\" and every HIP-3 dex): account value, notional, margin used, withdrawable and open positions, from one consistent node read across dexes.\n\nPricing: base (reads every dex). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"dex":{"type":"string","description":"Dex (\"native\" = core exchange)"},"account_value":{"type":"string","description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":"string","description":"Total position notional (decimal string; may carry extra trailing zeros)"},"total_margin_used":{"type":"string","description":"Margin used (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":"string","description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"positions":{"type":"integer","description":"Open positions"},"as_of":{"type":"integer","description":"Node state time (epoch ms)"},"total_raw_usd":{"type":["string","null"],"description":"Raw USD balance (decimal string; may carry extra trailing zeros)"},"cross_account_value":{"type":["string","null"],"description":"Cross-margin account value (decimal string; may carry extra trailing zeros)"},"cross_total_notional":{"type":["string","null"],"description":"Cross-margin position notional (decimal string; may carry extra trailing zeros)"},"cross_total_raw_usd":{"type":["string","null"],"description":"Cross-margin raw USD (decimal string; may carry extra trailing zeros)"},"cross_total_margin_used":{"type":["string","null"],"description":"Cross margin used (decimal string; may carry extra trailing zeros)"},"cross_maintenance_margin_used":{"type":["string","null"],"description":"Cross maintenance margin used (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/positions/all-dexes'"}]}},"/v1/accounts/{address}/portfolio":{"get":{"operationId":"getAccountPortfolio","summary":"Consistent perp + spot portfolio","description":"Perp positions and spot balances from one consistent node state (the right view for unified and portfolio-margin accounts, where spot collateral backs perps): one row per core-exchange position (`kind` perp; with `all_dexes=true` the positions of every perp dex, HIP-3 included, as hyperdash.com loads them) and per balance (`kind` spot). meta: core-exchange perp account value, withdrawable, maintenance margin, the account abstraction, and `equity`, `spot_value`, `staked_value` as on GET /v1/accounts/{address} (equity over every perp dex, spot at mid and staked HYPE, as hyperdash.com shows it).\n\nPricing: base + up to four node reads (the facade composes ~14 node reads across every dex; priced in the base). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"all_dexes","in":"query","required":false,"description":"true: position rows for every perp dex (core first), from the same read; default: the core exchange only.","schema":{"type":"string","default":"false","enum":["false","true"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"perp or spot"},"dex":{"type":["string","null"],"description":"Perp dex of the position (\"native\" = core exchange); null for spot"},"coin":{"type":"string","description":"Market (perp) or token (spot)"},"size":{"type":"string","description":"Signed position size (perp) or total balance (spot) (decimal string; may carry extra trailing zeros)"},"entry":{"type":["string","null"],"description":"Entry price (perp) or entry notional (spot) (decimal string; may carry extra trailing zeros)"},"value":{"type":["string","null"],"description":"Position value (perp, USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Unrealized PnL (perp) (decimal string; may carry extra trailing zeros)"},"margin_used":{"type":["string","null"],"description":"Margin used (perp) (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (perp) (decimal string; may carry extra trailing zeros)"},"leverage":{"type":["integer","null"],"description":"Leverage (perp)"},"hold":{"type":["string","null"],"description":"Held in open orders (spot) (decimal string; may carry extra trailing zeros)"},"leverage_type":{"type":["string","null"],"description":"perp: cross or isolated"},"max_leverage":{"type":["integer","null"],"description":"perp: market max leverage"},"return_on_equity":{"type":["string","null"],"description":"perp: return on equity (decimal string; may carry extra trailing zeros)"},"cum_funding_all_time":{"type":["string","null"],"description":"perp: funding paid on this market, all time (decimal string; may carry extra trailing zeros)"},"cum_funding_since_open":{"type":["string","null"],"description":"perp: funding paid since the position opened (decimal string; may carry extra trailing zeros)"},"cum_funding_since_change":{"type":["string","null"],"description":"perp: funding paid since the size last changed (decimal string; may carry extra trailing zeros)"},"token":{"type":["integer","null"],"description":"spot: token index (see /v1/spot/tokens)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/portfolio'"}]}},"/v1/accounts/{address}/risk":{"get":{"operationId":"getAccountRisk","summary":"Live margin risk (accounts ≥ $100k)","description":"Hyperdash's own margin engine, recomputed every sweep: per position the notional, mark and maintenance-margin requirement at its tier rate, grouped by margin book (cross per dex, or isolated); meta: equity and maintenance margin per book, margin mode, collateral and the sweep time. Covers accounts with at least $100k equity or gross notional; smaller accounts return no rows. Also the BTC move that liquidates the account (hyperdash.com's account-risk view): every coin projected through its 30 / 60 / 90-day hourly beta to BTC (per row: beta, correlation, beta_fallback = no usable history, projected 1:1), positions and margin tiers held constant; meta.btc_move = the closest cross book's move (signed fraction: −0.12 = BTC down 12 %; null = no plausible move within −95 % … +300 %), meta.btc_liquidation_px, per book btc_move / btc_delta; an isolated row's own move to its engine liquidation price (btc_move). A statistical projection from engine-exact inputs, not an engine-exact liquidation price. When the betas can't be loaded (or the positions server lacks the projection inputs), the margin rows are still served with the BTC fields null and meta.btc_projection false.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"book":{"type":"string","description":"cross:<dex> or isolated"},"dex":{"type":["integer","null"],"description":"Dex index (0 = core exchange)"},"coin":{"type":"string","description":"Market"},"notional":{"type":"string","description":"Signed notional (USD) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark price (decimal string; may carry extra trailing zeros)"},"maintenance_margin":{"type":["string","null"],"description":"Maintenance margin requirement (USD) (decimal string; may carry extra trailing zeros)"},"mm_rate":{"type":["string","null"],"description":"Maintenance margin rate of the position's tier (decimal string; may carry extra trailing zeros)"},"isolated_margin":{"type":["string","null"],"description":"Isolated margin (isolated positions) (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Engine liquidation price (isolated positions) (decimal string; may carry extra trailing zeros)"},"margin_uncertain":{"type":["boolean","null"],"description":"The position's margin is not certified yet (opened since the engine's last state snapshot, ~12 min, a cross position sharing its pool with one, or a pool, not portfolio margin, that a fill since then left below its maintenance requirement): its book (cross / isolated) and its book's equity are the engine's assumption, liquidation_px is null, and meta.approximate (with the BTC projection) and meta.margin_uncertain are true. Null: the positions server does not report it."},"beta":{"type":["string","null"],"description":"Beta of the market to BTC (30 / 60 / 90-day hourly average; 1 when beta_fallback); null when meta.btc_projection is false (decimal string; may carry extra trailing zeros)"},"correlation":{"type":["string","null"],"description":"Correlation with BTC (same windows) (decimal string; may carry extra trailing zeros)"},"beta_fallback":{"type":["boolean","null"],"description":"No usable price history: projected 1:1 with BTC"},"btc_move":{"type":["string","null"],"description":"Isolated positions: the BTC move (fraction, signed) that reaches the liquidation price; null for cross rows (see meta) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/risk'"}]}},"/v1/accounts/{address}/markets/{coin}":{"get":{"operationId":"getAccountMarket","summary":"Leverage and tradable size in one market","description":"The wallet's leverage setting in one perp market, the max size it can buy / sell now and the margin available to trade each way.\n\nPricing: base + one node read. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"coin","in":"path","required":true,"description":"Perp market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"leverage_type":{"type":"string","description":"cross or isolated"},"leverage":{"type":"integer","description":"Leverage"},"max_buy_size":{"type":"string","description":"Max size it can buy now (decimal string; may carry extra trailing zeros)"},"max_sell_size":{"type":"string","description":"Max size it can sell now (decimal string; may carry extra trailing zeros)"},"available_to_buy":{"type":"string","description":"Margin available to buy (USD) (decimal string; may carry extra trailing zeros)"},"available_to_sell":{"type":"string","description":"Margin available to sell (USD) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark price (decimal string; may carry extra trailing zeros)"},"leverage_raw_usd":{"type":["string","null"],"description":"Isolated leverage: the raw USD (margin) allocated (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/markets/BTC'"}]}},"/v1/accounts/{address}/agents":{"get":{"operationId":"getAccountAgents","summary":"Approved API agents","description":"API / agent wallets the account has approved to trade for it, with their names and expiry.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Agent name"},"agent":{"type":"string","description":"Agent wallet"},"valid_until":{"type":["integer","null"],"description":"Expiry, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/agents'"}]}},"/v1/accounts/{address}/rate-limit":{"get":{"operationId":"getAccountRateLimit","summary":"Exchange request budget","description":"The account's Hyperliquid action budget: cumulative traded volume, requests used, the cap it earns and any surplus.\n\nPricing: base + one node read. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"cum_volume":{"type":"string","description":"Cumulative traded volume (USD) (decimal string; may carry extra trailing zeros)"},"requests_used":{"type":"integer","description":"Requests used"},"requests_cap":{"type":"integer","description":"Request cap"},"requests_surplus":{"type":"integer","description":"Surplus requests"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/rate-limit'"}]}},"/v1/accounts/{address}/vault-equities":{"get":{"operationId":"getAccountVaultEquities","summary":"Vault deposits","description":"The account's equity in each vault it has deposited into, with the lock-up end.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"vault":{"type":"string","description":"Vault address"},"equity":{"type":"string","description":"Equity (USD) (decimal string; may carry extra trailing zeros)"},"locked_until":{"type":["integer","null"],"description":"Lock-up end, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/vault-equities'"}]}},"/v1/accounts/{address}/builder-fee":{"get":{"operationId":"getAccountBuilderFee","summary":"Approved max builder fee","description":"The maximum fee the account has approved for one builder (tenths of a basis point; 0 = not approved).\n\nPricing: base + one node read. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"builder","in":"query","required":true,"description":"Builder wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"builder":{"type":"string","description":"Builder wallet"},"max_fee_tenths_bp":{"type":"integer","description":"Approved max fee (tenths of a basis point)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/builder-fee?builder=0x…'"}]}},"/v1/accounts/{address}/spot-balances":{"get":{"operationId":"getAccountSpotBalances","summary":"Spot balances of one wallet","description":"Every spot token balance with the amount on hold (open orders) and entry notional.\n\nPricing: base + per balance + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Token"},"token":{"type":"integer","description":"Token index"},"total":{"type":"string","description":"Total balance (decimal string; may carry extra trailing zeros)"},"hold":{"type":"string","description":"On hold (open orders) (decimal string; may carry extra trailing zeros)"},"entry_ntl":{"type":["string","null"],"description":"Entry notional (USD) (decimal string; may carry extra trailing zeros)"},"available_after_maintenance":{"type":["string","null"],"description":"What the balance leaves free after maintenance margin (unified and portfolio-margin accounts); null when the node reports none (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/spot-balances'"}]}},"/v1/accounts/{address}/open-orders":{"get":{"operationId":"getAccountOpenOrders","summary":"Open orders of one wallet","description":"Resting limit orders and untriggered TP/SL / stop orders, for one dex (core exchange by default: its perps and every spot order). `all_dexes=true`: every perp dex in one call (HIP-3 markets are prefixed, e.g. xyz:TSLA), as hyperdash.com loads them — one node read per dex; meta.dexes lists the dexes read and meta.truncated is true past 2,000 orders.\n\nPricing: base + per order + one node read per dex read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"dex","in":"query","required":false,"description":"Builder dex (e.g. xyz). Omit for the core exchange.","schema":{"type":"string","pattern":"^[a-z0-9]{1,16}$"}},{"name":"all_dexes","in":"query","required":false,"description":"true: every perp dex (one node read each; not with dex).","schema":{"type":"string","default":"false","enum":["false","true"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"B (buy) or A (sell)"},"limit_px":{"type":"string","description":"Limit price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Remaining size (decimal string; may carry extra trailing zeros)"},"orig_sz":{"type":"string","description":"Original size (decimal string; may carry extra trailing zeros)"},"oid":{"type":"string","description":"Order id"},"time":{"type":"integer","description":"Placed at (epoch ms)"},"order_type":{"type":"string","description":"Limit, Stop Market, Take Profit Limit…"},"tif":{"type":["string","null"],"description":"Gtc, Ioc, Alo, FrontendMarket…"},"reduce_only":{"type":"boolean","description":"Reduce only"},"is_trigger":{"type":"boolean","description":"Trigger (TP/SL/stop) order"},"trigger_px":{"type":["string","null"],"description":"Trigger price (decimal string; may carry extra trailing zeros)"},"trigger_condition":{"type":["string","null"],"description":"Trigger condition"},"is_position_tpsl":{"type":"boolean","description":"Position TP/SL"},"cloid":{"type":["string","null"],"description":"Client order id"},"children":{"type":["string","null"],"description":"Attached TP/SL orders: JSON array of orders with these same fields (\"[]\" when none)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/open-orders'"}]}},"/v1/accounts/{address}/twaps":{"get":{"operationId":"getAccountTwaps","summary":"Active TWAPs of one wallet","description":"Every TWAP order the wallet is running or waiting to start (trigger), on core-exchange perps and spot, from the latest node state snapshots (meta.perp_snapshot_id / spot_snapshot_id; meta.perp_snapshot_time / spot_snapshot_time and *_estimated: each one's snapshot_time below): market, side, total / executed / remaining size, executed notional, progress, duration, next slice, stop / trigger prices. Newest first. HIP-3 perp TWAPs are not in the snapshot. Its finished TWAPs' fills: GET /v1/accounts/{address}/twap-fills. The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected.\n\nPricing: base + per TWAP + up to two snapshot reads (shared by every wallet for 10 s). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"perp or spot"},"coin":{"type":"string","description":"Core-exchange perp (e.g. BTC) or spot token (e.g. HYPE)"},"pair":{"type":["string","null"],"description":"Spot pair, e.g. HYPE/USDC (spot only)"},"pair_id":{"type":["string","null"],"description":"Spot pair id, e.g. @107 (spot only)"},"twap_id":{"type":"string","description":"TWAP id (decimal string: 64-bit)"},"side":{"type":"string","description":"buy or sell"},"total_sz":{"type":"string","description":"Total size (base) (decimal string; may carry extra trailing zeros)"},"executed_sz":{"type":"string","description":"Executed size (decimal string; may carry extra trailing zeros)"},"remaining_sz":{"type":"string","description":"Remaining size (decimal string; may carry extra trailing zeros)"},"executed_notional":{"type":"string","description":"Executed notional (USD; spot: the pair's quote) (decimal string; may carry extra trailing zeros)"},"progress_pct":{"type":"string","description":"Progress (0-100) (decimal string; may carry extra trailing zeros)"},"duration_s":{"type":"integer","description":"Duration (s)"},"start_time":{"type":"integer","description":"Start, epoch ms"},"reduce_only":{"type":"boolean","description":"Reduce-only"},"randomize":{"type":"boolean","description":"Randomized slices"},"next_slice_time":{"type":["string","null"],"description":"Next slice (ISO-8601)"},"slices_done":{"type":"integer","description":"Slices executed"},"waiting":{"type":"boolean","description":"Waiting for its trigger"},"stop_px":{"type":["string","null"],"description":"Stop price: a buy TWAP stops once the price reaches it from below, a sell from above. HL announced (2026-10-29) that it will pause there instead and resume when the price comes back. (decimal string; may carry extra trailing zeros)"},"trigger_px":{"type":["string","null"],"description":"Trigger price of a TWAP waiting to start (decimal string; may carry extra trailing zeros)"},"trigger_above":{"type":["boolean","null"],"description":"Starts when the price rises above (true) or falls below (false) trigger_px"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/twaps'"}]}},"/v1/accounts/{address}/orders":{"get":{"operationId":"getAccountOrderHistory","summary":"Recent order history of one wallet","description":"The wallet's most recent order-status updates (up to 2,000), newest first: one row per status change (open, filled, canceled, rejected, triggered…), so an order can appear more than once. From our order store (updates from 2026-09-24 on).\n\nPricing: base + per order + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"B (buy) or A (sell)"},"limit_px":{"type":"string","description":"Limit price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Remaining size (decimal string; may carry extra trailing zeros)"},"orig_sz":{"type":"string","description":"Original size (decimal string; may carry extra trailing zeros)"},"oid":{"type":"string","description":"Order id"},"time":{"type":"integer","description":"Placed at (epoch ms)"},"order_type":{"type":"string","description":"Limit, Stop Market, Take Profit Limit…"},"tif":{"type":["string","null"],"description":"Gtc, Ioc, Alo, FrontendMarket…"},"reduce_only":{"type":"boolean","description":"Reduce only"},"is_trigger":{"type":"boolean","description":"Trigger (TP/SL/stop) order"},"trigger_px":{"type":["string","null"],"description":"Trigger price (decimal string; may carry extra trailing zeros)"},"trigger_condition":{"type":["string","null"],"description":"Trigger condition"},"is_position_tpsl":{"type":"boolean","description":"Position TP/SL"},"cloid":{"type":["string","null"],"description":"Client order id"},"children":{"type":["string","null"],"description":"Attached TP/SL orders: JSON array of orders with these same fields (\"[]\" when none)"},"status":{"type":"string","description":"open, filled, canceled, triggered, rejected, marginCanceled…"},"status_time":{"type":"integer","description":"Status time (epoch ms)"},"builder":{"type":["string","null"],"description":"Builder code the order was sent with; null if none"},"builder_fee_tenths_bp":{"type":["integer","null"],"description":"Builder fee rate of the order (tenths of a basis point); null without a builder"},"tx_index":{"type":["integer","null"],"description":"Index of the status's transaction in its block"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/orders'"}]}},"/v1/accounts/{address}/twap-fills":{"get":{"operationId":"getAccountTwapFills","summary":"TWAP slice fills of one wallet","description":"Fills produced by the wallet's TWAP orders, with the TWAP id: its most recent 2,000, newest first, over its whole fills history (the last 12 h from the node's live index, older ones from Hyperdash's fills store).\n\nPricing: base + per fill + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"twap_id":{"type":"integer","description":"TWAP id"},"time":{"type":"integer","description":"Epoch ms"},"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"B or A"},"px":{"type":"string","description":"Price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (decimal string; may carry extra trailing zeros)"},"fee":{"type":"string","description":"Fee (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":"string","description":"Realized PnL (decimal string; may carry extra trailing zeros)"},"hash":{"type":"string","description":"Transaction hash"},"tid":{"type":"string","description":"Trade id"},"oid":{"type":"string","description":"Order id (the slice order)"},"dir":{"type":["string","null"],"description":"Open Long, Close Short, …"},"start_position":{"type":["string","null"],"description":"Position before this fill (decimal string; may carry extra trailing zeros)"},"crossed":{"type":["boolean","null"],"description":"Taker"},"fee_token":{"type":["string","null"],"description":"Fee asset"},"builder":{"type":["string","null"],"description":"Builder code the TWAP was sent with; null if none"},"builder_fee":{"type":["string","null"],"description":"Builder fee (in fee_token, part of fee); null without a builder or when not reported (decimal string; may carry extra trailing zeros)"},"cloid":{"type":["string","null"],"description":"Client order id; null if none"},"tx_index":{"type":["integer","null"],"description":"Index of the fill's transaction in its block"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/twap-fills'"}]}},"/v1/accounts/{address}/fees":{"get":{"operationId":"getAccountFees","summary":"Fee tier of one wallet","description":"Current taker/maker rates (perp and spot), referral and staking discounts, 14-day volume (and per day, with the exchange's), the exchange fee schedule and fee-trial state.\n\nPricing: base + one node read. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"taker_rate":{"type":"string","description":"Perp taker rate (decimal string; may carry extra trailing zeros)"},"maker_rate":{"type":"string","description":"Perp maker rate (negative = rebate) (decimal string; may carry extra trailing zeros)"},"spot_taker_rate":{"type":"string","description":"Spot taker rate (decimal string; may carry extra trailing zeros)"},"spot_maker_rate":{"type":"string","description":"Spot maker rate (decimal string; may carry extra trailing zeros)"},"referral_discount":{"type":"string","description":"Active referral discount (decimal string; may carry extra trailing zeros)"},"staking_discount":{"type":"string","description":"Active staking discount (decimal string; may carry extra trailing zeros)"},"volume_14d_taker":{"type":"string","description":"Taker volume over the daily window (decimal string; may carry extra trailing zeros)"},"volume_14d_maker":{"type":"string","description":"Maker volume over the daily window (decimal string; may carry extra trailing zeros)"},"staking_bps_of_max_supply":{"type":["string","null"],"description":"Staked HYPE as bps of max supply (sets the staking discount tier) (decimal string; may carry extra trailing zeros)"},"daily_volume":{"type":"string","description":"Volume per day of the window: JSON array [{date, taker, maker, exchange}] (the wallet's taker and maker volume and the whole exchange's, USD)"},"fee_schedule":{"type":["string","null"],"description":"The exchange fee schedule: JSON object (base rates, VIP tiers by volume, market-maker rebate tiers by maker share, referral discount, staking discount tiers), snake_case keys"},"trial":{"type":["string","null"],"description":"Active fee trial, JSON as the node reports it; null if none"},"fee_trial_escrow":{"type":["string","null"],"description":"Fee trial escrow (decimal string; may carry extra trailing zeros)"},"next_trial_available_time":{"type":["integer","null"],"description":"When a fee trial is next available (epoch ms)"},"staking_link":{"type":["string","null"],"description":"Staking link (another wallet's stake counted for this one), JSON as the node reports it; null if none"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/fees'"}]}},"/v1/accounts/{address}/subaccounts":{"get":{"operationId":"getAccountSubaccounts","summary":"Sub-accounts of one wallet","description":"Sub-accounts owned by the wallet with their core-exchange perp account value, withdrawable, and equity over every dex and spot (staked HYPE not included; null if their states could not be read).\n\nPricing: base + per sub-account + up to four node reads. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Sub-account wallet"},"name":{"type":"string","description":"Sub-account name"},"account_value":{"type":["string","null"],"description":"Perp account value on the core exchange: perp margin only, see equity (decimal string; may carry extra trailing zeros)"},"withdrawable":{"type":["string","null"],"description":"Withdrawable (decimal string; may carry extra trailing zeros)"},"spot_balances":{"type":["integer","null"],"description":"Non-zero spot balances, from the same spot state as spot_value (portfolio-margin sub-accounts included); null if that state could not be read for a portfolio-margin sub-account"},"equity":{"type":["string","null"],"description":"Account equity (USD) as hyperdash.com shows it: perp account value on every perp dex + spot balances at their mids + staked HYPE. Unified and portfolio-margin accounts: spot + staked HYPE only (their perp margin is drawn from the spot balances). Null when a price could not be read. Staked HYPE is not read here (see GET /v1/accounts/{address}). (decimal string; may carry extra trailing zeros)"},"spot_value":{"type":["string","null"],"description":"Spot balances at their mids (USD): USDC = 1, other tokens at their USDC pair's mid; tokens without a market (e.g. outcome shares) count 0. (decimal string; may carry extra trailing zeros)"},"staked_value":{"type":["string","null"],"description":"Always null here: staked HYPE is not read in this call, and equity leaves it out (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/subaccounts'"}]}},"/v1/accounts/{address}/staking":{"get":{"operationId":"getAccountStaking","summary":"HYPE staking of one wallet","description":"Delegated / undelegated HYPE, pending withdrawals and every delegation (validator, amount, lock).\n\nPricing: base + per delegation + two node reads. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"validator":{"type":["string","null"],"description":"Validator (one row per delegation; a summary row has validator = null)"},"amount":{"type":"string","description":"Delegated amount (summary row: total delegated) (decimal string; may carry extra trailing zeros)"},"locked_until":{"type":["integer","null"],"description":"Locked until (epoch ms)"},"undelegated":{"type":["string","null"],"description":"Summary row: undelegated balance (decimal string; may carry extra trailing zeros)"},"pending_withdrawal":{"type":["string","null"],"description":"Summary row: total pending withdrawal (decimal string; may carry extra trailing zeros)"},"pending_withdrawals":{"type":["integer","null"],"description":"Summary row: number of pending withdrawals"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/staking'"}]}},"/v1/accounts/{address}/orders/{oid}":{"get":{"operationId":"getAccountOrderStatus","summary":"One order's status by oid or cloid","description":"One order of the wallet by order id or client order id, from our node: resting orders on every dex and the wallet's newest ~2,000 order-status events (older finished orders answer `unknown`). The status is the order's latest (open, filled, canceled, triggered, rejected …). A momentarily unsettled lookup answers unavailable (retry).\n\nPricing: base (covers the node fan-out). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"oid","in":"path","required":true,"description":"Order id (integer ≤ 9007199254740991, the JSON-safe range; ids are ~6 × 10^11 today) or cloid (0x + 32 hex).","schema":{"type":"string","pattern":"^([0-9]{1,16}|0x[0-9a-fA-F]{32})$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"lookup":{"type":"string","description":"order (found) or unknown"},"status":{"type":["string","null"],"description":"Latest status (open, filled, canceled, triggered, rejected …)"},"status_time":{"type":["integer","null"],"description":"Status time, epoch ms"},"coin":{"type":["string","null"],"description":"Market"},"side":{"type":["string","null"],"description":"B (buy) or A (sell)"},"limit_px":{"type":["string","null"],"description":"Limit price (decimal string; may carry extra trailing zeros)"},"sz":{"type":["string","null"],"description":"Remaining size (decimal string; may carry extra trailing zeros)"},"orig_sz":{"type":["string","null"],"description":"Original size (decimal string; may carry extra trailing zeros)"},"oid":{"type":["string","null"],"description":"Order id"},"time":{"type":["integer","null"],"description":"Placed, epoch ms"},"order_type":{"type":["string","null"],"description":"Order type"},"tif":{"type":["string","null"],"description":"Time in force"},"reduce_only":{"type":["boolean","null"],"description":"Reduce-only"},"is_trigger":{"type":["boolean","null"],"description":"Trigger order"},"trigger_px":{"type":["string","null"],"description":"Trigger price (decimal string; may carry extra trailing zeros)"},"trigger_condition":{"type":["string","null"],"description":"Trigger condition"},"is_position_tpsl":{"type":["boolean","null"],"description":"Position TP/SL"},"cloid":{"type":["string","null"],"description":"Client order id"},"children":{"type":["string","null"],"description":"Attached TP/SL orders (JSON array, same fields)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/orders/123456789'"}]}},"/v1/accounts/{address}/approved-builders":{"get":{"operationId":"getAccountApprovedBuilders","summary":"Builder codes the wallet approved","description":"Every builder code (address) the wallet has approved a builder fee for, from our node. The fee cap of one builder: /accounts/{address}/builder-fee.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"builder":{"type":"string","description":"Builder code (address)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/approved-builders'"}]}},"/v1/accounts/{address}/multisig-signers":{"get":{"operationId":"getAccountMultisigSigners","summary":"A multi-sig account's signers and threshold","description":"For a multi-sig account: its authorized signers (rows) and in meta the signature threshold; empty for an ordinary account.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"signer":{"type":"string","description":"Authorized signer (address)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/multisig-signers'"}]}},"/v1/accounts/{address}/borrow-lend":{"get":{"operationId":"getAccountBorrowLend","summary":"The wallet's borrow / lend positions and health","description":"Per token, the wallet's borrow and supply position on Hyperliquid's borrow/lend (from our node), and in meta its health and health factor.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 200 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"token":{"type":"integer","description":"Token index"},"borrow_value":{"type":"string","description":"Borrowed amount now (token units, interest included) (decimal string; may carry extra trailing zeros)"},"borrow_basis":{"type":"string","description":"Borrowed principal (token units) (decimal string; may carry extra trailing zeros)"},"supply_value":{"type":"string","description":"Supplied amount now (token units, interest included) (decimal string; may carry extra trailing zeros)"},"supply_basis":{"type":"string","description":"Supplied principal (token units) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/borrow-lend'"}]}},"/v1/accounts/{address}/leading-vaults":{"get":{"operationId":"getAccountLeadingVaults","summary":"Vaults the wallet leads","description":"The vaults the wallet is the leader of (address and name), from our node.\n\nPricing: base + one node read. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"vault":{"type":"string","description":"Vault address"},"name":{"type":"string","description":"Vault name"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/leading-vaults'"}]}},"/v1/accounts/{address}/ledger":{"get":{"operationId":"getAccountLedger","summary":"Non-funding ledger updates of one wallet","description":"Deposits, withdrawals, internal/spot/sub-account transfers, vault and staking moves, liquidation settlements… in [start_time, end_time], ascending. Range ≤ 30 days; page with the cursor. Same source as hyperdash.com's Transfers tab (the node ledger store); the site asks for all history in one call and shows the store's first 2,000 answers (the OLDEST updates), so a long-lived wallet's recent transfers can be missing there but not here. `include=staking` adds the wallet's staking moves (delegation: delegate / undelegate to a validator; cDeposit / cWithdrawal: staking deposit / withdrawal) and `include=all` every type our node's ledger has (also createSubAccount, gossipPriorityGasAuction): these extra types cover the last 12 hours only (our node's local ledger) until their history is stored.\n\nPricing: base + per row; ×2 above 24 h. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"Extra types: staking (delegation, cDeposit, cWithdrawal) or all (every node ledger type). Last 12 h only (the node's live window); their full history (from 2025-09-27 10:00 UTC): GET /v1/accounts/{address}/staking/history (delegation, cDeposit, cWithdrawal), GET /v1/accounts/{address}/subaccounts/history (createSubAccount) and GET /v1/network/gossip-auctions (gossipPriorityGasAuction).","schema":{"type":"string","enum":["staking","all"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"hash":{"type":"string","description":"Transaction hash"},"type":{"type":"string","description":"deposit, withdraw, accountClassTransfer, spotTransfer, send, subAccountTransfer, vaultDeposit, vaultWithdraw, liquidation, rewardsClaim…; with include: delegation, cDeposit, cWithdrawal, createSubAccount, gossipPriorityGasAuction"},"usdc":{"type":["string","null"],"description":"USDC amount (perps cash deltas) (decimal string; may carry extra trailing zeros)"},"token":{"type":["string","null"],"description":"Token (spot / send)"},"amount":{"type":["string","null"],"description":"Token amount (decimal string; may carry extra trailing zeros)"},"usdc_value":{"type":["string","null"],"description":"USD value of the token amount (decimal string; may carry extra trailing zeros)"},"fee":{"type":["string","null"],"description":"Fee (decimal string; may carry extra trailing zeros)"},"destination":{"type":["string","null"],"description":"Counterparty / destination wallet"},"vault":{"type":["string","null"],"description":"Vault"},"details":{"type":"string","description":"The full delta as JSON (every field the chain recorded)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/ledger?start_time=1760000000000'"}]}},"/v1/accounts/{address}/funding":{"get":{"operationId":"getAccountFunding","summary":"Funding payments of one wallet","description":"Hourly funding paid/received per position in [start_time, end_time], ascending. Range ≤ 7 days; page with the cursor.\n\nPricing: base + per row; ×2 above 24 h. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"coin":{"type":"string","description":"Market"},"usdc":{"type":"string","description":"Funding paid (negative) or received (positive), USDC (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Signed position size at funding (decimal string; may carry extra trailing zeros)"},"funding_rate":{"type":"string","description":"Hourly funding rate (decimal string; may carry extra trailing zeros)"},"hash":{"type":["string","null"],"description":"Transaction hash"},"samples":{"type":["integer","null"],"description":"Funding samples in the payment (the node’s nSamples)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/funding'"}]}},"/v1/accounts/{address}/trades":{"get":{"operationId":"getAccountTrades","summary":"Completed round-trip trades of one wallet","description":"Every position opened and fully closed, with entry/exit, size, fees and realized PnL, by close time in [start_time, end_time], ascending. Range ≤ 90 days; page with the cursor. From the node trade store; the same round trips with the whole history, filters (market, side, win/loss, notional), the site's sorts and funding: GET /v1/accounts/{address}/completed-trades (hyperdash.com's Completed Trades tab).\n\nPricing: base + per row; ×2 above 24 h. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"open_time":{"type":"integer","description":"Opened (epoch ms)"},"close_time":{"type":"integer","description":"Closed (epoch ms)"},"duration_ms":{"type":"integer","description":"Holding time"},"entry_px":{"type":"string","description":"Average entry (decimal string; may carry extra trailing zeros)"},"exit_px":{"type":"string","description":"Average exit (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Closed size (decimal string; may carry extra trailing zeros)"},"max_size":{"type":["string","null"],"description":"Largest position size during the trade (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"PnL before fees (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"PnL after fees (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees paid (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":["string","null"],"description":"Funding (not yet populated) (decimal string; may carry extra trailing zeros)"},"fills":{"type":["integer","null"],"description":"Fills in the trade"},"maker_fills":{"type":["integer","null"],"description":"Maker fills"},"builder":{"type":["string","null"],"description":"Builder code of the trade's orders; null if none"},"leverage":{"type":["integer","null"],"description":"Leverage (null where not recorded: most trades before the leverage capture)"},"is_cross":{"type":["boolean","null"],"description":"Cross margin (null when leverage is not recorded)"},"tx_index":{"type":["integer","null"],"description":"Index of the closing transaction in its block"},"native_realized_pnl":{"type":["string","null"],"description":"Hyperliquid's own closed PnL summed over the trade's fills (gross_pnl is derived from the entry / exit VWAPs, as hyperdash.com); null where not recorded (older trades for now) (decimal string; may carry extra trailing zeros)"},"fees_incomplete":{"type":["boolean","null"],"description":"The opening fills were not observed (the trade was rebuilt from a position snapshot): fees and net_pnl are a lower bound; null where unknown"},"history_incomplete":{"type":["boolean","null"],"description":"The opening history was not observed, or the node disagreed with the position: entry, size and PnL may be partial; null where unknown"},"close_block_height":{"type":["integer","null"],"description":"Block of the trade's closing fill; null where not recorded (trades rebuilt from the fill archive)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/trades?start_time=1757000000000'"}]}},"/v1/accounts/{address}/pnl-summary":{"get":{"operationId":"getAccountPnlSummary","summary":"Lifetime PnL summary of one wallet","description":"A wallet's whole-history summary in two scopes (heavy: one full-history aggregate). Completed trades only — each position from flat back to flat, as GET /v1/accounts/{address}/trades lists them: total_pnl, win_rate, loss_rate, total_trades, total_fees and total_funding. A position still open, and every fill in a market the wallet has not brought back to flat since, are NOT in these, so total_fees and total_funding are not the wallet's lifetime fees and funding (read those from GET /v1/accounts/{address}/fills and …/funding). Every fill (perp, spot and outcome markets): volume_traded, days_active, account_age_days and traded_pairs.\n\nPricing: base (full-history aggregate). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"total_pnl":{"type":["string","null"],"description":"Net PnL of the completed trades (closed PnL − fees + funding) (decimal string; may carry extra trailing zeros)"},"win_rate":{"type":["string","null"],"description":"Share of completed trades with net PnL > 0 (decimal string; may carry extra trailing zeros)"},"loss_rate":{"type":["string","null"],"description":"Share of completed trades with net PnL ≤ 0 (decimal string; may carry extra trailing zeros)"},"total_trades":{"type":["integer","null"],"description":"Completed trades"},"total_fees":{"type":["string","null"],"description":"Fees of the completed trades only (not of open positions) (decimal string; may carry extra trailing zeros)"},"total_funding":{"type":["string","null"],"description":"Funding of the completed trades only (not of open positions) (decimal string; may carry extra trailing zeros)"},"volume_traded":{"type":["string","null"],"description":"Notional of every fill, perp, spot and outcome (USD) (decimal string; may carry extra trailing zeros)"},"days_active":{"type":["integer","null"],"description":"UTC days with any fill"},"account_age_days":{"type":["integer","null"],"description":"Whole days since the first fill"},"traded_pairs":{"type":["integer","null"],"description":"Distinct markets with any fill (perp, spot and outcome)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/pnl-summary'"}]}},"/v1/accounts/{address}/staking/history":{"get":{"operationId":"getAccountStakingHistory","summary":"Staking history of one wallet","description":"Every delegation to and undelegation from a validator, and every staking-balance deposit (spot → staking) and withdrawal request / settlement of the wallet in [start_time, end_time], oldest first. From our nodes' misc events: history from 2025-09-27 10:00 UTC (the first hour of Hyperliquid's node-data archive, loaded and checked hour by hour), live since 2026-11-05 18:06 UTC. Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. Staking rewards are credited per validator (GET /v1/staking/rewards), not per wallet. Range ≤ 365 days; page with the cursor.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Event time, epoch ms"},"kind":{"type":"string","description":"delegate | undelegate | deposit | withdrawal"},"validator":{"type":["string","null"],"description":"Validator address (delegate / undelegate; null otherwise)"},"amount":{"type":"string","description":"HYPE (decimal string; may carry extra trailing zeros)"},"finalized":{"type":["boolean","null"],"description":"Withdrawal: false = requested (in the unstaking queue), true = settled; null for other kinds"},"hash":{"type":"string","description":"Transaction hash"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/staking/history'"}]}},"/v1/accounts/{address}/subaccounts/history":{"get":{"operationId":"getAccountSubaccountHistory","summary":"Sub-accounts a wallet created","description":"Every sub-account the wallet (its master) created in [start_time, end_time], with the name given at creation, oldest first. From our nodes' misc events: Hyperliquid's nodes emit sub-account creations only since 2026-10-03 09:33 UTC (its node-data archive has none before), so a sub-account created earlier is not listed here; live since 2026-11-05 18:06 UTC. Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. The current list with balances (every sub-account, however old, without a creation time): GET /v1/accounts/{address}/subaccounts. Range ≤ 365 days; page with the cursor.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 365 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Creation time, epoch ms"},"sub_account":{"type":"string","description":"Sub-account address"},"name":{"type":"string","description":"Name at creation"},"hash":{"type":"string","description":"Transaction hash"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/subaccounts/history'"}]}},"/v1/accounts/{address}/twaps/history":{"get":{"operationId":"getAccountTwapHistory","summary":"TWAP history of one wallet","description":"Every TWAP status change of the wallet (activated, waiting for trigger, finished, terminated, error) with its size, executed size / notional and settings, oldest first. From our nodes' TWAP-status, CoreWriter and HIP-3 oracle output, live since 2026-11-05 19:00 UTC (earlier history is not loaded). Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Event time, epoch ms"},"coin":{"type":"string","description":"Market"},"twap_id":{"type":"integer","description":"TWAP id"},"status":{"type":"string","description":"activated | finished | terminated | error | waitingForTrigger | other"},"error":{"type":["string","null"],"description":"Error message (status error)"},"side":{"type":"string","description":"B | A"},"sz":{"type":["string","null"],"description":"Size (decimal string; may carry extra trailing zeros)"},"executed_sz":{"type":["string","null"],"description":"Executed size (decimal string; may carry extra trailing zeros)"},"executed_ntl":{"type":["string","null"],"description":"Executed notional (USD) (decimal string; may carry extra trailing zeros)"},"minutes":{"type":"integer","description":"Duration, minutes"},"reduce_only":{"type":"boolean","description":"Reduce only"},"randomize":{"type":"boolean","description":"Randomized slices"},"created_time":{"type":"integer","description":"TWAP created, epoch ms"},"trigger":{"type":["string","null"],"description":"Trigger of a stop TWAP (JSON text; null: none)"},"stop_px":{"type":["string","null"],"description":"Stop price (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/twaps/history'"}]}},"/v1/accounts/{address}/core-writer-actions":{"get":{"operationId":"getAccountCoreWriterActions","summary":"HyperEVM ↔ Core actions of one wallet","description":"CoreWriter and system EVM ↔ Core actions where the wallet is the sender or the recipient (role), oldest first: action type, token, amount in wei (exact, or the rounded wei_approx when only that is known), EVM tx hash and the action. From our nodes' TWAP-status, CoreWriter and HIP-3 oracle output, live since 2026-11-05 19:00 UTC (earlier history is not loaded). Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Event time, epoch ms"},"role":{"type":"string","description":"sender | recipient"},"user":{"type":"string","description":"Sender"},"destination":{"type":["string","null"],"description":"Recipient"},"action_type":{"type":"string","description":"Action"},"nonce":{"type":"integer","description":"Nonce"},"evm_tx_hash":{"type":["string","null"],"description":"HyperEVM tx hash"},"token":{"type":["integer","null"],"description":"Token id"},"wei":{"type":["string","null"],"description":"Amount in wei, exact (null when only the rounded wei_approx is known)"},"wei_approx":{"type":["string","null"],"description":"Amount in wei, rounded upstream (only when the exact amount is not known) (decimal string; may carry extra trailing zeros)"},"action":{"type":"string","description":"The action (JSON text)"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/core-writer-actions'"}]}},"/v1/accounts/{address}/actions":{"get":{"operationId":"getAccountL1Actions","summary":"L1 actions of one wallet","description":"The wallet's L1 actions other than orders (leverage / isolated-margin changes, approvals, setReferrer, scheduleCancel, transfers, abstraction changes, deploys, …) with the node's response, oldest first. From our nodes' replica commands (every L1 action and the node's response), live since 2026-11-05 ~20:40 UTC (no earlier history). Actions usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. Range ≤ 90 days.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"action_type","in":"query","required":false,"description":"Only this action type (e.g. updateLeverage).","schema":{"type":"string","pattern":"^[A-Za-z]{1,64}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Block time, epoch ms"},"action_type":{"type":"string","description":"Action"},"ok":{"type":"boolean","description":"Accepted by the node"},"error":{"type":["string","null"],"description":"Error (not accepted)"},"asset":{"type":["integer","null"],"description":"Asset index"},"counterparty":{"type":["string","null"],"description":"Counterparty (transfers, agents, …)"},"response_user":{"type":["string","null"],"description":"Account the node's response names (e.g. the sub-account or vault acted on)"},"vault_address":{"type":["string","null"],"description":"Vault (vault actions)"},"multi_sig_user":{"type":["string","null"],"description":"Multi-sig user"},"action":{"type":"string","description":"The action (JSON text)"},"block":{"type":"integer","description":"Block height"},"bundle_index":{"type":"integer","description":"Bundle in the block"},"action_index":{"type":"integer","description":"Action in the bundle"},"inner":{"type":"boolean","description":"An inner action (of a multi-sig or batch)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/actions?action_type=updateLeverage'"}]}},"/v1/markets/{coin}/trades":{"get":{"operationId":"getMarketTrades","summary":"Trade tape of one market","description":"Every trade in [start_time, end_time], ascending by (time, tid): aggressor side, price, size, taker and maker wallets. Range ≤ 1 day; page with the cursor.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"tid":{"type":"string","description":"Trade id (unique with time)"},"side":{"type":"string","description":"Aggressor side: B = buy, A = sell"},"px":{"type":"string","description":"Price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"hash":{"type":"string","description":"Transaction hash (0x00… for TWAP slices)"},"taker":{"type":"string","description":"Taker wallet"},"maker":{"type":["string","null"],"description":"Maker wallet"},"taker_builder":{"type":["string","null"],"description":"Builder code of the taker order (null: none, or unknown on trades before 2025-03-22)"},"taker_builder_fee":{"type":["string","null"],"description":"Builder fee the taker paid on this trade (null: none or not reported) (decimal string; may carry extra trailing zeros)"},"maker_builder":{"type":["string","null"],"description":"Builder code of the maker order (null: none, or unknown: no maker fill matched, or a trade rebuilt from older history)"},"maker_builder_fee":{"type":["string","null"],"description":"Builder fee the maker paid on this trade (null: none or not reported) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/trades?limit=100'"}]}},"/v1/markets/{coin}/open-interest":{"get":{"operationId":"getOpenInterest","summary":"Open interest bars of one market","description":"Open interest OHLC per bar in [start_time, end_time) (aligned to the interval). `limit` bars per page; page with the cursor. A page whose bars are all empty (before the first data, a gap) reads on to the next bars with data in the same call, as far as the longest page this route serves; a page that still holds no bars but has more only moves the cursor on. Without start_time the window is the default range in whole bars, ending with the bar in progress. Freshness: the per-minute samples land one closed UTC hour at a time, about 1–10 minutes after the hour ends, so the hour in progress is not served (the newest bar is up to about 70 minutes old and a range inside the current hour is empty); for the current open interest use GET /v1/markets (live context).\n\nPricing: base + per bar. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1m","5m","15m","30m","1h","4h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"open":{"type":"string","description":"OI at bar open (base units) (decimal string; may carry extra trailing zeros)"},"high":{"type":"string","description":"High (decimal string; may carry extra trailing zeros)"},"low":{"type":"string","description":"Low (decimal string; may carry extra trailing zeros)"},"close":{"type":"string","description":"OI at bar close (decimal string; may carry extra trailing zeros)"},"minutes":{"type":"integer","description":"Minutes with a sample"},"source_rank":{"type":["integer","null"],"description":"Worst source in the bar: 0 = exact (rebuilt from every fill; until 2026-10-18), 1 = our recorders (sampled every 1 s; 30 s on HIP-3), 2 = Hyperliquid's per-minute archive (core perps)"},"quality":{"type":["integer","null"],"description":"Exact bars: OR of quality bits (2 = re-anchored to the archive, 8 = between checks that disagreed; 0 = clean)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/open-interest?interval=1h'"}]}},"/v1/markets/{coin}/trade-bars":{"get":{"operationId":"getTradeBars","summary":"Buy/sell volume and liquidation bars","description":"Per bar: OHLC, taker buy and sell size/notional/count, and liquidation volume by side. Cumulative volume delta = running sum of buy_sz − sell_sz. Reaches the current minute (live from Hyperdash's nodes; `final` = false until a bar is complete and certified; meta.live_to = newest block time). `limit` bars per page.\n\nPricing: base + per bar. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1m","5m","15m","30m","1h","4h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"open":{"type":"string","description":"Open (decimal string; may carry extra trailing zeros)"},"high":{"type":"string","description":"High (decimal string; may carry extra trailing zeros)"},"low":{"type":"string","description":"Low (decimal string; may carry extra trailing zeros)"},"close":{"type":"string","description":"Close (decimal string; may carry extra trailing zeros)"},"buy_sz":{"type":"string","description":"Taker buy size (decimal string; may carry extra trailing zeros)"},"sell_sz":{"type":"string","description":"Taker sell size (decimal string; may carry extra trailing zeros)"},"buy_ntl":{"type":"string","description":"Taker buy notional (USD) (decimal string; may carry extra trailing zeros)"},"sell_ntl":{"type":"string","description":"Taker sell notional (USD) (decimal string; may carry extra trailing zeros)"},"buy_n":{"type":"integer","description":"Taker buys"},"sell_n":{"type":"integer","description":"Taker sells"},"liq_buy_sz":{"type":"string","description":"Liquidation buys (shorts liquidated), size (decimal string; may carry extra trailing zeros)"},"liq_sell_sz":{"type":"string","description":"Liquidation sells (longs liquidated), size (decimal string; may carry extra trailing zeros)"},"liq_buy_ntl":{"type":"string","description":"Liquidation buys, notional (decimal string; may carry extra trailing zeros)"},"liq_sell_ntl":{"type":"string","description":"Liquidation sells, notional (decimal string; may carry extra trailing zeros)"},"liq_n":{"type":"integer","description":"Liquidation fills"},"liq_known":{"type":"boolean","description":"Liquidation split known for every minute of the bar"},"final":{"type":"boolean","description":"Bar complete and settled (false: the forming bar, or minutes not yet certified — values can still grow)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/ETH/trade-bars?interval=5m'"}]}},"/v1/markets/{coin}/context-history":{"get":{"operationId":"getMarketContextHistory","summary":"Mark, oracle, premium and predicted funding bars","description":"Per bar: mark and oracle OHLC, closing mid, premium, predicted funding and impact prices. Main-dex perps (HIP-3 from 2026-10-18). `limit` bars per page. A page whose bars are all empty (before the first data, a gap) reads on to the next bars with data in the same call, as far as the longest page this route serves; a page that still holds no bars but has more only moves the cursor on. Without start_time the window is the default range in whole bars, ending with the bar in progress. Freshness: the per-minute samples land one closed UTC hour at a time, about 1–10 minutes after the hour ends, so the hour in progress is not served (the newest bar is up to about 70 minutes old); for the current context use GET /v1/markets (live context).\n\nPricing: base + per bar. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1m","5m","15m","30m","1h","4h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"mark_open":{"type":["string","null"],"description":"Mark open (decimal string; may carry extra trailing zeros)"},"mark_high":{"type":["string","null"],"description":"Mark high (decimal string; may carry extra trailing zeros)"},"mark_low":{"type":["string","null"],"description":"Mark low (decimal string; may carry extra trailing zeros)"},"mark_close":{"type":["string","null"],"description":"Mark close (decimal string; may carry extra trailing zeros)"},"oracle_open":{"type":["string","null"],"description":"Oracle open (decimal string; may carry extra trailing zeros)"},"oracle_high":{"type":["string","null"],"description":"Oracle high (decimal string; may carry extra trailing zeros)"},"oracle_low":{"type":["string","null"],"description":"Oracle low (decimal string; may carry extra trailing zeros)"},"oracle_close":{"type":["string","null"],"description":"Oracle close (decimal string; may carry extra trailing zeros)"},"mid_close":{"type":["string","null"],"description":"Book mid at close (decimal string; may carry extra trailing zeros)"},"premium":{"type":["string","null"],"description":"Premium at close (decimal string; may carry extra trailing zeros)"},"predicted_funding":{"type":["string","null"],"description":"Predicted hourly funding at close (decimal string; may carry extra trailing zeros)"},"impact_bid":{"type":["string","null"],"description":"Impact bid at close (decimal string; may carry extra trailing zeros)"},"impact_ask":{"type":["string","null"],"description":"Impact ask at close (decimal string; may carry extra trailing zeros)"},"minutes":{"type":"integer","description":"Minutes with a sample"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/context-history?interval=1d&start_time=1700000000000'"}]}},"/v1/markets/{coin}/funding-rates":{"get":{"operationId":"getFundingRates","summary":"Realized funding rate history","description":"Settled hourly funding rates, per hour or summed per UTC day. `limit` buckets per page.\n\nPricing: base + per bucket. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"rate":{"type":"string","description":"Funding rate (sum of the hourly rates in the bucket) (decimal string; may carry extra trailing zeros)"},"hours":{"type":"integer","description":"Funding hours in the bucket"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/funding-rates?interval=1d'"}]}},"/v1/markets/{coin}/footprint":{"get":{"operationId":"getFootprint","summary":"Volume footprint (volume at price per bar)","description":"Per bar and price level: taker buy/sell size and counts. Optional row_size buckets prices; tier keeps only fills ≥ $10k / $100k. Returns ≤ 20,000 cells per page (`limit` = bars per page; a page ends on a whole bar). Reaches the current minute (live from Hyperdash's nodes; `final` = false until the bar is complete and certified).\n\nPricing: base + per cell. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 20,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1m","5m","15m","30m","1h","4h","1d"]}},{"name":"row_size","in":"query","required":false,"description":"Price bucket (e.g. 10 for $10 levels). Omit for exact prices.","schema":{"type":"string","pattern":"^[0-9]{1,12}(\\.[0-9]{1,12})?$"}},{"name":"tier","in":"query","required":false,"description":"Fill size filter.","schema":{"type":"string","default":"all","enum":["all","10k","100k"]}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":60}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"px":{"type":"string","description":"Price level (decimal string; may carry extra trailing zeros)"},"buy_sz":{"type":"string","description":"Taker buy size (decimal string; may carry extra trailing zeros)"},"sell_sz":{"type":"string","description":"Taker sell size (decimal string; may carry extra trailing zeros)"},"buy_n":{"type":"integer","description":"Taker buys"},"sell_n":{"type":"integer","description":"Taker sells"},"final":{"type":"boolean","description":"Bar complete and settled (false: the forming bar, or minutes not yet certified — values can still grow)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/footprint?interval=1h&row_size=50'"}]}},"/v1/markets/{coin}/footprint/actions":{"get":{"operationId":"getFootprintActions","summary":"Position-action footprint (open / close × long / short × taker / maker per price row)","description":"Per bar and price row, the size and notional of every fill leg split by what it did to the trader's position: open long, close long, open short, close short, each as taker or maker. Both legs of every trade count (they are different wallets' actions), so the totals are twice the market volume by design. A flip (long > short or short > long) splits exactly at the position it closed. Only whole bars inside the window that ended at least 2 minutes ago are served (best effort: late fills within that delay can still land); an empty window returns no rows. row_size: 'auto' (default: a band from the window's first price) or a decimal at least the auto size / 10. ≤ 2,500 rows per page (a page ends on a whole bar; one bar above it: use a coarser row_size or interval). A page reads ≤ 4 h at 1m and ≤ 1 day otherwise; the cursor continues.\n\nPricing: base + per row; ×2 for a page over 4 h. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1m","5m","15m","1h","4h","1d"]}},{"name":"row_size","in":"query","required":false,"description":"Price row size: auto, or a decimal (e.g. 10 for $10 rows).","schema":{"type":"string","pattern":"^(auto|[0-9]{1,12}(\\.[0-9]{1,18})?)$","default":"auto"}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":24}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"px":{"type":"string","description":"Price row floor (decimal string; may carry extra trailing zeros)"},"ol_taker_sz":{"type":"string","description":"Open long size, taker legs (decimal string; may carry extra trailing zeros)"},"ol_maker_sz":{"type":"string","description":"Open long size, maker legs (decimal string; may carry extra trailing zeros)"},"cl_taker_sz":{"type":"string","description":"Close long size, taker legs (decimal string; may carry extra trailing zeros)"},"cl_maker_sz":{"type":"string","description":"Close long size, maker legs (decimal string; may carry extra trailing zeros)"},"os_taker_sz":{"type":"string","description":"Open short size, taker legs (decimal string; may carry extra trailing zeros)"},"os_maker_sz":{"type":"string","description":"Open short size, maker legs (decimal string; may carry extra trailing zeros)"},"cs_taker_sz":{"type":"string","description":"Close short size, taker legs (decimal string; may carry extra trailing zeros)"},"cs_maker_sz":{"type":"string","description":"Close short size, maker legs (decimal string; may carry extra trailing zeros)"},"ol_taker_ntl":{"type":"string","description":"Open long notional (Σ trade price × leg size), taker legs (decimal string; may carry extra trailing zeros)"},"ol_maker_ntl":{"type":"string","description":"Open long notional (Σ trade price × leg size), maker legs (decimal string; may carry extra trailing zeros)"},"cl_taker_ntl":{"type":"string","description":"Close long notional (Σ trade price × leg size), taker legs (decimal string; may carry extra trailing zeros)"},"cl_maker_ntl":{"type":"string","description":"Close long notional (Σ trade price × leg size), maker legs (decimal string; may carry extra trailing zeros)"},"os_taker_ntl":{"type":"string","description":"Open short notional (Σ trade price × leg size), taker legs (decimal string; may carry extra trailing zeros)"},"os_maker_ntl":{"type":"string","description":"Open short notional (Σ trade price × leg size), maker legs (decimal string; may carry extra trailing zeros)"},"cs_taker_ntl":{"type":"string","description":"Close short notional (Σ trade price × leg size), taker legs (decimal string; may carry extra trailing zeros)"},"cs_maker_ntl":{"type":"string","description":"Close short notional (Σ trade price × leg size), maker legs (decimal string; may carry extra trailing zeros)"},"taker_legs":{"type":"integer","description":"Taker legs in the row"},"maker_legs":{"type":"integer","description":"Maker legs in the row"},"row_size":{"type":"string","description":"Row size used (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/footprint/actions?interval=15m'"}]}},"/v1/markets/{coin}/book/history":{"get":{"operationId":"getOrderBookAt","summary":"Order book at a past minute","description":"One market's order book (top 20 aggregated levels per side, best first) as Hyperdash's own node held it right after the first block at or past the requested minute. Sampled once a minute since 2026-11-11 19:45 UTC (no earlier history) and kept 30 days. Rows are the levels (side, level, px, sz); meta carries the sampled minute, its block height and time (block_time), best bid / ask, mid, spread, the crossed flag, per-side truncation (the band walk stopped at 3,000 levels, so that side's notionals are lower bounds) and the 10 / 25 / 50 / 100 / 200 bps band notionals (null without a two-sided, uncrossed book). A minute that was not sampled answers no rows (meta.minute null). No per-order data (see GET /v1/markets/{coin}/book/orders).\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 40 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"time","in":"query","required":true,"description":"Any time within the minute to read, epoch ms (floored to the minute; at most 30 days back, not in the future; sampled since 2026-11-11 19:45 UTC).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","description":"bid or ask"},"level":{"type":"integer","description":"Level index from the best (0 = best)"},"px":{"type":"string","description":"Price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Aggregated size at the level (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/book/history?time=1794427440000'"}]}},"/v1/markets/{coin}/twaps/history":{"get":{"operationId":"getMarketTwapHistory","summary":"TWAP history of one market","description":"Every TWAP status change in the market with the wallet, oldest first (a tape like the trades tape: wallets returned are observed). From our nodes' TWAP-status, CoreWriter and HIP-3 oracle output, live since 2026-11-05 19:00 UTC (earlier history is not loaded). Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. Range ≤ 30 days.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Event time, epoch ms"},"user":{"type":"string","description":"Wallet"},"twap_id":{"type":"integer","description":"TWAP id"},"status":{"type":"string","description":"activated | finished | terminated | error | waitingForTrigger | other"},"error":{"type":["string","null"],"description":"Error message (status error)"},"side":{"type":"string","description":"B | A"},"sz":{"type":["string","null"],"description":"Size (decimal string; may carry extra trailing zeros)"},"executed_sz":{"type":["string","null"],"description":"Executed size (decimal string; may carry extra trailing zeros)"},"executed_ntl":{"type":["string","null"],"description":"Executed notional (USD) (decimal string; may carry extra trailing zeros)"},"minutes":{"type":"integer","description":"Duration, minutes"},"reduce_only":{"type":"boolean","description":"Reduce only"},"randomize":{"type":"boolean","description":"Randomized slices"},"created_time":{"type":"integer","description":"TWAP created, epoch ms"},"trigger":{"type":["string","null"],"description":"Trigger of a stop TWAP (JSON text; null: none)"},"stop_px":{"type":["string","null"],"description":"Stop price (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/twaps/history'"}]}},"/v1/markets/{coin}/oracle":{"get":{"operationId":"getHip3OracleBars","summary":"HIP-3 oracle bars","description":"A builder-dex (HIP-3) market's oracle per bar from the node's oracle updates: open / high / low / close, mark and external-perp close, the oracle's daily price, updates and fallback updates. From our nodes' TWAP-status, CoreWriter and HIP-3 oracle output, live since 2026-11-05 19:00 UTC (earlier history is not loaded). Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. A page spans ≤ 7 days (1m, 5m) or 30 days (1h); the cursor continues.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1m","enum":["1m","5m","1h"]}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"oracle_open":{"type":["string","null"],"description":"Oracle open (decimal string; may carry extra trailing zeros)"},"oracle_high":{"type":["string","null"],"description":"Oracle high (decimal string; may carry extra trailing zeros)"},"oracle_low":{"type":["string","null"],"description":"Oracle low (decimal string; may carry extra trailing zeros)"},"oracle_close":{"type":["string","null"],"description":"Oracle close (decimal string; may carry extra trailing zeros)"},"mark_close":{"type":["string","null"],"description":"Mark close (decimal string; may carry extra trailing zeros)"},"external_perp_close":{"type":["string","null"],"description":"External perp close (decimal string; may carry extra trailing zeros)"},"oracle_daily_px":{"type":["string","null"],"description":"Oracle daily price (decimal string; may carry extra trailing zeros)"},"updates":{"type":"integer","description":"Updates"},"fallback_updates":{"type":"integer","description":"Fallback updates"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/xyz:TSLA/oracle?interval=5m'"}]}},"/v1/markets/{coin}/oracle/updates":{"get":{"operationId":"listHip3OracleUpdates","summary":"HIP-3 oracle updates","description":"Every oracle update of a builder-dex (HIP-3) market: class (Normal / Fallback), the mark / spot / external-perp inputs and the resulting oracle, mark and external-perp state, oldest first. From our nodes' TWAP-status, CoreWriter and HIP-3 oracle output, live since 2026-11-05 19:00 UTC (earlier history is not loaded). Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. Range ≤ 1 day.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 hour; range ≤ 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Update time, epoch ms"},"dex":{"type":"string","description":"Builder dex"},"update_class":{"type":"string","description":"Normal | Fallback"},"mark_px_input":{"type":["string","null"],"description":"Mark input (decimal string; may carry extra trailing zeros)"},"spot_px_input":{"type":["string","null"],"description":"Spot input (decimal string; may carry extra trailing zeros)"},"external_perp_px_input":{"type":["string","null"],"description":"External-perp input (decimal string; may carry extra trailing zeros)"},"oracle_px":{"type":["string","null"],"description":"Oracle (decimal string; may carry extra trailing zeros)"},"oracle_daily_px":{"type":["string","null"],"description":"Oracle daily price (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark (decimal string; may carry extra trailing zeros)"},"external_perp_px":{"type":["string","null"],"description":"External perp (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/xyz:TSLA/oracle/updates'"}]}},"/v1/network/evm-core-transfers":{"get":{"operationId":"listEvmCoreTransfers","summary":"HyperEVM ↔ Core actions of one type","description":"Every CoreWriter / system EVM ↔ Core action of one action_type across the network (e.g. SystemSpotSendAction, SystemSendAssetAction, SystemUsdClassTransferAction, order), oldest first. A network tape like the trades tape: wallets returned are observed. From our nodes' TWAP-status, CoreWriter and HIP-3 oracle output, live since 2026-11-05 19:00 UTC (earlier history is not loaded). Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. Range ≤ 7 days.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"action_type","in":"query","required":true,"description":"Action type (e.g. SystemSpotSendAction).","schema":{"type":"string","pattern":"^[A-Za-z]{1,64}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day; range ≤ 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Event time, epoch ms"},"user":{"type":"string","description":"Sender"},"destination":{"type":["string","null"],"description":"Recipient"},"action_type":{"type":"string","description":"Action"},"nonce":{"type":"integer","description":"Nonce"},"evm_tx_hash":{"type":["string","null"],"description":"HyperEVM tx hash"},"token":{"type":["integer","null"],"description":"Token id"},"wei":{"type":["string","null"],"description":"Amount in wei, exact (null when only the rounded wei_approx is known)"},"wei_approx":{"type":["string","null"],"description":"Amount in wei, rounded upstream (only when the exact amount is not known) (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/evm-core-transfers?action_type=SystemSpotSendAction'"}]}},"/v1/network/deploys":{"get":{"operationId":"listNetworkDeploys","summary":"HIP-3 / spot / outcome deploy actions","description":"Deploy actions and their governance (perp / spot / outcome deploys, register asset, halts, OI caps, fee scales, funding multipliers, …) with the deployer, oldest first (a network tape: deployers are observed). From our nodes' replica commands (every L1 action and the node's response), live since 2026-11-05 ~20:40 UTC (no earlier history). Actions usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"action_type","in":"query","required":false,"description":"Only this action type (e.g. perpDeploy).","schema":{"type":"string","pattern":"^[A-Za-z]{1,64}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Block time, epoch ms"},"action_type":{"type":"string","description":"Action"},"deployer":{"type":"string","description":"Deployer"},"ok":{"type":"boolean","description":"Accepted by the node"},"error":{"type":["string","null"],"description":"Error (not accepted)"},"asset":{"type":["integer","null"],"description":"Asset index"},"action":{"type":"string","description":"The action (JSON text)"},"block":{"type":"integer","description":"Block height"},"bundle_index":{"type":"integer","description":"Bundle in the block"},"action_index":{"type":"integer","description":"Action in the bundle"},"inner":{"type":"boolean","description":"An inner action (of a multi-sig or batch)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/deploys?action_type=perpDeploy'"}]}},"/v1/liquidations":{"get":{"operationId":"listLiquidations","summary":"Liquidation events","description":"Liquidations in [start_time, end_time], ascending, all markets or one coin. Range ≤ 7 days; page with the cursor.\n\nPricing: base + per row. Scope: `liquidations:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"liquidations:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"coin":{"type":"string","description":"Market"},"tid":{"type":"string","description":"Trade id"},"side":{"type":"string","description":"Liquidated position: long or short"},"method":{"type":"string","description":"market or backstop"},"user":{"type":"string","description":"Liquidated wallet"},"px":{"type":"string","description":"Fill price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"px × sz (USD) (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":"string","description":"Realized PnL of the liquidated position (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark price at liquidation (decimal string; may carry extra trailing zeros)"},"hash":{"type":"string","description":"Transaction hash"},"start_position":{"type":["string","null"],"description":"Liquidated wallet's position before this fill (signed; null: its own leg is not stored) (decimal string; may carry extra trailing zeros)"},"dir":{"type":["string","null"],"description":"Liquidated leg's direction (e.g. Close Long)"},"oid":{"type":["string","null"],"description":"Liquidated leg's order id"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations?coin=ETH'"}]}},"/v1/leaderboards/pnl":{"get":{"operationId":"getPnlLeaderboard","summary":"PnL leaderboard","description":"hyperdash.com's PnL leaderboard: wallets ranked by total, realized or unrealized PnL, or their ROI, in a window and asset category, with the PnL split, capital, volume, trades and win/loss counts. 24h / 7d / 30d / ytd rank portfolio PnL (account value change net of transfers, open positions included); all time ranks Hyperliquid's all-time PnL on category all and completed-trade PnL on the other categories. One wallet's row: GET /v1/accounts/{address}/leaderboard. account_value is the wallet's live perps equity as the site overlays it (one read per page, ≤ 1.5 s, kept 5 s), else the board's hourly snapshot; ranks never use it. Page with the cursor.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["leaderboards"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"window","in":"query","required":false,"description":"Ranking window. Default 30d, as hyperdash.com's leaderboard.","schema":{"type":"string","default":"30d","enum":["alltime","24h","7d","30d","ytd"]}},{"name":"category","in":"query","required":false,"description":"Asset category.","schema":{"type":"string","default":"all","enum":["all","crypto","majors","memes","alts","equities","indices","commodities","fx"]}},{"name":"sort","in":"query","required":false,"description":"Ranked metric: total (net PnL), realized, unrealized, or their ROI (÷ capital; wallets with capital ≥ $1,000). Wallets without that value are not ranked.","schema":{"type":"string","default":"total","enum":["total","realized","unrealized","roi","realized_roi","unrealized_roi"]}},{"name":"min_trades","in":"query","required":false,"description":"Minimum completed trades.","schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}},{"name":"min_account_value","in":"query","required":false,"description":"Only wallets with at least this account value (USD; hyperdash.com's equity filter). Filtered on the board's hourly account value: the live value returned can differ slightly.","schema":{"type":"string","enum":["1000","10000","100000","1000000","10000000"]}},{"name":"max_account_value","in":"query","required":false,"description":"Only wallets with at most this account value (USD), on the board's hourly value as min_account_value.","schema":{"type":"string","enum":["10000","100000","1000000","10000000","100000000"]}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"display_name":{"type":["string","null"],"description":"Display name"},"tag":{"type":["string","null"],"description":"Trader tag"},"net_pnl":{"type":"string","description":"Net PnL (USD) (decimal string; may carry extra trailing zeros)"},"realized_pnl":{"type":["string","null"],"description":"Realized PnL over the window (USD): closed PnL − fees + funding, partial closes included (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Change in open-position unrealized PnL over the window (USD); all time: open unrealized PnL now (decimal string; may carry extra trailing zeros)"},"capital":{"type":["string","null"],"description":"Capital (USD): equity at the window start + peak net external inflow (decimal string; may carry extra trailing zeros)"},"roi":{"type":["string","null"],"description":"Net PnL ÷ capital (ratio: 0.417 = 41.7 %) (decimal string; may carry extra trailing zeros)"},"realized_roi":{"type":["string","null"],"description":"Realized PnL ÷ capital (ratio) (decimal string; may carry extra trailing zeros)"},"unrealized_roi":{"type":["string","null"],"description":"Unrealized PnL ÷ capital (ratio) (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL before fees and funding (USD): 24h / 7d / 30d / ytd = price PnL incl. open positions (net_pnl + fees − funding); all time = completed-trade gross PnL (closed round trips) (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding PnL (decimal string; may carry extra trailing zeros)"},"total_fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Completed trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"account_value":{"type":["string","null"],"description":"Account value (USD) as hyperdash.com's leaderboard shows it: live perps equity — every perp dex's account value summed; unified accounts: their collateral stablecoins (USDC, USDH, USDE, USDT0); portfolio-margin accounts: their signed spot portfolio at mids — else the board's hourly snapshot (see account_value_source) (decimal string; may carry extra trailing zeros)"},"account_value_as_of":{"type":["integer","null"],"description":"When the live value was read, epoch ms (null for the snapshot value)"},"account_value_source":{"type":["string","null"],"description":"live (read within the last 5 s) or snapshot (the live read did not answer for this wallet within 1.5 s)"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"label":{"type":["string","null"],"description":"Hyperdash label"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"verified":{"type":["boolean","null"],"description":"Verified profile"},"copy_score":{"type":["string","null"],"description":"Copy score (0–100) (decimal string; may carry extra trailing zeros)"},"mark_quality":{"type":["integer","null"],"description":"Quality of the mark behind the unrealized part (1 = live mark of every open position, 0 = some fell back)"},"window_start":{"type":["integer","null"],"description":"Board window start, epoch ms (null for all time)"},"as_of":{"type":["integer","null"],"description":"Board computed at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/leaderboards/pnl?window=7d'"}]}},"/v1/markets/positioning":{"get":{"operationId":"getPositioning","summary":"Long/short positioning history","description":"Open long and short notional, unrealized PnL and position counts, hourly or daily, for the whole exchange or one market. `limit` buckets per page.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for the whole exchange).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"snapshot_time":{"type":"integer","description":"Snapshot used for the bucket, epoch ms"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"long_upnl":{"type":"string","description":"Longs' unrealized PnL (decimal string; may carry extra trailing zeros)"},"short_upnl":{"type":"string","description":"Shorts' unrealized PnL (decimal string; may carry extra trailing zeros)"},"long_positions":{"type":"integer","description":"Long positions"},"short_positions":{"type":"integer","description":"Short positions"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/positioning?interval=1d'"}]}},"/v1/outcomes":{"get":{"operationId":"listOutcomeStats","summary":"HIP-4 outcome market activity","description":"Per outcome market over the last `hours`: shares traded (`share_volume`, the volume hyperdash.com and Hyperliquid show: shares at $1 face value), Yes-space dollar notional (`yes_notional`), trades, traders, last Yes price. Sorted by `yes_notional`, largest first (not by `share_volume`).\n\nPricing: base × look-back tier (`hours`). Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"hours","in":"query","required":false,"description":"Look-back hours (≤ 168 = 7 days).","schema":{"type":"integer","minimum":1,"maximum":168,"default":24}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"outcome":{"type":"integer","description":"Outcome id"},"yes_notional":{"type":"string","description":"Dollar notional traded, in Yes-space prices (USD) (decimal string; may carry extra trailing zeros)"},"share_volume":{"type":"string","description":"Shares traded: the volume hyperdash.com and Hyperliquid show (shares at $1 face value) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"traders":{"type":"integer","description":"Traders"},"last_yes_px":{"type":["string","null"],"description":"Last Yes price (probability) (decimal string; may carry extra trailing zeros)"},"first_trade_at":{"type":"integer","description":"First trade, epoch ms"},"last_trade_at":{"type":"integer","description":"Last trade, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes?hours=24'"}]}},"/v1/outcomes/markets":{"get":{"operationId":"listOutcomeMarkets","summary":"HIP-4 outcome markets","description":"One row per HIP-4 outcome market from Hyperdash's outcome registry: its Yes / No coins, the question (event) it answers — a question's outcomes are its possible answers, `is_fallback` marks the catch-all one — names and description as published on chain, deployer venue, quote token, status, expiry and open interest (minted Yes/No pairs, in shares at $1 face) with the time of the market snapshot it comes from. Snapshots run every 5 minutes for active markets, so a settled market keeps its last pre-settlement open interest; listings without `outcome_id` / `question_id` look back 1 day for it (null beyond). Newest outcome first, one page of up to `limit` outcomes. No wallets.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"status","in":"query","required":false,"description":"Market status.","schema":{"type":"string","default":"active","enum":["active","settled","all"]}},{"name":"outcome_id","in":"query","required":false,"description":"One outcome.","schema":{"type":"integer","minimum":0,"maximum":1000000000000000}},{"name":"question_id","in":"query","required":false,"description":"One question (event): its outcomes, the fallback included.","schema":{"type":"integer","minimum":1,"maximum":1000000000000000}},{"name":"limit","in":"query","required":false,"description":"Outcomes (newest first).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"outcome":{"type":"integer","description":"Outcome id"},"coin_yes":{"type":"string","description":"Yes-side coin (#<outcome × 10>), as in mids and trades"},"coin_no":{"type":"string","description":"No-side coin (#<outcome × 10 + 1>)"},"question_id":{"type":["integer","null"],"description":"Question (event) id; null: a standalone outcome"},"question_name":{"type":["string","null"],"description":"Question name"},"is_fallback":{"type":"boolean","description":"The question's fallback (catch-all) outcome"},"name":{"type":"string","description":"Outcome name"},"description":{"type":["string","null"],"description":"Description as published (key:value pairs separated by |); \"\" when published empty"},"side0_name":{"type":"string","description":"Yes-side name"},"side1_name":{"type":"string","description":"No-side name"},"venue":{"type":["string","null"],"description":"Deployer venue"},"quote_token":{"type":["string","null"],"description":"Quote token"},"status":{"type":"string","description":"active or settled"},"first_seen_time":{"type":"integer","description":"First seen by Hyperdash, epoch ms"},"expiry_time":{"type":["integer","null"],"description":"Expiry, epoch ms (UTC): the registry's expiry, else the description's time / dateTime / *Deadline key; null when none (a question's outcomes: the deadline sits on the question)"},"expiry_raw":{"type":["string","null"],"description":"The expiry as published (YYYYMMDD-HHMM)"},"open_interest":{"type":["string","null"],"description":"Open interest: minted Yes/No pairs, in shares ($1 face); null without a market snapshot in reach (decimal string; may carry extra trailing zeros)"},"oi_as_of":{"type":["integer","null"],"description":"Time of the market snapshot open_interest comes from, epoch ms"},"class":{"type":["string","null"],"description":"Outcome class from its template (e.g. priceBinary)"},"underlying":{"type":["string","null"],"description":"Underlying market of a price outcome"},"period":{"type":["string","null"],"description":"Period of a recurring outcome"},"target_price":{"type":["string","null"],"description":"Target price of a price outcome (decimal string; may carry extra trailing zeros)"},"category":{"type":["string","null"],"description":"Category"},"sub_category":{"type":["string","null"],"description":"Sub-category"},"deployer_fee_scale":{"type":["string","null"],"description":"Deployer fee scale (decimal string; may carry extra trailing zeros)"},"settle_fraction":{"type":["string","null"],"description":"Settlement: Yes-side payout share (1 = Yes won, 0 = No won, 0.5 = split); null until settled (decimal string; may carry extra trailing zeros)"},"settle_details":{"type":["string","null"],"description":"Settlement details as published"},"settled_at":{"type":["integer","null"],"description":"When Hyperdash's registry saw the outcome settled, epoch ms: its poll runs after the chain settlement, so this is typically 20–30 s after the outcome's Settlement fills (their `time` is the on-chain moment)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/markets?status=active&limit=500'"}]}},"/v1/outcomes/{outcome}/probability":{"get":{"operationId":"getOutcomeProbability","summary":"Outcome probability history","description":"Per bucket of one outcome market (Yes side): the last traded Yes price (`trade_px`, what Hyperliquid's candle close and hyperdash.com plot; a No-book trade at px counts as 1 − px; a bucket without a trade carries the last trade before it, `last_trade_time` < the bucket start), the mark and mid (implied probability) and 24 h volume of the bucket's last market snapshot (5-minute cadence), and open interest in shares ($1 face). Buckets with trades but no snapshot have null snapshot fields. `limit` buckets per page. A page whose bars are all empty (before the first data, a gap) reads on to the next bars with data in the same call, as far as the longest page this route serves; a page that still holds no bars but has more only moves the cursor on. Without start_time the window is the default range in whole bars, ending with the bar in progress.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"outcome","in":"path","required":true,"description":"Outcome id.","schema":{"type":"integer","minimum":0,"maximum":1000000000000000}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["5m","1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"mark_px":{"type":["string","null"],"description":"Mark (probability) at the bucket's last snapshot (decimal string; may carry extra trailing zeros)"},"mid_px":{"type":["string","null"],"description":"Mid (decimal string; may carry extra trailing zeros)"},"day_volume":{"type":["string","null"],"description":"24 h notional volume (decimal string; may carry extra trailing zeros)"},"last_time":{"type":["integer","null"],"description":"Last snapshot in the bucket, epoch ms (null: no snapshot)"},"trade_px":{"type":["string","null"],"description":"Last traded Yes price at or before the bucket's end (null: no trade yet) (decimal string; may carry extra trailing zeros)"},"last_trade_time":{"type":["integer","null"],"description":"Time of that trade, epoch ms (before the bucket start when carried over)"},"open_interest":{"type":["string","null"],"description":"Open interest at the bucket's last snapshot: minted Yes/No pairs, in shares ($1 face) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/1/probability'"}]}},"/v1/network/priority-fees":{"get":{"operationId":"getPriorityFees","summary":"Priority fee spend","description":"HYPE and USD spent on priority gas (IOC writes, ALO estimate, reads) per bucket in [start_time, end_time). Hourly ≤ 30 days, daily ≤ 365 days. One page.\n\nPricing: base × range tier (≤1 d ×1, ≤7 d ×3, ≤30 d ×6, ≤90 d ×12, ≤365 d ×16). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 5,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"write_hype":{"type":"string","description":"Write (order) priority fees, HYPE (decimal string; may carry extra trailing zeros)"},"write_usd":{"type":"string","description":"Write priority fees, USD (decimal string; may carry extra trailing zeros)"},"write_orders":{"type":"integer","description":"Priority orders"},"read_hype":{"type":"string","description":"Read priority fees, HYPE (decimal string; may carry extra trailing zeros)"},"read_usd":{"type":"string","description":"Read priority fees, USD (decimal string; may carry extra trailing zeros)"},"reads":{"type":"integer","description":"Priority reads"},"total_hype":{"type":"string","description":"Total HYPE (decimal string; may carry extra trailing zeros)"},"total_usd":{"type":"string","description":"Total USD (decimal string; may carry extra trailing zeros)"},"complete":{"type":"boolean","description":"Every fee in the bucket priced in both HYPE and USD"},"usd_complete":{"type":"boolean","description":"Every fee priced in USD"},"hype_complete":{"type":"boolean","description":"Every ALO fee converted to HYPE"},"read_unpriced_hype":{"type":["string","null"],"description":"Read fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"total_txs":{"type":["integer","null"],"description":"Paying transactions"},"write_ioc_hype":{"type":["string","null"],"description":"IOC priority fees paid (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_usd":{"type":["string","null"],"description":"IOC priority fees paid (USD) (decimal string; may carry extra trailing zeros)"},"write_ioc_orders":{"type":["integer","null"],"description":"IOC orders that paid"},"write_ioc_fills":{"type":["integer","null"],"description":"Fills of those IOC orders"},"write_ioc_unpriced_hype":{"type":["string","null"],"description":"IOC fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"write_alo_hype_estimate":{"type":["string","null"],"description":"ALO priority fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_usd":{"type":["string","null"],"description":"ALO priority fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_orders":{"type":["integer","null"],"description":"ALO orders that paid"},"write_alo_resting_notional_usd":{"type":["string","null"],"description":"Notional of those ALO orders while resting (USD) (decimal string; may carry extra trailing zeros)"},"write_unpriced_hype":{"type":["string","null"],"description":"Write fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unpriced_hype":{"type":["string","null"],"description":"All fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unconverted_usd":{"type":["string","null"],"description":"USD fees not converted to HYPE (decimal string; may carry extra trailing zeros)"},"hype_estimated":{"type":"boolean","description":"HYPE totals include ALO estimates"},"live_from":{"type":["integer","null"],"description":"From this time (epoch ms) the window is filled from the live tail (less settled)"},"cumulative_write_ioc_hype":{"type":["string","null"],"description":"Running total of write ioc hype since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_write_ioc_usd":{"type":["string","null"],"description":"Running total of write ioc usd since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_write_alo_hype_estimate":{"type":["string","null"],"description":"Running total of write alo hype estimate since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_write_alo_usd":{"type":["string","null"],"description":"Running total of write alo usd since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_write_hype":{"type":["string","null"],"description":"Running total of write hype since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_write_usd":{"type":["string","null"],"description":"Running total of write usd since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_read_hype":{"type":["string","null"],"description":"Running total of read hype since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_read_usd":{"type":["string","null"],"description":"Running total of read usd since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_hype":{"type":["string","null"],"description":"Running total of hype since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_usd":{"type":["string","null"],"description":"Running total of usd since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_unconverted_usd":{"type":["string","null"],"description":"Running total of unconverted usd since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_unpriced_hype":{"type":["string","null"],"description":"Running total of unpriced hype since the window start (decimal string; may carry extra trailing zeros)"},"cumulative_hype_complete":{"type":"boolean","description":"Running HYPE total complete"},"cumulative_hype_estimated":{"type":"boolean","description":"Running HYPE total includes estimates"},"cumulative_usd_complete":{"type":"boolean","description":"Running USD total complete"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/priority-fees?interval=1d'"}]}},"/v1/accounts/{address}/account-value":{"get":{"operationId":"getAccountValueHistory","summary":"Hourly account value","description":"Hourly account value snapshots (USD) in [start_time, end_time], ascending. Range ≤ 365 days; page with the cursor.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":2500,"default":500}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Snapshot time, epoch ms"},"account_value":{"type":"string","description":"Account value (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/account-value'"}]}},"/v1/accounts/{address}/pnl-chart":{"get":{"operationId":"getAccountPnlChart","summary":"PnL chart","description":"A wallet's cumulative PnL over a window, like hyperdash.com's profile chart, computed by Hyperdash from its own data: the hourly account-value snapshots (as GET /v1/accounts/{address}/account-value) and the capital moved in or out of that value, with GET /v1/accounts/{address}/pnl-calendar's definition (deposits, withdrawals, transfers with other wallets on any side at their USD value, vaults, borrow / lend and HYPE staking transfers from 2026-09-23; before it the perp-cash USDC moves). Per bucket: the account value at its last point (defined next), the net flows assigned to its points, and pnl = account value − the value at the window start − net flows since. A snapshot with a ledger entry of the wallet (any transfer, including its own spot↔perp moves) in the 20 minutes before it is not a point, because the stored value takes transfers in up to about 20 minutes late — except each UTC day's close as the calendar picks it (its last snapshot, or the one before it), which is always a point. Each capital move counts at the first point at or after it, and the value at the start is the last point-eligible snapshot before the window on the day of the last snapshot before it or the day before (if neither day has one, that last snapshot itself; 0 if there is none). Account value change minus flows only: no realized / unrealized split; for a unified account it is the whole collateral pool's PnL, as in the calendar, and the calendar's known limits apply. A one-time step from a change in how Hyperdash computes the stored value (2026-11: flat classic accounts' spot wallets) is in net_flows, not in pnl, with the calendar's exceptions (wallets active around the switch, portfolio-margin accounts). Between two daily closes, pnl changes by the sum of GET /v1/accounts/{address}/pnl-calendar's daily PnL over those days. `window` sets the bucket and default range: day (15 min buckets, last 24 h; with start_time ≤ 7 days), week (1 h, last 7 days; ≤ 30 days), month (4 h, last 30 days; ≤ 90 days), alltime (1 day, from 2025-08-25 — the first snapshots — through the whole history, buckets widened to whole multi-day buckets past 1,000 days; with start_time ≤ 365 days). Buckets without a point are absent. One page.\n\nPricing: base × range tier (≤7 d ×1, ≤30 d ×3, ≤90 d ×4, ≤365 d ×10, longer ×11). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"window","in":"query","required":false,"description":"Bucket size and default range.","schema":{"type":"string","default":"day","enum":["day","week","month","alltime"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − the window (alltime: 2025-08-25).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms"},"account_value":{"type":"string","description":"Account value at the bucket's last point: its last snapshot that is not excluded by the 20-minute rule (USD) (decimal string; may carry extra trailing zeros)"},"net_flows":{"type":"string","description":"Net capital moved in (> 0) or out (< 0) assigned to the bucket, including a one-time revaluation step of the stored value (USD) (decimal string; may carry extra trailing zeros)"},"pnl":{"type":"string","description":"Cumulative PnL at the bucket's last point since the window start (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/pnl-chart?window=week'"}]}},"/v1/accounts/{address}/portfolio-daily":{"get":{"operationId":"getAccountPortfolioDaily","summary":"Daily account value and PnL","description":"Per UTC day, from Hyperliquid's own portfolio history (`source` hl, recent days): whole-account equity (perps, spot, vaults, staked HYPE) at Hyperliquid's daily close (its last sample of the day, typically ~75 minutes before midnight UTC; `close_time` gives it), the whole account's PnL between two closes (transfers excluded) and its perp part. Older days are rebuilt by Hyperdash from fills, funding and position snapshots (`source` rebuilt): their PnL is perp PnL only. This is not the hyperdash.com PnL calendar (that is GET /v1/accounts/{address}/pnl-calendar, UTC days). Range ≤ 365 days; page with the cursor.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":400,"default":400}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer","description":"UTC day start, epoch ms"},"close_time":{"type":"integer","description":"Close snapshot, epoch ms"},"account_value":{"type":"string","description":"Account value at close (USD) (decimal string; may carry extra trailing zeros)"},"daily_pnl":{"type":"string","description":"Whole-account PnL since the previous close (decimal string; may carry extra trailing zeros)"},"perp_daily_pnl":{"type":"string","description":"Perp PnL since the previous close (decimal string; may carry extra trailing zeros)"},"source":{"type":"string","description":"hl (Hyperliquid portfolio) or rebuilt (perp PnL only)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/portfolio-daily'"}]}},"/v1/markets/{coin}/positions":{"get":{"operationId":"getMarketPositions","summary":"Open positions of one market","description":"Open positions sorted by notional (or another field), long, short or both, optionally within ranges (the hyperdash.com asset page's filters: notional, entry, liquidation price, unrealized PnL, account value; bounds inclusive; a position without a liquidation price fails any liquidation bound; an unknown account value filters as 0). meta: the counts and notionals of the positions matching every filter (`total_count`, and per side as asked), and the long / short tab badges (`badge_*`: the range filters only, whatever `side`). `block_time`: the block (epoch ms) the positions state reflects; `computed_at`: when the server computed it. A row with `margin_uncertain` true serves null liquidation price and account value (and null leverage / leverage_type when the position was opened since the engine's last state snapshot): its margin is not certified until the next snapshot (~12 min). `mark`: the price positions are valued at — Hyperliquid's own mark for core-exchange markets (from the validators' latest price update, ≤ 20 s old; rounded to 5 significant figures as Hyperliquid publishes it); otherwise (HIP-3 markets, or that update older than 20 s) the median of the fresh sources among the last trade (≤ ~10 s), the reference oracle and, core markets, that update's average of oracle and mark: the midpoint when two are fresh, the one available otherwise. Page with the cursor.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Perp market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"side","in":"query","required":false,"description":"Position side.","schema":{"type":"string","default":"all","enum":["all","long","short"]}},{"name":"sort","in":"query","required":false,"description":"Sort field.","schema":{"type":"string","default":"notional","enum":["notional","entry_px","liquidation_px","unrealized_pnl","funding_pnl","account_value","address"]}},{"name":"order","in":"query","required":false,"description":"Sort order (asc for A→Z addresses).","schema":{"type":"string","default":"desc","enum":["desc","asc"]}},{"name":"min_notional","in":"query","required":false,"description":"Minimum notional at mark (USD) (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"max_notional","in":"query","required":false,"description":"Maximum notional at mark (USD) (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"min_entry_px","in":"query","required":false,"description":"Minimum entry price (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"max_entry_px","in":"query","required":false,"description":"Maximum entry price (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"min_liquidation_px","in":"query","required":false,"description":"Minimum liquidation price (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"max_liquidation_px","in":"query","required":false,"description":"Maximum liquidation price (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"min_unrealized_pnl","in":"query","required":false,"description":"Minimum unrealized PnL (USD) (inclusive).","schema":{"type":"string","pattern":"^-?\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"max_unrealized_pnl","in":"query","required":false,"description":"Maximum unrealized PnL (USD) (inclusive).","schema":{"type":"string","pattern":"^-?\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"min_account_value","in":"query","required":false,"description":"Minimum account value (USD) (inclusive).","schema":{"type":"string","pattern":"^-?\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"max_account_value","in":"query","required":false,"description":"Maximum account value (USD) (inclusive).","schema":{"type":"string","pattern":"^-?\\d{1,15}(\\.\\d{1,12})?$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"side":{"type":"string","description":"long or short"},"size":{"type":"string","description":"Signed size (negative = short) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional at mark (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding since the position opened (USD; received > 0) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":["string","null"],"description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"leverage":{"type":["integer","null"],"description":"Leverage setting (null when margin_uncertain and opened since the last state snapshot)"},"leverage_type":{"type":["string","null"],"description":"cross or isolated (null when margin_uncertain and opened since the last state snapshot)"},"margin_uncertain":{"type":["boolean","null"],"description":"The position's margin is not certified yet: it was opened since the engine's last state snapshot (about every 12 min), or it is a cross position sharing its margin pool with one (an isolated open moves margin out of that pool), or a fill since that snapshot left its pool below the maintenance requirement — a state Hyperliquid liquidates at once, so an input such as a deposit or transfer is missing (portfolio-margin pools excepted). Its liquidation price and account value are null, and — when it was itself opened since then — its leverage and leverage_type too; it is left out of the liquidation levels. Certified again at the next state snapshot. Null: the positions server does not report it."}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/positions?side=long&limit=50'"}]}},"/v1/markets/{coin}/liquidation-levels":{"get":{"operationId":"getLiquidationLevels","summary":"Liquidation levels (liq map)","description":"Projected liquidation prices of every open position whose margin is certified (positions opened since the engine's last state snapshot, ~12 min, the cross positions sharing their margin pool, and pools other than portfolio margin that a fill since then left below their maintenance requirement are left out until the next snapshot), bucketed by price: notional, size and positions per level, longs and shorts. meta: `mark` (the price the ladder was computed at), `bucket_size` (bucket width in price) and `computed_at`.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Perp market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","description":"long (longs liquidated below mark) or short"},"px":{"type":"string","description":"Bucket price (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional at mark (USD) (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"positions":{"type":"integer","description":"Positions in the bucket"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/liquidation-levels'"}]}},"/v1/markets/{coin}/stop-levels":{"get":{"operationId":"getStopLevels","summary":"Stop-order levels","description":"Resting stop-loss / take-profit triggers bucketed by trigger price: notional, size and order count, sells and buys. meta: `mark`, `bucket_size` (bucket width in price) and `computed_at`.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Perp market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","description":"sell or buy (the order the trigger places)"},"px":{"type":"string","description":"Bucket trigger price (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional at trigger (USD) (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"orders":{"type":"integer","description":"Orders in the bucket"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/stop-levels'"}]}},"/v1/accounts/liquidation-risk":{"get":{"operationId":"getAccountsLiquidationRisk","summary":"Large accounts by the BTC move that liquidates them","description":"Accounts ranked by how close a BTC move takes them to liquidation (or by equity, notional, leverage): the BTC move (signed fraction: −0.12 = BTC down 12 %) and BTC price that liquidate the account's closest cross book, its equity, notionals, cross leverage, BTC-equivalent exposure, maintenance and cushion. Hyperdash's margin engine (every sweep, from our nodes) gives each account's exact margin inputs; every coin is then projected through its 30 / 60 / 90-day hourly beta to BTC (coins without usable history at 1.0), positions and margin tiers held constant: a statistical projection, not an engine-exact liquidation price. A book liquidates at equity = maintenance (portfolio margin: maintenance = 0.95 × the liquidation value). No plausible move (outside −95 % … +300 %) = null. Covers accounts with ≥ $100k equity or gross notional (the engine's export). One page (the top `limit`); meta: btc_mark, computed_at (sweep), input_at (the older of the newest node event and oracle update), stale (input older than 60 s), the matching account count.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"kind","in":"query","required":false,"description":"cross: standard and unified accounts (every account that is not portfolio margin); coin_margined: portfolio-margin accounts posting ≥ $1,000 of HYPE / BTC collateral (hyperdash.com's XM / CM risk widgets).","schema":{"type":"string","default":"cross","enum":["cross","coin_margined"]}},{"name":"min_equity","in":"query","required":false,"description":"Minimum account equity (USD; cross books + isolated margin and value).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$","default":"100000"}},{"name":"min_leverage","in":"query","required":false,"description":"Minimum cross leverage (cross notional / cross equity). Default: 3 for cross (below 3x a plausible liquidation move is rare), 0 for coin_margined.","schema":{"type":"string","pattern":"^\\d{1,6}(\\.\\d{1,6})?$"}},{"name":"sort","in":"query","required":false,"description":"risk: closest to liquidation first (no plausible move last); else largest first. Ties by address.","schema":{"type":"string","default":"risk","enum":["risk","equity","notional","leverage"]}},{"name":"limit","in":"query","required":false,"description":"Accounts per page.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"mode":{"type":"string","description":"Margin mode (classic, unified, portfolioMargin)"},"coin_margined":{"type":"boolean","description":"Portfolio margin with ≥ $1,000 HYPE / BTC collateral"},"equity":{"type":"string","description":"Account equity (USD) (decimal string; may carry extra trailing zeros)"},"cross_notional":{"type":"string","description":"Cross positions' gross notional (USD) (decimal string; may carry extra trailing zeros)"},"isolated_notional":{"type":"string","description":"Isolated positions' gross notional (USD) (decimal string; may carry extra trailing zeros)"},"cross_leverage":{"type":["string","null"],"description":"Cross notional / cross equity (decimal string; may carry extra trailing zeros)"},"btc_delta":{"type":"string","description":"Σ notional × beta over the cross books: BTC-equivalent exposure (USD; collateral not included) (decimal string; may carry extra trailing zeros)"},"maintenance_margin":{"type":"string","description":"Cross maintenance margin (USD) (decimal string; may carry extra trailing zeros)"},"cushion":{"type":"string","description":"Cross equity − maintenance (USD) (decimal string; may carry extra trailing zeros)"},"collateral_hype_usd":{"type":"string","description":"Portfolio-margin HYPE collateral (USD) (decimal string; may carry extra trailing zeros)"},"collateral_btc_usd":{"type":"string","description":"Portfolio-margin BTC collateral (USD) (decimal string; may carry extra trailing zeros)"},"btc_move":{"type":["string","null"],"description":"BTC move that liquidates the closest cross book (fraction, signed) (decimal string; may carry extra trailing zeros)"},"btc_liquidation_px":{"type":["string","null"],"description":"BTC price at that move (decimal string; may carry extra trailing zeros)"},"approximate":{"type":"boolean","description":"Some positions had no mark, or a margin not yet certified (the move is approximate)"},"margin_uncertain":{"type":["boolean","null"],"description":"Some positions' margin is not certified yet (opened since the engine's last state snapshot, ~12 min, sharing their pool with one, or in a pool, not portfolio margin, that a fill since then left below its maintenance requirement): the account's equity and books are the engine's assumption, and it stays out of the ladder. Null: the positions server does not report it"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/liquidation-risk?kind=cross&limit=50'"}]}},"/v1/accounts/liquidation-risk/ladder":{"get":{"operationId":"getLiquidationRiskLadder","summary":"Accounts liquidated per 1 % BTC move","description":"The same accounts as GET /v1/accounts/liquidation-risk, bucketed by the BTC move that liquidates them: per 1 % bucket from −50 % to +50 % (floor of the move), the accounts, their cross notional and equity, and the BTC price at the bucket's lower bound. Accounts without a plausible move, or outside ±50 %, are counted in meta (unplaced); accounts whose margin is not certified yet (positions opened since the engine's last state snapshot, ~12 min, or a pool, not portfolio margin, that a fill since then left below its maintenance requirement) are left out and counted in meta (uncertain; null when the positions server does not report certification, and then no account is left out). Hyperdash's margin engine (every sweep, from our nodes) gives each account's exact margin inputs; every coin is then projected through its 30 / 60 / 90-day hourly beta to BTC (coins without usable history at 1.0), positions and margin tiers held constant: a statistical projection, not an engine-exact liquidation price. A book liquidates at equity = maintenance (portfolio margin: maintenance = 0.95 × the liquidation value). No plausible move (outside −95 % … +300 %) = null. Covers accounts with ≥ $100k equity or gross notional (the engine's export). meta: btc_mark, computed_at (sweep), input_at (the older of the newest node event and oracle update), stale (input older than 60 s), the matching account count. No wallets.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"kind","in":"query","required":false,"description":"cross: standard and unified accounts (every account that is not portfolio margin); coin_margined: portfolio-margin accounts posting ≥ $1,000 of HYPE / BTC collateral (hyperdash.com's XM / CM risk widgets).","schema":{"type":"string","default":"cross","enum":["cross","coin_margined"]}},{"name":"min_equity","in":"query","required":false,"description":"Minimum account equity (USD; cross books + isolated margin and value).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,12})?$","default":"100000"}},{"name":"min_leverage","in":"query","required":false,"description":"Minimum cross leverage (cross notional / cross equity). Default: 3 for cross (below 3x a plausible liquidation move is rare), 0 for coin_margined.","schema":{"type":"string","pattern":"^\\d{1,6}(\\.\\d{1,6})?$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"from_pct":{"type":"integer","description":"Bucket start (BTC move, %)"},"to_pct":{"type":"integer","description":"Bucket end (exclusive, %)"},"accounts":{"type":"integer","description":"Accounts liquidated in the bucket"},"notional":{"type":"string","description":"Their cross notional (USD) (decimal string; may carry extra trailing zeros)"},"equity":{"type":"string","description":"Their equity (USD) (decimal string; may carry extra trailing zeros)"},"btc_px":{"type":["string","null"],"description":"BTC price at the bucket start (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/liquidation-risk/ladder?kind=coin_margined'"}]}},"/v1/markets/{coin}/liquidation-heatmap":{"get":{"operationId":"getLiquidationHeatmap","summary":"Liquidation-price heatmap of one market","description":"Per bar and price band: size of long and short positions whose liquidation price falls in the band, from the hourly positions snapshots. A 1h bar is its hour's snapshot; a 4h or 1d bar is the last hourly snapshot inside it (its close), never a sum over the bar's hours. Bands span 0 to 2 × mark; optional `min_px` / `max_px` keep only the bands that overlap that price range (hyperdash.com's heatmap view). Positions worth 100 USD or less at their liquidation price (|size| × liquidation price) are not in the snapshot (meta.min_notional_usd); the live ladder /liquidation-levels has no floor. `limit` bars per page; page with the cursor.\n\nPricing: base + per cell. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1h","4h","1d"]}},{"name":"min_px","in":"query","required":false,"description":"Lower price: bands ending below it are left out.","schema":{"type":"string","pattern":"^\\d{1,12}(\\.\\d{1,12})?$"}},{"name":"max_px","in":"query","required":false,"description":"Upper price: bands starting above it are left out.","schema":{"type":"string","pattern":"^\\d{1,12}(\\.\\d{1,12})?$"}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":6,"default":4}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"band_min":{"type":"string","description":"Band lower price (decimal string; may carry extra trailing zeros)"},"band_max":{"type":"string","description":"Band upper price (decimal string; may carry extra trailing zeros)"},"long_size":{"type":"string","description":"Long size (base) whose liquidation price is in the band, at the bar's last snapshot (decimal string; may carry extra trailing zeros)"},"short_size":{"type":"string","description":"Short size (base) whose liquidation price is in the band, at the bar's last snapshot (decimal string; may carry extra trailing zeros)"},"positions":{"type":"integer","description":"Positions in the band at the bar's last snapshot"},"mark_px":{"type":"string","description":"Current mark (sets the band width) (decimal string; may carry extra trailing zeros)"},"band_size":{"type":"string","description":"Band width (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/liquidation-heatmap?interval=1h'"}]}},"/v1/markets/{coin}/stop-heatmap":{"get":{"operationId":"getStopHeatmap","summary":"Stop-order heatmap of one market","description":"Per bar and price band: buy and sell size of resting stop / take-profit triggers in the band, from the hourly stop-order snapshots. A 1h bar is its hour's snapshot; a 4h or 1d bar is the last complete hourly snapshot inside it (its close), never a sum over the bar's hours. Stop orders worth under 100 USD at their trigger price (|size| × trigger price) are not in the snapshot (meta.min_notional_usd); the live routes /stop-levels and /stop-orders have no floor. Rows are netted (wallet, trigger price) levels. `limit` bars per page; page with the cursor.\n\nPricing: base + per cell. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1h","4h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Bars per page.","schema":{"type":"integer","minimum":1,"maximum":6,"default":4}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 24 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"band_min":{"type":"string","description":"Band lower price (decimal string; may carry extra trailing zeros)"},"band_max":{"type":"string","description":"Band upper price (decimal string; may carry extra trailing zeros)"},"buy_size":{"type":"string","description":"Buy trigger size in the band at the bar's last snapshot (decimal string; may carry extra trailing zeros)"},"sell_size":{"type":"string","description":"Sell trigger size in the band at the bar's last snapshot (decimal string; may carry extra trailing zeros)"},"orders":{"type":"integer","description":"Trigger levels (wallet, price) in the band at the bar's last snapshot"},"mark_px":{"type":"string","description":"Current mark (sets the band width) (decimal string; may carry extra trailing zeros)"},"band_size":{"type":"string","description":"Band width (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/stop-heatmap?interval=1h'"}]}},"/v1/markets/{coin}/liquidation-levels/totals":{"get":{"operationId":"getLiquidationLevelTotals","summary":"Liquidation-level totals of one market","description":"Total long and short size with a liquidation price, and the number of positions, at the latest hourly liquidation snapshot. Positions worth 100 USD or less at their liquidation price (|size| × liquidation price) are not in the snapshot (meta.min_notional_usd); the live ladder /liquidation-levels has no floor. Position counts are therefore well below the live ladder's, while sizes differ little.\n\nPricing: flat. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"long_size":{"type":"string","description":"Long size (decimal string; may carry extra trailing zeros)"},"long_positions":{"type":"integer","description":"Long positions"},"short_size":{"type":"string","description":"Short size (decimal string; may carry extra trailing zeros)"},"short_positions":{"type":"integer","description":"Short positions"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/liquidation-levels/totals'"}]}},"/v1/markets/{coin}/stop-levels/totals":{"get":{"operationId":"getStopLevelTotals","summary":"Stop-order totals of one market","description":"Total buy and sell stop-trigger size and order counts at the latest hourly stop-order snapshot. Stop orders worth under 100 USD at their trigger price (|size| × trigger price) are not in the snapshot (meta.min_notional_usd); the live routes /stop-levels and /stop-orders have no floor. Counts are therefore below the live routes' (and size too where many small triggers rest), and count netted (wallet, trigger price) levels.\n\nPricing: flat. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"buy_size":{"type":"string","description":"Buy trigger size (decimal string; may carry extra trailing zeros)"},"buy_orders":{"type":"integer","description":"Buy trigger levels (wallet, price)"},"sell_size":{"type":"string","description":"Sell trigger size (decimal string; may carry extra trailing zeros)"},"sell_orders":{"type":"integer","description":"Sell trigger levels (wallet, price)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/stop-levels/totals'"}]}},"/v1/markets/stop-summary":{"get":{"operationId":"getStopSummary","summary":"Stop-loss / take-profit density, every market","description":"Per market, from the latest complete hourly stop-order snapshot: stop-loss and take-profit trigger notional in total and within ±5 % of the mark, split by the side they protect, and the largest level. Every notional is valued at the trigger's own price (|size| × trigger price, as on /stop-levels), not at the mark, so a few take-profits or stops set far from the mark (e.g. 1,000× it) can dominate stop_notional, tp_notional, total_notional and largest_level; the *_band fields count only triggers within ±5 % of the mark (where trigger and mark values are close) and set the order. Stop orders worth under 100 USD at their trigger price (|size| × trigger price) are not in the snapshot (meta.min_notional_usd); the live routes /stop-levels and /stop-orders have no floor. Levels are netted (wallet, trigger price). Sorted by notional near the mark. Cached up to 5 min.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"},"mark_px":{"type":["string","null"],"description":"Mark used to classify triggers (decimal string; may carry extra trailing zeros)"},"mark_time":{"type":"integer","description":"Mark time, epoch ms"},"stop_notional":{"type":"string","description":"Stop-loss notional at trigger prices (USD) (decimal string; may carry extra trailing zeros)"},"tp_notional":{"type":"string","description":"Take-profit notional at trigger prices (USD) (decimal string; may carry extra trailing zeros)"},"stop_notional_band":{"type":"string","description":"Stop-loss notional within ±5 % (decimal string; may carry extra trailing zeros)"},"tp_notional_band":{"type":"string","description":"Take-profit notional within ±5 % (decimal string; may carry extra trailing zeros)"},"long_sl_band":{"type":"string","description":"Longs' stop-losses within ±5 % (decimal string; may carry extra trailing zeros)"},"short_sl_band":{"type":"string","description":"Shorts' stop-losses within ±5 % (decimal string; may carry extra trailing zeros)"},"long_tp_band":{"type":"string","description":"Longs' take-profits within ±5 % (decimal string; may carry extra trailing zeros)"},"short_tp_band":{"type":"string","description":"Shorts' take-profits within ±5 % (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":"string","description":"All trigger notional at trigger prices (USD) (decimal string; may carry extra trailing zeros)"},"stop_levels":{"type":"integer","description":"Stop-loss levels"},"tp_levels":{"type":"integer","description":"Take-profit levels"},"largest_level":{"type":"string","description":"Largest level notional at its trigger price (USD) (decimal string; may carry extra trailing zeros)"},"largest_level_px":{"type":"string","description":"Largest level's trigger price (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/stop-summary'"}]}},"/v1/liquidations/by-market":{"get":{"operationId":"getLiquidationTotalsByMarket","summary":"Realized liquidations per market","description":"Per market over [start_time, end_time): liquidation events and notional (long/short), realized PnL, backstop events, largest liquidation and liquidated accounts, gross and excluding the system backstop account (trader_*). Top `limit` markets by notional. Range ≤ 30 days.\n\nPricing: base × range tier. Scope: `liquidations:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"liquidations:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Markets (largest first).","schema":{"type":"integer","minimum":1,"maximum":500,"default":200}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 24 h; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"events":{"type":"integer","description":"Liquidation fills"},"total_notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"long_notional":{"type":"string","description":"Longs liquidated (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Shorts liquidated (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":"string","description":"Realized PnL of liquidated positions (decimal string; may carry extra trailing zeros)"},"backstop_events":{"type":"integer","description":"Backstop liquidations"},"largest_notional":{"type":"string","description":"Largest liquidation (decimal string; may carry extra trailing zeros)"},"accounts":{"type":"integer","description":"Liquidated accounts (per market; not summable)"},"trader_events":{"type":"integer","description":"Events excluding the system backstop account"},"trader_notional":{"type":"string","description":"Notional excluding the system account (decimal string; may carry extra trailing zeros)"},"trader_long_notional":{"type":"string","description":"Longs, excluding the system account (decimal string; may carry extra trailing zeros)"},"trader_short_notional":{"type":"string","description":"Shorts, excluding the system account (decimal string; may carry extra trailing zeros)"},"trader_largest_notional":{"type":["string","null"],"description":"Largest, excluding the system account (decimal string; may carry extra trailing zeros)"},"trader_accounts":{"type":"integer","description":"Accounts excluding the system account"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations/by-market'"}]}},"/v1/liquidations/cascades":{"get":{"operationId":"getLiquidationCascades","summary":"Largest liquidation days","description":"The `limit` UTC days with the most liquidated notional in [start_time, end_time): lead market, peak minute and long/short split.\n\nPricing: base + per row, × range tier (≤30 d ×1, ≤90 d ×4, ≤365 d ×9). Scope: `liquidations:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"liquidations:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Days (largest first).","schema":{"type":"integer","minimum":1,"maximum":100,"default":10}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 90 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer","description":"UTC day, epoch ms"},"lead_coin":{"type":"string","description":"Market with the most liquidated notional that day"},"peak_minute":{"type":["integer","null"],"description":"Peak minute, epoch ms"},"peak_minute_notional":{"type":["string","null"],"description":"Notional in the peak minute (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Liquidated notional (USD) (decimal string; may carry extra trailing zeros)"},"long_notional":{"type":"string","description":"Longs liquidated (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Shorts liquidated (decimal string; may carry extra trailing zeros)"},"events":{"type":"integer","description":"Liquidation fills"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations/cascades?limit=10'"}]}},"/v1/cohorts/consensus":{"get":{"operationId":"getTopTraderConsensus","summary":"Top-trader consensus per market","description":"Among Hyperdash's curated tape cohort (GET /v1/traders/cohort: wallets with ≥ $100k perp PnL over the last 30 days and a fill in the last 7 days, ≈600; wallets tagged `algo`, HLP and four of its child vaults, two system addresses, three hedged-fund wallets and one HIP-3 market maker left out; labelled market makers with another style tag stay in; core exchange and xyz markets): how many are long and short each market and their notional — every market where a cohort trader holds a position (≈300), most cohort traders first, up to 500 (meta.truncated = true when that cap was reached). From the positions snapshot before the latest (up to ~24 min old); cached up to 5 min. This is not the Smart Money Bias widget on hyperdash.com: that one is the all-time-PnL cohorts extremely_profitable + very_profitable of GET /v1/cohorts/positioning?cohort_type=pnl.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"long_traders":{"type":"integer","description":"Cohort traders long"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"short_traders":{"type":"integer","description":"Cohort traders short"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"traders":{"type":"integer","description":"Cohort traders positioned"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/consensus'"}]}},"/v1/cohorts/opens":{"get":{"operationId":"getTopTraderOpens","summary":"Top-trader opens per market","description":"Cohort traders (GET /v1/cohorts/consensus's cohort) who opened or flipped into a long or short in the last `minutes`, and the opened notional, per market: every market with an opening cohort trader, up to 500 (meta.truncated = true when that cap was reached). Cached up to 5 min.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"minutes","in":"query","required":false,"description":"Look-back.","schema":{"type":"string","default":"60","enum":["60","240","1440"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"long_traders":{"type":"integer","description":"Traders opening long"},"short_traders":{"type":"integer","description":"Traders opening short"},"traders":{"type":"integer","description":"Traders opening"},"notional":{"type":"string","description":"Opened notional (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/opens?minutes=240'"}]}},"/v1/markets/net-positioning":{"get":{"operationId":"getNetPositioningByMarket","summary":"Net trader positioning per market","description":"Long, short and net notional and position counts per market at the latest complete snapshot, vaults excluded. Top 500 markets by open notional. Cached up to 5 min.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"net_notional":{"type":"string","description":"Long − short (decimal string; may carry extra trailing zeros)"},"long_positions":{"type":"integer","description":"Long positions"},"short_positions":{"type":"integer","description":"Short positions"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/net-positioning'"}]}},"/v1/markets/net-positioning/summary":{"get":{"operationId":"getNetPositioningSummary","summary":"Net trader positioning, whole exchange","description":"Total long, short and net notional and the number of accounts with a position, vaults excluded. Cached up to 5 min.\n\nPricing: flat. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"net_notional":{"type":"string","description":"Long − short (decimal string; may carry extra trailing zeros)"},"accounts":{"type":"integer","description":"Accounts with a position"},"snapshot_time":{"type":["integer","null"],"description":"Snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/net-positioning/summary'"}]}},"/v1/cohorts/positioning":{"get":{"operationId":"getCohortPositioning","summary":"Hourly positioning by trader cohort","description":"Per UTC hour and Hyperdash trader cohort — account-size cohorts (`size`: small, medium, large, whale, apex; before 2026-02-07 19:00 UTC: shrimp, fish, large_fish, dolphin, shark, whale, large_whale, kraken) and all-time-PnL cohorts (`pnl`: rekt, very_unprofitable, unprofitable, profitable, very_profitable, extremely_profitable; slightly_profitable / slightly_unprofitable until 2026-02-07) — across all markets (omit `coin`) or in one market: long and short notional and, where recorded, the number of distinct wallets on each side. Notional from 2026-01-24; wallet counts from 2026-10-26 11:00 UTC (null before). Within an hour, counts and notional always come from the same sample (the hour's first). `limit` rows per page; window ≤ 30 days. hyperdash.com's Smart Money Bias = `cohort_type=pnl`, cohorts extremely_profitable + very_profitable.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all markets combined).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"cohort_type","in":"query","required":false,"description":"Cohort family.","schema":{"type":"string","default":"all","enum":["all","size","pnl"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 7 days; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"coin":{"type":"string","description":"Market, or `all` for all markets combined"},"cohort_type":{"type":"string","description":"size or pnl"},"cohort":{"type":"string","description":"Cohort id"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"long_traders":{"type":["integer","null"],"description":"Distinct wallets long (null before counts exist)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"short_traders":{"type":["integer","null"],"description":"Distinct wallets short (null before counts exist)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/positioning?coin=BTC&cohort_type=size'"}]}},"/v1/cohorts/positioning/markets":{"get":{"operationId":"getCohortPositioningMarkets","summary":"Cohort positioning of every market at one hour","description":"Every market's long and short notional per trader cohort (size and PnL families) at one UTC hour — the latest complete hour by default — with distinct wallets per side where recorded (from 2026-10-26 11:00 UTC).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"time","in":"query","required":false,"description":"Hour (epoch ms, rounded down to the hour). Default: the latest complete hour.","schema":{"type":"integer"}},{"name":"cohort_type","in":"query","required":false,"description":"Cohort family.","schema":{"type":"string","default":"all","enum":["all","size","pnl"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"coin":{"type":"string","description":"Market"},"cohort_type":{"type":"string","description":"size or pnl"},"cohort":{"type":"string","description":"Cohort id"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"long_traders":{"type":["integer","null"],"description":"Distinct wallets long (null before counts exist)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"short_traders":{"type":["integer","null"],"description":"Distinct wallets short (null before counts exist)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/positioning/markets?cohort_type=size'"}]}},"/v1/markets/{coin}/position-counts":{"get":{"operationId":"getPositionCounts","summary":"Position counts of one market","description":"Number of long and short positions and their notional at the latest complete snapshot.\n\nPricing: flat. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"long_positions":{"type":"integer","description":"Long positions"},"short_positions":{"type":"integer","description":"Short positions"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/position-counts'"}]}},"/v1/markets/participation":{"get":{"operationId":"getMarketParticipation","summary":"Holders, longs / shorts and profitable / losing per market","description":"Per perp market (every market in one call, or one): positions open, longs, shorts, profitable and losing positions (unrealized PnL > 0 / < 0), long and short notional and the summed unrealized PnL. Deduplicated per (market, wallet). From one perp-positions snapshot (about every 12 min, the second newest of the last 3 h); a snapshot under 85 % of the previous one's positions, or one without a previous snapshot to compare, is refused as unavailable (retry shortly). Empty when no snapshot landed in 3 h. No wallets.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"market":{"type":"string","description":"Market"},"positions":{"type":"integer","description":"Open positions"},"longs":{"type":"integer","description":"Long positions"},"shorts":{"type":"integer","description":"Short positions"},"profitable":{"type":"integer","description":"Positions with unrealized PnL > 0"},"losing":{"type":"integer","description":"Positions with unrealized PnL < 0"},"long_notional":{"type":"string","description":"Long notional (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Short notional (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Summed unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Positions snapshot used (epoch ms)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/participation'"}]}},"/v1/cohorts/totals":{"get":{"operationId":"getCohortTotals","summary":"Per account-size cohort: wallets, account value, uPnL, profitable / losing","description":"Per account-size cohort (small < $10K, medium $10K–100K, large $100K–1M, whale $1M–5M, apex ≥ $5M; account value = perp + spot): wallets, total account value (newest complete hourly equity snapshot), wallets with an open perp position, their summed unrealized PnL and how many are profitable / losing (a wallet's uPnL summed over its positions, counted once). The position metrics come from one perp-positions snapshot; when it is missing or under 85 % of the previous one, they are null and `positions_complete` is false (the account totals stay valid). No wallets.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"cohort":{"type":"string","description":"Cohort"},"wallets":{"type":"integer","description":"Accounts in the cohort"},"account_value":{"type":"string","description":"Total account value (USD) (decimal string; may carry extra trailing zeros)"},"wallets_with_positions":{"type":["integer","null"],"description":"Accounts with an open perp position"},"unrealized_pnl":{"type":["string","null"],"description":"Their summed unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"profitable_wallets":{"type":["integer","null"],"description":"Accounts with uPnL > 0"},"losing_wallets":{"type":["integer","null"],"description":"Accounts with uPnL < 0"},"equity_snapshot_time":{"type":"integer","description":"Equity snapshot used, epoch ms"},"positions_snapshot_time":{"type":["integer","null"],"description":"Positions snapshot used, epoch ms"},"positions_complete":{"type":"boolean","description":"The position metrics passed the snapshot check"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/totals'"}]}},"/v1/markets/{coin}/cvd":{"get":{"operationId":"getCvd","summary":"Cumulative volume delta of one market","description":"Taker buy and sell notional per bucket and the running delta over the look-back. Hyperliquid's daily spot dust conversion (every UTC day at 00:00, a sell of small spot balances with no buyer) is not a trade, as on Hyperliquid's candles: its sell is left out (older 00:00 UTC buckets of spot markets may still include it).\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,200 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["1h","1d"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days (≤ 90).","schema":{"type":"integer","minimum":1,"maximum":90,"default":7}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"buy_notional":{"type":"string","description":"Taker buy notional (USD) (decimal string; may carry extra trailing zeros)"},"sell_notional":{"type":"string","description":"Taker sell notional (USD) (decimal string; may carry extra trailing zeros)"},"delta":{"type":"string","description":"Buy − sell (decimal string; may carry extra trailing zeros)"},"cvd":{"type":"string","description":"Cumulative delta since the window start (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/cvd?interval=1h&days=7'"}]}},"/v1/markets/funding/latest":{"get":{"operationId":"getFundingScreener","summary":"Funding screener","description":"Latest funding rate and APR of every market with mark, open interest and 24 h volume, ranked. Markets under `min_open_interest_usd` of open interest are left out (default $1M, as on hyperdash.com; 0 = every market).\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"sort","in":"query","required":false,"description":"Ranking.","schema":{"type":"string","default":"highest","enum":["highest","lowest","abs"]}},{"name":"min_open_interest_usd","in":"query","required":false,"description":"Minimum open interest (USD): 0 (any), 1000000 or 10000000.","schema":{"type":"string","default":"1000000","enum":["0","1000000","10000000"]}},{"name":"limit","in":"query","required":false,"description":"Markets per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"funding_rate":{"type":"string","description":"Hourly funding rate (decimal string; may carry extra trailing zeros)"},"funding_apr_pct":{"type":"string","description":"Annualized (%) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":"string","description":"Mark (decimal string; may carry extra trailing zeros)"},"open_interest_usd":{"type":"string","description":"Open interest (USD) (decimal string; may carry extra trailing zeros)"},"day_volume":{"type":"string","description":"24 h volume (USD) (decimal string; may carry extra trailing zeros)"},"time":{"type":"integer","description":"Context time, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/funding/latest?sort=abs'"}]}},"/v1/markets/funding/matrix":{"get":{"operationId":"getFundingMatrix","summary":"Funding matrix","description":"Settled funding rate and APR per market and bucket: one market, or the `top` markets by open interest. Each hourly cell is the rate settled at that hour (`t` = the settlement time, as GET /v1/markets/{coin}/funding-rates and Hyperliquid's funding history); a daily cell averages the day's hourly settled rates. An hour with no settlement (no open position) has no cell. Hourly ≤ 7 days, daily ≤ 90 days.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all), matched ignoring case; if two markets differ only by case, only one comes back: the exact spelling when it has rows, else the other.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"top","in":"query","required":false,"description":"Markets by open interest when no market is given.","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["1h","1d"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days: ≤ 7 hourly, ≤ 90 daily. Default: 7 hourly, 7 daily.","schema":{"type":"integer","minimum":1,"maximum":90}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"t":{"type":"integer","description":"Bar start, epoch ms"},"funding_rate":{"type":"string","description":"Settled hourly funding rate (daily = average of the day's settled hourly rates) (decimal string; may carry extra trailing zeros)"},"funding_apr_pct":{"type":"string","description":"Annualized (%) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/funding/matrix?top=20&interval=1d&days=30'"}]}},"/v1/markets/open-interest/changes":{"get":{"operationId":"getOpenInterestChanges","summary":"Open interest changes, every market","description":"Open interest (USD) of every market now and 24 h, 7 days and 30 days ago.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"},"oi_usd":{"type":"string","description":"Open interest now (USD) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":"string","description":"Mark (decimal string; may carry extra trailing zeros)"},"oi_usd_24h":{"type":["string","null"],"description":"24 h ago (decimal string; may carry extra trailing zeros)"},"oi_usd_7d":{"type":["string","null"],"description":"7 days ago (decimal string; may carry extra trailing zeros)"},"oi_usd_30d":{"type":["string","null"],"description":"30 days ago (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/open-interest/changes'"}]}},"/v1/markets/{coin}/open-interest/daily":{"get":{"operationId":"getOpenInterestDaily","summary":"Daily open interest (USD) of one market","description":"Open interest in USD (open interest × mark) and the mark at each UTC day's last hourly snapshot, for the days starting in [start_time, end_time) (≤ 365 days; from 2025-08-26 or the market's listing). Per-minute OI in coin units: GET /v1/markets/{coin}/open-interest.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 400 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 90 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer","description":"UTC day, epoch ms"},"oi_usd":{"type":"string","description":"Open interest (USD) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":"string","description":"Mark at the snapshot (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/open-interest/daily'"}]}},"/v1/markets/open-interest/by-category":{"get":{"operationId":"getOpenInterestByCategory","summary":"Open interest by asset category","description":"Open interest (USD) and market count per asset category per bucket. Hourly ≤ 7 days, daily ≤ 90 days. Categories are GET /v1/markets/catalog's; a market without a catalog row (listed after the catalog's last sync, see its `updated_at`) is counted in its own `unmapped` row, never guessed into another category.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days: ≤ 7 hourly, ≤ 90 daily. Default: 7 hourly, 30 daily.","schema":{"type":"integer","minimum":1,"maximum":90}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"category":{"type":"string","description":"Asset category: btc, eth_majors, hype, memes, equities, indices, commodities, fx, other, or unmapped (markets not in the catalog yet)"},"open_interest_usd":{"type":"string","description":"Open interest (USD) (decimal string; may carry extra trailing zeros)"},"markets":{"type":"integer","description":"Markets"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/open-interest/by-category'"}]}},"/v1/markets/open-interest/by-dex":{"get":{"operationId":"getOpenInterestByDex","summary":"Open interest by dex","description":"Open interest (USD) and market count of the core exchange and each HIP-3 dex per bucket. Hourly ≤ 7 days, daily ≤ 90 days.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days: ≤ 7 hourly, ≤ 90 daily. Default: 7 hourly, 30 daily.","schema":{"type":"integer","minimum":1,"maximum":90}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"dex":{"type":"string","description":"Dex (core or a HIP-3 dex)"},"open_interest_usd":{"type":"string","description":"Open interest (USD) (decimal string; may carry extra trailing zeros)"},"markets":{"type":"integer","description":"Markets"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/open-interest/by-dex'"}]}},"/v1/markets/open-interest/total":{"get":{"operationId":"getOpenInterestTotal","summary":"Open interest in USD over time","description":"Open interest (USD) per bucket of one market or of the whole exchange. Hourly ≤ 30 days, daily ≤ 90 days.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all), matched ignoring case; if two markets differ only by case, only one comes back: the exact spelling when it has rows, else the other.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days: ≤ 30 hourly, ≤ 90 daily. Default: 30 hourly, 90 daily.","schema":{"type":"integer","minimum":1,"maximum":90}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"open_interest_usd":{"type":"string","description":"Open interest (USD) (decimal string; may carry extra trailing zeros)"},"markets":{"type":"integer","description":"Markets counted"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/open-interest/total?interval=1d'"}]}},"/v1/markets/price-changes":{"get":{"operationId":"getPriceChanges","summary":"Price changes, every market","description":"Every market's price now with its 24 h, 7 day and 30 day changes, as the hyperdash.com price heatmap: `price` is the live mid (`price_source` mid), or the latest hourly snapshot mark when the market has no live mid (`mark`); changes are computed from `price`. The 24 h reference is Hyperliquid's previous-day price from the latest snapshot; the 7 and 30 day references are the hourly snapshot marks at or before then. Markets without a snapshot in the last 3 hours are left out.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market (builder-dex markets keep their prefix, e.g. xyz:MU)"},"price":{"type":"string","description":"Price now: live mid, else the latest snapshot mark (decimal string; may carry extra trailing zeros)"},"price_source":{"type":"string","description":"mid or mark"},"change_24h_pct":{"type":["string","null"],"description":"Change vs 24 h ago (%) (decimal string; may carry extra trailing zeros)"},"change_7d_pct":{"type":["string","null"],"description":"Change vs 7 days ago (%) (decimal string; may carry extra trailing zeros)"},"change_30d_pct":{"type":["string","null"],"description":"Change vs 30 days ago (%) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":"string","description":"Latest hourly snapshot mark (decimal string; may carry extra trailing zeros)"},"px_24h":{"type":"string","description":"Price 24 h ago (decimal string; may carry extra trailing zeros)"},"px_7d":{"type":["string","null"],"description":"Price 7 days ago (decimal string; may carry extra trailing zeros)"},"px_30d":{"type":["string","null"],"description":"Price 30 days ago (decimal string; may carry extra trailing zeros)"},"day_volume":{"type":"string","description":"24 h volume (USD) (decimal string; may carry extra trailing zeros)"},"open_interest":{"type":"string","description":"Open interest (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/price-changes'"}]}},"/v1/markets/returns":{"get":{"operationId":"getReturnsMatrix","summary":"Returns matrix","description":"Mark now and 1 h, 4 h, 1 day, 7 days and 30 days ago for every market with a mark in the last 3 hours, in one answer (returns = now / then − 1).\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"px_now":{"type":["string","null"],"description":"Mark now (decimal string; may carry extra trailing zeros)"},"px_1h":{"type":["string","null"],"description":"1 h ago (decimal string; may carry extra trailing zeros)"},"px_4h":{"type":["string","null"],"description":"4 h ago (decimal string; may carry extra trailing zeros)"},"px_1d":{"type":["string","null"],"description":"1 day ago (decimal string; may carry extra trailing zeros)"},"px_7d":{"type":["string","null"],"description":"7 days ago (decimal string; may carry extra trailing zeros)"},"px_30d":{"type":["string","null"],"description":"30 days ago (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/returns'"}]}},"/v1/markets/beta":{"get":{"operationId":"getMarketBeta","summary":"Beta and correlation to BTC","description":"Beta and correlation of every market's hourly returns to BTC over 30, 60 or 90 days.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 5,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"days","in":"query","required":false,"description":"Window in days.","schema":{"type":"string","default":"30","enum":["30","60","90"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"beta":{"type":"string","description":"Beta to BTC (decimal string; may carry extra trailing zeros)"},"correlation":{"type":"string","description":"Correlation to BTC (decimal string; may carry extra trailing zeros)"},"hours":{"type":"integer","description":"Hourly returns used"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/beta?days=90'"}]}},"/v1/markets/session-returns":{"get":{"operationId":"getSessionReturns","summary":"Returns by trading session","description":"Cumulative return per market in the Asia, Europe and US UTC sessions over the look-back.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 3 rows when `market` is given (one market's rows, whatever the other parameters), and at its cap of 1,500 rows when no `market` is given (every market: their number is not known before the request runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all), matched ignoring case; if two markets differ only by case, only one comes back: the exact spelling when it has rows, else the other.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"days","in":"query","required":false,"description":"Look-back in days (≤ 90).","schema":{"type":"integer","minimum":1,"maximum":90,"default":30}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"session":{"type":"string","description":"asia, europe or us"},"return_pct":{"type":"string","description":"Cumulative return (%) (decimal string; may carry extra trailing zeros)"},"hours":{"type":"integer","description":"Hours counted"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/session-returns?days=30'"}]}},"/v1/markets/twap-pressure":{"get":{"operationId":"getTwapPressure","summary":"Net TWAP pressure per market","description":"FILLED TWAP flow per market over the last `minutes`: TWAP buy and sell fill notional, net, and the number of TWAPs and fills, for every market or one. Executed fills only: hyperdash.com's Net TWAP Pressure table ranks the TWAPs running now (their remaining size per market): GET /v1/markets/twap-pressure/active; per wallet for one core market: GET /v1/markets/{coin}/twaps.\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market, e.g. BTC, xyz:TSLA (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"minutes","in":"query","required":false,"description":"Look-back in minutes (≤ 1 day).","schema":{"type":"integer","minimum":1,"maximum":1440,"default":60}},{"name":"limit","in":"query","required":false,"description":"Markets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"buy_notional":{"type":"string","description":"TWAP buy notional (USD) (decimal string; may carry extra trailing zeros)"},"sell_notional":{"type":"string","description":"TWAP sell notional (USD) (decimal string; may carry extra trailing zeros)"},"net_notional":{"type":"string","description":"Buy − sell (decimal string; may carry extra trailing zeros)"},"twaps":{"type":"integer","description":"TWAPs"},"fills":{"type":"integer","description":"TWAP fills"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/twap-pressure?minutes=240'"}]}},"/v1/markets/{coin}/sentiment":{"get":{"operationId":"getSentiment","summary":"Sentiment regime inputs of one market","description":"Per bucket: log return, taker CVD and volume, realized volatility, funding (APR %), open-interest change, liquidations, and each input's z-score against the 30 days before the bucket. Complete buckets only, scored when at least 95 % of the prior month's buckets are complete. `limit` buckets per page.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["1h","4h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":168}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"close":{"type":["string","null"],"description":"Close (decimal string; may carry extra trailing zeros)"},"ret":{"type":"string","description":"Log return (decimal string; may carry extra trailing zeros)"},"cvd":{"type":"string","description":"Taker CVD (USD) (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Taker volume (USD) (decimal string; may carry extra trailing zeros)"},"rv":{"type":"string","description":"Realized volatility (annualized %) (decimal string; may carry extra trailing zeros)"},"funding":{"type":["string","null"],"description":"Funding APR (%) (decimal string; may carry extra trailing zeros)"},"funding_start":{"type":["string","null"],"description":"Funding APR at the bucket start (decimal string; may carry extra trailing zeros)"},"funding_end":{"type":["string","null"],"description":"Funding APR at the bucket end (decimal string; may carry extra trailing zeros)"},"funding_base":{"type":["string","null"],"description":"Lowest end-of-bucket funding over the prior day (decimal string; may carry extra trailing zeros)"},"oi_usd":{"type":["string","null"],"description":"Open interest at the end (USD) (decimal string; may carry extra trailing zeros)"},"oi_change_pct":{"type":["string","null"],"description":"Open interest change (%) (decimal string; may carry extra trailing zeros)"},"rv_change":{"type":["string","null"],"description":"Volatility change (decimal string; may carry extra trailing zeros)"},"liq_long":{"type":"string","description":"Longs liquidated (USD) (decimal string; may carry extra trailing zeros)"},"liq_short":{"type":"string","description":"Shorts liquidated (USD) (decimal string; may carry extra trailing zeros)"},"liq_long_next":{"type":["string","null"],"description":"Longs liquidated in the next bucket (decimal string; may carry extra trailing zeros)"},"liq_short_next":{"type":["string","null"],"description":"Shorts liquidated in the next bucket (decimal string; may carry extra trailing zeros)"},"z_ret":{"type":["string","null"],"description":"Return z-score (decimal string; may carry extra trailing zeros)"},"z_cvd":{"type":["string","null"],"description":"CVD z-score (decimal string; may carry extra trailing zeros)"},"z_funding":{"type":["string","null"],"description":"Funding z-score (decimal string; may carry extra trailing zeros)"},"z_oi":{"type":["string","null"],"description":"OI change z-score (decimal string; may carry extra trailing zeros)"},"z_vol":{"type":["string","null"],"description":"Volatility z-score (decimal string; may carry extra trailing zeros)"},"z_funding_base":{"type":["string","null"],"description":"Funding base z-score (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/sentiment?interval=4h'"}]}},"/v1/markets/{coin}/sentiment/events":{"get":{"operationId":"getSentimentEvents","summary":"Unusual taker-flow hours of one market","description":"Whole hourly buckets inside [start_time, end_time) (≤ 30 days) whose taker CVD was unusual — |z_cvd| ≥ 2 against the 30 days before — with every sentiment input and z-score (same fields as GET /v1/markets/{coin}/sentiment).\n\nPricing: base + per bucket. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 7 days; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"close":{"type":["string","null"],"description":"Close (decimal string; may carry extra trailing zeros)"},"ret":{"type":"string","description":"Log return (decimal string; may carry extra trailing zeros)"},"cvd":{"type":"string","description":"Taker CVD (USD) (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Taker volume (USD) (decimal string; may carry extra trailing zeros)"},"rv":{"type":"string","description":"Realized volatility (annualized %) (decimal string; may carry extra trailing zeros)"},"funding":{"type":["string","null"],"description":"Funding APR (%) (decimal string; may carry extra trailing zeros)"},"funding_start":{"type":["string","null"],"description":"Funding APR at the bucket start (decimal string; may carry extra trailing zeros)"},"funding_end":{"type":["string","null"],"description":"Funding APR at the bucket end (decimal string; may carry extra trailing zeros)"},"funding_base":{"type":["string","null"],"description":"Lowest end-of-bucket funding over the prior day (decimal string; may carry extra trailing zeros)"},"oi_usd":{"type":["string","null"],"description":"Open interest at the end (USD) (decimal string; may carry extra trailing zeros)"},"oi_change_pct":{"type":["string","null"],"description":"Open interest change (%) (decimal string; may carry extra trailing zeros)"},"rv_change":{"type":["string","null"],"description":"Volatility change (decimal string; may carry extra trailing zeros)"},"liq_long":{"type":"string","description":"Longs liquidated (USD) (decimal string; may carry extra trailing zeros)"},"liq_short":{"type":"string","description":"Shorts liquidated (USD) (decimal string; may carry extra trailing zeros)"},"liq_long_next":{"type":["string","null"],"description":"Longs liquidated in the next bucket (decimal string; may carry extra trailing zeros)"},"liq_short_next":{"type":["string","null"],"description":"Shorts liquidated in the next bucket (decimal string; may carry extra trailing zeros)"},"z_ret":{"type":["string","null"],"description":"Return z-score (decimal string; may carry extra trailing zeros)"},"z_cvd":{"type":["string","null"],"description":"CVD z-score (decimal string; may carry extra trailing zeros)"},"z_funding":{"type":["string","null"],"description":"Funding z-score (decimal string; may carry extra trailing zeros)"},"z_oi":{"type":["string","null"],"description":"OI change z-score (decimal string; may carry extra trailing zeros)"},"z_vol":{"type":["string","null"],"description":"Volatility z-score (decimal string; may carry extra trailing zeros)"},"z_funding_base":{"type":["string","null"],"description":"Funding base z-score (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/sentiment/events'"}]}},"/v1/markets/sentiment/scanner":{"get":{"operationId":"getSentimentScanner","summary":"Sentiment scanner across markets","description":"One row per market (or, with view=index, one open-interest-weighted index over the selected markets): the z-scores of its latest scored bucket inside [start_time, end_time) — each against the 30 days before that bucket; a bucket is scored only with ≥ 95 % of that month behind it — plus window aggregates over its scored buckets: summed taker CVD and volume, RMS realized volatility (annualized %), price and open-interest change (ratios: 0.05 = +5 %), the latest bucket's funding change and end-of-bucket funding (APR %) and log return. Each row's `t` is that market's latest scored bucket (markets can differ); a z-score is null where it could not be computed. Whole buckets only (the start rounds up, the end down); the window is ≤ 7 days at 1h and ≤ 30 days at 4h / 1d. asset_class uses the sentiment classes: majors (BTC ETH SOL HYPE XRP BNB DOGE), alts (other main-dex markets), xyz (trade.xyz), dex:<name> (other builder dexes). Index rows have no price, so px_change is null.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["1h","4h","1d"]}},{"name":"view","in":"query","required":false,"description":"markets: one row per market; index: one row, the open-interest-weighted index over the selected markets (all, or one asset_class).","schema":{"type":"string","default":"markets","enum":["markets","index"]}},{"name":"asset_class","in":"query","required":false,"description":"Only this sentiment class (the index's class with view=index).","schema":{"type":"string","pattern":"^(majors|alts|xyz|dex:[a-z0-9]{1,20})$"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated markets, up to 50 (view=markets only).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}(,[A-Za-z0-9:_\\-/@.]{1,40}){0,49}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 7 days; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"market":{"type":"string","description":"Market, or the index label (all or the asset_class)"},"t":{"type":"integer","description":"Bar start, epoch ms"},"z_ret":{"type":["string","null"],"description":"Return z-score (decimal string; may carry extra trailing zeros)"},"z_cvd":{"type":["string","null"],"description":"Taker CVD z-score (decimal string; may carry extra trailing zeros)"},"z_funding":{"type":["string","null"],"description":"Funding z-score (decimal string; may carry extra trailing zeros)"},"z_oi":{"type":["string","null"],"description":"Open-interest change z-score (decimal string; may carry extra trailing zeros)"},"z_vol":{"type":["string","null"],"description":"Realized-volatility z-score (decimal string; may carry extra trailing zeros)"},"z_funding_base":{"type":["string","null"],"description":"Funding vs base z-score (decimal string; may carry extra trailing zeros)"},"funding_change":{"type":["string","null"],"description":"The latest bucket's funding change (APR %) (decimal string; may carry extra trailing zeros)"},"funding_end":{"type":["string","null"],"description":"Funding at the latest bucket's end (APR %) (decimal string; may carry extra trailing zeros)"},"cvd":{"type":["string","null"],"description":"Taker CVD summed over the window's scored buckets (USD) (decimal string; may carry extra trailing zeros)"},"volume":{"type":["string","null"],"description":"Taker volume summed (USD) (decimal string; may carry extra trailing zeros)"},"rv":{"type":["string","null"],"description":"RMS realized volatility (annualized %) (decimal string; may carry extra trailing zeros)"},"px_change":{"type":["string","null"],"description":"Price change over the window (ratio; null for an index) (decimal string; may carry extra trailing zeros)"},"oi_change":{"type":["string","null"],"description":"Open-interest change over the window (ratio) (decimal string; may carry extra trailing zeros)"},"last_return":{"type":["string","null"],"description":"The latest bucket's log return (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/sentiment/scanner?interval=4h'"}]}},"/v1/markets/{coin}/event-moves":{"get":{"operationId":"getEventMoves","summary":"Price reaction around given times","description":"For each instant in `times`: the price just before and 60 minutes after (macro events, listings, announcements), at minute resolution: `px_before` is the close of the last 1-minute candle that ends by the instant's minute start, `px_after` the close of the last one that ends by 60 minutes after it. A minute-aligned instant is exact; an instant inside a minute is evaluated at that minute's start, so no trade after the instant is used.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 12 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"times","in":"query","required":true,"description":"Comma-separated epoch ms, up to 12.","schema":{"type":"string","pattern":"^\\d{10,13}(,\\d{10,13}){0,11}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Requested instant, epoch ms"},"px_before":{"type":"string","description":"Price at the instant's minute start (close of the last 1-minute candle ending by it) (decimal string; may carry extra trailing zeros)"},"samples_before":{"type":"integer","description":"1-minute candles with a trade in the hour before"},"px_after":{"type":"string","description":"Price 60 min after that minute start (decimal string; may carry extra trailing zeros)"},"samples_after":{"type":"integer","description":"1-minute candles with a trade in the following hour"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/event-moves?times=1792843200000'"}]}},"/v1/markets/{coin}/session-gaps":{"get":{"operationId":"getEquitySessionGaps","summary":"Equity perp overnight gaps","description":"For a trade.xyz equity perp: last price before the New York cash close and the price at the cash open, per New York date whose cash session (09:30–16:00 New York) overlaps the range (≤ 90 days): a range ending before a date's 09:30 or starting after its 16:00 leaves that date out. Early-close days use the regular close time.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 400 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"trade.xyz equity perp, e.g. xyz:TSLA.","schema":{"type":"string","pattern":"^xyz:[A-Za-z0-9_\\-]{1,30}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"ny_date":{"type":"string","description":"New York date (YYYY-MM-DD)"},"px_before_close":{"type":"string","description":"Last price before the cash close (decimal string; may carry extra trailing zeros)"},"px_at_open":{"type":"string","description":"Price at the cash open (decimal string; may carry extra trailing zeros)"},"samples_before_close":{"type":"integer","description":"Samples before close"},"samples_after_open":{"type":"integer","description":"Samples after open"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/xyz:TSLA/session-gaps'"}]}},"/v1/markets/{coin}/session-slots":{"get":{"operationId":"getEquitySessionSlots","summary":"Equity perp 30-minute activity","description":"For a trade.xyz equity perp: taker volume, trades and liquidations per 30-minute slot in the range (≤ 30 days).\n\nPricing: base + per row. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"trade.xyz equity perp, e.g. xyz:TSLA.","schema":{"type":"string","pattern":"^xyz:[A-Za-z0-9_\\-]{1,30}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 7 days; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"volume":{"type":"string","description":"Taker volume (USD) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"liq_notional":{"type":"string","description":"Liquidated notional (USD) (decimal string; may carry extra trailing zeros)"},"liquidations":{"type":"integer","description":"Liquidations"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/xyz:TSLA/session-slots'"}]}},"/v1/markets/correlation":{"get":{"operationId":"getMarketCorrelation","summary":"Pairwise return correlation of 2–8 markets","description":"Pearson correlation of the log returns of 2–8 markets over [start_time, end_time), from our daily or hourly candle closes: a return is log(close / previous close) of two consecutive buckets (a missing candle breaks the chain), only closed buckets count, and each pair uses the buckets where both markets have a return (`n`). `correlation` is null when n < 3 or a side has no variance. Any market can be the anchor: read the pairs it is part of. One row per pair. No wallets.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 28 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coins","in":"query","required":true,"description":"2..8 comma-separated markets.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}(,[A-Za-z0-9:_\\-/@.]{1,40}){1,7}$"}},{"name":"interval","in":"query","required":false,"description":"1d (range ≤ 365 days, default 90 days) or 1h (≤ 90 days, default 30 days).","schema":{"type":"string","default":"1d","enum":["1d","1h"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin_a":{"type":"string","description":"First market"},"coin_b":{"type":"string","description":"Second market"},"n":{"type":"integer","description":"Buckets where both markets have a return"},"correlation":{"type":["string","null"],"description":"Pearson correlation (−1..1) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/correlation?coins=BTC,ETH,HYPE&interval=1d'"}]}},"/v1/network/builder-volume-share":{"get":{"operationId":"getBuilderVolumeShare","summary":"HIP-3 builder-dex volume share","description":"Daily perp volume on HIP-3 builder dexes vs the core exchange and the HIP-3 share. A day's volume = each market's rolling 24 h volume (Hyperliquid dayNtlVlm) at that day's last complete snapshot, summed, so adjacent days overlap slightly; core_volume + hip3_volume is hyperdash.com's Market Volume card. Exact taker notional per UTC day (spot included): GET /v1/network/revenue.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"days","in":"query","required":false,"description":"Look-back in days (≤ 90).","schema":{"type":"integer","minimum":1,"maximum":90,"default":30}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"hip3_volume":{"type":"string","description":"HIP-3 volume (USD) (decimal string; may carry extra trailing zeros)"},"core_volume":{"type":"string","description":"Core volume (USD) (decimal string; may carry extra trailing zeros)"},"hip3_share_pct":{"type":"string","description":"HIP-3 share (%) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/builder-volume-share'"}]}},"/v1/network/revenue":{"get":{"operationId":"getRevenue","summary":"Trading-fee revenue","description":"Trading fees, volume and trades per bucket for the whole exchange or one market. volume_usd = exact taker notional per UTC hour / day, spot included (not hyperdash.com's Market Volume card, which sums perps' rolling 24 h volume: GET /v1/network/builder-volume-share). fees_usd = every USDC fee paid minus maker rebates, builder fees included; GET /v1/network/fees reports builder fees apart (net exchange fees = fees − builder fees + rebates). Daily buckets are whole UTC days: `days` = N returns the current UTC day so far and the N − 1 days before it. Hourly: every hour that starts in the last N × 24 h (the newest still open). Hourly ≤ 30 days, daily ≤ 365 days. Hyperliquid's daily spot dust conversion (every UTC day at 00:00, a sell of small spot balances with no buyer) is not a trade, as on Hyperliquid's candles: it is in neither trades nor volume_usd (older 00:00 UTC spot buckets may still include it).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all), matched ignoring case; if two markets differ only by case, only one comes back: the exact spelling when it has rows, else the other.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days: ≤ 30 hourly, ≤ 365 daily. Default: 30 hourly, 90 daily.","schema":{"type":"integer","minimum":1,"maximum":365}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"fees_usd":{"type":"string","description":"USDC fees paid − maker rebates, builder fees included (USD) (decimal string; may carry extra trailing zeros)"},"volume_usd":{"type":"string","description":"Volume (USD), taker notional (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades (each match once; not the daily spot dust conversion)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/revenue?interval=1d&days=365'"}]}},"/v1/network/new-traders":{"get":{"operationId":"getNewTraders","summary":"New traders","description":"Wallets trading for the first time (on the exchange, or in one market) per bucket. `limit` buckets per page.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"Count first trades in this market (omit for the whole exchange).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":90}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"traders":{"type":"integer","description":"New traders"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/new-traders?interval=1d'"}]}},"/v1/network/user-growth":{"get":{"operationId":"getUserGrowth","summary":"Wallet growth","description":"New wallets per day, week or month and the cumulative total.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1d","1w","1M"]}},{"name":"days","in":"query","required":false,"description":"Look-back in days (≤ 365).","schema":{"type":"integer","minimum":1,"maximum":365,"default":90}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"new_wallets":{"type":"integer","description":"New wallets"},"total_wallets":{"type":"integer","description":"Cumulative wallets"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/user-growth?interval=1w&days=365'"}]}},"/v1/network/trader-profitability":{"get":{"operationId":"getTraderProfitability","summary":"Trader profitability by account size","description":"Per UTC day and account-size cohort: active traders, profitable and unprofitable counts, PnL sum and median ROI. Cohort = account value at that day's close: small < $10K, medium $10K–100K, large $100K–1M, whale $1M–5M, apex $5M+, unknown (no close snapshot yet, or none); all = every trader. Traders = wallets with perp PnL that day, except vaults and the 13 accounts Hyperdash's rankings exclude (HLP and its child vaults, the system addresses 0xfefe…fefe and 0xffff…ffff, and three wallets it treats as hedged funds: 0xb83de012dba672c76a7dbbbf3e459cb59d7d6e36, 0x5b5d51203a0f9079f8aeb098a6523a13f298c060, 0x49e96e255ba418d08e66c35b588e2f2f3766e1d0). A day is complete (`complete`) about 31 h after it closes: until then its close account values are still filling in (many traders sit in `unknown` and the size cohorts are short) and its PnL is recomputed. Later rewrites of close values can still move a few traders for up to 7 days. Each row carries its band (min_usd, max_usd). Not the bands of GET /v1/network/trader-distribution, whose tiers share some names (its small is $10K–100K, its whale $10M+). `limit` days per page.\n\nPricing: base + per row (one per cohort and day: up to 7 a day). Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Days per page.","schema":{"type":"integer","minimum":1,"maximum":400,"default":30}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"cohort":{"type":"string","description":"Account-size cohort"},"min_usd":{"type":["string","null"],"description":"Band lower bound, inclusive (USD; null: open) (decimal string; may carry extra trailing zeros)"},"max_usd":{"type":["string","null"],"description":"Band upper bound, exclusive (USD; null: open) (decimal string; may carry extra trailing zeros)"},"traders":{"type":"integer","description":"Traders"},"profitable":{"type":"integer","description":"Profitable"},"unprofitable":{"type":"integer","description":"Unprofitable"},"pnl_sum":{"type":"string","description":"PnL sum (USD) (decimal string; may carry extra trailing zeros)"},"median_roi":{"type":"string","description":"Median ROI (decimal string; may carry extra trailing zeros)"},"complete":{"type":"boolean","description":"The day's cohorts and PnL are complete (false for about 31 h after its close: close account values still filling in, PnL still recomputed; small revisions remain possible for 7 days)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/trader-profitability'"}]}},"/v1/network/trader-distribution":{"get":{"operationId":"getTraderDistribution","summary":"Active traders by account size, lifetime volume or size migration","description":"For one finalized UTC period — a week (Monday to Monday) or a calendar month, ended at least 7 days ago so late data has settled; default: the latest finalized one, up to 52 weeks / 12 months back — the wallets that traded perps in the period (vaults and the 13 accounts Hyperdash's rankings exclude — HLP and its child vaults, two system addresses, three hedged-fund wallets — left out), grouped by `view`: `size` = account size at the close of the period's last day (micro < $10K, small < $100K, medium < $1M, large < $10M, whale $10M+, unknown without a snapshot) with their total account value; `volume` = CURRENT lifetime traded volume as of the request (low < $1M, medium < $10M, high < $100M, very_high < $1B, extreme $1B+, unknown without stats) with the total lifetime volume; `migration` = account-size tier at the close of the day before the period (`from_tier`) → at the close of its last day (`tier`), among the period's active traders, wallet counts only. A period's first released answer is kept (served again unchanged). Each row carries its `tier`'s band (min_usd, max_usd: account value for size / migration, lifetime volume for volume). These are not the cohorts of GET /v1/network/trader-profitability, which share some names (its small is < $10K, its whale $1M–5M).\n\nPricing: flat. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 40 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"view","in":"query","required":false,"description":"Grouping.","schema":{"type":"string","default":"size","enum":["size","volume","migration"]}},{"name":"period","in":"query","required":false,"description":"Window.","schema":{"type":"string","default":"week","enum":["week","month"]}},{"name":"start","in":"query","required":false,"description":"First day of the period, YYYY-MM-DD (UTC): a Monday for weeks, the 1st for months. Default: the latest finalized period.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"tier":{"type":"string","description":"Tier (size / volume; migration: tier at the period's close)"},"min_usd":{"type":["string","null"],"description":"Band lower bound, inclusive (USD; null: open) (decimal string; may carry extra trailing zeros)"},"max_usd":{"type":["string","null"],"description":"Band upper bound, exclusive (USD; null: open) (decimal string; may carry extra trailing zeros)"},"from_tier":{"type":["string","null"],"description":"Migration only: tier before the period"},"wallets":{"type":"integer","description":"Wallets"},"total":{"type":["string","null"],"description":"size: total account value at the close; volume: total lifetime volume (USD); null for migration (decimal string; may carry extra trailing zeros)"},"period_start":{"type":"integer","description":"Period start, epoch ms"},"period_end":{"type":"integer","description":"Period end (exclusive), epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/trader-distribution?view=migration&period=month'"}]}},"/v1/network/hlp":{"get":{"operationId":"getHlp","summary":"HLP vault performance","description":"Account value (and daily PnL) of the three HLP strategies (A, B, Liquidator) per bucket. `limit` buckets per page.\n\nPricing: base + per row (one per strategy and bucket: up to 3 a bucket). Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":90}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"strategy":{"type":"string","description":"A, B or Liquidator"},"account_value":{"type":"string","description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"pnl":{"type":["string","null"],"description":"PnL of the day (daily only) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/hlp'"}]}},"/v1/staking/flows":{"get":{"operationId":"getStakingFlows","summary":"HYPE staking flows","description":"HYPE staked and unstaked per bucket with transfer and wallet counts. `limit` buckets per page.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":90}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"staked":{"type":"string","description":"HYPE staked (decimal string; may carry extra trailing zeros)"},"unstaked":{"type":"string","description":"HYPE unstaked (decimal string; may carry extra trailing zeros)"},"stake_transfers":{"type":"integer","description":"Stake transfers"},"unstake_transfers":{"type":"integer","description":"Unstake transfers"},"stakers":{"type":"integer","description":"Wallets staking"},"unstakers":{"type":"integer","description":"Wallets unstaking"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/flows'"}]}},"/v1/staking/validators":{"get":{"operationId":"getValidators","summary":"Validator set","description":"Every validator from the latest snapshot, by name: stake, commission, jailed / active, recent blocks, uptime and predicted APR per period. Since 2026-11-10 22:05 UTC the snapshots come from our node's state (`source` node), one per hour, so the served one is up to about 80 minutes old; they carry stake, commission and jailed / active / unjailable after (null in node snapshots taken before those were read from the node's state), but not recent blocks, uptime, APR or samples (null). Before that, Hyperliquid's validator summary every 5 minutes (`source` hyperliquid).\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Validator name"},"stake":{"type":"string","description":"Delegated HYPE (decimal string; may carry extra trailing zeros)"},"commission":{"type":"string","description":"Commission (decimal string; may carry extra trailing zeros)"},"is_jailed":{"type":["boolean","null"],"description":"Jailed (null when the snapshot cannot tell: early node snapshots)"},"is_active":{"type":["boolean","null"],"description":"In the active set: the largest validators by stake, up to the network's maximum, jailed or not (a validator jailed mid-epoch stays active); null when the snapshot cannot tell (early node snapshots)"},"recent_blocks":{"type":["integer","null"],"description":"Recent blocks (null in node snapshots)"},"uptime_day":{"type":["string","null"],"description":"Uptime, last day (null in node snapshots) (decimal string; may carry extra trailing zeros)"},"uptime_week":{"type":["string","null"],"description":"Uptime, last week (null in node snapshots) (decimal string; may carry extra trailing zeros)"},"uptime_month":{"type":["string","null"],"description":"Uptime, last month (null in node snapshots) (decimal string; may carry extra trailing zeros)"},"apr_day":{"type":["string","null"],"description":"Predicted APR, day (null in node snapshots) (decimal string; may carry extra trailing zeros)"},"apr_week":{"type":["string","null"],"description":"Predicted APR, week (null in node snapshots) (decimal string; may carry extra trailing zeros)"},"apr_month":{"type":["string","null"],"description":"Predicted APR, month (null in node snapshots) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Snapshot time, epoch ms (node snapshots: the node state's own time)"},"unjailable_after":{"type":["integer","null"],"description":"Jailed validator: when it can be unjailed, epoch ms (0 = now); null when not jailed or unknown"},"samples_day":{"type":["integer","null"],"description":"Uptime samples over the day (null in node snapshots)"},"samples_week":{"type":["integer","null"],"description":"Uptime samples over the week (null in node snapshots)"},"samples_month":{"type":["integer","null"],"description":"Uptime samples over the month (null in node snapshots)"},"source":{"type":"string","description":"Where the snapshot came from: hyperliquid (Hyperliquid's validator summary, until 2026-11-10 22:00 UTC) or node (our node's state: no recent blocks, uptime, APR or samples)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/validators'"}]}},"/v1/staking/history":{"get":{"operationId":"getStakeHistory","summary":"Total delegated HYPE over time","description":"Total and active delegated HYPE and the validator count at the last snapshot of each bucket (GET /v1/staking/validators: Hyperliquid's summary every 5 minutes until 2026-11-10 22:00 UTC, our node's state hourly since). `limit` buckets per page.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":90}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"total_stake":{"type":"string","description":"Delegated HYPE (decimal string; may carry extra trailing zeros)"},"active_stake":{"type":["string","null"],"description":"Delegated to active, not jailed validators; null when the bucket's last snapshot cannot tell (node snapshots from 2026-11-10 22:05 UTC until jailed / active status was read from the node's state) (decimal string; may carry extra trailing zeros)"},"validators":{"type":"integer","description":"Validators"},"snapshot_time":{"type":"integer","description":"Snapshot time, epoch ms (node snapshots: the node state's own time)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/history'"}]}},"/v1/network/hype-supply":{"get":{"operationId":"getHypeSupply","summary":"HYPE supply","description":"HYPE circulating, total and max supply, future emissions and mark at the last hourly snapshot of each UTC day. `limit` days per page. A page whose bars are all empty (before the first data, a gap) reads on to the next bars with data in the same call, as far as the longest page this route serves; a page that still holds no bars but has more only moves the cursor on. Without start_time the window is the default range in whole bars, ending with the bar in progress.\n\nPricing: base + per day. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Days per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":90}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"circulating_supply":{"type":"string","description":"Circulating supply (decimal string; may carry extra trailing zeros)"},"total_supply":{"type":"string","description":"Total supply (decimal string; may carry extra trailing zeros)"},"max_supply":{"type":"string","description":"Max supply (decimal string; may carry extra trailing zeros)"},"future_emissions":{"type":"string","description":"Future emissions (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":"string","description":"HYPE mark (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/hype-supply'"}]}},"/v1/network/hype-holders":{"get":{"operationId":"getHypeHolderBands","summary":"HYPE holders by balance band","description":"Per UTC day: wallets and HYPE held per balance band. A band starts at its lower edge (a wallet holding exactly 100,000 HYPE is in 100K-1M); days computed before that was fixed (November 2026) count such a wallet in 10K-100K; the daily job recomputes only the last 3 days, so older days keep it (their source snapshots are kept 7 days). `limit` days per page.\n\nPricing: base + per row (one per band and day: up to 8 a day). Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Days per page.","schema":{"type":"integer","minimum":1,"maximum":400,"default":30}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"band":{"type":"string","description":"Balance band"},"wallets":{"type":"integer","description":"Wallets"},"held":{"type":"string","description":"HYPE held (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/hype-holders'"}]}},"/v1/spot/tokens/{token}/holder-bands":{"get":{"operationId":"getTokenHolderBands","summary":"Spot token holders by balance band, now vs a week ago","description":"Wallets and amount held per balance band of one spot token at the latest complete HyperCore spot snapshot (`period` now) and about 7 days earlier (`week_ago`). A band starts at its lower edge (a wallet holding exactly 100,000 is in 100K-1M). Snapshot population only (not staked / HyperEVM). Not available for USDC. Cached up to 5 min.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 32 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["spot"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"token","in":"path","required":true,"description":"Spot token name, e.g. HYPE, PURR.","schema":{"type":"string","pattern":"^[A-Za-z0-9]{1,20}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"period":{"type":"string","description":"now or week_ago"},"snapshot_time":{"type":"integer","description":"Snapshot time, epoch ms"},"band":{"type":"string","description":"Balance band (token units)"},"wallets":{"type":"integer","description":"Wallets"},"held":{"type":"string","description":"Amount held (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/spot/tokens/HYPE/holder-bands'"}]}},"/v1/lending/reserves/{token}/history":{"get":{"operationId":"getLendingReserveHistory","summary":"Borrow/lend reserve history of one token","description":"One HyperCore borrow/lend reserve over time (5-minute collector): the last snapshot of each hour or UTC day — supply and borrow APR, utilization, supplied, borrowed and available, oracle price, LTV. `limit` buckets per page. A page whose bars are all empty (before the first data, a gap) reads on to the next bars with data in the same call, as far as the longest page this route serves; a page that still holds no bars but has more only moves the cursor on. Without start_time the window is the default range in whole bars, ending with the bar in progress.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["lending"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"token","in":"path","required":true,"description":"Token index (see /v1/lending/reserves), e.g. 0 = USDC.","schema":{"type":"integer","minimum":0,"maximum":100000}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":168}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"snapshot_time":{"type":"integer","description":"Snapshot used, epoch ms"},"token_name":{"type":["string","null"],"description":"Token name"},"supply_apr":{"type":["string","null"],"description":"Supply rate (yearly, fraction) (decimal string; may carry extra trailing zeros)"},"borrow_apr":{"type":["string","null"],"description":"Borrow rate (yearly, fraction) (decimal string; may carry extra trailing zeros)"},"utilization":{"type":["string","null"],"description":"Borrowed / supplied (decimal string; may carry extra trailing zeros)"},"total_supplied":{"type":["string","null"],"description":"Supplied (decimal string; may carry extra trailing zeros)"},"total_borrowed":{"type":["string","null"],"description":"Borrowed (decimal string; may carry extra trailing zeros)"},"available":{"type":["string","null"],"description":"Available to borrow (decimal string; may carry extra trailing zeros)"},"oracle_px":{"type":["string","null"],"description":"Oracle price (USD) (decimal string; may carry extra trailing zeros)"},"ltv":{"type":["string","null"],"description":"Loan-to-value (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/lending/reserves/0/history?interval=1d'"}]}},"/v1/network/af-buybacks":{"get":{"operationId":"getAssistanceFundBuybacks","summary":"Assistance Fund buybacks","description":"HYPE bought and sold by the Assistance Fund per bucket and spot pair: exact UTC hours or days. hyperdash.com's AF card covers a rolling window (now − N days, so its first day is partial): request interval=1h from start_time = now − N days and sum to come within one hour of it (buckets are hour-aligned, so the first hour is whole). `limit` buckets per page.\n\nPricing: base + per row (one per bucket and spot pair). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":90}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"coin":{"type":"string","description":"Spot pair"},"buy_size":{"type":"string","description":"HYPE bought (decimal string; may carry extra trailing zeros)"},"buy_notional":{"type":"string","description":"Bought, quote notional (decimal string; may carry extra trailing zeros)"},"sell_size":{"type":"string","description":"HYPE sold (decimal string; may carry extra trailing zeros)"},"sell_notional":{"type":"string","description":"Sold, quote notional (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/af-buybacks'"}]}},"/v1/network/usdc-reserve":{"get":{"operationId":"getUsdcReserve","summary":"USDC reserve balance","description":"USDC balance of the reserve treasury at Hyperliquid's daily reading time (just after 00:00 UTC) per day in [start_time, end_time) (≤ 365 days), plus the latest reading.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 90 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"day or latest"},"day":{"type":["integer","null"],"description":"UTC day, epoch ms (null for latest)"},"balance":{"type":"string","description":"USDC balance (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Snapshot the row was computed from, epoch ms"},"read_time":{"type":"integer","description":"Chain read time, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/usdc-reserve'"}]}},"/v1/network/usdc-reserve/settlements":{"get":{"operationId":"getUsdcReserveSettlements","summary":"USDC reserve yield settlements","description":"Each payment of the reserve's yield to the Assistance Fund (USDC sends from the system interest address, exact amounts) in [start_time, end_time) (≤ 365 days), oldest first; `limit` rows per page, page with the cursor. Recorded from 2026-09-02.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 365 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the window).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Settlement time, epoch ms"},"amount":{"type":"string","description":"USDC paid (decimal string; may carry extra trailing zeros)"},"hash":{"type":["string","null"],"description":"Transaction hash"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/usdc-reserve/settlements'"}]}},"/v1/network/priority-fees/summary":{"get":{"operationId":"getPriorityFeeSummary","summary":"Priority-fee totals","description":"Write (IOC + ALO) and read priority fees in HYPE and USD over [start_time, end_time) (hour-aligned, ≤ 365 days): counts, averages and paying wallets.\n\nPricing: base × range tier (≤1 d ×1, ≤7 d ×2, ≤30 d ×5, ≤90 d ×8, ≤365 d ×11). Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"start":{"type":"integer","description":"Window start actually summed, epoch ms"},"end":{"type":"integer","description":"Window end, epoch ms"},"write_hype":{"type":"string","description":"Write fees, HYPE (decimal string; may carry extra trailing zeros)"},"write_usd":{"type":"string","description":"Write fees, USD (decimal string; may carry extra trailing zeros)"},"write_orders":{"type":"integer","description":"Paid orders"},"read_hype":{"type":"string","description":"Read fees, HYPE (decimal string; may carry extra trailing zeros)"},"read_usd":{"type":"string","description":"Read fees, USD (decimal string; may carry extra trailing zeros)"},"reads":{"type":"integer","description":"Read auction wins"},"total_hype":{"type":"string","description":"Total, HYPE (decimal string; may carry extra trailing zeros)"},"total_usd":{"type":"string","description":"Total, USD (decimal string; may carry extra trailing zeros)"},"total_txs":{"type":"integer","description":"Paid transactions"},"avg_write_usd":{"type":"string","description":"Average per paid order, USD (decimal string; may carry extra trailing zeros)"},"avg_read_usd":{"type":"string","description":"Average per read, USD (decimal string; may carry extra trailing zeros)"},"write_wallets":{"type":"integer","description":"Wallets paying write fees"},"read_wallets":{"type":"integer","description":"Wallets paying read fees"},"wallets":{"type":"integer","description":"Wallets paying any fee"},"usd_complete":{"type":"boolean","description":"Every fee priced in USD"},"hype_complete":{"type":"boolean","description":"Every ALO fee converted to HYPE"},"write_ioc_hype":{"type":["string","null"],"description":"IOC priority fees paid (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_usd":{"type":["string","null"],"description":"IOC priority fees paid (USD) (decimal string; may carry extra trailing zeros)"},"write_ioc_orders":{"type":["integer","null"],"description":"IOC orders that paid"},"write_ioc_fills":{"type":["integer","null"],"description":"Fills of those IOC orders"},"write_ioc_unpriced_hype":{"type":["string","null"],"description":"IOC fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"write_alo_hype_estimate":{"type":["string","null"],"description":"ALO priority fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_usd":{"type":["string","null"],"description":"ALO priority fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_orders":{"type":["integer","null"],"description":"ALO orders that paid"},"write_alo_resting_notional_usd":{"type":["string","null"],"description":"Notional of those ALO orders while resting (USD) (decimal string; may carry extra trailing zeros)"},"write_unpriced_hype":{"type":["string","null"],"description":"Write fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unpriced_hype":{"type":["string","null"],"description":"All fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unconverted_usd":{"type":["string","null"],"description":"USD fees not converted to HYPE (decimal string; may carry extra trailing zeros)"},"hype_estimated":{"type":"boolean","description":"HYPE totals include ALO estimates"},"live_from":{"type":["integer","null"],"description":"From this time (epoch ms) the window is filled from the live tail (less settled)"},"write_fills":{"type":["integer","null"],"description":"Fills of paying writes"},"read_unpriced_hype":{"type":["string","null"],"description":"Read fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"avg_write_ioc_hype":{"type":["string","null"],"description":"Average IOC fee (HYPE) (decimal string; may carry extra trailing zeros)"},"avg_write_ioc_usd":{"type":["string","null"],"description":"Average IOC fee (USD) (decimal string; may carry extra trailing zeros)"},"avg_write_alo_hype_estimate":{"type":["string","null"],"description":"Average ALO fee (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"avg_write_alo_usd":{"type":["string","null"],"description":"Average ALO fee (USD, estimated) (decimal string; may carry extra trailing zeros)"},"avg_write_hype":{"type":["string","null"],"description":"Average write fee (HYPE) (decimal string; may carry extra trailing zeros)"},"avg_read_hype":{"type":["string","null"],"description":"Average read fee (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_wallets":{"type":["integer","null"],"description":"Wallets paying IOC fees"},"write_alo_wallets":{"type":["integer","null"],"description":"Wallets paying ALO fees"},"last_hour":{"type":["integer","null"],"description":"Last complete hour in the window, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/priority-fees/summary'"}]}},"/v1/network/priority-fees/by-coin":{"get":{"operationId":"getPriorityFeesByCoin","summary":"Priority fees per market","description":"Write priority fees per market over [start_time, end_time) (≤ 90 days) with each market's share of the total.\n\nPricing: base × range tier (≤1 d ×1, ≤7 d ×2, ≤30 d ×5, ≤90 d ×8). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"kind","in":"query","required":false,"description":"Order type.","schema":{"type":"string","default":"write","enum":["write","write_ioc","write_alo"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"dex":{"type":"string","description":"HIP-3 dex (empty = core)"},"asset_class":{"type":"string","description":"Asset class"},"write_hype":{"type":"string","description":"Fees, HYPE (decimal string; may carry extra trailing zeros)"},"write_usd":{"type":"string","description":"Fees, USD (decimal string; may carry extra trailing zeros)"},"write_orders":{"type":"integer","description":"Paid orders"},"write_fills":{"type":"integer","description":"Paid fills"},"share_usd":{"type":["string","null"],"description":"Share of all fees, USD (decimal string; may carry extra trailing zeros)"},"share_hype":{"type":["string","null"],"description":"Share of all fees, HYPE (decimal string; may carry extra trailing zeros)"},"usd_complete":{"type":"boolean","description":"Every fee priced in USD"},"hype_complete":{"type":"boolean","description":"Every ALO fee converted to HYPE"},"write_ioc_hype":{"type":["string","null"],"description":"IOC priority fees paid (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_usd":{"type":["string","null"],"description":"IOC priority fees paid (USD) (decimal string; may carry extra trailing zeros)"},"write_ioc_orders":{"type":["integer","null"],"description":"IOC orders that paid"},"write_ioc_fills":{"type":["integer","null"],"description":"Fills of those IOC orders"},"write_ioc_unpriced_hype":{"type":["string","null"],"description":"IOC fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"write_alo_hype_estimate":{"type":["string","null"],"description":"ALO priority fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_usd":{"type":["string","null"],"description":"ALO priority fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_orders":{"type":["integer","null"],"description":"ALO orders that paid"},"write_alo_resting_notional_usd":{"type":["string","null"],"description":"Notional of those ALO orders while resting (USD) (decimal string; may carry extra trailing zeros)"},"write_unpriced_hype":{"type":["string","null"],"description":"Write fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unpriced_hype":{"type":["string","null"],"description":"All fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unconverted_usd":{"type":["string","null"],"description":"USD fees not converted to HYPE (decimal string; may carry extra trailing zeros)"},"hype_estimated":{"type":"boolean","description":"HYPE totals include ALO estimates"},"live_from":{"type":["integer","null"],"description":"From this time (epoch ms) the window is filled from the live tail (less settled)"},"share_hype_estimated":{"type":"boolean","description":"share_hype includes ALO estimates"},"share_hype_complete":{"type":"boolean","description":"share_hype complete"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/priority-fees/by-coin'"}]}},"/v1/network/priority-fees/top-coins":{"get":{"operationId":"getPriorityFeesTopCoins","summary":"Priority fees of the top markets over time","description":"Write priority fees per bucket for the `top` markets by USD over [start_time, end_time). Hourly ≤ 1 day, daily ≤ 30 days.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"top","in":"query","required":false,"description":"Markets.","schema":{"type":"integer","minimum":1,"maximum":50,"default":10}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"kind","in":"query","required":false,"description":"Order type.","schema":{"type":"string","default":"write","enum":["write","write_ioc","write_alo"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days (1 day hourly); range ≤ 30 days daily, 1 day hourly.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"coin":{"type":"string","description":"Market"},"dex":{"type":"string","description":"HIP-3 dex (empty = core)"},"write_hype":{"type":"string","description":"Fees, HYPE (decimal string; may carry extra trailing zeros)"},"write_usd":{"type":"string","description":"Fees, USD (decimal string; may carry extra trailing zeros)"},"write_orders":{"type":"integer","description":"Paid orders"},"usd_complete":{"type":"boolean","description":"Every fee priced in USD"},"hype_complete":{"type":"boolean","description":"Every ALO fee converted to HYPE"},"write_ioc_hype":{"type":["string","null"],"description":"IOC priority fees paid (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_usd":{"type":["string","null"],"description":"IOC priority fees paid (USD) (decimal string; may carry extra trailing zeros)"},"write_ioc_orders":{"type":["integer","null"],"description":"IOC orders that paid"},"write_ioc_fills":{"type":["integer","null"],"description":"Fills of those IOC orders"},"write_ioc_unpriced_hype":{"type":["string","null"],"description":"IOC fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"write_alo_hype_estimate":{"type":["string","null"],"description":"ALO priority fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_usd":{"type":["string","null"],"description":"ALO priority fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_orders":{"type":["integer","null"],"description":"ALO orders that paid"},"write_alo_resting_notional_usd":{"type":["string","null"],"description":"Notional of those ALO orders while resting (USD) (decimal string; may carry extra trailing zeros)"},"write_unpriced_hype":{"type":["string","null"],"description":"Write fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unpriced_hype":{"type":["string","null"],"description":"All fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unconverted_usd":{"type":["string","null"],"description":"USD fees not converted to HYPE (decimal string; may carry extra trailing zeros)"},"hype_estimated":{"type":"boolean","description":"HYPE totals include ALO estimates"},"live_from":{"type":["integer","null"],"description":"From this time (epoch ms) the window is filled from the live tail (less settled)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/priority-fees/top-coins?top=10'"}]}},"/v1/network/priority-fees/builder-share":{"get":{"operationId":"getPriorityFeesBuilderShare","summary":"HIP-3 share of priority fees","description":"Per bucket: write priority fees in total and on HIP-3 builder dexes, and the HIP-3 share. Hourly ≤ 30 days, daily ≤ 90 days.\n\nPricing: base × range tier (≤1 d ×1, ≤7 d ×2, ≤30 d ×5, ≤90 d ×8). X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"write_usd":{"type":"string","description":"All write fees, USD (decimal string; may carry extra trailing zeros)"},"hip3_write_usd":{"type":"string","description":"HIP-3 write fees, USD (decimal string; may carry extra trailing zeros)"},"hip3_share_usd":{"type":"string","description":"HIP-3 share, USD (decimal string; may carry extra trailing zeros)"},"write_hype":{"type":"string","description":"All write fees, HYPE (decimal string; may carry extra trailing zeros)"},"hip3_write_hype":{"type":"string","description":"HIP-3 write fees, HYPE (decimal string; may carry extra trailing zeros)"},"hip3_share_hype":{"type":"string","description":"HIP-3 share, HYPE (decimal string; may carry extra trailing zeros)"},"usd_complete":{"type":"boolean","description":"Every fee priced in USD"},"hype_complete":{"type":"boolean","description":"Every ALO fee converted to HYPE"},"write_ioc_hype":{"type":["string","null"],"description":"IOC priority fees paid (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_usd":{"type":["string","null"],"description":"IOC priority fees paid (USD) (decimal string; may carry extra trailing zeros)"},"write_ioc_orders":{"type":["integer","null"],"description":"IOC orders that paid"},"write_ioc_fills":{"type":["integer","null"],"description":"Fills of those IOC orders"},"write_ioc_unpriced_hype":{"type":["string","null"],"description":"IOC fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"write_alo_hype_estimate":{"type":["string","null"],"description":"ALO priority fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_usd":{"type":["string","null"],"description":"ALO priority fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_orders":{"type":["integer","null"],"description":"ALO orders that paid"},"write_alo_resting_notional_usd":{"type":["string","null"],"description":"Notional of those ALO orders while resting (USD) (decimal string; may carry extra trailing zeros)"},"write_unpriced_hype":{"type":["string","null"],"description":"Write fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unpriced_hype":{"type":["string","null"],"description":"All fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unconverted_usd":{"type":["string","null"],"description":"USD fees not converted to HYPE (decimal string; may carry extra trailing zeros)"},"hype_estimated":{"type":"boolean","description":"HYPE totals include ALO estimates"},"live_from":{"type":["integer","null"],"description":"From this time (epoch ms) the window is filled from the live tail (less settled)"},"hip3_write_ioc_hype":{"type":["string","null"],"description":"HIP-3 IOC fees (HYPE) (decimal string; may carry extra trailing zeros)"},"hip3_write_ioc_usd":{"type":["string","null"],"description":"HIP-3 IOC fees (USD) (decimal string; may carry extra trailing zeros)"},"hip3_write_alo_hype_estimate":{"type":["string","null"],"description":"HIP-3 ALO fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"hip3_write_alo_usd":{"type":["string","null"],"description":"HIP-3 ALO fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"hip3_write_ioc_share_usd":{"type":["string","null"],"description":"HIP-3 share of IOC fees (USD, ratio) (decimal string; may carry extra trailing zeros)"},"hip3_write_ioc_share_hype":{"type":["string","null"],"description":"HIP-3 share of IOC fees (HYPE, ratio) (decimal string; may carry extra trailing zeros)"},"hip3_write_alo_share_usd":{"type":["string","null"],"description":"HIP-3 share of ALO fees (USD, ratio) (decimal string; may carry extra trailing zeros)"},"hip3_write_alo_share_hype_estimate":{"type":["string","null"],"description":"HIP-3 share of ALO fees (HYPE, ratio) (decimal string; may carry extra trailing zeros)"},"write_orders":{"type":["integer","null"],"description":"Paying write orders"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/priority-fees/builder-share'"}]}},"/v1/outcomes/activity":{"get":{"operationId":"getOutcomeActivity","summary":"HIP-4 outcome activity","description":"Taker notional (Yes space), fees, fills and unique traders per bucket across HIP-4 outcome markets, or one outcome; buckets in time order. Real trades only: Settlement, Split / Merge / Negate Outcome and Merge Question fills are not counted as trades, fills or traders (their fees stay in `fees`). One page covers at most 1 day; page with the cursor.\n\nPricing: base + per bucket. Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"outcome","in":"query","required":false,"description":"One outcome id (omit for all).","schema":{"type":"integer","minimum":0,"maximum":1000000000000000}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["5m","1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":288,"default":24}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"taker_notional":{"type":"string","description":"Taker notional in Yes space (USD): size × Yes price, a No-book trade at px counting at 1 − px, as `yes_notional` on GET /v1/outcomes (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"taker_fills":{"type":"integer","description":"Taker fills"},"traders":{"type":"integer","description":"Unique traders"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/activity?interval=1h'"}]}},"/v1/staking/stakers/buckets":{"get":{"operationId":"getStakerBuckets","summary":"Delegated HYPE by stake size","description":"Wallets and delegated HYPE per stake-size bucket (< 1k, 1k–10k, 10k–100k, 100k–1M, ≥ 1M HYPE; wallets without stake excluded) at a whole UTC hour. History starts 2026-10-11 12:00 UTC (the first committed staking baseline). Exact decimals. No wallets.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"time","in":"query","required":false,"description":"Point in time, epoch ms, rounded down to the hour. Default: the last whole hour.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"bucket":{"type":"string","description":"Stake-size bucket"},"wallets":{"type":"integer","description":"Wallets"},"stake_total":{"type":"string","description":"Delegated HYPE in the bucket (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/stakers/buckets'"}]}},"/v1/network/usdc-reserve/intervals":{"get":{"operationId":"getUsdcReserveIntervals","summary":"USDC reserve yield per 30-day interval: accrual, settlement, implied rate","description":"Hyperliquid's USDC reserve yield (AQAv2) per 30-day interval since 2026-08-27, as hyperdash.com computes it: our daily readings of the treasury deployer's HyperEVM USDC balance (taken just after 00:00 UTC), the accrual at an assumed rate (the AQA rate has no public read path), the settlement to the Assistance Fund on its scheduled day (8 days after the interval; exact, from our ledger) and the rate it implies (settlement ÷ Σ daily balances × 365) — an estimate, given only when all 30 readings were on time (within 5 min of 00:00). No wallets.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 40 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Intervals starting at or after this, epoch ms. Default: end_time − 365 days (within your plan's history window); range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"Intervals starting at or before this, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"assumed_rate_pct","in":"query","required":false,"description":"Rate for the accrual estimate (%, 0–20).","schema":{"type":"integer","minimum":0,"maximum":20,"default":3}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Interval number (1 = from 2026-08-27)"},"start_time":{"type":"integer","description":"Interval start, epoch ms"},"end_time":{"type":"integer","description":"Interval end, epoch ms (exclusive)"},"settlement_due":{"type":"integer","description":"Scheduled settlement day, epoch ms"},"readings":{"type":"integer","description":"Daily readings in the interval"},"readings_on_time":{"type":"integer","description":"Readings within 5 min of 00:00 UTC"},"accrued_at_assumed_rate":{"type":"string","description":"Σ daily balances × assumed rate ÷ 365 (USD) (decimal string; may carry extra trailing zeros)"},"settled":{"type":["string","null"],"description":"Settlement to the Assistance Fund (USD) (decimal string; may carry extra trailing zeros)"},"settled_at":{"type":["integer","null"],"description":"Settlement time, epoch ms"},"implied_rate_pct":{"type":["string","null"],"description":"Implied annual rate (%) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/usdc-reserve/intervals'"}]}},"/v1/staking/rewards":{"get":{"operationId":"getValidatorRewards","summary":"Validator rewards","description":"Staking rewards credited to each validator per bucket (the node's ValidatorRewards events, every few minutes), with the validator's name from the latest validator snapshot (null when it is not in the current set). One row per (bucket, validator), ascending; optionally one validator. From our nodes' misc events: history from 2025-09-27 10:00 UTC (the first hour of Hyperliquid's node-data archive, loaded and checked hour by hour), live since 2026-11-05 18:06 UTC. Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. A validator filter counts as a queried wallet (even when no row comes back); without it, the validators returned count toward your discovered-wallet allowance. A page holds whole buckets (≤ 8,000 rows); hourly pages span ≤ 30 days, daily ≤ 365 days.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 8,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1h","enum":["1h","1d"]}},{"name":"validator","in":"query","required":false,"description":"Only this validator (address).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Buckets per page.","schema":{"type":"integer","minimum":1,"maximum":2000,"default":168}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days; range ≤ one page.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"validator":{"type":"string","description":"Validator address"},"name":{"type":["string","null"],"description":"Validator name (latest snapshot)"},"reward":{"type":"string","description":"HYPE credited in the bucket (decimal string; may carry extra trailing zeros)"},"events":{"type":"integer","description":"Reward events in the bucket"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/rewards?interval=1d'"}]}},"/v1/network/gossip-auctions":{"get":{"operationId":"listGossipAuctions","summary":"Gossip priority auctions","description":"Each restart of a gossip priority auction slot (the protocol auctions priority gossip slots for HYPE): the slot, the previous winner (a gossip peer, by IP; null when the slot had none) and the gas it ended at, oldest first. From our nodes' misc events: history from 2025-09-27 10:00 UTC (the first hour of Hyperliquid's node-data archive, loaded and checked hour by hour), live since 2026-11-05 18:06 UTC. Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. Range ≤ 365 days; page with the cursor.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Restart time, epoch ms"},"slot":{"type":"integer","description":"Slot id"},"previous_winner_ip":{"type":["string","null"],"description":"Previous winner's IP (null = none)"},"end_gas":{"type":["string","null"],"description":"Gas the auction ended at (HYPE; null = none) (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/gossip-auctions'"}]}},"/v1/staking/validators/registry":{"get":{"operationId":"getValidatorRegistry","summary":"Validator registry (node state)","description":"Every validator from our node's state, by name: description, commission (bps), delegations disabled / blocked, total delegated (exact HYPE), registered, last manual unjail, last signer change. From our nodes' state snapshots (validators, tokens and vaults hourly; referrers daily), first published 2026-11-05 20:40 UTC. An answer always comes from one complete snapshot; none complete and fresh: 503 unavailable, retry later.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Validator name"},"description":{"type":"string","description":"Description"},"commission_bps":{"type":["integer","null"],"description":"Commission, bps"},"delegations_disabled":{"type":["boolean","null"],"description":"Delegations disabled"},"delegations_blocked":{"type":["boolean","null"],"description":"Delegations blocked"},"total_delegated":{"type":["string","null"],"description":"Delegated HYPE (exact) (decimal string; may carry extra trailing zeros)"},"register_time":{"type":["integer","null"],"description":"Registered, epoch ms"},"last_manual_unjail_time":{"type":["integer","null"],"description":"Last manual unjail, epoch ms"},"last_signer_change_time":{"type":["integer","null"],"description":"Last signer change, epoch ms (null: never changed)"},"snapshot_time":{"type":"integer","description":"Node-state snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/validators/registry'"}]}},"/v1/referrals":{"get":{"operationId":"getReferral","summary":"Referral code","description":"A referral code or a referrer from our node's state: the referrer, the code and how many users it referred. Give exactly one of code or referrer. From our nodes' state snapshots (validators, tokens and vaults hourly; referrers daily), first published 2026-11-05 20:40 UTC. An answer always comes from one complete snapshot; none complete and fresh: 503 unavailable, retry later.\n\nPricing: base. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["referrals"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"code","in":"query","required":false,"description":"Referral code (case-insensitive).","schema":{"type":"string","pattern":"^[A-Za-z0-9_\\-]{1,40}$"}},{"name":"referrer","in":"query","required":false,"description":"Referrer address.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"referrer":{"type":"string","description":"Referrer"},"code":{"type":"string","description":"Code"},"referred_users":{"type":"integer","description":"Users referred"},"snapshot_time":{"type":"integer","description":"Node-state snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/referrals?code=HYPERDASH'"}]}},"/v1/accounts/{address}/stats":{"get":{"operationId":"getWalletStats","summary":"Trading statistics of one wallet","description":"All-time completed-trade statistics: trades, gross PnL, net PnL split long / short, fees, net PnL, hold-time quantiles and the longest winning streak in days. net_pnl = gross PnL − fees as charged (signed: maker rebates add) + funding, and long_pnl + short_pnl = net_pnl; `fees` sums the absolute fee of every fill (a rebate counts as a fee there), so pnl − fees is not net_pnl. Completed-trade (round-trip) PnL: a trade counts once its position is fully closed, so partial closes (trims) and open positions are not included and the numbers can differ from hyperdash.com's profile PnL — that is GET /v1/accounts/{address}/leaderboard.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"trades":{"type":"integer","description":"Completed trades"},"first_trade_time":{"type":["integer","null"],"description":"First trade open, epoch ms"},"last_trade_time":{"type":["integer","null"],"description":"Last trade close, epoch ms"},"pnl":{"type":"string","description":"Gross PnL (USD): closed PnL before fees and funding (decimal string; may carry extra trailing zeros)"},"long_pnl":{"type":"string","description":"Net PnL of long trades (long_pnl + short_pnl = net_pnl) (decimal string; may carry extra trailing zeros)"},"short_pnl":{"type":"string","description":"Net PnL of short trades (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees: Σ |fee| over the trades' fills (maker rebates counted as fees, not netted) (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net PnL: gross − signed fees (rebates add) + funding (decimal string; may carry extra trailing zeros)"},"avg_hold_minutes":{"type":"string","description":"Mean hold time (min) (decimal string; may carry extra trailing zeros)"},"median_hold_minutes":{"type":"string","description":"Median hold time (decimal string; may carry extra trailing zeros)"},"q1_hold_minutes":{"type":"string","description":"25th percentile hold time (decimal string; may carry extra trailing zeros)"},"q3_hold_minutes":{"type":"string","description":"75th percentile hold time (decimal string; may carry extra trailing zeros)"},"longest_win_streak":{"type":"integer","description":"Longest winning streak in DAYS: the most distinct UTC days (by trade open) within one unbroken run of winning trades (by open time)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/stats'"}]}},"/v1/accounts/{address}/completed-trades":{"get":{"operationId":"getWalletCompletedTrades","summary":"Completed trades of one wallet: whole history, filters and sorts (hyperdash.com's Completed Trades tab)","description":"Every round trip (a position opened and fully closed) from hyperdash.com's completed-trades table, the source of the site's Completed Trades and Best Trades tabs and of GET /v1/accounts/{address}/stats: whole history, filtered by market, side, result and minimum notional (|size| × entry price), sorted by any of the site's columns (default: newest close first). `limit` trades per page; page with the cursor — pages start at offsets ≤ 10,000 (as the site), so one query reaches at most 10,000 + limit trades (meta.truncated = more exist: narrow with a filter or reverse the order). Pages are offsets into the live table, as on the site: trades that close while you page shift newest-first pages (a trade can repeat); order=asc walks stably. meta.total: matching trades when a filter is set, counted within your plan's history window on the first page and carried by the cursor (null without filters). Coverage: wallets Hyperdash has admitted to that table (every wallet trading since ~August 2025 and any wallet viewed on hyperdash.com; an older inactive wallet can have no rows), trades from the fills archive (2025-03). Your plan's history window applies (meta.history_from): trades closed before it are not delivered, counted or paged through, in every sort and order. The first page pins the window for the query's cursor so offsets stay stable while it slides; a later page leaves out trades that have since aged out of it. A cursor continues for up to a day past its window; after that, or once your plan's history is shorter than when the query started, it is refused with history_limit: restart the query. Same round trips as GET /v1/accounts/{address}/trades, which pages a close-time range (≤ 90 days, ascending) from the node trade store instead. net_pnl = gross − signed fees (maker rebates add) + funding; fees = Σ |fee| (as /stats).\n\nPricing: base + per trade. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"coin","in":"query","required":false,"description":"One market, e.g. BTC, xyz:TSLA (case-insensitive).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"side","in":"query","required":false,"description":"long or short (omit for both).","schema":{"type":"string","enum":["long","short"]}},{"name":"result","in":"query","required":false,"description":"win (net PnL > 0) or loss (net PnL < 0); omit for all.","schema":{"type":"string","enum":["win","loss"]}},{"name":"min_notional","in":"query","required":false,"description":"Minimum notional (|size| × entry price, USD): 1000, 10000, 100000 or 1000000.","schema":{"type":"string","enum":["1000","10000","100000","1000000"]}},{"name":"sort","in":"query","required":false,"description":"Sort column (ties: newest close first).","schema":{"type":"string","default":"close_time","enum":["close_time","net_pnl","notional","duration","entry_px","exit_px","funding_pnl","coin","side"]}},{"name":"order","in":"query","required":false,"description":"Sort order.","schema":{"type":"string","default":"desc","enum":["desc","asc"]}},{"name":"limit","in":"query","required":false,"description":"Trades per page.","schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (same filters, sort and limit).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"open_time":{"type":"integer","description":"Opened, epoch ms"},"close_time":{"type":"integer","description":"Closed, epoch ms"},"duration_ms":{"type":"integer","description":"Holding time (ms)"},"entry_px":{"type":"string","description":"Average entry price (decimal string; may carry extra trailing zeros)"},"exit_px":{"type":"string","description":"Average exit price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size closed (base) (decimal string; may carry extra trailing zeros)"},"max_size":{"type":"string","description":"Largest position size during the trade (decimal string; may carry extra trailing zeros)"},"notional":{"type":["string","null"],"description":"|size| × entry price (USD): the min_notional / sort=notional measure (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Traded notional, entries + exits (USD) (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"PnL before fees and funding (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding over the trade (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees: Σ |fee| (rebates counted as fees) (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net PnL: gross − signed fees + funding (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills"},"maker_fills":{"type":"integer","description":"Maker fills"},"leverage":{"type":["integer","null"],"description":"Leverage (null when not recorded)"},"is_cross":{"type":["boolean","null"],"description":"Cross margin (null when the leverage is not recorded)"},"builder":{"type":["string","null"],"description":"Builder code of the trade's orders; null if none"},"tx_index":{"type":["integer","null"],"description":"Index of the closing transaction in its block"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/completed-trades?sort=net_pnl&limit=20'"}]}},"/v1/accounts/{address}/stats/by-market":{"get":{"operationId":"getWalletStatsByMarket","summary":"Trading statistics per market","description":"Per market traded by the wallet (all time): PnL, fees, net, trades, wins, losses, volume, sum of winning and losing closes.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"pnl":{"type":"string","description":"Gross PnL (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net PnL (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"wins":{"type":"integer","description":"Winning trades"},"losses":{"type":"integer","description":"Losing trades"},"volume":{"type":"string","description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"winning_pnl":{"type":"string","description":"Sum of winning closes (decimal string; may carry extra trailing zeros)"},"losing_pnl":{"type":"string","description":"Sum of losing closes (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/stats/by-market'"}]}},"/v1/accounts/{address}/trade-counts":{"get":{"operationId":"getWalletTradeCounts","summary":"Trade and win counts over 7–365 days","description":"Trades, longs, shorts, wins and losses all-time, and trades and wins over the last 7, 30, 90, 180 and 365 days.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"trades":{"type":"integer","description":"All-time trades"},"long_trades":{"type":"integer","description":"Longs"},"short_trades":{"type":"integer","description":"Shorts"},"wins":{"type":"integer","description":"Winning trades"},"losses":{"type":"integer","description":"Losing trades"},"trades_7d":{"type":"integer","description":"Trades, 7 d"},"trades_30d":{"type":"integer","description":"Trades, 30 d"},"trades_90d":{"type":"integer","description":"Trades, 90 d"},"trades_180d":{"type":"integer","description":"Trades, 180 d"},"trades_365d":{"type":"integer","description":"Trades, 365 d"},"wins_7d":{"type":"integer","description":"Wins, 7 d"},"wins_30d":{"type":"integer","description":"Wins, 30 d"},"wins_90d":{"type":"integer","description":"Wins, 90 d"},"wins_180d":{"type":"integer","description":"Wins, 180 d"},"wins_365d":{"type":"integer","description":"Wins, 365 d"},"last_trade_time":{"type":["integer","null"],"description":"Last trade close, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/trade-counts'"}]}},"/v1/accounts/{address}/risk-metrics":{"get":{"operationId":"getWalletRiskMetrics","summary":"Sharpe, Sortino and drawdowns","description":"Daily-return Sharpe and Sortino over 30/90/180/365 days and maximum drawdown over 7–365 days (as of the latest daily computation).\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"as_of":{"type":"string","description":"Computation date (YYYY-MM-DD)"},"sharpe_30d":{"type":["string","null"],"description":"Sharpe, 30d (decimal string; may carry extra trailing zeros)"},"sortino_30d":{"type":["string","null"],"description":"Sortino, 30d (decimal string; may carry extra trailing zeros)"},"sharpe_90d":{"type":["string","null"],"description":"Sharpe, 90d (decimal string; may carry extra trailing zeros)"},"sortino_90d":{"type":["string","null"],"description":"Sortino, 90d (decimal string; may carry extra trailing zeros)"},"sharpe_180d":{"type":["string","null"],"description":"Sharpe, 180d (decimal string; may carry extra trailing zeros)"},"sortino_180d":{"type":["string","null"],"description":"Sortino, 180d (decimal string; may carry extra trailing zeros)"},"sharpe_365d":{"type":["string","null"],"description":"Sharpe, 365d (decimal string; may carry extra trailing zeros)"},"sortino_365d":{"type":["string","null"],"description":"Sortino, 365d (decimal string; may carry extra trailing zeros)"},"max_drawdown_7d":{"type":["string","null"],"description":"Max drawdown, 7d (fraction) (decimal string; may carry extra trailing zeros)"},"max_drawdown_30d":{"type":["string","null"],"description":"Max drawdown, 30d (fraction) (decimal string; may carry extra trailing zeros)"},"max_drawdown_90d":{"type":["string","null"],"description":"Max drawdown, 90d (fraction) (decimal string; may carry extra trailing zeros)"},"max_drawdown_180d":{"type":["string","null"],"description":"Max drawdown, 180d (fraction) (decimal string; may carry extra trailing zeros)"},"max_drawdown_365d":{"type":["string","null"],"description":"Max drawdown, 365d (fraction) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/risk-metrics'"}]}},"/v1/accounts/{address}/sharpe":{"get":{"operationId":"getWalletSharpe","summary":"Sharpe and Sortino over a date range","description":"Sharpe and Sortino of daily PnL between two UTC dates (≤ 365 days, from 2025-07-29), with the active days counted; `min_active_days` below which the ratios are null. Every range ends at two days before today (UTC) at the latest: yesterday's daily PnL is still being rewritten, so a later `to` is cut there (meta.as_of = that last included date; the row's `last_date` = the range's effective end). A range that starts after meta.as_of returns no row.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"from","in":"query","required":false,"description":"First UTC date (YYYY-MM-DD). Default: 89 days before `to` (the last 90 dates).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"to","in":"query","required":false,"description":"Last UTC date (YYYY-MM-DD). Default: today. Dates after two days before today are not included yet (meta.as_of).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"min_active_days","in":"query","required":false,"description":"Minimum active days for a ratio.","schema":{"type":"integer","minimum":2,"maximum":365,"default":10}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"days":{"type":["integer","null"],"description":"Days in the effective range (first_date … last_date)"},"active_days":{"type":"integer","description":"Days with PnL"},"first_date":{"type":["string","null"],"description":"First date of the range: `from`, or the account's first day if later"},"last_date":{"type":"string","description":"Last date of the range: `to`, or meta.as_of (two days before today, UTC) if earlier"},"pnl":{"type":"string","description":"PnL over the range (decimal string; may carry extra trailing zeros)"},"sharpe":{"type":["string","null"],"description":"Sharpe (annualized) (decimal string; may carry extra trailing zeros)"},"sortino":{"type":["string","null"],"description":"Sortino (annualized) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/sharpe?from=2026-07-01'"}]}},"/v1/accounts/{address}/review":{"get":{"operationId":"getWalletReview","summary":"Trading review by market, month, weekday and hour","description":"Trades closed in [start_time, end_time) (≤ 365 days): totals, then per market, month, day, weekday and UTC hour (`section` + `key`) — trades, wins, losses, net / gross / funding PnL, fees, volume, best and worst trade.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 30 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"section":{"type":"string","description":"total, coin, month, day, dow or hour"},"key":{"type":"string","description":"Group key"},"trades":{"type":"integer","description":"Trades"},"wins":{"type":"integer","description":"Wins"},"losses":{"type":"integer","description":"Losses"},"incomplete":{"type":"integer","description":"Trades still open at the window end"},"net_pnl":{"type":"string","description":"Net PnL (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding PnL (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume (decimal string; may carry extra trailing zeros)"},"best_trade":{"type":["string","null"],"description":"Total section only: best trade as JSON {coin, direction, entry_px, exit_px, size, start_time, end_time, duration_ms, net_pnl}"},"worst_trade":{"type":["string","null"],"description":"Total section only: worst trade (same shape)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/review'"}]}},"/v1/accounts/{address}/highlights":{"get":{"operationId":"getWalletHighlights","summary":"Best, biggest, winning and losing trades","description":"The wallet's notable completed trades opened in the window (≤ 90 days): `best` (highest net PnL, up to 15) and `biggest` (largest absolute net PnL, up to 15); a trade can appear in both.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 30 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"side","in":"query","required":false,"description":"long or short.","schema":{"type":"string","enum":["long","short"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 90 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"best or biggest"},"rank":{"type":"integer","description":"Rank within kind"},"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"open_time":{"type":"integer","description":"Open, epoch ms"},"close_time":{"type":"integer","description":"Close, epoch ms"},"duration_s":{"type":"string","description":"Duration (s) (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Entry size (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Average entry (decimal string; may carry extra trailing zeros)"},"exit_px":{"type":"string","description":"Average exit (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net PnL (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/highlights'"}]}},"/v1/accounts/{address}/markets-traded":{"get":{"operationId":"getWalletMarketsTraded","summary":"Per-market performance over a window","description":"Per market for trades closed in the window (≤ 365 days): volume, gross / net PnL, fees, trades, wins, losses, win rate and the last trade time — most-traded first. Completed-trade (round-trip) PnL: a trade counts once its position is fully closed, so partial closes (trims) and open positions are not included and the numbers can differ from hyperdash.com's profile PnL — that is GET /v1/accounts/{address}/leaderboard.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Markets per page.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 365 days; range ≤ 365 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"volume":{"type":"string","description":"Volume (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net PnL (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"wins":{"type":"integer","description":"Wins"},"losses":{"type":"integer","description":"Losses"},"win_rate_pct":{"type":"string","description":"Wins / trades (%) (decimal string; may carry extra trailing zeros)"},"last_trade_time":{"type":"integer","description":"Last trade, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/markets-traded'"}]}},"/v1/accounts/{address}/pnl-calendar":{"get":{"operationId":"getWalletPnlCalendar","summary":"Daily PnL calendar","description":"Daily PnL like the hyperdash.com PnL calendar, per UTC day from `from` to `to` (at most 366 dates, as the site): the change in the wallet's account value (GET /v1/accounts/{address}/account-value) from the previous close to the day's close minus the capital moved in or out in between. A day's close is its last snapshot (about 23:00 UTC); when that snapshot has a ledger entry of the wallet (any transfer, including its own spot↔perp moves) in the 20 minutes before it and the snapshot before it (about 22:00) has none, the close is that earlier snapshot: the stored value takes transfers in up to about 20 minutes late, so a move just before the close is counted the next day instead, and that as a % of the previous close. The account value is the equity on every perp dex plus the spot wallet for a classic account (with or without an open position), or for unified and portfolio-margin accounts their pooled collateral; it never includes lent tokens, staked HYPE or vault equity. For a unified account (spot and perps share one collateral pool) PnL is the change of that whole pool — available spot USDC, perp equity and its other tokens at their price — minus the capital moved in or out: its moves between spot and perp are internal, and supplying to lending or staking HYPE takes value out. Capital moved: deposits and withdrawals, transfers with other wallets on any side (spot, perp or HIP-3 dex, at their USD value), vault deposits and withdrawals, borrow / lend (supplying or repaying takes value out, withdrawing or borrowing brings it in) and HYPE staking transfers; moves between the wallet's own spot and perp balances are not. Stablecoins count at face value, HYPE and UBTC at the HYPE / BTC perp's close of the last whole minute before the move. Before 2026-09-23 the stored account value is perp equity only and the capital moves are the perp-cash ones (USDC deposits, withdrawals, transfers, spot↔perp); days before 2025-08-25 come from the wallet's fills. When Hyperdash changes how the stored value is computed (2026-11: a classic account with no open position now counts its spot wallet, as a positioned one already did), the one-time step is booked as capital moved, not PnL — except for a wallet that traded or moved capital within about an hour of the switch, and for portfolio-margin accounts (their valuation changed at the same time), whose switch day can carry part of the step. Known limits: from 2026-09-23 until that change, a classic account with no open position was stored without its spot wallet, so on those days its spot-side transfers show as PnL (those stored values cannot be rebuilt); lending interest and staking rewards are not counted as PnL (they arrive with the moves); protocol and treasury wallets (their spot is token supply, left out of their value) do not match their transfers; a unified account emptied to zero keeps its last stored value until it holds funds again; when both of a day's last two snapshots follow a ledger entry by under 20 minutes, the close stays the last one and can miss that move until the next day; idle collateral on a HIP-3 dex without a position is not counted.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 400 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"from","in":"query","required":false,"description":"First UTC date (YYYY-MM-DD). Default: 89 days before `to` (the last 90 dates).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"to","in":"query","required":false,"description":"Last UTC date (YYYY-MM-DD). Default: today.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"UTC date"},"pnl":{"type":"string","description":"Daily change in account value minus the capital moved in or out (USD) (decimal string; may carry extra trailing zeros)"},"pnl_pct":{"type":["string","null"],"description":"pnl as % of the previous close (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/pnl-calendar?from=2026-09-01'"}]}},"/v1/accounts/{address}/builders":{"get":{"operationId":"getWalletBuilders","summary":"Builder fees a wallet paid, per builder code","description":"The wallet's fills sent with a builder code (an app or bot routing its orders, e.g. a trading terminal) whose fill time is in [start_time, end_time], per builder and fee token: fills, orders, notional, the fees paid on those fills and the builder fees among them (what went to the builder; part of `fees`). Highest builder fees first. A fill whose builder fee the node did not report (mostly non-USDC fee tokens) counts in fee_unreported_fills, not in builder_fees. Every fill of the wallet, builder or not, with its fee, builder and builder_fee: GET /v1/accounts/{address}/fills. Builder addresses returned count toward your discovered-wallet allowance, as wherever a response names other wallets. Range ≤ 365 days, data from 2025-07-28 (for longer, add up windows per builder and fee token; both bounds are inclusive, so start each next window at the previous end_time + 1; an order filled across a window boundary counts in both); your plan's history window applies.\n\nPricing: base; ×2 above 30 days, ×8 above 90 days. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 500 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start (fill time, inclusive), epoch ms. Default: end_time − 30 days; range ≤ 365 days. Data starts 2025-07-28.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End (fill time, inclusive), epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"builder":{"type":"string","description":"Builder code (address)"},"fee_token":{"type":"string","description":"Token the fees are paid in (USDC, …)"},"fills":{"type":"integer","description":"Fills sent with this builder"},"orders":{"type":"integer","description":"Orders filled"},"notional":{"type":"string","description":"Filled notional: Σ px × size, in each market's quote (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees paid on these fills, builder fees included (maker rebates negative) (decimal string; may carry extra trailing zeros)"},"builder_fees":{"type":"string","description":"Builder fees: the part of `fees` that went to the builder (decimal string; may carry extra trailing zeros)"},"fee_unreported_fills":{"type":"integer","description":"Fills whose builder fee the node did not report (not counted in builder_fees)"},"first_fill":{"type":"integer","description":"First fill in the window, epoch ms"},"last_fill":{"type":"integer","description":"Last fill in the window, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/builders'"}]}},"/v1/accounts/{address}/copy-score":{"get":{"operationId":"getWalletCopyScore","summary":"Copy score and its factors","description":"How copyable the wallet's trading is (0–100) with every factor and input: quality, replicability, consistency, drawdown, volatility, PnL, fills and holding behaviour over 90 days. No row when the wallet has too little history.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"as_of":{"type":"string","description":"Computation date"},"copy_score":{"type":"string","description":"Score 0–100 (decimal string; may carry extra trailing zeros)"},"copy_score_raw":{"type":"string","description":"Score before shrinkage (decimal string; may carry extra trailing zeros)"},"quality":{"type":"string","description":"Quality factor (q) (decimal string; may carry extra trailing zeros)"},"gate":{"type":"integer","description":"Gate (g): 1 = eligible"},"consistency":{"type":"string","description":"Consistency (c) (decimal string; may carry extra trailing zeros)"},"replicability":{"type":"string","description":"Replicability (decimal string; may carry extra trailing zeros)"},"activity":{"type":"string","description":"Activity (a) (decimal string; may carry extra trailing zeros)"},"skill":{"type":"string","description":"Skill (k) (decimal string; may carry extra trailing zeros)"},"drawdown_factor":{"type":"string","description":"Drawdown (d) (decimal string; may carry extra trailing zeros)"},"volatility_factor":{"type":"string","description":"Volatility (v) (decimal string; may carry extra trailing zeros)"},"pnl_factor":{"type":"string","description":"PnL (p) (decimal string; may carry extra trailing zeros)"},"sortino_90d":{"type":["string","null"],"description":"Sortino, 90 d (decimal string; may carry extra trailing zeros)"},"pnl_90d":{"type":"string","description":"PnL, 90 d (decimal string; may carry extra trailing zeros)"},"lifetime_pnl":{"type":"string","description":"Lifetime PnL (decimal string; may carry extra trailing zeros)"},"fills_90d":{"type":"integer","description":"Fills, 90 d"},"orders_per_day":{"type":"string","description":"Orders per day (decimal string; may carry extra trailing zeros)"},"maker_share":{"type":"string","description":"Maker share (decimal string; may carry extra trailing zeros)"},"short_hold_share":{"type":"string","description":"Share of very short holds (decimal string; may carry extra trailing zeros)"},"algo":{"type":"boolean","description":"Looks algorithmic"},"delay_cost_90d":{"type":"string","description":"Cost of copying with a delay, 90 d (decimal string; may carry extra trailing zeros)"},"fee_drag_90d":{"type":"string","description":"Fee drag, 90 d (decimal string; may carry extra trailing zeros)"},"round_trips_90d":{"type":"integer","description":"Round trips, 90 d"},"fill_days_90d":{"type":"integer","description":"Days with fills, 90 d"},"weeks_with_pnl":{"type":"integer","description":"Weeks with PnL"},"winning_week_share":{"type":"string","description":"Winning weeks share (decimal string; may carry extra trailing zeros)"},"active_days_14d":{"type":"integer","description":"Active days, 14 d"},"equity_p50":{"type":"string","description":"Median equity (decimal string; may carry extra trailing zeros)"},"max_drawdown_90d":{"type":["string","null"],"description":"Max drawdown, 90 d (decimal string; may carry extra trailing zeros)"},"volatility_90d":{"type":"string","description":"Volatility, 90 d (decimal string; may carry extra trailing zeros)"},"twr_drawdown_90d":{"type":"string","description":"Time-weighted drawdown, 90 d (decimal string; may carry extra trailing zeros)"},"underwater":{"type":"string","description":"Share of time under water (decimal string; may carry extra trailing zeros)"},"sortino_weighted":{"type":"string","description":"Weighted Sortino (decimal string; may carry extra trailing zeros)"},"evidence_days":{"type":"string","description":"Evidence days (decimal string; may carry extra trailing zeros)"},"record_days":{"type":"integer","description":"Record days"},"computed_at":{"type":"string","description":"Computed at (UTC)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/copy-score'"}]}},"/v1/accounts/{address}/year-summary":{"get":{"operationId":"getWalletYearSummary","summary":"Year in review: trader class and percentiles","description":"Hyperdash's year in review, built once per year: only 2025 exists today (one build, `computed_at` 2026-10-09; no 2026 row before a 2026 build). `pnl`, `volume`, `trades` and their percentiles cover the wallet's completed trades closed in that year. The trader class, its reason, `win_rate`, `taker_ratio`, `trades_per_day` and `median_hold_s` are NOT yearly: they are the wallet's lifetime stats as of `computed_at` (the class inputs); `sharpe_30d` is the wallet's cached trailing 30-day Sharpe at the build. Every wallet with stats at the build has a row, so a wallet with no trade in the year shows trades 0 next to its lifetime rates.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 20 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer","description":"Year of pnl / volume / trades and their percentiles (2025 only today)"},"trader_class":{"type":"string","description":"Class, from lifetime stats as of computed_at"},"reason":{"type":"string","description":"Why this class"},"pnl":{"type":"string","description":"Completed-trade PnL closed in the year (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Completed-trade volume closed in the year (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Completed trades closed in the year"},"pnl_percentile":{"type":"string","description":"PnL percentile in the year (0 without a trade in it) (decimal string; may carry extra trailing zeros)"},"volume_percentile":{"type":"string","description":"Volume percentile in the year (decimal string; may carry extra trailing zeros)"},"trades_percentile":{"type":"string","description":"Trades percentile in the year (decimal string; may carry extra trailing zeros)"},"win_rate":{"type":"string","description":"Win rate, lifetime as of computed_at (not the year's) (decimal string; may carry extra trailing zeros)"},"sharpe_30d":{"type":"string","description":"The wallet's cached trailing 30-day Sharpe at the build (its window ends about two days before its own refresh), not the year's (decimal string; may carry extra trailing zeros)"},"taker_ratio":{"type":"string","description":"Taker share of all fills, lifetime as of computed_at (decimal string; may carry extra trailing zeros)"},"trades_per_day":{"type":"string","description":"Completed trades per day between the first and last trade, lifetime as of computed_at (decimal string; may carry extra trailing zeros)"},"median_hold_s":{"type":"string","description":"Volume-weighted median hold (s), lifetime as of computed_at (decimal string; may carry extra trailing zeros)"},"computed_at":{"type":"string","description":"Computed at (UTC)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/year-summary'"}]}},"/v1/accounts/{address}/window-stats":{"get":{"operationId":"getWalletWindowStats","summary":"Completed-trade PnL over 24 h / 7 d / 30 d / 90 d / YTD / all time","description":"Net / gross / funding PnL, volume, trades, wins and losses of the trades closed in one window (ytd: since 1 January, UTC), optionally for one market; no row when none closed. Completed-trade (round-trip) PnL: a trade counts once its position is fully closed, so partial closes (trims) and open positions are not included and the numbers can differ from hyperdash.com's profile PnL — that is GET /v1/accounts/{address}/leaderboard.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"window","in":"query","required":false,"description":"Window (ytd: trades closed since 1 January, UTC).","schema":{"type":"string","default":"7d","enum":["24h","7d","30d","90d","ytd","alltime"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"net_pnl":{"type":"string","description":"Net PnL (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"wins":{"type":"integer","description":"Wins"},"losses":{"type":"integer","description":"Losses"},"last_trade_at":{"type":["string","null"],"description":"Last trade (UTC)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/window-stats?window=30d'"}]}},"/v1/accounts/{address}/upnl-rank":{"get":{"operationId":"getWalletUpnlRank","summary":"Rank by unrealized PnL","description":"The wallet's current unrealized PnL and its rank among all traders with open positions (1 = largest), optionally within an asset category.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"category","in":"query","required":false,"description":"Asset category.","schema":{"type":"string","default":"all","enum":["all","crypto","majors","memes","alts","equities","indices","commodities","fx"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"unrealized_pnl":{"type":"string","description":"Unrealized PnL (decimal string; may carry extra trailing zeros)"},"rank":{"type":"integer","description":"Rank (1 = largest)"},"traders":{"type":"integer","description":"Traders ranked"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/upnl-rank'"}]}},"/v1/accounts/{address}/leaderboard":{"get":{"operationId":"getWalletLeaderboard","summary":"The wallet's PnL leaderboard row (rank, net / realized / unrealized PnL, ROI)","description":"The wallet's own row on hyperdash.com's PnL leaderboard (GET /v1/leaderboards/pnl, or the per-market board with `coin`): rank for the chosen sort, net PnL with its realized / unrealized split, capital and ROI over the window — the numbers of the site's profile Performance card. Portfolio PnL: partial closes and open positions count (unlike the completed-trade statistics routes). No row when the wallet is not ranked on that board and sort. Cached up to 1 min.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"window","in":"query","required":false,"description":"Window.","schema":{"type":"string","default":"alltime","enum":["alltime","24h","7d","30d","ytd"]}},{"name":"category","in":"query","required":false,"description":"Asset category (all-markets board; omit with coin).","schema":{"type":"string","default":"all","enum":["all","crypto","majors","memes","alts","equities","indices","commodities","fx"]}},{"name":"sort","in":"query","required":false,"description":"Ranked metric: total (net PnL), realized, unrealized, or their ROI (÷ capital; wallets with capital ≥ $1,000). Wallets without that value are not ranked.","schema":{"type":"string","default":"total","enum":["total","realized","unrealized","roi","realized_roi","unrealized_roi"]}},{"name":"coin","in":"query","required":false,"description":"One market's board instead of a category, e.g. BTC, xyz:GOLD (case-sensitive).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank on the board for the sort (1 = best)"},"net_pnl":{"type":"string","description":"Net PnL over the window (USD) (decimal string; may carry extra trailing zeros)"},"realized_pnl":{"type":["string","null"],"description":"Realized PnL over the window (USD): closed PnL − fees + funding, partial closes included (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Change in open-position unrealized PnL over the window (USD); all time: open unrealized PnL now (decimal string; may carry extra trailing zeros)"},"capital":{"type":["string","null"],"description":"Capital (USD): equity at the window start + peak net external inflow (decimal string; may carry extra trailing zeros)"},"roi":{"type":["string","null"],"description":"Net PnL ÷ capital (ratio: 0.417 = 41.7 %) (decimal string; may carry extra trailing zeros)"},"realized_roi":{"type":["string","null"],"description":"Realized PnL ÷ capital (ratio) (decimal string; may carry extra trailing zeros)"},"unrealized_roi":{"type":["string","null"],"description":"Unrealized PnL ÷ capital (ratio) (decimal string; may carry extra trailing zeros)"},"display_name":{"type":["string","null"],"description":"Display name"},"tag":{"type":["string","null"],"description":"Trader tag"},"gross_pnl":{"type":["string","null"],"description":"Gross PnL before fees and funding (USD) (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":["string","null"],"description":"Funding PnL (decimal string; may carry extra trailing zeros)"},"total_fees":{"type":["string","null"],"description":"Fees (decimal string; may carry extra trailing zeros)"},"volume":{"type":["string","null"],"description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"trades":{"type":["integer","null"],"description":"Completed trades"},"winning_trades":{"type":["integer","null"],"description":"Winning trades"},"losing_trades":{"type":["integer","null"],"description":"Losing trades"},"account_value":{"type":["string","null"],"description":"Account value on the board (hourly snapshot, USD) (decimal string; may carry extra trailing zeros)"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"label":{"type":["string","null"],"description":"Hyperdash label"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"verified":{"type":["boolean","null"],"description":"Verified profile"},"copy_score":{"type":["string","null"],"description":"Copy score (0–100) (decimal string; may carry extra trailing zeros)"},"mark_quality":{"type":["integer","null"],"description":"Quality of the mark behind the unrealized part (1 = live mark of every open position, 0 = some fell back)"},"window_start":{"type":["integer","null"],"description":"Board window start, epoch ms (null for all time)"},"as_of":{"type":["integer","null"],"description":"Board computed at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/leaderboard?window=30d'"}]}},"/v1/accounts/{address}/staked-hype":{"get":{"operationId":"getWalletStakedHype","summary":"Delegated HYPE at a past time","description":"HYPE the wallet had delegated at `time`, from Hyperdash's committed staking snapshots (the latest at or before `time`). History starts 2026-10-11 11:15:40.723 UTC (the first committed staking baseline, epoch ms 1791717340723): an earlier `time` is refused with 400 `invalid_parameter`. No row = the wallet had no HYPE delegated at `time`.\n\nPricing: base. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"time","in":"query","required":true,"description":"Epoch ms, at or after 1791717340723 (2026-10-11 11:15:40.723 UTC) and not in the future.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"hype":{"type":"string","description":"Delegated HYPE (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/staked-hype?time=1793000000000'"}]}},"/v1/accounts/{address}/order-fills":{"get":{"operationId":"getWalletOrderFills","summary":"Order history with each order's fills","description":"Orders that filled in [start_time, end_time) (≤ 1 day per query; query earlier windows for older orders), newest first, grouped by order id: side, total size, average price, notional, closed PnL, fees and up to 50 fills each. `limit` orders per page; page with the cursor.\n\nPricing: base + per order (≤ 1 day per query). Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Orders per page.","schema":{"type":"integer","minimum":1,"maximum":99,"default":50}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 1 day; range ≤ 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","description":"Order id"},"coin":{"type":"string","description":"Market"},"time":{"type":"integer","description":"Last fill of the order, epoch ms"},"first_time":{"type":"integer","description":"First fill, epoch ms"},"start_position":{"type":"string","description":"Position before the order (decimal string; may carry extra trailing zeros)"},"direction":{"type":"string","description":"First fill's direction (Open Long, Close Short, …)"},"side":{"type":"string","description":"B = buy, A = sell"},"size":{"type":"string","description":"Filled size (decimal string; may carry extra trailing zeros)"},"avg_px":{"type":["string","null"],"description":"Average fill price (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":"string","description":"Closed PnL (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"fill_count":{"type":"integer","description":"Fills"},"fills":{"type":"string","description":"JSON array of up to 50 fills: {time, px, sz, closed_pnl}"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/order-fills?limit=20'"}]}},"/v1/accounts/{address}/outcomes":{"get":{"operationId":"getWalletOutcomes","summary":"HIP-4 outcome record per market","description":"Per HIP-4 outcome the wallet traded: Yes / No shares and their cost basis, realized PnL, fees, notional, fills, settlement and net PnL. On a settled outcome the shares and basis are the position held at settlement (Hyperliquid then redeems it) and what it cost; the settlement result is `settlement_pnl` (shares × payout − basis, Hyperliquid's Settlement fills), not part of `realized_pnl`; `net_pnl` = `realized_pnl` + `settlement_pnl` − `usdc_fees`. Split, merge and negate actions count as position changes. Growth and above (heavy: cached 5 min).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Outcomes per page.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"outcome":{"type":"string","description":"Outcome id"},"yes_shares":{"type":"string","description":"Yes shares held (settled outcome: held at settlement) (decimal string; may carry extra trailing zeros)"},"no_shares":{"type":"string","description":"No shares held (settled outcome: held at settlement) (decimal string; may carry extra trailing zeros)"},"yes_basis":{"type":"string","description":"What the Yes shares held cost (USD) (decimal string; may carry extra trailing zeros)"},"no_basis":{"type":"string","description":"What the No shares held cost (USD) (decimal string; may carry extra trailing zeros)"},"realized_pnl":{"type":"string","description":"Realized gross PnL of trades, splits and merges (the settlement result is settlement_pnl) (decimal string; may carry extra trailing zeros)"},"usdc_fees":{"type":"string","description":"Fees (USDC), settlement fees included (decimal string; may carry extra trailing zeros)"},"share_fees":{"type":"string","description":"Fees (shares) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Yes-space taker notional of trades (settlement / split / merge fills excluded) (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills, settlement / split / merge fills included"},"first_fill_time":{"type":"integer","description":"First fill, epoch ms"},"last_fill_time":{"type":"integer","description":"Last fill, epoch ms"},"settled":{"type":"boolean","description":"Outcome settled"},"settle_fraction":{"type":"string","description":"Settlement fraction (decimal string; may carry extra trailing zeros)"},"settlement_pnl":{"type":"string","description":"Settlement PnL: yes_shares × settle_fraction + no_shares × (1 − settle_fraction) − yes_basis − no_basis (per side Hyperliquid's Settlement fills' closed PnL); 0 while settled is false. settled, settle_fraction, settlement_pnl and result follow Hyperdash's outcome registry, which sees a settlement about 20–30 s after its Settlement fills (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net PnL: realized_pnl + settlement_pnl − usdc_fees (decimal string; may carry extra trailing zeros)"},"result":{"type":"string","description":"Result"},"balance_status":{"type":"string","description":"Balance check status"},"balance_checked_at":{"type":["integer","null"],"description":"When the share balance was last checked against the node, epoch ms (null for estimated rows)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/outcomes'"}]}},"/v1/accounts/{address}/copy-activity":{"get":{"operationId":"getWalletCopyActivity","summary":"Daily copy-cost inputs","description":"Per UTC day with a perp fill or a closed round trip, the inputs behind the copy score: fills, manual orders (distinct non-TWAP order ids), notional and its maker part, fees paid (rebates negative), delay cost (re-executing each fill at its minute's close, signed) over the notional that had a candle, round trips closed and their notional (and the part held under 1 h). The last two days are recomputed on every refresh (`computed_at`). Oldest first.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 365 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"from","in":"query","required":false,"description":"First UTC date (YYYY-MM-DD). Default: 29 days before `to` (the last 30 dates); at most 365 dates.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"to","in":"query","required":false,"description":"Last UTC date (YYYY-MM-DD). Default: today.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","description":"UTC date"},"fills":{"type":"integer","description":"Perp fills"},"orders_manual":{"type":"integer","description":"Distinct non-TWAP orders filled"},"notional":{"type":"string","description":"Filled notional (USD) (decimal string; may carry extra trailing zeros)"},"maker_notional":{"type":"string","description":"Maker part of the notional (USD) (decimal string; may carry extra trailing zeros)"},"fees_paid":{"type":"string","description":"Fees paid (USD; rebates negative) (decimal string; may carry extra trailing zeros)"},"delay_cost":{"type":"string","description":"Cost of re-executing each fill at its minute's close (USD, signed) (decimal string; may carry extra trailing zeros)"},"priced_notional":{"type":"string","description":"Notional with a candle to price the delay (USD) (decimal string; may carry extra trailing zeros)"},"trips":{"type":"integer","description":"Round trips closed"},"trip_notional":{"type":"string","description":"Notional of the round trips closed (USD) (decimal string; may carry extra trailing zeros)"},"trip_notional_under_1h":{"type":"string","description":"Part of it held under 1 h (USD) (decimal string; may carry extra trailing zeros)"},"computed_at":{"type":"integer","description":"Row computed at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/copy-activity?from=2026-10-01'"}]}},"/v1/accounts/{address}/realized-pnl":{"get":{"operationId":"getAccountRealizedPnl","summary":"Realized PnL series","description":"A wallet's cumulative realized perp PnL over a window: the realized line (rPnL) of hyperdash.com's profile PnL chart, computed by Hyperdash from its own fills and funding. Realized = closed PnL − fees (every fee token at face value; rebates add) + funding; spot and outcome fills are excluded. Funding before 2025-09-27 10:00 UTC comes from each completed trade's funding, booked at its close (a trade open across that instant has the part before it booked at 09:59:59.999). Rows: start_time, then the running total at the end of each `interval` bucket with activity that ends before end_time (buckets count from start_time; pass a UTC-aligned start_time for UTC hours / days), then end_time. The series starts at 0, or with `anchor=true` on the wallet's All Time leaderboard realized PnL (the board's value at its last refresh minus what the series adds between start_time and then); `anchored` says whether that applied (the wallet has a board row with a realized split, and start_time is not after the board's refresh). Known limit: a self-matched fill counts one leg, except on the full UTC days the daily table serves (below) from 2025-07-28, where it counts both legs. `interval` sets the bucket and the range: 5m (default the last day, ≤ 7 days), 1h (default 7 days, ≤ 90 days), 1d (default 90 days, ≤ 365 days). 1d whose window is longer than 90 days, or with `anchor=true` whose start_time is more than 90 days and 10 minutes before now, reads Hyperdash's certified daily table: buckets are UTC days (points at the UTC midnight after each active day), and while a day the range needs is being rebuilt the call answers 503 `unavailable` (retry later, or read ≤ 90 days). `anchor=true` reads every fill from start_time up to now (whatever end_time), so start_time must then be within that bound of now, and the range that counts for this call is start_time → now, not start_time → end_time. One page.\n\nPricing: base × range tier (≤1 d ×1, ≤7 d ×3, ≤30 d ×10, ≤90 d ×25, ≤365 d ×25 with interval 1d); with anchor=true the range is start_time → now whatever end_time (the anchor reads every fill up to now; quote with range_ms = now − start_time); a range containing 2025-09-27 09:59:59.999 UTC (the funding-source correction, which reads the trades open across it) is priced as at least 30 days. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size: 5m, 1h or 1d (sets the default and maximum range).","schema":{"type":"string","default":"1h","enum":["5m","1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day (5m), 7 days (1h) or 90 days (1d).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive: activity before it). Default: now.","schema":{"type":"integer"}},{"name":"anchor","in":"query","required":false,"description":"true: place the series on the wallet's All Time leaderboard realized PnL. Reads up to now: the range that counts is start_time → now, not start_time → end_time. Default: from 0.","schema":{"type":"string","default":"false","enum":["false","true"]}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Point time, epoch ms: start_time, a bucket's end, or end_time"},"realized_pnl":{"type":"string","description":"Cumulative realized PnL at t (USD) (decimal string; may carry extra trailing zeros)"},"anchored":{"type":"boolean","description":"Placed on the All Time leaderboard's realized PnL"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/realized-pnl?interval=1h&anchor=true'"}]}},"/v1/accounts/profiles":{"get":{"operationId":"getWalletProfiles","summary":"Public profiles of up to 100 wallets","description":"The public hyperdash.com profile fields (display name, avatar, X handle, Hyperdash tag, verified, label) of up to 100 wallets in one call, as the site shows them next to a wallet. Only wallets with at least one field set are returned. Every listed wallet counts as a queried wallet.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"addresses","in":"query","required":true,"description":"Comma-separated wallets (0x + 40 hex), 1..100. Every listed wallet counts as a queried wallet.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}(,0x[0-9a-fA-F]{40}){0,99}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"display_name":{"type":["string","null"],"description":"Public hyperdash.com display name"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"tag":{"type":["string","null"],"description":"Hyperdash trader tag (e.g. intraday)"},"verified":{"type":"boolean","description":"Verified profile"},"label":{"type":["string","null"],"description":"Hyperdash label"},"updated_at":{"type":"integer","description":"Profile synced at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/profiles?addresses=0x…,0x…'"}]}},"/v1/accounts/batch/stats":{"get":{"operationId":"getAccountsBatchStats","summary":"Trader stats of up to 100 wallets","description":"The trader-screener row (PnL windows, win rates, Sharpe / Sortino, drawdowns, trade counts, copy scores, account value, profile) of up to 100 wallets at once — the site's multi-wallet stats. Wallets without a ranked stats row are omitted. Each wallet's stats row is rebuilt about once a day, at a wallet-specific time (every 24–26 h), so its 24-hour, 7-day and 30-day PnL windows end around that rebuild, not now: `updated_at` is when the row was computed (some inputs, e.g. account value, can be older still). Every listed wallet counts as a queried wallet.\n\nPricing: flat per call. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"addresses","in":"query","required":true,"description":"Comma-separated wallets (0x + 40 hex), 1..100. Every listed wallet counts as a queried wallet.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}(,0x[0-9a-fA-F]{40}){0,99}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"pnl_day":{"type":"string","description":"Perp PnL, 24 h (decimal string; may carry extra trailing zeros)"},"pnl_week":{"type":"string","description":"Perp PnL, 7 d (decimal string; may carry extra trailing zeros)"},"pnl_month":{"type":"string","description":"Perp PnL, 30 d (decimal string; may carry extra trailing zeros)"},"pnl_alltime":{"type":"string","description":"Perp PnL, all time (decimal string; may carry extra trailing zeros)"},"total_trades":{"type":"integer","description":"Completed trades"},"trades_7d":{"type":"integer","description":"Trades, 7 d"},"trades_30d":{"type":"integer","description":"Trades, 30 d"},"long_trades":{"type":"integer","description":"Long trades"},"short_trades":{"type":"integer","description":"Short trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"winrate":{"type":"string","description":"Win rate, lifetime (all completed trades) (decimal string; may carry extra trailing zeros)"},"winrate_7d":{"type":["string","null"],"description":"Win rate, 7 d (decimal string; may carry extra trailing zeros)"},"winrate_30d":{"type":["string","null"],"description":"Win rate, 30 d (hyperdash.com Explore's Win Rate column) (decimal string; may carry extra trailing zeros)"},"winrate_90d":{"type":["string","null"],"description":"Win rate, 90 d (decimal string; may carry extra trailing zeros)"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"last_fill_at":{"type":["integer","null"],"description":"Last fill, epoch ms"},"account_value":{"type":["string","null"],"description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"notional":{"type":["string","null"],"description":"Open notional (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"display_name":{"type":["string","null"],"description":"Display name"},"twitter":{"type":["string","null"],"description":"Twitter handle"},"tag":{"type":["string","null"],"description":"Tag"},"verified":{"type":"boolean","description":"Verified profile"},"label":{"type":["string","null"],"description":"Label"},"sharpe_7d":{"type":["string","null"],"description":"Sharpe, 7 d (decimal string; may carry extra trailing zeros)"},"sharpe_30d":{"type":["string","null"],"description":"Sharpe, 30 d (decimal string; may carry extra trailing zeros)"},"sortino_7d":{"type":["string","null"],"description":"Sortino, 7 d (decimal string; may carry extra trailing zeros)"},"sortino_30d":{"type":["string","null"],"description":"Sortino, 30 d (decimal string; may carry extra trailing zeros)"},"sortino_90d":{"type":["string","null"],"description":"Sortino, 90 d (decimal string; may carry extra trailing zeros)"},"max_drawdown_week":{"type":["string","null"],"description":"Max drawdown, 7 d (decimal string; may carry extra trailing zeros)"},"max_drawdown_month":{"type":["string","null"],"description":"Max drawdown, 30 d (decimal string; may carry extra trailing zeros)"},"max_drawdown_90d":{"type":["string","null"],"description":"Max drawdown, 90 d (decimal string; may carry extra trailing zeros)"},"gpr_7d":{"type":["string","null"],"description":"Gain-to-pain, 7 d (decimal string; may carry extra trailing zeros)"},"gpr_30d":{"type":["string","null"],"description":"Gain-to-pain, 30 d (decimal string; may carry extra trailing zeros)"},"gpr_90d":{"type":["string","null"],"description":"Gain-to-pain, 90 d (decimal string; may carry extra trailing zeros)"},"gpr_all_time":{"type":["string","null"],"description":"Gain-to-pain, all time (decimal string; may carry extra trailing zeros)"},"copy_score":{"type":["string","null"],"description":"Copy score (decimal string; may carry extra trailing zeros)"},"copy_score_v2":{"type":["string","null"],"description":"Copy score v2 (decimal string; may carry extra trailing zeros)"},"top_assets":{"type":"string","description":"Top assets (JSON: coin, volume, pnl)"},"total_volume":{"type":["string","null"],"description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"updated_at":{"type":"integer","description":"When this wallet's stats row was computed, epoch ms (about once a day per wallet; some inputs, e.g. account value, can be older)"},"avatar":{"type":["string","null"],"description":"Avatar image URL"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/batch/stats?addresses=0x…,0x…'"}]}},"/v1/vaults/{vault}/history":{"get":{"operationId":"getVaultHistory","summary":"One vault over time","description":"The vault's followers, closed / deposits flags and leader commission per complete node-state snapshot (hourly), oldest first. From our nodes' state snapshots (validators, tokens and vaults hourly; referrers daily), first published 2026-11-05 20:40 UTC. A snapshot still being written is left out until complete; none in the window (or an unknown vault): empty. Range ≤ 90 days.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["vaults"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"vault","in":"path","required":true,"description":"Vault address, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":2400,"default":720}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 30 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"snapshot_time":{"type":"integer","description":"Snapshot, epoch ms"},"followers":{"type":"integer","description":"Followers"},"is_closed":{"type":["boolean","null"],"description":"Closed"},"allow_deposits":{"type":["boolean","null"],"description":"Deposits allowed"},"leader_commission":{"type":["string","null"],"description":"Leader commission (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/vaults/0xdfc24b077bc1425ad1dea75bcb6f8158e10df303/history'"}]}},"/v1/liquidations/series":{"get":{"operationId":"getLiquidationSeries","summary":"Exact liquidations per bucket and side","description":"Liquidated notional, closed PnL and events per bucket and side (long, short, other = rare backstop rows), for all markets, one market or one asset class. Every liquidated account counts, including the system backstop account (the xyz-market backstop account 0x4000000000000000000000000000000000000001, which takes over liquidated positions and is liquidated on them in turn): hyperdash.com's liquidation totals default to traders only, which is GET /v1/liquidations/by-market's trader_* columns. Exact sums (decimal strings) from Hyperdash's re-aggregated levels plus raw edges; meta.as_of = exclusive end of the data, meta.start_time / end_time = the window actually covered.\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 6,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"asset_class","in":"query","required":false,"description":"Asset class: majors, alts, xyz or dex:<name>.","schema":{"type":"string","pattern":"^(majors|alts|xyz|spot|dex:[a-z0-9]{1,16})$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day (1h) / 30 days (1d). Range ≤ 30 days hourly, 365 days daily.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms (UTC hour or day)"},"side":{"type":"string","description":"long, short or other"},"notional":{"type":"string","description":"Liquidated notional (USD) (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":["string","null"],"description":"Closed PnL (USD); null before 2025-05-25 14:23 UTC (decimal string; may carry extra trailing zeros)"},"events":{"type":"integer","description":"Liquidation fills"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations/series?interval=1h'"}]}},"/v1/markets/funding/flows":{"get":{"operationId":"getFundingFlows","summary":"Funding paid and received by side","description":"Funding paid and received by longs and shorts per UTC hour (one settlement each; sum hours for days), with payments and the exact number of paying / earning wallets, across all markets or in one market. Exact sums (decimal strings) from Hyperdash's re-aggregated levels plus raw edges; meta.as_of = exclusive end of the data, meta.start_time / end_time = the window actually covered.\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day. Range ≤ 1 day; snapped outward to whole hours.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms (UTC hour or day)"},"side":{"type":"string","description":"long or short"},"paid":{"type":"string","description":"Funding paid (USD) (decimal string; may carry extra trailing zeros)"},"received":{"type":"string","description":"Funding received (USD) (decimal string; may carry extra trailing zeros)"},"payments":{"type":"integer","description":"Funding payments"},"payers":{"type":"integer","description":"Wallets that paid"},"earners":{"type":"integer","description":"Wallets that received"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/funding/flows'"}]}},"/v1/cohorts/flows":{"get":{"operationId":"getCohortFlows","summary":"Taker flows by account-size cohort","description":"Taker buy and sell notional and taker fills per account-size cohort (the taker's cohort at the time of the fill; `unknown` before its first classification) per bucket, for all markets, one market or one asset class; cohort CVD = running sum of buy − sell. Wallet counts are not recorded for flows. Exact sums (decimal strings) from Hyperdash's re-aggregated levels plus raw edges; meta.as_of = exclusive end of the data, meta.start_time / end_time = the window actually covered.\n\nPricing: flat. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"asset_class","in":"query","required":false,"description":"Asset class: majors, alts, xyz, dex:<name> (perps only).","schema":{"type":"string","pattern":"^(majors|alts|xyz|spot|dex:[a-z0-9]{1,16})$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day; one market daily: 7 days. Range ≤ 1 day for all markets or an asset class; one market: 7 days hourly, 30 days daily.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms (UTC hour or day)"},"cohort":{"type":"string","description":"Account-size cohort of the taker"},"taker_buy_notional":{"type":"string","description":"Taker buy notional (USD) (decimal string; may carry extra trailing zeros)"},"taker_sell_notional":{"type":"string","description":"Taker sell notional (USD) (decimal string; may carry extra trailing zeros)"},"taker_fills":{"type":"integer","description":"Taker fills"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/flows?coin=BTC&interval=1h'"}]}},"/v1/network/fees":{"get":{"operationId":"getExchangeFees","summary":"Exchange fees and volume","description":"Per quote token: taker buy/sell notional, fees paid, maker rebates, builder fees, trades and fills — per bucket and segment (core, spot, outcome, dex:<name>; `by=segment`) or as window totals per market (`by=market`). Net exchange fees = fees − builder fees + rebates (GET /v1/network/revenue's fees_usd keeps builder fees in). Exact sums (decimal strings) from Hyperdash's re-aggregated levels plus raw edges; meta.as_of = exclusive end of the data, meta.start_time / end_time = the window actually covered. Hyperliquid's daily spot dust conversion (every UTC day at 00:00, a sell of small spot balances with no buyer) is not a trade, as on Hyperliquid's candles: it is in neither trades nor the taker notionals, but stays in fills (older 00:00 UTC spot buckets may still include it).\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"by","in":"query","required":false,"description":"segment (per bucket) or market (window totals; window ≤ 7 days, default 7 days).","schema":{"type":"string","default":"segment","enum":["segment","market"]}},{"name":"segment","in":"query","required":false,"description":"One segment (omit for all).","schema":{"type":"string","pattern":"^(core|spot|outcome|dex:[a-z0-9]{1,16})$"}},{"name":"coin","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day (1h) / 7 days (1d). Range ≤ 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":["integer","null"],"description":"Bucket start, epoch ms (null for by=market)"},"key":{"type":"string","description":"Segment or market"},"quote_token":{"type":"string","description":"Quote token"},"taker_buy_notional":{"type":"string","description":"Taker buy notional (decimal string; may carry extra trailing zeros)"},"taker_sell_notional":{"type":"string","description":"Taker sell notional (decimal string; may carry extra trailing zeros)"},"fees_paid":{"type":"string","description":"Fees paid (decimal string; may carry extra trailing zeros)"},"maker_rebates":{"type":"string","description":"Maker rebates (negative) (decimal string; may carry extra trailing zeros)"},"builder_fees":{"type":"string","description":"Builder fees (part of fees paid) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades (taker legs; not the daily spot dust conversion)"},"fills":{"type":"integer","description":"Fills (every fill, dust conversions included)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/fees?interval=1d'"}]}},"/v1/network/active-traders":{"get":{"operationId":"getActiveTraders","summary":"Exact active traders","description":"Distinct wallets that traded per bucket, for all markets (*), one segment (seg:core, seg:spot, seg:outcome, seg:dex:<name>) or one market; meta.window_traders = distinct over the whole window. Exact sums (decimal strings) from Hyperdash's re-aggregated levels plus raw edges; meta.as_of = exclusive end of the data, meta.start_time / end_time = the window actually covered.\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"scope","in":"query","required":false,"description":"*, seg:<segment> or one market.","schema":{"type":"string","pattern":"^(\\*|seg:(core|spot|outcome|dex:[a-z0-9]{1,16})|[A-Za-z0-9@:/._-]{1,64})$","default":"*"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day (1h) / 7 days (1d). Range ≤ 1 day hourly, 7 days daily.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms (UTC hour or day)"},"traders":{"type":"integer","description":"Distinct trading wallets"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/active-traders?interval=1d'"}]}},"/v1/network/bridge-flows":{"get":{"operationId":"getBridgeFlows","summary":"Bridge deposits and withdrawals","description":"USDC deposits (in) and withdrawals (out) through the Arbitrum bridge per bucket: amount, withdrawal fees, transfers. Exact sums (decimal strings) from Hyperdash's re-aggregated levels plus raw edges; meta.as_of = exclusive end of the data, meta.start_time / end_time = the window actually covered.\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 4,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day (1h) / 30 days (1d). Range ≤ 30 days hourly, 365 days daily.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms (UTC hour or day)"},"route":{"type":"string","description":"Bridge route"},"token":{"type":"string","description":"Token"},"direction":{"type":"string","description":"in or out"},"amount":{"type":"string","description":"Amount (decimal string; may carry extra trailing zeros)"},"fee":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"transfers":{"type":"integer","description":"Transfers"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/bridge-flows'"}]}},"/v1/markets/{coin}/volatility":{"get":{"operationId":"getRealizedVolatility","summary":"Realized volatility of one market","description":"Annualized realized volatility per complete hour or UTC day from 1-minute log returns: sqrt(Σr² / n × 525,600) × 100, with the inputs (Σr², n) so windows can be combined. Up to the last complete hour (meta.as_of). The 1-minute closes are those of the durable 1m candle store (GET /v1/markets/{coin}/candles at 1m for minutes older than about 30 minutes): the last trade, with trades inside one millisecond ordered by taker order and sweep position (the execution order on all but about 0.05 % of minutes).\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"type":"string","default":"1d","enum":["1h","1d"]}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day (1h) / 30 days (1d). Range ≤ 30 days hourly, 365 days daily.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bucket start, epoch ms (UTC hour or day)"},"vol_pct":{"type":["string","null"],"description":"Annualized volatility (%) (decimal string; may carry extra trailing zeros)"},"sum_sq_log_ret":{"type":["string","null"],"description":"Σ of squared 1-minute log returns (decimal string; may carry extra trailing zeros)"},"n_returns":{"type":"integer","description":"1-minute returns"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/volatility?interval=1h'"}]}},"/v1/markets/window-prices":{"get":{"operationId":"getWindowPrices","summary":"Exact open/high/low/close over a window","description":"Exact open, high, low and close of each market over [start_time, end_time) from candle levels plus live fills for the newest minutes; for up to 100 markets, one asset class, or every market. Trades follow GET /v1/markets/{coin}/candles (Hyperliquid's candle rule): spot backstop borrow liquidations are not trades, liquidation trades set a price only in a minute that has nothing else, and trades inside one millisecond are ordered by taker order and sweep position (the execution order on all but about 0.05 % of minute edges).\n\nPricing: base × range tier. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 10,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `markets:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"markets:read","parameters":[{"name":"coins","in":"query","required":false,"description":"Comma-separated markets (≤ 100).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}(,[A-Za-z0-9:_\\-/@.]{1,40}){0,99}$"}},{"name":"asset_class","in":"query","required":false,"description":"Asset class: majors, alts, xyz, spot or dex:<name>.","schema":{"type":"string","pattern":"^(majors|alts|xyz|spot|dex:[a-z0-9]{1,16})$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day. Range ≤ 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now. Clamped to the data (meta.as_of).","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"open":{"type":"string","description":"Open (decimal string; may carry extra trailing zeros)"},"high":{"type":"string","description":"High (decimal string; may carry extra trailing zeros)"},"low":{"type":"string","description":"Low (decimal string; may carry extra trailing zeros)"},"close":{"type":"string","description":"Close (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/window-prices?coins=BTC,ETH,HYPE'"}]}},"/v1/markets/{coin}/liquidation-levels/top":{"get":{"operationId":"getTopLiquidationLevels","summary":"Largest positions by liquidation price","description":"Largest positions of one market at the latest hourly liquidation snapshot, with the price at which each is liquidated. Positions worth 100 USD or less at their liquidation price (|size| × liquidation price) are not in the snapshot (meta.min_notional_usd); the live ladder /liquidation-levels has no floor.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"side":{"type":"string","description":"long or short"},"liquidation_px":{"type":"string","description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base, signed: shorts < 0) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/liquidation-levels/top?limit=20'"}]}},"/v1/markets/{coin}/stop-levels/top":{"get":{"operationId":"getTopStopLevels","summary":"Largest resting stop orders","description":"Largest stop / take-profit orders of one market at the latest hourly stop-order snapshot: trigger price, size, side (netted per wallet and trigger price). Stop orders worth under 100 USD at their trigger price (|size| × trigger price) are not in the snapshot (meta.min_notional_usd); the live routes /stop-levels and /stop-orders have no floor.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"side":{"type":"string","description":"buy or sell"},"trigger_px":{"type":"string","description":"Trigger price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base, signed: sells < 0) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/stop-levels/top?limit=20'"}]}},"/v1/markets/{coin}/stop-orders":{"get":{"operationId":"getMarketStopOrders","summary":"Largest stop orders, live","description":"Largest resting stop / take-profit orders of one market from the live positions server, sized as the stop ladder counts them (reduce-only orders capped at the position). Both sides, largest notional first; `limit` counts rows across both sides. meta: `mark`, and per side the totals over EVERY resting order (not this page): `buy_orders` / `sell_orders`, `buy_size` / `sell_size` (base), `buy_notional` / `sell_notional` (USD at the trigger).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"side":{"type":"string","description":"buy or sell"},"trigger_px":{"type":"string","description":"Trigger price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional at the trigger (USD) (decimal string; may carry extra trailing zeros)"},"take_profit":{"type":"boolean","description":"Take-profit (else stop-loss)"},"position_sized":{"type":"boolean","description":"Capped at the position size"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/stop-orders?limit=40'"}]}},"/v1/markets/{coin}/position-changes":{"get":{"operationId":"getMarketPositionChanges","summary":"Who just changed a position","description":"Wallets whose position in one market changed over the last 5 min, 15 min, 1 h, 4 h or 24 h of chain time, largest change first: previous and current size.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"window","in":"query","required":false,"description":"Look-back in seconds.","schema":{"type":"string","default":"3600","enum":["300","900","3600","14400","86400"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"previous":{"type":"string","description":"Size before (signed, base) (decimal string; may carry extra trailing zeros)"},"current":{"type":"string","description":"Size now (signed, base) (decimal string; may carry extra trailing zeros)"},"delta":{"type":"string","description":"Change (signed, base) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/position-changes?window=3600'"}]}},"/v1/liquidations/top":{"get":{"operationId":"listTopLiquidations","summary":"Largest liquidations","description":"Largest single liquidations in a window (≤ 30 days), across all markets or one: wallet, side, price, size, notional, closed PnL. Every liquidated account counts, including the system backstop account (the xyz-market backstop account 0x4000000000000000000000000000000000000001); hyperdash.com's liquidation totals default to traders only (GET /v1/liquidations/by-market, trader_* columns).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 24 h; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short (position liquidated)"},"method":{"type":"string","description":"market or backstop"},"address":{"type":"string","description":"Wallet"},"px":{"type":"string","description":"Fill price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"closed_pnl":{"type":"string","description":"Closed PnL (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark at the time (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations/top?limit=20'"}]}},"/v1/positions/near-liquidation":{"get":{"operationId":"listPositionsNearLiquidation","summary":"Positions closest to liquidation","description":"Open positions within `max_distance_pct` of their liquidation price, closest first (then larger notional), all markets or one, as hyperdash.com's Imminent Liquidations: positions from the latest complete positions snapshot (every few minutes; the 500 closest at its 5-minute mark, cached up to 1 min), distance recomputed on every request from the LIVE mark price of each market (the core exchange's and each listed HIP-3 dex's market context, as Hyperdash's facade serves it); a market whose live mark cannot be read keeps the snapshot's 5-minute mark (`mark_source`). A live mark Hyperdash estimates itself (some HIP-3 markets) is flagged `mark_px_estimated`.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["positions"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"max_distance_pct","in":"query","required":false,"description":"Largest distance to liquidation (%), as the site's choices.","schema":{"type":"string","default":"5","enum":["1","2","5","10"]}},{"name":"min_notional","in":"query","required":false,"description":"Smallest position notional (USD); 0 = any (the site's default).","schema":{"type":"string","default":"0","enum":["0","100000","1000000"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"market":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":"string","description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark price the distance uses: live, else the snapshot's 5-minute mark (decimal string; may carry extra trailing zeros)"},"mark_source":{"type":["string","null"],"description":"live (current mark) or snapshot (5-minute mark at the positions snapshot)"},"mark_px_estimated":{"type":"boolean","description":"true: the live mark is Hyperdash's own estimate, not the exchange's mark; false = not flagged"},"distance_pct":{"type":["string","null"],"description":"|liquidation_px − mark_px| ÷ mark_px (%) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Positions snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/positions/near-liquidation?market=BTC'"}]}},"/v1/positions/largest":{"get":{"operationId":"listLargestPositions","summary":"Largest open positions","description":"Largest open positions by notional at the latest complete positions snapshot (every few minutes): every perp market — the core exchange and every HIP-3 dex — and every wallet, as hyperdash.com's Top Perp Positions; or one market, optionally one side. Cached up to 1 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["positions"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market, exact symbol, e.g. BTC, xyz:TSLA (omit for every market).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"side","in":"query","required":false,"description":"long or short (omit for both).","schema":{"type":"string","enum":["long","short"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"market":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":"string","description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding since the position opened (USD; received > 0) (decimal string; may carry extra trailing zeros)"},"leverage":{"type":["string","null"],"description":"Leverage (decimal string; may carry extra trailing zeros)"},"leverage_mode":{"type":["string","null"],"description":"cross or isolated"},"snapshot_time":{"type":"integer","description":"Snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/positions/largest?market=ETH'"}]}},"/v1/positions/fresh-wallets":{"get":{"operationId":"listFreshWalletPositions","summary":"New wallets with large positions","description":"Open positions of wallets first active in the last `max_age_days` (1, 3 or 7; 7 by default) with an account value of at least `min_balance` (any, $10k or $100k; $100k by default), as hyperdash.com's Fresh Wallet Positions. A wallet's age runs from the earlier of its first ledger activity (deposit, transfer, send) and its first trade in Hyperdash's records, so an old wallet whose early ledger history is missing from them is still left out once it has traded before the cutoff. Positions from the latest complete positions snapshot; cached up to 5 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["positions"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"max_age_days","in":"query","required":false,"description":"Wallet age: first ledger activity and first trade both within this many days.","schema":{"type":"string","default":"7","enum":["1","3","7"]}},{"name":"min_balance","in":"query","required":false,"description":"Smallest account value (USD); 0 = any.","schema":{"type":"string","default":"100000","enum":["0","10000","100000"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"market":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":"string","description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding PnL (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/positions/fresh-wallets'"}]}},"/v1/cohorts/top-positions":{"get":{"operationId":"listCohortTopPositions","summary":"Profitable traders' freshest winners","description":"Positions that curated profitable traders opened or added to in the last hour, ranked by unrealized PnL. The cohort is GET /v1/traders/cohort's: ≥ $100k perp PnL over 30 days, a fill in the last 7 days, wallets tagged `algo` left out, as are HLP and four of its child vaults, two system addresses, three wallets Hyperdash treats as hedged funds and one HIP-3 market maker. Labelled market makers are left out only through the `algo` style tag and that list: one tagged otherwise would appear in the cohort. `first_open_time` / `last_open_time` are the first and last opening or adding fills INSIDE that hour, not when the position was first opened. Position values from the positions snapshot before the latest (up to ~24 min old). Fixed cohort; cached up to 5 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"direction","in":"query","required":false,"description":"winners or losers.","schema":{"type":"string","default":"winners","enum":["winners","losers"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"market":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":"string","description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"total_pnl":{"type":"string","description":"Total PnL incl. funding (decimal string; may carry extra trailing zeros)"},"opened_notional":{"type":"string","description":"Notional opened in the window (decimal string; may carry extra trailing zeros)"},"last_open_time":{"type":"integer","description":"Last opening or adding fill in the window, epoch ms"},"first_open_time":{"type":["integer","null"],"description":"First opening or adding fill in the window (the last hour), epoch ms — not when the position was first opened"},"funding_pnl":{"type":["string","null"],"description":"Funding PnL of the position (USD) (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":["string","null"],"description":"Mark price at the snapshot (decimal string; may carry extra trailing zeros)"},"unrealized_pnl_pct":{"type":["string","null"],"description":"Unrealized PnL ÷ the position's entry notional (ratio, unleveraged: 0.01 = the price moved 1 % in its favour) (decimal string; may carry extra trailing zeros)"},"leverage":{"type":["string","null"],"description":"Leverage (decimal string; may carry extra trailing zeros)"},"leverage_mode":{"type":["string","null"],"description":"cross or isolated"},"notional_pct_of_account":{"type":["string","null"],"description":"Position notional ÷ account value (ratio) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":["integer","null"],"description":"Position snapshot time, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/top-positions'"}]}},"/v1/traders/top-unrealized":{"get":{"operationId":"listTopUnrealizedPnl","summary":"Top traders by unrealized PnL","description":"Wallets with the largest current unrealized PnL (summed over their perp positions at the positions snapshot before the latest), all assets or one asset category. Like hyperdash.com's top-traders board it leaves out 10 accounts: HLP and four of its child vaults, two system addresses (0xfefe…fefe, 0xffff…ffff) and three wallets Hyperdash treats as hedged funds (0xb83de012dba672c76a7dbbbf3e459cb59d7d6e36 and 0x5b5d51203a0f9079f8aeb098a6523a13f298c060, Abraxas Capital, and 0x49e96e255ba418d08e66c35b588e2f2f3766e1d0): their perp PnL is one leg of a hedge. GET /v1/traders/unrealized-movers does not exclude them. Cached up to 1 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["traders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"category","in":"query","required":false,"description":"Asset category.","schema":{"type":"string","default":"all","enum":["all","crypto","stocks","indices","commodities","fx","majors"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/traders/top-unrealized'"}]}},"/v1/traders/unrealized-movers":{"get":{"operationId":"listUnrealizedPnlMovers","summary":"Biggest unrealized PnL moves","description":"Wallets whose unrealized PnL changed most over 1 h, 4 h, 1 day or 7 days (winners or losers), between two positions snapshots: `snapshot_time` (the positions snapshot before the latest, up to ~24 min old) and `baseline_time` (for 1 h / 4 h / 1 day the snapshot nearest to snapshot_time minus the interval — snapshots are ~12 min apart, so the span is the interval ± 6 min; for 7 days the oldest snapshot kept, about 7 days back). Every wallet counts. Cached up to 1 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["traders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"interval","in":"query","required":false,"description":"Look-back.","schema":{"type":"string","default":"1h","enum":["1h","4h","1d","7d"]}},{"name":"direction","in":"query","required":false,"description":"winners or losers.","schema":{"type":"string","default":"winners","enum":["winners","losers"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"upnl_now":{"type":"string","description":"Unrealized PnL now (decimal string; may carry extra trailing zeros)"},"upnl_then":{"type":"string","description":"Unrealized PnL at the start (decimal string; may carry extra trailing zeros)"},"upnl_change":{"type":"string","description":"Change (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Open notional now (decimal string; may carry extra trailing zeros)"},"open_positions":{"type":"integer","description":"Open positions"},"account_value":{"type":"string","description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":["integer","null"],"description":"Snapshot of upnl_now, epoch ms"},"baseline_time":{"type":["integer","null"],"description":"Snapshot of upnl_then, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/traders/unrealized-movers?interval=1d'"}]}},"/v1/traders/groups/{group}":{"get":{"operationId":"getTraderGroup","summary":"hyperdash.com's copytrading groups","description":"The wallets of one of hyperdash.com's copytrading groups (Explore → Copytrade tabs), as the site last refreshed them (every 15 min; `synced_at`), ranked by how each group is selected: `copytraders` = the Top 100 tab (highest copy score among traders with a positive all-time perp PnL, algorithmic accounts left out, one slot per master account), `equities` (top traders across the site's equity markets by combined PnL), `btc`, `hype`, `cl` (the market's top traders by asset score with at least $100k account value, a copy score of 60 and $50k PnL in that market). The site sorts each tab's cards itself (by copy score by default), so its card order can differ from `rank`. Only complete refreshes are served: an interrupted one leaves the previous refresh in place. A group the site shows empty is empty here. Cached up to 1 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["traders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"group","in":"path","required":true,"description":"Group: copytraders (Top 100), equities, btc, hype or cl.","schema":{"type":"string","enum":["copytraders","equities","btc","hype","cl"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank in the group by its selection criterion (1 = top)"},"address":{"type":"string","description":"Wallet"},"label":{"type":["string","null"],"description":"Label, else display name (null: neither)"},"synced_at":{"type":"integer","description":"When the site refreshed the group, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/traders/groups/copytraders'"}]}},"/v1/markets/{coin}/leaderboard":{"get":{"operationId":"getMarketLeaderboard","summary":"Per-market PnL leaderboard","description":"hyperdash.com's per-market board: wallets ranked by total, realized or unrealized PnL, or their ROI, in one market over a window, with the PnL split and capital. 24h / 7d / 30d / ytd rank that market's portfolio PnL (open positions included); all time ranks completed-trade PnL. account_value is the wallet's live perps equity as the site overlays it (one read per page, ≤ 1.5 s, kept 5 s), else the board's hourly snapshot. One wallet's row: GET /v1/accounts/{address}/leaderboard?coin=.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"window","in":"query","required":false,"description":"Window. Default 30d, as hyperdash.com's per-market board.","schema":{"type":"string","default":"30d","enum":["24h","7d","30d","ytd","alltime"]}},{"name":"sort","in":"query","required":false,"description":"Ranked metric: total (net PnL), realized, unrealized, or their ROI (÷ capital; wallets with capital ≥ $1,000). Wallets without that value are not ranked.","schema":{"type":"string","default":"total","enum":["total","realized","unrealized","roi","realized_roi","unrealized_roi"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"display_name":{"type":["string","null"],"description":"Display name"},"net_pnl":{"type":"string","description":"Net PnL (USD) (decimal string; may carry extra trailing zeros)"},"realized_pnl":{"type":["string","null"],"description":"Realized PnL over the window (USD): closed PnL − fees + funding, partial closes included (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Change in open-position unrealized PnL over the window (USD); all time: open unrealized PnL now (decimal string; may carry extra trailing zeros)"},"capital":{"type":["string","null"],"description":"Capital (USD): equity at the window start + peak net external inflow (decimal string; may carry extra trailing zeros)"},"roi":{"type":["string","null"],"description":"Net PnL ÷ capital (ratio: 0.417 = 41.7 %) (decimal string; may carry extra trailing zeros)"},"realized_roi":{"type":["string","null"],"description":"Realized PnL ÷ capital (ratio) (decimal string; may carry extra trailing zeros)"},"unrealized_roi":{"type":["string","null"],"description":"Unrealized PnL ÷ capital (ratio) (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL before fees and funding (USD): 24h / 7d / 30d / ytd = price PnL incl. open positions (net_pnl + fees − funding); all time = completed-trade gross PnL (closed round trips) (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding PnL (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"account_value":{"type":["string","null"],"description":"Account value (USD) as hyperdash.com's leaderboard shows it: live perps equity — every perp dex's account value summed; unified accounts: their collateral stablecoins (USDC, USDH, USDE, USDT0); portfolio-margin accounts: their signed spot portfolio at mids — else the board's hourly snapshot (see account_value_source) (decimal string; may carry extra trailing zeros)"},"account_value_as_of":{"type":["integer","null"],"description":"When the live value was read, epoch ms (null for the snapshot value)"},"account_value_source":{"type":["string","null"],"description":"live (read within the last 5 s) or snapshot (the live read did not answer for this wallet within 1.5 s)"},"tag":{"type":["string","null"],"description":"Trader tag"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"label":{"type":["string","null"],"description":"Hyperdash label"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"verified":{"type":["boolean","null"],"description":"Verified profile"},"copy_score":{"type":["string","null"],"description":"Copy score (0–100) (decimal string; may carry extra trailing zeros)"},"mark_quality":{"type":["integer","null"],"description":"Quality of the mark behind the unrealized part (1 = live mark of every open position, 0 = some fell back)"},"window_start":{"type":["integer","null"],"description":"Board window start, epoch ms (null for all time)"},"as_of":{"type":["integer","null"],"description":"Board computed at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/leaderboard?window=30d'"}]}},"/v1/markets/{coin}/funding/top-wallets":{"get":{"operationId":"getFundingTopWallets","summary":"Top funding payers / earners of one market","description":"Wallets of one market ranked by funding paid, received or net (received − paid, ascending = biggest net payers) over a window of whole settlement hours (≤ 30 days). Exact sums from Hyperdash's funding levels plus raw edge hours; meta.as_of = the funding watermark.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"rank_by","in":"query","required":false,"description":"Ranking.","schema":{"type":"string","default":"paid","enum":["paid","received","net"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 7 days; range ≤ 30 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"paid":{"type":"string","description":"Funding paid (USD) (decimal string; may carry extra trailing zeros)"},"received":{"type":"string","description":"Funding received (USD) (decimal string; may carry extra trailing zeros)"},"net":{"type":"string","description":"Received − paid (USD) (decimal string; may carry extra trailing zeros)"},"payments":{"type":"integer","description":"Settlements"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/funding/top-wallets?rank_by=net'"}]}},"/v1/leaderboards/sorted":{"get":{"operationId":"getSortedLeaderboard","summary":"Completed-trade leaderboard by PnL, volume, trades, win rate or fees","description":"Every wallet ranked by its completed trades (round trips) in a window — net PnL, volume, trade count, win rate or fees — for all markets or one asset category. net_pnl is completed-trade PnL: partial closes and open positions are not included, and wallets with no closed trade in the window are not ranked. Not hyperdash.com's leaderboard: that is GET /v1/leaderboards/pnl (portfolio PnL, open positions included), and the site's Volume / Trades / Win-rate sorts re-sort that board's top 100.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["leaderboards"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"window","in":"query","required":false,"description":"Window.","schema":{"type":"string","default":"30d","enum":["24h","7d","30d","90d","ytd","alltime"]}},{"name":"sort","in":"query","required":false,"description":"Ranking.","schema":{"type":"string","default":"volume","enum":["net_pnl","volume","trade_count","win_rate","fees"]}},{"name":"category","in":"query","required":false,"description":"Asset category.","schema":{"type":"string","default":"all","enum":["all","crypto","majors","memes","alts","equities","indices","commodities","fx"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"net_pnl":{"type":"string","description":"Completed-trade net PnL (USD) (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Gross PnL (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding PnL (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"Fees (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"win_rate":{"type":["string","null"],"description":"winning_trades ÷ (winning_trades + losing_trades): breakeven trades left out (ratio); hyperdash.com's leaderboard shows winning_trades ÷ trades (decimal string; may carry extra trailing zeros)"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"tag":{"type":["string","null"],"description":"Trader tag"},"refreshed_at":{"type":["integer","null"],"description":"Board refreshed at, epoch ms (hourly; also meta.refreshed_at)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/leaderboards/sorted?sort=volume'"}]}},"/v1/markets/largest-opens":{"get":{"operationId":"listLargestOpens","summary":"Largest position-opening orders","description":"Largest orders that opened or increased a position in the last `minutes` (≤ 1 day), all markets or one; optionally only orders of at least `min_notional` ($100k or $1M, as hyperdash.com's Largest Opened Trades size filter).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"market","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"minutes","in":"query","required":false,"description":"Look-back in minutes (≤ 1,440).","schema":{"type":"integer","minimum":1,"maximum":1440,"default":60}},{"name":"min_notional","in":"query","required":false,"description":"Smallest order notional (USD); 0 = any.","schema":{"type":"string","default":"0","enum":["0","100000","1000000"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"coin":{"type":"string","description":"Market"},"direction":{"type":"string","description":"Open Long, Open Short, …"},"oid":{"type":"string","description":"Order id"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"avg_px":{"type":"string","description":"Average fill price (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills"},"first_fill_time":{"type":"integer","description":"First fill, epoch ms"},"last_fill_time":{"type":"integer","description":"Last fill, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/largest-opens?minutes=240'"}]}},"/v1/network/whale-deposits":{"get":{"operationId":"listWhaleDeposits","summary":"Large USDC deposits","description":"Deposits of at least `min_usd` ($100k by default, as hyperdash.com; or $1M, $3M, $5M) into Hyperliquid in the last `hours` (≤ 7 days), newest first.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"hours","in":"query","required":false,"description":"Look-back in hours (≤ 168).","schema":{"type":"integer","minimum":1,"maximum":168,"default":24}},{"name":"min_usd","in":"query","required":false,"description":"Smallest deposit (USD).","schema":{"type":"string","default":"100000","enum":["100000","1000000","3000000","5000000"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"address":{"type":"string","description":"Wallet"},"usdc":{"type":"string","description":"Amount (USDC) (decimal string; may carry extra trailing zeros)"},"fee":{"type":"string","description":"Fee (decimal string; may carry extra trailing zeros)"},"hash":{"type":"string","description":"Transaction hash"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/whale-deposits?hours=72'"}]}},"/v1/network/priority-fees/top-users":{"get":{"operationId":"listPriorityFeeTopUsers","summary":"Largest priority-fee payers","description":"Wallets that paid the most priority fees (write IOC + ALO and read gas) over the last `days` (≤ 30), with their share of all priority fees.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"days","in":"query","required":false,"description":"Look-back in days (≤ 30).","schema":{"type":"integer","minimum":1,"maximum":30,"default":7}},{"name":"kind","in":"query","required":false,"description":"Fee kind.","schema":{"type":"string","default":"all","enum":["all","write","write_ioc","write_alo","read"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"total_usd":{"type":"string","description":"Total priority fees (USD) (decimal string; may carry extra trailing zeros)"},"total_hype":{"type":"string","description":"Total (HYPE) (decimal string; may carry extra trailing zeros)"},"write_usd":{"type":"string","description":"Write fees (USD) (decimal string; may carry extra trailing zeros)"},"read_usd":{"type":"string","description":"Read fees (USD) (decimal string; may carry extra trailing zeros)"},"write_orders":{"type":"integer","description":"Write orders"},"reads":{"type":"integer","description":"Reads"},"share_pct":{"type":["string","null"],"description":"Share of all priority fees (%) (decimal string; may carry extra trailing zeros)"},"write_ioc_hype":{"type":["string","null"],"description":"IOC priority fees paid (HYPE) (decimal string; may carry extra trailing zeros)"},"write_ioc_usd":{"type":["string","null"],"description":"IOC priority fees paid (USD) (decimal string; may carry extra trailing zeros)"},"write_ioc_orders":{"type":["integer","null"],"description":"IOC orders that paid"},"write_ioc_fills":{"type":["integer","null"],"description":"Fills of those IOC orders"},"write_ioc_unpriced_hype":{"type":["string","null"],"description":"IOC fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"write_alo_hype_estimate":{"type":["string","null"],"description":"ALO priority fees (HYPE, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_usd":{"type":["string","null"],"description":"ALO priority fees (USD, estimated) (decimal string; may carry extra trailing zeros)"},"write_alo_orders":{"type":["integer","null"],"description":"ALO orders that paid"},"write_alo_resting_notional_usd":{"type":["string","null"],"description":"Notional of those ALO orders while resting (USD) (decimal string; may carry extra trailing zeros)"},"write_unpriced_hype":{"type":["string","null"],"description":"Write fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unpriced_hype":{"type":["string","null"],"description":"All fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"unconverted_usd":{"type":["string","null"],"description":"USD fees not converted to HYPE (decimal string; may carry extra trailing zeros)"},"hype_estimated":{"type":"boolean","description":"HYPE totals include ALO estimates"},"live_from":{"type":["integer","null"],"description":"From this time (epoch ms) the window is filled from the live tail (less settled)"},"write_fills":{"type":["integer","null"],"description":"Fills of paying writes"},"read_hype":{"type":["string","null"],"description":"Read fees (HYPE) (decimal string; may carry extra trailing zeros)"},"read_unpriced_hype":{"type":["string","null"],"description":"Read fees (HYPE) with no USD price (decimal string; may carry extra trailing zeros)"},"total_txs":{"type":["integer","null"],"description":"Paying transactions"},"fee_hype":{"type":["string","null"],"description":"Fees used for the ranking (HYPE) (decimal string; may carry extra trailing zeros)"},"fee_usd":{"type":["string","null"],"description":"Fees used for the ranking (USD) (decimal string; may carry extra trailing zeros)"},"writes":{"type":["integer","null"],"description":"Paying writes"},"share_hype_pct":{"type":["string","null"],"description":"Share of all fees in HYPE (%) (decimal string; may carry extra trailing zeros)"},"share_hype_estimated":{"type":"boolean","description":"share_hype_pct includes estimates"},"share_hype_complete":{"type":"boolean","description":"share_hype_pct complete"},"wallets":{"type":["integer","null"],"description":"Wallets that paid in the window"},"usd_complete":{"type":"boolean","description":"Every fee priced in USD"},"hype_complete":{"type":"boolean","description":"Every ALO fee converted to HYPE"},"write_hype":{"type":["string","null"],"description":"Write fees (HYPE) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/priority-fees/top-users?days=7'"}]}},"/v1/staking/top-stakers":{"get":{"operationId":"listTopStakers","summary":"Largest HYPE stakers","description":"Wallets with the most HYPE delegated, from the latest state dump (~10 min): total, the number of validators and each delegation (validator address and name, HYPE; largest first).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"hype":{"type":"string","description":"Delegated HYPE (decimal string; may carry extra trailing zeros)"},"validators":{"type":"integer","description":"Validators delegated to"},"delegations":{"type":"string","description":"Delegations (JSON array, largest first: {validator, name, hype}; hype a decimal string; validator / name null when the dump does not resolve them, name null for a validator without a profile)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/top-stakers'"}]}},"/v1/markets/{coin}/bar-flows":{"get":{"operationId":"getBarFlows","summary":"Top buyers and sellers of one bar","description":"Largest buyers and sellers of one market inside one bar [`bar_start`, + `minutes`) (≤ 1 day), half of `limit` per side: wallet, notional, fills.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"bar_start","in":"query","required":true,"description":"Bar start, epoch ms (minute-aligned).","schema":{"type":"integer"}},{"name":"minutes","in":"query","required":false,"description":"Bar length in minutes (≤ 1,440).","schema":{"type":"integer","minimum":1,"maximum":1440,"default":5}},{"name":"limit","in":"query","required":false,"description":"Rows across both sides (≤ 40).","schema":{"type":"integer","minimum":1,"maximum":40,"default":10}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"side":{"type":"string","description":"buy or sell"},"rank":{"type":"integer","description":"Rank within the side"},"address":{"type":"string","description":"Wallet"},"notional":{"type":"string","description":"Gross notional bought or sold (taker + maker, USD) (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills"},"badge":{"type":["string","null"],"description":"MKT (mostly taker) or LMT (mostly maker)"},"bar_volume":{"type":["string","null"],"description":"The whole bar's volume (USD, both sides) (decimal string; may carry extra trailing zeros)"},"bar_trades":{"type":["integer","null"],"description":"The whole bar's trades"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/bar-flows?bar_start=1792972800000&minutes=5'"}]}},"/v1/markets/{coin}/box-traders":{"get":{"operationId":"getBoxTraders","summary":"Wallets that traded inside a price × time box","description":"Wallets that bought or sold one market inside a time window [start_time, end_time) (to the millisecond, ≤ 1 day) and an optional price band, counting exactly the fills inside the window and, with min_px / max_px, exactly the fills whose own price is inside the band (inclusive). Per fill side: a wallet that both bought and sold is listed once per side. Both sides merged, largest notional first. notional is rounded to 6 decimals, size and avg_px to 8.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end_time − 1 h; range ≤ 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"min_px","in":"query","required":false,"description":"Lowest fill price counted (inclusive).","schema":{"type":"string","pattern":"^\\d{1,12}(\\.\\d{1,12})?$"}},{"name":"max_px","in":"query","required":false,"description":"Highest fill price counted (inclusive).","schema":{"type":"string","pattern":"^\\d{1,12}(\\.\\d{1,12})?$"}},{"name":"min_notional","in":"query","required":false,"description":"Only wallet-sides with at least this notional in the box (USD).","schema":{"type":"string","enum":["1000","10000","100000","1000000"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Window start (start_time), epoch ms"},"address":{"type":"string","description":"Wallet"},"stance":{"type":"string","description":"long = bought, short = sold (the fills' side)"},"rank":{"type":"integer","description":"Rank"},"notional":{"type":"string","description":"Notional of the counted fills (USD) (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size of the counted fills (base) (decimal string; may carry extra trailing zeros)"},"avg_px":{"type":["string","null"],"description":"notional / size (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Counted fills"},"badge":{"type":["string","null"],"description":"MKT (taker notional ≥ half) or LMT"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/box-traders?min_px=79000&max_px=80000'"}]}},"/v1/outcomes/leaderboard":{"get":{"operationId":"getOutcomeLeaderboard","summary":"HIP-4 outcome PnL leaderboard","description":"Wallets ranked by realized PnL on HIP-4 outcome markets over the last 24 hours or 7 days, or one outcome. Realized PnL includes settled outcomes' payouts (Hyperliquid books a settlement as a Settlement fill); volume and the last trade count real trades only, not Settlement, Split / Merge / Negate Outcome or Merge Question fills. Cached up to 5 min.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"hours","in":"query","required":false,"description":"Look-back in hours.","schema":{"type":"string","default":"168","enum":["24","168"]}},{"name":"outcome","in":"query","required":false,"description":"One outcome id.","schema":{"type":"integer","minimum":0,"maximum":1000000000000000}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"realized_pnl":{"type":"string","description":"Realized PnL (USD): gross_pnl − fees (decimal string; may carry extra trailing zeros)"},"gross_pnl":{"type":"string","description":"Closed PnL, settlement results included (decimal string; may carry extra trailing zeros)"},"fees":{"type":"string","description":"USDC fees, settlement fees included (decimal string; may carry extra trailing zeros)"},"yes_notional":{"type":"string","description":"Yes-space notional of the wallet's taker trades (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills in the window, settlement / split / merge fills included"},"markets":{"type":"integer","description":"Outcomes with a fill in the window"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms; null when the window holds only settlement / split / merge fills"},"share_fees":{"type":["string","null"],"description":"Fees paid in outcome shares (decimal string; may carry extra trailing zeros)"},"taker_share_volume":{"type":["string","null"],"description":"Taker volume in shares (trades only) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":["string","null"],"description":"Account value (USD, latest snapshot) (decimal string; may carry extra trailing zeros)"},"display_name":{"type":["string","null"],"description":"Display name"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"verified":{"type":["boolean","null"],"description":"Verified profile"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/leaderboard?hours=168'"}]}},"/v1/outcomes/whale-trades":{"get":{"operationId":"listOutcomeWhaleTrades","summary":"Large HIP-4 outcome trades","description":"Taker trades of at least $1,000 (Yes-space notional) on outcome markets in the last `hours` (≤ 1 day), all outcomes or one.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"hours","in":"query","required":false,"description":"Look-back in hours (≤ 24).","schema":{"type":"integer","minimum":1,"maximum":24,"default":24}},{"name":"outcome","in":"query","required":false,"description":"One outcome id.","schema":{"type":"integer","minimum":0,"maximum":1000000000000000}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"coin":{"type":"string","description":"Outcome coin"},"outcome":{"type":"integer","description":"Outcome id"},"side_index":{"type":"integer","description":"0 = Yes, 1 = No"},"yes_px":{"type":"string","description":"Price in Yes space (decimal string; may carry extra trailing zeros)"},"yes_side":{"type":"string","description":"B = buy, A = sell (Yes space)"},"size":{"type":"string","description":"Shares (decimal string; may carry extra trailing zeros)"},"yes_notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"address":{"type":"string","description":"Wallet"},"hash":{"type":"string","description":"Transaction hash"},"tid":{"type":["string","null"],"description":"Trade id"},"twap_id":{"type":["string","null"],"description":"TWAP id, if the trade was a TWAP slice"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/whale-trades'"}]}},"/v1/outcomes/{outcome}/holders":{"get":{"operationId":"getOutcomeHolders","summary":"Largest holders of one outcome","description":"Largest holders of one HIP-4 outcome, per side: shares, cost basis, average entry, realized PnL, how the balance was established, and at the side's live mid the notional and unrealized PnL. On a settled outcome a row is the position held at settlement (Hyperliquid then redeems it) with what it cost, and realized_pnl includes the settlement result. `sort=notional` ranks by notional as hyperdash.com's Top Holders does (the site also merges the outcomes of one event); the default ranks by shares. A side's mid is its own live mid, else 1 − the other side's (as the site); without one (e.g. a settled outcome) mid_px, notional and unrealized_pnl are null and those rows rank by shares, after the priced ones. Cached up to 30 s.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["outcomes"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"outcome","in":"path","required":true,"description":"Outcome id.","schema":{"type":"integer","minimum":0,"maximum":1000000000000000}},{"name":"side","in":"query","required":false,"description":"0 = Yes, 1 = No (omit for both).","schema":{"type":"integer","minimum":0,"maximum":1}},{"name":"sort","in":"query","required":false,"description":"Ranking: shares held, or notional at the live mid.","schema":{"type":"string","default":"shares","enum":["shares","notional"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"side_index":{"type":"integer","description":"0 = Yes, 1 = No"},"shares":{"type":"string","description":"Shares held (settled outcome: held at settlement) (decimal string; may carry extra trailing zeros)"},"cost_basis":{"type":"string","description":"What the shares held cost (USD) (decimal string; may carry extra trailing zeros)"},"avg_entry":{"type":"string","description":"Average entry: cost_basis / shares (decimal string; may carry extra trailing zeros)"},"realized_pnl":{"type":"string","description":"Realized PnL: closed PnL − USDC fees (settled outcome: the settlement result included) (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills"},"last_fill_at":{"type":"integer","description":"Last fill, epoch ms"},"balance_status":{"type":["string","null"],"description":"reconciled (Hyperliquid balance check under 30 min old, plus later fills), stale (older check) or estimated (no check: replayed from fills, splits and merges included)"},"balance_checked_at":{"type":["integer","null"],"description":"Last balance check, epoch ms (null when estimated)"},"mid_px":{"type":["string","null"],"description":"The side's live mid (price per share, USD) (decimal string; may carry extra trailing zeros)"},"notional":{"type":["string","null"],"description":"Shares × mid_px (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"(mid_px − avg_entry) × shares (USD) (decimal string; may carry extra trailing zeros)"},"display_name":{"type":["string","null"],"description":"Display name"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"verified":{"type":["boolean","null"],"description":"Verified profile"},"share_fees":{"type":["string","null"],"description":"Fees paid in outcome shares (decimal string; may carry extra trailing zeros)"},"account_value":{"type":["string","null"],"description":"Account value (USD, latest snapshot) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/outcomes/1234/holders'"}]}},"/v1/accounts/search":{"get":{"operationId":"searchWallets","summary":"Find wallets by profile name, label or X handle","description":"Wallets whose public hyperdash.com display name, label or X handle matches `search` (case-insensitive): prefix matches first, then substring matches, then verified, then address. Only wallets with a public profile are searchable. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"search","in":"query","required":true,"description":"Text to find (3..64 characters).","schema":{"type":"string","pattern":"^.{3,64}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 25).","schema":{"type":"integer","minimum":1,"maximum":25,"default":10}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"display_name":{"type":["string","null"],"description":"Public hyperdash.com display name"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"tag":{"type":["string","null"],"description":"Hyperdash trader tag (e.g. intraday)"},"verified":{"type":"boolean","description":"Verified profile"},"label":{"type":["string","null"],"description":"Hyperdash label"},"match":{"type":"integer","description":"0 = prefix match, 1 = substring match"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/search?search=whale'"}]}},"/v1/markets/{coin}/leaderboard/asset-score":{"get":{"operationId":"getAssetScoreLeaderboard","summary":"One market's traders ranked by asset score","description":"The hyperdash.com asset leaderboard: traders of one market ranked by asset score (asset score > 0, a completed trade in ANY market in the last 30 days — the site's activity rule, so a wallet can rank here without trading this market for a month —, at least `min_trades` trades and `min_loss` of losses, algo-tagged excluded; ties by net PnL, gains, trades, address), with their PnL split, account value, copy score and profile. Page with the cursor (up to 1,000 rows). Cached up to 10 min. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"min_trades","in":"query","required":false,"description":"Minimum trades in the market.","schema":{"type":"string","default":"5","enum":["1","5","10","25","50","100"]}},{"name":"min_loss","in":"query","required":false,"description":"Minimum |losses| in the market (USD).","schema":{"type":"string","default":"100","enum":["0","100","1000","10000","100000"]}},{"name":"min_pnl","in":"query","required":false,"description":"Minimum net PnL in the market (USD).","schema":{"type":"string","enum":["0","1000","10000","100000","1000000"]}},{"name":"min_account_value","in":"query","required":false,"description":"Minimum account value (USD).","schema":{"type":"string","enum":["1000","10000","100000","1000000","10000000"]}},{"name":"min_copy_score","in":"query","required":false,"description":"Minimum copy score.","schema":{"type":"string","enum":["50","60","70","80","90"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (next page).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"asset_score":{"type":["string","null"],"description":"Asset score (decimal string; may carry extra trailing zeros)"},"net_pnl":{"type":"string","description":"Net closed PnL in the market (USD) (decimal string; may carry extra trailing zeros)"},"gains":{"type":"string","description":"Positive closed PnL (USD) (decimal string; may carry extra trailing zeros)"},"losses":{"type":"string","description":"Negative closed PnL (USD) (decimal string; may carry extra trailing zeros)"},"volume":{"type":"string","description":"Volume in the market (USD) (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"account_value":{"type":["string","null"],"description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"copy_score":{"type":["string","null"],"description":"Copy score (decimal string; may carry extra trailing zeros)"},"display_name":{"type":["string","null"],"description":"Public hyperdash.com display name"},"avatar":{"type":["string","null"],"description":"Avatar image URL"},"twitter":{"type":["string","null"],"description":"X (Twitter) profile URL"},"tag":{"type":["string","null"],"description":"Hyperdash trader tag (e.g. intraday)"},"verified":{"type":"boolean","description":"Verified profile"},"label":{"type":["string","null"],"description":"Hyperdash label"},"last_trade_at":{"type":["integer","null"],"description":"The wallet's last completed trade in any market (not only this one), epoch ms"},"updated_at":{"type":"integer","description":"Scores computed at, epoch ms"},"total":{"type":"integer","description":"Qualifying traders"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/leaderboard/asset-score?min_trades=10'"}]}},"/v1/positions/top-unrealized":{"get":{"operationId":"listTopUnrealizedPositions","summary":"Open positions with the largest unrealized PnL","description":"Open perp positions across every market (or one) ranked by unrealized PnL (winners) or by unrealized loss (losers) — by position, where /traders/top-unrealized ranks wallets. From one perp-positions snapshot (about every 12 min, the second newest of the last 3 h); a snapshot under 85 % of the previous one's positions, or one without a previous snapshot to compare, is refused as unavailable (retry shortly). Empty when no snapshot landed in 3 h. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["positions"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"side","in":"query","required":false,"description":"winners or losers.","schema":{"type":"string","default":"winners","enum":["winners","losers"]}},{"name":"market","in":"query","required":false,"description":"One market (omit for all).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"min_notional","in":"query","required":false,"description":"Minimum |notional| (USD).","schema":{"type":"string","enum":["10000","100000","1000000","10000000"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"market":{"type":"string","description":"Market"},"side":{"type":"string","description":"long or short"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding since open (USD) (decimal string; may carry extra trailing zeros)"},"account_value":{"type":"string","description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"leverage_value":{"type":["string","null"],"description":"Leverage (decimal string; may carry extra trailing zeros)"},"leverage_mode":{"type":["string","null"],"description":"cross or isolated"},"snapshot_time":{"type":"integer","description":"Positions snapshot used (epoch ms)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/positions/top-unrealized?side=losers'"}]}},"/v1/markets/{coin}/stop-orders/history":{"get":{"operationId":"getStopOrdersAt","summary":"Wallets behind a market's stop orders at a past hour","description":"The wallets with resting stop orders on one market at a past time (within 30 days), from the newest complete hourly stop-order snapshot at or before `time`, optionally inside a price band. Rows are netted levels, not single orders: one row per (wallet, trigger price) with the summed size (sell stops negative) and notional at the trigger (signed). Stop orders worth under 100 USD at their trigger price (|size| × trigger price) are not in the snapshot (meta.min_notional_usd); the live routes /stop-levels and /stop-orders have no floor. Largest |notional| first. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"time","in":"query","required":true,"description":"Point in time, epoch ms (within the last 30 days and your plan's history window).","schema":{"type":"integer"}},{"name":"min_px","in":"query","required":false,"description":"Lowest trigger price.","schema":{"type":"string","pattern":"^\\d{1,12}(\\.\\d{1,12})?$"}},{"name":"max_px","in":"query","required":false,"description":"Highest trigger price.","schema":{"type":"string","pattern":"^\\d{1,12}(\\.\\d{1,12})?$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 500).","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"px":{"type":"string","description":"Trigger price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Summed size at this price (base; sell stops negative) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"size × px (USD, signed) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Snapshot used, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/stop-orders/history?time=1793880000000&min_px=70000'"}]}},"/v1/staking/stakers/changes":{"get":{"operationId":"listStakerChanges","summary":"Largest changes in delegated HYPE between two times","description":"Every wallet's delegated HYPE at start_time and end_time and the change, ranked by gain, loss or absolute change, with its share of all delegated HYPE at end_time. Exact decimals (8 dp). History starts 2026-10-11 11:15:40.723 UTC (the first committed staking baseline); end_time must not be in the future. A weekly full baseline (since 2026-11-05) bounds how far each read reconstructs going forward; windows before the first periodic baseline still replay the longer log. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"gain, loss or abs (absolute change).","schema":{"type":"string","default":"abs","enum":["gain","loss","abs"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"stake_from":{"type":"string","description":"Delegated HYPE at start_time (decimal string; may carry extra trailing zeros)"},"stake_to":{"type":"string","description":"Delegated HYPE at end_time (decimal string; may carry extra trailing zeros)"},"change":{"type":"string","description":"stake_to − stake_from (decimal string; may carry extra trailing zeros)"},"share_to":{"type":["string","null"],"description":"Share of all delegated HYPE at end_time (0–1) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/stakers/changes?sort=gain'"}]}},"/v1/cohorts/{cohort}/members":{"get":{"operationId":"listCohortMembers","summary":"The positioned wallets of one account-size cohort","description":"The wallets of one account-size cohort (small < $10K, medium $10K–100K, large $100K–1M, whale $1M–5M, apex ≥ $5M; account value = perp + spot) that hold an open perp position, with their positions. Without `coin`: one row per wallet (positions, gross notional, uPnL summed). With `coin`: that market's position of each wallet holding it. Page with the cursor (up to 1,000 rows; meta.truncated is true only when the list has more than 1,000 rows — the source counts them). Members are positioned wallets only, while /cohorts/totals counts every account of the cohort. From one perp-positions snapshot (about every 12 min, the second newest of the last 3 h); a snapshot under 85 % of the previous one's positions, or one without a previous snapshot to compare, is refused as unavailable (retry shortly). Empty when no snapshot landed in 3 h. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["cohorts"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"cohort","in":"path","required":true,"description":"Account-size cohort.","schema":{"type":"string","enum":["small","medium","large","whale","apex"]}},{"name":"coin","in":"query","required":false,"description":"One market: its position rows.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"sort","in":"query","required":false,"description":"account_value, notional, upnl (largest gain) or upnl_loss (largest loss).","schema":{"type":"string","default":"account_value","enum":["account_value","notional","upnl","upnl_loss"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (next page).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"account_value":{"type":"string","description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"positions":{"type":["integer","null"],"description":"Open positions (without coin)"},"market":{"type":["string","null"],"description":"Market (with coin)"},"side":{"type":["string","null"],"description":"long or short (with coin)"},"size":{"type":["string","null"],"description":"Size (base, with coin) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":["string","null"],"description":"Entry price (with coin) (decimal string; may carry extra trailing zeros)"},"leverage_value":{"type":["string","null"],"description":"Leverage (with coin) (decimal string; may carry extra trailing zeros)"},"leverage_mode":{"type":["string","null"],"description":"cross or isolated (with coin)"},"notional":{"type":"string","description":"Gross notional (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"snapshot_time":{"type":"integer","description":"Positions snapshot used (epoch ms)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/cohorts/whale/members?coin=BTC&sort=upnl'"}]}},"/v1/markets/twaps":{"get":{"operationId":"listAllTwaps","summary":"Every running core-exchange perp TWAP","description":"Every active TWAP on the core exchange's perps (the node state snapshot our facade keeps; HIP-3 dex TWAPs are not in it), largest first, with the same fields as /markets/{coin}/twaps plus the market. The snapshot is cut from the node state every 10,000 blocks (~12 min) and published ~3 min later, so it is 3 to 15 min old: its block time is in meta (snapshot_time, epoch ms; snapshot_time_estimated = true when derived from its TWAPs' next slices, within 15 s; null when unknown — no running TWAP to date it by). TWAPs started, ended or terminated since are not reflected. Every returned address counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows (≤ 500).","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"address":{"type":"string","description":"Wallet running the TWAP"},"twap_id":{"type":"string","description":"TWAP id (decimal string: 64-bit)"},"side":{"type":"string","description":"buy or sell"},"total_sz":{"type":"string","description":"Total size (base) (decimal string; may carry extra trailing zeros)"},"executed_sz":{"type":"string","description":"Executed size (decimal string; may carry extra trailing zeros)"},"remaining_sz":{"type":"string","description":"Remaining size (decimal string; may carry extra trailing zeros)"},"executed_notional":{"type":"string","description":"Executed notional (USD) (decimal string; may carry extra trailing zeros)"},"progress_pct":{"type":"string","description":"Progress (0-100) (decimal string; may carry extra trailing zeros)"},"duration_s":{"type":"integer","description":"Duration (s)"},"start_time":{"type":"integer","description":"Start, epoch ms"},"reduce_only":{"type":"boolean","description":"Reduce-only"},"randomize":{"type":"boolean","description":"Randomized slices"},"next_slice_time":{"type":["string","null"],"description":"Next slice (ISO-8601)"},"slices_done":{"type":"integer","description":"Slices executed"},"waiting":{"type":"boolean","description":"Waiting for its trigger"},"stop_px":{"type":["string","null"],"description":"Stop price: a buy TWAP stops once the price reaches it from below, a sell from above. HL announced (2026-10-29) that it will pause there instead and resume when the price comes back. (decimal string; may carry extra trailing zeros)"},"trigger_px":{"type":["string","null"],"description":"Trigger price of a TWAP waiting to start (decimal string; may carry extra trailing zeros)"},"trigger_above":{"type":["boolean","null"],"description":"Starts when the price rises above (true) or falls below (false) trigger_px"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/twaps?limit=50'"}]}},"/v1/staking/validators/{validator}/delegations":{"get":{"operationId":"listValidatorDelegations","summary":"Delegations to one validator","description":"Every delegation to and undelegation from the validator in [start_time, end_time] with the delegating wallet, oldest first; events of the last 5 minutes are left for a later query (pages stay stable). From our nodes' misc events: history from 2025-09-27 10:00 UTC (the first hour of Hyperliquid's node-data archive, loaded and checked hour by hour), live since 2026-11-05 18:06 UTC. Events usually appear within seconds; one delayed by more than 5 minutes can still land in a window you already paged through. The validator you ask for counts as a queried wallet; every delegator returned counts toward your discovered-wallet allowance; rows across one query's pages are capped by your plan (and at 10,000). Range ≤ 90 days; page with the cursor.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["staking"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"validator","in":"path","required":true,"description":"Validator address, 0x + 40 hex (as `validator` in GET /v1/accounts/{address}/staking/history or GET /v1/staking/rewards).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 7 days; range ≤ 90 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (inclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Event time, epoch ms"},"user":{"type":"string","description":"Delegating wallet"},"kind":{"type":"string","description":"delegate | undelegate"},"amount":{"type":"string","description":"HYPE (decimal string; may carry extra trailing zeros)"},"hash":{"type":"string","description":"Transaction hash"},"block":{"type":"integer","description":"Block height"},"event_index":{"type":"integer","description":"Position among the block's events (with block: unique)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/staking/validators/0x…/delegations'"}]}},"/v1/snapshots/positions/{coin}":{"get":{"operationId":"snapshotMarketPositions","summary":"Every open position in a market","description":"All open positions of one perp market (core or HIP-3), largest notional first: wallet, signed size, entry and mark, liquidation price, leverage, margin, funding and the account's value. The same state as our perpSnapshots, as JSON.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"coin":{"type":"string","description":"Market"},"dex":{"type":"integer","description":"Perp dex index (0 = core)"},"size":{"type":"string","description":"Size (base, signed: shorts < 0) (decimal string; may carry extra trailing zeros)"},"entry_notional":{"type":"string","description":"Entry notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"mark_px":{"type":"string","description":"Mark price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"leverage_type":{"type":"string","description":"cross or isolated"},"leverage":{"type":"integer","description":"Leverage"},"isolated_margin":{"type":["string","null"],"description":"Isolated ledger balance (USD; Hyperliquid's rawUsd), isolated positions: the margin held is isolated_margin + size × mark_px (decimal string; may carry extra trailing zeros)"},"cross_balance":{"type":["string","null"],"description":"Cross balance (USD) (decimal string; may carry extra trailing zeros)"},"funding_accrued":{"type":"string","description":"Funding since the position opened (USD; paid > 0) (decimal string; may carry extra trailing zeros)"},"margin_table_id":{"type":["integer","null"],"description":"Margin table"},"account_value":{"type":["string","null"],"description":"Equity of the margin pool behind this position (USD), the value its liquidation is judged on — not the wallet's total: a cross position carries its account's cross account value on the position's dex (unified and portfolio-margin accounts: their one account-wide pool, spot collateral included); an isolated position its own isolated margin + unrealized PnL. A wallet's rows can therefore differ. (decimal string; may carry extra trailing zeros)"},"spot_usdc":{"type":["string","null"],"description":"Spot USDC (USD) (decimal string; may carry extra trailing zeros)"},"abstraction":{"type":["string","null"],"description":"Account abstraction mode"},"updated_height":{"type":"integer","description":"Block height of the position's last change since the engine's base snapshot (meta.snapshot_height); that snapshot's height when unchanged since"},"margin_uncertain":{"type":["boolean","null"],"description":"The position's margin is not certified: opened since the engine's base snapshot (meta.snapshot_height), a cross position sharing its margin pool with one, or a pool, not portfolio margin, that a fill since then left below its maintenance requirement (an input such as a deposit is missing). liquidation_px and account_value are null; leverage / leverage_type / isolated_margin are the slot's last snapshotted setting, not certified. Null: a snapshot from a server without the check."}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/positions/BTC?limit=1000'"}]}},"/v1/snapshots/spot-holders/{token}":{"get":{"operationId":"snapshotSpotHolders","summary":"Every holder of a spot token","description":"All holders of one spot token (name as in /v1/spot/markets, e.g. HYPE, PURR) from the node's spot state snapshot, largest USD value first; optionally only holders within balance / USD value ranges (inclusive; the snapshot's own USD values, not a live price). meta: holders, total_balance and total_value_usd of the matching holders (null on a snapshot server without the summary), and `total` = the matching holders. A filtered query on a snapshot server without filters answers 503 (retry), never unfiltered rows.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"token","in":"path","required":true,"description":"Spot token name, e.g. HYPE.","schema":{"type":"string","pattern":"^[A-Za-z0-9_\\-]{1,24}$"}},{"name":"min_balance","in":"query","required":false,"description":"Minimum balance (token units) (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,18})?$"}},{"name":"max_balance","in":"query","required":false,"description":"Maximum balance (token units) (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,18})?$"}},{"name":"min_value","in":"query","required":false,"description":"Minimum USD value (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,18})?$"}},{"name":"max_value","in":"query","required":false,"description":"Maximum USD value (inclusive).","schema":{"type":"string","pattern":"^\\d{1,15}(\\.\\d{1,18})?$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"balance":{"type":"string","description":"Balance (token units) (decimal string; may carry extra trailing zeros)"},"value_usd":{"type":"string","description":"Value at the spot mark (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/spot-holders/HYPE?limit=1000'"}]}},"/v1/snapshots/account-values":{"get":{"operationId":"snapshotAccountValues","summary":"Every account's value","description":"Every account's value in the core USDC book (`hyperliquid:USDC`, the only book served: per-HIP-3-dex books are not built), largest first: account value, long and short notional of its core-exchange positions only, unified flag and margin mode. Unified accounts are valued at their whole equity (every perp dex, core and HIP-3, plus spot USDC and tokens) and portfolio-margin accounts at Hyperliquid's portfolio value, positions or not; classic accounts with an open perp position at the dexes they hold positions on plus their core-exchange balance and spot wallet (idle balances on other HIP-3 dexes are not counted), classic accounts without one at their core-exchange perp balance only. From the node's periodic state snapshot.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"collateral","in":"query","required":false,"description":"Collateral book. Only hyperliquid:USDC is served.","schema":{"type":"string","default":"hyperliquid:USDC","enum":["hyperliquid:USDC"]}},{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"account_value":{"type":"string","description":"Account value (USD): unified / portfolio-margin accounts their whole equity; classic accounts see the description (positioned: their position dexes + core + spot; else core only) (decimal string; may carry extra trailing zeros)"},"long_notional":{"type":"string","description":"Long notional of core-exchange positions (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Short notional of core-exchange positions (USD) (decimal string; may carry extra trailing zeros)"},"unified":{"type":"boolean","description":"Unified account"},"mode":{"type":"string","description":"standard, dex_abstraction, unified or portfolio_margin"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/account-values?collateral=hyperliquid:USDC&limit=1000'"}]}},"/v1/snapshots/positioned-accounts":{"get":{"operationId":"snapshotPositionedAccounts","summary":"Every account with an open perp","description":"Every account with at least one open perp position, and the dexes it holds them on (core and HIP-3), by address.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"dexes":{"type":"string","description":"Comma-separated dexes with open positions (core = the main exchange)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/positioned-accounts?limit=1000'"}]}},"/v1/snapshots/portfolio-margin-accounts":{"get":{"operationId":"snapshotPortfolioMarginAccounts","summary":"Every portfolio-margin account","description":"Every account in portfolio-margin mode, by address.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/portfolio-margin-accounts'"}]}},"/v1/snapshots/borrowers":{"get":{"operationId":"snapshotBorrowers","summary":"Every borrower","description":"Every account with an open HyperCore borrow, largest eligible collateral first: borrowed and supplied tokens (USD), wallet HYPE / BTC collateral, eligible collateral, liquidation value and maintenance requirement.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"mode":{"type":"string","description":"Margin mode"},"borrowed_usd":{"type":"string","description":"Borrowed (USD) (decimal string; may carry extra trailing zeros)"},"supplied_usd":{"type":"string","description":"Supplied (USD) (decimal string; may carry extra trailing zeros)"},"eligible_collateral_usd":{"type":"string","description":"Eligible collateral (USD) (decimal string; may carry extra trailing zeros)"},"liquidation_value":{"type":"string","description":"Liquidation value (USD) (decimal string; may carry extra trailing zeros)"},"maintenance":{"type":"string","description":"Maintenance requirement (USD) (decimal string; may carry extra trailing zeros)"},"wallet_hype_usd":{"type":"string","description":"Wallet HYPE (USD) (decimal string; may carry extra trailing zeros)"},"wallet_btc_usd":{"type":"string","description":"Wallet BTC (USD) (decimal string; may carry extra trailing zeros)"},"unpriced":{"type":"boolean","description":"Some leg had no oracle price"},"borrows":{"type":"string","description":"Borrow legs (JSON: token, name, amount, usd, ltv)"},"supplies":{"type":"string","description":"Supply legs (JSON)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/borrowers'"}]}},"/v1/snapshots/trigger-orders/{coin}":{"get":{"operationId":"snapshotTriggerOrders","summary":"Every resting trigger order in a market","description":"All untriggered stop-loss / take-profit / stop-limit orders of one market from our order book engine, by trigger price: wallet, side, trigger condition and price, limit price, size, reduce-only, TP/SL flags. Client order ids are never returned. Trailing stops are returned as placed: trigger_px 0, the placement limit_px and 'best waiting' in trigger_condition, also once they have activated — their live trailing state (activation, best price, current trigger and limit) is not tracked yet: Hyperliquid derives it from the mark price and the node's order updates do not carry it.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["snapshots"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (≤ 1,000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (pins the snapshot).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"coin":{"type":"string","description":"Market"},"side":{"type":"string","description":"B (buy) or A (sell)"},"order_type":{"type":"string","description":"Order type"},"trigger_condition":{"type":"string","description":"Trigger condition"},"trigger_px":{"type":"string","description":"Trigger price (trailing stops: 0 — their trailing trigger is not tracked; activation and retracement in trigger_condition) (decimal string; may carry extra trailing zeros)"},"limit_px":{"type":"string","description":"Limit price (decimal string; may carry extra trailing zeros)"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"orig_size":{"type":"string","description":"Original size (base) (decimal string; may carry extra trailing zeros)"},"oid":{"type":"string","description":"Order id"},"time":{"type":"integer","description":"Placed at, epoch ms"},"reduce_only":{"type":"boolean","description":"Reduce-only"},"is_position_tpsl":{"type":"boolean","description":"Position TP/SL"},"tif":{"type":["string","null"],"description":"Time in force"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/snapshots/trigger-orders/BTC?limit=1000'"}]}},"/v1/vaults":{"get":{"operationId":"listVaults","summary":"Vaults","description":"Vaults from our node's state (hourly): name, description, leader, created, leader commission, closed, deposits allowed, always-close-on-withdraw, lockup, relationship (normal / parent with its child vaults / child), followers. Most followers first. One query returns at most your plan's wallet-list cap across its pages (Lite and Starter 100, Growth 500, Scale and Enterprise 1,000): a query cut there ends with meta.truncated = true and no next_cursor, and the rows past the cap are not reachable through this route. Every page of one query comes from the SAME node-state snapshot: the cursor pins the generation the first page read. Once that snapshot ages out (vaults 3 h, followers 36 h), a cursor page answers 409 snapshot_expired: restart from the first page. From our nodes' state snapshots (validators, tokens and vaults hourly; referrers daily), first published 2026-11-05 20:40 UTC. None complete and fresh: 503 unavailable, retry later.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["vaults"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (it pins the snapshot generation).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"vault":{"type":"string","description":"Vault address"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"leader":{"type":"string","description":"Leader"},"create_time":{"type":["integer","null"],"description":"Created, epoch ms"},"leader_commission":{"type":["string","null"],"description":"Leader commission (fraction of profits) (decimal string; may carry extra trailing zeros)"},"is_closed":{"type":["boolean","null"],"description":"Closed"},"allow_deposits":{"type":["boolean","null"],"description":"Deposits allowed"},"lockup_s":{"type":["string","null"],"description":"Deposit lockup, seconds (decimal string; may carry extra trailing zeros)"},"always_close_on_withdraw":{"type":["boolean","null"],"description":"Withdrawals always close the follower's share of positions"},"relationship":{"type":["string","null"],"description":"normal | parent | child"},"child_vaults":{"type":["string","null"],"description":"A parent vault's child vaults (JSON array of addresses); null unless relationship = parent"},"followers":{"type":"integer","description":"Followers"},"snapshot_time":{"type":"integer","description":"Node-state snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/vaults'"}]}},"/v1/vaults/{vault}/followers":{"get":{"operationId":"listVaultFollowers","summary":"Followers of one vault","description":"The vault's followers from our node's state (daily): ownership fraction (× the vault's account value = the follower's equity), net transfers in USDC, entry and last change. Largest share first. One query returns at most your plan's wallet-list cap across its pages (Lite and Starter 100, Growth 500, Scale and Enterprise 1,000): a query cut there ends with meta.truncated = true and no next_cursor, and the rows past the cap are not reachable through this route. The vault counts as a queried wallet; the followers count toward your discovered-wallet allowance. Every page of one query comes from the SAME node-state snapshot: the cursor pins the generation the first page read. Once that snapshot ages out (vaults 3 h, followers 36 h), a cursor page answers 409 snapshot_expired: restart from the first page. From our nodes' state snapshots (validators, tokens and vaults hourly; referrers daily), first published 2026-11-05 20:40 UTC. None complete and fresh: 503 unavailable, retry later.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["vaults"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"vault","in":"path","required":true,"description":"Vault address, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (it pins the snapshot generation).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"follower":{"type":"string","description":"Follower"},"ownership_fraction":{"type":["string","null"],"description":"Share of the vault (decimal string; may carry extra trailing zeros)"},"ownership_b":{"type":["string","null"],"description":"The node's per-follower `b` value, verbatim (an integer string; not documented by Hyperliquid)"},"net_transfers":{"type":["string","null"],"description":"Signed cumulative net transfers into the vault, USDC (exact; the node keeps micro-USDC) (decimal string; may carry extra trailing zeros)"},"entry_time":{"type":["integer","null"],"description":"Entered, epoch ms"},"last_change_time":{"type":["integer","null"],"description":"Last change, epoch ms"},"snapshot_time":{"type":"integer","description":"Node-state snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/vaults/0x…/followers'"}]}},"/v1/traders/screener":{"get":{"operationId":"traderScreener","summary":"Trader screener","description":"Ranked traders with their stats: PnL per window, trade counts, win rates, Sharpe and Sortino, drawdowns, GPR, copy scores, account value, open notional, unrealized PnL, profile and top assets. The top 2,000 per sort and filter set, paged; like hyperdash.com's Explore, it leaves out the 13 accounts the site excludes (e.g. the Assistance Fund). Explore's filters as fixed choices: smallest account value, smallest PnL in the timeframe, smallest copy score and style tag (all optional, combined with AND). `rank` is the wallet's rank on the perp-PnL leaderboard of `timeframe` (Explore's # column; display only, it does not change the order). Explore's Win Rate column is `winrate_30d`; `winrate` is lifetime. Each wallet's stats row is rebuilt about once a day, at a wallet-specific time (every 24–26 h), so its 24-hour, 7-day and 30-day PnL windows end around that rebuild, not now, and rows of one page can be up to a day apart: `updated_at` is when the row was computed (some inputs, e.g. account value, can be older still).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["traders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"sort","in":"query","required":false,"description":"Sort field. Default pnlPerpMonth (30-day perp PnL), as hyperdash.com's Explore traders.","schema":{"type":"string","default":"pnlPerpMonth","enum":["pnlPerpDay","pnlPerpWeek","pnlPerpMonth","pnlPerpAllTime","winrate30d","winrate7d","winrateLifetime","totalTrades","accountValue","notional","sharpe30d","copyScore","copyScoreV2","maxDrawdownPerpWeek","maxDrawdownPerpMonth"]}},{"name":"order","in":"query","required":false,"description":"Sort order.","schema":{"type":"string","default":"desc","enum":["desc","asc"]}},{"name":"timeframe","in":"query","required":false,"description":"Window of `rank` and of `min_pnl`. Default: the sort's window (pnlPerpDay 24h, pnlPerpWeek 7d, pnlPerpMonth 30d — so 30d for the default sort —, pnlPerpAllTime alltime), else alltime.","schema":{"type":"string","enum":["24h","7d","30d","alltime"]}},{"name":"min_account_value","in":"query","required":false,"description":"Only traders with at least this account value (USD; Explore's equity filter).","schema":{"type":"string","enum":["1000","10000","100000","1000000","10000000"]}},{"name":"min_pnl","in":"query","required":false,"description":"Only traders with at least this perp PnL (USD) in `timeframe`'s window (pnl_day, pnl_week, pnl_month or pnl_alltime); 0 = profitable.","schema":{"type":"string","enum":["0","10000","100000","1000000"]}},{"name":"min_copy_score","in":"query","required":false,"description":"Only traders with at least this copy score (`copy_score_v2`, Explore's copy-score filter).","schema":{"type":"string","enum":["50","70","90"]}},{"name":"tag","in":"query","required":false,"description":"Only traders with this style tag (Explore's trader-type filter).","schema":{"type":"string","enum":["algo","scalp","intraday","swing","position"]}},{"name":"max_account_value","in":"query","required":false,"description":"Only traders with at most this account value (USD).","schema":{"type":"string","enum":["10000","100000","1000000","10000000","100000000"]}},{"name":"max_pnl","in":"query","required":false,"description":"Only traders with at most this perp PnL (USD) in `timeframe`'s window; 0 = unprofitable.","schema":{"type":"string","enum":["0","-1000","-10000","-100000","-1000000"]}},{"name":"max_copy_score","in":"query","required":false,"description":"Only traders with at most this copy score (`copy_score_v2`).","schema":{"type":"string","enum":["30","50","70","90"]}},{"name":"winrate_window","in":"query","required":false,"description":"Window of min_winrate / max_winrate: winrate_7d, winrate_30d (default) or the lifetime winrate (wallets with at least one completed trade).","schema":{"type":"string","enum":["7d","30d","lifetime"]}},{"name":"min_winrate","in":"query","required":false,"description":"Only traders with at least this win rate (0–1) in `winrate_window`.","schema":{"type":"string","enum":["0.3","0.4","0.5","0.6","0.7","0.8","0.9"]}},{"name":"max_winrate","in":"query","required":false,"description":"Only traders with at most this win rate (0–1) in `winrate_window`.","schema":{"type":"string","enum":["0.1","0.2","0.3","0.4","0.5","0.6"]}},{"name":"min_sharpe","in":"query","required":false,"description":"Only traders with at least this 30-day Sharpe.","schema":{"type":"string","enum":["0","1","2","3","5"]}},{"name":"max_sharpe","in":"query","required":false,"description":"Only traders with at most this 30-day Sharpe.","schema":{"type":"string","enum":["0","-1","-2"]}},{"name":"drawdown_window","in":"query","required":false,"description":"Window of max_drawdown: 7d or 30d (default).","schema":{"type":"string","enum":["7d","30d"]}},{"name":"max_drawdown","in":"query","required":false,"description":"Only traders whose max drawdown (fraction of peak, 0–1) in `drawdown_window` is at most this.","schema":{"type":"string","enum":["0.05","0.1","0.2","0.3","0.5"]}},{"name":"trades_window","in":"query","required":false,"description":"Window of min_trades / max_trades: 7d, 30d (default) or total.","schema":{"type":"string","enum":["7d","30d","total"]}},{"name":"min_trades","in":"query","required":false,"description":"Only traders with at least this many trades in `trades_window`.","schema":{"type":"string","enum":["1","10","50","100","500","1000"]}},{"name":"max_trades","in":"query","required":false,"description":"Only traders with at most this many trades in `trades_window`.","schema":{"type":"string","enum":["10","50","100","500","1000"]}},{"name":"verified","in":"query","required":false,"description":"Only verified profiles.","schema":{"type":"string","enum":["true"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 1000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"rank":{"type":["integer","null"],"description":"Rank on the perp-PnL leaderboard of `timeframe` (null: not ranked in that window)"},"pnl_day":{"type":"string","description":"Perp PnL, 24 h (decimal string; may carry extra trailing zeros)"},"pnl_week":{"type":"string","description":"Perp PnL, 7 d (decimal string; may carry extra trailing zeros)"},"pnl_month":{"type":"string","description":"Perp PnL, 30 d (decimal string; may carry extra trailing zeros)"},"pnl_alltime":{"type":"string","description":"Perp PnL, all time (decimal string; may carry extra trailing zeros)"},"total_trades":{"type":"integer","description":"Completed trades"},"trades_7d":{"type":"integer","description":"Trades, 7 d"},"trades_30d":{"type":"integer","description":"Trades, 30 d"},"long_trades":{"type":"integer","description":"Long trades"},"short_trades":{"type":"integer","description":"Short trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"winrate":{"type":"string","description":"Win rate, lifetime (all completed trades) (decimal string; may carry extra trailing zeros)"},"winrate_7d":{"type":["string","null"],"description":"Win rate, 7 d (decimal string; may carry extra trailing zeros)"},"winrate_30d":{"type":["string","null"],"description":"Win rate, 30 d (hyperdash.com Explore's Win Rate column) (decimal string; may carry extra trailing zeros)"},"winrate_90d":{"type":["string","null"],"description":"Win rate, 90 d (decimal string; may carry extra trailing zeros)"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"last_fill_at":{"type":["integer","null"],"description":"Last fill, epoch ms"},"account_value":{"type":["string","null"],"description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"notional":{"type":["string","null"],"description":"Open notional (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"display_name":{"type":["string","null"],"description":"Display name"},"twitter":{"type":["string","null"],"description":"Twitter handle"},"tag":{"type":["string","null"],"description":"Tag"},"verified":{"type":"boolean","description":"Verified profile"},"label":{"type":["string","null"],"description":"Label"},"sharpe_7d":{"type":["string","null"],"description":"Sharpe, 7 d (decimal string; may carry extra trailing zeros)"},"sharpe_30d":{"type":["string","null"],"description":"Sharpe, 30 d (decimal string; may carry extra trailing zeros)"},"sortino_7d":{"type":["string","null"],"description":"Sortino, 7 d (decimal string; may carry extra trailing zeros)"},"sortino_30d":{"type":["string","null"],"description":"Sortino, 30 d (decimal string; may carry extra trailing zeros)"},"sortino_90d":{"type":["string","null"],"description":"Sortino, 90 d (decimal string; may carry extra trailing zeros)"},"max_drawdown_week":{"type":["string","null"],"description":"Max drawdown, 7 d (decimal string; may carry extra trailing zeros)"},"max_drawdown_month":{"type":["string","null"],"description":"Max drawdown, 30 d (decimal string; may carry extra trailing zeros)"},"max_drawdown_90d":{"type":["string","null"],"description":"Max drawdown, 90 d (decimal string; may carry extra trailing zeros)"},"gpr_7d":{"type":["string","null"],"description":"Gain-to-pain, 7 d (decimal string; may carry extra trailing zeros)"},"gpr_30d":{"type":["string","null"],"description":"Gain-to-pain, 30 d (decimal string; may carry extra trailing zeros)"},"gpr_90d":{"type":["string","null"],"description":"Gain-to-pain, 90 d (decimal string; may carry extra trailing zeros)"},"gpr_all_time":{"type":["string","null"],"description":"Gain-to-pain, all time (decimal string; may carry extra trailing zeros)"},"copy_score":{"type":["string","null"],"description":"Copy score (decimal string; may carry extra trailing zeros)"},"copy_score_v2":{"type":["string","null"],"description":"Copy score v2 (decimal string; may carry extra trailing zeros)"},"top_assets":{"type":"string","description":"Top assets (JSON: coin, volume, pnl)"},"total_volume":{"type":["string","null"],"description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"updated_at":{"type":"integer","description":"When this wallet's stats row was computed, epoch ms (about once a day per wallet; some inputs, e.g. account value, can be older)"},"avatar":{"type":["string","null"],"description":"Avatar image URL"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/traders/screener?sort=sharpe30d&limit=100'"}]}},"/v1/traders/cohort":{"get":{"operationId":"traderCohort","summary":"Curated profitable trader cohort","description":"Our curated cohort: traders with ≥ $100k perp PnL over 30 days and a fill in the last 7 days (the 2,000 most profitable at most), with wallets tagged algorithmic (style tag `algo`) and a fixed list (HLP and four of its child vaults, two system addresses, three hedged-fund wallets and one HIP-3 market maker) left out. Labelled market makers are left out only through the `algo` style tag and that list: one tagged otherwise would appear in the cohort. With their stats (win rates, trades, PnL windows, holding times, longest win streak). Each wallet's stats row is rebuilt about once a day, at a wallet-specific time (every 24–26 h), so its 24-hour, 7-day and 30-day PnL windows end around that rebuild, not now, and rows of one page can be up to a day apart: `updated_at` is when the row was computed (some inputs, e.g. account value, can be older still).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["traders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows (≤ 1000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":500}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"display_name":{"type":["string","null"],"description":"Display name"},"label":{"type":["string","null"],"description":"Label"},"tag":{"type":["string","null"],"description":"Tag"},"winrate":{"type":"string","description":"Win rate (decimal string; may carry extra trailing zeros)"},"winrate_7d":{"type":["string","null"],"description":"Win rate, 7 d (decimal string; may carry extra trailing zeros)"},"winrate_30d":{"type":["string","null"],"description":"Win rate, 30 d (decimal string; may carry extra trailing zeros)"},"winrate_90d":{"type":["string","null"],"description":"Win rate, 90 d (decimal string; may carry extra trailing zeros)"},"trades_7d":{"type":"integer","description":"Trades, 7 d"},"trades_30d":{"type":"integer","description":"Trades, 30 d"},"total_trades":{"type":"integer","description":"Completed trades"},"long_trades":{"type":"integer","description":"Long trades"},"short_trades":{"type":"integer","description":"Short trades"},"winning_trades":{"type":"integer","description":"Winning trades"},"losing_trades":{"type":"integer","description":"Losing trades"},"pnl_day":{"type":"string","description":"Perp PnL, 24 h (decimal string; may carry extra trailing zeros)"},"pnl_week":{"type":"string","description":"Perp PnL, 7 d (decimal string; may carry extra trailing zeros)"},"pnl_month":{"type":"string","description":"Perp PnL, 30 d (decimal string; may carry extra trailing zeros)"},"pnl_alltime":{"type":"string","description":"Perp PnL, all time (decimal string; may carry extra trailing zeros)"},"account_value":{"type":["string","null"],"description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"total_volume":{"type":["string","null"],"description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"copy_score":{"type":["string","null"],"description":"Copy score (decimal string; may carry extra trailing zeros)"},"avg_duration_minutes":{"type":"string","description":"Average holding time (min) (decimal string; may carry extra trailing zeros)"},"median_duration_minutes":{"type":"string","description":"Median holding time (min) (decimal string; may carry extra trailing zeros)"},"longest_win_streak":{"type":"integer","description":"Longest win streak"},"updated_at":{"type":["integer","null"],"description":"When this wallet's stats row was computed, epoch ms (about once a day per wallet; some inputs, e.g. account value, can be older)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/traders/cohort?limit=500'"}]}},"/v1/builders/{builder}/members":{"get":{"operationId":"builderMembers","summary":"Wallets of a builder code","description":"Every wallet that has traded through one builder code (address of the builder).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["builders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"builder","in":"path","required":true,"description":"Builder address, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 1000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/builders/0x…/members'"}]}},"/v1/builders/sub-builders":{"get":{"operationId":"listSubBuilderEarnings","summary":"Sub-builder earnings","description":"HL sub-builders (live 2026-10-28): an order's builder code can share its builder fee with up to 5 sub-builders. Each fill carries its own split (its sub-builders and their shares), so earnings are computed per fill: builder fee × share (complete since the first sub-builder fills, 2026-10-31). Per sub-builder and fee token over a window of fill time: the builders that pay it, orders, fills, notional and what it earned (builder fee × its share). Optional builder / sub_builder filters. A fill shared by several sub-builders counts in each of their rows: don't add fills or notional across sub-builders. Highest earnings first; at most 1,000 rows per query (your plan's wallet-list cap; meta.truncated reports a cut).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["builders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start of the fill-time window, epoch ms. Default: end − 7 days (≤ 30 days).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now.","schema":{"type":"integer"}},{"name":"builder","in":"query","required":false,"description":"Only shares paid by this builder (0x + 40 hex).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"sub_builder","in":"query","required":false,"description":"Only this sub-builder (0x + 40 hex).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 500).","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"sub_builder":{"type":"string","description":"Sub-builder"},"fee_token":{"type":"string","description":"Token the builder fee is paid in (USDC, …)"},"builders":{"type":"integer","description":"Builders sharing with it"},"orders":{"type":"integer","description":"Orders filled in the window"},"fills":{"type":"integer","description":"Fills"},"notional":{"type":"string","description":"Filled notional (px × size, in each market's quote) (decimal string; may carry extra trailing zeros)"},"earned":{"type":"string","description":"Earned: builder fee × share, in fee_token (decimal string; may carry extra trailing zeros)"},"fee_unreported_fills":{"type":"integer","description":"Fills whose builder fee the node did not report (not counted in earned)"},"first_fill":{"type":"integer","description":"First fill, epoch ms"},"last_fill":{"type":"integer","description":"Last fill, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/builders/sub-builders'"}]}},"/v1/builders/{builder}/sub-builders":{"get":{"operationId":"getBuilderSubBuilderSplit","summary":"How a builder shares its fees","description":"HL sub-builders (live 2026-10-28): an order's builder code can share its builder fee with up to 5 sub-builders. Each fill carries its own split (its sub-builders and their shares), so earnings are computed per fill: builder fee × share (complete since the first sub-builder fills, 2026-10-31). For one builder over a window of fill time, on its fills that name sub-builders, per fee token: kind=split_total (those fills and their builder fee, each fill once), kept (what the builder keeps of it) and paid (one row per sub-builder). Fills without sub-builders are not included (the builder keeps their whole fee). At most 1,000 rows per query (your plan's wallet-list cap; meta.truncated reports a cut).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["builders"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"builder","in":"path","required":true,"description":"Builder address, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"start_time","in":"query","required":false,"description":"Start of the fill-time window, epoch ms. Default: end − 7 days (≤ 30 days).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 500).","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"split_total, kept or paid"},"sub_builder":{"type":["string","null"],"description":"Sub-builder (paid rows)"},"fee_token":{"type":"string","description":"Token the builder fee is paid in"},"orders":{"type":"integer","description":"Orders filled in the window"},"fills":{"type":"integer","description":"Fills"},"notional":{"type":"string","description":"Filled notional (px × size, in each market's quote) (decimal string; may carry extra trailing zeros)"},"fee":{"type":"string","description":"Builder fee (split_total), kept or paid, in fee_token (decimal string; may carry extra trailing zeros)"},"fee_unreported_fills":{"type":"integer","description":"Fills whose builder fee the node did not report (not counted in fee)"},"first_fill":{"type":"integer","description":"First fill, epoch ms"},"last_fill":{"type":"integer","description":"Last fill, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/builders/0x…/sub-builders'"}]}},"/v1/leaderboards/portfolio":{"get":{"operationId":"portfolioLeaderboard","summary":"Portfolio-PnL leaderboard","description":"Traders ranked by unrealized PnL, unrealized PnL %, total PnL, realized PnL % or total PnL % (Hyperliquid portfolio PnL over a window, which already includes open positions), with profile, account value and top assets. Top 500 per sort and window. totalPnl = the window's portfolio PnL; realizedPnlPct and totalPnlPct are the same ratio (portfolio PnL ÷ current account value) and realizedPnlPct is deprecated (not realized-only). For hyperdash.com's leaderboard (realized / unrealized split, ROI ÷ capital: equity at the window start + peak net inflow) use GET /v1/leaderboards/pnl with sort=total, realized, roi or realized_roi. Each wallet's stats row is rebuilt about once a day, at a wallet-specific time (every 24–26 h), so its 24-hour, 7-day and 30-day PnL windows end around that rebuild, not now, and rows of one page can be up to a day apart: `updated_at` is when the row was computed (some inputs, e.g. account value, can be older still). Ranks compare those rows as they are.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["leaderboards"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"sort","in":"query","required":false,"description":"Ranking. realizedPnlPct is deprecated (same as totalPnlPct; see the description).","schema":{"type":"string","default":"unrealizedPnl","enum":["unrealizedPnl","unrealizedPnlPct","totalPnl","realizedPnlPct","totalPnlPct"]}},{"name":"window","in":"query","required":false,"description":"PnL window.","schema":{"type":"string","default":"alltime","enum":["day","week","month","alltime"]}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"rank":{"type":"integer","description":"Rank"},"address":{"type":"string","description":"Wallet"},"display_name":{"type":["string","null"],"description":"Display name"},"label":{"type":["string","null"],"description":"Label"},"tag":{"type":["string","null"],"description":"Tag"},"account_value":{"type":["string","null"],"description":"Account value (USD) (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":["string","null"],"description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"pnl_day":{"type":"string","description":"Perp PnL, 24 h (decimal string; may carry extra trailing zeros)"},"pnl_week":{"type":"string","description":"Perp PnL, 7 d (decimal string; may carry extra trailing zeros)"},"pnl_month":{"type":"string","description":"Perp PnL, 30 d (decimal string; may carry extra trailing zeros)"},"pnl_alltime":{"type":"string","description":"Perp PnL, all time (decimal string; may carry extra trailing zeros)"},"winrate":{"type":"string","description":"Win rate (decimal string; may carry extra trailing zeros)"},"total_trades":{"type":"integer","description":"Completed trades"},"total_volume":{"type":["string","null"],"description":"Volume (USD) (decimal string; may carry extra trailing zeros)"},"copy_score":{"type":["string","null"],"description":"Copy score (decimal string; may carry extra trailing zeros)"},"top_assets":{"type":"string","description":"Top assets (JSON: coin, volume, pnl)"},"last_trade_at":{"type":["integer","null"],"description":"Last trade, epoch ms"},"verified":{"type":"boolean","description":"Verified profile"},"sort_value":{"type":["string","null"],"description":"The ranked value (decimal string; may carry extra trailing zeros)"},"updated_at":{"type":["integer","null"],"description":"When this wallet's stats row was computed, epoch ms (about once a day per wallet; some inputs, e.g. account value, can be older)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/leaderboards/portfolio?sort=totalPnl&window=week'"}]}},"/v1/markets/{coin}/position-book":{"get":{"operationId":"marketPositionBook","summary":"Position book at a past time","description":"Long and short totals of one market at `at` (≤ 7 days ago) and its largest positions then: wallet, size, notional, entry, liquidation price, unrealized PnL, leverage, and whether the position is still open or was liquidated since.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"at","in":"query","required":true,"description":"Time, epoch ms (≤ 7 days ago).","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 100).","schema":{"type":"integer","minimum":1,"maximum":100,"default":30}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"top (one position), long or short (side totals)"},"snapshot_time":{"type":["integer","null"],"description":"Snapshot used, epoch ms"},"address":{"type":["string","null"],"description":"Wallet (top rows)"},"size":{"type":["string","null"],"description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":["string","null"],"description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"leverage":{"type":["string","null"],"description":"Leverage (decimal string; may carry extra trailing zeros)"},"still_open":{"type":"boolean","description":"Still open now"},"liquidated_since":{"type":"boolean","description":"Liquidated since"},"positions":{"type":"integer","description":"Positions (side totals)"},"current_snapshot_time":{"type":["integer","null"],"description":"Latest snapshot, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/position-book?at=1792843200000'"}]}},"/v1/markets/{coin}/footprint/all-wallets":{"get":{"operationId":"footprintAllWallets","summary":"Every wallet behind a footprint bar","description":"Every wallet that traded in one bar of one market (from–to minute-aligned, ≤ 1 day), per side: size, notional, fills and the taker part, plus side totals. Largest first; up to 1,000 wallets per side.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"from","in":"query","required":true,"description":"Bar start, epoch ms (minute-aligned).","schema":{"type":"integer"}},{"name":"to","in":"query","required":true,"description":"Bar end, epoch ms (minute-aligned, ≤ 1 day after from).","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 1000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"side":{"type":"string","description":"buy or sell"},"address":{"type":"string","description":"Wallet"},"size":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"fills":{"type":"integer","description":"Fills"},"taker_size":{"type":"string","description":"Taker size (decimal string; may carry extra trailing zeros)"},"taker_notional":{"type":"string","description":"Taker notional (decimal string; may carry extra trailing zeros)"},"taker_fills":{"type":"integer","description":"Taker fills"},"side_wallets":{"type":"integer","description":"Wallets on this side"},"side_size":{"type":"string","description":"Side size (decimal string; may carry extra trailing zeros)"},"side_notional":{"type":"string","description":"Side notional (decimal string; may carry extra trailing zeros)"},"side_fills":{"type":"integer","description":"Side fills"},"side_taker_size":{"type":["string","null"],"description":"The side's taker size (all wallets of the side) (decimal string; may carry extra trailing zeros)"},"side_taker_notional":{"type":["string","null"],"description":"The side's taker notional (USD) (decimal string; may carry extra trailing zeros)"},"side_taker_fills":{"type":["integer","null"],"description":"The side's taker fills"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/footprint/all-wallets?from=1792843200000&to=1792846800000'"}]}},"/v1/accounts/{address}/position-history":{"get":{"operationId":"accountPositionHistory","summary":"Positions at chosen times","description":"The wallet's open perp positions at each requested time (up to 20 instants), from the newest positions snapshot (about every 12 min) at or before it: market, size, notional, entry, liquidation price, unrealized and funding PnL. A time at which the wallet held no perp position returns one row with `positions` 0 and an empty `market` (snapshot_time = that snapshot); a time before any snapshot we hold returns that row with snapshot_time 0, or no row on plans with a history depth. Flat wallets are recognised from 2026-10-11 (the exchange-wide snapshot index); for earlier times a flat wallet still shows its last snapshot. funding_pnl is funding since the position opened (snapshots before 2026-11-12: the wallet's all-time funding on that market). Times and snapshots must be inside your plan's history depth.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"times","in":"query","required":true,"description":"Comma-separated epoch ms, up to 20.","schema":{"type":"string","pattern":"^\\d{10,13}(,\\d{10,13}){0,19}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 200).","schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"requested_time":{"type":"integer","description":"Requested instant, epoch ms"},"snapshot_time":{"type":"integer","description":"Snapshot used, epoch ms"},"market":{"type":"string","description":"Market"},"size":{"type":"string","description":"Size (base, signed) (decimal string; may carry extra trailing zeros)"},"notional":{"type":"string","description":"Notional (USD) (decimal string; may carry extra trailing zeros)"},"entry_px":{"type":"string","description":"Entry price (decimal string; may carry extra trailing zeros)"},"liquidation_px":{"type":["string","null"],"description":"Liquidation price (decimal string; may carry extra trailing zeros)"},"unrealized_pnl":{"type":"string","description":"Unrealized PnL (USD) (decimal string; may carry extra trailing zeros)"},"funding_pnl":{"type":"string","description":"Funding PnL (USD) (decimal string; may carry extra trailing zeros)"},"positions":{"type":"integer","description":"Open positions at that time"},"total_unrealized_pnl":{"type":"string","description":"Total unrealized PnL then (USD) (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/position-history?times=1792843200000,1792929600000'"}]}},"/v1/accounts/{address}/pnl-history":{"get":{"operationId":"accountPnl90d","summary":"Daily perp PnL, last 90 days","description":"The wallet's daily perp trading PnL (fills, funding, fees and marks; no spot, transfers or staking) over the 90 days of the copy-score window, which ends at `as_of` (1–2 days behind today), and the 90-day total. On a plan with a shorter history depth only the dates inside it are returned (the total stays the 90-day one). For the hyperdash.com PnL calendar use GET /v1/accounts/{address}/pnl-calendar.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 100 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet, 0x + 40 hex.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"UTC date (YYYY-MM-DD)"},"pnl":{"type":"string","description":"Perp PnL that day (USD) (decimal string; may carry extra trailing zeros)"},"pnl_90d":{"type":"string","description":"90-day total (USD) (decimal string; may carry extra trailing zeros)"},"as_of":{"type":["string","null"],"description":"Data as of (UTC date)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/0x…/pnl-history'"}]}},"/v1/accounts/batch/recent-trades":{"get":{"operationId":"batchRecentTrades","summary":"Newest completed trades of many wallets","description":"The newest completed trades (direction, net PnL, close time) of up to 25 wallets in one call, up to 50 per wallet, optionally one market, from hyperdash.com's completed-trades table (its Completed Trades tab). That table is refreshed wallet by wallet — by a sweep over recently active wallets (a busy wallet at most every 2 hours; a backlog stretches that to days) and whenever the wallet's hyperdash.com profile is opened — so trades a wallet closed since its last refresh are not here yet (2026-11-11: 58 % of all trades closed in the previous 3 hours were missing). Trades closed in the last 365 days only.\n\nPricing: base + per row. Scope: `accounts:read`.","tags":["accounts"],"security":[{"bearer":[]}],"x-scope":"accounts:read","parameters":[{"name":"addresses","in":"query","required":true,"description":"Comma-separated wallets (≤ 25).","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}(,0x[0-9a-fA-F]{40}){0,24}$"}},{"name":"per_address","in":"query","required":false,"description":"Trades per wallet (≤ 50).","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"market","in":"query","required":false,"description":"One market (optional).","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Wallet"},"coin":{"type":"string","description":"Market"},"direction":{"type":"string","description":"Direction"},"net_pnl":{"type":"string","description":"Net PnL (USD) (decimal string; may carry extra trailing zeros)"},"close_time":{"type":"integer","description":"Closed at, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/accounts/batch/recent-trades?addresses=0x…,0x…'"}]}},"/v1/network/trader-classes/{trader_class}":{"get":{"operationId":"traderClassStats","summary":"Trader-class aggregates for a year","description":"Traders, volume, PnL, trades, average win rate and Sharpe of one trader class (Scalper, Executioner, Toxic Taker, Sniper, Ronin) in Hyperdash's year in review (GET /v1/accounts/{address}/year-summary summed over every wallet of the class). Only 2025 is built (one build, 2026-10-09), so `year` accepts 2025 only; a later year opens once its build exists. Volume, PnL and trades are the year's completed trades; the class and win rate are each wallet's lifetime stats as of the build, the Sharpe its cached trailing 30-day Sharpe then.\n\nPricing: base. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"trader_class","in":"path","required":true,"description":"Trader class.","schema":{"type":"string","enum":["Scalper","Executioner","Toxic Taker","Sniper","Ronin"]}},{"name":"year","in":"query","required":false,"description":"Year of the year-in-review build (2025 only today).","schema":{"type":"integer","minimum":2025,"maximum":2025,"default":2025}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","description":"Trader class"},"traders":{"type":"integer","description":"Traders"},"total_volume":{"type":"string","description":"Completed-trade volume closed in the year (USD) (decimal string; may carry extra trailing zeros)"},"total_pnl":{"type":"string","description":"Completed-trade PnL closed in the year (USD) (decimal string; may carry extra trailing zeros)"},"total_trades":{"type":"integer","description":"Completed trades closed in the year"},"avg_winrate":{"type":"string","description":"Average lifetime win rate as of the build (decimal string; may carry extra trailing zeros)"},"avg_sharpe_30d":{"type":"string","description":"Average of the wallets' cached trailing 30-day Sharpe at the build (decimal string; may carry extra trailing zeros)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/trader-classes/Sniper?year=2025'"}]}},"/v1/markets/traded-assets":{"get":{"operationId":"tradedAssets","summary":"Every perp market's trading totals","description":"Every perp market (core, and HIP-3 as `dex:COIN`) in Hyperdash's fill record with its market totals, largest volume first: `volume` = traded notional (price × size, each trade counted once), `trades` = trades (each match once; liquidations and auto-deleveraging included), `traders` = distinct wallets that filled in it as maker or taker. Spot pairs and HIP-4 outcome contract sides are not listed (outcomes: GET /v1/outcomes/*). The totals cover Hyperdash's own fill record: complete from 2025-05-26 (within 0.01 % of Hyperliquid's own trade counts) and partial before, so a market that traded before then understates its early history (BTC: about 85 B of about 620 B USD of its 2023 to May 2025 trading is in the record); `first_trade_hour` shows where each market's record starts. Cached up to 1 h.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows (≤ 1000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market (core coin, or dex:COIN for a HIP-3 market)"},"volume":{"type":"string","description":"Traded notional (USD): price × size, each trade counted once (decimal string; may carry extra trailing zeros)"},"trades":{"type":"integer","description":"Trades (each match once)"},"traders":{"type":"integer","description":"Distinct wallets with a fill in the market (maker or taker)"},"first_trade_hour":{"type":"integer","description":"UTC hour of the market's first trade in Hyperdash's fill record, epoch ms (before 2025-05-26 the record is partial)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/traded-assets'"}]}},"/v1/network/trader-profitability/window":{"get":{"operationId":"traderProfitabilityWindow","summary":"Profitable share per cohort over a window","description":"For whole UTC days [start_time, end_time) (≤ 30 days): traders, profitable and unprofitable counts, PnL sum and median ROI per account-size cohort — account value at the window's last day close: small < $10K, medium $10K–100K, large $100K–1M, whale $1M–5M, apex $5M+, unknown (no close snapshot yet, or none); all = every trader with perp PnL in the window except vaults and the 13 accounts Hyperdash's rankings exclude (HLP and its child vaults, the system addresses 0xfefe…fefe and 0xffff…ffff, and three wallets it treats as hedged funds: 0xb83de012dba672c76a7dbbbf3e459cb59d7d6e36, 0x5b5d51203a0f9079f8aeb098a6523a13f298c060, 0x49e96e255ba418d08e66c35b588e2f2f3766e1d0). A day is complete about 31 h after it closes: until then its close account values are still filling in (so many traders sit in `unknown` and the size cohorts are short) and its PnL is recomputed; later rewrites of close values can still move a few traders for up to 7 days. The default window ends today 00:00 UTC, on such a day: meta.complete says whether every day of the window is complete, meta.complete_until (epoch ms) is the latest end_time that is. Each row carries its band (min_usd, max_usd); GET /v1/network/trader-distribution's tiers share some names with other bands.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 20 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (UTC midnight). Default: 7 days before end.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (UTC midnight). Default: today 00:00 UTC.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"cohort":{"type":"string","description":"Account-size cohort"},"min_usd":{"type":["string","null"],"description":"Band lower bound, inclusive (USD; null: open) (decimal string; may carry extra trailing zeros)"},"max_usd":{"type":["string","null"],"description":"Band upper bound, exclusive (USD; null: open) (decimal string; may carry extra trailing zeros)"},"traders":{"type":"integer","description":"Traders"},"profitable":{"type":"integer","description":"Profitable"},"unprofitable":{"type":"integer","description":"Unprofitable"},"pnl_sum":{"type":"string","description":"PnL sum (USD) (decimal string; may carry extra trailing zeros)"},"median_roi":{"type":"string","description":"Median ROI (decimal string; may carry extra trailing zeros)"},"roi_traders":{"type":"integer","description":"Traders with an ROI"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/trader-profitability/window'"}]}},"/v1/liquidations/minutes":{"get":{"operationId":"liquidationMinutes","summary":"Liquidations per minute","description":"Long and short liquidated notional and event counts per minute, all markets, over [start_time, end_time) (≤ 1 day).\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 1,441 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end − 1 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Minute start, epoch ms"},"long_notional":{"type":"string","description":"Longs liquidated (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Shorts liquidated (USD) (decimal string; may carry extra trailing zeros)"},"long_events":{"type":"integer","description":"Long liquidations"},"short_events":{"type":"integer","description":"Short liquidations"},"events":{"type":"integer","description":"Liquidations"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations/minutes'"}]}},"/v1/liquidations/mix":{"get":{"operationId":"liquidationMix","summary":"Liquidations per market over a window","description":"Long, short and total liquidated notional and events per market over [start_time, end_time) (≤ 1 day), largest first.\n\nPricing: base + per row. X-Max-Credits / GET /v1/quote: this route's ceiling is priced at its cap of 2,000 rows, whatever the parameters (this route reserves the same rows for any request, mostly because their number cannot be known before it runs), plus any range tier or node reads; you are charged for the rows returned. Use GET /v1/quote for the exact ceiling, and omit X-Max-Credits or set it to at least that ceiling. Scope: `analytics:read`.","tags":["liquidations"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms. Default: end − 1 day.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms. Default: now.","schema":{"type":"integer"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string","description":"Market"},"long_notional":{"type":"string","description":"Longs liquidated (USD) (decimal string; may carry extra trailing zeros)"},"short_notional":{"type":"string","description":"Shorts liquidated (USD) (decimal string; may carry extra trailing zeros)"},"total_notional":{"type":"string","description":"Total (USD) (decimal string; may carry extra trailing zeros)"},"events":{"type":"integer","description":"Liquidations"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/liquidations/mix'"}]}},"/v1/markets/{coin}/options-iv":{"get":{"operationId":"optionsIv","summary":"Options implied volatility (Deribit)","description":"Deribit options implied volatility of BTC or ETH: the latest term structure (`mode=latest`) or the daily 30-day IV history (`mode=daily`, start/end ≤ 365 days). `data` is the source record (JSON).\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"BTC or ETH.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$","enum":["BTC","ETH"]}},{"name":"mode","in":"query","required":false,"description":"latest or daily.","schema":{"type":"string","default":"latest","enum":["latest","daily"]}},{"name":"start_time","in":"query","required":false,"description":"daily: start, epoch ms (default end − 90 days).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"daily: end, epoch ms.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 1000).","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"Record kind"},"snapshot_time":{"type":"integer","description":"Snapshot, epoch ms"},"data":{"type":"string","description":"Record (JSON)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/options-iv?mode=latest'"}]}},"/v1/network/venue-share":{"get":{"operationId":"venueShare","summary":"Perp venue market share (CoinGlass)","description":"Perp exchanges' share of volume and open interest: the latest snapshot (`mode=latest`) or the daily history (`mode=daily`, ≤ 365 days), with `data` = the source record (JSON); or the hourly history (`mode=hourly`) as typed fields: each venue's 24 h volume and open interest, the all-venue totals, its shares (%) and Hyperliquid's rank among venues — ≤ 7 days per call for every venue, ≤ 365 days for one `venue`. Hourly history: Hyperliquid from 2026-04-05, every venue from 2026-10-11 12:00 UTC. `venue` filters any mode.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"mode","in":"query","required":false,"description":"latest, daily or hourly.","schema":{"type":"string","default":"latest","enum":["latest","daily","hourly"]}},{"name":"venue","in":"query","required":false,"description":"One venue key, e.g. hyperliquid, binance (omit for every venue).","schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,39}$"}},{"name":"start_time","in":"query","required":false,"description":"daily / hourly: start, epoch ms (default end − 90 days daily, end − 7 days hourly).","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"daily / hourly: end, epoch ms (exclusive).","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 5000).","schema":{"type":"integer","minimum":1,"maximum":5000,"default":5000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","description":"Venue key"},"snapshot_time":{"type":"integer","description":"Snapshot, epoch ms"},"data":{"type":["string","null"],"description":"latest / daily: the source record (JSON); hourly: null"},"name":{"type":["string","null"],"description":"hourly: venue name"},"volume_usd":{"type":["string","null"],"description":"hourly: 24 h volume (USD) (decimal string; may carry extra trailing zeros)"},"oi_usd":{"type":["string","null"],"description":"hourly: open interest (USD) (decimal string; may carry extra trailing zeros)"},"total_volume_usd":{"type":["string","null"],"description":"hourly: 24 h volume of every venue (USD; null with `venue` when CoinGlass published no total for the hour) (decimal string; may carry extra trailing zeros)"},"total_oi_usd":{"type":["string","null"],"description":"hourly: open interest of every venue (USD; null as total_volume_usd) (decimal string; may carry extra trailing zeros)"},"volume_share_pct":{"type":["string","null"],"description":"hourly: volume_usd ÷ total_volume_usd × 100 (decimal string; may carry extra trailing zeros)"},"oi_share_pct":{"type":["string","null"],"description":"hourly: oi_usd ÷ total_oi_usd × 100 (decimal string; may carry extra trailing zeros)"},"volume_rank":{"type":["integer","null"],"description":"hourly: Hyperliquid's volume rank among venues (Hyperliquid rows only)"},"oi_rank":{"type":["integer","null"],"description":"hourly: Hyperliquid's open-interest rank among venues (Hyperliquid rows only)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/venue-share?mode=hourly&venue=hyperliquid&start_time=1790000000000'"}]}},"/v1/network/etf-flows/{asset}":{"get":{"operationId":"etfFlows","summary":"Spot ETF flows","description":"Daily net flows of every spot ETF of one asset (BTC, ETH, SOL, HYPE, …) with shares outstanding, NAV, net assets and coins held, per source (issuer, SoSoValue, Farside). HYPE ETFs come from Farside's per-fund flows (source farside; issuer metrics null), from the first day Hyperdash mirrors them. Dates inside your plan's history depth.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["network"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"asset","in":"path","required":true,"description":"Asset, e.g. BTC, ETH, SOL, HYPE.","schema":{"type":"string","pattern":"^[A-Z0-9]{2,10}$"}},{"name":"limit","in":"query","required":false,"description":"Rows (≤ 10000).","schema":{"type":"integer","minimum":1,"maximum":10000,"default":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor.","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"UTC date"},"fund":{"type":"string","description":"Fund"},"source":{"type":"string","description":"Source"},"flow_usd":{"type":["string","null"],"description":"Net flow (USD) (decimal string; may carry extra trailing zeros)"},"span_days":{"type":"integer","description":"Days the flow spans"},"prev_date":{"type":"string","description":"Previous date"},"shares_outstanding":{"type":["string","null"],"description":"Shares outstanding (decimal string; may carry extra trailing zeros)"},"nav_per_share":{"type":["string","null"],"description":"NAV per share (decimal string; may carry extra trailing zeros)"},"net_assets":{"type":["string","null"],"description":"Net assets (USD) (decimal string; may carry extra trailing zeros)"},"coins_held":{"type":["string","null"],"description":"Coins held (decimal string; may carry extra trailing zeros)"},"fetched_at":{"type":"integer","description":"Fetched, epoch ms"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/network/etf-flows/BTC'"}]}},"/v1/markets/{coin}/priority-fills":{"get":{"operationId":"getPriorityFills","summary":"IOC fills that paid priority gas","description":"Every fill of one market that paid IOC (write) priority in [start_time, end_time) (≤ 1 h), ascending by time: wallet, order id, side, price, size, the HYPE burned for that fill. History before the live tail (~1 h) from the history store, the rest live from Hyperdash's workers. A full page returns next_cursor (pass it with nothing else); with no next_cursor, poll again with start_time = meta.end_time. One query returns at most your plan's wallet-list cap across its pages (Growth 500, Scale and Enterprise 1,000); a query cut there ends with meta.truncated = true and no next_cursor: start a new one from the last row's time. meta.start_time / meta.end_time = the window this page covers: rows are complete in it outside meta.gaps ([{from, to}] not proven, e.g. a worker restart). meta.live_to = the live feed's newest block time (meta.as_of), meta.stale = true when it lags > 15 s. Growth plans and above.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page.","schema":{"type":"integer","minimum":1,"maximum":5000,"default":2000}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 h. Window ≤ 1 h.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Epoch ms"},"user":{"type":"string","description":"Wallet"},"side":{"type":"string","description":"B (buy) or A (sell)"},"tid":{"type":"string","description":"Trade id (decimal string)"},"oid":{"type":"string","description":"Order id (decimal string)"},"px":{"type":"string","description":"Price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"crossed":{"type":"boolean","description":"Taker"},"priority_gas":{"type":"string","description":"HYPE burned for this fill (an order's priority fee is spread over its fills pro rata to notional) (decimal string; may carry extra trailing zeros)"},"hash":{"type":"string","description":"Transaction hash"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/priority-fills?limit=500'"}]}},"/v1/markets/{coin}/alo-priority":{"get":{"operationId":"getAloPriority","summary":"Resting ALO orders that bought queue priority","description":"Every order of one market that rested with queue priority (grouping.p) in [start_time, end_time) (≤ 10 min, live only), ascending by time, with the rate p and the fee in USD. Rows come in block order (time, then their place in the block); a block holding more orders than limit is split across pages (next_cursor keeps the place), so any limit reads every row (up to the wallet-list cap below). Polling: pass start_time = the previous response's meta.end_time (follow next_cursor first while has_more). One query returns at most your plan's wallet-list cap across its pages (Growth 500, Scale and Enterprise 1,000); a query cut there ends with meta.truncated = true and no next_cursor: start a new one from the last row's time (its block is served again from the start; a block larger than the cap itself is cut there: start after its time to go on). meta.start_time / meta.end_time = the window this page covers: rows are complete in it outside meta.gaps ([{from, to}] not proven, e.g. a worker restart). meta.live_to = the live feed's newest block time (meta.as_of), meta.stale = true when it lags > 15 s. Growth plans and above.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (a block larger than this is split across pages).","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 min. Window ≤ 10 min.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Block time the order rested with priority, epoch ms"},"oid":{"type":"string","description":"Order id (decimal string)"},"user":{"type":"string","description":"Wallet that paid"},"side":{"type":"string","description":"B (bid), A (ask) or ? (unknown)"},"px":{"type":"string","description":"Limit price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"p":{"type":"integer","description":"Queue priority rate bought (grouping.p)"},"tif":{"type":"string","description":"Time in force (Alo, or a resting Gtc)"},"fee_usd":{"type":"string","description":"Priority fee, USD: px × sz × p / 1e8 (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height the order was placed in"},"bundle_index":{"type":"integer","description":"Bundle in the block (block order)"},"action_index":{"type":"integer","description":"Action in the bundle"},"order_index":{"type":"integer","description":"Order in the action (a batch of orders)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/alo-priority?start_time=1793000000000'"}]}},"/v1/markets/{coin}/alo-priority/lookup":{"post":{"operationId":"lookupAloPriority","summary":"Which orders paid for queue priority","description":"For order ids of one market (e.g. from GET /v1/markets/{coin}/book/orders), JSON body {\"oids\": [...]} (≤ 2,000, and ≤ your plan's wallet-list cap: Growth 500, Scale and Enterprise 1,000): one row per order seen resting with priority in the live window (the last ~10 min, meta.start_time on). Order ids not returned are listed in meta.unknown_oids: UNKNOWN (placed before the window, or a gap in meta.gaps), not \"no priority\". Growth plans and above.\n\nPricing: base + per row. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["oids"],"properties":{"oids":{"type":"array","items":{"type":"string","pattern":"^[0-9]{1,20}$"},"minItems":1,"maxItems":2000,"description":"Order ids (decimal strings), ≤ 2,000, deduplicated."}}}}}},"parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"integer","description":"Block time the order rested with priority, epoch ms"},"oid":{"type":"string","description":"Order id (decimal string)"},"user":{"type":"string","description":"Wallet that paid"},"side":{"type":"string","description":"B (bid), A (ask) or ? (unknown)"},"px":{"type":"string","description":"Limit price (decimal string; may carry extra trailing zeros)"},"sz":{"type":"string","description":"Size (base) (decimal string; may carry extra trailing zeros)"},"p":{"type":"integer","description":"Queue priority rate bought (grouping.p)"},"tif":{"type":"string","description":"Time in force (Alo, or a resting Gtc)"},"fee_usd":{"type":"string","description":"Priority fee, USD: px × sz × p / 1e8 (decimal string; may carry extra trailing zeros)"},"block":{"type":"integer","description":"Block height the order was placed in"},"bundle_index":{"type":"integer","description":"Bundle in the block (block order)"},"action_index":{"type":"integer","description":"Action in the bundle"},"order_index":{"type":"integer","description":"Order in the action (a batch of orders)"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Not found: an unknown market, dex or token","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -X POST -H 'Authorization: Bearer $HD_KEY' -H 'content-type: application/json' -d '{\"oids\":[\"586119480698\"]}' 'https://data.hyperdash.com/v1/markets/BTC/alo-priority/lookup'"}]}},"/v1/markets/{coin}/alo-priority/bars":{"get":{"operationId":"getAloPriorityBars","summary":"ALO priority payers per bar","description":"Per bar of `interval` in [start_time, end_time) (widened to whole bars, ≤ 7 days): the wallets whose orders rested with queue priority, largest fee first (`payers` per bar), with the bar's totals over ALL payers. A page holds whole bars (⌊limit / payers⌋ of them); page with the cursor. payers ≤ your plan's wallet-list cap, and one query returns at most that many rows across its pages; a query cut there ends with meta.truncated = true (start a new one at meta.end_time). meta.start_time / meta.end_time = this page's bars, complete outside meta.gaps; meta.live_to = the newest minute loaded (the last ~2 min provisional). History from 2026-10-27 14:00 UTC. Growth plans and above.\n\nPricing: base + per row; ×2 above 24 h. Scope: `analytics:read`.","tags":["markets"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"coin","in":"path","required":true,"description":"Market, e.g. BTC, xyz:TSLA.","schema":{"type":"string","pattern":"^[A-Za-z0-9:_\\-/@.]{1,40}$"}},{"name":"interval","in":"query","required":false,"description":"Bar size.","schema":{"type":"string","default":"1h","enum":["1m","5m","15m","30m","1h","4h","1d"]}},{"name":"payers","in":"query","required":false,"description":"Wallets per bar (largest fee first).","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"name":"limit","in":"query","required":false,"description":"Rows per page (whole bars: ⌊limit / payers⌋ of them; payers ≤ limit).","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"name":"start_time","in":"query","required":false,"description":"Start, epoch ms (inclusive). Default: end_time − 1 day. Window ≤ 7 days.","schema":{"type":"integer"}},{"name":"end_time","in":"query","required":false,"description":"End, epoch ms (exclusive). Default: now.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from next_cursor (replaces the range).","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more. The check compares your limit with the MOST the request could cost, before it runs: GET /v1/quote with the same route and parameters (cursor included) returns exactly that maximum, never below the charge. Where the number of rows cannot be known from the request (a wallet's or the exchange's current state, every market, price levels per bar…) that maximum is priced at the route's row cap (plus any range tier or node reads), while you are charged for the rows actually returned: such operations say so in their pricing note. There, omit X-Max-Credits or set it to at least the quoted ceiling.","schema":{"type":"integer"}},{"name":"X-Credit-Price-Version","in":"header","required":false,"description":"Expected price version; 409 price_changed if it differs.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-Credits-Charged":{"schema":{"type":"integer"}},"X-Credit-Price-Version":{"schema":{"type":"integer"}},"X-Request-Id":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","has_more","next_cursor","meta"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Bar start, epoch ms"},"user":{"type":"string","description":"Wallet that paid"},"side":{"type":"string","description":"B (bid) or A (ask)"},"resting":{"type":"integer","description":"Its orders that rested with priority"},"notional_usd":{"type":"string","description":"Their notional (px × sz, USD) (decimal string; may carry extra trailing zeros)"},"fee_usd":{"type":"string","description":"Their priority fees, USD (decimal string; may carry extra trailing zeros)"},"max_p":{"type":"integer","description":"Highest priority rate"},"bar_resting":{"type":"integer","description":"Bar total: priority orders (all payers)"},"bar_fee_usd":{"type":"string","description":"Bar total: priority fees, USD (all payers) (decimal string; may carry extra trailing zeros)"},"bar_payers":{"type":"integer","description":"Bar total: distinct paying wallets"}}}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"Invalid parameter (also: a request body that is not valid JSON)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Invalid, expired or revoked key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Price version changed, or a cursor's snapshot expired","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Rate limited (Retry-After; free): request rate, concurrent requests (a request counts one slot per 1,000 rows it can return), or this server busy with your workspace's requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"502":{"description":"Upstream data source failed (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"Backend at capacity or temporarily unavailable (Retry-After)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"504":{"description":"Upstream data source timed out (free; retry later)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl -H 'Authorization: Bearer $HD_KEY' 'https://data.hyperdash.com/v1/markets/BTC/alo-priority/bars?interval=5m&payers=10'"}]}},"/v1/jobs":{"post":{"operationId":"createJob","tags":["jobs"],"security":[{"bearer":[]}],"summary":"Submit an async job (free)","description":"Heavy computations with a small result (Growth, Scale and Enterprise). At most 2 running at a time and 100 per day. Results are kept 24 h. Kinds:\n\n- `account_fills_summary` (scope `accounts:read`): Per coin over up to 90 days for one wallet: fills, buy/sell notional, fees per fee token, realized PnL, first and last fill. Both legs of self-matches count.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["kind","params"],"properties":{"kind":{"type":"string","enum":["account_fills_summary"]},"params":{"type":"object"}}}}}},"responses":{"200":{"description":"Idempotent replay","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"params":{"type":"object"},"status":{"type":"string","enum":["queued","running","succeeded","failed","canceled","expired"]},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"finished_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"result_rows":{"type":["integer","null"]},"compute_units":{"type":"integer"},"result_url":{"type":["string","null"]},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"detail":{"type":"string"}}}}}}}},"202":{"description":"Queued","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"params":{"type":"object"},"status":{"type":"string","enum":["queued","running","succeeded","failed","canceled","expired"]},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"finished_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"result_rows":{"type":["integer","null"]},"compute_units":{"type":"integer"},"result_url":{"type":["string","null"]},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"detail":{"type":"string"}}}}}}}},"400":{"description":"Invalid kind or params","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Scope, plan or history limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Idempotency-Key reused with a different request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Job limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"get":{"operationId":"listJobs","tags":["jobs"],"security":[{"bearer":[]}],"summary":"Recent jobs of this key's project (free)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"params":{"type":"object"},"status":{"type":"string","enum":["queued","running","succeeded","failed","canceled","expired"]},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"finished_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"result_rows":{"type":["integer","null"]},"compute_units":{"type":"integer"},"result_url":{"type":["string","null"]},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"detail":{"type":"string"}}}}}}}}}}}}}},"/v1/jobs/{id}":{"get":{"operationId":"getJob","tags":["jobs"],"security":[{"bearer":[]}],"summary":"Job status (free)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"params":{"type":"object"},"status":{"type":"string","enum":["queued","running","succeeded","failed","canceled","expired"]},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"finished_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"result_rows":{"type":["integer","null"]},"compute_units":{"type":"integer"},"result_url":{"type":["string","null"]},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"detail":{"type":"string"}}}}}}}},"404":{"description":"Unknown job","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"delete":{"operationId":"cancelJob","tags":["jobs"],"security":[{"bearer":[]}],"summary":"Cancel a queued or running job (free)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"params":{"type":"object"},"status":{"type":"string","enum":["queued","running","succeeded","failed","canceled","expired"]},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"finished_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"result_rows":{"type":["integer","null"]},"compute_units":{"type":"integer"},"result_url":{"type":["string","null"]},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"detail":{"type":"string"}}}}}}}},"404":{"description":"Unknown job","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/jobs/{id}/result":{"get":{"operationId":"getJobResult","tags":["jobs"],"security":[{"bearer":[]}],"summary":"Read a job's result (paged, metered)","description":"Pricing: 10 credits + 1 per row per page, plus the job's compute_units once, on the first delivered page. 409 job_not_ready while the job runs (or another read is settling its compute fee; retry).","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"X-Max-Credits","in":"header","required":false,"description":"Refuse (free) if the request could cost more: a page priced at `limit` rows, plus the job's compute_units on the page that carries them.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]},"meta":{"type":"object"}}}}}},"400":{"description":"limit outside 1..1000, or an invalid cursor","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"Plan, history or credit limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Unknown job","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"Not ready","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}}}