We define Directional Alpha as a signal that exhibits a consistent positive or negative relationship with forward returns.
Pre-executed results — free to run on preview data, or use the CLI with DEMO-KEY.
Browse the catalog and pull point-in-time microstructure metrics — no L2 reconstruction, no tick archive to maintain.
Every notebook runs end to end on preview data with a free account, in the browser or through the CLI.
Swap the preview key for your own and the same code pulls the full history through the Python package or the API.
This notebook introduces order-flow analytics with the `aperiodic` Python package. We focus on a single large-cap instrument — Binance BTC perpetuals (`perpetual-BTC-USDT:USDT`) — over the exact six-month window from September 1, 2025 through February 28, 2026, using 1-hour observations.
View notebookFrom raw order flow to a ranked, backtestable signal — every step in runnable code.
Directional order flow split by taker buy vs. sell, broken into small/medium/large notional segments, with a flow toxicity score.
Need the ticks behind this metric? Prime + Raw includes raw trades.
/api/v1/data/flow
Trades
taker_buy_volumeTaker Buy VolumeTotal buy-side traded notional in the intervaltaker_sell_volumeTaker Sell VolumeTotal sell-side traded notional in the intervaltaker_buy_countTaker Buy CountNumber of buy-side trades in the intervaltaker_sell_countTaker Sell CountNumber of sell-side trades in the intervalvolume_deltaVolume DeltaBuy-side traded quantity minus sell-side traded quantityvolume_delta_notionalVolume Delta NotionalBuy-side traded notional minus sell-side traded notionalflow_entropyFlow EntropyEntropy of the buy-versus-sell notional split in the intervalflow_toxicity_scoreFlow Toxicity ScorePast-normalized signed notional flow multiplied by past-normalized short-horizon realized volatilitytaker_buy_sell_ratioBuy/Sell RatioBuy-side traded notional divided by sell-side traded notionaltaker_buy_sell_count_ratioBuy/Sell Count RatioBuy-side trade count divided by sell-side trade counttaker_buy_sell_percentageTaker Buy %Share of traded notional that came from buy-side tradestaker_buy_sell_count_percentageTaker Buy Count %Share of trades that were buy-side tradestaker_buy_small_order_volumeBuy Small Order VolumeTotal buy-side notional from small trades under $100taker_buy_small_order_countBuy Small Order CountNumber of buy-side trades under $100taker_buy_medium_order_volumeBuy Medium Order VolumeTotal buy-side notional from medium trades from $100 to under $1,000taker_buy_medium_order_countBuy Medium Order CountNumber of buy-side trades from $100 to under $1,000taker_buy_large_order_volumeBuy Large Order VolumeTotal buy-side notional from large trades of at least $1,000taker_buy_large_order_countBuy Large Order CountNumber of buy-side trades of at least $1,000taker_sell_small_order_volumeSell Small Order VolumeTotal sell-side notional from small trades under $100taker_sell_small_order_countSell Small Order CountNumber of sell-side trades under $100taker_sell_medium_order_volumeSell Medium Order VolumeTotal sell-side notional from medium trades from $100 to under $1,000taker_sell_medium_order_countSell Medium Order CountNumber of sell-side trades from $100 to under $1,000taker_sell_large_order_volumeSell Large Order VolumeTotal sell-side notional from large trades of at least $1,000taker_sell_large_order_countSell Large Order CountNumber of sell-side trades of at least $1,000taker_buy_small_order_percentageBuy Small Order %Ratio of small buy-side trade notional to total buy-side traded notionaltaker_buy_medium_order_percentageBuy Medium Order %Ratio of medium buy-side trade notional to total buy-side traded notionaltaker_buy_large_order_percentageBuy Large Order %Ratio of large buy-side trade notional to total buy-side traded notionaltaker_buy_small_order_count_percentageBuy Small Count %Share of buy-side trades that were small tradestaker_buy_medium_order_count_percentageBuy Medium Count %Share of buy-side trades that were medium tradestaker_buy_large_order_count_percentageBuy Large Count %Share of buy-side trades that were large tradestaker_sell_small_order_percentageSell Small Order %Ratio of small sell-side trade notional to total sell-side traded notionaltaker_sell_medium_order_percentageSell Medium Order %Ratio of medium sell-side trade notional to total sell-side traded notionaltaker_sell_large_order_percentageSell Large Order %Ratio of large sell-side trade notional to total sell-side traded notionaltaker_sell_small_order_count_percentageSell Small Count %Share of sell-side trades that were small tradestaker_sell_medium_order_count_percentageSell Medium Count %Share of sell-side trades that were medium tradestaker_sell_large_order_count_percentageSell Large Count %Share of sell-side trades that were large trades# Install the Aperiodic CLI into ~/.local/bin
mkdir -p "$HOME/.local/bin"
curl -fsSL https://raw.githubusercontent.com/aperiodic-io/cli/main/install.sh | INSTALL_DIR="$HOME/.local/bin" bash
export PATH="$HOME/.local/bin:$PATH"
# Free preview — no API key required
aperiodic flow --preview \
--exchange binance-futures \
--symbol perpetual-BTC-USDT:USDT \
--interval 5m \
--timestamp exchange \
--start-date 2025-05-01 \
--end-date 2025-05-31 \
--output-dir ./data && echo "Saved to $PWD/data"timestampreqstringTimestamp source. 'exchange' uses the exchange-reported timestamp, 'true' uses actual arrival time at our servers.
exchangetrueintervalreqstringAggregation time interval for the data. Sub-minute intervals (15s, 30s) require a Tier 3 subscription.
15s30s1m5m15m30m1h4h1dexchangereqstringSource exchange for the data.
binance-futuresokx-perpshyperliquid-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 every file covering the range — one per month before 2026-08-01, one per day from 2026-08-01 onwards
filesobject[]requiredFiles covering the requested date range, in chronological order. Data before 2026-08-01 is split by month (one file per calendar month, no `day`); data from 2026-08-01 onwards is split by day (one file per calendar day, with `day` set). The changeover falls on a month boundary, so a given month is served entirely one way or the other; a range spanning it returns the earlier months as monthly files followed by a daily file per day.
yearintegerrequiredYear of the data file
monthintegerrequiredMonth of the data file (1-12)
dayintegerDay of the data file (1-31). Present only on daily files, i.e. those covering 2026-08-01 onwards. Absent on monthly files, which cover an entire calendar month.
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": 2026,
"month": 6,
"url": "https://ohlcv.aperiodic.io/binance-futures/1h/BTCUSDT/2026-06.parquet?X-Amz-Expires=300&..."
},
{
"year": 2026,
"month": 7,
"url": "https://ohlcv.aperiodic.io/binance-futures/1h/BTCUSDT/2026-07.parquet?X-Amz-Expires=300&..."
},
{
"year": 2026,
"month": 8,
"day": 1,
"url": "https://ohlcv.aperiodic.io/binance-futures/1h/BTCUSDT/2026-08-01.parquet?X-Amz-Expires=300&..."
},
{
"year": 2026,
"month": 8,
"day": 2,
"url": "https://ohlcv.aperiodic.io/binance-futures/1h/BTCUSDT/2026-08-02.parquet?X-Amz-Expires=300&..."
}
]
}
Prefilled with the shared DEMO-KEY and a free preview slice — send the request to see live data, no account required.
/api/v1/data/preview/flow?timestamp=exchange&interval=5m&exchange=binance-futures&symbol=perpetual-BTC-USDT%3AUSDT&start_date=2025-05-01&end_date=2025-05-31