sentisense 0.74.0 → 0.75.1
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 +28 -2
- package/dist/cli.cjs +28 -4
- package/dist/index.cjs +18 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +56 -5
- package/dist/index.d.ts +56 -5
- package/dist/index.mjs +18 -4
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -3151,6 +3151,42 @@ interface TrackerListing {
|
|
|
3151
3151
|
refreshIntervalSeconds: number;
|
|
3152
3152
|
/** Canonical detail URL (e.g. `"/api/v1/trackers/institution-concentration"`). */
|
|
3153
3153
|
canonicalUrl: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* What this tracker accepts through `client.trackers.get(id, { filter })`: one entry per
|
|
3156
|
+
* key, each with the complete list of accepted values. Absent on a tracker with no filters.
|
|
3157
|
+
*/
|
|
3158
|
+
filters?: TrackerFilter[];
|
|
3159
|
+
}
|
|
3160
|
+
/** One filter a tracker accepts, as listed by `client.trackers.list()`. */
|
|
3161
|
+
interface TrackerFilter {
|
|
3162
|
+
/** Filter name, e.g. `"state"`. */
|
|
3163
|
+
key: string;
|
|
3164
|
+
/** The complete list of accepted values, e.g. `["AZ", "FEDERAL", "TX"]`. */
|
|
3165
|
+
values: string[];
|
|
3166
|
+
}
|
|
3167
|
+
/**
|
|
3168
|
+
* Query parameters for `client.trackers.get()`. Each is optional and provider-specific;
|
|
3169
|
+
* other keys are passed through as query parameters.
|
|
3170
|
+
*/
|
|
3171
|
+
interface TrackerGetParams {
|
|
3172
|
+
/**
|
|
3173
|
+
* Which universe a scoped tracker returns, e.g. `"nasdaq100"` for `market-heatmap`.
|
|
3174
|
+
* A value the tracker does not serve throws `APIError` with `code: "invalid_scope"`.
|
|
3175
|
+
*/
|
|
3176
|
+
scope?: string;
|
|
3177
|
+
/**
|
|
3178
|
+
* For the institution rankings: overrides the default filer-category filter. Pass `""`
|
|
3179
|
+
* to open the universe across all categories.
|
|
3180
|
+
*/
|
|
3181
|
+
category?: string;
|
|
3182
|
+
/**
|
|
3183
|
+
* Narrows a tracker that declares `filters`. An object such as
|
|
3184
|
+
* `{ state: "TX", category: "local" }` or the wire string `"state:TX,category:local"`.
|
|
3185
|
+
* An unknown key or value, or a filter on a tracker with none, throws `APIError` with
|
|
3186
|
+
* `status: 400` and `code: "invalid_filter"`.
|
|
3187
|
+
*/
|
|
3188
|
+
filter?: string | Record<string, string>;
|
|
3189
|
+
[param: string]: string | number | boolean | Record<string, string> | undefined;
|
|
3154
3190
|
}
|
|
3155
3191
|
/** Discovery envelope returned by `client.trackers.list()`. */
|
|
3156
3192
|
interface TrackerListResponse {
|
|
@@ -3170,6 +3206,20 @@ interface TrackerTableRow {
|
|
|
3170
3206
|
url: string | null;
|
|
3171
3207
|
/** Per-cell metric values; each carries its own label and unit. */
|
|
3172
3208
|
metrics: TrackerMetricValue[];
|
|
3209
|
+
/** The stock symbol the row is about, when it is about one company. Absent otherwise. */
|
|
3210
|
+
ticker?: string;
|
|
3211
|
+
/** ISO calendar day (`YYYY-MM-DD`) a row's stated term ends. Absent when it has none. */
|
|
3212
|
+
endsDate?: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* Two-letter state codes a record names (`data-center-moratoriums` company filings). A row
|
|
3215
|
+
* appears under a `state` filter for each of them. Absent when it names none.
|
|
3216
|
+
*/
|
|
3217
|
+
statesNamed?: string[];
|
|
3218
|
+
/**
|
|
3219
|
+
* Any other named cell a tracker writes on the row, such as the `market-heatmap` columns
|
|
3220
|
+
* (`marketCap`, `changePercent`, ...).
|
|
3221
|
+
*/
|
|
3222
|
+
[field: string]: unknown;
|
|
3173
3223
|
}
|
|
3174
3224
|
/**
|
|
3175
3225
|
* A labeled quantitative reading attached to a row, geo region, or
|
|
@@ -5465,10 +5515,11 @@ declare class Trackers {
|
|
|
5465
5515
|
* in your renderer.
|
|
5466
5516
|
*
|
|
5467
5517
|
* @param trackerId slug from {@link list}, e.g. `"institution-concentration"`.
|
|
5468
|
-
* @param params provider-specific query params
|
|
5469
|
-
*
|
|
5518
|
+
* @param params provider-specific query params, e.g. `{ scope: "nasdaq100" }` for
|
|
5519
|
+
* `market-heatmap`, or `{ filter: { state: "TX" } }` for a tracker that lists
|
|
5520
|
+
* `filters`. A bad `filter` throws `APIError` with `code: "invalid_filter"`.
|
|
5470
5521
|
*/
|
|
5471
|
-
get(trackerId: string, params?:
|
|
5522
|
+
get(trackerId: string, params?: TrackerGetParams): Promise<TrackerSnapshotResponse>;
|
|
5472
5523
|
}
|
|
5473
5524
|
|
|
5474
5525
|
/** @internal HTTP interface exposed to resource classes. */
|
|
@@ -5568,6 +5619,6 @@ declare class APIError extends SentiSenseError {
|
|
|
5568
5619
|
constructor(message: string, status: number, code?: string);
|
|
5569
5620
|
}
|
|
5570
5621
|
|
|
5571
|
-
declare const VERSION = "0.
|
|
5622
|
+
declare const VERSION = "0.75.1";
|
|
5572
5623
|
|
|
5573
|
-
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCalledItOptions, type GetAnalystCallsOptions, type GetAnalystConsensusHistoryOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsStatisticsOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetInstitutionDetailOptions, type GetInstitutionHistoryOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionChangeFilter, type InstitutionChangeType, type InstitutionDetail, type InstitutionHistory, type InstitutionHistoryQuarter, type InstitutionHolding, type InstitutionList, type InstitutionListResponse, type InstitutionMatchTotals, type InstitutionPositionPoint, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
|
|
5624
|
+
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCalledItOptions, type GetAnalystCallsOptions, type GetAnalystConsensusHistoryOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsStatisticsOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetInstitutionDetailOptions, type GetInstitutionHistoryOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionChangeFilter, type InstitutionChangeType, type InstitutionDetail, type InstitutionHistory, type InstitutionHistoryQuarter, type InstitutionHolding, type InstitutionList, type InstitutionListResponse, type InstitutionMatchTotals, type InstitutionPositionPoint, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerFilter, type TrackerGeoEntry, type TrackerGetParams, 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
|
@@ -3151,6 +3151,42 @@ interface TrackerListing {
|
|
|
3151
3151
|
refreshIntervalSeconds: number;
|
|
3152
3152
|
/** Canonical detail URL (e.g. `"/api/v1/trackers/institution-concentration"`). */
|
|
3153
3153
|
canonicalUrl: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* What this tracker accepts through `client.trackers.get(id, { filter })`: one entry per
|
|
3156
|
+
* key, each with the complete list of accepted values. Absent on a tracker with no filters.
|
|
3157
|
+
*/
|
|
3158
|
+
filters?: TrackerFilter[];
|
|
3159
|
+
}
|
|
3160
|
+
/** One filter a tracker accepts, as listed by `client.trackers.list()`. */
|
|
3161
|
+
interface TrackerFilter {
|
|
3162
|
+
/** Filter name, e.g. `"state"`. */
|
|
3163
|
+
key: string;
|
|
3164
|
+
/** The complete list of accepted values, e.g. `["AZ", "FEDERAL", "TX"]`. */
|
|
3165
|
+
values: string[];
|
|
3166
|
+
}
|
|
3167
|
+
/**
|
|
3168
|
+
* Query parameters for `client.trackers.get()`. Each is optional and provider-specific;
|
|
3169
|
+
* other keys are passed through as query parameters.
|
|
3170
|
+
*/
|
|
3171
|
+
interface TrackerGetParams {
|
|
3172
|
+
/**
|
|
3173
|
+
* Which universe a scoped tracker returns, e.g. `"nasdaq100"` for `market-heatmap`.
|
|
3174
|
+
* A value the tracker does not serve throws `APIError` with `code: "invalid_scope"`.
|
|
3175
|
+
*/
|
|
3176
|
+
scope?: string;
|
|
3177
|
+
/**
|
|
3178
|
+
* For the institution rankings: overrides the default filer-category filter. Pass `""`
|
|
3179
|
+
* to open the universe across all categories.
|
|
3180
|
+
*/
|
|
3181
|
+
category?: string;
|
|
3182
|
+
/**
|
|
3183
|
+
* Narrows a tracker that declares `filters`. An object such as
|
|
3184
|
+
* `{ state: "TX", category: "local" }` or the wire string `"state:TX,category:local"`.
|
|
3185
|
+
* An unknown key or value, or a filter on a tracker with none, throws `APIError` with
|
|
3186
|
+
* `status: 400` and `code: "invalid_filter"`.
|
|
3187
|
+
*/
|
|
3188
|
+
filter?: string | Record<string, string>;
|
|
3189
|
+
[param: string]: string | number | boolean | Record<string, string> | undefined;
|
|
3154
3190
|
}
|
|
3155
3191
|
/** Discovery envelope returned by `client.trackers.list()`. */
|
|
3156
3192
|
interface TrackerListResponse {
|
|
@@ -3170,6 +3206,20 @@ interface TrackerTableRow {
|
|
|
3170
3206
|
url: string | null;
|
|
3171
3207
|
/** Per-cell metric values; each carries its own label and unit. */
|
|
3172
3208
|
metrics: TrackerMetricValue[];
|
|
3209
|
+
/** The stock symbol the row is about, when it is about one company. Absent otherwise. */
|
|
3210
|
+
ticker?: string;
|
|
3211
|
+
/** ISO calendar day (`YYYY-MM-DD`) a row's stated term ends. Absent when it has none. */
|
|
3212
|
+
endsDate?: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* Two-letter state codes a record names (`data-center-moratoriums` company filings). A row
|
|
3215
|
+
* appears under a `state` filter for each of them. Absent when it names none.
|
|
3216
|
+
*/
|
|
3217
|
+
statesNamed?: string[];
|
|
3218
|
+
/**
|
|
3219
|
+
* Any other named cell a tracker writes on the row, such as the `market-heatmap` columns
|
|
3220
|
+
* (`marketCap`, `changePercent`, ...).
|
|
3221
|
+
*/
|
|
3222
|
+
[field: string]: unknown;
|
|
3173
3223
|
}
|
|
3174
3224
|
/**
|
|
3175
3225
|
* A labeled quantitative reading attached to a row, geo region, or
|
|
@@ -5465,10 +5515,11 @@ declare class Trackers {
|
|
|
5465
5515
|
* in your renderer.
|
|
5466
5516
|
*
|
|
5467
5517
|
* @param trackerId slug from {@link list}, e.g. `"institution-concentration"`.
|
|
5468
|
-
* @param params provider-specific query params
|
|
5469
|
-
*
|
|
5518
|
+
* @param params provider-specific query params, e.g. `{ scope: "nasdaq100" }` for
|
|
5519
|
+
* `market-heatmap`, or `{ filter: { state: "TX" } }` for a tracker that lists
|
|
5520
|
+
* `filters`. A bad `filter` throws `APIError` with `code: "invalid_filter"`.
|
|
5470
5521
|
*/
|
|
5471
|
-
get(trackerId: string, params?:
|
|
5522
|
+
get(trackerId: string, params?: TrackerGetParams): Promise<TrackerSnapshotResponse>;
|
|
5472
5523
|
}
|
|
5473
5524
|
|
|
5474
5525
|
/** @internal HTTP interface exposed to resource classes. */
|
|
@@ -5568,6 +5619,6 @@ declare class APIError extends SentiSenseError {
|
|
|
5568
5619
|
constructor(message: string, status: number, code?: string);
|
|
5569
5620
|
}
|
|
5570
5621
|
|
|
5571
|
-
declare const VERSION = "0.
|
|
5622
|
+
declare const VERSION = "0.75.1";
|
|
5572
5623
|
|
|
5573
|
-
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCalledItOptions, type GetAnalystCallsOptions, type GetAnalystConsensusHistoryOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsStatisticsOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetInstitutionDetailOptions, type GetInstitutionHistoryOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionChangeFilter, type InstitutionChangeType, type InstitutionDetail, type InstitutionHistory, type InstitutionHistoryQuarter, type InstitutionHolding, type InstitutionList, type InstitutionListResponse, type InstitutionMatchTotals, type InstitutionPositionPoint, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
|
|
5624
|
+
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystCalledItCall, type AnalystCalledItMove, type AnalystConsensus, type AnalystConsensusHistory, type AnalystConsensusHistoryPoint, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatePeriodType, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AnalystRef, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarlyFilers, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsOutcomeStatistics, type EarningsQuarter, type EarningsReaction, type EarningsReactionsResponse, type EarningsSource, type EarningsStatistics, type EarningsStatisticsBaseline, type EarningsStatisticsDeviation, type EarningsStatisticsThresholds, type EarningsStatisticsWindow, type EarningsSummariesResponse, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfQuote, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type ExtendedHoursInfo, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCalledItOptions, type GetAnalystCallsOptions, type GetAnalystConsensusHistoryOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsStatisticsOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersHistoryOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetInstitutionDetailOptions, type GetInstitutionHistoryOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetOptionsIntradayHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRankedEarningsOptions, type GetRecentEarningsOptions, type GetShortInterestOptions, type GetShortVolumeOptions, type GetStockGraphOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type GraphCounts, type GraphEdge, type GraphGroups, type GraphNode, type GraphProductFamily, type Holder, type HolderComparisonStatus, type HolderNotableChanges, type HoldersHistory, type HoldersHistoryQuarter, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionChangeFilter, type InstitutionChangeType, type InstitutionDetail, type InstitutionHistory, type InstitutionHistoryQuarter, type InstitutionHolding, type InstitutionList, type InstitutionListResponse, type InstitutionMatchTotals, type InstitutionPositionPoint, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketMoodOptions, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type NotableHolder, type OptionsAggregate, type OptionsCapabilities, type OptionsContext, type OptionsHighlight, type OptionsHistory, type OptionsHistoryWindow, type OptionsIntradayBoardCapability, type OptionsIntradayFlow, type OptionsIntradayHistory, type OptionsIntradayPoint, type OptionsOiFollowUp, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type OwnershipSelection, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, type RankedEarnings, type RankedEarningsSection, type RankedReportedEarnings, type RankedUpcomingEarnings, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, type SearchStoriesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShareClass, type ShortInterest, type ShortInterestDataPoint, type ShortVolume, type ShortVolumeDataPoint, type SimilarStock, type StockDetail, type StockEntity, type StockGraph, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, TemporarilyUnavailableError, type TickerHolders, type TrackerEvent, type TrackerFilter, type TrackerGeoEntry, type TrackerGetParams, 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
|
@@ -1492,16 +1492,30 @@ var Trackers = class {
|
|
|
1492
1492
|
* in your renderer.
|
|
1493
1493
|
*
|
|
1494
1494
|
* @param trackerId slug from {@link list}, e.g. `"institution-concentration"`.
|
|
1495
|
-
* @param params provider-specific query params
|
|
1496
|
-
*
|
|
1495
|
+
* @param params provider-specific query params, e.g. `{ scope: "nasdaq100" }` for
|
|
1496
|
+
* `market-heatmap`, or `{ filter: { state: "TX" } }` for a tracker that lists
|
|
1497
|
+
* `filters`. A bad `filter` throws `APIError` with `code: "invalid_filter"`.
|
|
1497
1498
|
*/
|
|
1498
1499
|
async get(trackerId, params) {
|
|
1499
|
-
return this.client.get(`/api/v1/trackers/${trackerId}`, params);
|
|
1500
|
+
return this.client.get(`/api/v1/trackers/${trackerId}`, serializeTrackerParams(params));
|
|
1500
1501
|
}
|
|
1501
1502
|
};
|
|
1503
|
+
function serializeTrackerFilter(filter) {
|
|
1504
|
+
if (typeof filter === "string") return filter;
|
|
1505
|
+
return Object.entries(filter).map(([key, value]) => `${key}:${value}`).join(",");
|
|
1506
|
+
}
|
|
1507
|
+
function serializeTrackerParams(params) {
|
|
1508
|
+
if (!params) return void 0;
|
|
1509
|
+
const out = {};
|
|
1510
|
+
for (const [key, value] of Object.entries(params)) {
|
|
1511
|
+
if (value === void 0 || value === null) continue;
|
|
1512
|
+
out[key] = key === "filter" ? serializeTrackerFilter(value) : value;
|
|
1513
|
+
}
|
|
1514
|
+
return out;
|
|
1515
|
+
}
|
|
1502
1516
|
|
|
1503
1517
|
// src/version.ts
|
|
1504
|
-
var VERSION = "0.
|
|
1518
|
+
var VERSION = "0.75.1";
|
|
1505
1519
|
|
|
1506
1520
|
// src/client.ts
|
|
1507
1521
|
var DEFAULT_BASE_URL = "https://app.sentisense.ai";
|