sentisense 0.54.0 → 0.56.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 +9 -4
- package/dist/cli.cjs +102 -6
- package/dist/index.cjs +104 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +394 -4
- package/dist/index.d.ts +394 -4
- package/dist/index.mjs +103 -6
- 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
|
/**
|
|
@@ -1495,7 +1534,10 @@ interface GetEarningsCalendarOptions {
|
|
|
1495
1534
|
from?: string;
|
|
1496
1535
|
/** Inclusive upper date bound, ISO "YYYY-MM-DD". */
|
|
1497
1536
|
to?: string;
|
|
1498
|
-
/**
|
|
1537
|
+
/**
|
|
1538
|
+
* Two-sided. `true` returns only company-confirmed dates, `false` returns only
|
|
1539
|
+
* the still-estimated ones. Omit it to get both.
|
|
1540
|
+
*/
|
|
1499
1541
|
confirmed?: boolean;
|
|
1500
1542
|
/** Session filter. */
|
|
1501
1543
|
time?: "before_open" | "after_close" | "during_market" | "unknown";
|
|
@@ -1591,6 +1633,169 @@ interface RecentEarningsEntry {
|
|
|
1591
1633
|
/** Latest content written for this quarter, epoch seconds. */
|
|
1592
1634
|
generatedAt: number;
|
|
1593
1635
|
}
|
|
1636
|
+
/** One measured session move following an earnings announcement. */
|
|
1637
|
+
interface EarningsReaction {
|
|
1638
|
+
/** Date the results were announced, ISO calendar day `"YYYY-MM-DD"`. */
|
|
1639
|
+
reportDate: string;
|
|
1640
|
+
/** Always present. `null` means the reacting session was inferred. */
|
|
1641
|
+
timing: "AMC" | "BMO" | null;
|
|
1642
|
+
/** Close immediately before the reaction session. */
|
|
1643
|
+
priorClose: number;
|
|
1644
|
+
/** Close of the reaction session. */
|
|
1645
|
+
nextClose: number;
|
|
1646
|
+
/** Signed percent change from `priorClose` to `nextClose`. */
|
|
1647
|
+
movePct: number;
|
|
1648
|
+
}
|
|
1649
|
+
/** Up to twelve measured earnings reactions for one ticker, newest first. */
|
|
1650
|
+
interface EarningsReactionsResponse {
|
|
1651
|
+
ticker: string;
|
|
1652
|
+
/** Date the response was produced, ISO calendar day `"YYYY-MM-DD"`. */
|
|
1653
|
+
asOf: string;
|
|
1654
|
+
reactions: EarningsReaction[];
|
|
1655
|
+
}
|
|
1656
|
+
/** Calendar span covered by an earnings-statistics block. */
|
|
1657
|
+
interface EarningsStatisticsWindow {
|
|
1658
|
+
/** Stable cache key for this span. */
|
|
1659
|
+
key: string;
|
|
1660
|
+
kind: string;
|
|
1661
|
+
/** Inclusive first day, ISO `"YYYY-MM-DD"`. */
|
|
1662
|
+
startDate: string;
|
|
1663
|
+
/** Inclusive last day, ISO `"YYYY-MM-DD"`. */
|
|
1664
|
+
endDate: string;
|
|
1665
|
+
}
|
|
1666
|
+
/** Counts, rates, and measured moves for one earnings outcome. */
|
|
1667
|
+
interface EarningsOutcomeStatistics {
|
|
1668
|
+
count: number;
|
|
1669
|
+
/** `count` divided by all classified events; `null` when the denominator is zero. */
|
|
1670
|
+
rate: number | null;
|
|
1671
|
+
withReaction: number;
|
|
1672
|
+
fell: number;
|
|
1673
|
+
rose: number;
|
|
1674
|
+
flat: number;
|
|
1675
|
+
/** `fell` divided by `withReaction`; `null` when the denominator is zero. */
|
|
1676
|
+
fellRate: number | null;
|
|
1677
|
+
/** Mean signed session move as a percent, or `null` when no move is available. */
|
|
1678
|
+
averageMovePct: number | null;
|
|
1679
|
+
}
|
|
1680
|
+
/** Trailing comparison span for an earnings-statistics window. */
|
|
1681
|
+
interface EarningsStatisticsBaseline {
|
|
1682
|
+
window: EarningsStatisticsWindow;
|
|
1683
|
+
classifiedEvents: number;
|
|
1684
|
+
completedReactions: number;
|
|
1685
|
+
distinctTickers: number;
|
|
1686
|
+
beatRate: number | null;
|
|
1687
|
+
beatsFellRate: number | null;
|
|
1688
|
+
coverageRatio: number | null;
|
|
1689
|
+
sufficientData: boolean;
|
|
1690
|
+
}
|
|
1691
|
+
/** Signed differences from the trailing baseline. */
|
|
1692
|
+
interface EarningsStatisticsDeviation {
|
|
1693
|
+
beatRate: number | null;
|
|
1694
|
+
beatsFellRate: number | null;
|
|
1695
|
+
beatRateIsMaterial: boolean;
|
|
1696
|
+
beatsFellRateIsMaterial: boolean;
|
|
1697
|
+
}
|
|
1698
|
+
/** Publication and materiality thresholds used for the statistics. */
|
|
1699
|
+
interface EarningsStatisticsThresholds {
|
|
1700
|
+
minClassifiedEvents: number;
|
|
1701
|
+
minCoverageRatio: number;
|
|
1702
|
+
baselineWeeks: number;
|
|
1703
|
+
beatRateDeviation: number;
|
|
1704
|
+
reactionDivergence: number;
|
|
1705
|
+
}
|
|
1706
|
+
/** Market-wide earnings outcomes and their realized price reactions. */
|
|
1707
|
+
interface EarningsStatistics {
|
|
1708
|
+
calculationVersion: string;
|
|
1709
|
+
/** When the figures were computed, epoch seconds. */
|
|
1710
|
+
asOf: number;
|
|
1711
|
+
window: EarningsStatisticsWindow;
|
|
1712
|
+
eventsInWindow: number;
|
|
1713
|
+
classifiedEvents: number;
|
|
1714
|
+
unclassifiedEvents: number;
|
|
1715
|
+
distinctTickers: number;
|
|
1716
|
+
completedReactions: number;
|
|
1717
|
+
pendingReactions: number;
|
|
1718
|
+
/** Completed reactions divided by classified events. */
|
|
1719
|
+
coverageRatio: number | null;
|
|
1720
|
+
sufficientData: boolean;
|
|
1721
|
+
/** Absent when `sufficientData` is true. */
|
|
1722
|
+
insufficientDataReason?: "SAMPLE_BELOW_FLOOR" | "COVERAGE_BELOW_FLOOR";
|
|
1723
|
+
beat: EarningsOutcomeStatistics;
|
|
1724
|
+
miss: EarningsOutcomeStatistics;
|
|
1725
|
+
inline: EarningsOutcomeStatistics;
|
|
1726
|
+
/** Mean signed session move as a percent, or `null` when no move is available. */
|
|
1727
|
+
averageMovePct: number | null;
|
|
1728
|
+
/** Absent on `trailing_52w` and `all_time`. */
|
|
1729
|
+
baseline?: EarningsStatisticsBaseline;
|
|
1730
|
+
/** Absent when there is no baseline. */
|
|
1731
|
+
deviation?: EarningsStatisticsDeviation;
|
|
1732
|
+
thresholds: EarningsStatisticsThresholds;
|
|
1733
|
+
}
|
|
1734
|
+
/** One recently reported company in the earnings ranking. */
|
|
1735
|
+
interface RankedReportedEarnings {
|
|
1736
|
+
ticker: string;
|
|
1737
|
+
/** ISO calendar day `"YYYY-MM-DD"`. */
|
|
1738
|
+
reportDate: string;
|
|
1739
|
+
fiscalPeriod?: string;
|
|
1740
|
+
headline?: string;
|
|
1741
|
+
hasTranscriptSummary?: boolean;
|
|
1742
|
+
estimateEps?: number;
|
|
1743
|
+
actualEps?: number;
|
|
1744
|
+
/** Signed percent. */
|
|
1745
|
+
surprisePct?: number;
|
|
1746
|
+
outcome: "BEAT" | "MISS" | "INLINE" | "UNCLASSIFIED";
|
|
1747
|
+
/** Signed percent of the reacting session. */
|
|
1748
|
+
movePct?: number;
|
|
1749
|
+
reactionPending?: boolean;
|
|
1750
|
+
/** Signed percent, present only while the reacting session is trading. */
|
|
1751
|
+
liveReactionPct?: number;
|
|
1752
|
+
awaitingConsensus?: boolean;
|
|
1753
|
+
/** US dollars. */
|
|
1754
|
+
marketCap?: number;
|
|
1755
|
+
/** 7-day average SentiSense Score. Signed and unbounded. */
|
|
1756
|
+
sentisenseScore7d?: number;
|
|
1757
|
+
/** 7-day average Score minus the 30-day average, in signed score units. Positive means strengthening. */
|
|
1758
|
+
scoreChange7d?: number;
|
|
1759
|
+
/** Ranking importance from 0 to 1. */
|
|
1760
|
+
importance: number;
|
|
1761
|
+
}
|
|
1762
|
+
/** One upcoming company in the earnings ranking. */
|
|
1763
|
+
interface RankedUpcomingEarnings {
|
|
1764
|
+
ticker: string;
|
|
1765
|
+
companyName: string;
|
|
1766
|
+
/** ISO calendar day `"YYYY-MM-DD"`. */
|
|
1767
|
+
earningsDate: string;
|
|
1768
|
+
earningsTime: "before_open" | "after_close" | "during_market" | "unknown";
|
|
1769
|
+
confirmed: boolean;
|
|
1770
|
+
estimatedEps?: number;
|
|
1771
|
+
/** US dollars. */
|
|
1772
|
+
marketCap?: number;
|
|
1773
|
+
/** 7-day average SentiSense Score. Signed and unbounded. */
|
|
1774
|
+
sentisenseScore7d?: number;
|
|
1775
|
+
/** 7-day average Score minus the 30-day average, in signed score units. Positive means strengthening. */
|
|
1776
|
+
scoreChange7d?: number;
|
|
1777
|
+
/** Ranking importance from 0 to 1. */
|
|
1778
|
+
importance: number;
|
|
1779
|
+
}
|
|
1780
|
+
/** A ranked earnings window and the rows returned for it. */
|
|
1781
|
+
interface RankedEarningsSection<T> {
|
|
1782
|
+
/** Inclusive first day, ISO `"YYYY-MM-DD"`. */
|
|
1783
|
+
windowStart: string;
|
|
1784
|
+
/** Inclusive last day, ISO `"YYYY-MM-DD"`. */
|
|
1785
|
+
windowEnd: string;
|
|
1786
|
+
/** Full event count before tier or limit truncation. */
|
|
1787
|
+
totalInWindow: number;
|
|
1788
|
+
rows: T[];
|
|
1789
|
+
}
|
|
1790
|
+
/** Recently reported and upcoming earnings ranked by importance. */
|
|
1791
|
+
interface RankedEarnings {
|
|
1792
|
+
/** When the ranking was computed, epoch seconds. */
|
|
1793
|
+
asOf: number;
|
|
1794
|
+
/** Revision of the ordering rules. */
|
|
1795
|
+
rankingVersion: string;
|
|
1796
|
+
reported: RankedEarningsSection<RankedReportedEarnings>;
|
|
1797
|
+
upcoming: RankedEarningsSection<RankedUpcomingEarnings>;
|
|
1798
|
+
}
|
|
1594
1799
|
interface GetEarningsSummariesOptions {
|
|
1595
1800
|
/**
|
|
1596
1801
|
* Max quarters returned, 1 to 40. Omitted, the API applies its own default
|
|
@@ -1604,6 +1809,20 @@ interface GetRecentEarningsOptions {
|
|
|
1604
1809
|
/** Max rows returned, 1 to 100. Omitted, the API applies its own default of 50. */
|
|
1605
1810
|
limit?: number;
|
|
1606
1811
|
}
|
|
1812
|
+
interface GetEarningsStatisticsOptions {
|
|
1813
|
+
/** Statistics window. Omitted, the API uses `last_completed_week`. */
|
|
1814
|
+
window?: "last_completed_week" | "week_to_date" | "trailing_52w" | "all_time";
|
|
1815
|
+
}
|
|
1816
|
+
interface GetRankedEarningsOptions {
|
|
1817
|
+
/** Reported look-back window, 1 to 31. Omitted, the API uses 14. */
|
|
1818
|
+
reportedDays?: number;
|
|
1819
|
+
/** Maximum reported rows, 1 to 50. Omitted, the API uses 12. */
|
|
1820
|
+
reportedLimit?: number;
|
|
1821
|
+
/** Upcoming window, 1 to 31. Omitted, the API uses 7. */
|
|
1822
|
+
upcomingDays?: number;
|
|
1823
|
+
/** Maximum upcoming rows, 1 to 50. Omitted, the API uses 12. */
|
|
1824
|
+
upcomingLimit?: number;
|
|
1825
|
+
}
|
|
1607
1826
|
/**
|
|
1608
1827
|
* What lifts the gate on a preview response, in a form you can show a user directly.
|
|
1609
1828
|
*
|
|
@@ -2374,6 +2593,92 @@ interface AnalystConsensus {
|
|
|
2374
2593
|
strongSell: number;
|
|
2375
2594
|
updatedAt: string | null;
|
|
2376
2595
|
}
|
|
2596
|
+
/** One daily observation of the analyst consensus, as observed on `snapshotDate`. */
|
|
2597
|
+
interface AnalystConsensusHistoryPoint {
|
|
2598
|
+
/** Market-calendar date of the observation, `"YYYY-MM-DD"`. */
|
|
2599
|
+
snapshotDate: string;
|
|
2600
|
+
/** UTC observation instant, formatted as ISO-8601 with whole seconds. */
|
|
2601
|
+
observedAt: string;
|
|
2602
|
+
/** UTC observation instant in epoch seconds. */
|
|
2603
|
+
observedAtEpoch: number;
|
|
2604
|
+
source: string;
|
|
2605
|
+
/**
|
|
2606
|
+
* `false` when the vendor panel did not come back that day and the distribution
|
|
2607
|
+
* counts are carried forward.
|
|
2608
|
+
*/
|
|
2609
|
+
countsObserved: boolean;
|
|
2610
|
+
currentPrice: number | null;
|
|
2611
|
+
targetLow: number | null;
|
|
2612
|
+
targetMean: number | null;
|
|
2613
|
+
/** `null` in a free preview. */
|
|
2614
|
+
targetMedian: number | null;
|
|
2615
|
+
targetHigh: number | null;
|
|
2616
|
+
numberOfAnalysts: number;
|
|
2617
|
+
upsidePercent: number | null;
|
|
2618
|
+
/** `null` in a free preview. */
|
|
2619
|
+
recommendationMean: number | null;
|
|
2620
|
+
/** `null` in a free preview. */
|
|
2621
|
+
strongBuy: number | null;
|
|
2622
|
+
/** `null` in a free preview. */
|
|
2623
|
+
buy: number | null;
|
|
2624
|
+
/** `null` in a free preview. */
|
|
2625
|
+
hold: number | null;
|
|
2626
|
+
/** `null` in a free preview. */
|
|
2627
|
+
sell: number | null;
|
|
2628
|
+
/** `null` in a free preview. */
|
|
2629
|
+
strongSell: number | null;
|
|
2630
|
+
consensusLabel: string | null;
|
|
2631
|
+
}
|
|
2632
|
+
interface AnalystConsensusHistory {
|
|
2633
|
+
ticker: string;
|
|
2634
|
+
/** Inclusive first date of the served window, `"YYYY-MM-DD"`. */
|
|
2635
|
+
from: string;
|
|
2636
|
+
/** Inclusive last date of the served window, `"YYYY-MM-DD"`. */
|
|
2637
|
+
to: string;
|
|
2638
|
+
/** Rows returned after the limit and any free-preview clipping. */
|
|
2639
|
+
count: number;
|
|
2640
|
+
/** Daily observations ordered by `snapshotDate` ascending. */
|
|
2641
|
+
history: AnalystConsensusHistoryPoint[];
|
|
2642
|
+
}
|
|
2643
|
+
/** One recorded call associated with a stock move. */
|
|
2644
|
+
interface AnalystCalledItCall {
|
|
2645
|
+
firm: string;
|
|
2646
|
+
/** Always present; `null` when the publisher named nobody. */
|
|
2647
|
+
analystName: string | null;
|
|
2648
|
+
attribution: "firm" | "analyst";
|
|
2649
|
+
priceTarget: number | null;
|
|
2650
|
+
priorPriceTarget: number | null;
|
|
2651
|
+
/** Publication date, `"YYYY-MM-DD"`. */
|
|
2652
|
+
publishedOn: string;
|
|
2653
|
+
daysBeforeMove: number;
|
|
2654
|
+
}
|
|
2655
|
+
/** Factual call history as recorded when a stock moved 20% or more over five sessions. */
|
|
2656
|
+
interface AnalystCalledItMove {
|
|
2657
|
+
insightId: string;
|
|
2658
|
+
/** When the observation was generated, in epoch seconds. */
|
|
2659
|
+
generatedAt: number;
|
|
2660
|
+
/** First session date, `"YYYY-MM-DD"`. */
|
|
2661
|
+
moveStartDate: string;
|
|
2662
|
+
/** Last session date, `"YYYY-MM-DD"`. */
|
|
2663
|
+
moveEndDate: string;
|
|
2664
|
+
movePct: number;
|
|
2665
|
+
moveWindowSessions: number;
|
|
2666
|
+
lookbackDays: number;
|
|
2667
|
+
/** Move-level counts remain intact in a free preview. */
|
|
2668
|
+
coveringFirms: number;
|
|
2669
|
+
revisedWithMove: number;
|
|
2670
|
+
revisedAgainstMove: number;
|
|
2671
|
+
leftUnchanged: number;
|
|
2672
|
+
/** PRO: all recorded calls. FREE: up to five on the newest move. */
|
|
2673
|
+
calls: AnalystCalledItCall[];
|
|
2674
|
+
}
|
|
2675
|
+
interface GetAnalystCalledItOptions {
|
|
2676
|
+
/**
|
|
2677
|
+
* Maximum moves, newest first. Default 10; minimum 1, maximum 50.
|
|
2678
|
+
* The API rejects values below 1 and clamps values above 50.
|
|
2679
|
+
*/
|
|
2680
|
+
limit?: number;
|
|
2681
|
+
}
|
|
2377
2682
|
interface AnalystAction {
|
|
2378
2683
|
ticker: string;
|
|
2379
2684
|
actionDate: string;
|
|
@@ -2399,6 +2704,14 @@ interface GetAnalystActionsOptions {
|
|
|
2399
2704
|
/** Days of history to return. Default 90. */
|
|
2400
2705
|
lookbackDays?: number;
|
|
2401
2706
|
}
|
|
2707
|
+
interface GetAnalystConsensusHistoryOptions {
|
|
2708
|
+
/** First snapshot date, inclusive, as `"YYYY-MM-DD"`. */
|
|
2709
|
+
from?: string;
|
|
2710
|
+
/** Last snapshot date, inclusive, as `"YYYY-MM-DD"`. */
|
|
2711
|
+
to?: string;
|
|
2712
|
+
/** Maximum rows to return, 1 to 366. Omitted, the API uses 90. */
|
|
2713
|
+
limit?: number;
|
|
2714
|
+
}
|
|
2402
2715
|
interface GetAnalystMarketActivityOptions {
|
|
2403
2716
|
/** Days of history to return. Default 30. */
|
|
2404
2717
|
lookbackDays?: number;
|
|
@@ -2583,6 +2896,32 @@ declare class Analyst {
|
|
|
2583
2896
|
* coverage exists.
|
|
2584
2897
|
*/
|
|
2585
2898
|
consensus(ticker: string): Promise<PreviewResponse<AnalystConsensus>>;
|
|
2899
|
+
/**
|
|
2900
|
+
* Get daily consensus observations, ordered by `snapshotDate` ascending.
|
|
2901
|
+
* Each row describes the target fields as observed on that date. When
|
|
2902
|
+
* `countsObserved` is `false`, the vendor panel did not come back that day and the
|
|
2903
|
+
* distribution counts are carried forward.
|
|
2904
|
+
*
|
|
2905
|
+
* A PRO key receives the requested window. A FREE key receives the last 30 days;
|
|
2906
|
+
* `targetMedian`, `recommendationMean`, and the five distribution fields are `null`.
|
|
2907
|
+
* The envelope's `totalCount` still sizes the full requested window.
|
|
2908
|
+
*/
|
|
2909
|
+
consensusHistory(ticker: string, options?: GetAnalystConsensusHistoryOptions): Promise<PreviewResponse<AnalystConsensusHistory>>;
|
|
2910
|
+
/**
|
|
2911
|
+
* Get factual call history as recorded when a stock moved 20% or more over five
|
|
2912
|
+
* sessions, newest move first by `moveEndDate`.
|
|
2913
|
+
*
|
|
2914
|
+
* PRO receives full moves and calls. FREE receives the newest move with up to five
|
|
2915
|
+
* calls and all move-level counts intact. The envelope's `totalCount` counts all
|
|
2916
|
+
* available moves before the limit. A known stock with no qualifying move returns
|
|
2917
|
+
* an empty `moves` array. Each call includes `analystName`: it is `null`, never
|
|
2918
|
+
* absent, when the publisher named nobody.
|
|
2919
|
+
*/
|
|
2920
|
+
calledIt(ticker: string, options?: GetAnalystCalledItOptions): Promise<PreviewResponse<{
|
|
2921
|
+
ticker: string;
|
|
2922
|
+
count: number;
|
|
2923
|
+
moves: AnalystCalledItMove[];
|
|
2924
|
+
}>>;
|
|
2586
2925
|
/**
|
|
2587
2926
|
* Get recent analyst upgrade/downgrade actions for a ticker, newest first.
|
|
2588
2927
|
* Free users receive the 3 most recent.
|
|
@@ -2761,6 +3100,44 @@ declare class Earnings {
|
|
|
2761
3100
|
* forward-looking one.
|
|
2762
3101
|
*/
|
|
2763
3102
|
getRecent(options?: GetRecentEarningsOptions): Promise<PreviewResponse<RecentEarningsEntry[]>>;
|
|
3103
|
+
/**
|
|
3104
|
+
* Measured price reactions to a ticker's last earnings reports, newest first.
|
|
3105
|
+
*
|
|
3106
|
+
* Use this after {@link getRecent} when you need one company's realized
|
|
3107
|
+
* post-report history. `client.calendar.getEarnings()` is the forward-looking
|
|
3108
|
+
* schedule instead. This endpoint returns its payload directly, without a
|
|
3109
|
+
* preview envelope, and every API key receives the full series.
|
|
3110
|
+
*
|
|
3111
|
+
* `timing` is always present on each row and can be `null` when the reacting
|
|
3112
|
+
* session was inferred rather than observed.
|
|
3113
|
+
*/
|
|
3114
|
+
getReactions(ticker: string): Promise<EarningsReactionsResponse>;
|
|
3115
|
+
/**
|
|
3116
|
+
* Market-wide earnings outcomes and realized reaction statistics.
|
|
3117
|
+
*
|
|
3118
|
+
* Use this for aggregate beat, miss, inline, and post-report move rates.
|
|
3119
|
+
* {@link getRecent} returns individual recent reports, while
|
|
3120
|
+
* `client.calendar.getEarnings()` covers upcoming dates. The response uses
|
|
3121
|
+
* the preview envelope, but every API key receives the full body and
|
|
3122
|
+
* `isPreview` is always `false`.
|
|
3123
|
+
*
|
|
3124
|
+
* `baseline` and `deviation` are omitted for long-span windows, and rates can
|
|
3125
|
+
* be `null` when their denominator is zero.
|
|
3126
|
+
*/
|
|
3127
|
+
getStatistics(options?: GetEarningsStatisticsOptions): Promise<PreviewResponse<EarningsStatistics>>;
|
|
3128
|
+
/**
|
|
3129
|
+
* Important recently reported and upcoming earnings in one ranking.
|
|
3130
|
+
*
|
|
3131
|
+
* Use this to prioritize a cross-ticker sweep. Follow reported rows with
|
|
3132
|
+
* {@link getReactions} for realized history; use {@link getRecent} for an
|
|
3133
|
+
* unranked recent feed or `client.calendar.getEarnings()` for the broader
|
|
3134
|
+
* forward schedule.
|
|
3135
|
+
*
|
|
3136
|
+
* A PRO key receives the full ranking. A FREE key receives the first three
|
|
3137
|
+
* rows in each section with `totalInWindow` left intact. Optional row fields
|
|
3138
|
+
* are omitted when null, so check them before use.
|
|
3139
|
+
*/
|
|
3140
|
+
getRanked(options?: GetRankedEarningsOptions): Promise<PreviewResponse<RankedEarnings>>;
|
|
2764
3141
|
}
|
|
2765
3142
|
|
|
2766
3143
|
declare class EntityMetrics {
|
|
@@ -3487,7 +3864,7 @@ declare class Stocks {
|
|
|
3487
3864
|
* the full series. Returns 404 for tickers that do not yet have curated coverage.
|
|
3488
3865
|
*
|
|
3489
3866
|
* Coverage today: near-complete for the S&P 500 plus extended universe
|
|
3490
|
-
* (
|
|
3867
|
+
* (900+ tickers). Use `listKpiCoverage()` to enumerate.
|
|
3491
3868
|
*/
|
|
3492
3869
|
getKpis(ticker: string): Promise<PreviewResponse<CompanyKpisData>>;
|
|
3493
3870
|
/**
|
|
@@ -3740,10 +4117,23 @@ declare class RateLimitError extends SentiSenseError {
|
|
|
3740
4117
|
retryAfter?: number;
|
|
3741
4118
|
constructor(message: string, code?: string, retryAfter?: number);
|
|
3742
4119
|
}
|
|
4120
|
+
declare class TemporarilyUnavailableError extends SentiSenseError {
|
|
4121
|
+
/**
|
|
4122
|
+
* Seconds the server asked us to wait, from its `Retry-After` header on a 503. Unclamped,
|
|
4123
|
+
* because the point of this error is to hand you the server's real figure.
|
|
4124
|
+
*
|
|
4125
|
+
* The client honours short waits automatically, so you normally never see this. It is
|
|
4126
|
+
* thrown only when the requested wait is longer than the client will sleep for, which lets
|
|
4127
|
+
* a batch job keep the results it already has and resume later instead of retrying into a
|
|
4128
|
+
* server that has told you it is not ready.
|
|
4129
|
+
*/
|
|
4130
|
+
retryAfter?: number;
|
|
4131
|
+
constructor(message: string, retryAfter?: number, code?: string);
|
|
4132
|
+
}
|
|
3743
4133
|
declare class APIError extends SentiSenseError {
|
|
3744
4134
|
constructor(message: string, status: number, code?: string);
|
|
3745
4135
|
}
|
|
3746
4136
|
|
|
3747
|
-
declare const VERSION = "0.
|
|
4137
|
+
declare const VERSION = "0.56.0";
|
|
3748
4138
|
|
|
3749
|
-
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, 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 EarningsQuarter, type EarningsSource, 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 GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type 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, 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, 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 };
|
|
4139
|
+
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 };
|