Skip to main content
GET
/
v1
/
aggregate
/
{ticker}
Aggregate sentiment scoring across timeframes (VWF / SDF / FIR / Composite)
curl --request GET \
  --url https://flow-api.skylit.ai/v1/aggregate/{ticker} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "ticker": "<string>",
    "generatedAt": "2023-11-07T05:31:56Z",
    "byTimeframe": {},
    "trend": {
      "description": "<string>"
    },
    "byMoneyness": [
      {
        "composite": 123,
        "tradeCount": 1,
        "premium": 123,
        "pctOfTotal": 123
      }
    ]
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "d7574836"
  }
}

Authorizations

​
Authorization
string
header
required

Skylit API key in the Authorization header (Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.

Path Parameters

​
ticker
string
required

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

Example:

"SPY"

Query Parameters

​
timeframes
string
default:1d

Comma-separated timeframes, or all. Supported atoms: 5m, 15m, 1h, 4h, 1d, 7d, 30d, 90d.

Example:

"1d,7d,30d"

​
includeBreakdown
boolean
default:true

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

​
includeMoneyness
boolean
default:false

Attach a byMoneyness array (deep_itm → deep_otm).

​
moneynessFilter
enum<string>
default:all
Available options:
deep_itm,
itm,
atm,
otm,
deep_otm,
all
​
expirationFilter
enum<string>
default:all

Restrict to one expiration bucket.

Available options:
0dte,
weekly,
monthly,
leaps,
all
​
timeDecay
boolean
default:false

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

​
timeDecayHalfLife
integer
default:30

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

Required range: x >= 1
​
date
string<date>

Response

Aggregate sentiment by timeframe.

​
data
object
required
​
meta
object
required