sentisense 0.57.0 → 0.58.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
@@ -274,6 +274,18 @@ interface ChartDataPoint {
274
274
  * `null` for daily / weekly bars (3M and longer) that span whole sessions.
275
275
  */
276
276
  session?: "pre" | "regular" | "post" | null;
277
+ /**
278
+ * True when the bar is restated to the stock's current share count rather than served as it
279
+ * printed at the time. Always true on this endpoint.
280
+ *
281
+ * A stock that has split since a bar was printed would otherwise show that bar on a different
282
+ * basis from the current one, so both prices and volume are converted to current shares. The
283
+ * practical consequence is on `volume`: for a stock with a large cumulative split factor, older
284
+ * bars can report share counts many times the raw prints of the day, which is the restatement
285
+ * and not an error. Prices through `5Y` are split-adjusted; `10Y` and `MAX` are split- and
286
+ * dividend-adjusted.
287
+ */
288
+ adjusted?: boolean;
277
289
  }
278
290
  interface ChartData {
279
291
  ticker: string;
@@ -284,6 +296,22 @@ interface MarketStatus {
284
296
  status: string;
285
297
  [key: string]: unknown;
286
298
  }
299
+ /**
300
+ * How one period's EPS was restated to the current share basis, on the rows that carry it.
301
+ *
302
+ * Reproduce the original figure by dividing the served value by `multiplier`.
303
+ */
304
+ interface EpsBasisRepair {
305
+ /** Which EPS fields on the row were restated, in the order `epsBasic`, `epsDiluted`, `eps`. */
306
+ fields: string[];
307
+ /** Restated value divided by the value the provider reported: `0.25` for a 4-for-1 split. */
308
+ multiplier: number;
309
+ /**
310
+ * Execution dates of the splits the provider had not applied to this row's EPS, newest first,
311
+ * as `YYYY-MM-DD`.
312
+ */
313
+ splitExecutionDates: string[];
314
+ }
287
315
  /**
288
316
  * One period of filed financial statement data from `stocks.getFundamentals()`.
289
317
  *
@@ -332,6 +360,26 @@ interface Fundamentals {
332
360
  epsBasic?: number | null;
333
361
  /** Diluted earnings per share. `null` when the provider reports no diluted figure. */
334
362
  epsDiluted?: number | null;
363
+ /**
364
+ * Present when this row's EPS was restated, and `null` on almost every row.
365
+ *
366
+ * Per-period EPS is served as the provider reports it, and is restated for a small list of
367
+ * named issuers and nowhere else. A provider that restates a company's share counts for a
368
+ * split but leaves some older rows' EPS on the pre-split basis produces rows that contradict
369
+ * themselves; where that has been checked against the company's own filing, the EPS on the
370
+ * affected rows is divided by the split ratio so it agrees with the share count beside it.
371
+ * Share counts and net income are never changed.
372
+ *
373
+ * `null` means no EPS repair was applied to this row. It does NOT mean the row's EPS and share
374
+ * count are known to be on the same basis: an unlisted issuer, a row whose figures did not
375
+ * qualify, and a row whose split history could not be read all carry `null`.
376
+ *
377
+ * This marker describes per-period EPS only. The repair never changes `epsTTM` or the other
378
+ * trailing-twelve-month figures, and the marker never describes a trailing adjustment: those are
379
+ * assembled separately, and whether they carry a split adjustment of their own depends on which
380
+ * source served them.
381
+ */
382
+ epsBasisRepair?: EpsBasisRepair | null;
335
383
  /**
336
384
  * The provider's bottom-line income line, which can differ from `netIncome` in size and in
337
385
  * sign. Published as the provider states it; it is not promised to reconcile with either EPS
@@ -4155,6 +4203,6 @@ declare class APIError extends SentiSenseError {
4155
4203
  constructor(message: string, status: number, code?: string);
4156
4204
  }
4157
4205
 
4158
- declare const VERSION = "0.57.0";
4206
+ declare const VERSION = "0.58.0";
4159
4207
 
4160
4208
  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 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, 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 };
package/dist/index.d.ts CHANGED
@@ -274,6 +274,18 @@ interface ChartDataPoint {
274
274
  * `null` for daily / weekly bars (3M and longer) that span whole sessions.
275
275
  */
276
276
  session?: "pre" | "regular" | "post" | null;
277
+ /**
278
+ * True when the bar is restated to the stock's current share count rather than served as it
279
+ * printed at the time. Always true on this endpoint.
280
+ *
281
+ * A stock that has split since a bar was printed would otherwise show that bar on a different
282
+ * basis from the current one, so both prices and volume are converted to current shares. The
283
+ * practical consequence is on `volume`: for a stock with a large cumulative split factor, older
284
+ * bars can report share counts many times the raw prints of the day, which is the restatement
285
+ * and not an error. Prices through `5Y` are split-adjusted; `10Y` and `MAX` are split- and
286
+ * dividend-adjusted.
287
+ */
288
+ adjusted?: boolean;
277
289
  }
