/api/v1/data/l1_imbalance
L1 (Top of Book)
imbalanceImbalanceLast value of bid_amount − ask_amountimbalance_ratioImbalance RatioLast value of (bid_amount − ask_amount) / (bid_amount + ask_amount)bid_ask_ratioBid/Ask RatioLast value of bid_amount / ask_amountbid_percentageBid %Last value of bid_amount / (bid_amount + ask_amount)ask_percentageAsk %Last value of ask_amount / (bid_amount + ask_amount)imbalance_avgAvg ImbalanceAverage of bid_amount − ask_amount over the intervalimbalance_ratio_avgAvg Imbalance RatioAverage of imbalance_ratio over the intervalbid_ask_ratio_avgAvg Bid/Ask RatioAverage of bid_ask_ratio over the intervalbid_percentage_avgAvg Bid %Average of bid_percentage over the intervalask_percentage_avgAvg Ask %Average of ask_percentage over the intervalfrom datetime import datefrom aperiodic import get_metricsdf = get_metrics( api_key="YOUR_API_KEY", metric="l1_imbalance", 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 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/l1_imbalance?timestamp=exchange&interval=1m&exchange=binance-futures