@invinite-org/data-api-client 5.9.0 → 5.10.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.
Files changed (61) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/dist/apis/HoldingsApi.d.ts +57 -2
  3. package/dist/apis/HoldingsApi.js +142 -3
  4. package/dist/esm/apis/HoldingsApi.d.ts +57 -2
  5. package/dist/esm/apis/HoldingsApi.js +141 -2
  6. package/dist/esm/models/EtfHolding.d.ts +167 -0
  7. package/dist/esm/models/EtfHolding.js +97 -0
  8. package/dist/esm/models/EtfWeight.d.ts +92 -0
  9. package/dist/esm/models/EtfWeight.js +85 -0
  10. package/dist/esm/models/ListEtfHoldings200Response.d.ts +52 -0
  11. package/dist/esm/models/ListEtfHoldings200Response.js +57 -0
  12. package/dist/esm/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
  13. package/dist/esm/models/ListEtfHoldings200ResponseMeta.js +72 -0
  14. package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
  15. package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.js +50 -0
  16. package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
  17. package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +59 -0
  18. package/dist/esm/models/ListEtfWeights200Response.d.ts +52 -0
  19. package/dist/esm/models/ListEtfWeights200Response.js +57 -0
  20. package/dist/esm/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
  21. package/dist/esm/models/ListEtfWeights200ResponseMeta.js +79 -0
  22. package/dist/esm/models/index.d.ts +8 -0
  23. package/dist/esm/models/index.js +8 -0
  24. package/dist/models/EtfHolding.d.ts +167 -0
  25. package/dist/models/EtfHolding.js +105 -0
  26. package/dist/models/EtfWeight.d.ts +92 -0
  27. package/dist/models/EtfWeight.js +93 -0
  28. package/dist/models/ListEtfHoldings200Response.d.ts +52 -0
  29. package/dist/models/ListEtfHoldings200Response.js +64 -0
  30. package/dist/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
  31. package/dist/models/ListEtfHoldings200ResponseMeta.js +80 -0
  32. package/dist/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
  33. package/dist/models/ListEtfHoldings200ResponseMetaComposition.js +57 -0
  34. package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
  35. package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +67 -0
  36. package/dist/models/ListEtfWeights200Response.d.ts +52 -0
  37. package/dist/models/ListEtfWeights200Response.js +64 -0
  38. package/dist/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
  39. package/dist/models/ListEtfWeights200ResponseMeta.js +87 -0
  40. package/dist/models/index.d.ts +8 -0
  41. package/dist/models/index.js +8 -0
  42. package/docs/EtfHolding.md +76 -0
  43. package/docs/EtfWeight.md +48 -0
  44. package/docs/HoldingsApi.md +196 -1
  45. package/docs/ListEtfHoldings200Response.md +41 -0
  46. package/docs/ListEtfHoldings200ResponseMeta.md +47 -0
  47. package/docs/ListEtfHoldings200ResponseMetaComposition.md +43 -0
  48. package/docs/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.md +41 -0
  49. package/docs/ListEtfWeights200Response.md +41 -0
  50. package/docs/ListEtfWeights200ResponseMeta.md +45 -0
  51. package/package.json +1 -1
  52. package/src/apis/HoldingsApi.ts +192 -2
  53. package/src/models/EtfHolding.ts +248 -0
  54. package/src/models/EtfWeight.ts +150 -0
  55. package/src/models/ListEtfHoldings200Response.ts +108 -0
  56. package/src/models/ListEtfHoldings200ResponseMeta.ts +151 -0
  57. package/src/models/ListEtfHoldings200ResponseMetaComposition.ts +105 -0
  58. package/src/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.ts +103 -0
  59. package/src/models/ListEtfWeights200Response.ts +108 -0
  60. package/src/models/ListEtfWeights200ResponseMeta.ts +148 -0
  61. package/src/models/index.ts +8 -0
@@ -13,6 +13,16 @@
13
13
  */
14
14
 
15
15
  import * as runtime from '../runtime';
