Skip to main content
GET
cURL

What it measures

Total notional value of outstanding perpetual/futures contracts. Rising open interest signals new leverage entering the market; falling open interest signals positions closing or being liquidated. This endpoint serves exchange swap data — per-exchange, per-quote pairs (e.g. btc_usdt). Use inverse=true for coin-margined contracts; the default false returns linear (USDⓈ-margined) contracts.
This endpoint is dual-class: pass a per-quote symbol like btc_usdt for a single pair, or an aggregated btc_all symbol to get that exchange’s all-quote aggregate (still that one exchange — not the cross-exchange cq aggregate).

Authorizations

Authorization
string
header
required

For each API request, include the Authorization HTTP header with Bearer {access_token}.

Query Parameters

exchange
string
required

Exchange name, e.g. binance. List active exchanges via /market/info/exchanges.

symbol
string
required

Trading pair. Per-quote (btc_usdt) and aggregated all-quote (btc_all) symbols are both accepted — btc_all returns the exchange-level all-quote aggregate.

inverse
enum<string>
default:false

Return inverse (coin-margined) contracts. true or false; defaults to false (linear). Swap only.

Available options:
true,
false
window
enum<string>
default:day

Aggregation window: day (default), hour, 10min, or min.

Available options:
day,
hour,
10min,
min
from
string

Inclusive start time, YYYYMMDDTHHMMSS (UTC). If window=day, YYYYMMDD is also accepted.

to
string

Inclusive end time, YYYYMMDDTHHMMSS (UTC). If window=day, YYYYMMDD is also accepted.

limit
integer
default:100

Maximum rows returned (default 100, max 10000).

Required range: x <= 10000
format
enum<string>
default:json

Response format: json (default) or csv.

Available options:
json,
csv

Response

200 - application/json

Exchange Swap Open Interest time-series.

status
object
required

Returned with every response; indicates whether the request was successful.

result
object
required