sentisense 0.35.0 → 0.38.0

package/dist/index.d.mts

@@ -17,6 +17,22 @@ interface StockPrice {
     timestamp: number;
     /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
     extendedHours?: ExtendedHoursInfo | null;
+    /**
+     * Listing lifecycle. Absent for an ordinarily listed stock, which is almost every ticker.
+     *
+     * `"DELISTED"` means the company no longer trades publicly and EVERY price field above is
+     * frozen at the last trade before {@link delistedDate}. It is not a live price, so do not
+     * render `changePercent` as a market move.
+     *
+     * `"PENDING_DELISTING"` means a merger or take-private is scheduled but the stock still
+     * trades normally, so the figures above ARE current. Treat it as informational, never as a
+     * data-quality warning.
+     */
+    listingStatus?: 'DELISTED' | 'PENDING_DELISTING';
+    /** ISO date (YYYY-MM-DD) trading stopped. Absent unless `listingStatus` is `DELISTED`. */
+    delistedDate?: string;
+    /** Why it delisted. Absent unless `listingStatus` is `DELISTED`. */
+    delistingReason?: 'acquired' | 'take_private' | 'bankruptcy' | 'exchange_rule' | 'merged';
 }
 /**
  * Extended-hours session view embedded in price / quote responses when the snapshot sees
@@ -60,6 +76,22 @@ interface StockQuote {
      * omitted rather than computed in that case, so treat them as possibly absent, not zero.
      */
     reportedCurrency?: string;
+    /**
+     * Listing lifecycle. Absent for an ordinarily listed stock, which is almost every ticker.
+     *
+     * `"DELISTED"` means the company no longer trades publicly and EVERY price field above is
+     * frozen at the last trade before {@link delistedDate}. It is not a live quote, so do not
+     * render `changePercent` as a market move.
+     *
+     * `"PENDING_DELISTING"` means a merger or take-private is scheduled but the stock still
+     * trades and reports normally, so the figures above ARE current. Treat it as informational,
+     * never as a data-quality warning.
+     */
+    listingStatus?: 'DELISTED' | 'PENDING_DELISTING';
+    /** ISO date (YYYY-MM-DD) trading stopped. Absent unless `listingStatus` is `DELISTED`. */
+    delistedDate?: string;
+    /** Why it delisted. Absent unless `listingStatus` is `DELISTED`. */
+    delistingReason?: 'acquired' | 'take_private' | 'bankruptcy' | 'exchange_rule' | 'merged';
     timestamp: number | null;
     /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
     extendedHours?: ExtendedHoursInfo | null;
