sentisense 0.45.0 → 0.47.0

package/dist/index.d.mts

@@ -125,11 +125,33 @@ interface StockQuote {
     /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
     extendedHours?: ExtendedHoursInfo | null;
 }
+interface StockSocialDominance {
+    value: number;
+    rank: number;
+    percentile: number;
+}
+/**
+ * Stock with company name and entity metadata.
+ *
+ * The API names the company in two fields: `simpleName` is the short display name
+ * ("Agilent") and `companyName` is the legal name ("Agilent Technologies, Inc.").
+ */
 interface StockDetail {
     ticker: string;
+    /**
+     * @deprecated The API never sends this field. It is filled from `simpleName` so
+     * older code keeps working; read `simpleName` or `companyName` instead.
+     */
     name: string;
+    /** Short display name, e.g. "Agilent". */
+    simpleName: string;
+    /** Legal name, e.g. "Agilent Technologies, Inc.". */
+    companyName: string;
     kbEntityId?: string;
     urlSlug?: string;
+    /** Brand hex colour. Null for roughly two thirds of the universe. */
+    brandColor?: string | null;
+    socialDominance?: StockSocialDominance | null;
 }
 interface SimilarStock {
     symbol: string;
@@ -495,6 +517,139 @@ interface OptionsSummary {
     /** Top contracts by premium. */
     unusual?: OptionsUnusualContract[];
 }
+/** Trailing window for `client.stocks.getOptionsHistory()`. */
+type OptionsHistoryWindow = "1y" | "2y" | "5y";
+interface GetOptionsHistoryOptions {
+    /**
+     * Trailing window. Omitted, the API applies its own default of `"1y"`, and any
+     * unrecognised value clamps to `"1y"` rather than erroring.
+     *
+     * `"5y"` means "everything stored", which is currently a little over two years, so
+     * `"5y"` and `"2y"` can answer with nearly the same series. Read the window actually
+     * served off `OptionsHistory.window` rather than assuming you got what you asked for:
+     * a FREE key always receives `"1y"` whatever it requests.
+     */
+    window?: OptionsHistoryWindow;
+}
+/**
+ * The daily-aggregate time series for one stock or ETF, from
+ * `client.stocks.getOptionsHistory()`.
+ *
+ * **Unlike `getOptionsSummary`, this never answers with a null payload.** A ticker
+ * outside the covered universe, an unknown symbol, and a covered ticker with nothing
+ * stored yet all return this object with an empty `series`, so read the array's length
+ * rather than null-checking the payload.
+ */
+interface OptionsHistory {
+    ticker?: string;
+    /**
+     * Window the server actually served, which is not always the one you asked for: an
+     * unrecognised request clamps to `"1y"`, and so does any request on a FREE key.
+     */
+    window?: string;
+    /** Ascending by date, oldest first. Same shape as the dossier's `latest` aggregate. */
+    series?: OptionsAggregate[];
+}
+/**
+ * One ticker's row on the market-wide options radar, from `client.options.getOverview()`.
+ *
+ * Every percentile here is against **that ticker's own trailing history**, never against
+ * the rest of the board, so a row's `ivRank1y` says this name's implied volatility is high
+ * for itself and says nothing about whether it is high next to another name's.
+ *
+ * A covered ticker whose baseline is still building (roughly 60 sessions, plus a liquidity
+ * floor) carries its raw readings with the percentiles and `interestScore` omitted, so
+ * absent scores mean "not enough history yet", not "nothing interesting".
+ */
+interface OptionsOverviewRow {
+    ticker?: string;
+    /** Company name, or the fund name on an ETF row. Absent when unmapped. */
+    name?: string;
+    /**
+     * Sector on a stock row. On an **ETF row this carries the fund's asset class**
+     * (`"Equity"`, `"Bond"`, `"Commodity"`, ...) rather than a sector, so do not feed the two
+     * boards' values into one sector breakdown.
+     */
+    sector?: string;
+    /** Session this row describes, ISO calendar day. */
+    asOf?: string;
+    /** Options-implied positioning lean, roughly -1 to 1, negative for put-heavy. */
+    sentiment?: number;
+    /** Composite 0-100 blend of how extreme this row's readings are. Omitted while the baseline builds. */
+    interestScore?: number;
+    /** Put/call volume ratio for the session. */
+    pcVol?: number;
+    /** Percentile (0-100) of `pcVol` within this ticker's own trailing year. */
+    pcVolPctl1y?: number;
+    /** At-the-money implied volatility as a fraction, so `0.42` is 42%. */
+    atmIv?: number;
+    /** Where `atmIv` sits in this ticker's own trailing-year range, 0-100. */
+    ivRank1y?: number;
+    /** `iv25p - iv25c`, on the same scale as the IVs: `0.03` is three IV points. */
+    skew25d?: number;
+    /** Percentile (0-100) of `skew25d` within this ticker's own trailing year. */
+    skewPctl1y?: number;
+    /** Premium traded this session: volume times mark times 100. */
+    notionalVol?: number;
+    /** Signed change of `atmIv` against its ~20-session mean. Rank "biggest IV moves" by absolute value. */
+    ivMove20?: number;
+    /** Trailing-1y observation count, which is what drives the building-baseline state. */
+    observations1y?: number;
+    /** Unusually-active contracts this session. */
+    unusualCount?: number;
+    /** Largest volume/open-interest multiple among them. Absent when `unusualCount` is 0. */
+    maxVolOiRatio?: number;
+    /** Largest premium among them. Absent when `unusualCount` is 0. */
+    maxUnusualPremium?: number;
+    /** Side of the single heaviest open-interest wall, `"call"` or `"put"`. */
+    wallSide?: string;
+    /** Strike of that wall. */
+    wallStrike?: number;
+    /** That wall's share of its own side's open interest, 0 to 1. */
+    wallShare?: number;
+}
+/**
+ * The market-wide options radar, from `client.options.getOverview()`.
+ *
+ * **Two separately-ranked boards, never one.** `rows` is the covered stock universe and
+ * `etfRows` is the covered ETF universe, each already sorted by `interestScore` descending
+ * with unscored building-baseline rows last. Concatenating them produces a ranking that
+ * means nothing, because every reading behind the score is a percentile of that ticker's
+ * own past: an ETF's 90th percentile and a single stock's 90th percentile are measured
+ * against different histories.
+ *
+ * The aggregates split the same way. `medianIvRank`, `marketPcVol`, `extremeCount` and
+ * `coverageCount` describe the stock board only; the four `etf`-prefixed fields describe
+ * the ETF board and are omitted entirely when a build has no ETF rows.
+ *
+ * End of day, not live: `asOf` is the latest completed session.
+ */
+interface OptionsOverview {
+    /** Session the build describes, ISO calendar day. */
+    asOf?: string;
+    /** Median `ivRank1y` across the stock board. */
+    medianIvRank?: number;
+    /** Median put/call volume ratio across the stock board. */
+    marketPcVol?: number;
+    /** Stock rows reading as extreme today, out of `coverageCount`. */
+    extremeCount?: number;
+    /** Full size of the stock board, which stays the full number even on a truncated FREE response. */
+    coverageCount?: number;
+    /** The stock board, ranked. FREE keys receive the top 25; the envelope's `totalCount` carries the full size. */
+    rows?: OptionsOverviewRow[];
+    /** The ETF board, ranked independently. Omitted entirely when a build has no ETF rows. */
+    etfRows?: OptionsOverviewRow[];
+    /** Median `ivRank1y` across the ETF board. */
+    etfMedianIvRank?: number;
+    /** Median put/call volume ratio across the ETF board. */
+    etfMarketPcVol?: number;
+    /** ETF rows reading as extreme today, out of `etfCoverageCount`. */
+    etfExtremeCount?: number;
+    /** Full size of the ETF board, which stays the full number even on a truncated FREE response. */
+    etfCoverageCount?: number;
+    /** Full ETF board size on a FREE response, mirroring what the envelope's `totalCount` does for stocks. */
+    etfTotalCount?: number;
+}
 type DocumentSource = "news" | "reddit" | "x" | "substack" | "youtube";
 /** Per-entity sentiment classification with resolved entity details. */
 interface SentimentEntry {
@@ -2518,6 +2673,42 @@ declare class MarketSummaryResource {
     get(): Promise<MarketSummary>;
 }
 
+/**
+ * Market-wide options intelligence.
+ *
+ * Per-ticker options live on `client.stocks` (`getOptionsSummary`, `getOptionsHistory`),
+ * next to everything else keyed by a symbol. This resource holds the surfaces that have no
+ * ticker at all, the same split the market-wide mood and screener resources use.
+ */
+declare class Options {
+    private client;
+    constructor(client: APIClient);
+    /**
+     * Get the market-wide options radar: where implied volatility, put/call flow and skew are
+     * unusual today, ranked.
+     *
+     * End of day, not live. `asOf` is the latest completed session and the build refreshes the
+     * following morning, so this is positioning, not a quote feed.
+     *
+     * **The response carries two separately-ranked boards.** `data.rows` is the covered stock
+     * universe and `data.etfRows` is the covered ETF universe. Do not merge them: each row's
+     * readings are percentiles of that ticker's own trailing history, so a rank built across
+     * both boards compares numbers measured against different baselines. The aggregates are
+     * split the same way, with the `etf`-prefixed fields describing the ETF board alone.
+     *
+     * `data` is `null` before the first nightly build populates it, which is a cold-start
+     * state rather than an error.
+     *
+     * Tiering: a PRO key receives every row. A FREE key receives the top 25 stock rows plus
+     * all the aggregates, with `isPreview` true and the envelope's `totalCount` reporting the
+     * full stock board; `data.etfTotalCount` does the same for the ETF board.
+     *
+     * Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
+     * or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
+     */
+    getOverview(): Promise<PreviewResponse<OptionsOverview | null>>;
+}
+
 /**
  * Screener: filter the tracked universe on the SentiSense Score, attention,
  * analyst consensus, technicals and price in a single query. It is the one
@@ -2630,7 +2821,7 @@ declare class Stocks {
     constructor(client: APIClient);
     /** List all available ticker symbols. */
     list(): Promise<string[]>;
-    /** List all stocks with name, kbEntityId, urlSlug. */
+    /** List all stocks with company names, kbEntityId, urlSlug. */
     listDetailed(): Promise<StockDetail[]>;
     /** Get popular ticker symbols. */
     listPopular(): Promise<string[]>;
@@ -2763,6 +2954,24 @@ declare class Stocks {
      * true; calls that return a null `data` never spend that allowance.
      */
     getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
+    /**
+     * Get the daily options aggregates for one stock or ETF as a time series, oldest first.
+     * Use it to chart how a reading has trended: implied volatility, put/call flow, skew.
+     *
+     * Each element has the same shape as the dossier's `latest` aggregate, so a chart built
+     * off `getOptionsSummary` reads this series without a second mapping.
+     *
+     * **A null payload is not how this one reports no coverage.** Unlike
+     * {@link Stocks.getOptionsSummary}, an uncovered ticker, an unknown symbol and a covered
+     * ticker with nothing stored yet all answer with a populated object whose `series` is
+     * empty. Check the array's length, not the payload.
+     *
+     * The window served is not always the window requested: an unrecognised value clamps to
+     * `"1y"` rather than erroring, and a FREE key always receives `"1y"`. Read `data.window`
+     * for what you actually got. `"5y"` means all stored history, currently a little over two
+     * years, so it can answer with nearly the same series as `"2y"`.
+     */
+    getOptionsHistory(ticker: string, options?: GetOptionsHistoryOptions): Promise<PreviewResponse<OptionsHistory>>;
 }
 
 /**
@@ -2873,6 +3082,7 @@ declare class SentiSense implements APIClient {
     readonly calendar: Calendar;
     readonly earnings: Earnings;
     readonly screener: Screener;
+    readonly options: Options;
     constructor(options?: SentiSenseOptions);
     /** @internal */
     get<T = unknown>(path: string, params?: object): Promise<T>;
@@ -2918,6 +3128,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.45.0";
+declare const VERSION = "0.47.0";
 
-export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, 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 EarningsQuarter, type EarningsSource, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, 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 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 MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsOiWalls, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RecentEarningsEntry, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type Story, type StoryCluster, 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 };
+export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, 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 EarningsQuarter, type EarningsSource, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, 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 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 MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, 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, RateLimitError, type RecentEarningsEntry, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type StockSocialDominance, type Story, type StoryCluster, 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

@@ -125,11 +125,33 @@ interface StockQuote {
     /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
     extendedHours?: ExtendedHoursInfo | null;
 }
+interface StockSocialDominance {
+    value: number;
+    rank: number;
+    percentile: number;
+}
+/**
+ * Stock with company name and entity metadata.
+ *
+ * The API names the company in two fields: `simpleName` is the short display name
+ * ("Agilent") and `companyName` is the legal name ("Agilent Technologies, Inc.").
+ */
 interface StockDetail {
     ticker: string;
+    /**
+     * @deprecated The API never sends this field. It is filled from `simpleName` so
+     * older code keeps working; read `simpleName` or `companyName` instead.
+     */
     name: string;
+    /** Short display name, e.g. "Agilent". */
+    simpleName: string;
+    /** Legal name, e.g. "Agilent Technologies, Inc.". */
+    companyName: string;
     kbEntityId?: string;
     urlSlug?: string;
+    /** Brand hex colour. Null for roughly two thirds of the universe. */
+    brandColor?: string | null;
+    socialDominance?: StockSocialDominance | null;
 }
 interface SimilarStock {
     symbol: string;
@@ -495,6 +517,139 @@ interface OptionsSummary {
     /** Top contracts by premium. */
     unusual?: OptionsUnusualContract[];
 }
+/** Trailing window for `client.stocks.getOptionsHistory()`. */
+type OptionsHistoryWindow = "1y" | "2y" | "5y";
+interface GetOptionsHistoryOptions {
+    /**
+     * Trailing window. Omitted, the API applies its own default of `"1y"`, and any
+     * unrecognised value clamps to `"1y"` rather than erroring.
+     *
+     * `"5y"` means "everything stored", which is currently a little over two years, so
+     * `"5y"` and `"2y"` can answer with nearly the same series. Read the window actually
+     * served off `OptionsHistory.window` rather than assuming you got what you asked for:
+     * a FREE key always receives `"1y"` whatever it requests.
+     */
+    window?: OptionsHistoryWindow;
+}
+/**
+ * The daily-aggregate time series for one stock or ETF, from
+ * `client.stocks.getOptionsHistory()`.
+ *
+ * **Unlike `getOptionsSummary`, this never answers with a null payload.** A ticker
+ * outside the covered universe, an unknown symbol, and a covered ticker with nothing
+ * stored yet all return this object with an empty `series`, so read the array's length
+ * rather than null-checking the payload.
+ */
+interface OptionsHistory {
+    ticker?: string;
+    /**
+     * Window the server actually served, which is not always the one you asked for: an
+     * unrecognised request clamps to `"1y"`, and so does any request on a FREE key.
+     */
+    window?: string;
+    /** Ascending by date, oldest first. Same shape as the dossier's `latest` aggregate. */
+    series?: OptionsAggregate[];
+}
+/**
+ * One ticker's row on the market-wide options radar, from `client.options.getOverview()`.
+ *
+ * Every percentile here is against **that ticker's own trailing history**, never against
+ * the rest of the board, so a row's `ivRank1y` says this name's implied volatility is high
+ * for itself and says nothing about whether it is high next to another name's.
+ *
+ * A covered ticker whose baseline is still building (roughly 60 sessions, plus a liquidity
+ * floor) carries its raw readings with the percentiles and `interestScore` omitted, so
+ * absent scores mean "not enough history yet", not "nothing interesting".
+ */
+interface OptionsOverviewRow {
+    ticker?: string;
+    /** Company name, or the fund name on an ETF row. Absent when unmapped. */
+    name?: string;
+    /**
+     * Sector on a stock row. On an **ETF row this carries the fund's asset class**
+     * (`"Equity"`, `"Bond"`, `"Commodity"`, ...) rather than a sector, so do not feed the two
+     * boards' values into one sector breakdown.
+     */
+    sector?: string;
+    /** Session this row describes, ISO calendar day. */
+    asOf?: string;
+    /** Options-implied positioning lean, roughly -1 to 1, negative for put-heavy. */
+    sentiment?: number;
+    /** Composite 0-100 blend of how extreme this row's readings are. Omitted while the baseline builds. */
+    interestScore?: number;
+    /** Put/call volume ratio for the session. */
+    pcVol?: number;
+    /** Percentile (0-100) of `pcVol` within this ticker's own trailing year. */
+    pcVolPctl1y?: number;
+    /** At-the-money implied volatility as a fraction, so `0.42` is 42%. */
+    atmIv?: number;
+    /** Where `atmIv` sits in this ticker's own trailing-year range, 0-100. */
+    ivRank1y?: number;
+    /** `iv25p - iv25c`, on the same scale as the IVs: `0.03` is three IV points. */
+    skew25d?: number;
+    /** Percentile (0-100) of `skew25d` within this ticker's own trailing year. */
+    skewPctl1y?: number;
+    /** Premium traded this session: volume times mark times 100. */
+    notionalVol?: number;
+    /** Signed change of `atmIv` against its ~20-session mean. Rank "biggest IV moves" by absolute value. */
+    ivMove20?: number;
+    /** Trailing-1y observation count, which is what drives the building-baseline state. */
+    observations1y?: number;
+    /** Unusually-active contracts this session. */
+    unusualCount?: number;
+    /** Largest volume/open-interest multiple among them. Absent when `unusualCount` is 0. */
+    maxVolOiRatio?: number;
+    /** Largest premium among them. Absent when `unusualCount` is 0. */
+    maxUnusualPremium?: number;
+    /** Side of the single heaviest open-interest wall, `"call"` or `"put"`. */
+    wallSide?: string;
+    /** Strike of that wall. */
+    wallStrike?: number;
+    /** That wall's share of its own side's open interest, 0 to 1. */
+    wallShare?: number;
+}
+/**
+ * The market-wide options radar, from `client.options.getOverview()`.
+ *
+ * **Two separately-ranked boards, never one.** `rows` is the covered stock universe and
+ * `etfRows` is the covered ETF universe, each already sorted by `interestScore` descending
+ * with unscored building-baseline rows last. Concatenating them produces a ranking that
+ * means nothing, because every reading behind the score is a percentile of that ticker's
+ * own past: an ETF's 90th percentile and a single stock's 90th percentile are measured
+ * against different histories.
+ *
+ * The aggregates split the same way. `medianIvRank`, `marketPcVol`, `extremeCount` and
+ * `coverageCount` describe the stock board only; the four `etf`-prefixed fields describe
+ * the ETF board and are omitted entirely when a build has no ETF rows.
+ *
+ * End of day, not live: `asOf` is the latest completed session.
+ */
+interface OptionsOverview {
+    /** Session the build describes, ISO calendar day. */
+    asOf?: string;
+    /** Median `ivRank1y` across the stock board. */
+    medianIvRank?: number;
+    /** Median put/call volume ratio across the stock board. */
+    marketPcVol?: number;
+    /** Stock rows reading as extreme today, out of `coverageCount`. */
+    extremeCount?: number;
+    /** Full size of the stock board, which stays the full number even on a truncated FREE response. */
+    coverageCount?: number;
+    /** The stock board, ranked. FREE keys receive the top 25; the envelope's `totalCount` carries the full size. */
+    rows?: OptionsOverviewRow[];
+    /** The ETF board, ranked independently. Omitted entirely when a build has no ETF rows. */
+    etfRows?: OptionsOverviewRow[];
+    /** Median `ivRank1y` across the ETF board. */
+    etfMedianIvRank?: number;
+    /** Median put/call volume ratio across the ETF board. */
+    etfMarketPcVol?: number;
+    /** ETF rows reading as extreme today, out of `etfCoverageCount`. */
+    etfExtremeCount?: number;
+    /** Full size of the ETF board, which stays the full number even on a truncated FREE response. */
+    etfCoverageCount?: number;
+    /** Full ETF board size on a FREE response, mirroring what the envelope's `totalCount` does for stocks. */
+    etfTotalCount?: number;
+}
 type DocumentSource = "news" | "reddit" | "x" | "substack" | "youtube";
 /** Per-entity sentiment classification with resolved entity details. */
 interface SentimentEntry {
@@ -2518,6 +2673,42 @@ declare class MarketSummaryResource {
     get(): Promise<MarketSummary>;
 }
 
+/**
+ * Market-wide options intelligence.
+ *
+ * Per-ticker options live on `client.stocks` (`getOptionsSummary`, `getOptionsHistory`),
+ * next to everything else keyed by a symbol. This resource holds the surfaces that have no
+ * ticker at all, the same split the market-wide mood and screener resources use.
+ */
+declare class Options {
+    private client;
+    constructor(client: APIClient);
+    /**
+     * Get the market-wide options radar: where implied volatility, put/call flow and skew are
+     * unusual today, ranked.
+     *
+     * End of day, not live. `asOf` is the latest completed session and the build refreshes the
+     * following morning, so this is positioning, not a quote feed.
+     *
+     * **The response carries two separately-ranked boards.** `data.rows` is the covered stock
+     * universe and `data.etfRows` is the covered ETF universe. Do not merge them: each row's
+     * readings are percentiles of that ticker's own trailing history, so a rank built across
+     * both boards compares numbers measured against different baselines. The aggregates are
+     * split the same way, with the `etf`-prefixed fields describing the ETF board alone.
+     *
+     * `data` is `null` before the first nightly build populates it, which is a cold-start
+     * state rather than an error.
+     *
+     * Tiering: a PRO key receives every row. A FREE key receives the top 25 stock rows plus
+     * all the aggregates, with `isPreview` true and the envelope's `totalCount` reporting the
+     * full stock board; `data.etfTotalCount` does the same for the ETF board.
+     *
+     * Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
+     * or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
+     */
+    getOverview(): Promise<PreviewResponse<OptionsOverview | null>>;
+}
+
 /**
  * Screener: filter the tracked universe on the SentiSense Score, attention,
  * analyst consensus, technicals and price in a single query. It is the one
@@ -2630,7 +2821,7 @@ declare class Stocks {
     constructor(client: APIClient);
     /** List all available ticker symbols. */
     list(): Promise<string[]>;
-    /** List all stocks with name, kbEntityId, urlSlug. */
+    /** List all stocks with company names, kbEntityId, urlSlug. */
     listDetailed(): Promise<StockDetail[]>;
     /** Get popular ticker symbols. */
     listPopular(): Promise<string[]>;
@@ -2763,6 +2954,24 @@ declare class Stocks {
      * true; calls that return a null `data` never spend that allowance.
      */
     getOptionsSummary(ticker: string): Promise<PreviewResponse<OptionsSummary | null>>;
+    /**
+     * Get the daily options aggregates for one stock or ETF as a time series, oldest first.
+     * Use it to chart how a reading has trended: implied volatility, put/call flow, skew.
+     *
+     * Each element has the same shape as the dossier's `latest` aggregate, so a chart built
+     * off `getOptionsSummary` reads this series without a second mapping.
+     *
+     * **A null payload is not how this one reports no coverage.** Unlike
+     * {@link Stocks.getOptionsSummary}, an uncovered ticker, an unknown symbol and a covered
+     * ticker with nothing stored yet all answer with a populated object whose `series` is
+     * empty. Check the array's length, not the payload.
+     *
+     * The window served is not always the window requested: an unrecognised value clamps to
+     * `"1y"` rather than erroring, and a FREE key always receives `"1y"`. Read `data.window`
+     * for what you actually got. `"5y"` means all stored history, currently a little over two
+     * years, so it can answer with nearly the same series as `"2y"`.
+     */
+    getOptionsHistory(ticker: string, options?: GetOptionsHistoryOptions): Promise<PreviewResponse<OptionsHistory>>;
 }
 
 /**
@@ -2873,6 +3082,7 @@ declare class SentiSense implements APIClient {
     readonly calendar: Calendar;
     readonly earnings: Earnings;
     readonly screener: Screener;
+    readonly options: Options;
     constructor(options?: SentiSenseOptions);
     /** @internal */
     get<T = unknown>(path: string, params?: object): Promise<T>;
@@ -2918,6 +3128,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.45.0";
+declare const VERSION = "0.47.0";
 
-export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, 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 EarningsQuarter, type EarningsSource, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, 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 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 MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsOiWalls, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RecentEarningsEntry, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type Story, type StoryCluster, 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 };
+export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, 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 EarningsQuarter, type EarningsSource, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, 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 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 MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, 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, RateLimitError, type RecentEarningsEntry, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type StockSocialDominance, type Story, type StoryCluster, 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 };