/api/v1/data/l1_liquidity
L1 (Top of Book)
spreadSpreadLast value of ask_price − bid_pricespread_bpsSpread (bps)Last value of spread as basis points of midpricespread_depth_ratioSpread/Depth RatioLast value of spread / (bid_amount + ask_amount)total_depthTotal DepthLast value of bid_amount + ask_amountdollar_depth_bidBid Dollar DepthLast value of bid_price × bid_amountdollar_depth_askAsk Dollar DepthLast value of ask_price × ask_amounttotal_dollar_depthTotal Dollar DepthLast value of dollar_depth_bid + dollar_depth_askspread_avgAvg SpreadAverage of spread over the intervalspread_bps_avgAvg Spread (bps)Average of spread_bps over the intervalspread_depth_ratio_avgAvg Spread/Depth RatioAverage of spread_depth_ratio over the intervaltotal_depth_avgAvg Total DepthAverage of total_depth over the intervaldollar_depth_bid_avgAvg Bid Dollar DepthAverage of dollar_depth_bid over the intervaldollar_depth_ask_avgAvg Ask Dollar DepthAverage of dollar_depth_ask over the intervaltotal_dollar_depth_avgAvg Total Dollar DepthAverage of total_dollar_depth over the intervalfrom datetime import datefrom aperiodic import get_metricsdf = get_metrics( api_key="YOUR_API_KEY", metric="l1_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/l1_liquidity?timestamp=exchange&interval=1m&exchange=binance-futures