/api/v1/data/derivative_price
Derivatives
last_priceLast PriceLast traded price in intervalindex_priceIndex PriceLast index price in intervalmark_priceMark PriceLast mark price in intervallast_price_pct_changeLast Price % Change(last − first) / first × 100 for last_price within intervalindex_price_pct_changeIndex Price % Change(last − first) / first × 100 for index_price within intervalmark_price_pct_changeMark Price % Change(last − first) / first × 100 for mark_price within intervalmark_index_pct_change_ratioMark/Index % Change Ratiomark_price_pct_change / index_price_pct_changemark_last_pct_change_ratioMark/Last % Change Ratiomark_price_pct_change / last_price_pct_changeindex_last_pct_change_ratioIndex/Last % Change Ratioindex_price_pct_change / last_price_pct_changefrom datetime import datefrom aperiodic import get_derivative_metricsdf = get_derivative_metrics( api_key="YOUR_API_KEY", metric="derivative_price", 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/derivative_price?timestamp=exchange&interval=1m&exchange=binance-futures