Docs
Flowseeker/API Reference/Analytics

Aggregate sentiment scoring across timeframes (VWF / SDF / FIR / Composite)

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

Returns a Composite directional score plus its VWF / SDF / FIR components for one or more trailing timeframes (intraday or multi-day). Optional moneyness breakdown, optional time-decay weighting, and a comparative trend block contrasting short- vs long-horizon sentiment.

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

  • timeframesstringdefault 1d

    Comma-separated timeframes, or all. Supported atoms: 1h, 4h, 1d, 7d, 30d, 90d. all expands to all six. Unknown atoms are treated as a single trading day.

  • include_breakdownbooleandefault true

    Attach the per-timeframe VWF/SDF/FIR component split.

  • include_moneynessbooleandefault false

    Attach a byMoneyness array (deep_itm → deep_otm).

  • moneyness_filterstringdefault all
    deep_itmitmatmotmdeep_otmall
  • expiration_filterstringdefault all

    Restrict to one expiration bucket.

    0dteweeklymonthlyleapsall
  • time_decaybooleandefault false

    Apply exponential time decay to VWF / SDF / FIR components.

  • time_decay_half_lifeintegerdefault 30min 1

    Half-life in minutes for the decay (only applied when timeDecay=true).

  • datestringdate

Responses

  • 200

    Aggregate sentiment by timeframe.

  • 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
    • generatedAtstringdate-timerequired
    • byTimeframeobjectrequired

      Map keyed by timeframe id (1h, 4h, 1d, 7d, 30d, 90d, …). Only the requested timeframes appear; missing entries indicate the underlying query failed for that horizon.

    • trendobjectrequired
    • byMoneynessobject[]

      Present when includeMoneyness=true.

  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?