sentisense 0.53.0 → 0.54.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 +19 -4
- package/dist/cli.cjs +2 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +74 -7
- package/dist/index.d.ts +74 -7
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -453,6 +453,26 @@ interface OptionsAggregate {
|
|
|
453
453
|
/** Raw 25-delta call and put implied volatilities. */
|
|
454
454
|
iv25c?: number;
|
|
455
455
|
iv25p?: number;
|
|
456
|
+
/**
|
|
457
|
+
* Calibrated 90% expected move over 1 trading session, as a fraction of price, so `0.0407`
|
|
458
|
+
* is 4.07%. `k * atmIv * Math.sqrt(h / 252)` with an empirical `k` (1.48 here) fit on
|
|
459
|
+
* SentiSense's own stored option history. The 90% is a measured historical coverage rate,
|
|
460
|
+
* not a guarantee, and the range carries no direction and no price target.
|
|
461
|
+
*/
|
|
462
|
+
expectedMove1d?: number;
|
|
463
|
+
/** The same calibrated 90% range over 5 trading sessions (`k` = 1.56). */
|
|
464
|
+
expectedMove5d?: number;
|
|
465
|
+
/** The same calibrated 90% range over 20 trading sessions (`k` = 1.56). */
|
|
466
|
+
expectedMove20d?: number;
|
|
467
|
+
/**
|
|
468
|
+
* One-sigma expected move over 1 trading session, `atmIv * Math.sqrt(h / 252)`: the industry
|
|
469
|
+
* convention, roughly 68% of moves, with no calibration applied.
|
|
470
|
+
*/
|
|
471
|
+
expectedMove1s1d?: number;
|
|
472
|
+
/** One-sigma expected move over 5 trading sessions. */
|
|
473
|
+
expectedMove1s5d?: number;
|
|
474
|
+
/** One-sigma expected move over 20 trading sessions. */
|
|
475
|
+
expectedMove1s20d?: number;
|
|
456
476
|
netDelta?: number;
|
|
457
477
|
notionalVol?: number;
|
|
458
478
|
contracts?: number;
|
|
@@ -600,6 +620,18 @@ interface OptionsOverviewRow {
|
|
|
600
620
|
notionalVol?: number;
|
|
601
621
|
/** Signed change of `atmIv` against its ~20-session mean. Rank "biggest IV moves" by absolute value. */
|
|
602
622
|
ivMove20?: number;
|
|
623
|
+
/** Calibrated 90% expected move over 1 trading session, as a fraction of price. */
|
|
624
|
+
expectedMove1d?: number;
|
|
625
|
+
/** The same calibrated 90% range over 5 trading sessions. */
|
|
626
|
+
expectedMove5d?: number;
|
|
627
|
+
/** The same calibrated 90% range over 20 trading sessions. */
|
|
628
|
+
expectedMove20d?: number;
|
|
629
|
+
/** One-sigma expected move over 1 trading session: the industry convention, uncalibrated. */
|
|
630
|
+
expectedMove1s1d?: number;
|
|
631
|
+
/** One-sigma expected move over 5 trading sessions. */
|
|
632
|
+
expectedMove1s5d?: number;
|
|
633
|
+
/** One-sigma expected move over 20 trading sessions. */
|
|
634
|
+
expectedMove1s20d?: number;
|
|
603
635
|
/** Trailing-1y observation count, which is what drives the building-baseline state. */
|
|
604
636
|
observations1y?: number;
|
|
605
637
|
/** Unusually-active contracts this session. */
|
|
@@ -657,8 +689,8 @@ interface OptionsOverview {
|
|
|
657
689
|
/** Full ETF board size on a FREE response, mirroring what the envelope's `totalCount` does for stocks. */
|
|
658
690
|
etfTotalCount?: number;
|
|
659
691
|
}
|
|
660
|
-
/** The
|
|
661
|
-
type RatingDimensionKey = "crowd" | "smart_money" | "options" | "analysts" | "fundamentals" | "earnings";
|
|
692
|
+
/** The seven dimensions the composite is blended from, by stable `key`. */
|
|
693
|
+
type RatingDimensionKey = "crowd" | "smart_money" | "options" | "analysts" | "fundamentals" | "earnings" | "technicals";
|
|
662
694
|
/**
|
|
663
695
|
* Why a stock has no grade.
|
|
664
696
|
*
|
|
@@ -703,9 +735,9 @@ interface RatingSubLeg {
|
|
|
703
735
|
unit: string;
|
|
704
736
|
}
|
|
705
737
|
/**
|
|
706
|
-
* One of the
|
|
738
|
+
* One of the seven dimensions the composite is blended from.
|
|
707
739
|
*
|
|
708
|
-
* **All
|
|
740
|
+
* **All seven always arrive, in a fixed order, whether or not they had data.** An absent
|
|
709
741
|
* dimension is a full row with `present` false and a `null` percentile; the server never
|
|
710
742
|
* drops it, precisely so a client cannot mistake a gap for a five-dimension rating. Read
|
|
711
743
|
* `present` before reading `percentile`, and never substitute zero for a `null`: zero is the
|
|
@@ -749,7 +781,7 @@ interface RatingBase {
|
|
|
749
781
|
kbEntityId: string;
|
|
750
782
|
/** The New York calendar day this answer describes, `"YYYY-MM-DD"`. */
|
|
751
783
|
asOf: string;
|
|
752
|
-
/** Always all
|
|
784
|
+
/** Always all seven, in a fixed order, absent ones with `present` false. */
|
|
753
785
|
dimensions: RatingDimension[];
|
|
754
786
|
flags: RatingFlag[];
|
|
755
787
|
/** The standard financial disclaimer. Display it alongside the grade. */
|
|
@@ -821,7 +853,7 @@ interface StockNotRated extends RatingBase {
|
|
|
821
853
|
rated: false;
|
|
822
854
|
/** Why there is no grade. */
|
|
823
855
|
reason: RatingNotRatedReason;
|
|
824
|
-
/** How many of the
|
|
856
|
+
/** How many of the seven dimensions had data. */
|
|
825
857
|
dimensionsPresent?: number;
|
|
826
858
|
/** Which dimensions had data, by `key`. */
|
|
827
859
|
presentDimensions: RatingDimensionKey[];
|
|
@@ -1241,6 +1273,8 @@ interface InsiderTrade {
|
|
|
1241
1273
|
transactionCode: string;
|
|
1242
1274
|
transactionType: "BUY" | "SELL" | "EXERCISE" | "AWARD" | "GIFT" | "OTHER";
|
|
1243
1275
|
securityTitle: string;
|
|
1276
|
+
/** The security the row was filed in when it is not the US listing `ticker` names (e.g. "Common Shares (2330.TW)"); null on the ordinary case, and when set `pricePerShare` is null because the filed price is per foreign ordinary share. */
|
|
1277
|
+
securityBasis?: string | null;
|
|
1244
1278
|
sharesTransacted: number;
|
|
1245
1279
|
pricePerShare: number | null;
|
|
1246
1280
|
totalValue: number;
|
|
@@ -1570,9 +1604,33 @@ interface GetRecentEarningsOptions {
|
|
|
1570
1604
|
/** Max rows returned, 1 to 100. Omitted, the API applies its own default of 50. */
|
|
1571
1605
|
limit?: number;
|
|
1572
1606
|
}
|
|
1607
|
+
/**
|
|
1608
|
+
* What lifts the gate on a preview response, in a form you can show a user directly.
|
|
1609
|
+
*
|
|
1610
|
+
* Present only when `isPreview` is `true`. Every field is optional: the copy and the
|
|
1611
|
+
* offer are set server-side and can change without an SDK release, so read what is
|
|
1612
|
+
* there rather than depending on any one field.
|
|
1613
|
+
*/
|
|
1614
|
+
interface UpgradeHint {
|
|
1615
|
+
/** Plan that lifts the gate, e.g. `"PRO"`. */
|
|
1616
|
+
plan?: string;
|
|
1617
|
+
/** One sentence naming what was withheld. Safe to show verbatim. */
|
|
1618
|
+
message?: string;
|
|
1619
|
+
/** Current price, including any active discount code. */
|
|
1620
|
+
price?: string;
|
|
1621
|
+
/** Where to complete the upgrade. */
|
|
1622
|
+
url?: string;
|
|
1623
|
+
/** What an automated caller should do with this object. */
|
|
1624
|
+
relay?: string;
|
|
1625
|
+
}
|
|
1573
1626
|
interface PreviewResponse<T> {
|
|
1574
1627
|
isPreview: boolean;
|
|
1575
1628
|
previewReason: "PRO_REQUIRED" | null;
|
|
1629
|
+
/**
|
|
1630
|
+
* How to lift the gate. Present only on a preview; absent from full responses.
|
|
1631
|
+
* Surface `message` and `url` to your user rather than hard-coding a price.
|
|
1632
|
+
*/
|
|
1633
|
+
upgrade?: UpgradeHint;
|
|
1576
1634
|
/**
|
|
1577
1635
|
* Size of the full result set, before any truncation your response went through.
|
|
1578
1636
|
*
|
|
@@ -1927,6 +1985,8 @@ interface TrackerSnapshotResponse {
|
|
|
1927
1985
|
previewReason: "PRO_REQUIRED" | null;
|
|
1928
1986
|
/** Full row count before truncation. Only set on preview responses. */
|
|
1929
1987
|
totalCount?: number;
|
|
1988
|
+
/** How to lift the gate. Only set on preview responses. */
|
|
1989
|
+
upgrade?: UpgradeHint;
|
|
1930
1990
|
data: TrackerSnapshot;
|
|
1931
1991
|
}
|
|
1932
1992
|
/** Per-index discovery row returned by `client.indexes.list()`. */
|
|
@@ -2740,12 +2800,19 @@ interface EtfInfo {
|
|
|
2740
2800
|
imageUrl: string | null;
|
|
2741
2801
|
}
|
|
2742
2802
|
interface EtfHolding {
|
|
2803
|
+
/** The symbol as the issuer filed it. For an international fund this is the local exchange code, not a US ticker, so resolve stocks with `linkedTicker` instead. */
|
|
2743
2804
|
ticker: string;
|
|
2744
2805
|
name: string | null;
|
|
2745
2806
|
/** Weight in the fund as a percentage (0-100). */
|
|
2746
2807
|
weightPct: number;
|
|
2747
2808
|
/** ISO date "YYYY-MM-DD". First date this holding appeared in the composition. */
|
|
2748
2809
|
firstSeen: string | null;
|
|
2810
|
+
/** Listing venue the issuer reported for this position, verbatim (e.g. "NYSE", "SIX Swiss Exchange"). Null when the source carries no venue column. */
|
|
2811
|
+
exchange?: string | null;
|
|
2812
|
+
/** The symbol as listed on `exchange`. Same value as `ticker`, named to make it clear the symbol is venue-local and may not identify a US company. */
|
|
2813
|
+
localTicker?: string | null;
|
|
2814
|
+
/** The US stock symbol this holding resolves to, or null when it cannot be resolved to one. */
|
|
2815
|
+
linkedTicker?: string | null;
|
|
2749
2816
|
}
|
|
2750
2817
|
interface EtfHoldings {
|
|
2751
2818
|
ticker: string;
|
|
@@ -3677,6 +3744,6 @@ declare class APIError extends SentiSenseError {
|
|
|
3677
3744
|
constructor(message: string, status: number, code?: string);
|
|
3678
3745
|
}
|
|
3679
3746
|
|
|
3680
|
-
declare const VERSION = "0.
|
|
3747
|
+
declare const VERSION = "0.54.0";
|
|
3681
3748
|
|
|
3682
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -453,6 +453,26 @@ interface OptionsAggregate {
|
|
|
453
453
|
/** Raw 25-delta call and put implied volatilities. */
|
|
454
454
|
iv25c?: number;
|
|
455
455
|
iv25p?: number;
|
|
456
|
+
/**
|
|
457
|
+
* Calibrated 90% expected move over 1 trading session, as a fraction of price, so `0.0407`
|
|
458
|
+
* is 4.07%. `k * atmIv * Math.sqrt(h / 252)` with an empirical `k` (1.48 here) fit on
|
|
459
|
+
* SentiSense's own stored option history. The 90% is a measured historical coverage rate,
|
|
460
|
+
* not a guarantee, and the range carries no direction and no price target.
|
|
461
|
+
*/
|
|
462
|
+
expectedMove1d?: number;
|
|
463
|
+
/** The same calibrated 90% range over 5 trading sessions (`k` = 1.56). */
|
|
464
|
+
expectedMove5d?: number;
|
|
465
|
+
/** The same calibrated 90% range over 20 trading sessions (`k` = 1.56). */
|
|
466
|
+
expectedMove20d?: number;
|
|
467
|
+
/**
|
|
468
|
+
* One-sigma expected move over 1 trading session, `atmIv * Math.sqrt(h / 252)`: the industry
|
|
469
|
+
* convention, roughly 68% of moves, with no calibration applied.
|
|
470
|
+
*/
|
|
471
|
+
expectedMove1s1d?: number;
|
|
472
|
+
/** One-sigma expected move over 5 trading sessions. */
|
|
473
|
+
expectedMove1s5d?: number;
|
|
474
|
+
/** One-sigma expected move over 20 trading sessions. */
|
|
475
|
+
expectedMove1s20d?: number;
|
|
456
476
|
netDelta?: number;
|
|
457
477
|
notionalVol?: number;
|
|
458
478
|
contracts?: number;
|
|
@@ -600,6 +620,18 @@ interface OptionsOverviewRow {
|
|
|
600
620
|
notionalVol?: number;
|
|
601
621
|
/** Signed change of `atmIv` against its ~20-session mean. Rank "biggest IV moves" by absolute value. */
|
|
602
622
|
ivMove20?: number;
|
|
623
|
+
/** Calibrated 90% expected move over 1 trading session, as a fraction of price. */
|
|
624
|
+
expectedMove1d?: number;
|
|
625
|
+
/** The same calibrated 90% range over 5 trading sessions. */
|
|
626
|
+
expectedMove5d?: number;
|
|
627
|
+
/** The same calibrated 90% range over 20 trading sessions. */
|
|
628
|
+
expectedMove20d?: number;
|
|
629
|
+
/** One-sigma expected move over 1 trading session: the industry convention, uncalibrated. */
|
|
630
|
+
expectedMove1s1d?: number;
|
|
631
|
+
/** One-sigma expected move over 5 trading sessions. */
|
|
632
|
+
expectedMove1s5d?: number;
|
|
633
|
+
/** One-sigma expected move over 20 trading sessions. */
|
|
634
|
+
expectedMove1s20d?: number;
|
|
603
635
|
/** Trailing-1y observation count, which is what drives the building-baseline state. */
|
|
604
636
|
observations1y?: number;
|
|
605
637
|
/** Unusually-active contracts this session. */
|
|
@@ -657,8 +689,8 @@ interface OptionsOverview {
|
|
|
657
689
|
/** Full ETF board size on a FREE response, mirroring what the envelope's `totalCount` does for stocks. */
|
|
658
690
|
etfTotalCount?: number;
|
|
659
691
|
}
|
|
660
|
-
/** The
|
|
661
|
-
type RatingDimensionKey = "crowd" | "smart_money" | "options" | "analysts" | "fundamentals" | "earnings";
|
|
692
|
+
/** The seven dimensions the composite is blended from, by stable `key`. */
|
|
693
|
+
type RatingDimensionKey = "crowd" | "smart_money" | "options" | "analysts" | "fundamentals" | "earnings" | "technicals";
|
|
662
694
|
/**
|
|
663
695
|
* Why a stock has no grade.
|
|
664
696
|
*
|
|
@@ -703,9 +735,9 @@ interface RatingSubLeg {
|
|
|
703
735
|
unit: string;
|
|
704
736
|
}
|
|
705
737
|
/**
|
|
706
|
-
* One of the
|
|
738
|
+
* One of the seven dimensions the composite is blended from.
|
|
707
739
|
*
|
|
708
|
-
* **All
|
|
740
|
+
* **All seven always arrive, in a fixed order, whether or not they had data.** An absent
|
|
709
741
|
* dimension is a full row with `present` false and a `null` percentile; the server never
|
|
710
742
|
* drops it, precisely so a client cannot mistake a gap for a five-dimension rating. Read
|
|
711
743
|
* `present` before reading `percentile`, and never substitute zero for a `null`: zero is the
|
|
@@ -749,7 +781,7 @@ interface RatingBase {
|
|
|
749
781
|
kbEntityId: string;
|
|
750
782
|
/** The New York calendar day this answer describes, `"YYYY-MM-DD"`. */
|
|
751
783
|
asOf: string;
|
|
752
|
-
/** Always all
|
|
784
|
+
/** Always all seven, in a fixed order, absent ones with `present` false. */
|
|
753
785
|
dimensions: RatingDimension[];
|
|
754
786
|
flags: RatingFlag[];
|
|
755
787
|
/** The standard financial disclaimer. Display it alongside the grade. */
|
|
@@ -821,7 +853,7 @@ interface StockNotRated extends RatingBase {
|
|
|
821
853
|
rated: false;
|
|
822
854
|
/** Why there is no grade. */
|
|
823
855
|
reason: RatingNotRatedReason;
|
|
824
|
-
/** How many of the
|
|
856
|
+
/** How many of the seven dimensions had data. */
|
|
825
857
|
dimensionsPresent?: number;
|
|
826
858
|
/** Which dimensions had data, by `key`. */
|
|
827
859
|
presentDimensions: RatingDimensionKey[];
|
|
@@ -1241,6 +1273,8 @@ interface InsiderTrade {
|
|
|
1241
1273
|
transactionCode: string;
|
|
1242
1274
|
transactionType: "BUY" | "SELL" | "EXERCISE" | "AWARD" | "GIFT" | "OTHER";
|
|
1243
1275
|
securityTitle: string;
|
|
1276
|
+
/** The security the row was filed in when it is not the US listing `ticker` names (e.g. "Common Shares (2330.TW)"); null on the ordinary case, and when set `pricePerShare` is null because the filed price is per foreign ordinary share. */
|
|
1277
|
+
securityBasis?: string | null;
|
|
1244
1278
|
sharesTransacted: number;
|
|
1245
1279
|
pricePerShare: number | null;
|
|
1246
1280
|
totalValue: number;
|
|
@@ -1570,9 +1604,33 @@ interface GetRecentEarningsOptions {
|
|
|
1570
1604
|
/** Max rows returned, 1 to 100. Omitted, the API applies its own default of 50. */
|
|
1571
1605
|
limit?: number;
|
|
1572
1606
|
}
|
|
1607
|
+
/**
|
|
1608
|
+
* What lifts the gate on a preview response, in a form you can show a user directly.
|
|
1609
|
+
*
|
|
1610
|
+
* Present only when `isPreview` is `true`. Every field is optional: the copy and the
|
|
1611
|
+
* offer are set server-side and can change without an SDK release, so read what is
|
|
1612
|
+
* there rather than depending on any one field.
|
|
1613
|
+
*/
|
|
1614
|
+
interface UpgradeHint {
|
|
1615
|
+
/** Plan that lifts the gate, e.g. `"PRO"`. */
|
|
1616
|
+
plan?: string;
|
|
1617
|
+
/** One sentence naming what was withheld. Safe to show verbatim. */
|
|
1618
|
+
message?: string;
|
|
1619
|
+
/** Current price, including any active discount code. */
|
|
1620
|
+
price?: string;
|
|
1621
|
+
/** Where to complete the upgrade. */
|
|
1622
|
+
url?: string;
|
|
1623
|
+
/** What an automated caller should do with this object. */
|
|
1624
|
+
relay?: string;
|
|
1625
|
+
}
|
|
1573
1626
|
interface PreviewResponse<T> {
|
|
1574
1627
|
isPreview: boolean;
|
|
1575
1628
|
previewReason: "PRO_REQUIRED" | null;
|
|
1629
|
+
/**
|
|
1630
|
+
* How to lift the gate. Present only on a preview; absent from full responses.
|
|
1631
|
+
* Surface `message` and `url` to your user rather than hard-coding a price.
|
|
1632
|
+
*/
|
|
1633
|
+
upgrade?: UpgradeHint;
|
|
1576
1634
|
/**
|
|
1577
1635
|
* Size of the full result set, before any truncation your response went through.
|
|
1578
1636
|
*
|
|
@@ -1927,6 +1985,8 @@ interface TrackerSnapshotResponse {
|
|
|
1927
1985
|
previewReason: "PRO_REQUIRED" | null;
|
|
1928
1986
|
/** Full row count before truncation. Only set on preview responses. */
|
|
1929
1987
|
totalCount?: number;
|
|
1988
|
+
/** How to lift the gate. Only set on preview responses. */
|
|
1989
|
+
upgrade?: UpgradeHint;
|
|
1930
1990
|
data: TrackerSnapshot;
|
|
1931
1991
|
}
|
|
1932
1992
|
/** Per-index discovery row returned by `client.indexes.list()`. */
|
|
@@ -2740,12 +2800,19 @@ interface EtfInfo {
|
|
|
2740
2800
|
imageUrl: string | null;
|
|
2741
2801
|
}
|
|
2742
2802
|
interface EtfHolding {
|
|
2803
|
+
/** The symbol as the issuer filed it. For an international fund this is the local exchange code, not a US ticker, so resolve stocks with `linkedTicker` instead. */
|
|
2743
2804
|
ticker: string;
|
|
2744
2805
|
name: string | null;
|
|
2745
2806
|
/** Weight in the fund as a percentage (0-100). */
|
|
2746
2807
|
weightPct: number;
|
|
2747
2808
|
/** ISO date "YYYY-MM-DD". First date this holding appeared in the composition. */
|
|
2748
2809
|
firstSeen: string | null;
|
|
2810
|
+
/** Listing venue the issuer reported for this position, verbatim (e.g. "NYSE", "SIX Swiss Exchange"). Null when the source carries no venue column. */
|
|
2811
|
+
exchange?: string | null;
|
|
2812
|
+
/** The symbol as listed on `exchange`. Same value as `ticker`, named to make it clear the symbol is venue-local and may not identify a US company. */
|
|
2813
|
+
localTicker?: string | null;
|
|
2814
|
+
/** The US stock symbol this holding resolves to, or null when it cannot be resolved to one. */
|
|
2815
|
+
linkedTicker?: string | null;
|
|
2749
2816
|
}
|
|
2750
2817
|
interface EtfHoldings {
|
|
2751
2818
|
ticker: string;
|
|
@@ -3677,6 +3744,6 @@ declare class APIError extends SentiSenseError {
|
|
|
3677
3744
|
constructor(message: string, status: number, code?: string);
|
|
3678
3745
|
}
|
|
3679
3746
|
|
|
3680
|
-
declare const VERSION = "0.
|
|
3747
|
+
declare const VERSION = "0.54.0";
|
|
3681
3748
|
|
|
3682
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 };
|