sentisense 0.61.0 → 0.62.0

package/dist/index.d.ts

@@ -191,12 +191,120 @@ interface StockProfile {
     imageUrl?: string | null;
     [key: string]: unknown;
 }
+/**
+ * A knowledge-base entity related to a stock (a person, product, partner and so on), as
+ * returned by `stocks.getEntities()`.
+ *
+ * Address the entity by `urlSlug` (the handle the metric and document endpoints take) and
+ * label it with `displayName`.
+ */
 interface StockEntity {
+    /**
+     * Entity id as sent by the API.
+     * @deprecated Not a stable public identifier. Use `urlSlug` to refer to an entity.
+     */
+    id: string;
+    /** Human-readable name, e.g. `"Tim Cook"`. */
+    displayName: string;
+    /** Entity type, e.g. `"PERSON"`, `"COMPANY"`, `"PRODUCT_OR_SERVICE"`. */
+    type: string;
+    /** Ticker of the stock this entity is related to. */
+    relatedStock?: string | null;
+    /** Handle the metric and document endpoints address this entity by. `null` when it has none. */
+    urlSlug?: string | null;
+    /** A person's title, e.g. `"Executive Chairman"`. `null` for non-people. */
+    title?: string | null;
+    /** A product's category. `null` for non-products. */
+    category?: string | null;
+    /** Icon image URL, or `null` when none is assigned. */
+    iconUrl?: string | null;
+    /** App Store id when the product has a tracked companion app. Omitted otherwise. */
+    appId?: string | null;
+    /** @deprecated Never sent by the API. To refer to the entity, use `urlSlug`. */
     entityId: string;
+    /** @deprecated Never sent by the API; read `displayName`. */
     name: string;
-    type: string;
     [key: string]: unknown;
 }
