Contents
Largest positions
Largest tracked Hyperliquid positions (venue=lighter: tracked Lighter accounts) with entry, leverage, liquidation price and the signed distance from the mark to the liquidation price (liqDistance, fraction).
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 | Coin name as on Hyperliquid (BTC, ETH, kPEPE, HIP-3 names like xyz:TSLA); case-insensitive. |
sidestring | long | short (optional).one of long, short |
minUsdnumber | Minimum position notional in USD, default 0.≥ 0 · default 0 |
limitinteger | Number of items, default 50, clamped to 1–500.1–500 · default 50 |
cursorstring | Next page: the value of meta.nextCursor from the previous response (keep the other parameters unchanged). Cursors are signed: an edited cursor answers 400; paging stops at the plan history. |
venuestring | hyperliquid (default, the Hyperliquid answer as before) | lighter (tracked Lighter accounts: address = the Lighter account index, venue = "lighter", liqPx as the exchange reports it). A switched-off venue answers 400.one of hyperliquid, lighter · default hyperliquid |
fieldsstring | Comma-separated fields of every item to return, e.g. address,coin,side,positionUsd,liqPx (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 |
|---|---|
[].addressstring | Hyperliquid address (lowercase), or with venue "lighter" the Lighter account index. |
[].labelstring · nullable | Wallet label (public label or leaderboard display name). |
[].accountValuenumber · nullable | Account value (USD). |
[].coinstring | Coin name as on Hyperliquid (BTC, kPEPE, HIP-3 names like xyz:TSLA). |
[].side"long" | "short" | Position side (for liquidations: the side of the liquidated position). |
[].sizenumber | Size in coins. |
[].entryPxnumber · nullable | Entry price. |
[].positionUsdnumber | Notional (USD). |
[].leveragenumber · nullable | Leverage of the position (notional / margin). |
[].leverageTypestring · nullable | cross | isolated |
[].liqPxnumber · nullable | Liquidation price. |
[].liqDistancenumber · nullable | Signed distance from the mark to the liquidation price, fraction (−0.12 = 12 % below the mark). |
[].marknumber · nullable | Hyperliquid mark price. |
[].marginUsednumber · nullable | Margin used (USD). |
[].unrealizedPnlnumber · nullable | Unrealised PnL (USD). |
[].updatedAtstring (ISO 8601) | Newest data time of this item (ISO 8601 UTC). |
[].venue"hyperliquid" | "lighter" | Venue of the position (present for Lighter rows; absent = Hyperliquid). |
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
- Distance to liquidation (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.