Contents
Liquidation map (current)
Liquidation map of one coin from the tracked Hyperliquid positions: USD that would be liquidated per price bucket (longs below the mark, shorts above), plus totals.
/api/v1/liqmap/{coin}Every keyDescription
404 for unknown coins. Free keys: every coin (as "liquidation levels now" on the web).
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 · pathrequired | Coin name, e.g. BTC (case-insensitive). |
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 | Current Hyperliquid mark. |
bucketSizenumber · nullable | Width of a price bucket. |
updatedAtstring (ISO 8601) · nullable | Newest data time of this item (ISO 8601 UTC). |
buckets[]array of objects | Price buckets ascending; long liquidations sit below the mark, short liquidations above it. |
buckets[].pxnumber | Lower edge of the price bucket. |
buckets[].longUsdnumber | Long positions liquidated in this bucket (USD). |
buckets[].shortUsdnumber | Short positions liquidated in this bucket (USD). |
buckets[].positionsinteger | Positions in the bucket. |
totalsobject | Sums over the rows of this object. |
totals.longUsdnumber | Total long (USD). |
totals.shortUsdnumber | Total short (USD). |
totals.positionsinteger | Number of positions. |
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 - 404
not_foundNot found - 429
rate_limitedPer-minute limit reachedretry - 429
daily_limit_exceededDaily limit reachedretry - 429
stream_limitToo many open streamsretry - 500
internal_errorInternal errorretry
Methodology
- Liquidation clusters (how it is computed and its limits)
- Liquidation heatmap (real positions) (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.