/api/v1/data/funding
Derivatives
funding_rateFunding RateLast funding rate in intervalpredicted_funding_ratePredicted Funding RateLast predicted funding rate in intervalpredicted_funding_rate_spreadFunding Rate SpreadLast value of predicted_funding_rate − funding_ratepredicted_funding_rate_spread_bpsFunding Rate Spread (bps)Last value of spread as basis points of abs(funding_rate)predicted_funding_rate_spread_meanMean Funding Rate SpreadAverage predicted_funding_rate_spread over the intervalpredicted_funding_rate_stdPredicted Funding Rate Std DevStandard deviation of predicted_funding_rate over the intervalpredicted_funding_rate_spread_bps_stdFunding Rate Spread Std Dev (bps)Standard deviation of predicted_funding_rate_spread_bps over the intervalfunding_rate_update_frequencyFunding Rate Update FrequencyNumber of funding_rate updates per secondfunding_rate_avg_update_intervalAvg Funding Rate Update IntervalAverage seconds between funding_rate updatespredicted_funding_rate_update_frequencyPredicted Funding Rate Update FrequencyNumber of predicted_funding_rate updates per secondfrom datetime import datefrom aperiodic import get_derivative_metricsdf = get_derivative_metrics( api_key="YOUR_API_KEY", metric="funding", exchange="binance-futures", symbol="perpetual-BTC-USDT:USDT", interval="1d", start_date=date(2024, 1, 1), end_date=date(2024, 3, 1),)print(df.head())timestampreqstringTimestamp source. 'exchange' uses the exchange-reported timestamp, 'true' uses actual arrival time at our servers.
exchangetrueintervalreqstringAggregation time interval for the data.
1m5m15m30m1h4h1dexchangereqstringSource derivatives exchange for the data.
binance-futuresokx-perpssymbolreqstringTrading pair symbol in the format of Atlas' universal symbology: https://github.com/aperiodic-io/atlas
start_datereqstring<date>Start date for the data range (YYYY-MM-DD format). Data is partitioned by year and month.
end_datereqstring<date>End date for the data range (YYYY-MM-DD format). Must be greater than or equal to start_date.
Successful response with download URLs for each monthly file
filesobject[]requiredArray of file information for each month in the requested date range
yearintegerrequiredYear of the data file
monthintegerrequiredMonth of the data file (1-12)
urlstring<uri>requiredPresigned URL for direct file download (valid for 5 minutes). URLs are served from dataset-specific subdomains, e.g. ohlcv.aperiodic.io, trade-metrics.aperiodic.io, l1-metrics.aperiodic.io, l2-metrics.aperiodic.io, derivative-metrics.aperiodic.io.
{
"files": [
{
"year": 2024,
"month": 1,
"url": "https://ohlcv.aperiodic.io/binance-futures/1h/BTCUSDT/2024-01.parquet?X-Amz-Expires=300&..."
},
{
"year": 2024,
"month": 2,
"url": "https://ohlcv.aperiodic.io/binance-futures/1h/BTCUSDT/2024-02.parquet?X-Amz-Expires=300&..."
}
]
}
/api/v1/data/funding?timestamp=exchange&interval=1m&exchange=binance-futures