@@ -90,6 +122,15 @@ interface StockProfile {
     industry?: string;
     marketCap?: number;
     description?: string;
+    /**
+     * Listing lifecycle. Absent for an ordinarily listed stock. See {@link StockPrice.listingStatus}
+     * for what `"DELISTED"` and `"PENDING_DELISTING"` mean for the rest of the payload.
+     */
+    listingStatus?: 'DELISTED' | 'PENDING_DELISTING';
+    /** ISO date (YYYY-MM-DD) trading stopped. Absent unless `listingStatus` is `DELISTED`. */
+    delistedDate?: string;
+    /** Why it delisted. Absent unless `listingStatus` is `DELISTED`. */
+    delistingReason?: 'acquired' | 'take_private' | 'bankruptcy' | 'exchange_rule' | 'merged';
     [key: string]: unknown;
 }
 interface StockEntity {
@@ -839,6 +880,110 @@ interface GetEarningsCalendarOptions {
     /** Session filter. */
     time?: "before_open" | "after_close" | "during_market" | "unknown";
 }
+/**
+ * One KPI card on a reported quarter.
+ *
+ * `value` and `yoy` are display strings, already formatted (`"$109.4B"`,
+ * `"+16% YoY"`), not numbers to compute with. `yoy` is absent when the quarter
+ * carries no year-over-year comparison for that line, which is common on
+ * call highlights.
+ */
+interface EarningsKpiHighlight {
+    label: string;
+    value: string;
+    yoy?: string;
+}
+/** A citation backing a reported quarter. */
+interface EarningsSource {
+    title: string;
+    url: string;
+}
+/**
+ * One fiscal quarter of the earnings analysis report, from
+ * `client.earnings.getSummaries()`.
+ *
+ * The wire shape depends on the caller's tier, so branch on the envelope's
+ * `isPreview` rather than on field presence. `fiscalPeriod`, `reportDate`,
+ * `headline`, `hasTranscript`, `generatedAt` and `source` arrive on both tiers.
+ *
+ * PRO adds the bodies: `summaryMd`, the full `kpiHighlights`, `guidance`,
+ * `transcriptSummaryMd`, `transcriptHighlights`, `transcriptGeneratedAt` and
+ * `sources`.
+ *
+ * The FREE preview replaces those bodies with shape: up to two `kpiHighlights`
+ * cards (without `yoy`) plus `kpiHighlightCount`, the section titles in
+ * `summaryTopics` and `transcriptTopics`, and `hasGuidance` with
+ * `guidanceDirection` in place of the guidance language. It never carries a
+ * body, a KPI history, or a guidance figure.
+ *
+ * Absence is explicit: a quarter with no call summary sets `hasTranscript` to
+ * `false` rather than dropping the concept, so a client can say "no call
+ * summary yet" instead of rendering nothing.
+ */
+interface EarningsQuarter {
+    /** Display fiscal period, e.g. `"Q2 FY2026"`. */
+    fiscalPeriod: string;
+    /** Date the results were reported, ISO calendar day `"YYYY-MM-DD"`. */
+    reportDate: string;
+    /** One-line editorial summary of the quarter. */
+    headline: string;
+    /** True when a summary of the earnings call exists for this quarter. */
+    hasTranscript: boolean;
+    /** When the quarter summary was generated, epoch seconds. */
+    generatedAt: number;
+    /** Provenance of the quarter summary. */
+    source: "press_release" | "transcript";
+    /** PRO: markdown body summarizing the reported results. */
+    summaryMd?: string;
+    /** PRO carries the full set; a preview carries up to two cards without `yoy`. */
+    kpiHighlights?: EarningsKpiHighlight[];
+    /** PRO: forward-guidance language as reported. Absent when the quarter carries none. */
+    guidance?: string;
+    /** PRO: markdown body summarizing the call. Absent when `hasTranscript` is false. */
+    transcriptSummaryMd?: string;
+    /** PRO: call-specific highlights. Absent when there is no call summary. */
+    transcriptHighlights?: EarningsKpiHighlight[];
+    /** PRO: when the call summary was generated, epoch seconds. Can post-date `generatedAt`. */
+    transcriptGeneratedAt?: number;
+    /** PRO: citations backing the quarter. */
+    sources?: EarningsSource[];
+    /** Preview: how many KPI cards the full quarter carries. */
+    kpiHighlightCount?: number;
+    /** Preview: section titles of the summary, never body text. */
+    summaryTopics?: string[];
+    /** Preview: section titles of the call summary, never body text. */
+    transcriptTopics?: string[];
+    /** Preview: whether the quarter carries guidance at all. */
+    hasGuidance?: boolean;
+    /** Preview: the direction only, in place of the guidance language. */
+    guidanceDirection?: "RAISED" | "CUT" | "HELD" | "MIXED" | null;
+}
+/** One company that reported inside the recent window. */
+interface RecentEarningsEntry {
+    ticker: string;
+    /** Display fiscal period, e.g. `"Q2 FY2026"`. */
+    fiscalPeriod: string;
+    /** Date the results were reported, ISO calendar day `"YYYY-MM-DD"`. */
+    reportDate: string;
+    headline: string;
+    /** True when a summary of the earnings call exists for this quarter. */
+    hasTranscriptSummary: boolean;
+    /** Latest content written for this quarter, epoch seconds. */
+    generatedAt: number;
+}
+interface GetEarningsSummariesOptions {
+    /**
+     * Max quarters returned, 1 to 40. Omitted, the API applies its own default
+     * of 12. A FREE key receives one quarter whatever you pass.
+     */
+    limit?: number;
+}
+interface GetRecentEarningsOptions {
+    /** Look-back window in days, 1 to 31. Omitted, the API applies its own default of 7. */
+    days?: number;
+    /** Max rows returned, 1 to 100. Omitted, the API applies its own default of 50. */
+    limit?: number;
+}
 interface PreviewResponse<T> {
     isPreview: boolean;
     previewReason: "PRO_REQUIRED" | null;
@@ -1301,6 +1446,259 @@ interface IndexHistoryResponse {
     days: number;
     history: IndexHistoryPoint[];
 }
+/** One selectable value of an `ENUM` screener field. */
+interface ScreenerFieldOption {
+    /** The number a filter carries for this reading. */
+    value: number | null;
+    /** Display copy. */
+    label: string;
+}
+/**
+ * One filterable field from `client.screener.fields()`.
+ *
+ * Build a filter UI from this rather than hardcoding the field list, and new
+ * fields appear without an SDK release.
+ *
+ * `type` is `"NUMBER"`, `"ENUM"` or `"STRING"`:
+ *
+ * - `NUMBER` takes a scalar `value` and the comparison ops in `ops`.
+ * - `ENUM` is an ordinal with a fixed set of readings; `options` carries them
+ *   and `ops` is `["EQ"]`.
+ * - `STRING` (ETF universe only) takes `IN` / `NOT_IN` against `values`, which
+ *   is populated from the live universe rather than a static list, so pickers
+ *   stay current.
+ */
+interface ScreenerFieldDescriptor {
+    /** The name a filter's `fieldName` carries, e.g. `"SENTI_SCORE_7D"`. */
+    name: string;
+    label: string;
+    /** UI grouping, e.g. `"Sentiment"`, `"Analyst"`, `"Technical"`. */
+    group: string;
+    type: "NUMBER" | "ENUM" | "STRING" | (string & {});
+    /** e.g. `"SCORE"`, `"PERCENT"`, `"USD"`. `null` on unitless fields. */
+    unit: string | null;
+    ops: string[];
+    sortable: boolean;
+    /** Suggested input step for a numeric control. */
+    step: number | null;
+    placeholder: string | null;
+    description: string;
+    /** `ENUM` fields only; `null` otherwise. */
+    options: ScreenerFieldOption[] | null;
+    /**
+     * Thresholds worth offering as one-tap presets. On the SentiSense Score
+     * fields these are the band edges (5, 13, 23).
+     */
+    quickValues: string[] | null;
+    /** `STRING` fields only, populated from the live universe; `null` otherwise. */
+    values: string[] | null;
+}
+/**
+ * Both field catalogs, returned by `client.screener.fields()`.
+ *
+ * `stock` backs {@link Screener.run}; `etf` backs {@link Screener.runEtfs}. The
+ * two universes do not share a field vocabulary, so a name from one is not
+ * valid in the other.
+ */
+interface ScreenerFieldCatalog {
+    stock: ScreenerFieldDescriptor[];
+    etf: ScreenerFieldDescriptor[];
+}
+/**
+ * One filter leg. Filters are ANDed together; there is no OR, so run two
+ * screens and merge.
+ *
+ * Identify the field with `fieldName`. The curated plans from
+ * `client.screener.screens()` use the older `field` key instead, and both are
+ * accepted on the way in, so read either when inspecting a plan you did not
+ * build yourself.
+ *
+ * Numeric ops take `value`; `IN` / `NOT_IN` take `values` and are only
+ * meaningful on the ETF universe's string fields.
+ */
+interface ScreenerFilter {
+    fieldName?: string;
+    /** Legacy field key, as emitted by the curated screens. */
+    field?: string;
+    op: "GTE" | "LTE" | "GT" | "LT" | "EQ" | "NEQ" | "IN" | "NOT_IN";
+    value?: number;
+    values?: string[];
+}
+/** Sort spec. Nulls sort last regardless of direction. */
+interface ScreenerSort {
+    fieldName?: string;
+    /** Legacy field key, as emitted by the curated screens. */
+    field?: string;
+    dir: "ASC" | "DESC";
+}
+/**
+ * A filter and sort plan. The same shape works for both universes; the endpoint
+ * you call decides which one runs, so `universe` on a plan you pass in is a
+ * no-op.
+ *
+ * `limit` is deliberately not on this object: it rides next to the plan on the
+ * request, because a plan is a stored object and paging is a transport concern.
+ */
+interface ScreenerPlan {
+    universe?: "STOCK" | "ETF";
+    filters: ScreenerFilter[];
+    sort?: ScreenerSort;
+    /** Present on curated plans; ignored on execution. */
+    intent?: string;
+    /** Present on curated plans; ignored on execution. */
+    summary?: string;
+}
+/**
+ * A curated screen from `client.screener.screens()`.
+ *
+ * `plan` round-trips straight back into {@link Screener.run} (or
+ * {@link Screener.runEtfs} when `plan.universe === "ETF"`), so a curated screen
+ * is both a ready-made query and a worked example of the plan shape.
+ *
+ * `id` is stable and safe to persist. `name` and `summary` are display copy and
+ * may be revised. Two conventions in the names are load-bearing: `+` means both
+ * conditions hold, `vs` means the two sides disagree.
+ */
+interface FeaturedScreen {
+    id: string;
+    name: string;
+    summary: string;
+    plan: ScreenerPlan;
+}
+/** Envelope returned by `client.screener.screens()`. */
+interface ScreenerScreensResponse {
+    screens: FeaturedScreen[];
+}
+/**
+ * One matching stock. Every row carries the full field set rather than only the
+ * fields you filtered on, so you can sort or post-process client side without a
+ * second call. A field with no data for that ticker is `null`, and a row
+ * missing the field you filtered on never matches in either direction.
+ *
+ * `sentiSenseScore7D` / `sentiSenseScore1M` are the SentiSense Score, not
+ * sentiment polarity: unbounded, banded at 5 / 13 / 23 either side of zero.
+ */
+interface ScreenerRow {
+    ticker: string;
+    /** 7-day average SentiSense Score. */
+    sentiSenseScore7D: number | null;
+    /** 1-month average SentiSense Score. */
+    sentiSenseScore1M: number | null;
+    /** 7-day Score minus the 1-month baseline; positive means strengthening. */
+    scoreChange7D: number | null;
+    /** Side of the neutral band the 7-day Score sits on: `1` / `0` / `-1`. */
+    sentimentDirection: number | null;
+    socialDominance: number | null;
+    mentionShare: number | null;
+    mentionVelocity: number | null;
+    dominanceChange: number | null;
+    /** USD. */
+    marketCap: number | null;
+    currentPrice: number | null;
+    changePercent: number | null;
+    change: number | null;
+    volume: number | null;
+    week52High: number | null;
+    week52Low: number | null;
+    /** Signed-negative percent below the 52-week high. */
+    pctOff52wHigh: number | null;
+    /** Signed-positive percent above the 52-week low. */
+    pctOff52wLow: number | null;
+    /** Share of rating analysts saying buy, 0..100. Higher is more bullish. */
+    analystBuyRatioPct: number | null;
+    analystTargetUpsidePct: number | null;
+    analystCount: number | null;
+    analystRatingMomentum30D: number | null;
+    /** Vendor 1-to-5 scale. **INVERTED: 1.0 is strong buy.** */
+    analystRatingMean: number | null;
+    pctOff200dMa: number | null;
+    pctOff50dMa: number | null;
+    /** Ordinal: `1` golden cross, `-1` death cross, `0` neither. */
+    maCrossState: number | null;
+    return1M: number | null;
+    return3M: number | null;
+    return6M: number | null;
+    return1Y: number | null;
+    volatility30D: number | null;
+    /** Daily Score values for the last 7 days, oldest first. */
+    sentisenseScoreBars7D: number[] | null;
+    /** Weekly-grouped Score values across the last 30 days, oldest first. */
+    sentisenseScoreBars30D: number[] | null;
+    /** Daily closes for the last 30 days, oldest first. */
+    priceSparkline30D: number[] | null;
+    /** Epoch seconds. */
+    lastUpdated: number | null;
+}
+/**
+ * One matching fund.
+ *
+ * The two Score readings answer different questions.
+ * `constituentsWeightedSentisense` is the holdings-weighted SentiSense Score
+ * across what the fund actually owns, which is usually the one you want;
+ * `directSentisense` is the Score from chatter about the fund ticker itself,
+ * which on a broad index fund is mostly macro noise.
+ */
+interface EtfScreenerRow {
+    ticker: string;
+    name: string;
+    issuer: string | null;
+    assetClass: string | null;
+    trackedIndex: string | null;
+    /** AUM in USD. */
+    marketCap: number | null;
+    /** Percent points: `0.09` means 0.09%. */
+    expenseRatio: number | null;
+    currentPrice: number | null;
+    changePercent: number | null;
+    priceChange: number | null;
+    volume: number | null;
+    week52High: number | null;
+    week52Low: number | null;
+    pctOff52wHigh: number | null;
+    pctOff52wLow: number | null;
+    weightedAnalystUpside: number | null;
+    weightedConsensusLabel: string | null;
+    weightedInsiderNet30d: number | null;
+    weightedInsiderNet90d: number | null;
+    /** Holdings-weighted SentiSense Score across the fund's constituents. */
+    constituentsWeightedSentisense: number | null;
+    /** SentiSense Score from chatter about the fund ticker itself. */
+    directSentisense: number | null;
+    /** How much of the fund's weight had constituent data behind the weighted Score. */
+    weightCoveredPct: number | null;
+    holdingsCount: number | null;
+    totalKnownHoldings: number | null;
+    /** `true` when the holdings set behind the aggregates is incomplete. */
+    partial: boolean | null;
+    /** Epoch seconds. */
+    lastUpdated: number | null;
+}
+/** Request body for both execute endpoints. */
+interface ScreenerExecuteOptions {
+    plan: ScreenerPlan;
+    /** Optional ticker subset. Omit to screen the whole tracked universe. */
+    tickers?: string[];
+    /** Rows to return. Defaults to 100 server-side, caps at 500. */
+    limit?: number;
+}
+/**
+ * Stock screen results.
+ *
+ * `matched` is how many rows the plan matched *before* `limit` was applied, so
+ * truncation is visible: when `matched` exceeds `limit` you are looking at the
+ * top slice under the plan's sort, not the whole answer.
+ */
+interface ScreenerExecuteResponse {
+    results: ScreenerRow[];
+    matched: number;
+    limit: number;
+}
+/** ETF screen results. Same envelope; `matched` is the pre-limit count. */
+interface EtfScreenerExecuteResponse {
+    results: EtfScreenerRow[];
+    matched: number;
+    limit: number;
+}
 
 interface AnalystConsensus {
     ticker: string;
@@ -1422,6 +1820,58 @@ declare class Documents {
     getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
 }
 
+/**
+ * Earnings: what a company actually reported, after the fact.
+ *
+ * A quarter's results arrive as a press release, a filing, and a call, none of
+ * which is a data structure. {@link getSummaries} is the assembled version, one
+ * object per fiscal quarter, and {@link getRecent} is the cross-ticker view of
+ * who reported lately. Pair them to drive a post-earnings sweep: list the
+ * window, then pull each ticker's analysis report.
+ *
+ * The forward-looking half of the family lives on `client.calendar.getEarnings()`,
+ * which covers scheduled dates and consensus EPS rather than results.
+ *
+ * @see EarningsQuarter
+ */
+declare class Earnings {
+    private client;
+    constructor(client: APIClient);
+    /**
+     * Per-quarter earnings analysis report for one ticker, newest first.
+     *
+     * Each quarter carries the editorial headline, the KPI cards that matter for
+     * that company with year-over-year deltas, the guidance language as
+     * management phrased it, and a summary of the earnings call.
+     *
+     * Branch on `isPreview`: a PRO key receives every hydrated quarter in full, a
+     * FREE key receives the latest quarter shaped rather than truncated, plus
+     * `totalCount`. {@link EarningsQuarter} documents which fields each tier
+     * carries.
+     *
+     * A quarter typically appears within 48 hours of the company reporting, and
+     * the call summary can arrive after the press-release content for the same
+     * quarter, so read `generatedAt` and `transcriptGeneratedAt` rather than
+     * assuming a fixed lag. A ticker with no stored quarter answers with an empty
+     * `data` array, not a 404.
+     *
+     * Use canonical ticker symbols: `GOOGL` (not `GOOG`), `BRK.B` (not `BRK-B`).
+     */
+    getSummaries(ticker: string, options?: GetEarningsSummariesOptions): Promise<PreviewResponse<EarningsQuarter[]>>;
+    /**
+     * Which covered companies reported on or after `today - days`, newest first.
+     *
+     * Every API key receives the full window it asks for, so `isPreview` is
+     * always `false` here. The window is bounded by `reportDate`, so a quarter
+     * reported inside it appears even when its call summary lands later, and an
+     * empty `data` array means nobody in the covered set reported in that window.
+     *
+     * This is the backward-looking feed; `client.calendar.getEarnings()` is the
+     * forward-looking one.
+     */
+    getRecent(options?: GetRecentEarningsOptions): Promise<PreviewResponse<RecentEarningsEntry[]>>;
+}
+
 declare class EntityMetrics {
     private client;
     constructor(client: APIClient);
@@ -1615,7 +2065,7 @@ declare class Insider {
     /**
      * Get market-wide insider activity: top buys and sells aggregated by ticker.
      *
-     * PRO-gated. Free/unauthenticated users receive a preview (top 5 per direction)
+     * PRO-gated. Free-tier users receive a preview (top 5 per direction)
      * with `isPreview: true` in the response.
      */
     getActivity(options?: GetInsiderOptions): Promise<PreviewResponse<InsiderActivityResponse>>;
@@ -1639,7 +2089,7 @@ declare class Politicians {
     /**
      * Get recent congressional STOCK Act trading activity across all politicians.
      *
-     * PRO-gated. Free/unauthenticated users receive a preview (top 5 trades)
+     * PRO-gated. Free-tier users receive a preview (top 5 trades)
      * with `isPreview: true` in the response.
      *
      * The feed is longer than one response: a default 90-day window is routinely well over a
@@ -1734,7 +2184,7 @@ declare class Insights {
     user(options?: GetUserInsightsOptions): Promise<PreviewResponse<Insight[]>>;
     /**
      * Get available insight types for a specific stock.
-     * No authentication required.
+     * API key required.
      *
      * Returns an array of insight type strings (e.g., `["sentiment_shift", "options_activity"]`).
      */
@@ -1825,6 +2275,113 @@ declare class MarketSummaryResource {
     get(): Promise<MarketSummary>;
 }
 
+/**
+ * Screener: filter the tracked universe on the SentiSense Score, attention,
+ * analyst consensus, technicals and price in a single query. It is the one
+ * surface where our own signals sit in the same `WHERE` clause as the market
+ * data, which is the point: screening on analyst ratings alone is something a
+ * dozen free tools do, screening on analyst ratings *where the Score disagrees*
+ * is not.
+ *
+ * Every screen is a {@link ScreenerPlan}. Take one from {@link screens} or
+ * build your own, then hand it to {@link run} or {@link runEtfs}.
+ *
+ * Three field semantics are worth knowing before you write a filter, because
+ * guessing them wrong produces a screen that looks fine and means nothing:
+ *
+ * - **`ANALYST_RATING_MEAN` is inverted.** It is the vendor's 1-to-5 scale
+ *   where `1.0` is strong buy, so bullish is `LTE 2.5`, not `GTE`. Prefer
+ *   `ANALYST_BUY_RATIO_PCT`, which runs the intuitive direction.
+ * - **`MA_CROSS_STATE` is ordinal**, not a percentage: `1` golden cross (50-day
+ *   above 200-day), `-1` death cross, `0` neither. Use `EQ`.
+ * - **`SENTIMENT_DIRECTION` is the sign of the 7-day SentiSense Score**
+ *   (`1` / `0` / `-1`) with a neutral band of plus-or-minus 5. Despite the name
+ *   it is not sentiment polarity, and `0` matches only an exact zero, so it
+ *   returns almost nothing.
+ *
+ * The Score fields (`SENTI_SCORE_7D`, `SENTI_SCORE_1M`, `SCORE_CHANGE_7D`) are
+ * the SentiSense Score, not polarity: unbounded, banded at 5 / 13 / 23 either
+ * side of zero. Filter on those band edges, not on values like `0.5`, which
+ * behave as "any positive score".
+ *
+ * Nulls never match, in either direction: `RETURN_1Y >= 0` and `RETURN_1Y < 0`
+ * do not partition the universe, because a stock listed four months ago is in
+ * neither result. If a screen returns fewer rows than you expect, check
+ * coverage before you check your thresholds.
+ *
+ * Screens read a snapshot that refreshes every 20 minutes, so this is not a
+ * quote feed. Use `client.stocks.getQuote()` for live prices.
+ */
+declare class Screener {
+    private client;
+    constructor(client: APIClient);
+    /**
+     * Every filterable field, with its unit, operators and description, for both
+     * universes.
+     *
+     * Build a filter UI from this rather than hardcoding the list and you inherit
+     * new fields as they ship. The ETF `STRING` fields (`ISSUER`, `ASSET_CLASS`,
+     * `TRACKED_INDEX`) come back with their `values` populated from the live
+     * universe, so pickers stay current without a redeploy.
+     */
+    fields(): Promise<ScreenerFieldCatalog>;
+    /**
+     * The curated screens shipped in the product, each with a runnable plan.
+     *
+     * Each `plan` round-trips straight into {@link run} (or {@link runEtfs} when
+     * `plan.universe === "ETF"`) with nothing to rebuild.
+     *
+     * Their filters identify the field with `field` rather than `fieldName`.
+     * Both keys are accepted on the way in, so read either when inspecting a plan
+     * you did not build yourself.
+     */
+    screens(): Promise<ScreenerScreensResponse>;
+    /**
+     * Run a screen against the stock universe.
+     *
+     * `tickers` is optional: omit it to screen the whole tracked universe, pass a
+     * list to screen a watchlist. `limit` sits next to the plan rather than
+     * inside it, because a plan is a stored object and paging is a transport
+     * concern; it defaults to 100 and caps at 500.
+     *
+     * Read `matched` before you read `results`: it is the count before `limit`
+     * was applied, so a `matched` above your `limit` means you are holding the
+     * top slice under the plan's sort, not the whole answer.
+     *
+     * @example
+     * ```ts
+     * const res = await client.screener.run({
+     *   plan: {
+     *     filters: [
+     *       { fieldName: "SENTI_SCORE_7D", op: "GTE", value: 13 },
+     *       { fieldName: "ANALYST_BUY_RATIO_PCT", op: "LTE", value: 30 },
+     *       { fieldName: "ANALYST_COUNT", op: "GTE", value: 5 },
+     *     ],
+     *     sort: { fieldName: "SENTI_SCORE_7D", dir: "DESC" },
+     *   },
+     *   limit: 25,
+     * });
+     * ```
+     */
+    run(options: ScreenerExecuteOptions): Promise<ScreenerExecuteResponse>;
+    /**
+     * Run a screen against the ETF universe.
+     *
+     * Same request shape as {@link run}, against a different field vocabulary:
+     * take the ETF names from `fields().etf`. `IN` / `NOT_IN` take a `values`
+     * array instead of `value` and are the operators for the string fields
+     * (`ISSUER`, `ASSET_CLASS`, `TRACKED_INDEX`).
+     *
+     * `CONSTITUENTS_WEIGHTED_SENTISENSE` is the holdings-weighted SentiSense
+     * Score across what the fund owns and is usually the one you want;
+     * `DIRECT_SENTISENSE` is the Score from chatter about the fund ticker itself,
+     * which on a broad index fund is mostly macro noise. `WEIGHT_COVERED_PCT`
+     * tells you how much of the fund's weight had constituent data behind the
+     * weighted number.
+     */
+    runEtfs(options: ScreenerExecuteOptions): Promise<EtfScreenerExecuteResponse>;
+}
+
 declare class Stocks {
     private client;
     constructor(client: APIClient);
@@ -2048,6 +2605,8 @@ declare class SentiSense implements APIClient {
     readonly indexes: Indexes;
     readonly trackers: Trackers;
     readonly calendar: Calendar;
+    readonly earnings: Earnings;
+    readonly screener: Screener;
     constructor(options?: SentiSenseOptions);
     /** @internal */
     get<T = unknown>(path: string, params?: object): Promise<T>;
@@ -2093,6 +2652,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.35.0";
+declare const VERSION = "0.38.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 EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfSentimentAggregate, type EtfSentimentReading, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticiansOptions, 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 PoliticianDetail, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, 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 GetPoliticianActivityOptions, 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 PoliticianDetail, 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 };