v1

latestOpenAPI 3.1.02026-07-2655154175.6 KB

Flow

Raw flow feed for a ticker (Flow Score + FlowBonus per trade)

Returns the most recent options trades for {ticker} within the requested timeframe, each scored on Skylit's directional Flow Score (-100 → +100) and conviction-weighted FlowBonus. The response also includes timeframe-level VWF / SDF / FIR aggregates.

get/v1/flow/{ticker}

Path parameters

tickerstring required

Example:SPY

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

Query parameters

timeframe'5m' | '15m' | '1h' | '4h' | '1d'

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

limitinteger

Max trades returned. Server caps this at 500.

min_premiumnumber double

Example:50000

Minimum total premium per trade (USD).

option_type'call' | 'put' | 'all'

Filter to calls or puts. all returns both.

trade_type'sweep' | 'multi_leg' | 'all'

Filter by trade type. Comma-separated for multiple.

moneyness'deep_itm' | 'itm' | 'atm' | 'otm' | 'deep_otm' | 'all'

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

start_timestring

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

end_timestring

Optional upper bound (RFC 3339 or Unix seconds).

max_premiumnumber double

Maximum total premium per trade (USD).

min_contractsinteger

Minimum contract size per trade.

max_contractsinteger

Maximum contract size per trade.

single_leg_onlyboolean

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

min_dteinteger

Minimum days to expiration.

max_dteinteger

Maximum days to expiration.

min_strikenumber double

Minimum strike price (inclusive).

max_strikenumber double

Maximum strike price (inclusive).

expirationstring date

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

conviction_weightsstring

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_scoreinteger

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

min_flow_bonusinteger

Filter to trades with flowBonus ≥ this value.

min_rvolnumber double

Example:2

Filter to trades with relative volume ≥ this multiple.

include_clustersboolean

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

datestring date

Example:2026-05-27

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

Response

Flow feed for {ticker}.

Example response

{
  "data": {
    "trades": [
      {
        "tradeId": "flow_188afe42c3a77af2_0",
        "scores": {
          "flowScoreInterpretation": "strong_bullish",
          "flowBonusInterpretation": "high_conviction"
        }
      }
    ]
  },
  "meta": {
    "requestId": "d7574836"
  }
}