24h Volume—Open Interest—24h Liquidations$1.36B24h Long/Short—BTC Dominance—ETH Dominance—
App
Language ▾
$ USD ▾
/api/hl/symbol-heatmap
GETAvailable

Hyperliquid tier × coin heatmap

Hyperliquid tier × coin heatmap

GET/api/hl/symbol-heatmap

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
kindstringOptionalpnlpnl, marginTier basis: account-value tiers or position-size tiers. Example: pnl
topintegerOptional12≥ 5 · ≤ 30Top N coins. Example: 12

Example request

curl -s "https://www.coinboss.com/api/hl/symbol-heatmap?kind=pnl&top=12"

Response fields

The field table is generated from real responses, so it lists exactly what the endpoint returns. Paths use a[] for array items and {*} for objects keyed by a dynamic name such as a coin or an exchange.

FieldTypeUnitDescription
successboolean—true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`.
snapshotTsnumbermsTime of the position snapshot.
kindstring—Kind.
coinsarray—Coins.
coins[]string—Coins.
cellsarray—Matrix cells.
cells[]object—Matrix cells.
cells[].bucketnumbermsStart of the time bucket.
cells[].coinstring—Coin symbol, upper case (for example BTC).
cells[].holdersnumbercountNumber of addresses in this tier holding a position in the coin at the latest full account scan.
cells[].longUsdnumberUSDLong notional.
cells[].shortUsdnumberUSDShort notional.
cells[].totalUsdnumberUSDTotal.

Generated 2026-11-11 23:00 UTC from 1 real responses.

Example response

/api/hl/symbol-heatmap?kind=pnl&top=12 · Real response captured 2026-11-13 03:58:37 UTC. Long arrays and maps are shortened for display: cells had 84 items; coins had 12 items.

  • {
    • "success": true,
    • "snapshotTs": 1794541022568,
    • "kind": "pnl",
    • "coins": [
      • "BTC",
      • "HYPE",
      • "ETH",
      • "ZEC",
      • "SOL",
      • "NEAR",
      • "XMR",
      • "LIT"
      ],
    • "cells": [
      • { … 6 },
      • { … 6 }
      ]
    }

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
5m
Edge micro-cache
10s
Update frequency
hourly (kept 14 days); API cache 300 s
Window
latest scan
Data sources
Per-coin holders and long/short exposure split by wallet tier, from hourly full scans on our own Hyperliquid node.
Exchange coverage
Top coins by exposure; kind = pnl | margin grouping
Pagination
top (5-30, default 12)
Units
USD; holder counts
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:58:37 UTCHTTP 200138 msSchema matchesNewest data point 22m old

Availability, last 30 days

99.76% of 409 checks passed

Errors

Failed calls share one shape on every endpoint. The full list is on the errors page. Errors and rate limits →

CodeHTTPMeaningWhat to do
INVALID_PARAM400A required parameter is missing or a value is not accepted. `param` names the parameter when it is known.Do not retry unchanged; fix the request.
UNAUTHORIZED401The `CB-API-KEY` header was sent but the key is unknown or revoked. Public data needs no key — drop the header or use a valid key.Do not retry unchanged.
FORBIDDEN403The route is not part of the public API (internal or account-only).Do not retry.
NOT_FOUND404Unknown route, or the requested coin / exchange / fund does not exist.Do not retry; check the path and identifiers against the catalog.
RATE_LIMITED429More requests than the per-minute limit. `Retry-After` gives the seconds to wait.Wait for `Retry-After`, then retry with backoff.
INTERNAL500Unexpected server error. The message is generic by design; quote `request_id` when reporting it.Retry once after a few seconds; report it with the request id if it persists.
UPSTREAM_FAILED503The data source behind this endpoint did not answer in time. No stale or substitute numbers are returned in its place.Retry with backoff; check the status page.
UNAVAILABLE501 / 503The dataset is temporarily not ready (cache warming) or the endpoint has no lawful public source yet.Retry later; the catalog marks endpoints that are unavailable by design.
REQUEST_FAILED200Some older endpoints answer HTTP 200 with `success: false`. Always check `success`, not only the HTTP status.Depends on the message; treat as a failed request.

Try it

GET/api/hl/symbol-heatmapAvailable
Parameters

string · default pnl — Tier basis: account-value tiers or position-size tiers.

integer · default 12 · min 5 · max 30 — Top N coins.

Request URLhttps://www.coinboss.com/api/hl/symbol-heatmap?kind=pnl&top=12
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.