Liquidation map
Liquidation map (estimated liquidation size per price level and leverage)
/api/liq-mapRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| symbol | string | Optional | BTC | — | Coin symbol; 404 when no data. Example: BTC |
| range | string | Optional | 1d | 1d, 7d | Time window. Example: 1d |
Example request
curl -s "https://www.coinboss.com/api/liq-map?symbol=BTC&range=1d"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.
| Field | Type | Unit | Description |
|---|---|---|---|
| symbol | string | — | Instrument symbol as normalised by CoinBoss (for example BTCUSDT). |
| range | string | — | Window requested. |
| updatedAt | number | ms | When the data was last updated. |
| currentPrice | number | — | Current price. |
| binWidth | number | USD | Price width of one bin: the axis spans ±10 % (`1d`) or ±18 % (`7d`) around `currentPrice`, split into 200 bins. |
| leverages | array | — | Leverage tiers the model distributes positions into, ascending (10, 25, 50, 100). |
| leverages[] | number | x | Leverage multiple of one tier; used as the key inside `bins[].tiers`. |
| bins | array | — | The 200 price bins of the map in ascending price order; model estimate, not exchange data. |
| bins[] | object | — | One price bin: mid `price`, `side` (`long` below the current price, `short` at or above), per-leverage `tiers` and their `total`. |
| bins[].price | number | — | Last price in the quote currency (USD or USDT unless stated). |
| bins[].side | string | — | `long` / `short` or `buy` / `sell`. |
| bins[].tiers | object | — | Size tiers. |
| bins[].tiers.10 | number | USD | Modelled liquidation notional in this price bin from positions opened with 10x leverage; the key is absent when the amount is zero. may be absent |
| bins[].total | number | — | Total. |
| bins[].tiers.25 | number | USD | Modelled liquidation notional in this price bin from positions opened with 25x leverage; the key is absent when the amount is zero. may be absent |
| cum | array | — | Cumulative curve aligned index-by-index with `bins`. |
| cum[] | number | USD | Modelled liquidation notional accumulated from the current price out to this bin (downwards for bins below, upwards for bins above). |
| maxBin | number | USD | Largest `bins[].total` in the map, usable to scale the chart axis. |
| totalLong | number | — | Total long. |
| totalShort | number | — | Total short. |
| actualLiq24h | number | USD | Notional actually liquidated in the coin over the last 24 hours (long + short, recorded liquidation orders), for comparison with the model. |
Generated 2026-11-11 23:00 UTC from 3 real responses.
Example response
/api/liq-map?symbol=BTC&range=1d · Real response captured 2026-11-13 03:52:47 UTC. Long arrays and maps are shortened for display: cum had 200 items; bins had 200 items.
- "symbol""BTC"
- "range""1d"
- "updatedAt"1794541891278
- "currentPrice"69059.1
- "binWidth"69.0591
- "leverages"
- 10
- 25
- 50
- 100
- "bins"
- "cum"
- 181751104
- 181751104
- 181751104
- 181751104
- 165607035
- 165607035
- 165607035
- 165607035
- "maxBin"22547138
- "totalLong"181751104
- "totalShort"232458129
- "actualLiq24h"745954159
Verified samples
Besides the example above, the probe calls this endpoint with these parameters and checks the schema each time.
| Parameters | HTTP | Latency | Result |
|---|---|---|---|
| range=1d&symbol=ETH | 200 | 1 ms | Pass |
| range=1d&symbol=SOL | 200 | 1 ms | Pass |
Checked 2026-11-13 03:28: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: 1d | 7d (positions assumed opened in the last 1 or 7 days); 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
- each 1 h candle opens notional proportional to volume x close (boosted by OI increase), spread over leverage tiers; long liq price ~ P x (1 - 1/L + MMR), short ~ P x (1 + 1/L - MMR); levels swept by later candles are cleared; output = cumulative long/short liquidation notional by price and leverage tier
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
Availability, last 30 days
100% 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 →
| Code | HTTP | Meaning | What to do |
|---|---|---|---|
| INVALID_PARAM | 400 | A 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. |
| UNAUTHORIZED | 401 | The `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. |
| FORBIDDEN | 403 | The route is not part of the public API (internal or account-only). | Do not retry. |
| NOT_FOUND | 404 | Unknown route, or the requested coin / exchange / fund does not exist. | Do not retry; check the path and identifiers against the catalog. |
| RATE_LIMITED | 429 | More requests than the per-minute limit. `Retry-After` gives the seconds to wait. | Wait for `Retry-After`, then retry with backoff. |
| INTERNAL | 500 | Unexpected 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_FAILED | 503 | The 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. |
| UNAVAILABLE | 501 / 503 | The 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_FAILED | 200 | Some 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
/api/liq-mapAvailablestring · default BTC — Coin symbol; 404 when no data.
string · default 1d — Time window.
https://www.coinboss.com/api/liq-map?symbol=BTC&range=1dMore in this category
- Liquidation heatmap (model 1) /api/heatmap
- Symbols supported by the liquidation heatmap /api/heatmap/symbols
- Liquidation heatmap (model 2 / 3) /api/liq-heatmap
- Symbols supported by the liquidation-heatmap model /api/liq-heatmap/symbols
- Liquidation cluster levels /api/liq-levels
- Liquidation map /api/liq-map
- Symbols supported by the liquidation map /api/liq-map/symbols
- Liquidation max-pain levels /api/liq-maxpain