Wealthnow
Sign up

API ReferenceMarket Data

Status

Crypto funding (cross-venue)

GET/api/v3/crypto/derivatives/funding
Price
1 credit per call
MCP tool
crypto_derivatives_funding

Call this when you need to know whether a coin's perp market is CROWDED — cross-venue perpetual funding for up to 20 base assets (default: top-20 coins by open interest across the first-party venues). Seven venues are read first-party (tier 'verified'); a licensed aggregator adds the venues this region cannot reach (tier 'aggregator') only after its units are calibrated against the verified venues on every call and each row passes plausibility, price and asset-class checks — every row names its source. Every rate is normalised to an 8h-equivalent from each venue's OWN settlement interval (venues mix 1h/4h/8h); a row whose interval had to be assumed says interval_assumed and stays out of the *_all aggregates. funding_rate_8h is the OI-weighted rate over verified venues (funding_rate_basis says so; the plain mean is mean_rate_8h_verified); when a verified venue quotes a rate but its OI read is missing, the headline switches to the verified median, labelled by funding_rate_basis and stored under its own signal name; oi_weighted_rate_8h and dispersion_bps are verified too; *_all keys add the aggregator tier. Also: median, OI concentration (oi_hhi), coverage, divergence flags, APR, and a 30-day z-score of one venue's rate against its own settlements once ≥60 exist (funding_z_venue names it). The answer is shaped to stay under 15k chars: for several coins rows[].venues is {venue: rate_8h} over verified venues and venues_aggregator over the aggregator rows that enter the aggregates (shape and budget say what was served); detail=full is meant for ONE coin: every per-venue field and the flat venues list. Perps a venue declares as a stock, ETF, index, FX or commodity are refused; a coin-and-commodity token (e.g. gold-backed) is served labelled commodity_backed_token; a coin no venue classifies is served labelled asset_class: unknown. Missing is typed with a reason, never zero. coverage.not_covered names the venues in no value here (with a reason_code) and coverage.headline_scope what the headline covers, so no total is market-wide. DATA context (not_a_score, not_a_forecast) — rich funding is crowding in one regime and trend confirmation in another. Auth: X-API-Key.

Parameters

Query

symbolsstringOptional

Comma list of BASE assets (BTC,ETH,SOL — never BTC-USD), ≤20. Omit for top-20 by OI.

asset_classstringOptional

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

One ofcrypto
Defaultcrypto
detailstringOptional

Auto = 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.

One ofautofullsummary
Defaultauto

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.