Contents
Screener (every coin)
Screener: one row per Hyperliquid coin with price change 1h / 24h (Hyperliquid mark), open interest of the enabled venues and its change 1h / 24h, current and predicted Hyperliquid funding (annualised), tracked Hyperliquid long/short and Binance top-trader ratio, liquidations of the last 24 h, the nearest big liquidation cluster (signed distance, USD, side), RSI(14) of 1h and 4h candles and 24 h realised volatility (annualised; computed for the 80 largest coins by open interest, else null).
/api/v1/screenerEvery keyDescription
Licence review: lsBinanceTop is null and coins without a Hyperliquid market are left out (meta.restricted); open interest summed over venues stays, except where exactly one withheld exchange is in the sum (then oiUsd is null: the total minus Hyperliquid would be that exchange’s value).
Who can call it
Available with every key and keyless (X-Blockmetric-Access: public). Keys of Free accounts get free-tier data (real-time feeds, 30 days of history, heatmap over time for every coin over the last 24 hours, liquidation levels now for every coin, the same as the free web plan); Pro and Desk keys the data of their plan; API Dev / API Pro raise the limits.
- No key
- 24 h
- Free
- 30 days
- Pro
- 365 days
- Desk
- 1095 days
- API Dev
- 365 days
- API Pro
- 1095 days
History window per plan. Limits: Authentication & limits.
Parameters
| Parameter | Description |
|---|---|
coinstring | Only this coin (optional). |
sortstring | oi (default) | change1h | change24h | oiChange1h | oiChange24h | funding | fundingPred | ls | liq24h | cluster | rsi1h | rsi4h | vol | coin; missing values sort last.one of oi, change1h, change24h, oiChange1h, oiChange24h, funding, fundingPred, ls, liq24h, cluster, rsi1h, rsi4h, vol, coin · default oi |
dirstring | desc (default) | asc.one of asc, desc · default desc |
minOiUsdnumber | Minimum open interest in USD, default 0.≥ 0 · default 0 |
limitinteger | Number of items, default 100, clamped to 1–500.1–500 · default 100 |
fieldsstring | Comma-separated fields of every item to return, e.g. coin,mark,change24h,oiUsd,fundingApr,rsi1h (case-insensitive). All other fields are left out, so large lists get much smaller; an unknown name answers 400 with the list of fields. Default: every field. |
formatstring | json (default: the { data, meta } envelope) | csv (the rows with a header line; nested values as JSON text) | ndjson (one JSON object per row and line). csv and ndjson carry the meta block in headers: Link rel="next" and X-Blockmetric-Next-Cursor (next page), X-Blockmetric-Next-After (forward polling), X-Blockmetric-Updated-At, X-Blockmetric-Warnings, X-Blockmetric-License. Errors stay JSON.one of json, csv, ndjson · default json |
Response fields
Every success is { data, meta }; these are the fields of data. meta is the same on every endpoint.
| Field | Description |
|---|---|
[].coinstring | Coin name as on Hyperliquid (BTC, kPEPE, HIP-3 names like xyz:TSLA). |
[].marknumber · nullable | Hyperliquid mark; for a coin without a Hyperliquid market the mark of the enabled exchange with the largest open interest. |
[].change1hnumber · nullable | Price change in 1 h, fraction. |
[].change24hnumber · nullable | Price change in 24 h, fraction. |
[].oiUsdnumber · nullable | Open interest of the enabled venues (USD). |
[].oiChange1hnumber · nullable | Open interest change in 1 h (venues with a value at both times), fraction. |
[].oiChange24hnumber · nullable | Open interest change in 24 h, fraction. |
[].volume24hUsdnumber · nullable | Hyperliquid 24 h volume (coins without a Hyperliquid market: summed over the exchanges that report one) (USD). |
[].fundingAprnumber · nullable | Hyperliquid funding now, annualised fraction (null for a coin without a Hyperliquid market). |
[].fundingPredAprnumber · nullable | Predicted next Hyperliquid funding, annualised fraction. |
[].lsHlnumber · nullable | Tracked Hyperliquid long USD / short USD. |
[].lsBinanceTopnumber · nullable | Binance top traders long/short (positions); null when Binance is switched off. |
[].liq24hUsdnumber · nullable | Liquidations in 24 h (CEX as reported, Hyperliquid confirmed by fills) (USD). |
[].liq24hLongUsdnumber · nullable | Long liquidations in 24 h (USD). |
[].liq24hShortUsdnumber · nullable | Short liquidations in 24 h (USD). |
[].clusterDistancenumber · nullable | Signed distance mark → nearest big liquidation cluster, fraction (−0.03 = 3 % below). |
[].clusterUsdnumber · nullable | USD in that cluster (USD). |
[].clusterSide"long" | "short" · nullable | Dominant side of the cluster. |
[].rsi1hnumber · nullable | RSI(14) of 1h candles, 0–100. |
[].rsi4hnumber · nullable | RSI(14) of 4h candles, 0–100. |
[].vol24hnumber · nullable | 24 h realised volatility of 1h closes, annualised fraction. |
[].maxLeverageinteger · nullable | Maximum leverage the venue allows on this market. |
Errors
- 400
invalid_paramInvalid parameter - 401
unauthorizedMissing or invalid API key - 403
plan_requiredPlan does not include this - 403
scope_requiredKey not scoped for this API - 403
ip_not_allowedAddress not on the IP allowlist of the key - 403
origin_not_allowedKey used from a browser origin it does not allow - 403
source_restrictedExchange data not redistributed - 403
https_requiredhttps required - 429
rate_limitedPer-minute limit reachedretry - 429
daily_limit_exceededDaily limit reachedretry - 429
stream_limitToo many open streamsretry - 500
internal_errorInternal errorretry
Methodology
- Open interest (how it is computed and its limits)
- RSI (14) (how it is computed and its limits)
- Realised volatility (how it is computed and its limits)
Code snippets in these docs are licensed under MIT-0: copy them into your own code without attribution. The SDKs, CLI and MCP server will be, once published, Apache-2.0; the name Blockmetric is not licensed (forks must be renamed). Data from the API is governed by the API terms; third-party exchange data by the exchange’s terms.