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

Authorization

Path parameters

• tickerstringrequired

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

Query parameters

• timeframestringdefault 1h

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

  5m15m1h4h1d
• limitintegerdefault 100min 1 · max 500

  Max trades returned. Server caps this at 500.

• min_premiumnumberdouble

  Minimum total premium per trade (USD).

• option_typestringdefault all

  Filter to calls or puts. all returns both.

  callputall
• trade_typestringdefault all

  Filter by trade type. Comma-separated for multiple.

  sweepmulti_legall
• moneynessstringdefault all

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

  deep_itmitmatmotmdeep_otmall
• 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_premiumnumberdouble

  Maximum total premium per trade (USD).

• min_contractsintegermin 0

  Minimum contract size per trade.

• max_contractsintegermin 0

  Maximum contract size per trade.

• single_leg_onlybooleandefault false

  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_strikenumberdouble

  Minimum strike price (inclusive).

• max_strikenumberdouble

  Maximum strike price (inclusive).

• expirationstringdate

  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_scoreintegermin -100 · max 100

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

• min_flow_bonusintegermin 0

  Filter to trades with flowBonus ≥ this value.

• min_rvolnumberdoublemin 0

  Filter to trades with relative volume ≥ this multiple.

• include_clustersbooleandefault true

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

• datestringdate

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

Responses

• 200

  Flow feed for {ticker}.

• 400

  Request validation failed.

• 401

  Missing or invalid API key.

• 402

  The account's shared Skylit credit balance is lower than this route's cost. Top up to continue. Carries X-Credits-Remaining: 0.

• 403

  API key invalid, revoked or expired, or the account's API access is suspended (account_suspended).

• 404

  Unknown resource (ticker / sector / window with no data).

• 429

  Per-minute rate limit exceeded.

• 503

  Underlying data source temporarily unavailable, or the credit balance could not be verified (credit_check_failed). Safe to retry.

Response fields

• dataobjectrequired
  Hide 8 fields

  • tickerstringrequired
  • timeframestringrequired
  • tradesobject[]required
    Show 43 fields
  • aggregateobjectrequired

    Window-level scoring components.

    Show 3 fields
  • tradeCountintegerrequired
  • sweepCountintegerrequired
  • totalPremiumnumberrequired
  • queryTimeMsintegerrequired
• metaobjectrequired
  Hide 2 fields

  • timestampstringdate-timerequired

    Server-side timestamp the response was generated at.

  • requestIdstringrequired

    Short opaque ID for log correlation.