Docs
Flowseeker/API Reference/Sweeps

Aggregated multi-exchange sweep activity

GEThttps://flow-api.skylit.ai/v1/sweeps/{ticker}

Returns "logical sweeps" — multi-exchange splits of one large order grouped by contract within a one-second execution window. Each row carries the venue list, total contracts/premium, spread position, moneyness bucket, and Skylit Flow Score / FlowBonus. The summary block adds population-level Sweep Dominance Factor (SDF) and bullish/bearish counts extrapolated from the full-day total.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Path parameters

  • tickerstringrequired

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

Query parameters

  • timeframestringdefault 1h

    Trailing window. Currently only restricts the trading day; 5m/15m/1h/4h reserved for future intraday filtering.

    5m15m1h4h1d
  • min_premiumnumberdouble
  • option_typestringdefault all
    callputall
  • moneynessstringdefault all
    deep_itmitmatmotmdeep_otmall
  • min_dteintegermin 0
  • max_dteintegermin 0
  • min_strikenumberdouble
  • max_strikenumberdouble
  • expirationstringdate

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

  • limitintegerdefault 100min 1 · max 500

    Max sweep rows returned (server caps at 500).

  • datestringdate

Responses

  • 200

    Sweep activity 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
    • tickerstringrequired
    • sweepsobject[]required
    • summaryobjectrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?