@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,52 @@
1
+ /**
2
+ * Invinite API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { EtfWeight } from './EtfWeight';
13
+ import type { ListEtfWeights200ResponseMeta } from './ListEtfWeights200ResponseMeta';
14
+ /**
15
+ * A page of EtfWeight rows (the list envelope, R3)
16
+ * @export
17
+ * @interface ListEtfWeights200Response
18
+ */
19
+ export interface ListEtfWeights200Response {
20
+ /**
21
+ * The rows of this page
22
+ * @type {Array<EtfWeight>}
23
+ * @memberof ListEtfWeights200Response
24
+ */
25
+ data: Array<EtfWeight>;
26
+ /**
27
+ * true when a next page exists
28
+ * @type {boolean}
29
+ * @memberof ListEtfWeights200Response
30
+ */
31
+ has_more: boolean;
32
+ /**
33
+ * Opaque cursor of the next page; null on the last page
34
+ * @type {string}
35
+ * @memberof ListEtfWeights200Response
36
+ */
37
+ next_cursor: string | null;
38
+ /**
39
+ *
40
+ * @type {ListEtfWeights200ResponseMeta}
41
+ * @memberof ListEtfWeights200Response
42
+ */
43
+ meta: ListEtfWeights200ResponseMeta;
44
+ }
45
+ /**
46
+ * Check if a given object implements the ListEtfWeights200Response interface.
47
+ */
48
+ export declare function instanceOfListEtfWeights200Response(value: object): value is ListEtfWeights200Response;
49
+ export declare function ListEtfWeights200ResponseFromJSON(json: any): ListEtfWeights200Response;
50
+ export declare function ListEtfWeights200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfWeights200Response;
51
+ export declare function ListEtfWeights200ResponseToJSON(json: any): ListEtfWeights200Response;
52
+ export declare function ListEtfWeights200ResponseToJSONTyped(value?: ListEtfWeights200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
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
+ import { EtfWeightFromJSON, EtfWeightToJSON, } from './EtfWeight';
15
+ import { ListEtfWeights200ResponseMetaFromJSON, ListEtfWeights200ResponseMetaToJSON, } from './ListEtfWeights200ResponseMeta';
16
+ /**
17
+ * Check if a given object implements the ListEtfWeights200Response interface.
18
+ */
19
+ export function instanceOfListEtfWeights200Response(value) {
20
+ if (!('data' in value) || value['data'] === undefined)
21
+ return false;
22
+ if (!('has_more' in value) || value['has_more'] === undefined)
23
+ return false;
24
+ if (!('next_cursor' in value) || value['next_cursor'] === undefined)
25
+ return false;
26
+ if (!('meta' in value) || value['meta'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function ListEtfWeights200ResponseFromJSON(json) {
31
+ return ListEtfWeights200ResponseFromJSONTyped(json, false);
32
+ }
33
+ export function ListEtfWeights200ResponseFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'data': (json['data'].map(EtfWeightFromJSON)),
39
+ 'has_more': json['has_more'],
40
+ 'next_cursor': json['next_cursor'],
41
+ 'meta': ListEtfWeights200ResponseMetaFromJSON(json['meta']),
42
+ };
43
+ }
44
+ export function ListEtfWeights200ResponseToJSON(json) {
45
+ return ListEtfWeights200ResponseToJSONTyped(json, false);
46
+ }
47
+ export function ListEtfWeights200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(EtfWeightToJSON)),
53
+ 'has_more': value['has_more'],
54
+ 'next_cursor': value['next_cursor'],
55
+ 'meta': ListEtfWeights200ResponseMetaToJSON(value['meta']),
56
+ };
57
+ }
@@ -0,0 +1,93 @@
1
+ /**
2
+ * Invinite API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { MetaCoverage } from './MetaCoverage';
13
+ /**
14
+ * Page metadata
15
+ * @export
16
+ * @interface ListEtfWeights200ResponseMeta
17
+ */
18
+ export interface ListEtfWeights200ResponseMeta {
19
+ /**
20
+ *
21
+ * @type {MetaCoverage}
22
+ * @memberof ListEtfWeights200ResponseMeta
23
+ */
24
+ coverage?: MetaCoverage;
25
+ /**
26
+ * Which composition the rows come from (etf=): issuer_daily / issuer_monthly = the issuer's own holdings file, nport = the fund's latest public N-PORT report; null with company= (each row names its own)
27
+ * @type {ListEtfWeights200ResponseMetaSourceEnum}
28
+ * @memberof ListEtfWeights200ResponseMeta
29
+ */
30
+ source?: ListEtfWeights200ResponseMetaSourceEnum | null;
31
+ /**
32
+ * The date the composition is stated as of (etf=); null with company=
33
+ * @type {Date}
34
+ * @memberof ListEtfWeights200ResponseMeta
35
+ */
36
+ as_of?: Date | null;
37
+ /**
38
+ * Why the answer is partial or empty by design: single_asset_trust (a single-asset trust such as GLD holds one commodity: no rows by design), source_stale (the issuer file is more than 5 trading days old), issuer_source_unavailable (a daily-file ETF answered from its N-PORT report), weights_unavailable (etf-weights: no buckets for the chosen source)
39
+ * @type {ListEtfWeights200ResponseMetaReasonEnum}
40
+ * @memberof ListEtfWeights200ResponseMeta
41
+ */
42
+ reason?: ListEtfWeights200ResponseMetaReasonEnum | null;
43
+ /**
44
+ * What the buckets of one dimension sum to, in percent (every weighted position once). About 100 for a plain fund; a leveraged or inverse fund is far from 100 (swaps and futures count at notional exposure in the Derivatives bucket): draw a pie chart only when this is about 100. null without buckets
45
+ * @type {number}
46
+ * @memberof ListEtfWeights200ResponseMeta
47
+ */
48
+ weight_pct_sum?: number | null;
49
+ /**
50
+ * How the position weights were stated: stated = the issuer file states each weight, net_assets = market value over the stated net assets, sum = market value over the sum of the non-derivative positions, nport = the N-PORT percent of net assets, none = no weight was stated or derivable (then reason is weights_unavailable)
51
+ * @type {ListEtfWeights200ResponseMetaWeightBasisEnum}
52
+ * @memberof ListEtfWeights200ResponseMeta
53
+ */
54
+ weight_basis?: ListEtfWeights200ResponseMetaWeightBasisEnum | null;
55
+ }
56
+ /**
57
+ * @export
58
+ */
59
+ export declare const ListEtfWeights200ResponseMetaSourceEnum: {
60
+ readonly IssuerDaily: "issuer_daily";
61
+ readonly IssuerMonthly: "issuer_monthly";
62
+ readonly Nport: "nport";
63
+ };
64
+ export type ListEtfWeights200ResponseMetaSourceEnum = typeof ListEtfWeights200ResponseMetaSourceEnum[keyof typeof ListEtfWeights200ResponseMetaSourceEnum] | (string & {});
65
+ /**
66
+ * @export
67
+ */
68
+ export declare const ListEtfWeights200ResponseMetaReasonEnum: {
69
+ readonly SingleAssetTrust: "single_asset_trust";
70
+ readonly SourceStale: "source_stale";
71
+ readonly IssuerSourceUnavailable: "issuer_source_unavailable";
72
+ readonly WeightsUnavailable: "weights_unavailable";
73
+ };
74
+ export type ListEtfWeights200ResponseMetaReasonEnum = typeof ListEtfWeights200ResponseMetaReasonEnum[keyof typeof ListEtfWeights200ResponseMetaReasonEnum] | (string & {});
75
+ /**
76
+ * @export
77
+ */
78
+ export declare const ListEtfWeights200ResponseMetaWeightBasisEnum: {
79
+ readonly Stated: "stated";
80
+ readonly NetAssets: "net_assets";
81
+ readonly Sum: "sum";
82
+ readonly Nport: "nport";
83
+ readonly None: "none";
84
+ };
85
+ export type ListEtfWeights200ResponseMetaWeightBasisEnum = typeof ListEtfWeights200ResponseMetaWeightBasisEnum[keyof typeof ListEtfWeights200ResponseMetaWeightBasisEnum] | (string & {});
86
+ /**
87
+ * Check if a given object implements the ListEtfWeights200ResponseMeta interface.
88
+ */
89
+ export declare function instanceOfListEtfWeights200ResponseMeta(value: object): value is ListEtfWeights200ResponseMeta;
90
+ export declare function ListEtfWeights200ResponseMetaFromJSON(json: any): ListEtfWeights200ResponseMeta;
91
+ export declare function ListEtfWeights200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfWeights200ResponseMeta;
92
+ export declare function ListEtfWeights200ResponseMetaToJSON(json: any): ListEtfWeights200ResponseMeta;
93
+ export declare function ListEtfWeights200ResponseMetaToJSONTyped(value?: ListEtfWeights200ResponseMeta | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,79 @@
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
+ import { MetaCoverageFromJSON, MetaCoverageToJSON, } from './MetaCoverage';
15
+ /**
16
+ * @export
17
+ */
18
+ export const ListEtfWeights200ResponseMetaSourceEnum = {
19
+ IssuerDaily: 'issuer_daily',
20
+ IssuerMonthly: 'issuer_monthly',
21
+ Nport: 'nport'
22
+ };
23
+ /**
24
+ * @export
25
+ */
26
+ export const ListEtfWeights200ResponseMetaReasonEnum = {
27
+ SingleAssetTrust: 'single_asset_trust',
28
+ SourceStale: 'source_stale',
29
+ IssuerSourceUnavailable: 'issuer_source_unavailable',
30
+ WeightsUnavailable: 'weights_unavailable'
31
+ };
32
+ /**
33
+ * @export
34
+ */
35
+ export const ListEtfWeights200ResponseMetaWeightBasisEnum = {
36
+ Stated: 'stated',
37
+ NetAssets: 'net_assets',
38
+ Sum: 'sum',
39
+ Nport: 'nport',
40
+ None: 'none'
41
+ };
42
+ /**
43
+ * Check if a given object implements the ListEtfWeights200ResponseMeta interface.
44
+ */
45
+ export function instanceOfListEtfWeights200ResponseMeta(value) {
46
+ return true;
47
+ }
48
+ export function ListEtfWeights200ResponseMetaFromJSON(json) {
49
+ return ListEtfWeights200ResponseMetaFromJSONTyped(json, false);
50
+ }
51
+ export function ListEtfWeights200ResponseMetaFromJSONTyped(json, ignoreDiscriminator) {
52
+ if (json == null) {
53
+ return json;
54
+ }
55
+ return {
56
+ 'coverage': json['coverage'] == null ? undefined : MetaCoverageFromJSON(json['coverage']),
57
+ 'source': json['source'] == null ? undefined : json['source'],
58
+ 'as_of': json['as_of'] == null ? undefined : (new Date(json['as_of'])),
59
+ 'reason': json['reason'] == null ? undefined : json['reason'],
60
+ 'weight_pct_sum': json['weight_pct_sum'] == null ? undefined : json['weight_pct_sum'],
61
+ 'weight_basis': json['weight_basis'] == null ? undefined : json['weight_basis'],
62
+ };
63
+ }
64
+ export function ListEtfWeights200ResponseMetaToJSON(json) {
65
+ return ListEtfWeights200ResponseMetaToJSONTyped(json, false);
66
+ }
67
+ export function ListEtfWeights200ResponseMetaToJSONTyped(value, ignoreDiscriminator = false) {
68
+ if (value == null) {
69
+ return value;
70
+ }
71
+ return {
72
+ 'coverage': MetaCoverageToJSON(value['coverage']),
73
+ 'source': value['source'],
74
+ 'as_of': value['as_of'] == null ? value['as_of'] : value['as_of'].toISOString().substring(0, 10),
75
+ 'reason': value['reason'],
76
+ 'weight_pct_sum': value['weight_pct_sum'],
77
+ 'weight_basis': value['weight_basis'],
78
+ };
79
+ }
@@ -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';
@@ -32,6 +32,8 @@ export * from './DocumentFigure';
32
32
  export * from './DocumentKindCatalogEntry';
33
33
  export * from './DocumentSection';
34
34
  export * from './DocumentVersion';
35
+ export * from './EtfHolding';
36
+ export * from './EtfWeight';
35
37
  export * from './Event';
36
38
  export * from './EventCalendar';
37
39
  export * from './EventCalendarCall';
@@ -114,6 +116,12 @@ export * from './ListDatasets200Response';
114
116
  export * from './ListDividends200Response';
115
117
  export * from './ListDocumentKindCatalog200Response';
116
118
  export * from './ListDocumentSections200Response';
119
+ export * from './ListEtfHoldings200Response';
120
+ export * from './ListEtfHoldings200ResponseMeta';
121
+ export * from './ListEtfHoldings200ResponseMetaComposition';
122
+ export * from './ListEtfHoldings200ResponseMetaCompositionStoredDatesInner';
123
+ export * from './ListEtfWeights200Response';
124
+ export * from './ListEtfWeights200ResponseMeta';
117
125
  export * from './ListEventTypeCatalog200Response';
118
126
  export * from './ListEvents200Response';
119
127
  export * from './ListFactPlaces200Response';
@@ -0,0 +1,167 @@
1
+ /**
2
+ * Invinite API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface EtfHolding
16
+ */
17
+ export interface EtfHolding {
18
+ /**
19
+ * The ETF's ticker
20
+ * @type {string}
21
+ * @memberof EtfHolding
22
+ */
23
+ etf_symbol: string;
24
+ /**
25
+ * The ETF's name
26
+ * @type {string}
27
+ * @memberof EtfHolding
28
+ */
29
+ etf_name?: string | null;
30
+ /**
31
+ * SEC series id of the ETF's fund (S + 9 digits); null for a unit investment trust and on company= rows
32
+ * @type {string}
33
+ * @memberof EtfHolding
34
+ */
35
+ series_id?: string | null;
36
+ /**
37
+ * issuer_daily / issuer_monthly = the issuer's holdings file, nport = the fund's latest public N-PORT report
38
+ * @type {EtfHoldingSourceEnum}
39
+ * @memberof EtfHolding
40
+ */
41
+ source: EtfHoldingSourceEnum;
42
+ /**
43
+ * The date the composition is stated as of
44
+ * @type {Date}
45
+ * @memberof EtfHolding
46
+ */
47
+ as_of: Date;
48
+ /**
49
+ * Line of the position in its source (issuer file line, N-PORT source line); null on company= rows (lines summed)
50
+ * @type {number}
51
+ * @memberof EtfHolding
52
+ */
53
+ line?: number | null;
54
+ /**
55
+ * Holding name as stated (company= rows: the requested company)
56
+ * @type {string}
57
+ * @memberof EtfHolding
58
+ */
59
+ name?: string | null;
60
+ /**
61
+ * Holding ticker as stated (company= rows: the requested company's ticker)
62
+ * @type {string}
63
+ * @memberof EtfHolding
64
+ */
65
+ ticker?: string | null;
66
+ /**
67
+ * Holding CUSIP
68
+ * @type {string}
69
+ * @memberof EtfHolding
70
+ */
71
+ cusip?: string | null;
72
+ /**
73
+ * Holding ISIN
74
+ * @type {string}
75
+ * @memberof EtfHolding
76
+ */
77
+ isin?: string | null;
78
+ /**
79
+ * Holding SEDOL (issuer files only)
80
+ * @type {string}
81
+ * @memberof EtfHolding
82
+ */
83
+ sedol?: string | null;
84
+ /**
85
+ * equity, fixed_income, cash, derivative, fund, commodity, crypto or other
86
+ * @type {string}
87
+ * @memberof EtfHolding
88
+ */
89
+ asset_class?: string | null;
90
+ /**
91
+ * Shares held; null for a non-share position (principal, contracts)
92
+ * @type {number}
93
+ * @memberof EtfHolding
94
+ */
95
+ shares?: number | null;
96
+ /**
97
+ * Market value in USD as stated
98
+ * @type {number}
99
+ * @memberof EtfHolding
100
+ */
101
+ market_value_usd?: number | null;
102
+ /**
103
+ * Notional value in USD of a derivative (issuer files only)
104
+ * @type {number}
105
+ * @memberof EtfHolding
106
+ */
107
+ notional_value_usd?: number | null;
108
+ /**
109
+ * Percent of the fund (7.1 = 7.1 %; N-PORT: percent of net assets)
110
+ * @type {number}
111
+ * @memberof EtfHolding
112
+ */
113
+ weight_pct?: number | null;
114
+ /**
115
+ * Sector: as the issuer stated it, else the SEC SIC sector of the holding's issuer
116
+ * @type {string}
117
+ * @memberof EtfHolding
118
+ */
119
+ sector?: string | null;
120
+ /**
121
+ * issuer_stated, derived_sic or none
122
+ * @type {string}
123
+ * @memberof EtfHolding
124
+ */
125
+ sector_basis?: string | null;
126
+ /**
127
+ * Country (ISO alpha-2 where it maps): as stated, else derived
128
+ * @type {string}
129
+ * @memberof EtfHolding
130
+ */
131
+ country?: string | null;
132
+ /**
133
+ * issuer_stated, nport, isin_prefix, registrant or none
134
+ * @type {string}
135
+ * @memberof EtfHolding
136
+ */
137
+ country_basis?: string | null;
138
+ /**
139
+ * Issuer CIK of the holding, 10 digits; null when it did not resolve
140
+ * @type {string}
141
+ * @memberof EtfHolding
142
+ */
143
+ issuer_cik?: string | null;
144
+ /**
145
+ * How issuer_cik was found: cusip_cache, isin, ticker, not_equity or unresolved
146
+ * @type {string}
147
+ * @memberof EtfHolding
148
+ */
149
+ issuer_resolution?: string | null;
150
+ }
151
+ /**
152
+ * @export
153
+ */
154
+ export declare const EtfHoldingSourceEnum: {
155
+ readonly IssuerDaily: "issuer_daily";
156
+ readonly IssuerMonthly: "issuer_monthly";
157
+ readonly Nport: "nport";
158
+ };
159
+ export type EtfHoldingSourceEnum = typeof EtfHoldingSourceEnum[keyof typeof EtfHoldingSourceEnum] | (string & {});
160
+ /**
161
+ * Check if a given object implements the EtfHolding interface.
162
+ */
163
+ export declare function instanceOfEtfHolding(value: object): value is EtfHolding;
164
+ export declare function EtfHoldingFromJSON(json: any): EtfHolding;
165
+ export declare function EtfHoldingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EtfHolding;
166
+ export declare function EtfHoldingToJSON(json: any): EtfHolding;
167
+ export declare function EtfHoldingToJSONTyped(value?: EtfHolding | null, ignoreDiscriminator?: boolean): any;