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

Liquidation heatmap (model 2 / 3)

Liquidation heatmap (model 2 / model 3)

GET/api/liq-heatmap

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
symbolstringOptionalBTC—Coin symbol; 404 when no data. Example: BTC
rangestringOptional24h12h, 24h, 3d, 7d, 1MTime window. Example: 24h
modelstringOptional22, 3Model number.

Example request

curl -s "https://www.coinboss.com/api/liq-heatmap?symbol=BTC&range=24h"

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
symbolstring—Instrument symbol as normalised by CoinBoss (for example BTCUSDT).
rangestring—Window requested.
modelnumber—Model variant used: `2` (sharp levels, entries at the hourly close, stronger open-interest weighting) or `3` (smoothed, entries spread across each candle's range).
updatedAtnumbermsWhen the data was last updated.
currentPricenumber—Current price.
pricesarray—Price series.
prices[]number—Price series.
timesarray—Timestamps of the series.
times[]number—Timestamps of the series.
gridarray—Grid values.
grid[]array—Grid values.
grid[][]number—Grid values.
maxNotionalnumberUSDModelled liquidation notional of the densest cell in the whole grid, i.e. the amount a `grid` value of 250 stands for; model estimate, not exchange data.
clustersarray—Price clusters.
clusters[]object—Price clusters.
clusters[].pricenumber—Last price in the quote currency (USD or USDT unless stated).
clusters[].strengthnumberratioCluster's modelled notional ÷ `maxNotional`, between 0.15 and 1; clusters are the up to 8 strongest local peaks of the latest column.
clusters[].usdnumberUSDValue.

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

Example response

/api/liq-heatmap?symbol=BTC&range=24h · Real response captured 2026-11-13 03:58:04 UTC. Long arrays and maps are shortened for display: grid had 24 items; times had 24 items; grid[] had 250 items; prices had 250 items; clusters had 8 items.

  • {
    • "symbol": "BTC",
    • "range": "24h",
    • "model": 2,
    • "updatedAt": 1794542191150,
    • "currentPrice": 68700.4,
    • "prices": [
      • 65834.75,
      • 65878.66,
      • 65922.57,
      • 65966.48,
      • 66010.39,
      • 66054.3,
      • 66098.2,
      • 66142.11
      ],
    • "times": [
      • 1794456000000,
      • 1794459600000,
      • 1794463200000,
      • 1794466800000,
      • 1794470400000,
      • 1794474000000,
      • 1794477600000,
      • 1794481200000
      ],
    • "grid": [
      • [ … 8 ],
      • [ … 8 ]
      ],
    • "maxNotional": 575067181,
    • "clusters": [
      • { … 3 },
      • { … 3 }
      ]
    }

Verified samples

Besides the example above, the probe calls this endpoint with these parameters and checks the schema each time.

ParametersHTTPLatencyResult
range=24h&symbol=ETH2001 msPass
range=24h&symbol=SOL2002 msPass

Checked 2026-11-13 03:58:04 UTC

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
60s
Edge micro-cache
10s
Update frequency
every 5 min for the top 100 coins; coins ranked 101-300 are refreshed in 5 staggered batches (about every 25 min)
Window
range param: 12h | 24h | 3d | 7d | 1M; model param: 2 | 3; latest model snapshot
Data sources
Model estimate computed in-house from CoinBoss's own hourly futures klines (binance, okx fallback), aggregated open-interest history and collected liquidations.
Exchange coverage
up to 300 crypto coins ranked by futures notional volume, requiring >= 30 liquidation events in the last 7 days; tokenized stocks, commodities, FX and indices are excluded; estimates are model output, not exchange-reported liquidation levels
Units
estimated liquidation notional in USD per price level; prices in USD; timestamps in Unix ms
Method
time x price grid (250 price bins) of pending estimated liquidation notional; model 2 = OI-increment driven, leverage tiers 10/25/50/100, no decay; model 3 = entries spread across candle range, tiers 5/10/25/50/100, slow decay
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 03:58:04 UTCHTTP 2001 msSchema matchesNewest data point 2m old

Availability, last 30 days

100% of 410 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/liq-heatmapAvailable
Parameters

string · default BTC — Coin symbol; 404 when no data.

string · default 24h — Time window.

string · default 2 — Model number.

Request URLhttps://www.coinboss.com/api/liq-heatmap?symbol=BTC&range=24h
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.