Options OI by expiry
Options OI by expiry
/api/options/oi-by-expiryRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| currency | string | Optional | BTC | BTC, ETH | Underlying: `BTC` or `ETH`. Any other value returns 400 `INVALID_PARAM`. Alias: `coin`. Example: BTC |
Example request
curl -s "https://www.coinboss.com/api/options/oi-by-expiry?currency=BTC"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 }`. |
| currency | string | — | Currency / asset symbol. |
| index_price | number | — | Index price of the underlying. |
| snap_ts | number | ms | Time of the snapshot. |
| count | number | — | Number of items. |
| data | array | — | Payload. |
| data[] | object | — | Payload. |
| data[].expiry | string | — | Expiry date of the option series. |
| data[].call_oi_usd | number | USD | Open interest of calls. |
| data[].put_oi_usd | number | USD | Open interest of puts. |
| data[].total_oi_usd | number | USD | Total open interest. |
| data[].volume_usd | number | USD | Volume in USD notional. |
Generated 2026-11-11 23:00 UTC from 2 real responses.
Example response
/api/options/oi-by-expiry?currency=BTC · Real response captured 2026-11-13 04:02:54 UTC. Long arrays and maps are shortened for display: data had 12 items.
- "success"true
- "currency""BTC"
- "index_price"68883.34
- "snap_ts"1794542401947
- "count"12
- "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 |
|---|---|---|---|
| currency=ETH | 200 | 3 ms | Pass |
| currency=SOL | 400 | 1 ms | Pass returns the expected error |
Checked 2026-11-13 03:58:24 UTC
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 2m
- Edge micro-cache
- 10s
- Update frequency
- every 10 min (full snapshot replace)
- Window
- latest snapshot
- Data sources
- Options open interest and volume by expiry from a single exchange's public API (Deribit).
- Exchange coverage
- Deribit only, BTC and ETH options; other venues (Binance/OKX/Bybit options, CME) are not included.
- Sorting
- expiry ascending
- Units
- USD notional (open interest); USD (volume)
- Method
- Call, put and total open interest plus 24h volume summed per expiry.
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
Availability, last 30 days
100% of 411 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/options/oi-by-expiryAvailablestring · default BTC — Underlying: `BTC` or `ETH`. Any other value returns 400 `INVALID_PARAM`. Alias: `coin`.
https://www.coinboss.com/api/options/oi-by-expiry?currency=BTCMore in this category
- Option chain (single venue) /api/sd/options/chain
- Options by expiry /api/sd/options/expiries
- Options history (hourly) /api/sd/options/history
- Options overview (all venues) /api/sd/options/overview
- Options by strike /api/sd/options/strikes
- Coin-page options summary /api/currency/options-summary
- Options implied-volatility smile / term structure /api/options/iv
- Options implied-volatility history /api/options/iv-history
- Options max pain /api/options/max-pain
- Options OI by expiry /api/options/oi-by-expiry
- Options OI by strike /api/options/oi-by-strike
- Options overview /api/options/overview
- Options volume distribution /api/options/volume-dist