OKX order book

docs menu

GET https://api.api.sh/okx/v1/orderbook

1 credit / call finance & crypto try it in the playground →

An OKX instrument's order book: bids and asks with price, size and order count per level, best bid and ask and the spread.

Every response includes credits_used: the credits this call cost.

Parameters

name	type	description
`inst`required	string	OKX instrument id. Example: `BTC-USDT`
`depth`	integer	Price levels per side, 1-400 (default 50). Example: `50`

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/okx/v1/orderbook?inst=BTC-USDT" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/okx/v1/orderbook",
    params={"inst": "BTC-USDT"},
    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/orderbook");
url.searchParams.set("inst", "BTC-USDT");

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.