16
+ import {
17
+ type ListEtfHoldings200Response,
18
+ ListEtfHoldings200ResponseFromJSON,
19
+ ListEtfHoldings200ResponseToJSON,
20
+ } from '../models/ListEtfHoldings200Response';
21
+ import {
22
+ type ListEtfWeights200Response,
23
+ ListEtfWeights200ResponseFromJSON,
24
+ ListEtfWeights200ResponseToJSON,
25
+ } from '../models/ListEtfWeights200Response';
16
26
  import {
17
27
  type ListFundHoldings200Response,
18
28
  ListFundHoldings200ResponseFromJSON,
@@ -34,6 +44,25 @@ import {
34
44
  ProblemToJSON,
35
45
  } from '../models/Problem';
36
46
 
47
+ export interface ListEtfHoldingsRequest {
48
+ etf?: string;
49
+ company?: string;
50
+ asOf?: Date;
51
+ sort?: ListEtfHoldingsSortEnum;
52
+ fields?: string;
53
+ limit?: number;
54
+ cursor?: string;
55
+ }
56
+
57
+ export interface ListEtfWeightsRequest {
58
+ etf: string;
59
+ dimension?: string;
60
+ asOf?: Date;
61
+ fields?: string;
62
+ limit?: number;
63
+ cursor?: string;
64
+ }
65
+
37
66
  export interface ListFundHoldingsRequest {
38
67
  company?: string;
39
68
  filer?: string;
@@ -74,6 +103,159 @@ export interface ListHoldingsRequest {
74
103
  */
75
104
  export class HoldingsApi extends runtime.BaseAPI {
76
105
 
106
+ /**
107
+ * Creates request options for listEtfHoldings without sending the request
108
+ */
109
+ async listEtfHoldingsRequestOpts(requestParameters: ListEtfHoldingsRequest): Promise<runtime.RequestOpts> {
110
+ const queryParameters: any = {};
111
+
112
+ if (requestParameters['etf'] != null) {
113
+ queryParameters['etf'] = requestParameters['etf'];
114
+ }
115
+
116
+ if (requestParameters['company'] != null) {
117
+ queryParameters['company'] = requestParameters['company'];
118
+ }
119
+
120
+ if (requestParameters['asOf'] != null) {
121
+ queryParameters['as_of'] = (requestParameters['asOf'] as any).toISOString().substring(0,10);
122
+ }
123
+
124
+ if (requestParameters['sort'] != null) {
125
+ queryParameters['sort'] = requestParameters['sort'];
126
+ }
127
+
128
+ if (requestParameters['fields'] != null) {
129
+ queryParameters['fields'] = requestParameters['fields'];
130
+ }
131
+
132
+ if (requestParameters['limit'] != null) {
133
+ queryParameters['limit'] = requestParameters['limit'];
134
+ }
135
+
136
+ if (requestParameters['cursor'] != null) {
137
+ queryParameters['cursor'] = requestParameters['cursor'];
138
+ }
139
+
140
+ const headerParameters: runtime.HTTPHeaders = {};
141
+
142
+ if (this.configuration && this.configuration.accessToken) {
143
+ const token = this.configuration.accessToken;
144
+ const tokenString = await token("bearerAuth", []);
145
+
146
+ if (tokenString) {
147
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
148
+ }
149
+ }
150
+
151
+ let urlPath = `/v1/etf-holdings`;
152
+
153
+ return {
154
+ path: urlPath,
155
+ method: 'GET',
156
+ headers: headerParameters,
157
+ query: queryParameters,
158
+ };
159
+ }
160
+
161
+ /**
162
+ * The holdings of US ETFs from the freshest source per ETF, always named: the issuer\'s own daily (or monthly) holdings file where the store reads one, else the fund\'s latest public N-PORT report (quarter end, about 60 days later). `etf=` lists one ETF\'s positions (`meta.source`, `meta.as_of`; `as_of=` reads a stored earlier date, `meta.composition.stored_dates` lists them), order `-weight_pct`; `company=` lists the ETFs whose newest issuer file holds the company (one row per ETF, its lines of the company summed; ETFs known only from N-PORT are listed by `/v1/fund-holdings?company=`), order `-market_value_usd`. Exactly one of `etf` or `company`. A single-asset trust (GLD) has no rows by design (`meta.reason: single_asset_trust`). `EtfHolding` is not `FundHolding` (R16): `/v1/fund-holdings` serves filed N-PORT rows per report (with `accession_number` and `report_date`); this collection is the current composition of a listed ETF by ticker and falls back to N-PORT only where no issuer file is read.
163
+ * List ETF holdings (daily issuer files or N-PORT)
164
+ */
165
+ async listEtfHoldingsRaw(requestParameters: ListEtfHoldingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEtfHoldings200Response>> {
166
+ const requestOptions = await this.listEtfHoldingsRequestOpts(requestParameters);
167
+ const response = await this.request(requestOptions, initOverrides);
168
+
169
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListEtfHoldings200ResponseFromJSON(jsonValue));
170
+ }
171
+
172
+ /**
173
+ * The holdings of US ETFs from the freshest source per ETF, always named: the issuer\'s own daily (or monthly) holdings file where the store reads one, else the fund\'s latest public N-PORT report (quarter end, about 60 days later). `etf=` lists one ETF\'s positions (`meta.source`, `meta.as_of`; `as_of=` reads a stored earlier date, `meta.composition.stored_dates` lists them), order `-weight_pct`; `company=` lists the ETFs whose newest issuer file holds the company (one row per ETF, its lines of the company summed; ETFs known only from N-PORT are listed by `/v1/fund-holdings?company=`), order `-market_value_usd`. Exactly one of `etf` or `company`. A single-asset trust (GLD) has no rows by design (`meta.reason: single_asset_trust`). `EtfHolding` is not `FundHolding` (R16): `/v1/fund-holdings` serves filed N-PORT rows per report (with `accession_number` and `report_date`); this collection is the current composition of a listed ETF by ticker and falls back to N-PORT only where no issuer file is read.
174
+ * List ETF holdings (daily issuer files or N-PORT)
175
+ */
176
+ async listEtfHoldings(requestParameters: ListEtfHoldingsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEtfHoldings200Response> {
177
+ const response = await this.listEtfHoldingsRaw(requestParameters, initOverrides);
178
+ return await response.value();
179
+ }
180
+
181
+ /**
182
+ * Creates request options for listEtfWeights without sending the request
183
+ */
184
+ async listEtfWeightsRequestOpts(requestParameters: ListEtfWeightsRequest): Promise<runtime.RequestOpts> {
185
+ if (requestParameters['etf'] == null) {
186
+ throw new runtime.RequiredError(
187
+ 'etf',
188
+ 'Required parameter "etf" was null or undefined when calling listEtfWeights().'
189
+ );
190
+ }
191
+
192
+ const queryParameters: any = {};
193
+
194
+ if (requestParameters['etf'] != null) {
195
+ queryParameters['etf'] = requestParameters['etf'];
196
+ }
197
+
198
+ if (requestParameters['dimension'] != null) {
199
+ queryParameters['dimension'] = requestParameters['dimension'];
200
+ }
201
+
202
+ if (requestParameters['asOf'] != null) {
203
+ queryParameters['as_of'] = (requestParameters['asOf'] as any).toISOString().substring(0,10);
204
+ }
205
+
206
+ if (requestParameters['fields'] != null) {
207
+ queryParameters['fields'] = requestParameters['fields'];
208
+ }
209
+
210
+ if (requestParameters['limit'] != null) {
211
+ queryParameters['limit'] = requestParameters['limit'];
212
+ }
213
+
214
+ if (requestParameters['cursor'] != null) {
215
+ queryParameters['cursor'] = requestParameters['cursor'];
216
+ }
217
+
218
+ const headerParameters: runtime.HTTPHeaders = {};
219
+
220
+ if (this.configuration && this.configuration.accessToken) {
221
+ const token = this.configuration.accessToken;
222
+ const tokenString = await token("bearerAuth", []);
223
+
224
+ if (tokenString) {
225
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
226
+ }
227
+ }
228
+
229
+ let urlPath = `/v1/etf-weights`;
230
+
231
+ return {
232
+ path: urlPath,
233
+ method: 'GET',
234
+ headers: headerParameters,
235
+ query: queryParameters,
236
+ };
237
+ }
238
+
239
+ /**
240
+ * Sector, country and asset-class weights of one US ETF, from the same composition `/v1/etf-holdings?etf=` answers from (`meta.source`, `meta.as_of`): sector = the issuer\'s stated sector, else the SEC SIC sector of the holding\'s issuer; country = the stated location, else the N-PORT country / ISIN prefix / registrant country (each bucket names its `basis`, `mixed` when its positions differ); weights in percent of the fund. `dimension=` one or several of sector, country, asset_class (default all). An ETF without buckets for the chosen source answers `data: []` with `meta.reason: weights_unavailable`; a single-asset trust `meta.reason: single_asset_trust`. Positions themselves: `/v1/etf-holdings`; filed N-PORT rows: `/v1/fund-holdings`.
241
+ * List ETF sector, country and asset-class weights
242
+ */
243
+ async listEtfWeightsRaw(requestParameters: ListEtfWeightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEtfWeights200Response>> {
244
+ const requestOptions = await this.listEtfWeightsRequestOpts(requestParameters);
245
+ const response = await this.request(requestOptions, initOverrides);
246
+
247
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListEtfWeights200ResponseFromJSON(jsonValue));
248
+ }
249
+
250
+ /**
251
+ * Sector, country and asset-class weights of one US ETF, from the same composition `/v1/etf-holdings?etf=` answers from (`meta.source`, `meta.as_of`): sector = the issuer\'s stated sector, else the SEC SIC sector of the holding\'s issuer; country = the stated location, else the N-PORT country / ISIN prefix / registrant country (each bucket names its `basis`, `mixed` when its positions differ); weights in percent of the fund. `dimension=` one or several of sector, country, asset_class (default all). An ETF without buckets for the chosen source answers `data: []` with `meta.reason: weights_unavailable`; a single-asset trust `meta.reason: single_asset_trust`. Positions themselves: `/v1/etf-holdings`; filed N-PORT rows: `/v1/fund-holdings`.
252
+ * List ETF sector, country and asset-class weights
253
+ */
254
+ async listEtfWeights(requestParameters: ListEtfWeightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEtfWeights200Response> {
255
+ const response = await this.listEtfWeightsRaw(requestParameters, initOverrides);
256
+ return await response.value();
257
+ }
258
+
77
259
  /**
78
260
  * Creates request options for listFundHoldings without sending the request
79
261
  */
@@ -138,7 +320,7 @@ export class HoldingsApi extends runtime.BaseAPI {
138
320
  }
139
321
 
140
322
  /**
141
- * N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
323
+ * N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers. ETFs\' current composition (daily issuer files, falling back to N-PORT): `/v1/etf-holdings`.
142
324
  * List N-PORT fund holdings
143
325
  */
144
326
  async listFundHoldingsRaw(requestParameters: ListFundHoldingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFundHoldings200Response>> {
@@ -149,7 +331,7 @@ export class HoldingsApi extends runtime.BaseAPI {
149
331
  }
150
332
 
151
333
  /**
152
- * N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
334
+ * N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers. ETFs\' current composition (daily issuer files, falling back to N-PORT): `/v1/etf-holdings`.
153
335
  * List N-PORT fund holdings
154
336
  */
155
337
  async listFundHoldings(requestParameters: ListFundHoldingsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFundHoldings200Response> {
@@ -321,6 +503,14 @@ export class HoldingsApi extends runtime.BaseAPI {
321
503
 
322
504
  }
323
505
 
506
+ /**
507
+ * @export
508
+ */
509
+ export const ListEtfHoldingsSortEnum = {
510
+ WeightPct: '-weight_pct',
511
+ MarketValueUsd: '-market_value_usd'
512
+ } as const;
513
+ export type ListEtfHoldingsSortEnum = typeof ListEtfHoldingsSortEnum[keyof typeof ListEtfHoldingsSortEnum];
324
514
  /**
325
515
  * @export
326
516
  */
@@ -0,0 +1,248 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface EtfHolding
20
+ */
21
+ export interface EtfHolding {
22
+ /**
23
+ * The ETF's ticker
24
+ * @type {string}
25
+ * @memberof EtfHolding
26
+ */
27
+ etf_symbol: string;
28
+ /**
29
+ * The ETF's name
30
+ * @type {string}
31
+ * @memberof EtfHolding
32
+ */
33
+ etf_name?: string | null;
34
+ /**
35
+ * SEC series id of the ETF's fund (S + 9 digits); null for a unit investment trust and on company= rows
36
+ * @type {string}
37
+ * @memberof EtfHolding
38
+ */
39
+ series_id?: string | null;
40
+ /**
41
+ * issuer_daily / issuer_monthly = the issuer's holdings file, nport = the fund's latest public N-PORT report
42
+ * @type {EtfHoldingSourceEnum}
43
+ * @memberof EtfHolding
44
+ */
45
+ source: EtfHoldingSourceEnum;
46
+ /**
47
+ * The date the composition is stated as of
48
+ * @type {Date}
49
+ * @memberof EtfHolding
50
+ */
51
+ as_of: Date;
52
+ /**
53
+ * Line of the position in its source (issuer file line, N-PORT source line); null on company= rows (lines summed)
54
+ * @type {number}
55
+ * @memberof EtfHolding
56
+ */
57
+ line?: number | null;
58
+ /**
59
+ * Holding name as stated (company= rows: the requested company)
60
+ * @type {string}
61
+ * @memberof EtfHolding
62
+ */
63
+ name?: string | null;
64
+ /**
65
+ * Holding ticker as stated (company= rows: the requested company's ticker)
66
+ * @type {string}
67
+ * @memberof EtfHolding
68
+ */
69
+ ticker?: string | null;
70
+ /**
71
+ * Holding CUSIP
72
+ * @type {string}
73
+ * @memberof EtfHolding
74
+ */
75
+ cusip?: string | null;
76
+ /**
77
+ * Holding ISIN
78
+ * @type {string}
79
+ * @memberof EtfHolding
80
+ */
81
+ isin?: string | null;
82
+ /**
83
+ * Holding SEDOL (issuer files only)
84
+ * @type {string}
85
+ * @memberof EtfHolding
86
+ */
87
+ sedol?: string | null;
88
+ /**
89
+ * equity, fixed_income, cash, derivative, fund, commodity, crypto or other
90
+ * @type {string}
91
+ * @memberof EtfHolding
92
+ */
93
+ asset_class?: string | null;
94
+ /**
95
+ * Shares held; null for a non-share position (principal, contracts)
96
+ * @type {number}
97
+ * @memberof EtfHolding
98
+ */
99
+ shares?: number | null;
100
+ /**
101
+ * Market value in USD as stated
102
+ * @type {number}
103
+ * @memberof EtfHolding
104
+ */
105
+ market_value_usd?: number | null;
106
+ /**
107
+ * Notional value in USD of a derivative (issuer files only)
108
+ * @type {number}
109
+ * @memberof EtfHolding
110
+ */
111
+ notional_value_usd?: number | null;
112
+ /**
113
+ * Percent of the fund (7.1 = 7.1 %; N-PORT: percent of net assets)
114
+ * @type {number}
115
+ * @memberof EtfHolding
116
+ */
117
+ weight_pct?: number | null;
118
+ /**
119
+ * Sector: as the issuer stated it, else the SEC SIC sector of the holding's issuer
120
+ * @type {string}
121
+ * @memberof EtfHolding
122
+ */
123
+ sector?: string | null;
124
+ /**
125
+ * issuer_stated, derived_sic or none
126
+ * @type {string}
127
+ * @memberof EtfHolding
128
+ */
129
+ sector_basis?: string | null;
130
+ /**
131
+ * Country (ISO alpha-2 where it maps): as stated, else derived
132
+ * @type {string}
133
+ * @memberof EtfHolding
134
+ */
135
+ country?: string | null;
136
+ /**
137
+ * issuer_stated, nport, isin_prefix, registrant or none
138
+ * @type {string}
139
+ * @memberof EtfHolding
140
+ */
141
+ country_basis?: string | null;
142
+ /**
143
+ * Issuer CIK of the holding, 10 digits; null when it did not resolve
144
+ * @type {string}
145
+ * @memberof EtfHolding
146
+ */
147
+ issuer_cik?: string | null;
148
+ /**
149
+ * How issuer_cik was found: cusip_cache, isin, ticker, not_equity or unresolved
150
+ * @type {string}
151
+ * @memberof EtfHolding
152
+ */
153
+ issuer_resolution?: string | null;
154
+ }
155
+
156
+
157
+ /**
158
+ * @export
159
+ */
160
+ export const EtfHoldingSourceEnum = {
161
+ IssuerDaily: 'issuer_daily',
162
+ IssuerMonthly: 'issuer_monthly',
163
+ Nport: 'nport'
164
+ } as const;
165
+ export type EtfHoldingSourceEnum = typeof EtfHoldingSourceEnum[keyof typeof EtfHoldingSourceEnum] | (string & {});
166
+
167
+
168
+ /**
169
+ * Check if a given object implements the EtfHolding interface.
170
+ */
171
+ export function instanceOfEtfHolding(value: object): value is EtfHolding {
172
+ if (!('etf_symbol' in value) || value['etf_symbol'] === undefined) return false;
173
+ if (!('source' in value) || value['source'] === undefined) return false;
174
+ if (!('as_of' in value) || value['as_of'] === undefined) return false;
175
+ return true;
176
+ }
177
+
178
+ export function EtfHoldingFromJSON(json: any): EtfHolding {
179
+ return EtfHoldingFromJSONTyped(json, false);
180
+ }
181
+
182
+ export function EtfHoldingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EtfHolding {
183
+ if (json == null) {
184
+ return json;
185
+ }
186
+ return {
187
+
188
+ 'etf_symbol': json['etf_symbol'],
189
+ 'etf_name': json['etf_name'] == null ? undefined : json['etf_name'],
190
+ 'series_id': json['series_id'] == null ? undefined : json['series_id'],
191
+ 'source': json['source'],
192
+ 'as_of': (new Date(json['as_of'])),
193
+ 'line': json['line'] == null ? undefined : json['line'],
194
+ 'name': json['name'] == null ? undefined : json['name'],
195
+ 'ticker': json['ticker'] == null ? undefined : json['ticker'],
196
+ 'cusip': json['cusip'] == null ? undefined : json['cusip'],
197
+ 'isin': json['isin'] == null ? undefined : json['isin'],
198
+ 'sedol': json['sedol'] == null ? undefined : json['sedol'],
199
+ 'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
200
+ 'shares': json['shares'] == null ? undefined : json['shares'],
201
+ 'market_value_usd': json['market_value_usd'] == null ? undefined : json['market_value_usd'],
202
+ 'notional_value_usd': json['notional_value_usd'] == null ? undefined : json['notional_value_usd'],
203
+ 'weight_pct': json['weight_pct'] == null ? undefined : json['weight_pct'],
204
+ 'sector': json['sector'] == null ? undefined : json['sector'],
205
+ 'sector_basis': json['sector_basis'] == null ? undefined : json['sector_basis'],
206
+ 'country': json['country'] == null ? undefined : json['country'],
207
+ 'country_basis': json['country_basis'] == null ? undefined : json['country_basis'],
208
+ 'issuer_cik': json['issuer_cik'] == null ? undefined : json['issuer_cik'],
209
+ 'issuer_resolution': json['issuer_resolution'] == null ? undefined : json['issuer_resolution'],
210
+ };
211
+ }
212
+
213
+ export function EtfHoldingToJSON(json: any): EtfHolding {
214
+ return EtfHoldingToJSONTyped(json, false);
215
+ }
216
+
217
+ export function EtfHoldingToJSONTyped(value?: EtfHolding | null, ignoreDiscriminator: boolean = false): any {
218
+ if (value == null) {
219
+ return value;
220
+ }
221
+
222
+ return {
223
+
224
+ 'etf_symbol': value['etf_symbol'],
225
+ 'etf_name': value['etf_name'],
226
+ 'series_id': value['series_id'],
227
+ 'source': value['source'],
228
+ 'as_of': value['as_of'].toISOString().substring(0,10),
229
+ 'line': value['line'],
230
+ 'name': value['name'],
231
+ 'ticker': value['ticker'],
232
+ 'cusip': value['cusip'],
233
+ 'isin': value['isin'],
234
+ 'sedol': value['sedol'],
235
+ 'asset_class': value['asset_class'],
236
+ 'shares': value['shares'],
237
+ 'market_value_usd': value['market_value_usd'],
238
+ 'notional_value_usd': value['notional_value_usd'],
239
+ 'weight_pct': value['weight_pct'],
240
+ 'sector': value['sector'],
241
+ 'sector_basis': value['sector_basis'],
242
+ 'country': value['country'],
243
+ 'country_basis': value['country_basis'],
244
+ 'issuer_cik': value['issuer_cik'],
245
+ 'issuer_resolution': value['issuer_resolution'],
246
+ };
247
+ }
248
+
@@ -0,0 +1,150 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface EtfWeight
20
+ */
21
+ export interface EtfWeight {
22
+ /**
23
+ * The ETF's ticker
24
+ * @type {string}
25
+ * @memberof EtfWeight
26
+ */
27
+ etf_symbol: string;
28
+ /**
29
+ * The composition the weights come from
30
+ * @type {EtfWeightSourceEnum}
31
+ * @memberof EtfWeight
32
+ */
33
+ source: EtfWeightSourceEnum;
34
+ /**
35
+ * The date the composition is stated as of
36
+ * @type {Date}
37
+ * @memberof EtfWeight
38
+ */
39
+ as_of: Date;
40
+ /**
41
+ * sector, country or asset_class
42
+ * @type {EtfWeightDimensionEnum}
43
+ * @memberof EtfWeight
44
+ */
45
+ dimension: EtfWeightDimensionEnum;
46
+ /**
47
+ * The bucket label (a sector, an ISO country code, an asset class; Unclassified / Cash and other)
48
+ * @type {string}
49
+ * @memberof EtfWeight
50
+ */
51
+ bucket: string;
52
+ /**
53
+ * Percent of the fund in this bucket
54
+ * @type {number}
55
+ * @memberof EtfWeight
56
+ */
57
+ weight_pct: number;
58
+ /**
59
+ * Positions in the bucket
60
+ * @type {number}
61
+ * @memberof EtfWeight
62
+ */
63
+ positions?: number | null;
64
+ /**
65
+ * issuer_stated, derived_sic, nport, isin_prefix, registrant, mixed or none
66
+ * @type {string}
67
+ * @memberof EtfWeight
68
+ */
69
+ basis: string;
70
+ }
71
+
72
+
73
+ /**
74
+ * @export
75
+ */
76
+ export const EtfWeightSourceEnum = {
77
+ IssuerDaily: 'issuer_daily',
78
+ IssuerMonthly: 'issuer_monthly',
79
+ Nport: 'nport'
80
+ } as const;
81
+ export type EtfWeightSourceEnum = typeof EtfWeightSourceEnum[keyof typeof EtfWeightSourceEnum] | (string & {});
82
+
83
+ /**
84
+ * @export
85
+ */
86
+ export const EtfWeightDimensionEnum = {
87
+ Sector: 'sector',
88
+ Country: 'country',
89
+ AssetClass: 'asset_class'
90
+ } as const;
91
+ export type EtfWeightDimensionEnum = typeof EtfWeightDimensionEnum[keyof typeof EtfWeightDimensionEnum] | (string & {});
92
+
93
+
94
+ /**
95
+ * Check if a given object implements the EtfWeight interface.
96
+ */
97
+ export function instanceOfEtfWeight(value: object): value is EtfWeight {
98
+ if (!('etf_symbol' in value) || value['etf_symbol'] === undefined) return false;
99
+ if (!('source' in value) || value['source'] === undefined) return false;
100
+ if (!('as_of' in value) || value['as_of'] === undefined) return false;
101
+ if (!('dimension' in value) || value['dimension'] === undefined) return false;
102
+ if (!('bucket' in value) || value['bucket'] === undefined) return false;
103
+ if (!('weight_pct' in value) || value['weight_pct'] === undefined) return false;
104
+ if (!('basis' in value) || value['basis'] === undefined) return false;
105
+ return true;
106
+ }
107
+
108
+ export function EtfWeightFromJSON(json: any): EtfWeight {
109
+ return EtfWeightFromJSONTyped(json, false);
110
+ }
111
+
112
+ export function EtfWeightFromJSONTyped(json: any, ignoreDiscriminator: boolean): EtfWeight {
113
+ if (json == null) {
114
+ return json;
115
+ }
116
+ return {
117
+
118
+ 'etf_symbol': json['etf_symbol'],
119
+ 'source': json['source'],
120
+ 'as_of': (new Date(json['as_of'])),
121
+ 'dimension': json['dimension'],
122
+ 'bucket': json['bucket'],
123
+ 'weight_pct': json['weight_pct'],
124
+ 'positions': json['positions'] == null ? undefined : json['positions'],
125
+ 'basis': json['basis'],
126
+ };
127
+ }
128
+
129
+ export function EtfWeightToJSON(json: any): EtfWeight {
130
+ return EtfWeightToJSONTyped(json, false);
131
+ }
132
+
133
+ export function EtfWeightToJSONTyped(value?: EtfWeight | null, ignoreDiscriminator: boolean = false): any {
134
+ if (value == null) {
135
+ return value;
136
+ }
137
+
138
+ return {
139
+
140
+ 'etf_symbol': value['etf_symbol'],
141
+ 'source': value['source'],
142
+ 'as_of': value['as_of'].toISOString().substring(0,10),
143
+ 'dimension': value['dimension'],
144
+ 'bucket': value['bucket'],
145
+ 'weight_pct': value['weight_pct'],
146
+ 'positions': value['positions'],
147
+ 'basis': value['basis'],
148
+ };
149
+ }
150
+