278
290
  interface ChartData {
279
291
  ticker: string;
@@ -284,6 +296,22 @@ interface MarketStatus {
284
296
  status: string;
285
297
  [key: string]: unknown;
286
298
  }
299
+ /**
300
+ * How one period's EPS was restated to the current share basis, on the rows that carry it.
301
+ *
302
+ * Reproduce the original figure by dividing the served value by `multiplier`.
303
+ */
304
+ interface EpsBasisRepair {
305
+ /** Which EPS fields on the row were restated, in the order `epsBasic`, `epsDiluted`, `eps`. */
306
+ fields: string[];
307
+ /** Restated value divided by the value the provider reported: `0.25` for a 4-for-1 split. */
308
+ multiplier: number;
309
+ /**
310
+ * Execution dates of the splits the provider had not applied to this row's EPS, newest first,
311
+ * as `YYYY-MM-DD`.
312
+ */
313
+ splitExecutionDates: string[];
314
+ }
287
315
  /**
288
316
  * One period of filed financial statement data from `stocks.getFundamentals()`.
289
317
  *
@@ -332,6 +360,26 @@ interface Fundamentals {
332
360
  epsBasic?: number | null;
333
361
  /** Diluted earnings per share. `null` when the provider reports no diluted figure. */
334
362
  epsDiluted?: number | null;
363
+ /**
364
+ * Present when this row's EPS was restated, and `null` on almost every row.
365
+ *
366
+ * Per-period EPS is served as the provider reports it, and is restated for a small list of
367
+ * named issuers and nowhere else. A provider that restates a company's share counts for a
368
+ * split but leaves some older rows' EPS on the pre-split basis produces rows that contradict
369
+ * themselves; where that has been checked against the company's own filing, the EPS on the
370
+ * affected rows is divided by the split ratio so it agrees with the share count beside it.
371
+ * Share counts and net income are never changed.
372
+ *
373
+ * `null` means no EPS repair was applied to this row. It does NOT mean the row's EPS and share
374
+ * count are known to be on the same basis: an unlisted issuer, a row whose figures did not
375
+ * qualify, and a row whose split history could not be read all carry `null`.
376
+ *
377
+ * This marker describes per-period EPS only. The repair never changes `epsTTM` or the other
378
+ * trailing-twelve-month figures, and the marker never describes a trailing adjustment: those are
379
+ * assembled separately, and whether they carry a split adjustment of their own depends on which
380
+ * source served them.
381
+ */
382
+ epsBasisRepair?: EpsBasisRepair | null;
335
383
  /**
336
384
  * The provider's bottom-line income line, which can differ from `netIncome` in size and in
337
385
  * sign. Published as the provider states it; it is not promised to reconcile with either EPS
@@ -4155,6 +4203,6 @@ declare class APIError extends SentiSenseError {
4155
4203
  constructor(message: string, status: number, code?: string);
4156
4204
  }
4157
4205
 
4158
- declare const VERSION = "0.57.0";
4206
+ declare const VERSION = "0.58.0";
4159
4207
 
4160
4208
  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 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, 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 };
package/dist/index.mjs CHANGED
@@ -1311,7 +1311,7 @@ var Trackers = class {
1311
1311
  };
1312
1312
 
1313
1313
  // src/version.ts
1314
- var VERSION = "0.57.0";
1314
+ var VERSION = "0.58.0";
1315
1315
 
1316
1316
  // src/client.ts
1317
1317
  var DEFAULT_BASE_URL = "https://app.sentisense.ai";