@invinite-org/data-api-client 5.7.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 (77) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/dist/apis/EventsApi.d.ts +2 -2
  3. package/dist/apis/EventsApi.js +2 -2
  4. package/dist/apis/HoldingsApi.d.ts +57 -2
  5. package/dist/apis/HoldingsApi.js +142 -3
  6. package/dist/esm/apis/EventsApi.d.ts +2 -2
  7. package/dist/esm/apis/EventsApi.js +2 -2
  8. package/dist/esm/apis/HoldingsApi.d.ts +57 -2
  9. package/dist/esm/apis/HoldingsApi.js +141 -2
  10. package/dist/esm/models/EtfHolding.d.ts +167 -0
  11. package/dist/esm/models/EtfHolding.js +97 -0
  12. package/dist/esm/models/EtfWeight.d.ts +92 -0
  13. package/dist/esm/models/EtfWeight.js +85 -0
  14. package/dist/esm/models/Event.d.ts +2 -1
  15. package/dist/esm/models/Event.js +2 -1
  16. package/dist/esm/models/EventCalendarCall.d.ts +2 -1
  17. package/dist/esm/models/EventCalendarCall.js +1 -0
  18. package/dist/esm/models/ListEtfHoldings200Response.d.ts +52 -0
  19. package/dist/esm/models/ListEtfHoldings200Response.js +57 -0
  20. package/dist/esm/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
  21. package/dist/esm/models/ListEtfHoldings200ResponseMeta.js +72 -0
  22. package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
  23. package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.js +50 -0
  24. package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
  25. package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +59 -0
  26. package/dist/esm/models/ListEtfWeights200Response.d.ts +52 -0
  27. package/dist/esm/models/ListEtfWeights200Response.js +57 -0
  28. package/dist/esm/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
  29. package/dist/esm/models/ListEtfWeights200ResponseMeta.js +79 -0
  30. package/dist/esm/models/index.d.ts +8 -0
  31. package/dist/esm/models/index.js +8 -0
  32. package/dist/models/EtfHolding.d.ts +167 -0
  33. package/dist/models/EtfHolding.js +105 -0
  34. package/dist/models/EtfWeight.d.ts +92 -0
  35. package/dist/models/EtfWeight.js +93 -0
  36. package/dist/models/Event.d.ts +2 -1
  37. package/dist/models/Event.js +2 -1
  38. package/dist/models/EventCalendarCall.d.ts +2 -1
  39. package/dist/models/EventCalendarCall.js +1 -0
  40. package/dist/models/ListEtfHoldings200Response.d.ts +52 -0
  41. package/dist/models/ListEtfHoldings200Response.js +64 -0
  42. package/dist/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
  43. package/dist/models/ListEtfHoldings200ResponseMeta.js +80 -0
  44. package/dist/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
  45. package/dist/models/ListEtfHoldings200ResponseMetaComposition.js +57 -0
  46. package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
  47. package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +67 -0
  48. package/dist/models/ListEtfWeights200Response.d.ts +52 -0
  49. package/dist/models/ListEtfWeights200Response.js +64 -0
  50. package/dist/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
  51. package/dist/models/ListEtfWeights200ResponseMeta.js +87 -0
  52. package/dist/models/index.d.ts +8 -0
  53. package/dist/models/index.js +8 -0
  54. package/docs/EtfHolding.md +76 -0
  55. package/docs/EtfWeight.md +48 -0
  56. package/docs/EventsApi.md +1 -1
  57. package/docs/HoldingsApi.md +196 -1
  58. package/docs/ListEtfHoldings200Response.md +41 -0
  59. package/docs/ListEtfHoldings200ResponseMeta.md +47 -0
  60. package/docs/ListEtfHoldings200ResponseMetaComposition.md +43 -0
  61. package/docs/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.md +41 -0
  62. package/docs/ListEtfWeights200Response.md +41 -0
  63. package/docs/ListEtfWeights200ResponseMeta.md +45 -0
  64. package/package.json +1 -1
  65. package/src/apis/EventsApi.ts +2 -2
  66. package/src/apis/HoldingsApi.ts +192 -2
  67. package/src/models/EtfHolding.ts +248 -0
  68. package/src/models/EtfWeight.ts +150 -0
  69. package/src/models/Event.ts +3 -2
  70. package/src/models/EventCalendarCall.ts +2 -1
  71. package/src/models/ListEtfHoldings200Response.ts +108 -0
  72. package/src/models/ListEtfHoldings200ResponseMeta.ts +151 -0
  73. package/src/models/ListEtfHoldings200ResponseMetaComposition.ts +105 -0
  74. package/src/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.ts +103 -0
  75. package/src/models/ListEtfWeights200Response.ts +108 -0
  76. package/src/models/ListEtfWeights200ResponseMeta.ts +148 -0
  77. package/src/models/index.ts +8 -0
