Docs
Flowseeker/API Reference/Flow

Today's flow vs trailing average (with similar-days lookback)

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

Compares the current trading day's premium / volume / net premium / call-put ratio against the trailing 20-trading-day average for the same ticker. Returns absolute deltas, percentile rankings, and the five most-similar past trading days.

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

  • datestringdate

    Date to evaluate (YYYY-MM-DD). Defaults to today.

Responses

  • 200

    Today vs historical comparison.

  • 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
    • datestringdaterequired
    • currentobjectrequired
    • historicalobjectrequired
    • vsAverageobjectrequired
    • percentileRankingsobjectrequired
    • similarDaysobject[]required
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?