Docs
Flowseeker/API Reference/Flow

Trailing per-time-of-day flow baseline (avg + stddev)

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

Time-of-day baseline buckets for {ticker} — average and standard deviation of trade count, premium, and FIR per intraday bucket over a configurable lookback window. The reference distribution behind /v1/flow/{ticker}/momentum z-scores.

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

  • bucketstringdefault 5min

    Bucket size for the time series. Coarser buckets (1d, 1w) are rejected on intraday endpoints.

    1min5min15min30min1h
  • lookback_daysintegerdefault 20min 1 · max 30

    Trailing window size in trading days.

  • start_time_of_daystringdefault 09:30

    Lower bound of intraday window (HH:MM ET).

  • end_time_of_daystringdefault 16:00

    Upper bound of intraday window (HH:MM ET).

  • min_dteintegermin 0
  • max_dteintegermin 0

Responses

  • 200

    Per-bucket baseline statistics.

  • 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).

  • 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
    • bucketstringrequired
    • lookbackDaysintegerrequired
    • startTimeOfDaystringrequired
    • endTimeOfDaystringrequired
    • bucketsobject[]required
    • queryTimeMsintegerrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?