Wealthnow
Sign up

API ReferenceCrypto History

Status

Crypto vol surface history

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

Recorded history of the BTC or ETH options volatility surface, one row per 15-minute cycle (recorded since 2026-09-02): ATM implied vol at the expiries nearest 7, 30 and 90 days and the 90d-7d slope, the 10%-OTM put-minus-call implied-vol difference at 30 days (a moneyness measure), put/call open-interest ratio, the 30-day implied-vol index, realised vol and their ratio. Every vol figure is annualised vol points (38.3 = 38.3%). Realised vol and the ratio are served only on rows recorded from realized_vol_valid_since (earlier rows recorded an unfinished hour and are null, with the reason). Call it for how implied vol and term structure moved around an event. REQUIRES date or start(+end), max 31 days; as_of, gaps and freshness say what the recording covers. DATA context, not a score. Auth: X-API-Key.

Parameters

Query

symbolstringOptional
One ofBTCETH
DefaultBTC
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.