GETAvailable
Large resting-order monitor
Large resting-order monitor
GET
/api/indicators/large-orderbookModel output, not order-book data: the rows are estimated liquidation price levels. For depth and slippage computed from real order books use `/api/sd/liquidity`.
Request
This endpoint takes no parameters.
Example request
curl -s "https://www.coinboss.com/api/indicators/large-orderbook"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 |
|---|---|---|---|
| success | boolean | — | true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`. |
| series | array | — | Time series. |
| series[] | object | — | Time series. |
| series[].name | string | — | Name. |
| series[].data | array | — | Payload. |
| series[].data[] | array | — | Payload. |
| series[].data[][] | number | — | Payload. |
| series[].color | string | — | Display colour (hex). |
| table | array | — | Up to 30 coins with more than 10 million USD of 24-hour volume, sorted by `totalLiq` descending; model output, not order-book data. |
| table[] | object | — | One coin with its modelled liquidation totals from the 1-day liquidation map. |
| table[].symbol | string | — | Instrument symbol as normalised by CoinBoss (for example BTCUSDT). |
| table[].price | number | — | Last price in the quote currency (USD or USDT unless stated). |
| table[].longLiq | number | USD | Model-estimated notional of long liquidation levels below the current price in the 1-day liquidation map; an estimate, not exchange data. |
| table[].shortLiq | number | USD | Model-estimated notional of short liquidation levels above the current price in the 1-day liquidation map; an estimate, not exchange data. |
| table[].totalLiq | number | USD | `longLiq` + `shortLiq`. |
| table[].oiUsd | number | USD | Open interest. |
| table[].volUsd | number | USD | Volume. |
Generated 2026-11-11 23:00 UTC from 1 real responses.
Example response
/api/indicators/large-orderbook · Real response captured 2026-11-13 03:58:07 UTC. Long arrays and maps are shortened for display: table had 30 items; series[].data had 10 items.
- "success"true
- "series"
- "table"
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
- latest model snapshot
- Data sources
- Model estimate computed in-house from CoinBoss's own hourly futures klines, open-interest history and collected liquidations (not order-book data).
- Exchange coverage
- top 30 modelled coins by notional volume with vol_usd > 10M USD; 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
- Pagination
- fixed top 30
- Sorting
- totalLiq desc
- Units
- longLiq / shortLiq / totalLiq = estimated liquidation notional in USD; oiUsd, volUsd in USD; price in USD
- Method
- rows with vol_usd > 10,000,000; longLiq = model totalLong, shortLiq = model totalShort, totalLiq = longLiq + shortLiq; series = top 10
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
AvailableChecked 2026-11-13 03:58:07 UTCHTTP 2001 msSchema matches
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 →
| 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
GET
/api/indicators/large-orderbookAvailableParameters
No parameters.
Request URL
https://www.coinboss.com/api/indicators/large-orderbookChoose an endpoint and press “Send request”. The response, headers and timing will appear here.
More in this category
- Order-book depth and slippage /api/sd/liquidity
- Order-book depth history /api/sd/liquidity/history
- Coins ranked by order-book depth /api/sd/liquidity/rank
- Large resting-order monitor /api/indicators/large-orderbook