Wealthnow
Sign up

API ReferenceCrypto History

Status

Crypto derivatives history

GET/api/v3/crypto/history/derivatives
Plan
Pro and up
Price
3 credits per call
MCP tool
crypto_history_derivatives

Recorded history of cross-venue perpetual funding, open interest and basis for one base asset, one row per 15-minute recording cycle, newest first. Only rows of the current multi-venue method are served (multivenue_since); earlier rows are withheld and counted. Call it for how crowding or leverage built up over days; the live crypto_derivatives tools answer only now. Units: funding_rate_8h is a fraction per 8 hours (funding_apr = x3x365, a fraction), oi_usd_total USD, perp_premium_bps and dispersion_bps basis points, mark_px USD. licence_mode says the aggregator tier's access that cycle (commercial, unavailable, timeout, error). as_of is the newest observation; gaps lists stretches over an hour with no recording; freshness says how old the newest row is. REQUIRES date or start(+end), max 31 days; a window before the recording began is a 422. DATA context, not a score. Auth: X-API-Key.

Parameters

Query

symbolstringRequired

Base asset (the 20 recorded every cycle)

One ofBTCETHSOLXRPDOGEADAAVAXLINKLTCDOTBNBHYPEENATAOONDOSUIAPTARBOPNEAR
datestringOptional

One UTC day YYYY-MM-DD. Send at least one of date or start: the call is refused without it.

startstringOptional

Window start (UTC day). Send at least one of date or start: the call is refused without it.

endstringOptional

Window end (inclusive; max 31-day window)

limitintegerOptional
Default3000
Range1 to 5000
asset_classstringOptional

This route is crypto-native. asset_class=crypto is accepted.

One ofcrypto
Defaultcrypto

Response

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_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe 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 unauthorizedMissing or invalid API key.
402 plan_requiredYour 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_deniedThis 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_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe 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.