@@ -0,0 +1,87 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Invinite API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2026-11-13
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ListEtfWeights200ResponseMetaWeightBasisEnum = exports.ListEtfWeights200ResponseMetaReasonEnum = exports.ListEtfWeights200ResponseMetaSourceEnum = void 0;
17
+ exports.instanceOfListEtfWeights200ResponseMeta = instanceOfListEtfWeights200ResponseMeta;
18
+ exports.ListEtfWeights200ResponseMetaFromJSON = ListEtfWeights200ResponseMetaFromJSON;
19
+ exports.ListEtfWeights200ResponseMetaFromJSONTyped = ListEtfWeights200ResponseMetaFromJSONTyped;
20
+ exports.ListEtfWeights200ResponseMetaToJSON = ListEtfWeights200ResponseMetaToJSON;
21
+ exports.ListEtfWeights200ResponseMetaToJSONTyped = ListEtfWeights200ResponseMetaToJSONTyped;
22
+ const MetaCoverage_1 = require("./MetaCoverage");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.ListEtfWeights200ResponseMetaSourceEnum = {
27
+ IssuerDaily: 'issuer_daily',
28
+ IssuerMonthly: 'issuer_monthly',
29
+ Nport: 'nport'
30
+ };
31
+ /**
32
+ * @export
33
+ */
34
+ exports.ListEtfWeights200ResponseMetaReasonEnum = {
35
+ SingleAssetTrust: 'single_asset_trust',
36
+ SourceStale: 'source_stale',
37
+ IssuerSourceUnavailable: 'issuer_source_unavailable',
38
+ WeightsUnavailable: 'weights_unavailable'
39
+ };
40
+ /**
41
+ * @export
42
+ */
43
+ exports.ListEtfWeights200ResponseMetaWeightBasisEnum = {
44
+ Stated: 'stated',
45
+ NetAssets: 'net_assets',
46
+ Sum: 'sum',
47
+ Nport: 'nport',
48
+ None: 'none'
49
+ };
50
+ /**
51
+ * Check if a given object implements the ListEtfWeights200ResponseMeta interface.
52
+ */
53
+ function instanceOfListEtfWeights200ResponseMeta(value) {
54
+ return true;
55
+ }
56
+ function ListEtfWeights200ResponseMetaFromJSON(json) {
57
+ return ListEtfWeights200ResponseMetaFromJSONTyped(json, false);
58
+ }
59
+ function ListEtfWeights200ResponseMetaFromJSONTyped(json, ignoreDiscriminator) {
60
+ if (json == null) {
61
+ return json;
62
+ }
63
+ return {
64
+ 'coverage': json['coverage'] == null ? undefined : (0, MetaCoverage_1.MetaCoverageFromJSON)(json['coverage']),
65
+ 'source': json['source'] == null ? undefined : json['source'],
66
+ 'as_of': json['as_of'] == null ? undefined : (new Date(json['as_of'])),
67
+ 'reason': json['reason'] == null ? undefined : json['reason'],
68
+ 'weight_pct_sum': json['weight_pct_sum'] == null ? undefined : json['weight_pct_sum'],
69
+ 'weight_basis': json['weight_basis'] == null ? undefined : json['weight_basis'],
70
+ };
71
+ }
72
+ function ListEtfWeights200ResponseMetaToJSON(json) {
73
+ return ListEtfWeights200ResponseMetaToJSONTyped(json, false);
74
+ }
75
+ function ListEtfWeights200ResponseMetaToJSONTyped(value, ignoreDiscriminator = false) {
76
+ if (value == null) {
77
+ return value;
78
+ }
79
+ return {
80
+ 'coverage': (0, MetaCoverage_1.MetaCoverageToJSON)(value['coverage']),
81
+ 'source': value['source'],
82
+ 'as_of': value['as_of'] == null ? value['as_of'] : value['as_of'].toISOString().substring(0, 10),
83
+ 'reason': value['reason'],
84
+ 'weight_pct_sum': value['weight_pct_sum'],
85
+ 'weight_basis': value['weight_basis'],
86
+ };
87
+ }
@@ -30,6 +30,8 @@ export * from './DocumentFigure';
30
30
  export * from './DocumentKindCatalogEntry';
