Aggregated open-interest history for one coin
Aggregated open-interest history for one coin
/api/oi/historyRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| base | string | Required | — | — | Base coin symbol (uppercase, e.g. BTC). Example: BTC |
| hours | integer | Optional | 168 | ≥ 1 · ≤ 2160 | Look-back window in hours. Example: 168 |
Example request
curl -s "https://www.coinboss.com/api/oi/history?base=BTC&hours=168"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 }`. |
| base | string | — | Base asset symbol. |
| hours | number | — | Hourly values or number of hours. |
| exchanges | array | — | Exchanges. |
| exchanges[] | string | — | Exchanges. |
| count | number | — | Number of items. |
| data | array | — | Payload. |
| data[] | object | — | Payload. |
| data[].hour_ts | number | ms | Start of the hour bucket. |
| data[].total_usd | number | USD | Total. |
| data[].byExchange | object | — | Open interest per exchange at that hourly snapshot; keys are exchange ids, values are USD summed over the coin's contracts on that exchange. |
| data[].byExchange.bitfinex | number | — | Value for exchange `bitfinex` (the key is the exchange id). may be absent |
| data[].byExchange.edgex | number | — | Value for exchange `edgex` (the key is the exchange id). may be absent |
| data[].byExchange.aster | number | — | Value for exchange `aster` (the key is the exchange id). |
| data[].byExchange.bingx | number | — | Value for exchange `bingx` (the key is the exchange id). may be absent |
| data[].byExchange.kucoin | number | — | Value for exchange `kucoin` (the key is the exchange id). |
| data[].byExchange.deribit | number | — | Value for exchange `deribit` (the key is the exchange id). may be absent |
| data[].byExchange.okx | number | — | Value for exchange `okx` (the key is the exchange id). |
| data[].byExchange.dydx | number | — | Value for exchange `dydx` (the key is the exchange id). may be absent |
| data[].byExchange.hyperliquid | number | — | Value for exchange `hyperliquid` (the key is the exchange id). may be absent |
| data[].byExchange.backpack | number | — | Value for exchange `backpack` (the key is the exchange id). may be absent |
| data[].byExchange.bitget | number | — | Value for exchange `bitget` (the key is the exchange id). |
| data[].byExchange.htx | number | — | Value for exchange `htx` (the key is the exchange id). may be absent |
| data[].byExchange.lighter | number | — | Value for exchange `lighter` (the key is the exchange id). may be absent |
| data[].byExchange.bybit | number | — | Value for exchange `bybit` (the key is the exchange id). |
| data[].byExchange.binance | number | — | Value for exchange `binance` (the key is the exchange id). |
| data[].byExchange.gate | number | — | Value for exchange `gate` (the key is the exchange id). |
| data[].byExchange.mexc | number | — | Value for exchange `mexc` (the key is the exchange id). |
| data[].byExchange.cryptocom | number | — | Value for exchange `cryptocom` (the key is the exchange id). |
| data[].byExchange.kraken | number | — | Value for exchange `kraken` (the key is the exchange id). may be absent |
| data[].byExchange.paradex | number | — | Value for exchange `paradex` (the key is the exchange id). may be absent |
| data[].byExchange.whitebit | number | — | Value for exchange `whitebit` (the key is the exchange id). |
| data[].byExchange.cme | number | — | Value for exchange `cme` (the key is the exchange id). may be absent |
Generated 2026-11-11 23:00 UTC from 4 real responses.
Example response
/api/oi/history?base=BTC&hours=168 · Real response captured 2026-11-13 03:57:41 UTC. Long arrays and maps are shortened for display: data had 168 items; exchanges had 22 items.
- "success"true
- "base""BTC"
- "hours"168
- "exchanges"
- "aster"
- "backpack"
- "binance"
- "bingx"
- "bitfinex"
- "bitget"
- "bybit"
- "cme"
- "count"168
- "data"
Verified samples
Besides the example above, the probe calls this endpoint with these parameters and checks the schema each time.
| Parameters | HTTP | Latency | Result |
|---|---|---|---|
| base=ETH&hours=168 | 200 | 32 ms | Pass |
| base=SOL&hours=168 | 200 | 32 ms | Pass |
| base=ARKM&hours=168 | 200 | 34 ms | Pass |
Checked 2026-11-13 03:57:41 UTC
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 5m
- Edge micro-cache
- 10s
- Update frequency
- hourly archive at each UTC hour change (snapshot of the latest table); ClickHouse copy synced every 5 min
- Window
- hours param, default 168 h, range 1..2160 h; hourly points
- Data sources
- Open interest polled by in-house collectors from the public REST APIs of 22 derivatives venues (e.g. binance, okx, bybit, gate, bitget, hyperliquid) plus CME's official daily volume/open-interest report.
- Exchange coverage
- exchanges present in the hourly archive for the coin; since 2026-11-11 only fresh rows are archived (OI 3 h, cme 120 h); cme daily value is carried forward hourly
- Units
- open interest in USD notional; hour_ts in Unix ms
- Method
- per hour and exchange: SUM(oi_usd) over all contract symbols of the coin; total_usd = sum over exchanges
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
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
/api/oi/historyAvailablestring — Base coin symbol (uppercase, e.g. BTC).
integer · default 168 · min 1 · max 2160 — Look-back window in hours.
https://www.coinboss.com/api/oi/history?base=BTC&hours=168More in this category
- Open interest for one coin /api/sd/oi
- Open-interest ranking per coin across exchanges /api/market/open-interest
- Stacked OI chart series for one coin /api/oi/chart
- Aggregated open-interest history for one coin /api/oi/history
- Open-interest matrix /api/oi/matrix
- Open-interest summary for one coin /api/oi/summary