v1

latestOpenAPI 3.1.02026-07-2655154175.6 KB

Analytics

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

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. Reference: PRD Section 8.

get/v1/aggregate/{ticker}

Path parameters

tickerstring required

Example:SPY

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Query parameters

timeframesstring

Example:1d,7d,30d

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_breakdownboolean

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

include_moneynessboolean

Attach a byMoneyness array (deep_itm → deep_otm).

moneyness_filter'deep_itm' | 'itm' | 'atm' | 'otm' | 'deep_otm' | 'all'

expiration_filter'0dte' | 'weekly' | 'monthly' | 'leaps' | 'all'

Restrict to one expiration bucket.

time_decayboolean

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

time_decay_half_lifeinteger

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

datestring date

Response

Aggregate sentiment by timeframe.

Example response

{
  "meta": {
    "requestId": "d7574836"
  }
}

All 55 operations