Docs
Flowseeker/API Reference/Flow

Aggregate flow over an arbitrary [start, end] window

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

Server-side aggregation across an arbitrary [startTime, endTime] window — no row cap. Returns trade/sweep counts, VWF/SDF/FIR, and a bullish/bearish/neutral premium split with a one-line interpretation. Useful for arbitrary slicing without paging the full trade list.

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

  • start_timestringrequired

    Lower bound of the window. Accepts RFC 3339 (2026-05-27T13:30:00Z) or Unix seconds.

  • end_timestringrequired

    Upper bound of the window (RFC 3339 or Unix seconds).

  • option_typestringdefault all
    callputall
  • min_premiumnumberdouble
  • exclude_multi_legbooleandefault false

    Exclude trades flagged as part of a multi-leg structure.

  • min_dteintegermin 0
  • max_dteintegermin 0
  • datestringdate

Responses

  • 200

    Window-aggregated flow scores.

  • 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

    Unknown, revoked or expired API key (the gateway's forbidden), the account's API access is suspended (account_suspended) or blocked (account_blocked). Not retryable.

  • 404

    Unknown ticker or contract (SYMBOL_NOT_FOUND), or no data for the requested window. Not charged.

  • 429

    Either the key exceeded its requests-per-minute limit (X-RateLimit-Limit; no Retry-After, wait until X-RateLimit-Reset), or the account is over one of the API's own limits, such as the query budget (queries running at once, fresh queries per second): TOO_MANY_CONCURRENT_QUERIES or RATE_LIMITED with Retry-After. Not charged; retry after the wait.

  • 500

    Unexpected server error (INTERNAL_ERROR, DATABASE_ERROR). Not charged; safe to retry with exponential backoff.

  • 503

    Underlying data source temporarily unavailable, the credit balance could not be verified (credit_check_failed), or the API is paused for maintenance (api_paused, with a Retry-After header and a retry_after field in seconds). Not charged; safe to retry.

  • 504

    The request did not complete within 25 seconds. Not charged; narrow the window or retry.

Response fields

  • dataobjectrequired
    • tickerstringrequired
    • startTimestringdate-timerequired
    • endTimestringdate-timerequired
    • tradeCountintegerrequired
    • sweepCountintegerrequired
    • totalPremiumnumberrequired
    • aggregaterequired
    • premiumSplitobjectrequired
    • interpretationobjectrequired
    • queryTimeMsintegerrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

    • nextCursorstring

      Trade feeds (/v1/flow/{ticker}, /v1/contract/{symbol}/trades): pass back as cursor with the same filters for the next page. Present only when more rows may follow.

    • nextEndTimestringdate-time

      /v1/flow/{ticker} only: the last row's exact time (RFC 3339 with nanoseconds), for end_time paging. Inclusive, so rows at that instant can repeat; nextCursor never repeats or skips.

Last updated

Was this page helpful?