31
31
  export * from './DocumentSection';
32
32
  export * from './DocumentVersion';
33
+ export * from './EtfHolding';
34
+ export * from './EtfWeight';
33
35
  export * from './Event';
34
36
  export * from './EventCalendar';
35
37
  export * from './EventCalendarCall';
@@ -112,6 +114,12 @@ export * from './ListDatasets200Response';
112
114
  export * from './ListDividends200Response';
113
115
  export * from './ListDocumentKindCatalog200Response';
114
116
  export * from './ListDocumentSections200Response';
117
+ export * from './ListEtfHoldings200Response';
118
+ export * from './ListEtfHoldings200ResponseMeta';
119
+ export * from './ListEtfHoldings200ResponseMetaComposition';
120
+ export * from './ListEtfHoldings200ResponseMetaCompositionStoredDatesInner';
121
+ export * from './ListEtfWeights200Response';
122
+ export * from './ListEtfWeights200ResponseMeta';
115
123
  export * from './ListEventTypeCatalog200Response';
116
124
  export * from './ListEvents200Response';
117
125
  export * from './ListFactPlaces200Response';
@@ -48,6 +48,8 @@ __exportStar(require("./DocumentFigure"), exports);
48
48
  __exportStar(require("./DocumentKindCatalogEntry"), exports);
49
49
  __exportStar(require("./DocumentSection"), exports);
50
50
  __exportStar(require("./DocumentVersion"), exports);
51
+ __exportStar(require("./EtfHolding"), exports);
52
+ __exportStar(require("./EtfWeight"), exports);
51
53
  __exportStar(require("./Event"), exports);
52
54
  __exportStar(require("./EventCalendar"), exports);
53
55
  __exportStar(require("./EventCalendarCall"), exports);
@@ -130,6 +132,12 @@ __exportStar(require("./ListDatasets200Response"), exports);
130
132
  __exportStar(require("./ListDividends200Response"), exports);
131
133
  __exportStar(require("./ListDocumentKindCatalog200Response"), exports);
132
134
  __exportStar(require("./ListDocumentSections200Response"), exports);
135
+ __exportStar(require("./ListEtfHoldings200Response"), exports);
136
+ __exportStar(require("./ListEtfHoldings200ResponseMeta"), exports);
137
+ __exportStar(require("./ListEtfHoldings200ResponseMetaComposition"), exports);
138
+ __exportStar(require("./ListEtfHoldings200ResponseMetaCompositionStoredDatesInner"), exports);
139
+ __exportStar(require("./ListEtfWeights200Response"), exports);
140
+ __exportStar(require("./ListEtfWeights200ResponseMeta"), exports);
133
141
  __exportStar(require("./ListEventTypeCatalog200Response"), exports);
134
142
  __exportStar(require("./ListEvents200Response"), exports);
135
143
  __exportStar(require("./ListFactPlaces200Response"), exports);
