sentisense 0.55.0 → 0.57.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/README.md +1 -0
- package/dist/cli.cjs +12 -1
- package/dist/index.cjs +12 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +66 -3
- package/dist/index.d.ts +66 -3
- package/dist/index.mjs +12 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -325,6 +325,45 @@ interface Fundamentals {
|
|
|
325
325
|
* securities portfolio is wrong by billions and can flip the sign.
|
|
326
326
|
*/
|
|
327
327
|
freeCashFlow?: number | null;
|
|
328
|
+
/**
|
|
329
|
+
* Basic earnings per share. Always the basic figure, on every data source, unlike `eps`,
|
|
330
|
+
* whose basis depends on which source served the row.
|
|
331
|
+
*/
|
|
332
|
+
epsBasic?: number | null;
|
|
333
|
+
/** Diluted earnings per share. `null` when the provider reports no diluted figure. */
|
|
334
|
+
epsDiluted?: number | null;
|
|
335
|
+
/**
|
|
336
|
+
* The provider's bottom-line income line, which can differ from `netIncome` in size and in
|
|
337
|
+
* sign. Published as the provider states it; it is not promised to reconcile with either EPS
|
|
338
|
+
* field, and neither is `netIncome`.
|
|
339
|
+
*/
|
|
340
|
+
bottomLineNetIncome?: number | null;
|
|
341
|
+
/**
|
|
342
|
+
* Basic weighted-average shares for the period. An average ACROSS the period, not a count at
|
|
343
|
+
* period end, so it is not a correct input to a market capitalisation or a book value per
|
|
344
|
+
* share. `null` when the provider reports none.
|
|
345
|
+
*/
|
|
346
|
+
weightedAverageSharesBasic?: number | null;
|
|
347
|
+
/**
|
|
348
|
+
* Diluted weighted-average shares for the period. Same caveat as the basic count: it is an
|
|
349
|
+
* average across the period, not a period-end count. `null` when the provider reports none.
|
|
350
|
+
*/
|
|
351
|
+
weightedAverageSharesDiluted?: number | null;
|
|
352
|
+
/**
|
|
353
|
+
* @deprecated Stops being populated on 2026-12-15. Despite the name this is never a
|
|
354
|
+
* period-end shares-outstanding count, and it means different things on different rows: a
|
|
355
|
+
* diluted weighted average, a basic weighted average where no diluted figure exists, or an
|
|
356
|
+
* estimate derived from market capitalisation. It is being retired rather than redefined
|
|
357
|
+
* because no single definition would be true of every row it has already served.
|
|
358
|
+
*
|
|
359
|
+
* Use `weightedAverageSharesDiluted` or `weightedAverageSharesBasic`, and handle `null`,
|
|
360
|
+
* which now means the provider did not report that count instead of silently substituting
|
|
361
|
+
* the other one. Reading `weightedAverageSharesDiluted` and falling back to
|
|
362
|
+
* `weightedAverageSharesBasic` when null reproduces the statement-history form of the old
|
|
363
|
+
* field, which is what most callers were reading; it does not reproduce the rows that
|
|
364
|
+
* carried no value, nor the market-capitalisation-derived estimate on the latest snapshot.
|
|
365
|
+
*/
|
|
366
|
+
sharesOutstanding?: number | null;
|
|
328
367
|
[key: string]: unknown;
|
|
329
368
|
}
|
|
330
369
|
/**
|
|
@@ -1012,6 +1051,18 @@ interface GetStoriesOptions {
|
|
|
1012
1051
|
/** Look-back window in hours, for example 48 for the last two days. */
|
|
1013
1052
|
filterHours?: number;
|
|
1014
1053
|
}
|
|
1054
|
+
interface SearchStoriesOptions {
|
|
1055
|
+
/**
|
|
1056
|
+
* Free text, for example `fed decision` or `kb/company/1 guidance`. Explicit entity ids are
|
|
1057
|
+
* read first, then entities recognised in the text, then the remaining words as keywords that
|
|
1058
|
+
* must all appear in the story's own title or summary. A blank query is rejected with a 400.
|
|
1059
|
+
*/
|
|
1060
|
+
query: string;
|
|
1061
|
+
/** Look-back window in days, 1 to 30, defaulting to 7. Stories older than 30 days are archived and not searchable. */
|
|
1062
|
+
days?: number;
|
|
1063
|
+
/** Maximum number of stories, defaulting to 20 and capped at 50. */
|
|
1064
|
+
limit?: number;
|
|
1065
|
+
}
|
|
1015
1066
|
interface GetStoriesByTickerOptions {
|
|
1016
1067
|
limit?: number;
|
|
1017
1068
|
}
|
|
@@ -1495,7 +1546,10 @@ interface GetEarningsCalendarOptions {
|
|
|
1495
1546
|
from?: string;
|
|
1496
1547
|
/** Inclusive upper date bound, ISO "YYYY-MM-DD". */
|
|
1497
1548
|
to?: string;
|
|
1498
|
-
/**
|
|
1549
|
+
/**
|
|
1550
|
+
* Two-sided. `true` returns only company-confirmed dates, `false` returns only
|
|
1551
|
+
* the still-estimated ones. Omit it to get both.
|
|
1552
|
+
*/
|
|
1499
1553
|
confirmed?: boolean;
|
|
1500
1554
|
/** Session filter. */
|
|
1501
1555
|
time?: "before_open" | "after_close" | "during_market" | "unknown";
|
|
@@ -3004,6 +3058,15 @@ declare class Documents {
|
|
|
3004
3058
|
* exported for that array.
|
|
3005
3059
|
*/
|
|
3006
3060
|
getStoryDetail(clusterId: string): Promise<unknown>;
|
|
3061
|
+
/**
|
|
3062
|
+
* Free-text search across the AI-curated stories, newest first.
|
|
3063
|
+
*
|
|
3064
|
+
* The query is parsed like {@link Documents.search}: explicit entity ids first, then entities
|
|
3065
|
+
* recognised in the text, then the remaining words as keywords that must all appear in the
|
|
3066
|
+
* story's own title or summary. The rows are the same {@link Story} shape {@link
|
|
3067
|
+
* Documents.getStories} returns, so an `id` can go straight to {@link Documents.getStoryDetail}.
|
|
3068
|
+
*/
|
|
3069
|
+
searchStories(options: SearchStoriesOptions): Promise<Story[]>;
|
|
3007
3070
|
/** Get stories for a specific stock. */
|
|
3008
3071
|
getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
|
|
3009
3072
|
}
|
|
@@ -4092,6 +4155,6 @@ declare class APIError extends SentiSenseError {
|
|
|
4092
4155
|
constructor(message: string, status: number, code?: string);
|
|
4093
4156
|
}
|
|
4094
4157
|
|
|
4095
|
-
declare const VERSION = "0.
|
|
4158
|
+
declare const VERSION = "0.57.0";
|
|
4096
4159
|
|
|
4097
|
-
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, 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 };
|
|
4160
|
+
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
|
@@ -325,6 +325,45 @@ interface Fundamentals {
|
|
|
325
325
|
* securities portfolio is wrong by billions and can flip the sign.
|
|
326
326
|
*/
|
|
327
327
|
freeCashFlow?: number | null;
|
|
328
|
+
/**
|
|
329
|
+
* Basic earnings per share. Always the basic figure, on every data source, unlike `eps`,
|
|
330
|
+
* whose basis depends on which source served the row.
|
|
331
|
+
*/
|
|
332
|
+
epsBasic?: number | null;
|
|
333
|
+
/** Diluted earnings per share. `null` when the provider reports no diluted figure. */
|
|
334
|
+
epsDiluted?: number | null;
|
|
335
|
+
/**
|
|
336
|
+
* The provider's bottom-line income line, which can differ from `netIncome` in size and in
|
|
337
|
+
* sign. Published as the provider states it; it is not promised to reconcile with either EPS
|
|
338
|
+
* field, and neither is `netIncome`.
|
|
339
|
+
*/
|
|
340
|
+
bottomLineNetIncome?: number | null;
|
|
341
|
+
/**
|
|
342
|
+
* Basic weighted-average shares for the period. An average ACROSS the period, not a count at
|
|
343
|
+
* period end, so it is not a correct input to a market capitalisation or a book value per
|
|
344
|
+
* share. `null` when the provider reports none.
|
|
345
|
+
*/
|
|
346
|
+
weightedAverageSharesBasic?: number | null;
|
|
347
|
+
/**
|
|
348
|
+
* Diluted weighted-average shares for the period. Same caveat as the basic count: it is an
|
|
349
|
+
* average across the period, not a period-end count. `null` when the provider reports none.
|
|
350
|
+
*/
|
|
351
|
+
weightedAverageSharesDiluted?: number | null;
|
|
352
|
+
/**
|
|
353
|
+
* @deprecated Stops being populated on 2026-12-15. Despite the name this is never a
|
|
354
|
+
* period-end shares-outstanding count, and it means different things on different rows: a
|
|
355
|
+
* diluted weighted average, a basic weighted average where no diluted figure exists, or an
|
|
356
|
+
* estimate derived from market capitalisation. It is being retired rather than redefined
|
|
357
|
+
* because no single definition would be true of every row it has already served.
|
|
358
|
+
*
|
|
359
|
+
* Use `weightedAverageSharesDiluted` or `weightedAverageSharesBasic`, and handle `null`,
|
|
360
|
+
* which now means the provider did not report that count instead of silently substituting
|
|
361
|
+
* the other one. Reading `weightedAverageSharesDiluted` and falling back to
|
|
362
|
+
* `weightedAverageSharesBasic` when null reproduces the statement-history form of the old
|
|
363
|
+
* field, which is what most callers were reading; it does not reproduce the rows that
|
|
364
|
+
* carried no value, nor the market-capitalisation-derived estimate on the latest snapshot.
|
|
365
|
+
*/
|
|
366
|
+
sharesOutstanding?: number | null;
|
|
328
367
|
[key: string]: unknown;
|
|
329
368
|
}
|
|
330
369
|
/**
|
|
@@ -1012,6 +1051,18 @@ interface GetStoriesOptions {
|
|
|
1012
1051
|
/** Look-back window in hours, for example 48 for the last two days. */
|
|
1013
1052
|
filterHours?: number;
|
|
1014
1053
|
}
|
|
1054
|
+
interface SearchStoriesOptions {
|
|
1055
|
+
/**
|
|
1056
|
+
* Free text, for example `fed decision` or `kb/company/1 guidance`. Explicit entity ids are
|
|
1057
|
+
* read first, then entities recognised in the text, then the remaining words as keywords that
|
|
1058
|
+
* must all appear in the story's own title or summary. A blank query is rejected with a 400.
|
|
1059
|
+
*/
|
|
1060
|
+
query: string;
|
|
1061
|
+
/** Look-back window in days, 1 to 30, defaulting to 7. Stories older than 30 days are archived and not searchable. */
|
|
1062
|
+
days?: number;
|
|
1063
|
+
/** Maximum number of stories, defaulting to 20 and capped at 50. */
|
|
1064
|
+
limit?: number;
|
|
1065
|
+
}
|
|
1015
1066
|
interface GetStoriesByTickerOptions {
|
|
1016
1067
|
limit?: number;
|
|
1017
1068
|
}
|
|
@@ -1495,7 +1546,10 @@ interface GetEarningsCalendarOptions {
|
|
|
1495
1546
|
from?: string;
|
|
1496
1547
|
/** Inclusive upper date bound, ISO "YYYY-MM-DD". */
|
|
1497
1548
|
to?: string;
|
|
1498
|
-
/**
|
|
1549
|
+
/**
|
|
1550
|
+
* Two-sided. `true` returns only company-confirmed dates, `false` returns only
|
|
1551
|
+
* the still-estimated ones. Omit it to get both.
|
|
1552
|
+
*/
|
|
1499
1553
|
confirmed?: boolean;
|
|
1500
1554
|
/** Session filter. */
|
|
1501
1555
|
time?: "before_open" | "after_close" | "during_market" | "unknown";
|
|
@@ -3004,6 +3058,15 @@ declare class Documents {
|
|
|
3004
3058
|
* exported for that array.
|
|
3005
3059
|
*/
|
|
3006
3060
|
getStoryDetail(clusterId: string): Promise<unknown>;
|
|
3061
|
+
/**
|
|
3062
|
+
* Free-text search across the AI-curated stories, newest first.
|
|
3063
|
+
*
|
|
3064
|
+
* The query is parsed like {@link Documents.search}: explicit entity ids first, then entities
|
|
3065
|
+
* recognised in the text, then the remaining words as keywords that must all appear in the
|
|
3066
|
+
* story's own title or summary. The rows are the same {@link Story} shape {@link
|
|
3067
|
+
* Documents.getStories} returns, so an `id` can go straight to {@link Documents.getStoryDetail}.
|
|
3068
|
+
*/
|
|
3069
|
+
searchStories(options: SearchStoriesOptions): Promise<Story[]>;
|
|
3007
3070
|
/** Get stories for a specific stock. */
|
|
3008
3071
|
getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
|
|
3009
3072
|
}
|
|
@@ -4092,6 +4155,6 @@ declare class APIError extends SentiSenseError {
|
|
|
4092
4155
|
constructor(message: string, status: number, code?: string);
|
|
4093
4156
|
}
|
|
4094
4157
|
|
|
4095
|
-
declare const VERSION = "0.
|
|
4158
|
+
declare const VERSION = "0.57.0";
|
|
4096
4159
|
|
|
4097
|
-
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, 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 };
|
|
4160
|
+
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
|
@@ -271,6 +271,17 @@ var Documents = class {
|
|
|
271
271
|
async getStoryDetail(clusterId) {
|
|
272
272
|
return this.client.get(`/api/v1/documents/stories/${encodeURIComponent(clusterId)}`);
|
|
273
273
|
}
|
|
274
|
+
/**
|
|
275
|
+
* Free-text search across the AI-curated stories, newest first.
|
|
276
|
+
*
|
|
277
|
+
* The query is parsed like {@link Documents.search}: explicit entity ids first, then entities
|
|
278
|
+
* recognised in the text, then the remaining words as keywords that must all appear in the
|
|
279
|
+
* story's own title or summary. The rows are the same {@link Story} shape {@link
|
|
280
|
+
* Documents.getStories} returns, so an `id` can go straight to {@link Documents.getStoryDetail}.
|
|
281
|
+
*/
|
|
282
|
+
async searchStories(options) {
|
|
283
|
+
return this.client.get("/api/v1/documents/stories/search", options);
|
|
284
|
+
}
|
|
274
285
|
/** Get stories for a specific stock. */
|
|
275
286
|
async getStoriesByTicker(ticker, options) {
|
|
276
287
|
return this.client.get(
|
|
@@ -1300,7 +1311,7 @@ var Trackers = class {
|
|
|
1300
1311
|
};
|
|
1301
1312
|
|
|
1302
1313
|
// src/version.ts
|
|
1303
|
-
var VERSION = "0.
|
|
1314
|
+
var VERSION = "0.57.0";
|
|
1304
1315
|
|
|
1305
1316
|
// src/client.ts
|
|
1306
1317
|
var DEFAULT_BASE_URL = "https://app.sentisense.ai";
|