@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,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;
|
|
@@ -0,0 +1,97 @@
|
|
|
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
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const EtfHoldingSourceEnum = {
|
|
18
|
+
IssuerDaily: 'issuer_daily',
|
|
19
|
+
IssuerMonthly: 'issuer_monthly',
|
|
20
|
+
Nport: 'nport'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the EtfHolding interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfEtfHolding(value) {
|
|
26
|
+
if (!('etf_symbol' in value) || value['etf_symbol'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('as_of' in value) || value['as_of'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
export function EtfHoldingFromJSON(json) {
|
|
35
|
+
return EtfHoldingFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function EtfHoldingFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'etf_symbol': json['etf_symbol'],
|
|
43
|
+
'etf_name': json['etf_name'] == null ? undefined : json['etf_name'],
|
|
44
|
+
'series_id': json['series_id'] == null ? undefined : json['series_id'],
|
|
45
|
+
'source': json['source'],
|
|
46
|
+
'as_of': (new Date(json['as_of'])),
|
|
47
|
+
'line': json['line'] == null ? undefined : json['line'],
|
|
48
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
49
|
+
'ticker': json['ticker'] == null ? undefined : json['ticker'],
|
|
50
|
+
'cusip': json['cusip'] == null ? undefined : json['cusip'],
|
|
51
|
+
'isin': json['isin'] == null ? undefined : json['isin'],
|
|
52
|
+
'sedol': json['sedol'] == null ? undefined : json['sedol'],
|
|
53
|
+
'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
|
|
54
|
+
'shares': json['shares'] == null ? undefined : json['shares'],
|
|
55
|
+
'market_value_usd': json['market_value_usd'] == null ? undefined : json['market_value_usd'],
|
|
56
|
+
'notional_value_usd': json['notional_value_usd'] == null ? undefined : json['notional_value_usd'],
|
|
57
|
+
'weight_pct': json['weight_pct'] == null ? undefined : json['weight_pct'],
|
|
58
|
+
'sector': json['sector'] == null ? undefined : json['sector'],
|
|
59
|
+
'sector_basis': json['sector_basis'] == null ? undefined : json['sector_basis'],
|
|
60
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
61
|
+
'country_basis': json['country_basis'] == null ? undefined : json['country_basis'],
|
|
62
|
+
'issuer_cik': json['issuer_cik'] == null ? undefined : json['issuer_cik'],
|
|
63
|
+
'issuer_resolution': json['issuer_resolution'] == null ? undefined : json['issuer_resolution'],
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
export function EtfHoldingToJSON(json) {
|
|
67
|
+
return EtfHoldingToJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
export function EtfHoldingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
70
|
+
if (value == null) {
|
|
71
|
+
return value;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
'etf_symbol': value['etf_symbol'],
|
|
75
|
+
'etf_name': value['etf_name'],
|
|
76
|
+
'series_id': value['series_id'],
|
|
77
|
+
'source': value['source'],
|
|
78
|
+
'as_of': value['as_of'].toISOString().substring(0, 10),
|
|
79
|
+
'line': value['line'],
|
|
80
|
+
'name': value['name'],
|
|
81
|
+
'ticker': value['ticker'],
|
|
82
|
+
'cusip': value['cusip'],
|
|
83
|
+
'isin': value['isin'],
|
|
84
|
+
'sedol': value['sedol'],
|
|
85
|
+
'asset_class': value['asset_class'],
|
|
86
|
+
'shares': value['shares'],
|
|
87
|
+
'market_value_usd': value['market_value_usd'],
|
|
88
|
+
'notional_value_usd': value['notional_value_usd'],
|
|
89
|
+
'weight_pct': value['weight_pct'],
|
|
90
|
+
'sector': value['sector'],
|
|
91
|
+
'sector_basis': value['sector_basis'],
|
|
92
|
+
'country': value['country'],
|
|
93
|
+
'country_basis': value['country_basis'],
|
|
94
|
+
'issuer_cik': value['issuer_cik'],
|
|
95
|
+
'issuer_resolution': value['issuer_resolution'],
|
|
96
|
+
};
|
|
97
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
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 EtfWeight
|
|
16
|
+
*/
|
|
17
|
+
export interface EtfWeight {
|
|
18
|
+
/**
|
|
19
|
+
* The ETF's ticker
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof EtfWeight
|
|
22
|
+
*/
|
|
23
|
+
etf_symbol: string;
|
|
24
|
+
/**
|
|
25
|
+
* The composition the weights come from
|
|
26
|
+
* @type {EtfWeightSourceEnum}
|
|
27
|
+
* @memberof EtfWeight
|
|
28
|
+
*/
|
|
29
|
+
source: EtfWeightSourceEnum;
|
|
30
|
+
/**
|
|
31
|
+
* The date the composition is stated as of
|
|
32
|
+
* @type {Date}
|
|
33
|
+
* @memberof EtfWeight
|
|
34
|
+
*/
|
|
35
|
+
as_of: Date;
|
|
36
|
+
/**
|
|
37
|
+
* sector, country or asset_class
|
|
38
|
+
* @type {EtfWeightDimensionEnum}
|
|
39
|
+
* @memberof EtfWeight
|
|
40
|
+
*/
|
|
41
|
+
dimension: EtfWeightDimensionEnum;
|
|
42
|
+
/**
|
|
43
|
+
* The bucket label (a sector, an ISO country code, an asset class; Unclassified / Cash and other)
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof EtfWeight
|
|
46
|
+
*/
|
|
47
|
+
bucket: string;
|
|
48
|
+
/**
|
|
49
|
+
* Percent of the fund in this bucket
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof EtfWeight
|
|
52
|
+
*/
|
|
53
|
+
weight_pct: number;
|
|
54
|
+
/**
|
|
55
|
+
* Positions in the bucket
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof EtfWeight
|
|
58
|
+
*/
|
|
59
|
+
positions?: number | null;
|
|
60
|
+
/**
|
|
61
|
+
* issuer_stated, derived_sic, nport, isin_prefix, registrant, mixed or none
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof EtfWeight
|
|
64
|
+
*/
|
|
65
|
+
basis: string;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* @export
|
|
69
|
+
*/
|
|
70
|
+
export declare const EtfWeightSourceEnum: {
|
|
71
|
+
readonly IssuerDaily: "issuer_daily";
|
|
72
|
+
readonly IssuerMonthly: "issuer_monthly";
|
|
73
|
+
readonly Nport: "nport";
|
|
74
|
+
};
|
|
75
|
+
export type EtfWeightSourceEnum = typeof EtfWeightSourceEnum[keyof typeof EtfWeightSourceEnum] | (string & {});
|
|
76
|
+
/**
|
|
77
|
+
* @export
|
|
78
|
+
*/
|
|
79
|
+
export declare const EtfWeightDimensionEnum: {
|
|
80
|
+
readonly Sector: "sector";
|
|
81
|
+
readonly Country: "country";
|
|
82
|
+
readonly AssetClass: "asset_class";
|
|
83
|
+
};
|
|
84
|
+
export type EtfWeightDimensionEnum = typeof EtfWeightDimensionEnum[keyof typeof EtfWeightDimensionEnum] | (string & {});
|
|
85
|
+
/**
|
|
86
|
+
* Check if a given object implements the EtfWeight interface.
|
|
87
|
+
*/
|
|
88
|
+
export declare function instanceOfEtfWeight(value: object): value is EtfWeight;
|
|
89
|
+
export declare function EtfWeightFromJSON(json: any): EtfWeight;
|
|
90
|
+
export declare function EtfWeightFromJSONTyped(json: any, ignoreDiscriminator: boolean): EtfWeight;
|
|
91
|
+
export declare function EtfWeightToJSON(json: any): EtfWeight;
|
|
92
|
+
export declare function EtfWeightToJSONTyped(value?: EtfWeight | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,85 @@
|
|
|
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
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const EtfWeightSourceEnum = {
|
|
18
|
+
IssuerDaily: 'issuer_daily',
|
|
19
|
+
IssuerMonthly: 'issuer_monthly',
|
|
20
|
+
Nport: 'nport'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export const EtfWeightDimensionEnum = {
|
|
26
|
+
Sector: 'sector',
|
|
27
|
+
Country: 'country',
|
|
28
|
+
AssetClass: 'asset_class'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the EtfWeight interface.
|
|
32
|
+
*/
|
|
33
|
+
export function instanceOfEtfWeight(value) {
|
|
34
|
+
if (!('etf_symbol' in value) || value['etf_symbol'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('as_of' in value) || value['as_of'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('dimension' in value) || value['dimension'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('bucket' in value) || value['bucket'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('weight_pct' in value) || value['weight_pct'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('basis' in value) || value['basis'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
return true;
|
|
49
|
+
}
|
|
50
|
+
export function EtfWeightFromJSON(json) {
|
|
51
|
+
return EtfWeightFromJSONTyped(json, false);
|
|
52
|
+
}
|
|
53
|
+
export function EtfWeightFromJSONTyped(json, ignoreDiscriminator) {
|
|
54
|
+
if (json == null) {
|
|
55
|
+
return json;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
'etf_symbol': json['etf_symbol'],
|
|
59
|
+
'source': json['source'],
|
|
60
|
+
'as_of': (new Date(json['as_of'])),
|
|
61
|
+
'dimension': json['dimension'],
|
|
62
|
+
'bucket': json['bucket'],
|
|
63
|
+
'weight_pct': json['weight_pct'],
|
|
64
|
+
'positions': json['positions'] == null ? undefined : json['positions'],
|
|
65
|
+
'basis': json['basis'],
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
export function EtfWeightToJSON(json) {
|
|
69
|
+
return EtfWeightToJSONTyped(json, false);
|
|
70
|
+
}
|
|
71
|
+
export function EtfWeightToJSONTyped(value, ignoreDiscriminator = false) {
|
|
72
|
+
if (value == null) {
|
|
73
|
+
return value;
|
|
74
|
+
}
|
|
75
|
+
return {
|
|
76
|
+
'etf_symbol': value['etf_symbol'],
|
|
77
|
+
'source': value['source'],
|
|
78
|
+
'as_of': value['as_of'].toISOString().substring(0, 10),
|
|
79
|
+
'dimension': value['dimension'],
|
|
80
|
+
'bucket': value['bucket'],
|
|
81
|
+
'weight_pct': value['weight_pct'],
|
|
82
|
+
'positions': value['positions'],
|
|
83
|
+
'basis': value['basis'],
|
|
84
|
+
};
|
|
85
|
+
}
|
|
@@ -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 { EtfHolding } from './EtfHolding';
|
|
13
|
+
import type { ListEtfHoldings200ResponseMeta } from './ListEtfHoldings200ResponseMeta';
|
|
14
|
+
/**
|
|
15
|
+
* A page of EtfHolding rows (the list envelope, R3)
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ListEtfHoldings200Response
|
|
18
|
+
*/
|
|
19
|
+
export interface ListEtfHoldings200Response {
|
|
20
|
+
/**
|
|
21
|
+
* The rows of this page
|
|
22
|
+
* @type {Array<EtfHolding>}
|
|
23
|
+
* @memberof ListEtfHoldings200Response
|
|
24
|
+
*/
|
|
25
|
+
data: Array<EtfHolding>;
|
|
26
|
+
/**
|
|
27
|
+
* true when a next page exists
|
|
28
|
+
* @type {boolean}
|
|
29
|
+
* @memberof ListEtfHoldings200Response
|
|
30
|
+
*/
|
|
31
|
+
has_more: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Opaque cursor of the next page; null on the last page
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ListEtfHoldings200Response
|
|
36
|
+
*/
|
|
37
|
+
next_cursor: string | null;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {ListEtfHoldings200ResponseMeta}
|
|
41
|
+
* @memberof ListEtfHoldings200Response
|
|
42
|
+
*/
|
|
43
|
+
meta: ListEtfHoldings200ResponseMeta;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Check if a given object implements the ListEtfHoldings200Response interface.
|
|
47
|
+
*/
|
|
48
|
+
export declare function instanceOfListEtfHoldings200Response(value: object): value is ListEtfHoldings200Response;
|
|
49
|
+
export declare function ListEtfHoldings200ResponseFromJSON(json: any): ListEtfHoldings200Response;
|
|
50
|
+
export declare function ListEtfHoldings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfHoldings200Response;
|
|
51
|
+
export declare function ListEtfHoldings200ResponseToJSON(json: any): ListEtfHoldings200Response;
|
|
52
|
+
export declare function ListEtfHoldings200ResponseToJSONTyped(value?: ListEtfHoldings200Response | 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 { EtfHoldingFromJSON, EtfHoldingToJSON, } from './EtfHolding';
|
|
15
|
+
import { ListEtfHoldings200ResponseMetaFromJSON, ListEtfHoldings200ResponseMetaToJSON, } from './ListEtfHoldings200ResponseMeta';
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the ListEtfHoldings200Response interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfListEtfHoldings200Response(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 ListEtfHoldings200ResponseFromJSON(json) {
|
|
31
|
+
return ListEtfHoldings200ResponseFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
export function ListEtfHoldings200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'data': (json['data'].map(EtfHoldingFromJSON)),
|
|
39
|
+
'has_more': json['has_more'],
|
|
40
|
+
'next_cursor': json['next_cursor'],
|
|
41
|
+
'meta': ListEtfHoldings200ResponseMetaFromJSON(json['meta']),
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
export function ListEtfHoldings200ResponseToJSON(json) {
|
|
45
|
+
return ListEtfHoldings200ResponseToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
export function ListEtfHoldings200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'data': (value['data'].map(EtfHoldingToJSON)),
|
|
53
|
+
'has_more': value['has_more'],
|
|
54
|
+
'next_cursor': value['next_cursor'],
|
|
55
|
+
'meta': ListEtfHoldings200ResponseMetaToJSON(value['meta']),
|
|
56
|
+
};
|
|
57
|
+
}
|