@@ -0,0 +1,76 @@
1
+
2
+ # EtfHolding
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `etf_symbol` | string
10
+ `etf_name` | string
11
+ `series_id` | string
12
+ `source` | string
13
+ `as_of` | Date
14
+ `line` | number
15
+ `name` | string
16
+ `ticker` | string
17
+ `cusip` | string
18
+ `isin` | string
19
+ `sedol` | string
20
+ `asset_class` | string
21
+ `shares` | number
22
+ `market_value_usd` | number
23
+ `notional_value_usd` | number
24
+ `weight_pct` | number
25
+ `sector` | string
26
+ `sector_basis` | string
27
+ `country` | string
28
+ `country_basis` | string
29
+ `issuer_cik` | string
30
+ `issuer_resolution` | string
31
+
32
+ ## Example
33
+
34
+ ```typescript
35
+ import type { EtfHolding } from '@invinite-org/data-api-client'
36
+
37
+ // TODO: Update the object below with actual values
38
+ const example = {
39
+ "etf_symbol": null,
40
+ "etf_name": null,
41
+ "series_id": null,
42
+ "source": null,
43
+ "as_of": null,
44
+ "line": null,
45
+ "name": null,
46
+ "ticker": null,
47
+ "cusip": null,
48
+ "isin": null,
49
+ "sedol": null,
50
+ "asset_class": null,
51
+ "shares": null,
52
+ "market_value_usd": null,
53
+ "notional_value_usd": null,
54
+ "weight_pct": null,
55
+ "sector": null,
56
+ "sector_basis": null,
57
+ "country": null,
58
+ "country_basis": null,
59
+ "issuer_cik": null,
60
+ "issuer_resolution": null,
61
+ } satisfies EtfHolding
62
+
63
+ console.log(example)
64
+
65
+ // Convert the instance to a JSON string
66
+ const exampleJSON: string = JSON.stringify(example)
67
+ console.log(exampleJSON)
68
+
69
+ // Parse the JSON string back to an object
70
+ const exampleParsed = JSON.parse(exampleJSON) as EtfHolding
71
+ console.log(exampleParsed)
72
+ ```
73
+
74
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
75
+
76
+
@@ -0,0 +1,48 @@
1
+
2
+ # EtfWeight
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `etf_symbol` | string
10
+ `source` | string
11
+ `as_of` | Date
12
+ `dimension` | string
13
+ `bucket` | string
14
+ `weight_pct` | number
15
+ `positions` | number
16
+ `basis` | string
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { EtfWeight } from '@invinite-org/data-api-client'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "etf_symbol": null,
26
+ "source": null,
27
+ "as_of": null,
28
+ "dimension": null,
29
+ "bucket": null,
30
+ "weight_pct": null,
31
+ "positions": null,
32
+ "basis": null,
33
+ } satisfies EtfWeight
34
+
35
+ console.log(example)
36
+
37
+ // Convert the instance to a JSON string
38
+ const exampleJSON: string = JSON.stringify(example)
39
+ console.log(exampleJSON)
40
+
41
+ // Parse the JSON string back to an object
42
+ const exampleParsed = JSON.parse(exampleJSON) as EtfWeight
43
+ console.log(exampleParsed)
44
+ ```
45
+
46
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
47
+
48
+
package/docs/EventsApi.md CHANGED
@@ -432,7 +432,7 @@ example().catch(console.error);
432
432
 
433
433
  List events
434
434
 
435
- Events (earnings calls by default; &#x60;type&#x3D;all&#x60; or a list opts into investor days, conferences, AGMs and other events), keyset-paged by &#x60;scheduled_at&#x60; with the event id as tiebreaker. With &#x60;company&#x3D;&#x60; every date of that company is listed; without &#x60;company&#x3D;&#x60; the list is a calendar: the &#x60;scheduled_at&#x60; window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 &#x60;invalid_parameter&#x60;); &#x60;status&#x3D;live&#x60; alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; &#x60;GET /v1/events/{event_id}&#x60; still serves them.
435
+ Events (earnings calls by default; &#x60;type&#x3D;all&#x60; or a list opts into investor days, conferences, AGMs and other events), keyset-paged by &#x60;scheduled_at&#x60; with the event id as tiebreaker. With &#x60;company&#x3D;&#x60; every date of that company is listed; without &#x60;company&#x3D;&#x60; the list is a calendar: the &#x60;scheduled_at&#x60; window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 &#x60;invalid_parameter&#x60;); &#x60;status&#x3D;live&#x60; alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose &#x60;expired_reason&#x60; is &#x60;results_without_call&#x60; (a reported quarter whose call never came); &#x60;GET /v1/events/{event_id}&#x60; still serves them. A reported quarter (&#x60;results_released_at&#x60; set) is listed even when its call date is only an estimate.
436
436
 
437
437
  ### Example
438
438
 
@@ -4,19 +4,214 @@ All URIs are relative to *https://api.data.invinite.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
+ | [**listEtfHoldings**](HoldingsApi.md#listetfholdings) | **GET** /v1/etf-holdings | List ETF holdings (daily issuer files or N-PORT) |
8
+ | [**listEtfWeights**](HoldingsApi.md#listetfweights) | **GET** /v1/etf-weights | List ETF sector, country and asset-class weights |
7
9
  | [**listFundHoldings**](HoldingsApi.md#listfundholdings) | **GET** /v1/fund-holdings | List N-PORT fund holdings |
8
10
  | [**listHoldingChanges**](HoldingsApi.md#listholdingchanges) | **GET** /v1/holding-changes | List 13F position changes |
9
11
  | [**listHoldings**](HoldingsApi.md#listholdings) | **GET** /v1/holdings | List 13F holdings |
10
12
 
11
13
 
12
14
 
15
+ ## listEtfHoldings
16
+
17
+ > ListEtfHoldings200Response listEtfHoldings(etf, company, asOf, sort, fields, limit, cursor)
18
+
19
+ List ETF holdings (daily issuer files or N-PORT)
20
+
21
+ The holdings of US ETFs from the freshest source per ETF, always named: the issuer\&#39;s own daily (or monthly) holdings file where the store reads one, else the fund\&#39;s latest public N-PORT report (quarter end, about 60 days later). &#x60;etf&#x3D;&#x60; lists one ETF\&#39;s positions (&#x60;meta.source&#x60;, &#x60;meta.as_of&#x60;; &#x60;as_of&#x3D;&#x60; reads a stored earlier date, &#x60;meta.composition.stored_dates&#x60; lists them), order &#x60;-weight_pct&#x60;; &#x60;company&#x3D;&#x60; 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 &#x60;/v1/fund-holdings?company&#x3D;&#x60;), order &#x60;-market_value_usd&#x60;. Exactly one of &#x60;etf&#x60; or &#x60;company&#x60;. A single-asset trust (GLD) has no rows by design (&#x60;meta.reason: single_asset_trust&#x60;). &#x60;EtfHolding&#x60; is not &#x60;FundHolding&#x60; (R16): &#x60;/v1/fund-holdings&#x60; serves filed N-PORT rows per report (with &#x60;accession_number&#x60; and &#x60;report_date&#x60;); 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.
22
+
23
+ ### Example
24
+
25
+ ```ts
26
+ import {
27
+ Configuration,
28
+ HoldingsApi,
29
+ } from '@invinite-org/data-api-client';
30
+ import type { ListEtfHoldingsRequest } from '@invinite-org/data-api-client';
31
+
32
+ async function example() {
33
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
34
+ const config = new Configuration({
35
+ // Configure HTTP bearer authorization: bearerAuth
36
+ accessToken: "YOUR BEARER TOKEN",
37
+ });
38
+ const api = new HoldingsApi(config);
39
+
40
+ const body = {
41
+ // string | ETF ticker: the fund\'s freshest composition (one ETF) (optional)
42
+ etf: SPY,
43
+ // string | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. (optional)
44
+ company: NVDA,
45
+ // Date | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest (optional)
46
+ asOf: 2026-11-12,
47
+ // '-weight_pct' | '-market_value_usd' | Sort field: `-weight_pct` with etf= (default), `-market_value_usd` with company= (default); the only orders the store serves (optional)
48
+ sort: -weight_pct,
49
+ // string | Comma list of root-level fields to keep (R7) (optional)
50
+ fields: fiscal_year,period_end,
51
+ // number | Rows per page (default 25, max 1 000 on 13F rows) (optional)
52
+ limit: 100,
53
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
54
+ cursor: eyJ2IjoyfQ,
55
+ } satisfies ListEtfHoldingsRequest;
56
+
57
+ try {
58
+ const data = await api.listEtfHoldings(body);
59
+ console.log(data);
60
+ } catch (error) {
61
+ console.error(error);
62
+ }
63
+ }
64
+
65
+ // Run the test
66
+ example().catch(console.error);
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+
72
+ | Name | Type | Description | Notes |
73
+ |------------- | ------------- | ------------- | -------------|
74
+ | **etf** | `string` | ETF ticker: the fund\&#39;s freshest composition (one ETF) | [Optional] [Defaults to `undefined`] |
75
+ | **company** | `string` | Ticker (&#x60;NVDA&#x60;) or CIK of ONE company: the ETFs holding it (from the ETFs\&#39; issuer files). Exactly one of &#x60;etf&#x60; or &#x60;company&#x60; is required. | [Optional] [Defaults to `undefined`] |
76
+ | **asOf** | `Date` | With etf&#x3D;: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest | [Optional] [Defaults to `undefined`] |
77
+ | **sort** | `-weight_pct`, `-market_value_usd` | Sort field: &#x60;-weight_pct&#x60; with etf&#x3D; (default), &#x60;-market_value_usd&#x60; with company&#x3D; (default); the only orders the store serves | [Optional] [Defaults to `undefined`] [Enum: -weight_pct, -market_value_usd] |
78
+ | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
79
+ | **limit** | `number` | Rows per page (default 25, max 1 000 on 13F rows) | [Optional] [Defaults to `25`] |
80
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
81
+
82
+ ### Return type
83
+
84
+ [**ListEtfHoldings200Response**](ListEtfHoldings200Response.md)
85
+
86
+ ### Authorization
87
+
88
+ [bearerAuth](../README.md#bearerAuth)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: Not defined
93
+ - **Accept**: `application/json`, `application/problem+json`
94
+
95
+
96
+ ### HTTP response details
97
+ | Status code | Description | Response headers |
98
+ |-------------|-------------|------------------|
99
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
100
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
101
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
102
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
103
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
104
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
105
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
106
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
107
+ | **500** | 500: internal | * X-Request-Id - <br> |
108
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
109
+
110
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
111
+
112
+
113
+ ## listEtfWeights
114
+
115
+ > ListEtfWeights200Response listEtfWeights(etf, dimension, asOf, fields, limit, cursor)
116
+
117
+ List ETF sector, country and asset-class weights
118
+
119
+ Sector, country and asset-class weights of one US ETF, from the same composition &#x60;/v1/etf-holdings?etf&#x3D;&#x60; answers from (&#x60;meta.source&#x60;, &#x60;meta.as_of&#x60;): sector &#x3D; the issuer\&#39;s stated sector, else the SEC SIC sector of the holding\&#39;s issuer; country &#x3D; the stated location, else the N-PORT country / ISIN prefix / registrant country (each bucket names its &#x60;basis&#x60;, &#x60;mixed&#x60; when its positions differ); weights in percent of the fund. &#x60;dimension&#x3D;&#x60; one or several of sector, country, asset_class (default all). An ETF without buckets for the chosen source answers &#x60;data: []&#x60; with &#x60;meta.reason: weights_unavailable&#x60;; a single-asset trust &#x60;meta.reason: single_asset_trust&#x60;. Positions themselves: &#x60;/v1/etf-holdings&#x60;; filed N-PORT rows: &#x60;/v1/fund-holdings&#x60;.
120
+
121
+ ### Example
122
+
123
+ ```ts
124
+ import {
125
+ Configuration,
126
+ HoldingsApi,
127
+ } from '@invinite-org/data-api-client';
128
+ import type { ListEtfWeightsRequest } from '@invinite-org/data-api-client';
129
+
130
+ async function example() {
131
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
132
+ const config = new Configuration({
133
+ // Configure HTTP bearer authorization: bearerAuth
134
+ accessToken: "YOUR BEARER TOKEN",
135
+ });
136
+ const api = new HoldingsApi(config);
137
+
138
+ const body = {
139
+ // string | ETF ticker
140
+ etf: SPY,
141
+ // string | sector, country or asset_class; a comma list for several (default all three) (optional)
142
+ dimension: sector,
143
+ // Date | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest (optional)
144
+ asOf: 2026-11-12,
145
+ // string | Comma list of root-level fields to keep (R7) (optional)
146
+ fields: fiscal_year,period_end,
147
+ // number | Rows per page (default 25, max 200) (optional)
148
+ limit: 25,
149
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
150
+ cursor: eyJ2IjoyfQ,
151
+ } satisfies ListEtfWeightsRequest;
152
+
153
+ try {
154
+ const data = await api.listEtfWeights(body);
155
+ console.log(data);
156
+ } catch (error) {
157
+ console.error(error);
158
+ }
159
+ }
160
+
161
+ // Run the test
162
+ example().catch(console.error);
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+
168
+ | Name | Type | Description | Notes |
169
+ |------------- | ------------- | ------------- | -------------|
170
+ | **etf** | `string` | ETF ticker | [Defaults to `undefined`] |
171
+ | **dimension** | `string` | sector, country or asset_class; a comma list for several (default all three) | [Optional] [Defaults to `undefined`] |
172
+ | **asOf** | `Date` | With etf&#x3D;: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest | [Optional] [Defaults to `undefined`] |
173
+ | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
174
+ | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
175
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
176
+
177
+ ### Return type
178
+
179
+ [**ListEtfWeights200Response**](ListEtfWeights200Response.md)
180
+
181
+ ### Authorization
182
+
183
+ [bearerAuth](../README.md#bearerAuth)
184
+
185
+ ### HTTP request headers
186
+
187
+ - **Content-Type**: Not defined
188
+ - **Accept**: `application/json`, `application/problem+json`
189
+
190
+
191
+ ### HTTP response details
192
+ | Status code | Description | Response headers |
193
+ |-------------|-------------|------------------|
194
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
195
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
196
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
197
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
198
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
199
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
200
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
201
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
202
+ | **500** | 500: internal | * X-Request-Id - <br> |
203
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
204
+
205
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
206
+
207
+
13
208
  ## listFundHoldings
14
209
 
15
210
  > ListFundHoldings200Response listFundHoldings(company, filer, series, accession, periodEnd, sort, fields, limit, cursor)
16
211
 
17
212
  List N-PORT fund holdings
18
213
 
19
- N-PORT fund and ETF positions from the funds\&#39; quarterly public reports (about 60 days after the report date): by issuer (&#x60;company&#x3D;&#x60;, one row per fund holding it, from each fund\&#39;s latest report on or before &#x60;period_end&#x60;, its positions in the issuer summed), by fund (&#x60;filer&#x3D;&#x60; registrant CIK, &#x60;series&#x3D;&#x60; when the registrant files for several funds: that fund\&#39;s positions) or by filing (&#x60;accession&#x3D;&#x60;, an NPORT-P filing\&#39;s reported holdings as filed); exactly one of &#x60;company&#x60;, &#x60;filer&#x60; or &#x60;accession&#x60; (&#x60;series&#x60; alone needs &#x60;filer&#x60;). &#x60;period_end&#x60; defaults to today. Order: value in USD, descending (&#x60;company&#x3D;&#x60;, &#x60;filer&#x3D;&#x60;), the filing\&#39;s line order (&#x60;accession&#x3D;&#x60;); several companies are read one after another. A fund row is not a 13F &#x60;Holding&#x60; (different row type, R16): &#x60;/v1/holdings&#x60; keeps the 13F managers.
214
+ N-PORT fund and ETF positions from the funds\&#39; quarterly public reports (about 60 days after the report date): by issuer (&#x60;company&#x3D;&#x60;, one row per fund holding it, from each fund\&#39;s latest report on or before &#x60;period_end&#x60;, its positions in the issuer summed), by fund (&#x60;filer&#x3D;&#x60; registrant CIK, &#x60;series&#x3D;&#x60; when the registrant files for several funds: that fund\&#39;s positions) or by filing (&#x60;accession&#x3D;&#x60;, an NPORT-P filing\&#39;s reported holdings as filed); exactly one of &#x60;company&#x60;, &#x60;filer&#x60; or &#x60;accession&#x60; (&#x60;series&#x60; alone needs &#x60;filer&#x60;). &#x60;period_end&#x60; defaults to today. Order: value in USD, descending (&#x60;company&#x3D;&#x60;, &#x60;filer&#x3D;&#x60;), the filing\&#39;s line order (&#x60;accession&#x3D;&#x60;); several companies are read one after another. A fund row is not a 13F &#x60;Holding&#x60; (different row type, R16): &#x60;/v1/holdings&#x60; keeps the 13F managers. ETFs\&#39; current composition (daily issuer files, falling back to N-PORT): &#x60;/v1/etf-holdings&#x60;.
20
215
 
21
216
  ### Example
22
217
 
@@ -0,0 +1,41 @@
1
+
2
+ # ListEtfHoldings200Response
3
+
4
+ A page of EtfHolding rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array&lt;EtfHolding&gt;](EtfHolding.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListEtfHoldings200ResponseMeta](ListEtfHoldings200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListEtfHoldings200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListEtfHoldings200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,47 @@
1
+
2
+ # ListEtfHoldings200ResponseMeta
3
+
4
+ Page metadata
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `coverage` | [MetaCoverage](MetaCoverage.md)
11
+ `source` | string
12
+ `as_of` | Date
13
+ `reason` | string
14
+ `composition` | [ListEtfHoldings200ResponseMetaComposition](ListEtfHoldings200ResponseMetaComposition.md)
15
+ `issuer_sourced_etfs` | number
16
+ `snapshot_changed` | boolean
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { ListEtfHoldings200ResponseMeta } from '@invinite-org/data-api-client'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "coverage": null,
26
+ "source": null,
27
+ "as_of": null,
28
+ "reason": null,
29
+ "composition": null,
30
+ "issuer_sourced_etfs": null,
31
+ "snapshot_changed": null,
32
+ } satisfies ListEtfHoldings200ResponseMeta
33
+
34
+ console.log(example)
35
+
36
+ // Convert the instance to a JSON string
37
+ const exampleJSON: string = JSON.stringify(example)
38
+ console.log(exampleJSON)
39
+
40
+ // Parse the JSON string back to an object
41
+ const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200ResponseMeta
42
+ console.log(exampleParsed)
43
+ ```
44
+
45
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
46
+
47
+
@@ -0,0 +1,43 @@
1
+
2
+ # ListEtfHoldings200ResponseMetaComposition
3
+
4
+ What the store holds for the ETF (etf=); null with company=
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `newest_issuer_as_of` | Date
11
+ `nport_report_date` | Date
12
+ `stored_from` | Date
13
+ `stored_to` | Date
14
+ `stored_dates` | [Array&lt;ListEtfHoldings200ResponseMetaCompositionStoredDatesInner&gt;](ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.md)
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { ListEtfHoldings200ResponseMetaComposition } from '@invinite-org/data-api-client'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "newest_issuer_as_of": null,
24
+ "nport_report_date": null,
25
+ "stored_from": null,
26
+ "stored_to": null,
27
+ "stored_dates": null,
28
+ } satisfies ListEtfHoldings200ResponseMetaComposition
29
+
30
+ console.log(example)
31
+
32
+ // Convert the instance to a JSON string
33
+ const exampleJSON: string = JSON.stringify(example)
34
+ console.log(exampleJSON)
35
+
36
+ // Parse the JSON string back to an object
37
+ const exampleParsed = JSON.parse(exampleJSON) as ListEtfHoldings200ResponseMetaComposition
38
+ console.log(exampleParsed)
39
+ ```
40
+
41
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
42
+
43
+