API ReferenceMarket Data
Crypto open interest
/api/v3/crypto/derivatives/open_interest- Plan
- Free and up
- Price
- 1 credit per call
- MCP tool
crypto_derivatives_ open_ interest
Call this for LEVERAGE in the system — perpetual open interest per base asset in USD: oi_usd_total over the venues read first-party, oi_usd_total_all adding the calibrated aggregator tier (an aggregator venue's OI above 3× the largest verified venue's is capped and flagged), the per-venue breakdown, the dominant verified venue and OI concentration (oi_hhi). USD is the ONLY unit summed cross-venue (base-coin OI stays per venue; contract counts are never served because contract size varies 0.01→1000 across symbols). Venues this region cannot reach appear only through the aggregator tier, and the sources block says which (geo_blocked when it is off) rather than reporting a smaller total as if it were the whole market. Pair with derivatives_funding: rising OI + rising funding = new longs; rising OI + falling price = new shorts. DATA context, not a score. Auth: X-API-Key.
Parameters
Query
symbolsstringOptionalComma list of BASE assets, ≤20.
asset_classstringOptionalThis route is crypto-native. asset_class=crypto is accepted.
cryptocryptodetailstringOptionalAuto = shaped to stay under 15k chars (flat per-venue rows for one coin; compact {venue: value} maps for several); full = every field, for ONE coin; summary = no flat rows.
autofullsummaryautoResponse
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Crypto). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.
A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.
Errors
No error is billed. The body is { "ok": false, "error", "detail", "request_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed. |
401 unauthorized | Missing or invalid API key. |
402 plan_required | Your plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed. |
403 scope_denied | This API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed. |
404 not_found | No such resource. Not billed. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The request ran past the server's time budget; retry. Not billed. |
This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.
Guides
Read the Crypto guide for this endpoint's fields and examples.