@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.
- package/.openapi-generator/FILES +16 -0
- package/dist/apis/HoldingsApi.d.ts +57 -2
- package/dist/apis/HoldingsApi.js +142 -3
- package/dist/esm/apis/HoldingsApi.d.ts +57 -2
- package/dist/esm/apis/HoldingsApi.js +141 -2
- package/dist/esm/models/EtfHolding.d.ts +167 -0
- package/dist/esm/models/EtfHolding.js +97 -0
- package/dist/esm/models/EtfWeight.d.ts +92 -0
- package/dist/esm/models/EtfWeight.js +85 -0
- package/dist/esm/models/ListEtfHoldings200Response.d.ts +52 -0
- package/dist/esm/models/ListEtfHoldings200Response.js +57 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMeta.js +72 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaComposition.js +50 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
- package/dist/esm/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +59 -0
- package/dist/esm/models/ListEtfWeights200Response.d.ts +52 -0
- package/dist/esm/models/ListEtfWeights200Response.js +57 -0
- package/dist/esm/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
- package/dist/esm/models/ListEtfWeights200ResponseMeta.js +79 -0
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/models/EtfHolding.d.ts +167 -0
- package/dist/models/EtfHolding.js +105 -0
- package/dist/models/EtfWeight.d.ts +92 -0
- package/dist/models/EtfWeight.js +93 -0
- package/dist/models/ListEtfHoldings200Response.d.ts +52 -0
- package/dist/models/ListEtfHoldings200Response.js +64 -0
- package/dist/models/ListEtfHoldings200ResponseMeta.d.ts +89 -0
- package/dist/models/ListEtfHoldings200ResponseMeta.js +80 -0
- package/dist/models/ListEtfHoldings200ResponseMetaComposition.d.ts +57 -0
- package/dist/models/ListEtfHoldings200ResponseMetaComposition.js +57 -0
- package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.d.ts +59 -0
- package/dist/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.js +67 -0
- package/dist/models/ListEtfWeights200Response.d.ts +52 -0
- package/dist/models/ListEtfWeights200Response.js +64 -0
- package/dist/models/ListEtfWeights200ResponseMeta.d.ts +93 -0
- package/dist/models/ListEtfWeights200ResponseMeta.js +87 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/docs/EtfHolding.md +76 -0
- package/docs/EtfWeight.md +48 -0
- package/docs/HoldingsApi.md +196 -1
- package/docs/ListEtfHoldings200Response.md +41 -0
- package/docs/ListEtfHoldings200ResponseMeta.md +47 -0
- package/docs/ListEtfHoldings200ResponseMetaComposition.md +43 -0
- package/docs/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.md +41 -0
- package/docs/ListEtfWeights200Response.md +41 -0
- package/docs/ListEtfWeights200ResponseMeta.md +45 -0
- package/package.json +1 -1
- package/src/apis/HoldingsApi.ts +192 -2
- package/src/models/EtfHolding.ts +248 -0
- package/src/models/EtfWeight.ts +150 -0
- package/src/models/ListEtfHoldings200Response.ts +108 -0
- package/src/models/ListEtfHoldings200ResponseMeta.ts +151 -0
- package/src/models/ListEtfHoldings200ResponseMetaComposition.ts +105 -0
- package/src/models/ListEtfHoldings200ResponseMetaCompositionStoredDatesInner.ts +103 -0
- package/src/models/ListEtfWeights200Response.ts +108 -0
- package/src/models/ListEtfWeights200ResponseMeta.ts +148 -0
- package/src/models/index.ts +8 -0
|
@@ -0,0 +1,108 @@
|
|
|
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
|
+
import type { EtfHolding } from './EtfHolding';
|
|
17
|
+
import {
|
|
18
|
+
EtfHoldingFromJSON,
|
|
19
|
+
EtfHoldingFromJSONTyped,
|
|
20
|
+
EtfHoldingToJSON,
|
|
21
|
+
EtfHoldingToJSONTyped,
|
|
22
|
+
} from './EtfHolding';
|
|
23
|
+
import type { ListEtfHoldings200ResponseMeta } from './ListEtfHoldings200ResponseMeta';
|
|
24
|
+
import {
|
|
25
|
+
ListEtfHoldings200ResponseMetaFromJSON,
|
|
26
|
+
ListEtfHoldings200ResponseMetaFromJSONTyped,
|
|
27
|
+
ListEtfHoldings200ResponseMetaToJSON,
|
|
28
|
+
ListEtfHoldings200ResponseMetaToJSONTyped,
|
|
29
|
+
} from './ListEtfHoldings200ResponseMeta';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* A page of EtfHolding rows (the list envelope, R3)
|
|
33
|
+
* @export
|
|
34
|
+
* @interface ListEtfHoldings200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface ListEtfHoldings200Response {
|
|
37
|
+
/**
|
|
38
|
+
* The rows of this page
|
|
39
|
+
* @type {Array<EtfHolding>}
|
|
40
|
+
* @memberof ListEtfHoldings200Response
|
|
41
|
+
*/
|
|
42
|
+
data: Array<EtfHolding>;
|
|
43
|
+
/**
|
|
44
|
+
* true when a next page exists
|
|
45
|
+
* @type {boolean}
|
|
46
|
+
* @memberof ListEtfHoldings200Response
|
|
47
|
+
*/
|
|
48
|
+
has_more: boolean;
|
|
49
|
+
/**
|
|
50
|
+
* Opaque cursor of the next page; null on the last page
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof ListEtfHoldings200Response
|
|
53
|
+
*/
|
|
54
|
+
next_cursor: string | null;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {ListEtfHoldings200ResponseMeta}
|
|
58
|
+
* @memberof ListEtfHoldings200Response
|
|
59
|
+
*/
|
|
60
|
+
meta: ListEtfHoldings200ResponseMeta;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the ListEtfHoldings200Response interface.
|
|
65
|
+
*/
|
|
66
|
+
export function instanceOfListEtfHoldings200Response(value: object): value is ListEtfHoldings200Response {
|
|
67
|
+
if (!('data' in value) || value['data'] === undefined) return false;
|
|
68
|
+
if (!('has_more' in value) || value['has_more'] === undefined) return false;
|
|
69
|
+
if (!('next_cursor' in value) || value['next_cursor'] === undefined) return false;
|
|
70
|
+
if (!('meta' in value) || value['meta'] === undefined) return false;
|
|
71
|
+
return true;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export function ListEtfHoldings200ResponseFromJSON(json: any): ListEtfHoldings200Response {
|
|
75
|
+
return ListEtfHoldings200ResponseFromJSONTyped(json, false);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export function ListEtfHoldings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfHoldings200Response {
|
|
79
|
+
if (json == null) {
|
|
80
|
+
return json;
|
|
81
|
+
}
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': ((json['data'] as Array<any>).map(EtfHoldingFromJSON)),
|
|
85
|
+
'has_more': json['has_more'],
|
|
86
|
+
'next_cursor': json['next_cursor'],
|
|
87
|
+
'meta': ListEtfHoldings200ResponseMetaFromJSON(json['meta']),
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function ListEtfHoldings200ResponseToJSON(json: any): ListEtfHoldings200Response {
|
|
92
|
+
return ListEtfHoldings200ResponseToJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function ListEtfHoldings200ResponseToJSONTyped(value?: ListEtfHoldings200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
96
|
+
if (value == null) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
'data': ((value['data'] as Array<any>).map(EtfHoldingToJSON)),
|
|
103
|
+
'has_more': value['has_more'],
|
|
104
|
+
'next_cursor': value['next_cursor'],
|
|
105
|
+
'meta': ListEtfHoldings200ResponseMetaToJSON(value['meta']),
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
@@ -0,0 +1,151 @@
|
|
|
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
|
+
import type { MetaCoverage } from './MetaCoverage';
|
|
17
|
+
import {
|
|
18
|
+
MetaCoverageFromJSON,
|
|
19
|
+
MetaCoverageFromJSONTyped,
|
|
20
|
+
MetaCoverageToJSON,
|
|
21
|
+
MetaCoverageToJSONTyped,
|
|
22
|
+
} from './MetaCoverage';
|
|
23
|
+
import type { ListEtfHoldings200ResponseMetaComposition } from './ListEtfHoldings200ResponseMetaComposition';
|
|
24
|
+
import {
|
|
25
|
+
ListEtfHoldings200ResponseMetaCompositionFromJSON,
|
|
26
|
+
ListEtfHoldings200ResponseMetaCompositionFromJSONTyped,
|
|
27
|
+
ListEtfHoldings200ResponseMetaCompositionToJSON,
|
|
28
|
+
ListEtfHoldings200ResponseMetaCompositionToJSONTyped,
|
|
29
|
+
} from './ListEtfHoldings200ResponseMetaComposition';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Page metadata
|
|
33
|
+
* @export
|
|
34
|
+
* @interface ListEtfHoldings200ResponseMeta
|
|
35
|
+
*/
|
|
36
|
+
export interface ListEtfHoldings200ResponseMeta {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {MetaCoverage}
|
|
40
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
41
|
+
*/
|
|
42
|
+
coverage?: MetaCoverage;
|
|
43
|
+
/**
|
|
44
|
+
* 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)
|
|
45
|
+
* @type {ListEtfHoldings200ResponseMetaSourceEnum}
|
|
46
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
47
|
+
*/
|
|
48
|
+
source?: ListEtfHoldings200ResponseMetaSourceEnum | null;
|
|
49
|
+
/**
|
|
50
|
+
* The date the composition is stated as of (etf=); null with company=
|
|
51
|
+
* @type {Date}
|
|
52
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
53
|
+
*/
|
|
54
|
+
as_of?: Date | null;
|
|
55
|
+
/**
|
|
56
|
+
* 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)
|
|
57
|
+
* @type {ListEtfHoldings200ResponseMetaReasonEnum}
|
|
58
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
59
|
+
*/
|
|
60
|
+
reason?: ListEtfHoldings200ResponseMetaReasonEnum | null;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @type {ListEtfHoldings200ResponseMetaComposition}
|
|
64
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
65
|
+
*/
|
|
66
|
+
composition?: ListEtfHoldings200ResponseMetaComposition | null;
|
|
67
|
+
/**
|
|
68
|
+
* company=: how many ETFs the store reads an issuer file for (the ETFs this list can name)
|
|
69
|
+
* @type {number}
|
|
70
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
71
|
+
*/
|
|
72
|
+
issuer_sourced_etfs?: number | null;
|
|
73
|
+
/**
|
|
74
|
+
* true when the composition (etf=) or the ETFs holding the company (company=) changed since the first page of this walk (a newer issuer file arrived): restart from the first page for one consistent answer
|
|
75
|
+
* @type {boolean}
|
|
76
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
77
|
+
*/
|
|
78
|
+
snapshot_changed?: boolean | null;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* @export
|
|
84
|
+
*/
|
|
85
|
+
export const ListEtfHoldings200ResponseMetaSourceEnum = {
|
|
86
|
+
IssuerDaily: 'issuer_daily',
|
|
87
|
+
IssuerMonthly: 'issuer_monthly',
|
|
88
|
+
Nport: 'nport'
|
|
89
|
+
} as const;
|
|
90
|
+
export type ListEtfHoldings200ResponseMetaSourceEnum = typeof ListEtfHoldings200ResponseMetaSourceEnum[keyof typeof ListEtfHoldings200ResponseMetaSourceEnum] | (string & {});
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* @export
|
|
94
|
+
*/
|
|
95
|
+
export const ListEtfHoldings200ResponseMetaReasonEnum = {
|
|
96
|
+
SingleAssetTrust: 'single_asset_trust',
|
|
97
|
+
SourceStale: 'source_stale',
|
|
98
|
+
IssuerSourceUnavailable: 'issuer_source_unavailable',
|
|
99
|
+
WeightsUnavailable: 'weights_unavailable'
|
|
100
|
+
} as const;
|
|
101
|
+
export type ListEtfHoldings200ResponseMetaReasonEnum = typeof ListEtfHoldings200ResponseMetaReasonEnum[keyof typeof ListEtfHoldings200ResponseMetaReasonEnum] | (string & {});
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Check if a given object implements the ListEtfHoldings200ResponseMeta interface.
|
|
106
|
+
*/
|
|
107
|
+
export function instanceOfListEtfHoldings200ResponseMeta(value: object): value is ListEtfHoldings200ResponseMeta {
|
|
108
|
+
return true;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export function ListEtfHoldings200ResponseMetaFromJSON(json: any): ListEtfHoldings200ResponseMeta {
|
|
112
|
+
return ListEtfHoldings200ResponseMetaFromJSONTyped(json, false);
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export function ListEtfHoldings200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfHoldings200ResponseMeta {
|
|
116
|
+
if (json == null) {
|
|
117
|
+
return json;
|
|
118
|
+
}
|
|
119
|
+
return {
|
|
120
|
+
|
|
121
|
+
'coverage': json['coverage'] == null ? undefined : MetaCoverageFromJSON(json['coverage']),
|
|
122
|
+
'source': json['source'] == null ? undefined : json['source'],
|
|
123
|
+
'as_of': json['as_of'] == null ? undefined : (new Date(json['as_of'])),
|
|
124
|
+
'reason': json['reason'] == null ? undefined : json['reason'],
|
|
125
|
+
'composition': json['composition'] == null ? undefined : ListEtfHoldings200ResponseMetaCompositionFromJSON(json['composition']),
|
|
126
|
+
'issuer_sourced_etfs': json['issuer_sourced_etfs'] == null ? undefined : json['issuer_sourced_etfs'],
|
|
127
|
+
'snapshot_changed': json['snapshot_changed'] == null ? undefined : json['snapshot_changed'],
|
|
128
|
+
};
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
export function ListEtfHoldings200ResponseMetaToJSON(json: any): ListEtfHoldings200ResponseMeta {
|
|
132
|
+
return ListEtfHoldings200ResponseMetaToJSONTyped(json, false);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
export function ListEtfHoldings200ResponseMetaToJSONTyped(value?: ListEtfHoldings200ResponseMeta | null, ignoreDiscriminator: boolean = false): any {
|
|
136
|
+
if (value == null) {
|
|
137
|
+
return value;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
return {
|
|
141
|
+
|
|
142
|
+
'coverage': MetaCoverageToJSON(value['coverage']),
|
|
143
|
+
'source': value['source'],
|
|
144
|
+
'as_of': value['as_of'] == null ? value['as_of'] : value['as_of'].toISOString().substring(0,10),
|
|
145
|
+
'reason': value['reason'],
|
|
146
|
+
'composition': ListEtfHoldings200ResponseMetaCompositionToJSON(value['composition']),
|
|
147
|
+
'issuer_sourced_etfs': value['issuer_sourced_etfs'],
|
|
148
|
+
'snapshot_changed': value['snapshot_changed'],
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
|
|
@@ -0,0 +1,105 @@
|
|
|
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
|
+
import type { ListEtfHoldings200ResponseMetaCompositionStoredDatesInner } from './ListEtfHoldings200ResponseMetaCompositionStoredDatesInner';
|
|
17
|
+
import {
|
|
18
|
+
ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerFromJSON,
|
|
19
|
+
ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerFromJSONTyped,
|
|
20
|
+
ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerToJSON,
|
|
21
|
+
ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerToJSONTyped,
|
|
22
|
+
} from './ListEtfHoldings200ResponseMetaCompositionStoredDatesInner';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* What the store holds for the ETF (etf=); null with company=
|
|
26
|
+
* @export
|
|
27
|
+
* @interface ListEtfHoldings200ResponseMetaComposition
|
|
28
|
+
*/
|
|
29
|
+
export interface ListEtfHoldings200ResponseMetaComposition {
|
|
30
|
+
/**
|
|
31
|
+
* Date of the newest issuer holdings file
|
|
32
|
+
* @type {Date}
|
|
33
|
+
* @memberof ListEtfHoldings200ResponseMetaComposition
|
|
34
|
+
*/
|
|
35
|
+
newest_issuer_as_of?: Date | null;
|
|
36
|
+
/**
|
|
37
|
+
* Report date of the fund's latest public N-PORT report
|
|
38
|
+
* @type {Date}
|
|
39
|
+
* @memberof ListEtfHoldings200ResponseMetaComposition
|
|
40
|
+
*/
|
|
41
|
+
nport_report_date?: Date | null;
|
|
42
|
+
/**
|
|
43
|
+
* Oldest issuer file kept (about 30 days are kept)
|
|
44
|
+
* @type {Date}
|
|
45
|
+
* @memberof ListEtfHoldings200ResponseMetaComposition
|
|
46
|
+
*/
|
|
47
|
+
stored_from?: Date | null;
|
|
48
|
+
/**
|
|
49
|
+
* Newest issuer file kept
|
|
50
|
+
* @type {Date}
|
|
51
|
+
* @memberof ListEtfHoldings200ResponseMetaComposition
|
|
52
|
+
*/
|
|
53
|
+
stored_to?: Date | null;
|
|
54
|
+
/**
|
|
55
|
+
* Every stored date (issuer files and N-PORT reports), newest first; as_of= picks one
|
|
56
|
+
* @type {Array<ListEtfHoldings200ResponseMetaCompositionStoredDatesInner>}
|
|
57
|
+
* @memberof ListEtfHoldings200ResponseMetaComposition
|
|
58
|
+
*/
|
|
59
|
+
stored_dates?: Array<ListEtfHoldings200ResponseMetaCompositionStoredDatesInner>;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Check if a given object implements the ListEtfHoldings200ResponseMetaComposition interface.
|
|
64
|
+
*/
|
|
65
|
+
export function instanceOfListEtfHoldings200ResponseMetaComposition(value: object): value is ListEtfHoldings200ResponseMetaComposition {
|
|
66
|
+
return true;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function ListEtfHoldings200ResponseMetaCompositionFromJSON(json: any): ListEtfHoldings200ResponseMetaComposition {
|
|
70
|
+
return ListEtfHoldings200ResponseMetaCompositionFromJSONTyped(json, false);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function ListEtfHoldings200ResponseMetaCompositionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfHoldings200ResponseMetaComposition {
|
|
74
|
+
if (json == null) {
|
|
75
|
+
return json;
|
|
76
|
+
}
|
|
77
|
+
return {
|
|
78
|
+
|
|
79
|
+
'newest_issuer_as_of': json['newest_issuer_as_of'] == null ? undefined : (new Date(json['newest_issuer_as_of'])),
|
|
80
|
+
'nport_report_date': json['nport_report_date'] == null ? undefined : (new Date(json['nport_report_date'])),
|
|
81
|
+
'stored_from': json['stored_from'] == null ? undefined : (new Date(json['stored_from'])),
|
|
82
|
+
'stored_to': json['stored_to'] == null ? undefined : (new Date(json['stored_to'])),
|
|
83
|
+
'stored_dates': json['stored_dates'] == null ? undefined : ((json['stored_dates'] as Array<any>).map(ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerFromJSON)),
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function ListEtfHoldings200ResponseMetaCompositionToJSON(json: any): ListEtfHoldings200ResponseMetaComposition {
|
|
88
|
+
return ListEtfHoldings200ResponseMetaCompositionToJSONTyped(json, false);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function ListEtfHoldings200ResponseMetaCompositionToJSONTyped(value?: ListEtfHoldings200ResponseMetaComposition | null, ignoreDiscriminator: boolean = false): any {
|
|
92
|
+
if (value == null) {
|
|
93
|
+
return value;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
return {
|
|
97
|
+
|
|
98
|
+
'newest_issuer_as_of': value['newest_issuer_as_of'] == null ? value['newest_issuer_as_of'] : value['newest_issuer_as_of'].toISOString().substring(0,10),
|
|
99
|
+
'nport_report_date': value['nport_report_date'] == null ? value['nport_report_date'] : value['nport_report_date'].toISOString().substring(0,10),
|
|
100
|
+
'stored_from': value['stored_from'] == null ? value['stored_from'] : value['stored_from'].toISOString().substring(0,10),
|
|
101
|
+
'stored_to': value['stored_to'] == null ? value['stored_to'] : value['stored_to'].toISOString().substring(0,10),
|
|
102
|
+
'stored_dates': value['stored_dates'] == null ? undefined : ((value['stored_dates'] as Array<any>).map(ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerToJSON)),
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
|
@@ -0,0 +1,103 @@
|
|
|
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
|
+
* One stored composition date of the ETF
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
20
|
+
*/
|
|
21
|
+
export interface ListEtfHoldings200ResponseMetaCompositionStoredDatesInner {
|
|
22
|
+
/**
|
|
23
|
+
* Composition date
|
|
24
|
+
* @type {Date}
|
|
25
|
+
* @memberof ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
26
|
+
*/
|
|
27
|
+
as_of: Date;
|
|
28
|
+
/**
|
|
29
|
+
* issuer_daily / issuer_monthly / nport
|
|
30
|
+
* @type {ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerSourceEnum}
|
|
31
|
+
* @memberof ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
32
|
+
*/
|
|
33
|
+
source: ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerSourceEnum;
|
|
34
|
+
/**
|
|
35
|
+
* ready, or quarantined / superseded for an issuer file that is not served
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
38
|
+
*/
|
|
39
|
+
status?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* Positions in that composition
|
|
42
|
+
* @type {number}
|
|
43
|
+
* @memberof ListEtfHoldings200ResponseMetaCompositionStoredDatesInner
|
|
44
|
+
*/
|
|
45
|
+
positions_count?: number | null;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export const ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerSourceEnum = {
|
|
53
|
+
IssuerDaily: 'issuer_daily',
|
|
54
|
+
IssuerMonthly: 'issuer_monthly',
|
|
55
|
+
Nport: 'nport'
|
|
56
|
+
} as const;
|
|
57
|
+
export type ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerSourceEnum = typeof ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerSourceEnum[keyof typeof ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerSourceEnum] | (string & {});
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the ListEtfHoldings200ResponseMetaCompositionStoredDatesInner interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfListEtfHoldings200ResponseMetaCompositionStoredDatesInner(value: object): value is ListEtfHoldings200ResponseMetaCompositionStoredDatesInner {
|
|
64
|
+
if (!('as_of' in value) || value['as_of'] === undefined) return false;
|
|
65
|
+
if (!('source' in value) || value['source'] === undefined) return false;
|
|
66
|
+
return true;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerFromJSON(json: any): ListEtfHoldings200ResponseMetaCompositionStoredDatesInner {
|
|
70
|
+
return ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerFromJSONTyped(json, false);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfHoldings200ResponseMetaCompositionStoredDatesInner {
|
|
74
|
+
if (json == null) {
|
|
75
|
+
return json;
|
|
76
|
+
}
|
|
77
|
+
return {
|
|
78
|
+
|
|
79
|
+
'as_of': (new Date(json['as_of'])),
|
|
80
|
+
'source': json['source'],
|
|
81
|
+
'status': json['status'] == null ? undefined : json['status'],
|
|
82
|
+
'positions_count': json['positions_count'] == null ? undefined : json['positions_count'],
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export function ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerToJSON(json: any): ListEtfHoldings200ResponseMetaCompositionStoredDatesInner {
|
|
87
|
+
return ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerToJSONTyped(json, false);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function ListEtfHoldings200ResponseMetaCompositionStoredDatesInnerToJSONTyped(value?: ListEtfHoldings200ResponseMetaCompositionStoredDatesInner | null, ignoreDiscriminator: boolean = false): any {
|
|
91
|
+
if (value == null) {
|
|
92
|
+
return value;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
return {
|
|
96
|
+
|
|
97
|
+
'as_of': value['as_of'].toISOString().substring(0,10),
|
|
98
|
+
'source': value['source'],
|
|
99
|
+
'status': value['status'],
|
|
100
|
+
'positions_count': value['positions_count'],
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
|
|
@@ -0,0 +1,108 @@
|
|
|
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
|
+
import type { EtfWeight } from './EtfWeight';
|
|
17
|
+
import {
|
|
18
|
+
EtfWeightFromJSON,
|
|
19
|
+
EtfWeightFromJSONTyped,
|
|
20
|
+
EtfWeightToJSON,
|
|
21
|
+
EtfWeightToJSONTyped,
|
|
22
|
+
} from './EtfWeight';
|
|
23
|
+
import type { ListEtfWeights200ResponseMeta } from './ListEtfWeights200ResponseMeta';
|
|
24
|
+
import {
|
|
25
|
+
ListEtfWeights200ResponseMetaFromJSON,
|
|
26
|
+
ListEtfWeights200ResponseMetaFromJSONTyped,
|
|
27
|
+
ListEtfWeights200ResponseMetaToJSON,
|
|
28
|
+
ListEtfWeights200ResponseMetaToJSONTyped,
|
|
29
|
+
} from './ListEtfWeights200ResponseMeta';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* A page of EtfWeight rows (the list envelope, R3)
|
|
33
|
+
* @export
|
|
34
|
+
* @interface ListEtfWeights200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface ListEtfWeights200Response {
|
|
37
|
+
/**
|
|
38
|
+
* The rows of this page
|
|
39
|
+
* @type {Array<EtfWeight>}
|
|
40
|
+
* @memberof ListEtfWeights200Response
|
|
41
|
+
*/
|
|
42
|
+
data: Array<EtfWeight>;
|
|
43
|
+
/**
|
|
44
|
+
* true when a next page exists
|
|
45
|
+
* @type {boolean}
|
|
46
|
+
* @memberof ListEtfWeights200Response
|
|
47
|
+
*/
|
|
48
|
+
has_more: boolean;
|
|
49
|
+
/**
|
|
50
|
+
* Opaque cursor of the next page; null on the last page
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof ListEtfWeights200Response
|
|
53
|
+
*/
|
|
54
|
+
next_cursor: string | null;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {ListEtfWeights200ResponseMeta}
|
|
58
|
+
* @memberof ListEtfWeights200Response
|
|
59
|
+
*/
|
|
60
|
+
meta: ListEtfWeights200ResponseMeta;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the ListEtfWeights200Response interface.
|
|
65
|
+
*/
|
|
66
|
+
export function instanceOfListEtfWeights200Response(value: object): value is ListEtfWeights200Response {
|
|
67
|
+
if (!('data' in value) || value['data'] === undefined) return false;
|
|
68
|
+
if (!('has_more' in value) || value['has_more'] === undefined) return false;
|
|
69
|
+
if (!('next_cursor' in value) || value['next_cursor'] === undefined) return false;
|
|
70
|
+
if (!('meta' in value) || value['meta'] === undefined) return false;
|
|
71
|
+
return true;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export function ListEtfWeights200ResponseFromJSON(json: any): ListEtfWeights200Response {
|
|
75
|
+
return ListEtfWeights200ResponseFromJSONTyped(json, false);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export function ListEtfWeights200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfWeights200Response {
|
|
79
|
+
if (json == null) {
|
|
80
|
+
return json;
|
|
81
|
+
}
|
|
82
|
+
return {
|
|
83
|
+
|
|
84
|
+
'data': ((json['data'] as Array<any>).map(EtfWeightFromJSON)),
|
|
85
|
+
'has_more': json['has_more'],
|
|
86
|
+
'next_cursor': json['next_cursor'],
|
|
87
|
+
'meta': ListEtfWeights200ResponseMetaFromJSON(json['meta']),
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function ListEtfWeights200ResponseToJSON(json: any): ListEtfWeights200Response {
|
|
92
|
+
return ListEtfWeights200ResponseToJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function ListEtfWeights200ResponseToJSONTyped(value?: ListEtfWeights200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
96
|
+
if (value == null) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
'data': ((value['data'] as Array<any>).map(EtfWeightToJSON)),
|
|
103
|
+
'has_more': value['has_more'],
|
|
104
|
+
'next_cursor': value['next_cursor'],
|
|
105
|
+
'meta': ListEtfWeights200ResponseMetaToJSON(value['meta']),
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|