Skip to main content
GET
/
v1
/
flow
/
{ticker}
Raw flow feed for a ticker (Flow Score + FlowBonus per trade)
curl --request GET \
  --url https://flow-api.skylit.ai/v1/flow/{ticker} \
  --header 'Authorization: Bearer <token>'
{ "data": { "ticker": "<string>", "timeframe": "<string>", "trades": [ { "timestamp": "2023-11-07T05:31:56Z", "tradeId": "flow_188afe42c3a77af2_0", "strike": 123, "expiration": "2023-12-25", "dte": 1, "contracts": 2, "premium": 123, "price": 123, "bid": 123, "ask": 123, "mid": 123, "underlyingPrice": 123, "isSweep": true, "isMultiLeg": true, "scores": { "flowScore": 0, "flowScoreInterpretation": "strong_bullish", "flowBonus": 50, "flowBonusInterpretation": "high_conviction", "baseDirection": 123, "convictionMultiplier": 123 }, "dteFactor": 123, "dteMultiplier": 123, "spreadWidth": 123, "spreadWidthPct": 123, "exchangeCount": 123, "moneynessPct": 123, "moneynessWeight": 123, "combinedMoneynessDteWeight": 123, "delta": 123, "notionalDeltaExposure": 123, "openInterest": 1, "dailyVolume": 1, "volOiRatio": 123, "volOiScore": 123, "sizeOiRatio": 123, "sizeOiScore": 123, "oiIsZero": true, "rvol": 123, "rvolScore": 123, "rvolCategory": "<string>", "iv": 123, "ivChangePct": 123, "relativePremium": 123, "cluster": { "clusterId": "<string>", "clusterTradeCount": 2, "clusterTotalPremium": 123, "clusterTimeSpanSeconds": 1 } } ], "aggregate": { "vwf": 123, "sdf": 123, "fir": 123 }, "tradeCount": 1, "sweepCount": 1, "totalPremium": 123, "queryTimeMs": 1 }, "meta": { "timestamp": "2023-11-07T05:31:56Z", "requestId": "d7574836" } }

Authorizations

​
Authorization
string
header
required

Skylit API key in the Authorization header (Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.

Path Parameters

​
ticker
string
required

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Example:

"SPY"

Query Parameters

​
timeframe
enum<string>
default:1d

Trailing window for the request. 1m and 5m are intraday-only; 1d–1m work historically.

Available options:
1m,
5m,
15m,
1h,
4h,
1d,
1w,
1M
​
limit
integer
default:100

Max trades returned. Server enforces an upper cap.

Required range: 1 <= x <= 1000
​
minPremium
number<double>

Minimum total premium per trade (USD).

Example:

50000

​
optionType
enum<string>
default:all

Filter to calls or puts. all returns both.

Available options:
call,
put,
all
​
tradeType
enum<string>
default:all

Filter sweeps, blocks, or splits.

Available options:
sweep,
block,
split,
all
​
moneyness
enum<string>
default:all

Bucket filter for moneyness category.

Available options:
deep_itm,
itm,
atm,
otm,
deep_otm,
all
​
minFlowScore
integer

Filter to trades with flowScore ≥ this value (-100..100).

Required range: -100 <= x <= 100
​
minFlowBonus
integer

Filter to trades with flowBonus ≥ this value.

Required range: x >= 0
​
minRvol
number<double>

Filter to trades with relative volume ≥ this multiple.

Required range: x >= 0
Example:

2

​
includeClusters
boolean
default:true

If true, attach cluster* fields when a trade is part of a multi-leg cluster (sweep, condor, etc.).

​
date
string<date>

Trading date (YYYY-MM-DD). Defaults to current trading date.

Example:

"2026-05-27"

Response

Flow feed for {ticker}.

​
data
object
required
​
meta
object
required