sentisense 0.63.1 → 0.65.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
@@ -884,6 +884,12 @@ interface OptionsCapabilities {
884
884
  * `largePrintCount`, `largestPrintPctl`, `capabilities`), which are the same on every tier,
885
885
  * previews included, and are omitted when their source is absent: `intradayFlow` before the
886
886
  * day's first board or when the ticker has no row on it.
887
+ *
888
+ * A FREE key that has spent its monthly dossier allowance receives the headline preview
889
+ * instead (`isPreview` true): `asOf`, `sentiment` and six flat readings, `ivRank1y`, `atmIv`,
890
+ * `expectedMove1d`, `pcVol`, `pcVolPctl1y` and `maxPain`, with no `latest`, `context`,
891
+ * `oiWalls` or `unusual`. On a full dossier the six flat fields are absent and the same
892
+ * readings live in the nested objects.
887
893
  */
888
894
  interface OptionsSummary {
889
895
  /** Session the dossier describes, ISO calendar day. */
@@ -920,6 +926,18 @@ interface OptionsSummary {
920
926
  listingStatus?: "DELISTED";
921
927
  /** ISO day (YYYY-MM-DD) trading stopped; absent when the date is unknown. */
922
928
  delistedDate?: string;
929
+ /** Headline preview only: `context.ivRank1y` on a full dossier. */
930
+ ivRank1y?: number;
931
+ /** Headline preview only: `latest.atmIv` on a full dossier. */
932
+ atmIv?: number;
933
+ /** Headline preview only: `latest.expectedMove1d` on a full dossier. */
934
+ expectedMove1d?: number;
935
+ /** Headline preview only: `latest.pcVol` on a full dossier. */
936
+ pcVol?: number;
937
+ /** Headline preview only: `context.pcVolPctl1y` on a full dossier. */
938
+ pcVolPctl1y?: number;
939
+ /** Headline preview only: `oiWalls.maxPain` on a full dossier. */
940
+ maxPain?: number;
923
941
  }
924
942
  /** Trailing window for `client.stocks.getOptionsHistory()`. */
925
943
  type OptionsHistoryWindow = "1y" | "2y" | "5y";
@@ -954,6 +972,87 @@ interface OptionsHistory {
954
972
  /** Ascending by date, oldest first. Same shape as the dossier's `latest` aggregate. */
955
973
  series?: OptionsAggregate[];
956
974
  }
975
+ interface GetOptionsIntradayHistoryOptions {
976
+ /**
977
+ * Trading session date, `"YYYY-MM-DD"` (Eastern). Omitted, the server serves the session
978
+ * the intraday board ran most recently: today's once the first cycle lands at 09:45 ET, the
979
+ * previous session before that. Read `OptionsIntradayHistory.session` for the date served.
980
+ * A malformed or future date is rejected with HTTP 400, code `invalid_session`.
981
+ */
982
+ session?: string;
983
+ }
984
+ /**
985
+ * One ticker's numbers at one cycle of the intraday options board: counts, a ratio, a
986
+ * percentile and a ticker-level implied volatility, as the board showed them at `asOf`. It
987
+ * carries no contract symbol, strike, price, premium, open interest or print size. Readings
988
+ * the server cannot compute are omitted, never zero-filled.
989
+ */
990
+ interface OptionsIntradayPoint {
991
+ /** The board's cycle number within the session, starting at 1. */
992
+ cycle: number;
993
+ /** The cycle's snapshot time, Unix epoch seconds. */
994
+ asOf: number;
995
+ /** The same moment as `"HH:mm ET"`. */
996
+ asOfEt: string;
997
+ /** Calls traded so far this session, across the chain. */
998
+ callVol: number;
999
+ /** Puts traded so far this session. */
1000
+ putVol: number;
1001
+ /** `putVol / callVol`. Absent when `callVol` is 0. */
1002
+ pcVol?: number;
1003
+ /**
1004
+ * Contracts passing the unusual rule so far this session, up to 5: the same count as
1005
+ * `intradayFlow.unusualCount` on the dossier.
1006
+ */
1007
+ unusualCount: number;
1008
+ /**
1009
+ * Percentile (0-100) of the ticker's largest qualifying unusual contract so far this
1010
+ * session (same-day expiries excluded) against its own trailing year. Absent when nothing
1011
+ * qualifies, and while that history holds fewer than 60 sessions.
1012
+ */
1013
+ maxPremiumPctl1y?: number;
1014
+ /**
1015
+ * At-the-money implied volatility as a fraction (`0.42` is 42%), by the same rule as the
1016
+ * end-of-day `atmIv`. Absent when that expiry has no usable contract.
1017
+ */
1018
+ atmIv?: number;
1019
+ }
1020
+ /**
1021
+ * One ticker's intraday options series for one session, from
1022
+ * `client.stocks.getOptionsIntradayHistory()`, oldest cycle first.
1023
+ *
1024
+ * The board is rebuilt every 15 minutes from 15-minute delayed chains, from 09:45 to 16:15 ET,
1025
+ * so a full session holds 27 cycles. A ticker appears only on the cycles where it was on the
1026
+ * board, so `cycles` can be below that and the gaps show in each point's `cycle` and `asOf`.
1027
+ *
1028
+ * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
1029
+ * before the history was kept, a ticker outside the board and an unknown symbol all answer
1030
+ * with this object and nothing in `series`. The payload is `null` only on a FREE key's
1031
+ * `PRO_REQUIRED` preview.
1032
+ */
1033
+ interface OptionsIntradayHistory {
1034
+ /** Canonical ticker. */
1035
+ ticker: string;
1036
+ /** The trading session served, ISO date (Eastern). */
1037
+ session: string;
1038
+ /**
1039
+ * `true` while that session's board is still updating (today, before the close); `false`
1040
+ * for a completed or past session.
1041
+ */
1042
+ live: boolean;
1043
+ /** How far the chain data behind each point trails the market, in minutes. */
1044
+ delayMinutes: number;
1045
+ /** Number of points in `series`. */
1046
+ cycles: number;
1047
+ /**
1048
+ * Cycles of the session whose board was published but whose stored point could not be
1049
+ * found, ascending: this ticker's numbers at those cycles are unknown, not absent. Omitted
1050
+ * when there are none.
1051
+ */
1052
+ missingCycles?: number[];
1053
+ /** One point per cycle that carried this ticker, oldest first. */
1054
+ series: OptionsIntradayPoint[];
1055
+ }
957
1056
  /**
958
1057
  * One ticker's row on the market-wide options radar, from `client.options.getOverview()`.
959
1058
  *
@@ -1068,8 +1167,8 @@ interface OptionsHighlight {
1068
1167
  *
1069
1168
  * End of day, not live: `asOf` is the latest completed session. The exception is
1070
1169
  * `intradayActiveCount`, `intradayRanking` and `capabilities`, which summarize today's
1071
- * intraday board across stocks, are the same on every tier, and are omitted before the day's
1072
- * first board.
1170
+ * intraday board across stocks, are dated by `intradayAsOf` (epoch seconds) and
1171
+ * `intradayAsOfEt`, are the same on every tier, and are omitted before the day's first board.
1073
1172
  */
1074
1173
  interface OptionsOverview {
1075
1174
  /** Session the build describes, ISO calendar day. */
@@ -1113,6 +1212,13 @@ interface OptionsOverview {
1113
1212
  intradayActiveCount?: number;
1114
1213
  /** Up to 25 of those tickers, most unusual for their own history first. */
1115
1214
  intradayRanking?: string[];
1215
+ /**
1216
+ * Snapshot time of the intraday board `intradayActiveCount` and `intradayRanking` were read
1217
+ * from, Unix epoch seconds. Omitted with them.
1218
+ */
1219
+ intradayAsOf?: number;
1220
+ /** The same moment as `"HH:mm ET"`. Omitted with them. */
1221
+ intradayAsOfEt?: string;
1116
1222
  /** Where the intraday board lives and who can open it. */
1117
1223
  capabilities?: OptionsCapabilities;
1118
1224
  }
@@ -2972,8 +3078,49 @@ interface ScreenerRow {
2972
3078
  sentisenseScoreBars30D: number[] | null;
2973
3079
  /** Daily closes for the last 30 days, oldest first. */
2974
3080
  priceSparkline30D: number[] | null;
2975
- /** Epoch seconds. */
3081
+ /** Epoch seconds: when the row's snapshot was built. For the price's age read `priceAsOf`. */
2976
3082
  lastUpdated: number | null;
3083
+ /**
3084
+ * When the market data behind `currentPrice`, `change` and `changePercent` is from, epoch
3085
+ * **milliseconds**: the same field and unit as `priceAsOf` on the quote endpoints. `null`
3086
+ * outside regular hours, on a previous-close fallback, and when no quote was available, so
3087
+ * read `null` as unknown rather than fresh. Absent on responses from before the field
3088
+ * shipped.
3089
+ */
3090
+ priceAsOf?: number | null;
3091
+ /** SentiSense Rating letter, `"A"` to `"F"`. `null` for an unrated stock. */
3092
+ ratingLetter?: string | null;
3093
+ /** The graded 0-100 Rating score a Rating sort orders by. `null` when unrated. */
3094
+ ratingScore?: number | null;
3095
+ /** The 0-100 rank among the stocks rated that day, before risk adjustments. `null` when unrated. */
3096
+ ratingPercentile?: number | null;
3097
+ /**
3098
+ * IV rank, 0-100: where implied volatility sits in its own trailing one-year range. End of
3099
+ * day, from the nightly options board; `optionsAsOf` says which session. `null` when the
3100
+ * stock has no reading; absent on responses from before the field shipped.
3101
+ */
3102
+ ivRank1y?: number | null;
3103
+ /** Put volume divided by call volume in that session. End of day. */
3104
+ pcVol?: number | null;
3105
+ /** Percentile, 0-100, of `pcVol` against the stock's own trailing year. End of day. */
3106
+ pcVolPctl1y?: number | null;
3107
+ /** Percentile, 0-100, of the 25-delta skew against the stock's own trailing year. End of day. */
3108
+ skew25dPctl1y?: number | null;
3109
+ /** Composite 0-100 options interest score; `null` when unscored. End of day. */
3110
+ optionsInterestScore?: number | null;
3111
+ /** Dollar premium of the session's largest unusual contract; `null` when there was none. End of day. */
3112
+ maxUnusualPremium?: number | null;
3113
+ /**
3114
+ * Options-implied 90% expected move over 20 trading sessions as a **fraction** of price
3115
+ * (`0.2` is 20%), the same number as `expectedMove20d` on the options endpoints. End of day.
3116
+ */
3117
+ expectedMove20d?: number | null;
3118
+ /**
3119
+ * ISO date (`YYYY-MM-DD`) of the session the options values are from. `null` when no valid
3120
+ * options overview row was joined for the ticker; individual readings may still be `null` when
3121
+ * the date is present.
3122
+ */
3123
+ optionsAsOf?: string | null;
2977
3124
  }
2978
3125
  /**
2979
3126
  * One matching fund.
@@ -3018,6 +3165,33 @@ interface EtfScreenerRow {
3018
3165
  partial: boolean | null;
3019
3166
  /** Epoch seconds. */
3020
3167
  lastUpdated: number | null;
3168
+ /**
3169
+ * IV rank, 0-100: where implied volatility sits in its own trailing one-year range. End of
3170
+ * day, from the nightly options board; `optionsAsOf` says which session. `null` when the
3171
+ * fund has no reading; absent on responses from before the field shipped.
3172
+ */
3173
+ ivRank1y?: number | null;
3174
+ /** Put volume divided by call volume in that session. End of day. */
3175
+ pcVol?: number | null;
3176
+ /** Percentile, 0-100, of `pcVol` against the fund's own trailing year. End of day. */
3177
+ pcVolPctl1y?: number | null;
3178
+ /** Percentile, 0-100, of the 25-delta skew against the fund's own trailing year. End of day. */
3179
+ skew25dPctl1y?: number | null;
3180
+ /** Composite 0-100 options interest score; `null` when unscored. End of day. */
3181
+ optionsInterestScore?: number | null;
3182
+ /** Dollar premium of the session's largest unusual contract; `null` when there was none. End of day. */
3183
+ maxUnusualPremium?: number | null;
3184
+ /**
3185
+ * Options-implied 90% expected move over 20 trading sessions as a **fraction** of price
3186
+ * (`0.2` is 20%), the same number as `expectedMove20d` on the options endpoints. End of day.
3187
+ */
3188
+ expectedMove20d?: number | null;
3189
+ /**
3190
+ * ISO date (`YYYY-MM-DD`) of the session the options values are from. `null` when no valid
3191
+ * options overview row was joined for the ticker; individual readings may still be `null` when
3192
+ * the date is present.
3193
+ */
3194
+ optionsAsOf?: string | null;
3021
3195
  }
3022
3196
  /** Request body for both execute endpoints. */
3023
3197
  interface ScreenerExecuteOptions {
@@ -4267,7 +4441,8 @@ declare class Options {
4267
4441
 
4268
4442
  /**
4269
4443
  * Screener: filter the tracked universe on the SentiSense Score, attention,
4270
- * analyst consensus, technicals and price in a single query. It is the one
4444
+ * analyst consensus, technicals, price and end-of-day options readings in a
4445
+ * single query. It is the one
4271
4446
  * surface where our own signals sit in the same `WHERE` clause as the market
4272
4447
  * data, which is the point: screening on analyst ratings alone is something a
4273
4448
  * dozen free tools do, screening on analyst ratings *where the Score disagrees*
@@ -4299,8 +4474,12 @@ declare class Options {
4299
4474
  * neither result. If a screen returns fewer rows than you expect, check
4300
4475
  * coverage before you check your thresholds.
4301
4476
  *
4302
- * Screens read a snapshot that refreshes every 20 minutes, so this is not a
4303
- * quote feed. Use `client.stocks.getQuote()` for live prices.
4477
+ * Prices are 15-minute delayed quotes, refreshed at request time during the
4478
+ * regular session from a cache at most 5 minutes old; each stock row's
4479
+ * `priceAsOf` (epoch milliseconds, `null` when unknown) says when its price is
4480
+ * from. Everything else on a row comes from a snapshot rebuilt about every 20
4481
+ * minutes during the session, so this is not a quote feed. Use
4482
+ * `client.stocks.getQuote()` for one ticker's current quote.
4304
4483
  */
4305
4484
  declare class Screener {
4306
4485
  private client;
@@ -4524,7 +4703,9 @@ declare class Stocks {
4524
4703
  *
4525
4704
  * Tiering: a PRO key always receives the full dossier. A FREE key receives it for the first
4526
4705
  * ten calls each calendar month and a headline-only preview after that, with `isPreview`
4527
- * true; calls that return a null `data` never spend that allowance.
4706
+ * true; calls that return a null `data` never spend that allowance. The headline preview has
4707
+ * no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
4708
+ * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
4528
4709
  */
4529
4710
  getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
4530
4711
  /**
@@ -4545,6 +4726,28 @@ declare class Stocks {
4545
4726
  * years, so it can answer with nearly the same series as `"2y"`.
4546
4727
  */
4547
4728
  getOptionsHistory(ticker: string, options?: GetOptionsHistoryOptions): Promise<PreviewResponse<OptionsHistory>>;
4729
+ /**
4730
+ * Get one stock's or ETF's intraday options series for one session: its numbers at every
4731
+ * 15-minute cycle of the intraday board, oldest cycle first.
4732
+ *
4733
+ * Use it to test an intraday signal against what the board actually showed at each point in
4734
+ * the day, then compare it with the session's end-of-day row from
4735
+ * {@link Stocks.getOptionsHistory}. Each point carries call and put volume so far, the
4736
+ * put/call ratio, the unusual-contract count, the percentile of the largest qualifying
4737
+ * contract against the ticker's own year, and the ATM implied volatility. It never carries a
4738
+ * contract symbol, strike, price, premium, open interest or print size.
4739
+ *
4740
+ * **PRO only.** A FREE key receives the standard preview: `isPreview` true, `previewReason`
4741
+ * `"PRO_REQUIRED"`, an `upgrade` hint, and `data: null`.
4742
+ *
4743
+ * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
4744
+ * before the history was kept, a ticker outside the board and an unknown symbol all answer
4745
+ * with `data.series` empty. `data.missingCycles` lists cycles whose stored point could not be
4746
+ * read, which are unknown rather than absent. A malformed or future `session` rejects with
4747
+ * an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
4748
+ * not be read; it is retried like any other 503 and never answered with a partial series.
4749
+ */
4750
+ getOptionsIntradayHistory(ticker: string, options?: GetOptionsIntradayHistoryOptions): Promise<PreviewResponse<OptionsIntradayHistory | null>>;
4548
4751
  /**
4549
4752
  * Get the SentiSense Rating for one stock: where it ranks against the other stocks rated
4550
4753
  * that day, and the six dimensions the rank is blended from.
@@ -4763,6 +4966,6 @@ declare class APIError extends SentiSenseError {
4763
4966
  constructor(message: string, status: number, code?: string);
4764
4967
  }
4765
4968
 
4766
- declare const VERSION = "0.63.1";
4969
+ declare const VERSION = "0.65.0";
4767
4970
 
4768
- 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 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 EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, 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 GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionDetail, type InstitutionList, type InstitutionListResponse, 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 OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, 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 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 TrackerGeoEntry, 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 };
4971
+ 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 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 EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, 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 GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionDetail, type InstitutionList, type InstitutionListResponse, 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 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 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 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 TrackerGeoEntry, 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
@@ -884,6 +884,12 @@ interface OptionsCapabilities {
884
884
  * `largePrintCount`, `largestPrintPctl`, `capabilities`), which are the same on every tier,
885
885
  * previews included, and are omitted when their source is absent: `intradayFlow` before the
886
886
  * day's first board or when the ticker has no row on it.
887
+ *
888
+ * A FREE key that has spent its monthly dossier allowance receives the headline preview
889
+ * instead (`isPreview` true): `asOf`, `sentiment` and six flat readings, `ivRank1y`, `atmIv`,
890
+ * `expectedMove1d`, `pcVol`, `pcVolPctl1y` and `maxPain`, with no `latest`, `context`,
891
+ * `oiWalls` or `unusual`. On a full dossier the six flat fields are absent and the same
892
+ * readings live in the nested objects.
887
893
  */
888
894
  interface OptionsSummary {
889
895
  /** Session the dossier describes, ISO calendar day. */
@@ -920,6 +926,18 @@ interface OptionsSummary {
920
926
  listingStatus?: "DELISTED";
921
927
  /** ISO day (YYYY-MM-DD) trading stopped; absent when the date is unknown. */
922
928
  delistedDate?: string;
929
+ /** Headline preview only: `context.ivRank1y` on a full dossier. */
930
+ ivRank1y?: number;
931
+ /** Headline preview only: `latest.atmIv` on a full dossier. */
932
+ atmIv?: number;
933
+ /** Headline preview only: `latest.expectedMove1d` on a full dossier. */
934
+ expectedMove1d?: number;
935
+ /** Headline preview only: `latest.pcVol` on a full dossier. */
936
+ pcVol?: number;
937
+ /** Headline preview only: `context.pcVolPctl1y` on a full dossier. */
938
+ pcVolPctl1y?: number;
939
+ /** Headline preview only: `oiWalls.maxPain` on a full dossier. */
940
+ maxPain?: number;
923
941
  }
924
942
  /** Trailing window for `client.stocks.getOptionsHistory()`. */
925
943
  type OptionsHistoryWindow = "1y" | "2y" | "5y";
@@ -954,6 +972,87 @@ interface OptionsHistory {
954
972
  /** Ascending by date, oldest first. Same shape as the dossier's `latest` aggregate. */
955
973
  series?: OptionsAggregate[];
956
974
  }
975
+ interface GetOptionsIntradayHistoryOptions {
976
+ /**
977
+ * Trading session date, `"YYYY-MM-DD"` (Eastern). Omitted, the server serves the session
978
+ * the intraday board ran most recently: today's once the first cycle lands at 09:45 ET, the
979
+ * previous session before that. Read `OptionsIntradayHistory.session` for the date served.
980
+ * A malformed or future date is rejected with HTTP 400, code `invalid_session`.
981
+ */
982
+ session?: string;
983
+ }
984
+ /**
985
+ * One ticker's numbers at one cycle of the intraday options board: counts, a ratio, a
986
+ * percentile and a ticker-level implied volatility, as the board showed them at `asOf`. It
987
+ * carries no contract symbol, strike, price, premium, open interest or print size. Readings
988
+ * the server cannot compute are omitted, never zero-filled.
989
+ */
990
+ interface OptionsIntradayPoint {
991
+ /** The board's cycle number within the session, starting at 1. */
992
+ cycle: number;
993
+ /** The cycle's snapshot time, Unix epoch seconds. */
994
+ asOf: number;
995
+ /** The same moment as `"HH:mm ET"`. */
996
+ asOfEt: string;
997
+ /** Calls traded so far this session, across the chain. */
998
+ callVol: number;
999
+ /** Puts traded so far this session. */
1000
+ putVol: number;
1001
+ /** `putVol / callVol`. Absent when `callVol` is 0. */
1002
+ pcVol?: number;
1003
+ /**
1004
+ * Contracts passing the unusual rule so far this session, up to 5: the same count as
1005
+ * `intradayFlow.unusualCount` on the dossier.
1006
+ */
1007
+ unusualCount: number;
1008
+ /**
1009
+ * Percentile (0-100) of the ticker's largest qualifying unusual contract so far this
1010
+ * session (same-day expiries excluded) against its own trailing year. Absent when nothing
1011
+ * qualifies, and while that history holds fewer than 60 sessions.
1012
+ */
1013
+ maxPremiumPctl1y?: number;
1014
+ /**
1015
+ * At-the-money implied volatility as a fraction (`0.42` is 42%), by the same rule as the
1016
+ * end-of-day `atmIv`. Absent when that expiry has no usable contract.
1017
+ */
1018
+ atmIv?: number;
1019
+ }
1020
+ /**
1021
+ * One ticker's intraday options series for one session, from
1022
+ * `client.stocks.getOptionsIntradayHistory()`, oldest cycle first.
1023
+ *
1024
+ * The board is rebuilt every 15 minutes from 15-minute delayed chains, from 09:45 to 16:15 ET,
1025
+ * so a full session holds 27 cycles. A ticker appears only on the cycles where it was on the
1026
+ * board, so `cycles` can be below that and the gaps show in each point's `cycle` and `asOf`.
1027
+ *
1028
+ * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
1029
+ * before the history was kept, a ticker outside the board and an unknown symbol all answer
1030
+ * with this object and nothing in `series`. The payload is `null` only on a FREE key's
1031
+ * `PRO_REQUIRED` preview.
1032
+ */
1033
+ interface OptionsIntradayHistory {
1034
+ /** Canonical ticker. */
1035
+ ticker: string;
1036
+ /** The trading session served, ISO date (Eastern). */
1037
+ session: string;
1038
+ /**
1039
+ * `true` while that session's board is still updating (today, before the close); `false`
1040
+ * for a completed or past session.
1041
+ */
1042
+ live: boolean;
1043
+ /** How far the chain data behind each point trails the market, in minutes. */
1044
+ delayMinutes: number;
1045
+ /** Number of points in `series`. */
1046
+ cycles: number;
1047
+ /**
1048
+ * Cycles of the session whose board was published but whose stored point could not be
1049
+ * found, ascending: this ticker's numbers at those cycles are unknown, not absent. Omitted
1050
+ * when there are none.
1051
+ */
1052
+ missingCycles?: number[];
1053
+ /** One point per cycle that carried this ticker, oldest first. */
1054
+ series: OptionsIntradayPoint[];
1055
+ }
957
1056
  /**
958
1057
  * One ticker's row on the market-wide options radar, from `client.options.getOverview()`.
959
1058
  *
@@ -1068,8 +1167,8 @@ interface OptionsHighlight {
1068
1167
  *
1069
1168
  * End of day, not live: `asOf` is the latest completed session. The exception is
1070
1169
  * `intradayActiveCount`, `intradayRanking` and `capabilities`, which summarize today's
1071
- * intraday board across stocks, are the same on every tier, and are omitted before the day's
1072
- * first board.
1170
+ * intraday board across stocks, are dated by `intradayAsOf` (epoch seconds) and
1171
+ * `intradayAsOfEt`, are the same on every tier, and are omitted before the day's first board.
1073
1172
  */
1074
1173
  interface OptionsOverview {
1075
1174
  /** Session the build describes, ISO calendar day. */
@@ -1113,6 +1212,13 @@ interface OptionsOverview {
1113
1212
  intradayActiveCount?: number;
1114
1213
  /** Up to 25 of those tickers, most unusual for their own history first. */
1115
1214
  intradayRanking?: string[];
1215
+ /**
1216
+ * Snapshot time of the intraday board `intradayActiveCount` and `intradayRanking` were read
1217
+ * from, Unix epoch seconds. Omitted with them.
1218
+ */
1219
+ intradayAsOf?: number;
1220
+ /** The same moment as `"HH:mm ET"`. Omitted with them. */
1221
+ intradayAsOfEt?: string;
1116
1222
  /** Where the intraday board lives and who can open it. */
1117
1223
  capabilities?: OptionsCapabilities;
1118
1224
  }
@@ -2972,8 +3078,49 @@ interface ScreenerRow {
2972
3078
  sentisenseScoreBars30D: number[] | null;
2973
3079
  /** Daily closes for the last 30 days, oldest first. */
2974
3080
  priceSparkline30D: number[] | null;
2975
- /** Epoch seconds. */
3081
+ /** Epoch seconds: when the row's snapshot was built. For the price's age read `priceAsOf`. */
2976
3082
  lastUpdated: number | null;
3083
+ /**
3084
+ * When the market data behind `currentPrice`, `change` and `changePercent` is from, epoch
3085
+ * **milliseconds**: the same field and unit as `priceAsOf` on the quote endpoints. `null`
3086
+ * outside regular hours, on a previous-close fallback, and when no quote was available, so
3087
+ * read `null` as unknown rather than fresh. Absent on responses from before the field
3088
+ * shipped.
3089
+ */
3090
+ priceAsOf?: number | null;
3091
+ /** SentiSense Rating letter, `"A"` to `"F"`. `null` for an unrated stock. */
3092
+ ratingLetter?: string | null;
3093
+ /** The graded 0-100 Rating score a Rating sort orders by. `null` when unrated. */
3094
+ ratingScore?: number | null;
3095
+ /** The 0-100 rank among the stocks rated that day, before risk adjustments. `null` when unrated. */
3096
+ ratingPercentile?: number | null;
3097
+ /**
3098
+ * IV rank, 0-100: where implied volatility sits in its own trailing one-year range. End of
3099
+ * day, from the nightly options board; `optionsAsOf` says which session. `null` when the
3100
+ * stock has no reading; absent on responses from before the field shipped.
3101
+ */
3102
+ ivRank1y?: number | null;
3103
+ /** Put volume divided by call volume in that session. End of day. */
3104
+ pcVol?: number | null;
3105
+ /** Percentile, 0-100, of `pcVol` against the stock's own trailing year. End of day. */
3106
+ pcVolPctl1y?: number | null;
3107
+ /** Percentile, 0-100, of the 25-delta skew against the stock's own trailing year. End of day. */
3108
+ skew25dPctl1y?: number | null;
3109
+ /** Composite 0-100 options interest score; `null` when unscored. End of day. */
3110
+ optionsInterestScore?: number | null;
3111
+ /** Dollar premium of the session's largest unusual contract; `null` when there was none. End of day. */
3112
+ maxUnusualPremium?: number | null;
3113
+ /**
3114
+ * Options-implied 90% expected move over 20 trading sessions as a **fraction** of price
3115
+ * (`0.2` is 20%), the same number as `expectedMove20d` on the options endpoints. End of day.
3116
+ */
3117
+ expectedMove20d?: number | null;
3118
+ /**
3119
+ * ISO date (`YYYY-MM-DD`) of the session the options values are from. `null` when no valid
3120
+ * options overview row was joined for the ticker; individual readings may still be `null` when
3121
+ * the date is present.
3122
+ */
3123
+ optionsAsOf?: string | null;
2977
3124
  }
2978
3125
  /**
2979
3126
  * One matching fund.
@@ -3018,6 +3165,33 @@ interface EtfScreenerRow {
3018
3165
  partial: boolean | null;
3019
3166
  /** Epoch seconds. */
3020
3167
  lastUpdated: number | null;
3168
+ /**
3169
+ * IV rank, 0-100: where implied volatility sits in its own trailing one-year range. End of
3170
+ * day, from the nightly options board; `optionsAsOf` says which session. `null` when the
3171
+ * fund has no reading; absent on responses from before the field shipped.
3172
+ */
3173
+ ivRank1y?: number | null;
3174
+ /** Put volume divided by call volume in that session. End of day. */
3175
+ pcVol?: number | null;
3176
+ /** Percentile, 0-100, of `pcVol` against the fund's own trailing year. End of day. */
3177
+ pcVolPctl1y?: number | null;
3178
+ /** Percentile, 0-100, of the 25-delta skew against the fund's own trailing year. End of day. */
3179
+ skew25dPctl1y?: number | null;
3180
+ /** Composite 0-100 options interest score; `null` when unscored. End of day. */
3181
+ optionsInterestScore?: number | null;
3182
+ /** Dollar premium of the session's largest unusual contract; `null` when there was none. End of day. */
3183
+ maxUnusualPremium?: number | null;
3184
+ /**
3185
+ * Options-implied 90% expected move over 20 trading sessions as a **fraction** of price
3186
+ * (`0.2` is 20%), the same number as `expectedMove20d` on the options endpoints. End of day.
3187
+ */
3188
+ expectedMove20d?: number | null;
3189
+ /**
3190
+ * ISO date (`YYYY-MM-DD`) of the session the options values are from. `null` when no valid
3191
+ * options overview row was joined for the ticker; individual readings may still be `null` when
3192
+ * the date is present.
3193
+ */
3194
+ optionsAsOf?: string | null;
3021
3195
  }
3022
3196
  /** Request body for both execute endpoints. */
3023
3197
  interface ScreenerExecuteOptions {
@@ -4267,7 +4441,8 @@ declare class Options {
4267
4441
 
4268
4442
  /**
4269
4443
  * Screener: filter the tracked universe on the SentiSense Score, attention,
4270
- * analyst consensus, technicals and price in a single query. It is the one
4444
+ * analyst consensus, technicals, price and end-of-day options readings in a
4445
+ * single query. It is the one
4271
4446
  * surface where our own signals sit in the same `WHERE` clause as the market
4272
4447
  * data, which is the point: screening on analyst ratings alone is something a
4273
4448
  * dozen free tools do, screening on analyst ratings *where the Score disagrees*
@@ -4299,8 +4474,12 @@ declare class Options {
4299
4474
  * neither result. If a screen returns fewer rows than you expect, check
4300
4475
  * coverage before you check your thresholds.
4301
4476
  *
4302
- * Screens read a snapshot that refreshes every 20 minutes, so this is not a
4303
- * quote feed. Use `client.stocks.getQuote()` for live prices.
4477
+ * Prices are 15-minute delayed quotes, refreshed at request time during the
4478
+ * regular session from a cache at most 5 minutes old; each stock row's
4479
+ * `priceAsOf` (epoch milliseconds, `null` when unknown) says when its price is
4480
+ * from. Everything else on a row comes from a snapshot rebuilt about every 20
4481
+ * minutes during the session, so this is not a quote feed. Use
4482
+ * `client.stocks.getQuote()` for one ticker's current quote.
4304
4483
  */
4305
4484
  declare class Screener {
4306
4485
  private client;
@@ -4524,7 +4703,9 @@ declare class Stocks {
4524
4703
  *
4525
4704
  * Tiering: a PRO key always receives the full dossier. A FREE key receives it for the first
4526
4705
  * ten calls each calendar month and a headline-only preview after that, with `isPreview`
4527
- * true; calls that return a null `data` never spend that allowance.
4706
+ * true; calls that return a null `data` never spend that allowance. The headline preview has
4707
+ * no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
4708
+ * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
4528
4709
  */
4529
4710
  getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
4530
4711
  /**
@@ -4545,6 +4726,28 @@ declare class Stocks {
4545
4726
  * years, so it can answer with nearly the same series as `"2y"`.
4546
4727
  */
4547
4728
  getOptionsHistory(ticker: string, options?: GetOptionsHistoryOptions): Promise<PreviewResponse<OptionsHistory>>;
4729
+ /**
4730
+ * Get one stock's or ETF's intraday options series for one session: its numbers at every
4731
+ * 15-minute cycle of the intraday board, oldest cycle first.
4732
+ *
4733
+ * Use it to test an intraday signal against what the board actually showed at each point in
4734
+ * the day, then compare it with the session's end-of-day row from
4735
+ * {@link Stocks.getOptionsHistory}. Each point carries call and put volume so far, the
4736
+ * put/call ratio, the unusual-contract count, the percentile of the largest qualifying
4737
+ * contract against the ticker's own year, and the ATM implied volatility. It never carries a
4738
+ * contract symbol, strike, price, premium, open interest or print size.
4739
+ *
4740
+ * **PRO only.** A FREE key receives the standard preview: `isPreview` true, `previewReason`
4741
+ * `"PRO_REQUIRED"`, an `upgrade` hint, and `data: null`.
4742
+ *
4743
+ * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
4744
+ * before the history was kept, a ticker outside the board and an unknown symbol all answer
4745
+ * with `data.series` empty. `data.missingCycles` lists cycles whose stored point could not be
4746
+ * read, which are unknown rather than absent. A malformed or future `session` rejects with
4747
+ * an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
4748
+ * not be read; it is retried like any other 503 and never answered with a partial series.
4749
+ */
4750
+ getOptionsIntradayHistory(ticker: string, options?: GetOptionsIntradayHistoryOptions): Promise<PreviewResponse<OptionsIntradayHistory | null>>;
4548
4751
  /**
4549
4752
  * Get the SentiSense Rating for one stock: where it ranks against the other stocks rated
4550
4753
  * that day, and the six dimensions the rank is blended from.
@@ -4763,6 +4966,6 @@ declare class APIError extends SentiSenseError {
4763
4966
  constructor(message: string, status: number, code?: string);
4764
4967
  }
4765
4968
 
4766
- declare const VERSION = "0.63.1";
4969
+ declare const VERSION = "0.65.0";
4767
4970
 
4768
- 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 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 EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, 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 GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionDetail, type InstitutionList, type InstitutionListResponse, 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 OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, 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 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 TrackerGeoEntry, 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 };
4971
+ 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 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 EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, 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 GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionDetail, type InstitutionList, type InstitutionListResponse, 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 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 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 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 TrackerGeoEntry, 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 };