curl --request GET \
--url https://api.alphractal.com/{asset}/derivatives/Orderflow_summary \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.alphractal.com/{asset}/derivatives/Orderflow_summary"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.alphractal.com/{asset}/derivatives/Orderflow_summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"time": "2023-11-07T05:31:56Z",
"retail_buy_usd": 123,
"retail_sell_usd": 123,
"mid_buy_usd": 123,
"mid_sell_usd": 123,
"whale_buy_usd": 123,
"whale_sell_usd": 123
}
]Order Flow Summary (Retail, Mid, Whale)
Taker flow on perpetual swaps grouped by market order size, in USD: retail (under 10k), mid (10k to 1M) and whale (1M and above). Every exchange is summed. Each bucket classifies the whole market order (fills of the same side in the same millisecond), not each fill. The series starts on 2026-09-17; earlier dates return an empty array. 1m keeps 90 days. Without startDate, 1m returns the 7 days before the asset’s last minute with data (at or before endDate, when it is given); 5m to 4h return their newest bars (5m 90 days, 15m 180 days, 30m 1 year, 1h 2 years, 4h 4 years); 6h, 12h and 1d return the whole series. A 1m window longer than 7 days, counted to endDate or to now without one, is rejected with 400; request consecutive windows instead.
curl --request GET \
--url https://api.alphractal.com/{asset}/derivatives/Orderflow_summary \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.alphractal.com/{asset}/derivatives/Orderflow_summary"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.alphractal.com/{asset}/derivatives/Orderflow_summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"time": "2023-11-07T05:31:56Z",
"retail_buy_usd": 123,
"retail_sell_usd": 123,
"mid_buy_usd": 123,
"mid_sell_usd": 123,
"whale_buy_usd": 123,
"whale_sell_usd": 123
}
]Authorizations
API Key authentication. Include your API key in the X-Api-Key header for all requests.
Path Parameters
Asset identifier, lowercase ticker. The list is the assets that carry this metric — an asset outside it has no data here.
0g, 1inch, 2z, a, aave, ace, ada, aero, aioz, akt, alch, algo, ape, apt, ar, arb, aster, ath, atom, avax, awe, axs, b, banana, bard, bat, bch, beam, bnb, bonk, brett, bsv, btc, btt, cake, cc, cfg, cfx, cheems, chz, ckb, comp, core, cow, cro, crv, ctc, cvx, cys, dash, deep, dexe, dog, doge, dot, dydx, egld, ena, ens, etc, eth, ethfi, fartcoin, fet, ff, fil, floki, flr, fluid, form, frax, g, gala, gas, glm, gmx, gno, grass, grt, gwei, h, hbar, hnt, home, hot, hype, icnt, icp, imx, inch, inj, iota, ip, jasmy, jst, jto, jup, kaia, kaito, kas, kite, la, ldo, link, lit, lpt, ltc, lunc, m, mana, mantra, met, mina, mnt, mon, morpho, move, near, neo, night, okb, ondo, op, paxg, pendle, pengu, pepe, pieverse, pippin, pol, pump, pyth, qnt, qtum, qubic, render, river, rose, rsr, rune, rvn, s, safe, sand, sei, sent, sfp, shib, siren, skr, sky, snx, sol, spx, stable, stg, strk, stx, sui, sun, syrup, t, tag, tao, theta, tia, ton, toshi, tria, trump, trx, turbo, twt, uai, ub, uni, velo, vet, virtual, vvv, w, wal, wif, wld, wlfi, xaut, xcn, xdc, xec, xlm, xmr, xpl, xrp, xtz, xvg, yfi, yzy, z, zec, zen, zil, zk, zro, zrx Query Parameters
Aggregation bucket. Values outside the accepted list fall back to the daily series instead of returning an error.
1m, 5m, 15m, 30m, 1h, 4h, 6h, 12h, 1d Start of the window (UTC, inclusive). Without it, 1m returns the 7 days before the asset's last minute with data; 5m to 4h return their newest bars (5m 90 days, 15m 180 days, 30m 1 year, 1h 2 years, 4h 4 years); 6h, 12h and 1d return the whole series, which starts on 2026-09-17. A 1m window longer than 7 days is rejected with 400; request consecutive windows instead.
End of the window (UTC, inclusive). With 1m and no startDate, the answer is the 7 days before the last minute with data at or before this date.