sentisense 0.72.1 → 0.74.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 +32 -1
- package/dist/cli.cjs +338 -6
- package/dist/index.cjs +64 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +233 -4
- package/dist/index.d.ts +233 -4
- package/dist/index.mjs +64 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -2000,6 +2000,46 @@ interface HoldersHistory {
|
|
|
2000
2000
|
ticker: string;
|
|
2001
2001
|
quarters: HoldersHistoryQuarter[];
|
|
2002
2002
|
}
|
|
2003
|
+
/**
|
|
2004
|
+
* One row of an institution detail's `holdings`.
|
|
2005
|
+
*
|
|
2006
|
+
* `priorValueUsd`, `priorPortfolioWeight` and `estimatedFlowUsd` are present only when the
|
|
2007
|
+
* detail's `comparisonStatus` is `AVAILABLE`.
|
|
2008
|
+
*/
|
|
2009
|
+
interface InstitutionHolding {
|
|
2010
|
+
ticker?: string | null;
|
|
2011
|
+
companyName?: string | null;
|
|
2012
|
+
shares?: number;
|
|
2013
|
+
/** Position value in USD. */
|
|
2014
|
+
valueUsd?: number;
|
|
2015
|
+
/** `NEW`, `INCREASED`, `DECREASED`, `SOLD_OUT` or `UNCHANGED`. */
|
|
2016
|
+
changeType?: InstitutionChangeType | (string & {}) | null;
|
|
2017
|
+
sharesChange?: number;
|
|
2018
|
+
sharesChangePct?: number;
|
|
2019
|
+
/** Weight in the filer's portfolio, in percent. */
|
|
2020
|
+
portfolioWeight?: number;
|
|
2021
|
+
/** This ticker's value in the comparison filing; `0` for a `NEW` position. */
|
|
2022
|
+
priorValueUsd?: number;
|
|
2023
|
+
/** This ticker's weight in the comparison filing, in percent. */
|
|
2024
|
+
priorPortfolioWeight?: number;
|
|
2025
|
+
/**
|
|
2026
|
+
* Estimated dollars bought (positive) or sold (negative): an estimate from two quarter-end
|
|
2027
|
+
* snapshots, not a reported trade. Absent when the holding has no `changeType`.
|
|
2028
|
+
*/
|
|
2029
|
+
estimatedFlowUsd?: number;
|
|
2030
|
+
[key: string]: unknown;
|
|
2031
|
+
}
|
|
2032
|
+
/**
|
|
2033
|
+
* Totals over every holding that matches a filtered institution detail request, not just the
|
|
2034
|
+
* returned page. `priorValueUsd` and `estimatedFlowUsd` are present only when the detail's
|
|
2035
|
+
* `comparisonStatus` is `AVAILABLE`.
|
|
2036
|
+
*/
|
|
2037
|
+
interface InstitutionMatchTotals {
|
|
2038
|
+
count?: number;
|
|
2039
|
+
valueUsd?: number;
|
|
2040
|
+
priorValueUsd?: number;
|
|
2041
|
+
estimatedFlowUsd?: number;
|
|
2042
|
+
}
|
|
2003
2043
|
/**
|
|
2004
2044
|
* Optional wire keys inside an institution detail's preview envelope.
|
|
2005
2045
|
* Opt in with PreviewResponse<InstitutionDetail>; getInstitutionDetail retains
|
|
@@ -2021,17 +2061,159 @@ interface InstitutionDetail {
|
|
|
2021
2061
|
increasedPositions?: number;
|
|
2022
2062
|
decreasedPositions?: number;
|
|
2023
2063
|
soldOutPositions?: number;
|
|
2064
|
+
/**
|
|
2065
|
+
* `AVAILABLE` when the position counts and each holding's change fields compare with the
|
|
2066
|
+
* immediately preceding quarter; other values mean they are not a quarter-over-quarter
|
|
2067
|
+
* comparison.
|
|
2068
|
+
*/
|
|
2069
|
+
comparisonStatus?: string | null;
|
|
2070
|
+
/** The preceding quarter used for changes (ISO date); absent when none applies. */
|
|
2071
|
+
comparisonReportDate?: string | null;
|
|
2024
2072
|
multiCikRollup?: boolean | null;
|
|
2025
2073
|
childCikCount?: number | null;
|
|
2026
2074
|
childCiks?: string[] | null;
|
|
2027
|
-
holdings?:
|
|
2075
|
+
holdings?: InstitutionHolding[] | null;
|
|
2028
2076
|
optionPositions?: Record<string, unknown>[];
|
|
2029
2077
|
returnedCount?: number;
|
|
2030
2078
|
offset?: number;
|
|
2031
2079
|
/** max(0, holdingsCount - soldOutPositions), for the full portfolio on every tier. */
|
|
2032
2080
|
positionsHeld?: number;
|
|
2081
|
+
/** Equity value of the comparison filing. Present only when `comparisonStatus` is `AVAILABLE`. */
|
|
2082
|
+
priorTotalValueUsd?: number;
|
|
2083
|
+
/** Positions held in the comparison filing. Present only when `comparisonStatus` is `AVAILABLE`. */
|
|
2084
|
+
priorPositionsHeld?: number;
|
|
2085
|
+
/** Present only on a filtered page: totals over every matching holding, not just the page. */
|
|
2086
|
+
matchTotals?: InstitutionMatchTotals;
|
|
2033
2087
|
[key: string]: unknown;
|
|
2034
2088
|
}
|
|
2089
|
+
/** A holding's change type in an institution detail. */
|
|
2090
|
+
type InstitutionChangeType = "NEW" | "INCREASED" | "DECREASED" | "SOLD_OUT" | "UNCHANGED";
|
|
2091
|
+
/**
|
|
2092
|
+
* A value for the `changeType` filter of `institutional.getInstitutionDetail`: any
|
|
2093
|
+
* {@link InstitutionChangeType}, or `"HELD"` (every position still held, whatever its change,
|
|
2094
|
+
* including holdings without a `changeType`). Values combine as a union. A holding's own
|
|
2095
|
+
* `changeType` never carries `"HELD"`.
|
|
2096
|
+
*/
|
|
2097
|
+
type InstitutionChangeFilter = InstitutionChangeType | "HELD";
|
|
2098
|
+
/**
|
|
2099
|
+
* Paging, sort and filter options for `institutional.getInstitutionDetail`.
|
|
2100
|
+
*
|
|
2101
|
+
* Every option here only takes effect together with `limit`; send one without it and the
|
|
2102
|
+
* server ignores it and returns the full holdings list. A free key ignores them all and gets
|
|
2103
|
+
* the top 10 holdings.
|
|
2104
|
+
*/
|
|
2105
|
+
interface GetInstitutionDetailOptions {
|
|
2106
|
+
/** Page size, 1 to 1000. Omit for the full holdings list. */
|
|
2107
|
+
limit?: number;
|
|
2108
|
+
/** Start position within the sorted holdings. Server default is 0. */
|
|
2109
|
+
offset?: number;
|
|
2110
|
+
/**
|
|
2111
|
+
* Sort field. Server default is `"valueUsd"`. `valueChangeUsd` is `valueUsd - priorValueUsd`;
|
|
2112
|
+
* for `sharesChange`, `estimatedFlowUsd` and `priorValueUsd`, holdings without the field are
|
|
2113
|
+
* placed last in either direction.
|
|
2114
|
+
*/
|
|
2115
|
+
sortBy?: "valueUsd" | "shares" | "portfolioWeight" | "sharesChangePct" | "valueChangeUsd" | "sharesChange" | "estimatedFlowUsd" | "priorValueUsd";
|
|
2116
|
+
/** Sort direction. Server default is `"desc"`. */
|
|
2117
|
+
sortDir?: "asc" | "desc";
|
|
2118
|
+
/**
|
|
2119
|
+
* Keep only holdings matching these filters; values combine as a union. `"HELD"` keeps every
|
|
2120
|
+
* position still held, whatever its change, including holdings without a `changeType`.
|
|
2121
|
+
* An array is sent comma-joined.
|
|
2122
|
+
*/
|
|
2123
|
+
changeType?: InstitutionChangeFilter | readonly InstitutionChangeFilter[];
|
|
2124
|
+
/** Case-insensitive match on ticker or company name, up to 100 characters. */
|
|
2125
|
+
q?: string;
|
|
2126
|
+
/** Keep holdings whose `portfolioWeight` or `priorPortfolioWeight` is at least this percent. */
|
|
2127
|
+
minWeight?: number;
|
|
2128
|
+
}
|
|
2129
|
+
/** Options for `institutional.getInstitutionHistory`. */
|
|
2130
|
+
interface GetInstitutionHistoryOptions {
|
|
2131
|
+
/**
|
|
2132
|
+
* How many of the newest filings to return. Server default is 12; values above 40 are
|
|
2133
|
+
* capped server-side, and values below 1 are rejected with a 400.
|
|
2134
|
+
*/
|
|
2135
|
+
quarters?: number;
|
|
2136
|
+
/**
|
|
2137
|
+
* Up to 100 tickers; adds `positions` to the response. An array is sent comma-joined. A bad
|
|
2138
|
+
* symbol or more than 100 is rejected with a 400. Free keys receive positions only for the
|
|
2139
|
+
* institution's ten largest holdings; other tickers are left out.
|
|
2140
|
+
*/
|
|
2141
|
+
tickers?: string | readonly string[];
|
|
2142
|
+
}
|
|
2143
|
+
/** One filing's holding of one ticker, from an institution's history. */
|
|
2144
|
+
interface InstitutionPositionPoint {
|
|
2145
|
+
/** Quarter end, ISO date (`YYYY-MM-DD`). */
|
|
2146
|
+
reportDate: string;
|
|
2147
|
+
shares: number;
|
|
2148
|
+
/** Position value in US dollars. */
|
|
2149
|
+
valueUsd: number;
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
* One filing of an institution's 13F book.
|
|
2153
|
+
*
|
|
2154
|
+
* Fields marked "AVAILABLE only" are absent unless `comparisonStatus` is `AVAILABLE`, meaning
|
|
2155
|
+
* the filing compares with the immediately preceding quarter. Absent, never zero: a zero would
|
|
2156
|
+
* claim the institution did not trade. The flow figures are estimates from two quarter-end
|
|
2157
|
+
* snapshots, not reported cash flow.
|
|
2158
|
+
*/
|
|
2159
|
+
interface InstitutionHistoryQuarter {
|
|
2160
|
+
/** Quarter end, ISO date (`YYYY-MM-DD`). */
|
|
2161
|
+
reportDate: string;
|
|
2162
|
+
/** Quarter id in `YYYYQN` form, e.g. `"2026Q2"`. */
|
|
2163
|
+
value: string;
|
|
2164
|
+
/** Display label, e.g. `"Q2 2026"`. */
|
|
2165
|
+
label: string;
|
|
2166
|
+
/** `settled` once the quarter's filing deadline has passed, `filing` before. */
|
|
2167
|
+
status: "settled" | "filing" | (string & {});
|
|
2168
|
+
/** `AVAILABLE`, or one of the other values documented for the institution detail. */
|
|
2169
|
+
comparisonStatus: "AVAILABLE" | (string & {});
|
|
2170
|
+
/** The preceding quarter used for the comparison; absent when none applies. */
|
|
2171
|
+
comparisonReportDate?: string;
|
|
2172
|
+
/** Reported equity value of the filing, in US dollars. */
|
|
2173
|
+
totalValueUsd: number;
|
|
2174
|
+
/** Equity positions held. */
|
|
2175
|
+
positionsHeld: number;
|
|
2176
|
+
/** Share of `totalValueUsd` in the ten largest positions, in percent. */
|
|
2177
|
+
top10Pct: number;
|
|
2178
|
+
/** AVAILABLE only. Positions opened. */
|
|
2179
|
+
newPositions?: number;
|
|
2180
|
+
/** AVAILABLE only. Positions added to. */
|
|
2181
|
+
increasedPositions?: number;
|
|
2182
|
+
/** AVAILABLE only. Positions trimmed. */
|
|
2183
|
+
decreasedPositions?: number;
|
|
2184
|
+
/** AVAILABLE only. Positions exited. */
|
|
2185
|
+
soldOutPositions?: number;
|
|
2186
|
+
/** AVAILABLE only. Shares added (new and increased positions) valued at this filing's prices. */
|
|
2187
|
+
boughtUsd?: number;
|
|
2188
|
+
/** AVAILABLE only. Shares sold from positions still held, valued at this filing's prices. */
|
|
2189
|
+
trimmedUsd?: number;
|
|
2190
|
+
/** AVAILABLE only. Positions exited, at the previous filing's value. */
|
|
2191
|
+
exitedUsd?: number;
|
|
2192
|
+
/** AVAILABLE only. `boughtUsd - trimmedUsd - exitedUsd`. */
|
|
2193
|
+
netFlowUsd?: number;
|
|
2194
|
+
/**
|
|
2195
|
+
* AVAILABLE only. The change in `totalValueUsd` since the previous filing minus `netFlowUsd`:
|
|
2196
|
+
* the remainder after trading, mostly price moves. It also absorbs rounding, the different
|
|
2197
|
+
* price bases of exits (previous filing) and trades (this filing), and positions whose change
|
|
2198
|
+
* could not be restated.
|
|
2199
|
+
*/
|
|
2200
|
+
priceEffectUsd?: number;
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
* An institution's 13F book filing by filing, newest first: the `data` payload of
|
|
2204
|
+
* `institutional.getInstitutionHistory()`, which returns `PreviewResponse<InstitutionHistory>`.
|
|
2205
|
+
*/
|
|
2206
|
+
interface InstitutionHistory {
|
|
2207
|
+
filerCik: string;
|
|
2208
|
+
urlSlug: string;
|
|
2209
|
+
displayName: string;
|
|
2210
|
+
quarters: InstitutionHistoryQuarter[];
|
|
2211
|
+
/**
|
|
2212
|
+
* Present only when `tickers` was requested: each ticker maps to its filings, newest first.
|
|
2213
|
+
* A filing in which the institution did not hold the ticker is absent from its list.
|
|
2214
|
+
*/
|
|
2215
|
+
positions?: Record<string, InstitutionPositionPoint[]>;
|
|
2216
|
+
}
|
|
2035
2217
|
/** A single institution summary from the discovery list. */
|
|
2036
2218
|
interface InstitutionSummary {
|
|
2037
2219
|
/** SEC Central Index Key of the (rolled-up) institution. */
|
|
@@ -4706,8 +4888,55 @@ declare class Institutional {
|
|
|
4706
4888
|
* The signature remains unknown for compatibility. Opt in to the exported
|
|
4707
4889
|
* PreviewResponse<InstitutionDetail> type to read data.positionsHeld, the full
|
|
4708
4890
|
* portfolio count excluding SOLD_OUT rows, even on a truncated holdings list.
|
|
4891
|
+
*
|
|
4892
|
+
* When the filing compares with the preceding quarter (`comparisonStatus` is `AVAILABLE`),
|
|
4893
|
+
* the payload also carries `priorTotalValueUsd` and `priorPositionsHeld`, and each holding
|
|
4894
|
+
* carries `priorValueUsd`, `priorPortfolioWeight` and `estimatedFlowUsd` (an estimate from
|
|
4895
|
+
* two quarter-end snapshots, not a reported trade). Each is absent when it does not apply.
|
|
4896
|
+
*
|
|
4897
|
+
* `options.limit` returns a sorted page of holdings and adds `returnedCount` and `offset` to
|
|
4898
|
+
* `data` and `totalCount` to the envelope; `sortBy`, `sortDir`, `changeType`, `q` and
|
|
4899
|
+
* `minWeight` only take effect together with it (PRO only). `changeType` also accepts `"HELD"`,
|
|
4900
|
+
* every position still held whatever its change; values combine as a union. With a filter set, `data.matchTotals`
|
|
4901
|
+
* sums every matching holding, not just the page. Calling without `options` is unchanged.
|
|
4902
|
+
*
|
|
4903
|
+
* @example
|
|
4904
|
+
* const page = await client.institutional.getInstitutionDetail("Berkshire-Hathaway", {
|
|
4905
|
+
* limit: 10,
|
|
4906
|
+
* sortBy: "estimatedFlowUsd",
|
|
4907
|
+
* changeType: ["NEW", "INCREASED"],
|
|
4908
|
+
* }) as PreviewResponse<InstitutionDetail>;
|
|
4909
|
+
*/
|
|
4910
|
+
getInstitutionDetail(slugOrCik: string, options?: GetInstitutionDetailOptions): Promise<unknown>;
|
|
4911
|
+
/**
|
|
4912
|
+
* Get an institution's 13F book filing by filing, newest first.
|
|
4913
|
+
*
|
|
4914
|
+
* Returns the preview envelope wrapping an {@link InstitutionHistory}, so the rows are two
|
|
4915
|
+
* levels down: `(await getInstitutionHistory(s)).data.quarters`. Each row carries the
|
|
4916
|
+
* filing's reported value, positions held and top-10 concentration, and, when it compares
|
|
4917
|
+
* with the quarter before (`comparisonStatus: "AVAILABLE"`), the position counts and the
|
|
4918
|
+
* estimated dollars bought, trimmed and exited. Those comparison fields are absent
|
|
4919
|
+
* otherwise, never zero. The flows are estimates from two quarter-end snapshots, not
|
|
4920
|
+
* reported cash flow. A 13F covers long US-listed equity only.
|
|
4921
|
+
*
|
|
4922
|
+
* Pass `tickers` to also get `data.positions`: each ticker maps to its shares and value per
|
|
4923
|
+
* filing, newest first. A filing in which the institution did not hold the ticker is absent
|
|
4924
|
+
* from its list. Free keys receive positions only for the institution's ten largest
|
|
4925
|
+
* holdings; other tickers are left out.
|
|
4926
|
+
*
|
|
4927
|
+
* Free keys receive the newest four filings with `isPreview: true` and `totalCount` holding
|
|
4928
|
+
* the number of filings in the requested window. The first request for a large multi-filer
|
|
4929
|
+
* institution can take a few seconds; when too many such computations run at once the API
|
|
4930
|
+
* answers 503 with a `Retry-After` header.
|
|
4931
|
+
*
|
|
4932
|
+
* @example
|
|
4933
|
+
* const { data } = await client.institutional.getInstitutionHistory("Renaissance-Technologies", {
|
|
4934
|
+
* quarters: 8,
|
|
4935
|
+
* tickers: ["NVDA", "META"],
|
|
4936
|
+
* });
|
|
4937
|
+
* for (const q of data.quarters) console.log(q.label, q.totalValueUsd, q.netFlowUsd);
|
|
4709
4938
|
*/
|
|
4710
|
-
|
|
4939
|
+
getInstitutionHistory(slugOrCik: string, options?: GetInstitutionHistoryOptions): Promise<PreviewResponse<InstitutionHistory>>;
|
|
4711
4940
|
}
|
|
4712
4941
|
|
|
4713
4942
|
/** Public entity types the search `type` filter accepts, and that come back on a hit. */
|
|
@@ -5339,6 +5568,6 @@ declare class APIError extends SentiSenseError {
|
|
|
5339
5568
|
constructor(message: string, status: number, code?: string);
|
|
5340
5569
|
}
|
|
5341
5570
|
|
|
5342
|
-
declare const VERSION = "0.
|
|
5571
|
+
declare const VERSION = "0.74.0";
|
|
5343
5572
|
|
|
5344
|
-
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 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 InstitutionDetail, 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 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 };
|
|
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -2000,6 +2000,46 @@ interface HoldersHistory {
|
|
|
2000
2000
|
ticker: string;
|
|
2001
2001
|
quarters: HoldersHistoryQuarter[];
|
|
2002
2002
|
}
|
|
2003
|
+
/**
|
|
2004
|
+
* One row of an institution detail's `holdings`.
|
|
2005
|
+
*
|
|
2006
|
+
* `priorValueUsd`, `priorPortfolioWeight` and `estimatedFlowUsd` are present only when the
|
|
2007
|
+
* detail's `comparisonStatus` is `AVAILABLE`.
|
|
2008
|
+
*/
|
|
2009
|
+
interface InstitutionHolding {
|
|
2010
|
+
ticker?: string | null;
|
|
2011
|
+
companyName?: string | null;
|
|
2012
|
+
shares?: number;
|
|
2013
|
+
/** Position value in USD. */
|
|
2014
|
+
valueUsd?: number;
|
|
2015
|
+
/** `NEW`, `INCREASED`, `DECREASED`, `SOLD_OUT` or `UNCHANGED`. */
|
|
2016
|
+
changeType?: InstitutionChangeType | (string & {}) | null;
|
|
2017
|
+
sharesChange?: number;
|
|
2018
|
+
sharesChangePct?: number;
|
|
2019
|
+
/** Weight in the filer's portfolio, in percent. */
|
|
2020
|
+
portfolioWeight?: number;
|
|
2021
|
+
/** This ticker's value in the comparison filing; `0` for a `NEW` position. */
|
|
2022
|
+
priorValueUsd?: number;
|
|
2023
|
+
/** This ticker's weight in the comparison filing, in percent. */
|
|
2024
|
+
priorPortfolioWeight?: number;
|
|
2025
|
+
/**
|
|
2026
|
+
* Estimated dollars bought (positive) or sold (negative): an estimate from two quarter-end
|
|
2027
|
+
* snapshots, not a reported trade. Absent when the holding has no `changeType`.
|
|
2028
|
+
*/
|
|
2029
|
+
estimatedFlowUsd?: number;
|
|
2030
|
+
[key: string]: unknown;
|
|
2031
|
+
}
|
|
2032
|
+
/**
|
|
2033
|
+
* Totals over every holding that matches a filtered institution detail request, not just the
|
|
2034
|
+
* returned page. `priorValueUsd` and `estimatedFlowUsd` are present only when the detail's
|
|
2035
|
+
* `comparisonStatus` is `AVAILABLE`.
|
|
2036
|
+
*/
|
|
2037
|
+
interface InstitutionMatchTotals {
|
|
2038
|
+
count?: number;
|
|
2039
|
+
valueUsd?: number;
|
|
2040
|
+
priorValueUsd?: number;
|
|
2041
|
+
estimatedFlowUsd?: number;
|
|
2042
|
+
}
|
|
2003
2043
|
/**
|
|
2004
2044
|
* Optional wire keys inside an institution detail's preview envelope.
|
|
2005
2045
|
* Opt in with PreviewResponse<InstitutionDetail>; getInstitutionDetail retains
|
|
@@ -2021,17 +2061,159 @@ interface InstitutionDetail {
|
|
|
2021
2061
|
increasedPositions?: number;
|
|
2022
2062
|
decreasedPositions?: number;
|
|
2023
2063
|
soldOutPositions?: number;
|
|
2064
|
+
/**
|
|
2065
|
+
* `AVAILABLE` when the position counts and each holding's change fields compare with the
|
|
2066
|
+
* immediately preceding quarter; other values mean they are not a quarter-over-quarter
|
|
2067
|
+
* comparison.
|
|
2068
|
+
*/
|
|
2069
|
+
comparisonStatus?: string | null;
|
|
2070
|
+
/** The preceding quarter used for changes (ISO date); absent when none applies. */
|
|
2071
|
+
comparisonReportDate?: string | null;
|
|
2024
2072
|
multiCikRollup?: boolean | null;
|
|
2025
2073
|
childCikCount?: number | null;
|
|
2026
2074
|
childCiks?: string[] | null;
|
|
2027
|
-
holdings?:
|
|
2075
|
+
holdings?: InstitutionHolding[] | null;
|
|
2028
2076
|
optionPositions?: Record<string, unknown>[];
|
|
2029
2077
|
returnedCount?: number;
|
|
2030
2078
|
offset?: number;
|
|
2031
2079
|
/** max(0, holdingsCount - soldOutPositions), for the full portfolio on every tier. */
|
|
2032
2080
|
positionsHeld?: number;
|
|
2081
|
+
/** Equity value of the comparison filing. Present only when `comparisonStatus` is `AVAILABLE`. */
|
|
2082
|
+
priorTotalValueUsd?: number;
|
|
2083
|
+
/** Positions held in the comparison filing. Present only when `comparisonStatus` is `AVAILABLE`. */
|
|
2084
|
+
priorPositionsHeld?: number;
|
|
2085
|
+
/** Present only on a filtered page: totals over every matching holding, not just the page. */
|
|
2086
|
+
matchTotals?: InstitutionMatchTotals;
|
|
2033
2087
|
[key: string]: unknown;
|
|
2034
2088
|
}
|
|
2089
|
+
/** A holding's change type in an institution detail. */
|
|
2090
|
+
type InstitutionChangeType = "NEW" | "INCREASED" | "DECREASED" | "SOLD_OUT" | "UNCHANGED";
|
|
2091
|
+
/**
|
|
2092
|
+
* A value for the `changeType` filter of `institutional.getInstitutionDetail`: any
|
|
2093
|
+
* {@link InstitutionChangeType}, or `"HELD"` (every position still held, whatever its change,
|
|
2094
|
+
* including holdings without a `changeType`). Values combine as a union. A holding's own
|
|
2095
|
+
* `changeType` never carries `"HELD"`.
|
|
2096
|
+
*/
|
|
2097
|
+
type InstitutionChangeFilter = InstitutionChangeType | "HELD";
|
|
2098
|
+
/**
|
|
2099
|
+
* Paging, sort and filter options for `institutional.getInstitutionDetail`.
|
|
2100
|
+
*
|
|
2101
|
+
* Every option here only takes effect together with `limit`; send one without it and the
|
|
2102
|
+
* server ignores it and returns the full holdings list. A free key ignores them all and gets
|
|
2103
|
+
* the top 10 holdings.
|
|
2104
|
+
*/
|
|
2105
|
+
interface GetInstitutionDetailOptions {
|
|
2106
|
+
/** Page size, 1 to 1000. Omit for the full holdings list. */
|
|
2107
|
+
limit?: number;
|
|
2108
|
+
/** Start position within the sorted holdings. Server default is 0. */
|
|
2109
|
+
offset?: number;
|
|
2110
|
+
/**
|
|
2111
|
+
* Sort field. Server default is `"valueUsd"`. `valueChangeUsd` is `valueUsd - priorValueUsd`;
|
|
2112
|
+
* for `sharesChange`, `estimatedFlowUsd` and `priorValueUsd`, holdings without the field are
|
|
2113
|
+
* placed last in either direction.
|
|
2114
|
+
*/
|
|
2115
|
+
sortBy?: "valueUsd" | "shares" | "portfolioWeight" | "sharesChangePct" | "valueChangeUsd" | "sharesChange" | "estimatedFlowUsd" | "priorValueUsd";
|
|
2116
|
+
/** Sort direction. Server default is `"desc"`. */
|
|
2117
|
+
sortDir?: "asc" | "desc";
|
|
2118
|
+
/**
|
|
2119
|
+
* Keep only holdings matching these filters; values combine as a union. `"HELD"` keeps every
|
|
2120
|
+
* position still held, whatever its change, including holdings without a `changeType`.
|
|
2121
|
+
* An array is sent comma-joined.
|
|
2122
|
+
*/
|
|
2123
|
+
changeType?: InstitutionChangeFilter | readonly InstitutionChangeFilter[];
|
|
2124
|
+
/** Case-insensitive match on ticker or company name, up to 100 characters. */
|
|
2125
|
+
q?: string;
|
|
2126
|
+
/** Keep holdings whose `portfolioWeight` or `priorPortfolioWeight` is at least this percent. */
|
|
2127
|
+
minWeight?: number;
|
|
2128
|
+
}
|
|
2129
|
+
/** Options for `institutional.getInstitutionHistory`. */
|
|
2130
|
+
interface GetInstitutionHistoryOptions {
|
|
2131
|
+
/**
|
|
2132
|
+
* How many of the newest filings to return. Server default is 12; values above 40 are
|
|
2133
|
+
* capped server-side, and values below 1 are rejected with a 400.
|
|
2134
|
+
*/
|
|
2135
|
+
quarters?: number;
|
|
2136
|
+
/**
|
|
2137
|
+
* Up to 100 tickers; adds `positions` to the response. An array is sent comma-joined. A bad
|
|
2138
|
+
* symbol or more than 100 is rejected with a 400. Free keys receive positions only for the
|
|
2139
|
+
* institution's ten largest holdings; other tickers are left out.
|
|
2140
|
+
*/
|
|
2141
|
+
tickers?: string | readonly string[];
|
|
2142
|
+
}
|
|
2143
|
+
/** One filing's holding of one ticker, from an institution's history. */
|
|
2144
|
+
interface InstitutionPositionPoint {
|
|
2145
|
+
/** Quarter end, ISO date (`YYYY-MM-DD`). */
|
|
2146
|
+
reportDate: string;
|
|
2147
|
+
shares: number;
|
|
2148
|
+
/** Position value in US dollars. */
|
|
2149
|
+
valueUsd: number;
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
* One filing of an institution's 13F book.
|
|
2153
|
+
*
|
|
2154
|
+
* Fields marked "AVAILABLE only" are absent unless `comparisonStatus` is `AVAILABLE`, meaning
|
|
2155
|
+
* the filing compares with the immediately preceding quarter. Absent, never zero: a zero would
|
|
2156
|
+
* claim the institution did not trade. The flow figures are estimates from two quarter-end
|
|
2157
|
+
* snapshots, not reported cash flow.
|
|
2158
|
+
*/
|
|
2159
|
+
interface InstitutionHistoryQuarter {
|
|
2160
|
+
/** Quarter end, ISO date (`YYYY-MM-DD`). */
|
|
2161
|
+
reportDate: string;
|
|
2162
|
+
/** Quarter id in `YYYYQN` form, e.g. `"2026Q2"`. */
|
|
2163
|
+
value: string;
|
|
2164
|
+
/** Display label, e.g. `"Q2 2026"`. */
|
|
2165
|
+
label: string;
|
|
2166
|
+
/** `settled` once the quarter's filing deadline has passed, `filing` before. */
|
|
2167
|
+
status: "settled" | "filing" | (string & {});
|
|
2168
|
+
/** `AVAILABLE`, or one of the other values documented for the institution detail. */
|
|
2169
|
+
comparisonStatus: "AVAILABLE" | (string & {});
|
|
2170
|
+
/** The preceding quarter used for the comparison; absent when none applies. */
|
|
2171
|
+
comparisonReportDate?: string;
|
|
2172
|
+
/** Reported equity value of the filing, in US dollars. */
|
|
2173
|
+
totalValueUsd: number;
|
|
2174
|
+
/** Equity positions held. */
|
|
2175
|
+
positionsHeld: number;
|
|
2176
|
+
/** Share of `totalValueUsd` in the ten largest positions, in percent. */
|
|
2177
|
+
top10Pct: number;
|
|
2178
|
+
/** AVAILABLE only. Positions opened. */
|
|
2179
|
+
newPositions?: number;
|
|
2180
|
+
/** AVAILABLE only. Positions added to. */
|
|
2181
|
+
increasedPositions?: number;
|
|
2182
|
+
/** AVAILABLE only. Positions trimmed. */
|
|
2183
|
+
decreasedPositions?: number;
|
|
2184
|
+
/** AVAILABLE only. Positions exited. */
|
|
2185
|
+
soldOutPositions?: number;
|
|
2186
|
+
/** AVAILABLE only. Shares added (new and increased positions) valued at this filing's prices. */
|
|
2187
|
+
boughtUsd?: number;
|
|
2188
|
+
/** AVAILABLE only. Shares sold from positions still held, valued at this filing's prices. */
|
|
2189
|
+
trimmedUsd?: number;
|
|
2190
|
+
/** AVAILABLE only. Positions exited, at the previous filing's value. */
|
|
2191
|
+
exitedUsd?: number;
|
|
2192
|
+
/** AVAILABLE only. `boughtUsd - trimmedUsd - exitedUsd`. */
|
|
2193
|
+
netFlowUsd?: number;
|
|
2194
|
+
/**
|
|
2195
|
+
* AVAILABLE only. The change in `totalValueUsd` since the previous filing minus `netFlowUsd`:
|
|
2196
|
+
* the remainder after trading, mostly price moves. It also absorbs rounding, the different
|
|
2197
|
+
* price bases of exits (previous filing) and trades (this filing), and positions whose change
|
|
2198
|
+
* could not be restated.
|
|
2199
|
+
*/
|
|
2200
|
+
priceEffectUsd?: number;
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
* An institution's 13F book filing by filing, newest first: the `data` payload of
|
|
2204
|
+
* `institutional.getInstitutionHistory()`, which returns `PreviewResponse<InstitutionHistory>`.
|
|
2205
|
+
*/
|
|
2206
|
+
interface InstitutionHistory {
|
|
2207
|
+
filerCik: string;
|
|
2208
|
+
urlSlug: string;
|
|
2209
|
+
displayName: string;
|
|
2210
|
+
quarters: InstitutionHistoryQuarter[];
|
|
2211
|
+
/**
|
|
2212
|
+
* Present only when `tickers` was requested: each ticker maps to its filings, newest first.
|
|
2213
|
+
* A filing in which the institution did not hold the ticker is absent from its list.
|
|
2214
|
+
*/
|
|
2215
|
+
positions?: Record<string, InstitutionPositionPoint[]>;
|
|
2216
|
+
}
|
|
2035
2217
|
/** A single institution summary from the discovery list. */
|
|
2036
2218
|
interface InstitutionSummary {
|
|
2037
2219
|
/** SEC Central Index Key of the (rolled-up) institution. */
|
|
@@ -4706,8 +4888,55 @@ declare class Institutional {
|
|
|
4706
4888
|
* The signature remains unknown for compatibility. Opt in to the exported
|
|
4707
4889
|
* PreviewResponse<InstitutionDetail> type to read data.positionsHeld, the full
|
|
4708
4890
|
* portfolio count excluding SOLD_OUT rows, even on a truncated holdings list.
|
|
4891
|
+
*
|
|
4892
|
+
* When the filing compares with the preceding quarter (`comparisonStatus` is `AVAILABLE`),
|
|
4893
|
+
* the payload also carries `priorTotalValueUsd` and `priorPositionsHeld`, and each holding
|
|
4894
|
+
* carries `priorValueUsd`, `priorPortfolioWeight` and `estimatedFlowUsd` (an estimate from
|
|
4895
|
+
* two quarter-end snapshots, not a reported trade). Each is absent when it does not apply.
|
|
4896
|
+
*
|
|
4897
|
+
* `options.limit` returns a sorted page of holdings and adds `returnedCount` and `offset` to
|
|
4898
|
+
* `data` and `totalCount` to the envelope; `sortBy`, `sortDir`, `changeType`, `q` and
|
|
4899
|
+
* `minWeight` only take effect together with it (PRO only). `changeType` also accepts `"HELD"`,
|
|
4900
|
+
* every position still held whatever its change; values combine as a union. With a filter set, `data.matchTotals`
|
|
4901
|
+
* sums every matching holding, not just the page. Calling without `options` is unchanged.
|
|
4902
|
+
*
|
|
4903
|
+
* @example
|
|
4904
|
+
* const page = await client.institutional.getInstitutionDetail("Berkshire-Hathaway", {
|
|
4905
|
+
* limit: 10,
|
|
4906
|
+
* sortBy: "estimatedFlowUsd",
|
|
4907
|
+
* changeType: ["NEW", "INCREASED"],
|
|
4908
|
+
* }) as PreviewResponse<InstitutionDetail>;
|
|
4909
|
+
*/
|
|
4910
|
+
getInstitutionDetail(slugOrCik: string, options?: GetInstitutionDetailOptions): Promise<unknown>;
|
|
4911
|
+
/**
|
|
4912
|
+
* Get an institution's 13F book filing by filing, newest first.
|
|
4913
|
+
*
|
|
4914
|
+
* Returns the preview envelope wrapping an {@link InstitutionHistory}, so the rows are two
|
|
4915
|
+
* levels down: `(await getInstitutionHistory(s)).data.quarters`. Each row carries the
|
|
4916
|
+
* filing's reported value, positions held and top-10 concentration, and, when it compares
|
|
4917
|
+
* with the quarter before (`comparisonStatus: "AVAILABLE"`), the position counts and the
|
|
4918
|
+
* estimated dollars bought, trimmed and exited. Those comparison fields are absent
|
|
4919
|
+
* otherwise, never zero. The flows are estimates from two quarter-end snapshots, not
|
|
4920
|
+
* reported cash flow. A 13F covers long US-listed equity only.
|
|
4921
|
+
*
|
|
4922
|
+
* Pass `tickers` to also get `data.positions`: each ticker maps to its shares and value per
|
|
4923
|
+
* filing, newest first. A filing in which the institution did not hold the ticker is absent
|
|
4924
|
+
* from its list. Free keys receive positions only for the institution's ten largest
|
|
4925
|
+
* holdings; other tickers are left out.
|
|
4926
|
+
*
|
|
4927
|
+
* Free keys receive the newest four filings with `isPreview: true` and `totalCount` holding
|
|
4928
|
+
* the number of filings in the requested window. The first request for a large multi-filer
|
|
4929
|
+
* institution can take a few seconds; when too many such computations run at once the API
|
|
4930
|
+
* answers 503 with a `Retry-After` header.
|
|
4931
|
+
*
|
|
4932
|
+
* @example
|
|
4933
|
+
* const { data } = await client.institutional.getInstitutionHistory("Renaissance-Technologies", {
|
|
4934
|
+
* quarters: 8,
|
|
4935
|
+
* tickers: ["NVDA", "META"],
|
|
4936
|
+
* });
|
|
4937
|
+
* for (const q of data.quarters) console.log(q.label, q.totalValueUsd, q.netFlowUsd);
|
|
4709
4938
|
*/
|
|
4710
|
-
|
|
4939
|
+
getInstitutionHistory(slugOrCik: string, options?: GetInstitutionHistoryOptions): Promise<PreviewResponse<InstitutionHistory>>;
|
|
4711
4940
|
}
|
|
4712
4941
|
|
|
4713
4942
|
/** Public entity types the search `type` filter accepts, and that come back on a hit. */
|
|
@@ -5339,6 +5568,6 @@ declare class APIError extends SentiSenseError {
|
|
|
5339
5568
|
constructor(message: string, status: number, code?: string);
|
|
5340
5569
|
}
|
|
5341
5570
|
|
|
5342
|
-
declare const VERSION = "0.
|
|
5571
|
+
declare const VERSION = "0.74.0";
|
|
5343
5572
|
|
|
5344
|
-
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 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 InstitutionDetail, 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 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 };
|
|
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 };
|