+/** Options for `stocks.getGraph()`. */
+interface GetStockGraphOptions {
+    /** Hops from the stock's own company node: `1` (default) or `2`. */
+    depth?: 1 | 2;
+    /** Maximum nodes in the response, 1 to 200. Omitted, the API uses 75. */
+    cap?: number;
+}
+/** One node in a {@link StockGraph}. Every identifier in the graph is a `slug`. */
+interface GraphNode {
+    /** Handle for this entity, the same one the metric and document endpoints take. */
+    slug: string;
+    displayName: string;
+    /** `"COMPANY"`, `"PERSON"`, `"PRODUCT_OR_SERVICE"`, `"ORGANIZATION"`, `"PUBLISHER"`, `"TOPIC"`, ... */
+    type: string;
+}
+/** One typed relationship in a {@link StockGraph}, between two node slugs. */
+interface GraphEdge {
+    /** Slug of the node the relationship starts from. */
+    source: string;
+    /** Slug of the node the relationship points to. */
+    target: string;
+    /** Relationship type, e.g. `"LEADS"`, `"FOUNDED"`, `"PRODUCT_OF"`, `"VARIANT_OF"`, `"PEER"`. */
+    type: string;
+    /** `"DIRECTED"` (source to target) or `"BIDIRECTIONAL"` (for example peers). */
+    direction: string;
+    /**
+     * Extra facts about the relationship, all values as strings. Keys depend on the edge
+     * type, for example `role` and `since` on `LEADS`, `year` on `FOUNDED`. Empty when the
+     * edge carries none.
+     */
+    properties: Record<string, string>;
+}
+/** A product family and the slugs of its member products. */
+interface GraphProductFamily {
+    /** Family name, e.g. `"iPhone"`. */
+    family: string;
+    /** Slugs of the products in the family. */
+    members: string[];
+}
+/** Node slugs in a {@link StockGraph}, grouped by role relative to the stock. */
+interface GraphGroups {
+    people: string[];
+    products: string[];
+    productFamilies: GraphProductFamily[];
+    /** Peer companies. */
+    peers: string[];
+    organizations: string[];
+    publishers: string[];
+    topics: string[];
+}
+/** Size of a {@link StockGraph}. */
+interface GraphCounts {
+    nodes: number;
+    edges: number;
+    /** Node count per node `type`, e.g. `{ PERSON: 6, PRODUCT_OR_SERVICE: 23 }`. */
+    byType: Record<string, number>;
+}
+/**
+ * The company knowledge graph around one stock, from `GET /api/v1/stocks/{ticker}/graph`:
+ * the people, products, peers and other entities linked to the company, and the typed
+ * relationships between them. Every identifier is a slug.
+ */
+interface StockGraph {
+    ticker: string;
+    /** Slug of the stock's own company node, the graph's starting point. */
+    root: string;
+    /** Depth the graph was walked to (1 or 2). */
+    depth: number;
+    /** Node cap applied to this response. */
+    cap: number;
+    /** True when the cap cut the graph short. */
+    truncated: boolean;
+    /** Nodes left out because they carry no slug. */
+    omitted: number;
+    counts: GraphCounts;
+    groups: GraphGroups;
+    nodes: GraphNode[];
+    edges: GraphEdge[];
+}
 /** Per-source tone for a stock: where the conversation is, and how it leans. */
 interface SentimentSourceTone {
     /** "News", "Reddit", "X", "YouTube", "Substack". */
@@ -446,18 +554,81 @@ interface FundamentalsPeriodsResponse {
     /** Populated when no periods are available, explaining why. */
     reason?: string | null;
 }
+/** One settlement-date reading in {@link ShortInterest}. */
+interface ShortInterestDataPoint {
+    /** Shares sold short and not yet covered as of `settlementDate`. */
+    shortInterest: number | null;
+    /** `shortInterest` divided by `avgDailyVolume`: trading days to cover at average volume. */
+    daysToCover: number | null;
+    /** Average daily trading volume, in shares. */
+    avgDailyVolume: number | null;
+    /** ISO date `"YYYY-MM-DD"` of the settlement this reading is for. */
+    settlementDate: string | null;
+}
+/**
+ * Short interest history from `stocks.getShortInterest()`, newest first. An unknown
+ * ticker returns an empty `dataPoints` array and `count: 0`, not an error.
+ */
 interface ShortInterest {
     ticker: string;
+    dataPoints: ShortInterestDataPoint[];
+    /** Number of entries in `dataPoints`. */
+    count: number;
     [key: string]: unknown;
 }
+/**
+ * Free float from `stocks.getFloat()`. An unknown ticker returns every field other than
+ * `ticker` as `null`, not an error.
+ */
 interface FloatInfo {
     ticker: string;
+    /**
+     * Shares available to trade publicly. `0` means the symbol has no free float, as with
+     * funds such as SPY or QQQ. Shares outstanding is not on this response; read it from
+     * the fundamentals endpoints.
+     */
+    freeFloat: number | null;
+    /** Free float as percentage points of shares outstanding: `92.1` means 92.1%. */
+    freeFloatPercent: number | null;
+    /**
+     * Date the float figure is effective: `"YYYY-MM-DD"` or `"YYYY-MM-DD HH:mm:ss"`
+     * depending on the data source, so parse it leniently.
+     */
+    effectiveDate: string | null;
     [key: string]: unknown;
 }
+/** One trading day in {@link ShortVolume}. */
+interface ShortVolumeDataPoint {
+    /** Shares sold short that day on the reporting venues. */
+    shortVolume: number | null;
+    /** Total shares traded that day on the same reporting venues, not consolidated volume. */
+    totalVolume: number | null;
+    /** `shortVolume` as percentage points of `totalVolume`: `41.04` means 41.04%. */
+    shortVolumeRatio: number | null;
+    /** ISO date `"YYYY-MM-DD"` of the trading day. */
+    date: string | null;
+}
+/**
+ * Daily short volume from `stocks.getShortVolume()`, newest first. An unknown ticker
+ * returns an empty `dataPoints` array and `count: 0`, not an error.
+ */
 interface ShortVolume {
     ticker: string;
+    dataPoints: ShortVolumeDataPoint[];
+    /** Number of entries in `dataPoints`. */
+    count: number;
     [key: string]: unknown;
 }
+/** Options for `stocks.getShortInterest()`. */
+interface GetShortInterestOptions {
+    /** Settlement dates to return. Omitted, the API returns 24. */
+    limit?: number;
+}
+/** Options for `stocks.getShortVolume()`. */
+interface GetShortVolumeOptions {
+    /** Trading days to return. Omitted, the API returns 90. */
+    limit?: number;
+}
 interface MetricsBreakdown {
     [key: string]: unknown;
 }
@@ -2286,8 +2457,35 @@ interface KpiTypeEntry {
     category: string;
     chartType: string;
 }
+/**
+ * A knowledge-base entity, as returned by `kb.getPopularEntities()`. Address it by
+ * `urlSlug` and label it with `displayName`.
+ */
 interface KBEntity {
+    /**
+     * Entity id as sent by the API.
+     * @deprecated Not a stable public identifier. Use `urlSlug` to refer to an entity.
+     */
+    id: string;
+    /** Human-readable name, e.g. `"Elon Musk"`. */
+    displayName: string;
+    /** Entity type, e.g. `"PERSON"`, `"COMPANY"`, `"PRODUCT_OR_SERVICE"`. */
+    type: string;
+    /** Ticker of the stock this entity is most closely related to, when it has one. */
+    relatedStock?: string | null;
+    /** Handle the metric and document endpoints address this entity by. `null` when it has none. */
+    urlSlug?: string | null;
+    /** A person's title. `null` for non-people. */
+    title?: string | null;
+    /** A product's category. `null` for non-products. */
+    category?: string | null;
+    /** Icon image URL, or `null` when none is assigned. */
+    iconUrl?: string | null;
+    /** App Store id when the product has a tracked companion app. Omitted otherwise. */
+    appId?: string | null;
+    /** @deprecated Never sent by the API. To refer to the entity, use `urlSlug`. */
     entityId: string;
+    /** @deprecated Never sent by the API; read `displayName`. */
     name: string;
     [key: string]: unknown;
 }
@@ -2928,12 +3126,42 @@ interface AnalystAction {
     fromGrade: string | null;
     toGrade: string | null;
 }
+/** Which forward period an {@link AnalystEstimate} covers. */
+type AnalystEstimatePeriodType = "CURRENT_QUARTER" | "NEXT_QUARTER" | "CURRENT_YEAR" | "NEXT_YEAR";
+/** Consensus EPS estimate for one forward period. */
 interface AnalystEstimate {
-    /** Fiscal period descriptor (provider-specific shape). */
+    /**
+     * Period label as sent by the API: usually a date such as `"2026-10-29"` for the
+     * current quarter (a relative code such as `"0q"` when no date is known yet), a
+     * relative code such as `"+1q"`, `"0y"` or `"+1y"` otherwise. Use
+     * `periodType` to tell periods apart.
+     */
+    periodLabel: string | null;
+    periodType: AnalystEstimatePeriodType | null;
+    /** Lowest analyst EPS estimate for the period. */
+    estimateLow: number | null;
+    /** Mean analyst EPS estimate for the period. */
+    estimateMean: number | null;
+    /** Highest analyst EPS estimate for the period. */
+    estimateHigh: number | null;
+    /** Analysts contributing to the estimate. */
+    numberOfAnalysts: number | null;
     [key: string]: unknown;
 }
+/** Reported EPS against the consensus estimate for one past report. */
 interface AnalystEarningsSurprise {
-    /** Past report descriptor (provider-specific shape). */
+    /** Period label as sent by the API, e.g. `"2026-07-30"`. */
+    periodLabel: string | null;
+    /** ISO date `"YYYY-MM-DD"` the results were reported. */
+    reportDate: string | null;
+    /** Consensus EPS estimate going into the report. */
+    estimateEps: number | null;
+    /** Reported EPS. */
+    actualEps: number | null;
+    /**
+     * As sent by the API: a fraction rounded to 2 decimals (0.07 = 7%), despite the name.
+     */
+    surprisePercent: number | null;
     [key: string]: unknown;
 }
 interface AnalystEstimatesResponse {
@@ -2956,6 +3184,15 @@ interface GetAnalystMarketActivityOptions {
     /** Days of history to return. Default 30. */
     lookbackDays?: number;
 }
+/** A named analyst, as referenced from a note. */
+interface AnalystRef {
+    /**
+     * Addresses `analyst.profile(slug)` and `analyst.calls(slug)`. `null` when we hold no
+     * profile for the named analyst; the `name` is still returned.
+     */
+    slug: string | null;
+    name: string;
+}
 /** One price target note. */
 interface AnalystNote {
     /** ISO date the note was published, `"YYYY-MM-DD"`. */
@@ -2964,7 +3201,7 @@ interface AnalystNote {
      * The individual named on the note, or `null` when the report named nobody.
      * Absent means the report did not identify one, never that the note did not happen.
      */
-    analyst: string | null;
+    analyst: AnalystRef | null;
     priceTarget: number | null;
     adjPriceTarget: number | null;
     priceWhenPosted: number | null;
@@ -3431,6 +3668,53 @@ interface EtfInfo {
      */
     imageUrl: string | null;
 }
+/**
+ * Quote snapshot for an ETF from `GET /api/v1/etfs/{ticker}/quote`: the same price-side
+ * fields as the stock quote, with fund facts (AUM, expense ratio, NAV, inception date) in
+ * place of market cap, P/E and EPS.
+ *
+ * Every field except `ticker` and `timestamp` is left out of the response when unknown
+ * rather than sent as `null`, so check for presence before rendering.
+ */
+interface EtfQuote {
+    ticker: string;
+    /** Regular-session price, delayed. During regular hours: the most recent regular-session value. Otherwise: the most recent regular-session close. */
+    currentPrice?: number | null;
+    change?: number | null;
+    /** Change in percentage points: `-0.21` means -0.21%. */
+    changePercent?: number | null;
+    /** Shares traded in the session. */
+    volume?: number | null;
+    open?: number | null;
+    dayHigh?: number | null;
+    dayLow?: number | null;
+    previousClose?: number | null;
+    week52High?: number | null;
+    week52Low?: number | null;
+    /**
+     * Trailing-12-month dividend yield as a fraction, not percentage points: `0.0099` is a
+     * 0.99% yield.
+     */
+    dividendYield?: number | null;
+    /** Assets under management, in USD. The fund analogue of a stock's market cap. */
+    aum?: number | null;
+    /** Annual expense ratio as a fraction: `0.0009` is 0.09%. */
+    expenseRatio?: number | null;
+    /** Net asset value per share, in USD. */
+    nav?: number | null;
+    /** Fund inception date, ISO `"YYYY-MM-DD"`. */
+    inceptionDate?: string | null;
+    /** Unix timestamp in MILLISECONDS of when this response was served. Not the age of the price. */
+    timestamp: number;
+    /**
+     * Unix timestamp in MILLISECONDS of the market data behind `currentPrice`. Read this for
+     * freshness rather than `timestamp`. Absent when the price cannot be dated, so treat an
+     * absent value as unknown age, not as fresh.
+     */
+    priceAsOf?: number | null;
+    /** Pre-market or after-hours view. Absent during regular hours, overnight and weekends. */
+    extendedHours?: ExtendedHoursInfo | null;
+}
 interface EtfHolding {
     /** The symbol as the issuer filed it. For an international fund this is the local exchange code, not a US ticker, so resolve stocks with `linkedTicker` instead. */
     ticker: string;
@@ -3570,6 +3854,15 @@ declare class Etfs {
      * List every ETF tracked by SentiSense, sorted by ticker.
      */
     list(): Promise<EtfInfo[]>;
+    /**
+     * Get the quote snapshot for an ETF: price, day and 52-week range, volume, dividend
+     * yield, AUM, expense ratio, NAV and inception date.
+     *
+     * Fails with a 400 `APIError` whose `code` is `"ticker_is_not_etf"` when the symbol is a
+     * stock (use `stocks.getQuote()` for those), and a `NotFoundError` when there is no
+     * price data for the fund.
+     */
+    quote(ticker: string): Promise<EtfQuote>;
     /**
      * Get the full holdings composition for an ETF, including per-holding weights
      * and freshness metadata. Returns 404 for unknown ETFs or commodity-only funds.
@@ -4072,6 +4365,16 @@ declare class Stocks {
     getSentiment(ticker: string): Promise<PreviewResponse<StockSentiment>>;
     /** Get related KB entities (people, products, partners). */
     getEntities(ticker: string): Promise<StockEntity[]>;
+    /**
+     * Get the company knowledge graph around a stock: the people, products, peers and other
+     * entities linked to the company, and the typed relationships between them.
+     *
+     * Every identifier in the response is a slug, the same handle the metric and document
+     * endpoints take, so a node can be passed straight to them. `depth` is 1 (default) or 2,
+     * `cap` limits the node count (1 to 200, default 75); out-of-range values are rejected
+     * with a 400. A ticker with no graph returns a `NotFoundError`.
+     */
+    getGraph(ticker: string, options?: GetStockGraphOptions): Promise<StockGraph>;
     /**
      * Get AI-generated stock analysis report. Requires PRO tier.
      *
@@ -4110,12 +4413,18 @@ declare class Stocks {
     getCurrentFundamentals(ticker: string): Promise<TtmFundamentals>;
     /** Get historical revenue data. */
     getHistoricalRevenue(ticker: string): Promise<unknown>;
-    /** Get short interest metrics (FINRA). */
-    getShortInterest(ticker: string): Promise<ShortInterest>;
+    /**
+     * Get short interest history (FINRA), newest first: shares short, days to cover and
+     * average daily volume per settlement date. `limit` defaults to 24 settlement dates.
+     */
+    getShortInterest(ticker: string, options?: GetShortInterestOptions): Promise<ShortInterest>;
     /** Get float information. */
     getFloat(ticker: string): Promise<FloatInfo>;
-    /** Get short volume trading data. */
-    getShortVolume(ticker: string): Promise<ShortVolume>;
+    /**
+     * Get daily short volume, newest first: shares sold short against total volume on the
+     * reporting venues. `limit` defaults to 90 trading days.
+     */
+    getShortVolume(ticker: string, options?: GetShortVolumeOptions): Promise<ShortVolume>;
     /**
      * Get company-specific KPI time-series for a ticker. Returns curated GAAP and
      * non-GAAP metrics from earnings filings (e.g. iPhone unit sales, Tesla deliveries,
@@ -4395,6 +4704,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.61.0";
+declare const VERSION = "0.62.0";
 
-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 AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, 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 EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, 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 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 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 ShortVolume, type SimilarStock, type StockDetail, type StockEntity, 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 };
+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 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 };

package/dist/index.mjs

@@ -440,6 +440,19 @@ var Etfs = class {
   async list() {
     return this.client.get("/api/v1/etfs");
   }
+  /**
+   * Get the quote snapshot for an ETF: price, day and 52-week range, volume, dividend
+   * yield, AUM, expense ratio, NAV and inception date.
+   *
+   * Fails with a 400 `APIError` whose `code` is `"ticker_is_not_etf"` when the symbol is a
+   * stock (use `stocks.getQuote()` for those), and a `NotFoundError` when there is no
+   * price data for the fund.
+   */
+  async quote(ticker) {
+    return this.client.get(
+      `/api/v1/etfs/${encodeURIComponent(ticker.toUpperCase())}/quote`
+    );
+  }
   /**
    * Get the full holdings composition for an ETF, including per-holding weights
    * and freshness metadata. Returns 404 for unknown ETFs or commodity-only funds.
@@ -1034,6 +1047,21 @@ var Stocks = class {
   async getEntities(ticker) {
     return this.client.get(`/api/v1/stocks/${encodeURIComponent(ticker)}/entities`);
   }
+  /**
+   * Get the company knowledge graph around a stock: the people, products, peers and other
+   * entities linked to the company, and the typed relationships between them.
+   *
+   * Every identifier in the response is a slug, the same handle the metric and document
+   * endpoints take, so a node can be passed straight to them. `depth` is 1 (default) or 2,
+   * `cap` limits the node count (1 to 200, default 75); out-of-range values are rejected
+   * with a 400. A ticker with no graph returns a `NotFoundError`.
+   */
+  async getGraph(ticker, options) {
+    return this.client.get(
+      `/api/v1/stocks/${encodeURIComponent(ticker.toUpperCase())}/graph`,
+      options
+    );
+  }
   /**
    * Get AI-generated stock analysis report. Requires PRO tier.
    *
@@ -1096,17 +1124,23 @@ var Stocks = class {
   async getHistoricalRevenue(ticker) {
     return this.client.get("/api/v1/stocks/fundamentals/historical/revenue", { ticker });
   }
-  /** Get short interest metrics (FINRA). */
-  async getShortInterest(ticker) {
-    return this.client.get("/api/v1/stocks/short-interest", { ticker });
+  /**
+   * Get short interest history (FINRA), newest first: shares short, days to cover and
+   * average daily volume per settlement date. `limit` defaults to 24 settlement dates.
+   */
+  async getShortInterest(ticker, options) {
+    return this.client.get("/api/v1/stocks/short-interest", { ticker, ...options });
   }
   /** Get float information. */
   async getFloat(ticker) {
     return this.client.get("/api/v1/stocks/float", { ticker });
   }
-  /** Get short volume trading data. */
-  async getShortVolume(ticker) {
-    return this.client.get("/api/v1/stocks/short-volume", { ticker });
+  /**
+   * Get daily short volume, newest first: shares sold short against total volume on the
+   * reporting venues. `limit` defaults to 90 trading days.
+   */
+  async getShortVolume(ticker, options) {
+    return this.client.get("/api/v1/stocks/short-volume", { ticker, ...options });
   }
   /**
    * Get company-specific KPI time-series for a ticker. Returns curated GAAP and
@@ -1318,7 +1352,7 @@ var Trackers = class {
 };
 
 // src/version.ts
-var VERSION = "0.61.0";
+var VERSION = "0.62.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://app.sentisense.ai";