BTC OI Weighted Funding Rate API

Authorization: Bearer YOUR_TOKEN (required) — your 24 character API key (also accepted: the X-API-Key header or the api_token query parameter).

resolution (optional) — 1d only for the metrics on this chart. A finer value is refused, never served as 1d: 401 when the token is not entitled to finer buckets, 400 when it is entitled and the metric does not ingest that bucket; see Resolutions.

before (optional) — exclusive cursor, returns observations older than this timestamp_ms. Works on every resolution.

limit (optional) — the most recent N observations, maximum 5000. Finer resolutions page by default (2500); a 1d request returns the whole series unless you send limit or before.

before and limit narrow a time series. On a metric keyed by exchange or tenor they apply to each series, and the keys stay where they are. A response with no time axis, such as a labelled snapshot table, has nothing to cut on. It is returned whole, and both parameters are ignored rather than rejected.

A before that is not a positive epoch-millisecond timestamp is a 400. It is the one paging value we reject rather than ignore, because a page size has a sensible default and a cursor does not.

include (optional) — definition wraps the response as {"definition": …, "data": …} and returns the record shown under each metric; see Definitions. Any other value is a 400.

:metric_name — one of the metric names listed below.

200 with JSON payload, 400 for an unknown include value, 401 for missing/invalid token, 404 for missing resources, 429 when the monthly limit is reached. A 404 for a metric withdrawn on purpose adds withdrawn, withdrawn_on and reason, for example {"error":"Metric not found","withdrawn":true,"withdrawn_on":"2026-09-07","reason":"The venue's public feed reports insurance-fund settlements, not liquidation orders."}; a removed chart can add successor.

Plan and quota refusals keep their error texts and add code, required_plan, current_plan, feature, upgrade_url, limit and resets_at where they apply. The 429 for a used-up monthly allowance carries Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. A Pro token whose history window removed points also gets the X-Newhedge-History-Truncated headers, and for a Pro token X-Newhedge-Available-From is the start of the window. See Errors and plan limits.

Every 404 and 400 also carries a machine code and, where a list of valid names exists, up to 3 did_you_mean spellings, catalog_url and docs_url. Two different keys in one request are a 400 with code: conflicting_credentials. Only a successful response spends one call from the monthly allowance. A refused or failed call (any 4xx or 5xx, a conflict between credentials, an unknown path) spends nothing, and the request-rate limits are unchanged. The full list of codes is under Errors on the introduction page.