sentisense 0.79.0 → 0.81.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/README.md +1 -1
- package/dist/cli.cjs +467 -124
- package/dist/index.cjs +12 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +130 -25
- package/dist/index.d.ts +130 -25
- package/dist/index.mjs +12 -7
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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%),
|
|
1180
|
-
* end-of-day `atmIv
|
|
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 `
|
|
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
|
-
/**
|
|
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
|
|
1213
|
-
*
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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[];
|
|
@@ -2605,6 +2659,21 @@ interface EarningsEvent {
|
|
|
2605
2659
|
earningsDate: string;
|
|
2606
2660
|
/** Session timing. */
|
|
2607
2661
|
earningsTime: "before_open" | "after_close" | "during_market" | "unknown";
|
|
2662
|
+
/**
|
|
2663
|
+
* Start of the earnings conference call as the company's own announcement states it: an ISO 8601
|
|
2664
|
+
* date-time with the UTC offset, e.g. "2026-11-19T10:00:00-05:00". It is an ISO string, not epoch
|
|
2665
|
+
* seconds (an exception to the usual timestamp convention). It can fall on the day after
|
|
2666
|
+
* `earningsDate` (a release after the close, a call the next morning). Null when the row is not
|
|
2667
|
+
* confirmed, the announcement gives no time, or the company holds no call. Never derived from
|
|
2668
|
+
* `earningsTime`.
|
|
2669
|
+
*/
|
|
2670
|
+
callTime?: string | null;
|
|
2671
|
+
/**
|
|
2672
|
+
* The https link the company's announcement gives for the call's webcast; null when it gives
|
|
2673
|
+
* none. Some links need a free registration, and some go live only shortly before the call.
|
|
2674
|
+
* Filled only on confirmed rows.
|
|
2675
|
+
*/
|
|
2676
|
+
webcastUrl?: string | null;
|
|
2608
2677
|
/** Fiscal period label (e.g. "Q2 2026"), nullable. */
|
|
2609
2678
|
fiscalQuarter: string | null;
|
|
2610
2679
|
/** Whether the company has confirmed the date (vs. estimated/projected). */
|
|
@@ -3008,6 +3077,28 @@ interface UpgradeHint {
|
|
|
3008
3077
|
*/
|
|
3009
3078
|
sampleTickers?: string[];
|
|
3010
3079
|
}
|
|
3080
|
+
/**
|
|
3081
|
+
* A free key's monthly allowance of full options dossiers, as reported on the options summary
|
|
3082
|
+
* envelope by `stocks.getOptionsSummary()`.
|
|
3083
|
+
*
|
|
3084
|
+
* The allowance belongs to the account, so every key on it draws from one count, and another
|
|
3085
|
+
* request can spend it between two of your calls. Branch on `isPreview` for what a response
|
|
3086
|
+
* is; read this for how many full dossiers are left.
|
|
3087
|
+
*/
|
|
3088
|
+
interface DossierAllowance {
|
|
3089
|
+
/** Full dossiers the account receives per calendar month. */
|
|
3090
|
+
limit: number;
|
|
3091
|
+
/**
|
|
3092
|
+
* Full dossiers left after this call, never negative: `0` on the last full dossier and on
|
|
3093
|
+
* every headline preview. A sample company's dossier leaves it unchanged.
|
|
3094
|
+
*/
|
|
3095
|
+
remaining: number;
|
|
3096
|
+
/**
|
|
3097
|
+
* When the allowance next resets, as Unix epoch seconds: the start of the first day of next
|
|
3098
|
+
* month, Eastern time.
|
|
3099
|
+
*/
|
|
3100
|
+
resetsAt: number;
|
|
3101
|
+
}
|
|
3011
3102
|
interface PreviewResponse<T> {
|
|
3012
3103
|
isPreview: boolean;
|
|
3013
3104
|
previewReason: "PRO_REQUIRED" | null;
|
|
@@ -3033,6 +3124,15 @@ interface PreviewResponse<T> {
|
|
|
3033
3124
|
* "ask `data` for the count", never "zero results".
|
|
3034
3125
|
*/
|
|
3035
3126
|
totalCount?: number;
|
|
3127
|
+
/**
|
|
3128
|
+
* Sent, when available, only on options summary responses (`stocks.getOptionsSummary()`)
|
|
3129
|
+
* for a free key: how many full dossiers the account has left this calendar month, and when
|
|
3130
|
+
* that count resets. It can ride full dossiers, headline previews and sample-company
|
|
3131
|
+
* dossiers alike, but a dossier can also arrive without it, so treat it as optional on every
|
|
3132
|
+
* response. Absent on a PRO key, on a delisted ticker and on a summary with no snapshot
|
|
3133
|
+
* (`data: null`).
|
|
3134
|
+
*/
|
|
3135
|
+
dossierAllowance?: DossierAllowance;
|
|
3036
3136
|
data: T;
|
|
3037
3137
|
}
|
|
3038
3138
|
/** Supported metric types for the v2 Serving Metrics API. */
|
|
@@ -5273,9 +5373,10 @@ declare class Options {
|
|
|
5273
5373
|
* `data` is `null` before the first nightly build populates it, which is a cold-start
|
|
5274
5374
|
* state rather than an error.
|
|
5275
5375
|
*
|
|
5276
|
-
* Tiering: a PRO key receives every row. A FREE key receives the top 25
|
|
5277
|
-
*
|
|
5278
|
-
*
|
|
5376
|
+
* Tiering: a PRO key receives every row. A FREE key receives the top 25 rows of each board
|
|
5377
|
+
* and the top 3 session highlights of each board, plus every aggregate for both boards, with
|
|
5378
|
+
* `isPreview` true and the envelope's `totalCount` reporting the full stock board;
|
|
5379
|
+
* `data.etfTotalCount` does the same for the ETF board.
|
|
5279
5380
|
*
|
|
5280
5381
|
* Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
|
|
5281
5382
|
* or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
|
|
@@ -5573,7 +5674,9 @@ declare class Stocks {
|
|
|
5573
5674
|
* ten calls each calendar month and a headline-only preview after that, with `isPreview`
|
|
5574
5675
|
* true; calls that return a null `data` never spend that allowance. The headline preview has
|
|
5575
5676
|
* no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
|
|
5576
|
-
* `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
|
|
5677
|
+
* `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`. On a FREE key
|
|
5678
|
+
* the envelope's `dossierAllowance`, when available, says how many full dossiers are left
|
|
5679
|
+
* this calendar month and when the count resets.
|
|
5577
5680
|
*/
|
|
5578
5681
|
getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
|
|
5579
5682
|
/**
|
|
@@ -5610,8 +5713,10 @@ declare class Stocks {
|
|
|
5610
5713
|
*
|
|
5611
5714
|
* **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
|
|
5612
5715
|
* before the history was kept, a ticker outside the board and an unknown symbol all answer
|
|
5613
|
-
* with `data.series` empty. `data.missingCycles` lists cycles
|
|
5614
|
-
*
|
|
5716
|
+
* with `data.series` empty. `data.missingCycles` lists cycles with no stored history (a cycle
|
|
5717
|
+
* that published no board, or one whose history was lost), where the ticker's numbers are
|
|
5718
|
+
* unknown rather than zero. `data.cycles` counts the session's stored cycles, so `series` can
|
|
5719
|
+
* be shorter. A malformed or future `session` rejects with
|
|
5615
5720
|
* an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
|
|
5616
5721
|
* not be read; it is retried like any other 503 and never answered with a partial series.
|
|
5617
5722
|
*/
|
|
@@ -5905,6 +6010,6 @@ declare class APIError extends SentiSenseError {
|
|
|
5905
6010
|
constructor(message: string, status: number, code?: string, body?: ErrorBody);
|
|
5906
6011
|
}
|
|
5907
6012
|
|
|
5908
|
-
declare const VERSION = "0.
|
|
6013
|
+
declare const VERSION = "0.81.0";
|
|
5909
6014
|
|
|
5910
|
-
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 };
|
|
6015
|
+
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 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 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 };
|
package/dist/index.d.ts
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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%),
|
|
1180
|
-
* end-of-day `atmIv
|
|
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 `
|
|
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
|
-
/**
|
|
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
|
|
1213
|
-
*
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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[];
|
|
@@ -2605,6 +2659,21 @@ interface EarningsEvent {
|
|
|
2605
2659
|
earningsDate: string;
|
|
2606
2660
|
/** Session timing. */
|
|
2607
2661
|
earningsTime: "before_open" | "after_close" | "during_market" | "unknown";
|
|
2662
|
+
/**
|
|
2663
|
+
* Start of the earnings conference call as the company's own announcement states it: an ISO 8601
|
|
2664
|
+
* date-time with the UTC offset, e.g. "2026-11-19T10:00:00-05:00". It is an ISO string, not epoch
|
|
2665
|
+
* seconds (an exception to the usual timestamp convention). It can fall on the day after
|
|
2666
|
+
* `earningsDate` (a release after the close, a call the next morning). Null when the row is not
|
|
2667
|
+
* confirmed, the announcement gives no time, or the company holds no call. Never derived from
|
|
2668
|
+
* `earningsTime`.
|
|
2669
|
+
*/
|
|
2670
|
+
callTime?: string | null;
|
|
2671
|
+
/**
|
|
2672
|
+
* The https link the company's announcement gives for the call's webcast; null when it gives
|
|
2673
|
+
* none. Some links need a free registration, and some go live only shortly before the call.
|
|
2674
|
+
* Filled only on confirmed rows.
|
|
2675
|
+
*/
|
|
2676
|
+
webcastUrl?: string | null;
|
|
2608
2677
|
/** Fiscal period label (e.g. "Q2 2026"), nullable. */
|
|
2609
2678
|
fiscalQuarter: string | null;
|
|
2610
2679
|
/** Whether the company has confirmed the date (vs. estimated/projected). */
|
|
@@ -3008,6 +3077,28 @@ interface UpgradeHint {
|
|
|
3008
3077
|
*/
|
|
3009
3078
|
sampleTickers?: string[];
|
|
3010
3079
|
}
|
|
3080
|
+
/**
|
|
3081
|
+
* A free key's monthly allowance of full options dossiers, as reported on the options summary
|
|
3082
|
+
* envelope by `stocks.getOptionsSummary()`.
|
|
3083
|
+
*
|
|
3084
|
+
* The allowance belongs to the account, so every key on it draws from one count, and another
|
|
3085
|
+
* request can spend it between two of your calls. Branch on `isPreview` for what a response
|
|
3086
|
+
* is; read this for how many full dossiers are left.
|
|
3087
|
+
*/
|
|
3088
|
+
interface DossierAllowance {
|
|
3089
|
+
/** Full dossiers the account receives per calendar month. */
|
|
3090
|
+
limit: number;
|
|
3091
|
+
/**
|
|
3092
|
+
* Full dossiers left after this call, never negative: `0` on the last full dossier and on
|
|
3093
|
+
* every headline preview. A sample company's dossier leaves it unchanged.
|
|
3094
|
+
*/
|
|
3095
|
+
remaining: number;
|
|
3096
|
+
/**
|
|
3097
|
+
* When the allowance next resets, as Unix epoch seconds: the start of the first day of next
|
|
3098
|
+
* month, Eastern time.
|
|
3099
|
+
*/
|
|
3100
|
+
resetsAt: number;
|
|
3101
|
+
}
|
|
3011
3102
|
interface PreviewResponse<T> {
|
|
3012
3103
|
isPreview: boolean;
|
|
3013
3104
|
previewReason: "PRO_REQUIRED" | null;
|
|
@@ -3033,6 +3124,15 @@ interface PreviewResponse<T> {
|
|
|
3033
3124
|
* "ask `data` for the count", never "zero results".
|
|
3034
3125
|
*/
|
|
3035
3126
|
totalCount?: number;
|
|
3127
|
+
/**
|
|
3128
|
+
* Sent, when available, only on options summary responses (`stocks.getOptionsSummary()`)
|
|
3129
|
+
* for a free key: how many full dossiers the account has left this calendar month, and when
|
|
3130
|
+
* that count resets. It can ride full dossiers, headline previews and sample-company
|
|
3131
|
+
* dossiers alike, but a dossier can also arrive without it, so treat it as optional on every
|
|
3132
|
+
* response. Absent on a PRO key, on a delisted ticker and on a summary with no snapshot
|
|
3133
|
+
* (`data: null`).
|
|
3134
|
+
*/
|
|
3135
|
+
dossierAllowance?: DossierAllowance;
|
|
3036
3136
|
data: T;
|
|
3037
3137
|
}
|
|
3038
3138
|
/** Supported metric types for the v2 Serving Metrics API. */
|
|
@@ -5273,9 +5373,10 @@ declare class Options {
|
|
|
5273
5373
|
* `data` is `null` before the first nightly build populates it, which is a cold-start
|
|
5274
5374
|
* state rather than an error.
|
|
5275
5375
|
*
|
|
5276
|
-
* Tiering: a PRO key receives every row. A FREE key receives the top 25
|
|
5277
|
-
*
|
|
5278
|
-
*
|
|
5376
|
+
* Tiering: a PRO key receives every row. A FREE key receives the top 25 rows of each board
|
|
5377
|
+
* and the top 3 session highlights of each board, plus every aggregate for both boards, with
|
|
5378
|
+
* `isPreview` true and the envelope's `totalCount` reporting the full stock board;
|
|
5379
|
+
* `data.etfTotalCount` does the same for the ETF board.
|
|
5279
5380
|
*
|
|
5280
5381
|
* Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
|
|
5281
5382
|
* or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
|
|
@@ -5573,7 +5674,9 @@ declare class Stocks {
|
|
|
5573
5674
|
* ten calls each calendar month and a headline-only preview after that, with `isPreview`
|
|
5574
5675
|
* true; calls that return a null `data` never spend that allowance. The headline preview has
|
|
5575
5676
|
* no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
|
|
5576
|
-
* `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
|
|
5677
|
+
* `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`. On a FREE key
|
|
5678
|
+
* the envelope's `dossierAllowance`, when available, says how many full dossiers are left
|
|
5679
|
+
* this calendar month and when the count resets.
|
|
5577
5680
|
*/
|
|
5578
5681
|
getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
|
|
5579
5682
|
/**
|
|
@@ -5610,8 +5713,10 @@ declare class Stocks {
|
|
|
5610
5713
|
*
|
|
5611
5714
|
* **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
|
|
5612
5715
|
* before the history was kept, a ticker outside the board and an unknown symbol all answer
|
|
5613
|
-
* with `data.series` empty. `data.missingCycles` lists cycles
|
|
5614
|
-
*
|
|
5716
|
+
* with `data.series` empty. `data.missingCycles` lists cycles with no stored history (a cycle
|
|
5717
|
+
* that published no board, or one whose history was lost), where the ticker's numbers are
|
|
5718
|
+
* unknown rather than zero. `data.cycles` counts the session's stored cycles, so `series` can
|
|
5719
|
+
* be shorter. A malformed or future `session` rejects with
|
|
5615
5720
|
* an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
|
|
5616
5721
|
* not be read; it is retried like any other 503 and never answered with a partial series.
|
|
5617
5722
|
*/
|
|
@@ -5905,6 +6010,6 @@ declare class APIError extends SentiSenseError {
|
|
|
5905
6010
|
constructor(message: string, status: number, code?: string, body?: ErrorBody);
|
|
5906
6011
|
}
|
|
5907
6012
|
|
|
5908
|
-
declare const VERSION = "0.
|
|
6013
|
+
declare const VERSION = "0.81.0";
|
|
5909
6014
|
|
|
5910
|
-
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 };
|
|
6015
|
+
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 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 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 };
|