sentisense 0.69.0 → 0.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2305,6 +2305,18 @@ interface EarningsEvent {
2305
2305
  confirmed: boolean;
2306
2306
  /** Consensus EPS estimate, nullable. */
2307
2307
  estimatedEps: number | null;
2308
+ /** Consensus revenue estimate, nullable. */
2309
+ estimatedRevenue?: number | null;
2310
+ /** Reported EPS; null until the company reports. */
2311
+ actualEps?: number | null;
2312
+ /** Reported revenue; null until the company reports. */
2313
+ actualRevenue?: number | null;
2314
+ /** EPS surprise in percent, (actual - estimate) / abs(estimate) * 100; null if either side is missing or the estimate is 0. */
2315
+ epsSurprisePct?: number | null;
2316
+ /** Revenue surprise in percent, same formula as epsSurprisePct. */
2317
+ revenueSurprisePct?: number | null;
2318
+ /** Basis of actualEps against the company's filed GAAP EPS for the quarter; null until the company reports. */
2319
+ epsBasis?: "gaap" | "adjusted" | "unknown" | null;
2308
2320
  }
2309
2321
  interface CalendarMeta {
2310
2322
  /** When the snapshot was generated, epoch seconds. */
@@ -2679,7 +2691,30 @@ type MetricType = "mentions" | "sentiment" | "sentisense_score"
2679
2691
  * The SentiSense Rating score, 0 to 100. Time series only: it has no source
2680
2692
  * breakdown, so `getDistribution` answers with an empty distribution for it.
2681
2693
  */
2682
- | "sentisense_rating" | "social_dominance" | "creators";
2694
+ | "sentisense_rating" | "social_dominance" | "creators"
2695
+ /**
2696
+ * New written Apple App Store reviews per day, for a product entity with a tracked app (an
2697
+ * entity slug such as `"Instagram"`, not a ticker). Written reviews are a small share of all
2698
+ * ratings; `app_all_ratings_count` counts every rating. Count metric: read the point's `value`.
2699
+ */
2700
+ | "app_review_count"
2701
+ /**
2702
+ * Average stars, 1.0 to 5.0, of that day's new written App Store reviews, which skew lower
2703
+ * than all ratings (`app_all_ratings_avg`). Product entities with a tracked app only.
2704
+ */
2705
+ | "app_rating"
2706
+ /**
2707
+ * All new App Store ratings that day, star-only and written together. Absent on days with no
2708
+ * net new ratings or when the store's totals fell. Product entities with a tracked app only.
2709
+ * Count metric: read the point's `value`.
2710
+ */
2711
+ | "app_all_ratings_count"
2712
+ /**
2713
+ * Average stars, 1.0 to 5.0, of the ratings counted in `app_all_ratings_count`; absent on the
2714
+ * same days. Over a range, weight each day by `app_all_ratings_count` for the period average.
2715
+ * Product entities with a tracked app only.
2716
+ */
2717
+ | "app_all_ratings_avg";
2683
2718
  /** Options for `EntityMetrics.getMetrics()`. */
2684
2719
  interface MetricsOptions {
2685
2720
  /** Metric to retrieve. Defaults to `"sentiment"`. */
@@ -4134,7 +4169,10 @@ declare class EntityMetrics {
4134
4169
  *
4135
4170
  * @param symbol Ticker symbol (e.g. "AAPL") or entity urlSlug (e.g. "Nancy-Pelosi",
4136
4171
  * case-insensitive; discover slugs via stocks.getEntities()).
4137
- * @param options Metric type and optional time range / resolution.
4172
+ * @param options Metric type and optional time range / resolution. The App Store metrics
4173
+ * (`app_review_count`, `app_rating`, `app_all_ratings_count`,
4174
+ * `app_all_ratings_avg`) apply to product entities with a tracked app, so pass
4175
+ * an entity slug such as "Instagram", not a ticker.
4138
4176
  */
4139
4177
  getMetrics(symbol: string, options?: MetricsOptions): Promise<ServingMetric[]>;
4140
4178
  /**
@@ -5289,6 +5327,6 @@ declare class APIError extends SentiSenseError {
5289
5327
  constructor(message: string, status: number, code?: string);
5290
5328
  }
5291
5329
 
5292
- declare const VERSION = "0.69.0";
5330
+ declare const VERSION = "0.71.0";
5293
5331
 
5294
5332
  export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type 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 GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionDetail, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
package/dist/index.d.ts CHANGED
@@ -2305,6 +2305,18 @@ interface EarningsEvent {
2305
2305
  confirmed: boolean;
2306
2306
  /** Consensus EPS estimate, nullable. */
2307
2307
  estimatedEps: number | null;
2308
+ /** Consensus revenue estimate, nullable. */
2309
+ estimatedRevenue?: number | null;
2310
+ /** Reported EPS; null until the company reports. */
2311
+ actualEps?: number | null;
2312
+ /** Reported revenue; null until the company reports. */
2313
+ actualRevenue?: number | null;
2314
+ /** EPS surprise in percent, (actual - estimate) / abs(estimate) * 100; null if either side is missing or the estimate is 0. */
2315
+ epsSurprisePct?: number | null;
2316
+ /** Revenue surprise in percent, same formula as epsSurprisePct. */
2317
+ revenueSurprisePct?: number | null;
2318
+ /** Basis of actualEps against the company's filed GAAP EPS for the quarter; null until the company reports. */
2319
+ epsBasis?: "gaap" | "adjusted" | "unknown" | null;
2308
2320
  }
2309
2321
  interface CalendarMeta {
2310
2322
  /** When the snapshot was generated, epoch seconds. */
@@ -2679,7 +2691,30 @@ type MetricType = "mentions" | "sentiment" | "sentisense_score"
2679
2691
  * The SentiSense Rating score, 0 to 100. Time series only: it has no source
2680
2692
  * breakdown, so `getDistribution` answers with an empty distribution for it.
2681
2693
  */
2682
- | "sentisense_rating" | "social_dominance" | "creators";
2694
+ | "sentisense_rating" | "social_dominance" | "creators"
2695
+ /**
2696
+ * New written Apple App Store reviews per day, for a product entity with a tracked app (an
2697
+ * entity slug such as `"Instagram"`, not a ticker). Written reviews are a small share of all
2698
+ * ratings; `app_all_ratings_count` counts every rating. Count metric: read the point's `value`.
2699
+ */
2700
+ | "app_review_count"
2701
+ /**
2702
+ * Average stars, 1.0 to 5.0, of that day's new written App Store reviews, which skew lower
2703
+ * than all ratings (`app_all_ratings_avg`). Product entities with a tracked app only.
2704
+ */
2705
+ | "app_rating"
2706
+ /**
2707
+ * All new App Store ratings that day, star-only and written together. Absent on days with no
2708
+ * net new ratings or when the store's totals fell. Product entities with a tracked app only.
2709
+ * Count metric: read the point's `value`.
2710
+ */
2711
+ | "app_all_ratings_count"
2712
+ /**
2713
+ * Average stars, 1.0 to 5.0, of the ratings counted in `app_all_ratings_count`; absent on the
2714
+ * same days. Over a range, weight each day by `app_all_ratings_count` for the period average.
2715
+ * Product entities with a tracked app only.
2716
+ */
2717
+ | "app_all_ratings_avg";
2683
2718
  /** Options for `EntityMetrics.getMetrics()`. */
2684
2719
  interface MetricsOptions {
2685
2720
  /** Metric to retrieve. Defaults to `"sentiment"`. */
@@ -4134,7 +4169,10 @@ declare class EntityMetrics {
4134
4169
  *
4135
4170
  * @param symbol Ticker symbol (e.g. "AAPL") or entity urlSlug (e.g. "Nancy-Pelosi",
4136
4171
  * case-insensitive; discover slugs via stocks.getEntities()).
4137
- * @param options Metric type and optional time range / resolution.
4172
+ * @param options Metric type and optional time range / resolution. The App Store metrics
4173
+ * (`app_review_count`, `app_rating`, `app_all_ratings_count`,
4174
+ * `app_all_ratings_avg`) apply to product entities with a tracked app, so pass
4175
+ * an entity slug such as "Instagram", not a ticker.
4138
4176
  */
4139
4177
  getMetrics(symbol: string, options?: MetricsOptions): Promise<ServingMetric[]>;
4140
4178
  /**
@@ -5289,6 +5327,6 @@ declare class APIError extends SentiSenseError {
5289
5327
  constructor(message: string, status: number, code?: string);
5290
5328
  }
5291
5329
 
5292
- declare const VERSION = "0.69.0";
5330
+ declare const VERSION = "0.71.0";
5293
5331
 
5294
5332
  export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type 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 GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionDetail, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type 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 CHANGED
@@ -399,7 +399,10 @@ var EntityMetrics = class {
399
399
  *
400
400
  * @param symbol Ticker symbol (e.g. "AAPL") or entity urlSlug (e.g. "Nancy-Pelosi",
401
401
  * case-insensitive; discover slugs via stocks.getEntities()).
402
- * @param options Metric type and optional time range / resolution.
402
+ * @param options Metric type and optional time range / resolution. The App Store metrics
403
+ * (`app_review_count`, `app_rating`, `app_all_ratings_count`,
404
+ * `app_all_ratings_avg`) apply to product entities with a tracked app, so pass
405
+ * an entity slug such as "Instagram", not a ticker.
403
406
  */
404
407
  async getMetrics(symbol, options = {}) {
405
408
  const { metricType = "sentiment", startTime, endTime, maxDataPoints } = options;
@@ -1437,7 +1440,7 @@ var Trackers = class {
1437
1440
  };
1438
1441
 
1439
1442
  // src/version.ts
1440
- var VERSION = "0.69.0";
1443
+ var VERSION = "0.71.0";
1441
1444
 
1442
1445
  // src/client.ts
1443
1446
  var DEFAULT_BASE_URL = "https://app.sentisense.ai";