Skip to main content
GET
Raw flow feed for a ticker (Flow Score + FlowBonus per trade)

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:1h

Trailing window label for the request. Supported values: 5m, 15m, 1h, 4h, 1d.

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

Max trades returned. Server caps this at 500.

Required range: 1 <= x <= 500
min_premium
number<double>

Minimum total premium per trade (USD).

Example:

50000

option_type
enum<string>
default:all

Filter to calls or puts. all returns both.

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

Filter by trade type. Comma-separated for multiple.

Available options:
sweep,
multi_leg,
all
moneyness
enum<string>
default:all

Moneyness category filter. Comma-separated for multiple (e.g. otm,deep_otm). Unknown tokens are ignored.

Available options:
deep_itm,
itm,
atm,
otm,
deep_otm,
all
start_time
string

Optional lower bound for the trade window. Accepts RFC 3339 (2026-05-27T13:30:00Z) or Unix seconds. Omit to use the timeframe.

end_time
string

Optional upper bound (RFC 3339 or Unix seconds).

max_premium
number<double>

Maximum total premium per trade (USD).

min_contracts
integer

Minimum contract size per trade.

Required range: x >= 0
max_contracts
integer

Maximum contract size per trade.

Required range: x >= 0
single_leg_only
boolean
default:false

If true, exclude trades flagged as part of a multi-leg structure.

min_dte
integer

Minimum days to expiration.

max_dte
integer

Maximum days to expiration.

min_strike
number<double>

Minimum strike price (inclusive).

max_strike
number<double>

Maximum strike price (inclusive).

expiration
string<date>

Filter to a single expiration date (YYYY-MM-DD).

conviction_weights
string

Optional JSON object overriding the Flow Score conviction weights. Weights must be non-negative and sum to within 0.95–1.05, else 400.

min_flow_score
integer

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

Required range: -100 <= x <= 100
min_flow_bonus
integer

Filter to trades with flowBonus ≥ this value.

Required range: x >= 0
min_rvol
number<double>

Filter to trades with relative volume ≥ this multiple.

Required range: x >= 0
Example:

2

include_clusters
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