/api/v1/data/trade_size
Trades
small_order_volumeSmall Order VolumeNotional value of small orders (< $100)small_order_countSmall Order CountNumber of small ordersmedium_order_volumeMedium Order VolumeNotional value of medium orders ($100–$1,000)medium_order_countMedium Order CountNumber of medium orderslarge_order_volumeLarge Order VolumeNotional value of large orders (>= $1,000)large_order_countLarge Order CountNumber of large ordersvolumeTotal VolumeTotal trade volume (sum of amounts)n_tradesTrade CountNumber of all tradessmall_order_percentageSmall Order %small_order_volume / volumemedium_order_percentageMedium Order %medium_order_volume / volumelarge_order_percentageLarge Order %large_order_volume / volumesmall_order_count_percentageSmall Order Count %small_order_count / n_tradesmedium_order_count_percentageMedium Order Count %medium_order_count / n_tradeslarge_order_count_percentageLarge Order Count %large_order_count / n_tradestrade_amount_meanMean Trade SizeAverage trade sizetrade_amount_medianMedian Trade SizeMedian trade sizetrade_amount_stdTrade Size Std DevStandard deviation of trade sizetrade_amount_varianceTrade Size VarianceVariance of trade sizetrade_amount_skewnessTrade Size SkewnessSkewness of trade size distributiontrade_amount_kurtosisTrade Size KurtosisKurtosis of trade size distributiontrade_amount_minMin Trade SizeSmallest trade size in intervaltrade_amount_maxMax Trade SizeLargest trade size in intervaltrade_amount_range_ratioTrade Size Range Ratiotrade_amount_max / trade_amount_mintrade_amount_cvTrade Size CVCoefficient of variation (trade_amount_std / trade_amount_mean)from datetime import datefrom aperiodic import get_metricsdf = get_metrics( api_key="YOUR_API_KEY", metric="trade_size", 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/trade_size?timestamp=exchange&interval=1m&exchange=binance-futures