sentisense 0.80.0 → 0.82.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -854,22 +854,36 @@ interface OptionsAggregate {
854
854
  date?: string;
855
855
  callVol?: number;
856
856
  putVol?: number;
857
+ /** Call open interest going into this session, counted at the previous close. */
857
858
  callOi?: number;
859
+ /** Put open interest going into this session, counted at the previous close. */
858
860
  putOi?: number;
859
861
  /** Put/call volume ratio. */
860
862
  pcVol?: number;
861
- /** Put/call open-interest ratio. */
863
+ /**
864
+ * Put/call open-interest ratio, from the same open interest as `callOi` and `putOi`: going
865
+ * into this session, counted at the previous close.
866
+ */
862
867
  pcOi?: number;
863
868
  /** Volume-weighted implied volatility. */
864
869
  vwIv?: number;
865
- /** At-the-money implied volatility. */
870
+ /**
871
+ * At-the-money implied volatility, read on the listed expiry closest to 30 calendar days
872
+ * out, with no interpolation to a constant 30-day maturity.
873
+ */
866
874
  atmIv?: number;
867
- /** `iv25p - iv25c`: positive means puts are bid up relative to calls. */
875
+ /**
876
+ * `iv25p - iv25c`: positive means puts are bid up relative to calls. Read on the same listed
877
+ * expiry as `atmIv`, the one closest to 30 calendar days out, with no interpolation.
878
+ */
868
879
  skew25d?: number;
869
880
  /** Roughly 60-day and 90-day at-the-money implied volatility: the term structure. */
870
881
  atmIv60?: number;
871
882
  atmIv90?: number;
872
- /** Raw 25-delta call and put implied volatilities. */
883
+ /**
884
+ * Raw 25-delta call and put implied volatilities, read on the listed expiry closest to 30
885
+ * calendar days out, with no interpolation.
886
+ */
873
887
  iv25c?: number;
874
888
  iv25p?: number;
875
889
  /**
@@ -893,9 +907,19 @@ interface OptionsAggregate {
893
907
  /** One-sigma expected move over 20 trading sessions. */
894
908
  expectedMove1s20d?: number;
895
909
  netDelta?: number;
910
+ /**
911
+ * Estimated premium activity: session volume times the closing mark times 100, summed in
912
+ * USD. A valuation at the mark, not observed spending. A session completed from a secondary
913
+ * feed is valued at each contract's last trade instead, and keeps those values unless a
914
+ * complete primary chain arrives within the next four trading sessions.
915
+ */
896
916
  notionalVol?: number;
897
917
  contracts?: number;
898
- /** Largest unusual-contract premium this session; zero when none qualified. */
918
+ /**
919
+ * Largest unusual-contract premium this session; zero when none qualified. Valued at the
920
+ * closing mark like `notionalVol`, so an estimate rather than money paid, and at the last
921
+ * trade on a session completed from a secondary feed.
922
+ */
899
923
  maxUnusualPremium?: number;
900
924
  /**
901
925
  * Premium of the session's highlight contract: the largest qualifying premium with an
@@ -974,6 +998,10 @@ interface OptionsUnusualContract {
974
998
  volume?: number;
975
999
  oi?: number;
976
1000
  volOiRatio?: number;
1001
+ /**
1002
+ * Volume times the closing mark times 100: an estimate at the mark, not money paid. On a
1003
+ * session completed from a secondary feed it is valued at the contract's last trade instead.
1004
+ */
977
1005
  premium?: number;
978
1006
  oiPrior?: number;
979
1007
  oiNext?: number;
@@ -1176,8 +1204,10 @@ interface OptionsIntradayPoint {
1176
1204
  */
1177
1205
  maxPremiumPctl1y?: number;
1178
1206
  /**
1179
- * At-the-money implied volatility as a fraction (`0.42` is 42%), by the same rule as the
1180
- * end-of-day `atmIv`. Absent when that expiry has no usable contract.
1207
+ * At-the-money implied volatility as a fraction (`0.42` is 42%), read on the listed expiry
1208
+ * closest to 30 calendar days out. Closely related to the end-of-day `atmIv`, but the two
1209
+ * can differ on the same chain, so do not treat them as interchangeable. Absent when that
1210
+ * expiry has no usable contract.
1181
1211
  */
1182
1212
  atmIv?: number;
1183
1213
  }
@@ -1187,7 +1217,8 @@ interface OptionsIntradayPoint {
1187
1217
  *
1188
1218
  * The board is rebuilt every 15 minutes from 15-minute delayed chains, from 09:45 to 16:15 ET,
1189
1219
  * so a full session holds 27 cycles. A ticker appears only on the cycles where it was on the
1190
- * board, so `cycles` can be below that and the gaps show in each point's `cycle` and `asOf`.
1220
+ * board, so `series` can be shorter than `cycles` and the gaps show in each point's `cycle`
1221
+ * and `asOf`.
1191
1222
  *
1192
1223
  * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
1193
1224
  * before the history was kept, a ticker outside the board and an unknown symbol all answer
@@ -1206,12 +1237,15 @@ interface OptionsIntradayHistory {
1206
1237
  live: boolean;
1207
1238
  /** How far the chain data behind each point trails the market, in minutes. */
1208
1239
  delayMinutes: number;
1209
- /** Number of points in `series`. */
1240
+ /**
1241
+ * Number of stored cycles in the session. `series` has fewer points when the ticker was not
1242
+ * on the intraday board for some of them.
1243
+ */
1210
1244
  cycles: number;
1211
1245
  /**
1212
- * Cycles of the session whose board was published but whose stored point could not be
1213
- * found, ascending: this ticker's numbers at those cycles are unknown, not absent. Omitted
1214
- * when there are none.
1246
+ * Cycles of the session with no stored history, ascending: a cycle that published no board,
1247
+ * or one whose history was lost. This ticker's numbers at those cycles are unknown, not
1248
+ * zero. Omitted when there are none.
1215
1249
  */
1216
1250
  missingCycles?: number[];
1217
1251
  /** One point per cycle that carried this ticker, oldest first. */
@@ -1248,15 +1282,25 @@ interface OptionsOverviewRow {
1248
1282
  pcVol?: number;
1249
1283
  /** Percentile (0-100) of `pcVol` within this ticker's own trailing year. */
1250
1284
  pcVolPctl1y?: number;
1251
- /** At-the-money implied volatility as a fraction, so `0.42` is 42%. */
1285
+ /**
1286
+ * At-the-money implied volatility as a fraction, so `0.42` is 42%, read on the listed expiry
1287
+ * closest to 30 calendar days out, with no interpolation to a constant 30-day maturity.
1288
+ */
1252
1289
  atmIv?: number;
1253
1290
  /** Where `atmIv` sits in this ticker's own trailing-year range, 0-100. */
1254
1291
  ivRank1y?: number;
1255
- /** `iv25p - iv25c`, on the same scale as the IVs: `0.03` is three IV points. */
1292
+ /**
1293
+ * `iv25p - iv25c`, on the same scale as the IVs: `0.03` is three IV points. Read on the same
1294
+ * listed expiry as `atmIv`, the one closest to 30 calendar days out, with no interpolation.
1295
+ */
1256
1296
  skew25d?: number;
1257
1297
  /** Percentile (0-100) of `skew25d` within this ticker's own trailing year. */
1258
1298
  skewPctl1y?: number;
1259
- /** Premium traded this session: volume times mark times 100. */
1299
+ /**
1300
+ * Estimated premium activity this session: volume times the closing mark times 100, summed
1301
+ * in USD. A valuation at the mark, not observed spending; a session completed from a
1302
+ * secondary feed is valued at each contract's last trade instead.
1303
+ */
1260
1304
  notionalVol?: number;
1261
1305
  /** Signed change of `atmIv` against its ~20-session mean. Rank "biggest IV moves" by absolute value. */
1262
1306
  ivMove20?: number;
@@ -1278,7 +1322,10 @@ interface OptionsOverviewRow {
1278
1322
  unusualCount?: number;
1279
1323
  /** Largest volume/open-interest multiple among them. Absent when `unusualCount` is 0. */
1280
1324
  maxVolOiRatio?: number;
1281
- /** Largest premium among them. Absent when `unusualCount` is 0. */
1325
+ /**
1326
+ * Largest premium among them, valued at the closing mark like `notionalVol` (at the last
1327
+ * trade on a session completed from a secondary feed). Absent when `unusualCount` is 0.
1328
+ */
1282
1329
  maxUnusualPremium?: number;
1283
1330
  /** Side of the single heaviest open-interest wall, `"call"` or `"put"`. */
1284
1331
  wallSide?: string;
@@ -1298,6 +1345,10 @@ interface OptionsHighlight {
1298
1345
  volume?: number;
1299
1346
  oi?: number;
1300
1347
  volOiRatio?: number;
1348
+ /**
1349
+ * Volume times the closing mark times 100: an estimate at the mark, not money paid. On a
1350
+ * session completed from a secondary feed it is valued at the contract's last trade instead.
1351
+ */
1301
1352
  premium?: number;
1302
1353
  /** Percentile against this ticker's trailing-year largest daily unusual premiums, 0-100. */
1303
1354
  premiumPctl1y?: number;
@@ -1347,7 +1398,10 @@ interface OptionsOverview {
1347
1398
  coverageCount?: number;
1348
1399
  /** The stock board, ranked. FREE keys receive the top 25; the envelope's `totalCount` carries the full size. */
1349
1400
  rows?: OptionsOverviewRow[];
1350
- /** The ETF board, ranked independently. Omitted entirely when a build has no ETF rows. */
1401
+ /**
1402
+ * The ETF board, ranked independently. FREE keys receive the top 25; `etfTotalCount` carries
1403
+ * the full size. Omitted entirely when a build has no ETF rows.
1404
+ */
1351
1405
  etfRows?: OptionsOverviewRow[];
1352
1406
  /** Stock session highlights, up to 3 for FREE keys and 10 for PRO. Omitted when empty. */
1353
1407
  highlights?: OptionsHighlight[];
@@ -1922,6 +1976,14 @@ interface HolderNotableChanges {
1922
1976
  * alongside ticker-level totals like `holderCount`.
1923
1977
  */
1924
1978
  interface TickerHolders {
1979
+ /**
1980
+ * The security this roster is for, per share class, in SentiSense's spelling. 13F filings
1981
+ * report each share class under its own CUSIP, so `GOOG` is Alphabet's Class C roster and
1982
+ * `GOOGL` its Class A roster. It can differ from the ticker you requested: `BRKB` gives
1983
+ * `BRK.B`, and a recognized former ticker gives the company's current one. It is not the raw
1984
+ * 13F key the filings are recorded under. The rosters of two share classes are separate and must not be
1985
+ * added together as the issuer's holders.
1986
+ */
1925
1987
  ticker: string;
1926
1988
  companyName: string;
1927
1989
  /** The quarter actually served (ISO date). */
@@ -2013,6 +2075,56 @@ type InstitutionalFlowsResponse = InstitutionalFlows;
2013
2075
  interface GetFlowsOptions {
2014
2076
  limit?: number;
2015
2077
  }
2078
+ /**
2079
+ * One issuer's convertible bonds as institutions reported them on Form 13F for a quarter: a row
2080
+ * of `institutional.getBondFlows()`. Positions are grouped by the issuer's equity ticker.
2081
+ */
2082
+ interface InstitutionalBondFlow {
2083
+ /** The equity ticker the issuer's bonds are grouped under, e.g. `"ABNB"`. */
2084
+ baseTicker: string;
2085
+ /** Company name; `null` when no name is on record for the issuer. */
2086
+ companyName: string | null;
2087
+ /** Institutional positions in this issuer's bonds. */
2088
+ positionCount: number;
2089
+ /** Total value of those positions, in US dollars. */
2090
+ totalValue: number;
2091
+ /** Net change in shares or units held, summed across the positions. */
2092
+ netSharesChange: number;
2093
+ /**
2094
+ * The bond notations held, as ONE comma-separated string on the wire, not an array: for
2095
+ * example `"ABNB 0 03/15/26, ABNB 0.5 06/15/27"`. Split it on `", "` for a list.
2096
+ */
2097
+ bondTickers: string;
2098
+ /** Hedge funds holding this issuer's bonds. */
2099
+ hedgeFundCount: number;
2100
+ }
2101
+ /**
2102
+ * One stock's call and put positions as institutions reported them on Form 13F for a quarter: a
2103
+ * row of `institutional.getOptionFlows()`.
2104
+ *
2105
+ * These are quarter-end 13F holdings, not options market activity: for options volume, open
2106
+ * interest and implied volatility, use `client.options` and `stocks.getOptionsSummary()`.
2107
+ */
2108
+ interface InstitutionalOptionFlow {
2109
+ /** Ticker of the stock the options are on. */
2110
+ ticker: string;
2111
+ /** Company name; `null` when no name is on record for the company. */
2112
+ companyName: string | null;
2113
+ /** Total value of the call option positions, in US dollars. */
2114
+ callValue: number;
2115
+ /** Total value of the put option positions, in US dollars. */
2116
+ putValue: number;
2117
+ /** Call option positions reported. */
2118
+ callPositions: number;
2119
+ /** Put option positions reported. */
2120
+ putPositions: number;
2121
+ /** Net change in call option shares, summed across the positions. */
2122
+ callNetChange: number;
2123
+ /** Net change in put option shares, summed across the positions. */
2124
+ putNetChange: number;
2125
+ /** Hedge funds holding options on this ticker. */
2126
+ hedgeFundCount: number;
2127
+ }
2016
2128
  /**
2017
2129
  * Paging and sort options for `institutional.getHolders`.
2018
2130
  *
@@ -2120,7 +2232,14 @@ interface HoldersHistoryQuarter {
2120
2232
  * no 13F coverage.
2121
2233
  */
2122
2234
  interface HoldersHistory {
2123
- /** The security answered for, in SentiSense's spelling (`BRK.B`, `GOOG`). */
2235
+ /**
2236
+ * The security answered for, per share class, in SentiSense's spelling (`BRK.B`, `GOOG`).
2237
+ * 13F filings report each share class under its own CUSIP, so `GOOG` is Alphabet's Class C
2238
+ * and `GOOGL` its Class A. It can differ from the ticker you requested: `BRKB` gives `BRK.B`,
2239
+ * and a recognized former ticker gives the company's current one. It is not the raw 13F key the
2240
+ * filings are recorded under. The histories of two share classes are separate and must not be added
2241
+ * together as the issuer's holders.
2242
+ */
2124
2243
  ticker: string;
2125
2244
  quarters: HoldersHistoryQuarter[];
2126
2245
  }
@@ -2598,6 +2717,19 @@ interface GetPoliticianMemberOptions {
2598
2717
  offset?: number;
2599
2718
  }
2600
2719
  /** Generic preview wrapper used by PRO-gated endpoints. */
2720
+ /** One calendar on `calendar.list()`. */
2721
+ interface CalendarListing {
2722
+ /** The calendar's type, e.g. `"earnings"`. */
2723
+ type: string;
2724
+ /** Its API path, e.g. `"/api/v1/calendar/earnings"`. */
2725
+ path: string;
2726
+ /** What the calendar holds, in one line. */
2727
+ description: string;
2728
+ }
2729
+ /** The calendars the API serves, returned by `calendar.list()`. */
2730
+ interface CalendarListResponse {
2731
+ calendars: CalendarListing[];
2732
+ }
2601
2733
  interface EarningsEvent {
2602
2734
  ticker: string;
2603
2735
  companyName: string;
@@ -3023,6 +3155,28 @@ interface UpgradeHint {
3023
3155
  */
3024
3156
  sampleTickers?: string[];
3025
3157
  }
3158
+ /**
3159
+ * A free key's monthly allowance of full options dossiers, as reported on the options summary
3160
+ * envelope by `stocks.getOptionsSummary()`.
3161
+ *
3162
+ * The allowance belongs to the account, so every key on it draws from one count, and another
3163
+ * request can spend it between two of your calls. Branch on `isPreview` for what a response
3164
+ * is; read this for how many full dossiers are left.
3165
+ */
3166
+ interface DossierAllowance {
3167
+ /** Full dossiers the account receives per calendar month. */
3168
+ limit: number;
3169
+ /**
3170
+ * Full dossiers left after this call, never negative: `0` on the last full dossier and on
3171
+ * every headline preview. A sample company's dossier leaves it unchanged.
3172
+ */
3173
+ remaining: number;
3174
+ /**
3175
+ * When the allowance next resets, as Unix epoch seconds: the start of the first day of next
3176
+ * month, Eastern time.
3177
+ */
3178
+ resetsAt: number;
3179
+ }
3026
3180
  interface PreviewResponse<T> {
3027
3181
  isPreview: boolean;
3028
3182
  previewReason: "PRO_REQUIRED" | null;
@@ -3048,6 +3202,15 @@ interface PreviewResponse<T> {
3048
3202
  * "ask `data` for the count", never "zero results".
3049
3203
  */
3050
3204
  totalCount?: number;
3205
+ /**
3206
+ * Sent, when available, only on options summary responses (`stocks.getOptionsSummary()`)
3207
+ * for a free key: how many full dossiers the account has left this calendar month, and when
3208
+ * that count resets. It can ride full dossiers, headline previews and sample-company
3209
+ * dossiers alike, but a dossier can also arrive without it, so treat it as optional on every
3210
+ * response. Absent on a PRO key, on a delisted ticker and on a summary with no snapshot
3211
+ * (`data: null`).
3212
+ */
3213
+ dossierAllowance?: DossierAllowance;
3051
3214
  data: T;
3052
3215
  }
3053
3216
  /** Supported metric types for the v2 Serving Metrics API. */
@@ -3150,6 +3313,17 @@ interface MetricDistribution {
3150
3313
  valueType?: "SHARE_PERCENT" | "MEAN";
3151
3314
  [key: string]: unknown;
3152
3315
  }
3316
+ /** One dimension a metric can be broken down by, as listed by `entityMetrics.getSlices()`. */
3317
+ interface MetricSlice {
3318
+ /** The metric the slice applies to. */
3319
+ metricType: string;
3320
+ /** Dimension key, e.g. `"source"`. */
3321
+ dimension: string;
3322
+ /** The dimension's values present in the data. */
3323
+ values: string[];
3324
+ /** Human-readable label for the dimension. */
3325
+ displayName: string;
3326
+ }
3153
3327
  interface MarketMood {
3154
3328
  [key: string]: unknown;
3155
3329
  }
@@ -3158,6 +3332,141 @@ interface MarketMoodOptions {
3158
3332
  /** Days of history to return. Omit to get the API's default of 180. */
3159
3333
  days?: number;
3160
3334
  }
3335
+ /** A stock named on a {@link SentimentSectorRow}. */
3336
+ interface SentimentStockRef {
3337
+ /** Member stock ticker. */
3338
+ ticker?: string;
3339
+ /** That stock's sentiment polarity, from -1 (bearish) to 1 (bullish). */
3340
+ value?: number;
3341
+ }
3342
+ /**
3343
+ * One GICS sector on `marketMood.getSentimentSectors()`, read against the market's own
3344
+ * news-and-social tone. Compare sectors on `consensusVsMarket`: financial news reads positive as
3345
+ * a genre, so `meanSentiment` is bullish for most sectors on most days.
3346
+ *
3347
+ * The API omits a field rather than sending `null`, so every field is optional.
3348
+ */
3349
+ interface SentimentSectorRow {
3350
+ /** GICS level-1 sector name, e.g. `"Information Technology"`. */
3351
+ sector?: string;
3352
+ /** Mean sentiment polarity across the sector's covered stocks, from -1 to 1. */
3353
+ meanSentiment?: number;
3354
+ /** Tone label for `meanSentiment`. */
3355
+ label?: "Bullish" | "Neutral" | "Bearish" | (string & {});
3356
+ /** Mean SentiSense Score across the sector's covered stocks: signed, conviction-weighted, with no fixed range. */
3357
+ meanScore?: number;
3358
+ /** Band label for `meanScore`. */
3359
+ scoreLabel?: string;
3360
+ /**
3361
+ * The sector's directional-consensus ratio over its stocks' summed bullish and bearish
3362
+ * mentions, between -1 and 1. A tone ratio on its own scale, not a SentiSense Score.
3363
+ */
3364
+ consensusRatio?: number;
3365
+ /**
3366
+ * `consensusRatio` minus the snapshot's `marketConsensusRatio`. Positive means the sector runs
3367
+ * hotter than the market over the same window; negative means cooler than the market, which
3368
+ * is not the same as bearish.
3369
+ */
3370
+ consensusVsMarket?: number;
3371
+ /** Band label for `consensusVsMarket`. */
3372
+ consensusLabel?: "Hotter than market" | "In line with market" | "Cooler than market" | (string & {});
3373
+ /** Summed bullish mentions of the sector's stocks over the window. */
3374
+ bullMentions?: number;
3375
+ /** Summed bearish mentions of the sector's stocks over the window. */
3376
+ bearMentions?: number;
3377
+ /** Member stocks that had a sentiment reading. */
3378
+ stockCount?: number;
3379
+ /** Summed mention volume across those stocks. */
3380
+ totalMentions?: number;
3381
+ /** The sector's most bullish member stock. */
3382
+ topStock?: SentimentStockRef;
3383
+ /** The sector's most bearish member stock. */
3384
+ bottomStock?: SentimentStockRef;
3385
+ }
3386
+ /**
3387
+ * The per-sector sentiment rollup returned by `marketMood.getSentimentSectors()`, a daily
3388
+ * precomputed snapshot. Before the first snapshot is built, `sectors` is empty and the other
3389
+ * fields are absent.
3390
+ */
3391
+ interface SentimentSectors {
3392
+ /** Snapshot schema version, e.g. `"1.0"`. */
3393
+ schemaVersion?: string;
3394
+ /** When the rollup was computed, epoch seconds. */
3395
+ generatedAt?: number;
3396
+ /** New York calendar day the snapshot represents, ISO `YYYY-MM-DD`. */
3397
+ asOf?: string;
3398
+ /** One-line summary: the most and least bullish sector, and the covered stock count. */
3399
+ narrative?: string;
3400
+ /**
3401
+ * The whole covered universe's directional-consensus ratio for the window, between -1 and 1:
3402
+ * the market reading each row's `consensusVsMarket` is measured against.
3403
+ */
3404
+ marketConsensusRatio?: number;
3405
+ /** One row per GICS sector. */
3406
+ sectors: SentimentSectorRow[];
3407
+ }
3408
+ /**
3409
+ * One day of sentiment breadth: how the covered stocks split between bullish, neutral and
3410
+ * bearish, each stock casting one vote by its mean sentiment.
3411
+ *
3412
+ * The `*Pct` fields count stocks; the `*MentionPct` fields weight the same votes by each stock's
3413
+ * mention volume. When the two disagree, a few heavily covered names are carrying the tone.
3414
+ * Shares are percentages from 0 to 100 (`51.5` means 51.5%). The API omits a field rather than
3415
+ * sending `null`, so every field is optional.
3416
+ */
3417
+ interface SentimentBreadthBucket {
3418
+ /** New York calendar day of this bucket, ISO `YYYY-MM-DD`. */
3419
+ date?: string;
3420
+ /** Stocks with a reading that cleared the snapshot's `minMentions`: the breadth denominator. */
3421
+ coveredStocks?: number;
3422
+ /** Summed mention volume across those stocks. */
3423
+ totalMentions?: number;
3424
+ /** Covered stocks classified bullish. */
3425
+ bullish?: number;
3426
+ /** Covered stocks classified neutral. */
3427
+ neutral?: number;
3428
+ /** Covered stocks classified bearish. */
3429
+ bearish?: number;
3430
+ /** Bullish share of covered stocks, in percent. */
3431
+ bullishPct?: number;
3432
+ /** Neutral share of covered stocks, in percent. */
3433
+ neutralPct?: number;
3434
+ /** Bearish share of covered stocks, in percent. */
3435
+ bearishPct?: number;
3436
+ /** `bullishPct` minus `bearishPct`, in percentage points, from -100 to 100. */
3437
+ netBreadth?: number;
3438
+ /** Bullish share of mentions rather than of stocks, in percent. */
3439
+ bullishMentionPct?: number;
3440
+ /** Neutral share of mentions, in percent. */
3441
+ neutralMentionPct?: number;
3442
+ /** Bearish share of mentions, in percent. */
3443
+ bearishMentionPct?: number;
3444
+ /**
3445
+ * Population standard deviation of the covered stocks' sentiment polarity (each from -1 to 1):
3446
+ * high when stocks disagree with each other, low when they share one mood. Absent when fewer
3447
+ * than two stocks are covered.
3448
+ */
3449
+ sentimentDispersion?: number;
3450
+ }
3451
+ /**
3452
+ * Market-wide sentiment breadth returned by `marketMood.getSentimentBreadth()`, a daily
3453
+ * precomputed snapshot. Before the first snapshot is built, `series` is empty and the other
3454
+ * fields are absent.
3455
+ */
3456
+ interface SentimentBreadth {
3457
+ /** Snapshot schema version, e.g. `"1.0"`. */
3458
+ schemaVersion?: string;
3459
+ /** When the rollup was computed, epoch seconds. */
3460
+ generatedAt?: number;
3461
+ /** New York calendar day the snapshot represents, ISO `YYYY-MM-DD`. */
3462
+ asOf?: string;
3463
+ /** Minimum mention volume for a stock to count toward breadth. */
3464
+ minMentions?: number;
3465
+ /** The newest entry of `series`, also served on its own here. */
3466
+ latest?: SentimentBreadthBucket;
3467
+ /** Daily buckets, oldest to newest. */
3468
+ series: SentimentBreadthBucket[];
3469
+ }
3161
3470
  /** AI-generated market summary with headline and analysis. */
3162
3471
  interface MarketSummary {
3163
3472
  /** Not populated by the API (always empty); retained for backward compatibility. */
@@ -4470,6 +4779,14 @@ declare class Analyst {
4470
4779
  declare class Calendar {
4471
4780
  private client;
4472
4781
  constructor(client: APIClient);
4782
+ /**
4783
+ * List the calendars the API serves, with the path of each, so a client can find them
4784
+ * without hardcoding paths.
4785
+ *
4786
+ * Every tier receives the same list, and the call does not count against the monthly quota;
4787
+ * the per-minute rate limit still applies.
4788
+ */
4789
+ list(): Promise<CalendarListResponse>;
4473
4790
  /**
4474
4791
  * Upcoming company earnings, sorted by date.
4475
4792
  *
@@ -4642,6 +4959,19 @@ declare class EntityMetrics {
4642
4959
  * epoch milliseconds. Without a window the API uses the last 7 days.
4643
4960
  */
4644
4961
  getDistribution(symbol: string, metricType: MetricType, options?: MetricDistributionOptions): Promise<MetricDistribution>;
4962
+ /**
4963
+ * List the dimensions a metric can be broken down by for one entity, with the values present
4964
+ * in the data, so you can see what exists before calling `getDistribution()`.
4965
+ *
4966
+ * Returns a plain array, empty when the metric has no slices for this entity. Available on
4967
+ * every tier; each call counts against the monthly quota.
4968
+ *
4969
+ * @param symbol Ticker symbol (e.g. "AAPL") or entity urlSlug (e.g. "Nancy-Pelosi").
4970
+ * @param metricType The metric to look up (e.g. "mentions").
4971
+ * @throws {SentiSenseError} Before any request, when `symbol` or `metricType` is empty,
4972
+ * whitespace only, `"."` or `".."`.
4973
+ */
4974
+ getSlices(symbol: string, metricType: MetricType): Promise<MetricSlice[]>;
4645
4975
  }
4646
4976
 
4647
4977
  interface EtfInfo {
@@ -5124,6 +5454,31 @@ declare class Institutional {
5124
5454
  * Returns the preview envelope, so read the rows as `.data`.
5125
5455
  */
5126
5456
  getActivists(reportDate: string): Promise<PreviewResponse<Holder[]>>;
5457
+ /**
5458
+ * Get convertible bond positions from 13F filings for one quarter, one row per issuer,
5459
+ * grouped by the issuer's equity ticker.
5460
+ *
5461
+ * `reportDate` is the quarter end as an ISO date (e.g. `"2026-06-30"`); the API requires it,
5462
+ * so take one from `getQuarters()`. Returns the preview envelope, so the rows are `.data`. A
5463
+ * FREE key receives the top three rows with `isPreview: true` and `totalCount` holding the full
5464
+ * row count; a PRO key receives the full list.
5465
+ *
5466
+ * Each row's `bondTickers` is one comma-separated string, not an array.
5467
+ */
5468
+ getBondFlows(reportDate: string): Promise<PreviewResponse<InstitutionalBondFlow[]>>;
5469
+ /**
5470
+ * Get the call and put positions institutions reported on Form 13F for one quarter, one row
5471
+ * per stock.
5472
+ *
5473
+ * These are quarter-end 13F holdings, not options market activity: for options volume, open
5474
+ * interest and implied volatility, use `client.options` and `stocks.getOptionsSummary()`.
5475
+ *
5476
+ * `reportDate` is the quarter end as an ISO date (e.g. `"2026-06-30"`); the API requires it,
5477
+ * so take one from `getQuarters()`. Returns the preview envelope, so the rows are `.data`. A
5478
+ * FREE key receives the top three rows with `isPreview: true` and `totalCount` holding the full
5479
+ * row count; a PRO key receives the full list.
5480
+ */
5481
+ getOptionFlows(reportDate: string): Promise<PreviewResponse<InstitutionalOptionFlow[]>>;
5127
5482
  /**
5128
5483
  * Discover institutions: a paginated, AUM-ranked list of filers (slug + metadata)
5129
5484
  * so you can find what to query without knowing slugs upfront.
@@ -5253,6 +5608,33 @@ declare class MarketMoodResource {
5253
5608
  */
5254
5609
  get(options?: MarketMoodOptions): Promise<MarketMood>;
5255
5610
  get(): Promise<MarketMood>;
5611
+ /**
5612
+ * Get the per-sector sentiment rollup: the 11 GICS sectors, each measured against the
5613
+ * market's own news-and-social tone.
5614
+ *
5615
+ * Compare sectors on `consensusVsMarket`, the gap between a sector's bullish-versus-bearish
5616
+ * mention balance and the market's. Available on every tier with the same response; each
5617
+ * call counts against the monthly quota. It is a daily precomputed snapshot, so `generatedAt`
5618
+ * (epoch seconds) is its freshness.
5619
+ *
5620
+ * @example
5621
+ * const { sectors } = await client.marketMood.getSentimentSectors();
5622
+ * for (const s of sectors) console.log(s.sector, s.consensusVsMarket, s.consensusLabel);
5623
+ */
5624
+ getSentimentSectors(): Promise<SentimentSectors>;
5625
+ /**
5626
+ * Get market-wide sentiment breadth: each day's share of the covered US stocks leaning
5627
+ * bullish, neutral or bearish, the tone analogue of an advance/decline line.
5628
+ *
5629
+ * `series` runs oldest to newest, and `latest` is the newest entry of `series`. Available on
5630
+ * every tier with the same response; each call counts against the monthly quota. It is a daily
5631
+ * precomputed snapshot, so `generatedAt` (epoch seconds) is its freshness.
5632
+ *
5633
+ * @example
5634
+ * const breadth = await client.marketMood.getSentimentBreadth();
5635
+ * console.log(breadth.latest?.date, breadth.latest?.netBreadth);
5636
+ */
5637
+ getSentimentBreadth(): Promise<SentimentBreadth>;
5256
5638
  }
5257
5639
 
5258
5640
  declare class MarketSummaryResource {
@@ -5288,9 +5670,10 @@ declare class Options {
5288
5670
  * `data` is `null` before the first nightly build populates it, which is a cold-start
5289
5671
  * state rather than an error.
5290
5672
  *
5291
- * Tiering: a PRO key receives every row. A FREE key receives the top 25 stock rows plus
5292
- * all the aggregates, with `isPreview` true and the envelope's `totalCount` reporting the
5293
- * full stock board; `data.etfTotalCount` does the same for the ETF board.
5673
+ * Tiering: a PRO key receives every row. A FREE key receives the top 25 rows of each board
5674
+ * and the top 3 session highlights of each board, plus every aggregate for both boards, with
5675
+ * `isPreview` true and the envelope's `totalCount` reporting the full stock board;
5676
+ * `data.etfTotalCount` does the same for the ETF board.
5294
5677
  *
5295
5678
  * Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
5296
5679
  * or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
@@ -5588,7 +5971,9 @@ declare class Stocks {
5588
5971
  * ten calls each calendar month and a headline-only preview after that, with `isPreview`
5589
5972
  * true; calls that return a null `data` never spend that allowance. The headline preview has
5590
5973
  * no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
5591
- * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
5974
+ * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`. On a FREE key
5975
+ * the envelope's `dossierAllowance`, when available, says how many full dossiers are left
5976
+ * this calendar month and when the count resets.
5592
5977
  */
5593
5978
  getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
5594
5979
  /**
@@ -5625,8 +6010,10 @@ declare class Stocks {
5625
6010
  *
5626
6011
  * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
5627
6012
  * before the history was kept, a ticker outside the board and an unknown symbol all answer
5628
- * with `data.series` empty. `data.missingCycles` lists cycles whose stored point could not be
5629
- * read, which are unknown rather than absent. A malformed or future `session` rejects with
6013
+ * with `data.series` empty. `data.missingCycles` lists cycles with no stored history (a cycle
6014
+ * that published no board, or one whose history was lost), where the ticker's numbers are
6015
+ * unknown rather than zero. `data.cycles` counts the session's stored cycles, so `series` can
6016
+ * be shorter. A malformed or future `session` rejects with
5630
6017
  * an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
5631
6018
  * not be read; it is retried like any other 503 and never answered with a partial series.
5632
6019
  */
@@ -5920,6 +6307,6 @@ declare class APIError extends SentiSenseError {
5920
6307
  constructor(message: string, status: number, code?: string, body?: ErrorBody);
5921
6308
  }
5922
6309
 
5923
- declare const VERSION = "0.80.0";
6310
+ declare const VERSION = "0.82.0";
5924
6311
 
5925
- export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type ErrorBody, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfMembership, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsHistory, type FundamentalsLineSource, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCalledItOptions, type GetAnalystCallsOptions, type GetAnalystConsensusHistoryOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsStatisticsOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetFundamentalsHistoryOptions, type GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetInstitutionDetailOptions, type GetInstitutionHistoryOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockEtfsOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionChangeFilter, type InstitutionChangeType, type InstitutionDetail, type InstitutionHistory, type InstitutionHistoryQuarter, type InstitutionHolding, type InstitutionList, type InstitutionListResponse, type InstitutionMatchTotals, type InstitutionPositionPoint, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerFilter, type TrackerGeoEntry, type TrackerGetParams, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
6312
+ export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarListResponse, type CalendarListing, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type DossierAllowance, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type ErrorBody, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfMembership, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsHistory, type FundamentalsLineSource, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCalledItOptions, type GetAnalystCallsOptions, type GetAnalystConsensusHistoryOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsStatisticsOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetFundamentalsHistoryOptions, type GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetInstitutionDetailOptions, type GetInstitutionHistoryOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockEtfsOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionChangeFilter, type InstitutionChangeType, type InstitutionDetail, type InstitutionHistory, type InstitutionHistoryQuarter, type InstitutionHolding, type InstitutionList, type InstitutionListResponse, type InstitutionMatchTotals, type InstitutionPositionPoint, type InstitutionSummary, type InstitutionalBondFlow, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type InstitutionalOptionFlow, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricSlice, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentBreadth, type SentimentBreadthBucket, type SentimentEntry, type SentimentSectorRow, type SentimentSectors, type SentimentStockRef, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerFilter, type TrackerGeoEntry, type TrackerGetParams, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };