Flowseeker/API Reference/Flow

Live momentum signal vs baseline (5m / 30m / 1h windows)

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

Compares the current 5-minute, 30-minute, and 1-hour flow against the trailing per-time-of-day baseline (/v1/flow/{ticker}/baseline). Returns z-scores for the 5-minute window and a one-token trend classification.

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

  • as_ofstring

    Replay anchor. Accepts RFC 3339 or Unix seconds. Defaults to "now".

  • lookback_daysintegerdefault 20min 1 · max 30

    Trailing window size in trading days.

  • min_dteintegermin 0
  • max_dteintegermin 0

Responses

  • 200

    Live momentum metrics + signal.

  • 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
    • asOfstringdate-timerequired
    • current5mobjectrequired
    • current30mobjectrequired
    • current1hobjectrequired
    • baselineobject
    • signalsobjectrequired
    • 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?