/api/v1/data/l2_liquidity
L2 (Order Book)
ask_agg_5Ask Aggregate (5 levels)Last value of total ask quantity summed over levels 0..4ask_agg_10Ask Aggregate (10 levels)Last value of total ask quantity summed over levels 0..9ask_agg_20Ask Aggregate (20 levels)Last value of total ask quantity summed over levels 0..19ask_agg_25Ask Aggregate (25 levels)Last value of total ask quantity summed over levels 0..24bid_agg_5Bid Aggregate (5 levels)Last value of total bid quantity summed over levels 0..4bid_agg_10Bid Aggregate (10 levels)Last value of total bid quantity summed over levels 0..9bid_agg_20Bid Aggregate (20 levels)Last value of total bid quantity summed over levels 0..19bid_agg_25Bid Aggregate (25 levels)Last value of total bid quantity summed over levels 0..24ask_agg_5_avgAvg Ask Aggregate (5 levels)Average of ask_agg_5 over the intervalask_agg_10_avgAvg Ask Aggregate (10 levels)Average of ask_agg_10 over the intervalask_agg_20_avgAvg Ask Aggregate (20 levels)Average of ask_agg_20 over the intervalask_agg_25_avgAvg Ask Aggregate (25 levels)Average of ask_agg_25 over the intervalbid_agg_5_avgAvg Bid Aggregate (5 levels)Average of bid_agg_5 over the intervalbid_agg_10_avgAvg Bid Aggregate (10 levels)Average of bid_agg_10 over the intervalbid_agg_20_avgAvg Bid Aggregate (20 levels)Average of bid_agg_20 over the intervalbid_agg_25_avgAvg Bid Aggregate (25 levels)Average of bid_agg_25 over the intervalfrom datetime import datefrom aperiodic import get_metricsdf = get_metrics( api_key="YOUR_API_KEY", metric="l2_liquidity", 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/l2_liquidity?timestamp=exchange&interval=1m&exchange=binance-futures