Open interest of OKX swaps, futures or options, in contracts, in coin and in USD, ranked; or of one instrument. For one swap or futures contract, include adds long_short_ratio (the ratio of accounts long to short) and taker_volume (taker sell and buy volume) as time series of points periods of period.
Every response includes credits_used: the credits this call cost.
Parameters
name
type
description
type
SWAP | FUTURES | OPTION
SWAP (default), FUTURES or OPTION. Example: SWAP
inst
string
One instrument id instead of the whole list.
family
string
Instrument family such as BTC-USD (required for options).
sort
oi_usd | oi
oi_usd (default) or oi. Example: oi_usd
order
asc | desc
asc or desc (default desc). Example: desc
limit
integer
Number of instruments, 1-1000 (default 50). Example: 50
include
string
Comma-separated, with inst (a swap or futures contract): long_short, taker_volume.
import os, requests
res = requests.get(
"https://api.api.sh/okx/v1/open-interest",
params={"type": "SWAP"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json()
const url = new URL("https://api.api.sh/okx/v1/open-interest");
url.searchParams.set("type", "SWAP");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();
Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).
The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.