Skip to main content
Loading market data…
GET/api/v1/futures/premium-index/historyStartup tier+ · 80 req/min

Per-coin cross-exchange average premium %, bucketed to 5-minute floors.

Time series for a single base asset — the cross-exchange arithmetic average premium % within each 5-minute bucket. Intended for sparkline / chart rendering.

Query parameters

All query parameters are optional unless marked required.

NameTypeRequiredDefaultDescription
coinstringrequired
Base asset.
daysnumberoptional30
Trailing days. Max 90.

Response shape

Always wrapped in the standard envelope. Nullable fields are explicitly marked — treat missing numeric data as a real data-source gap, not as an error.

data payloadtypescript
// Wrapped in the standard envelope:
// {
//   data: /* shape below */,
//   meta?: { total?: number; limit?: number; offset?: number; ... }
// }

{
  base: string;
  days: number;
  points: Array<{ ts: number; premiumPct: number }>;
}

Example

Copy the curl, replace YOUR_KEY with a real key from your dashboard, and run.

Requestbash
curl -sS "http://localhost:3000/api/v1/futures/premium-index/history?coin=BTC&days=7" \
  -H "Authorization: Bearer cg_live_YOUR_KEY"
Responsejson
{
  "data": {
    "base": "BTC",
    "days": 7,
    "points": [
      { "ts": 1744220400000, "premiumPct": 0.031 },
      { "ts": 1744220700000, "premiumPct": 0.028 }
    ]
  },
  "meta": { "total": 2, "days": 7 }
}

Next

Check the error code reference, or get an API key to try the request against your own account.