Premium-index history for one coin
Premium-index history for one coin
/api/p3/premium-index/historyRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| base | string | Optional | BTC | — | Base coin symbol (uppercase, e.g. BTC). Example: BTC |
| days | integer | Optional | 7 | ≤ 90 | Look-back window in days. Example: 7 |
Example request
curl -s "https://www.coinboss.com/api/p3/premium-index/history?base=BTC&days=7"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. |
| series | object | — | Time series. |
| series.binance | array | — | Value for exchange `binance` (the key is the exchange id). may be absent |
| series.binance[] | array | — | Value for exchange `binance` (the key is the exchange id). may be absent |
| series.binance[][] | number | — | Value for exchange `binance` (the key is the exchange id). may be absent |
| series.bitget | array | — | Value for exchange `bitget` (the key is the exchange id). may be absent |
| series.bitget[] | array | — | Value for exchange `bitget` (the key is the exchange id). may be absent |
| series.bitget[][] | number | — | Value for exchange `bitget` (the key is the exchange id). may be absent |
| series.bybit | array | — | Value for exchange `bybit` (the key is the exchange id). may be absent |
| series.bybit[] | array | — | Value for exchange `bybit` (the key is the exchange id). may be absent |
| series.bybit[][] | number | — | Value for exchange `bybit` (the key is the exchange id). may be absent |
| series.gate | array | — | Value for exchange `gate` (the key is the exchange id). may be absent |
| series.gate[] | array | — | Value for exchange `gate` (the key is the exchange id). may be absent |
| series.gate[][] | number | — | Value for exchange `gate` (the key is the exchange id). may be absent |
| series.okx | array | — | Value for exchange `okx` (the key is the exchange id). may be absent |
| series.okx[] | array | — | Value for exchange `okx` (the key is the exchange id). may be absent |
| series.okx[][] | number | — | Value for exchange `okx` (the key is the exchange id). may be absent |
Generated 2026-11-11 23:00 UTC from 4 real responses.
Example response
/api/p3/premium-index/history?base=BTC&days=7 · Real response captured 2026-11-13 04:02:47 UTC. Long arrays and maps are shortened for display: series.okx had 168 items; series.gate had 168 items; series.bybit had 168 items; series.bitget had 168 items; series.binance had 168 items.
- "success"true
- "base""BTC"
- "series"
- "binance"
- "bitget"
- "bybit"
- "gate"
- "okx"
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&days=7 | 200 | 9 ms | Pass |
| base=SOL&days=7 | 200 | 10 ms | Pass |
| base=ARKM&days=7 | 200 | 5 ms | Pass |
Checked 2026-11-13 03:58:09 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
- days param, default 7, max 90; hourly points
- Data sources
- Hourly archive of in-house spot vs perpetual basis for 5 exchanges (binance, okx, bybit, bitget, gate).
- Exchange coverage
- 5 exchanges x 19 major coins; archive starts 2026-07-02
- Units
- basis_pct in percent; hour_ts in Unix ms
- 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/p3/premium-index/historyAvailablestring · default BTC — Base coin symbol (uppercase, e.g. BTC).
integer · default 7 · max 90 — Look-back window in days.
https://www.coinboss.com/api/p3/premium-index/history?base=BTC&days=7More in this category
- Futures basis (all venues) /api/sd/basis
- Basis history (hourly) /api/sd/basis/history
- Coins ranked by basis /api/sd/basis/rank
- Futures-spot basis list /api/derivatives/basis
- Daily BTC price spread between Coinbase and Kraken /api/p3/cb-kr-spread
- Coinbase Bitcoin premium index /api/p3/coinbase-premium
- Perp premium index list /api/p3/premium-index
- Premium-index history for one coin /api/p3/premium-index/history
- Premium-index candles /api/p3/premium-index/klines
- USDT OTC premium against fiat FX rates /api/usdt-premium
- Full futures-spot basis list /api/basis/list