@invinite-org/data-api-client 5.7.0 → 5.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +16 -0
- package/dist/apis/EventsApi.d.ts +2 -2
- package/dist/apis/EventsApi.js +2 -2
- package/dist/apis/HoldingsApi.d.ts +57 -2
- package/dist/apis/HoldingsApi.js +142 -3
- package/dist/esm/apis/EventsApi.d.ts +2 -2
- package/dist/esm/apis/EventsApi.js +2 -2
- 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/Event.d.ts +2 -1
- package/dist/esm/models/Event.js +2 -1
- package/dist/esm/models/EventCalendarCall.d.ts +2 -1
- package/dist/esm/models/EventCalendarCall.js +1 -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/Event.d.ts +2 -1
- package/dist/models/Event.js +2 -1
- package/dist/models/EventCalendarCall.d.ts +2 -1
- package/dist/models/EventCalendarCall.js +1 -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/EventsApi.md +1 -1
- 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/EventsApi.ts +2 -2
- package/src/apis/HoldingsApi.ts +192 -2
- package/src/models/EtfHolding.ts +248 -0
- package/src/models/EtfWeight.ts +150 -0
- package/src/models/Event.ts +3 -2
- package/src/models/EventCalendarCall.ts +2 -1
- 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,105 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.EtfHoldingSourceEnum = void 0;
|
|
17
|
+
exports.instanceOfEtfHolding = instanceOfEtfHolding;
|
|
18
|
+
exports.EtfHoldingFromJSON = EtfHoldingFromJSON;
|
|
19
|
+
exports.EtfHoldingFromJSONTyped = EtfHoldingFromJSONTyped;
|
|
20
|
+
exports.EtfHoldingToJSON = EtfHoldingToJSON;
|
|
21
|
+
exports.EtfHoldingToJSONTyped = EtfHoldingToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.EtfHoldingSourceEnum = {
|
|
26
|
+
IssuerDaily: 'issuer_daily',
|
|
27
|
+
IssuerMonthly: 'issuer_monthly',
|
|
28
|
+
Nport: 'nport'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the EtfHolding interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfEtfHolding(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
|
+
return true;
|
|
41
|
+
}
|
|
42
|
+
function EtfHoldingFromJSON(json) {
|
|
43
|
+
return EtfHoldingFromJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
function EtfHoldingFromJSONTyped(json, ignoreDiscriminator) {
|
|
46
|
+
if (json == null) {
|
|
47
|
+
return json;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'etf_symbol': json['etf_symbol'],
|
|
51
|
+
'etf_name': json['etf_name'] == null ? undefined : json['etf_name'],
|
|
52
|
+
'series_id': json['series_id'] == null ? undefined : json['series_id'],
|
|
53
|
+
'source': json['source'],
|
|
54
|
+
'as_of': (new Date(json['as_of'])),
|
|
55
|
+
'line': json['line'] == null ? undefined : json['line'],
|
|
56
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
57
|
+
'ticker': json['ticker'] == null ? undefined : json['ticker'],
|
|
58
|
+
'cusip': json['cusip'] == null ? undefined : json['cusip'],
|
|
59
|
+
'isin': json['isin'] == null ? undefined : json['isin'],
|
|
60
|
+
'sedol': json['sedol'] == null ? undefined : json['sedol'],
|
|
61
|
+
'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
|
|
62
|
+
'shares': json['shares'] == null ? undefined : json['shares'],
|
|
63
|
+
'market_value_usd': json['market_value_usd'] == null ? undefined : json['market_value_usd'],
|
|
64
|
+
'notional_value_usd': json['notional_value_usd'] == null ? undefined : json['notional_value_usd'],
|
|
65
|
+
'weight_pct': json['weight_pct'] == null ? undefined : json['weight_pct'],
|
|
66
|
+
'sector': json['sector'] == null ? undefined : json['sector'],
|
|
67
|
+
'sector_basis': json['sector_basis'] == null ? undefined : json['sector_basis'],
|
|
68
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
69
|
+
'country_basis': json['country_basis'] == null ? undefined : json['country_basis'],
|
|
70
|
+
'issuer_cik': json['issuer_cik'] == null ? undefined : json['issuer_cik'],
|
|
71
|
+
'issuer_resolution': json['issuer_resolution'] == null ? undefined : json['issuer_resolution'],
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
function EtfHoldingToJSON(json) {
|
|
75
|
+
return EtfHoldingToJSONTyped(json, false);
|
|
76
|
+
}
|
|
77
|
+
function EtfHoldingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
78
|
+
if (value == null) {
|
|
79
|
+
return value;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
'etf_symbol': value['etf_symbol'],
|
|
83
|
+
'etf_name': value['etf_name'],
|
|
84
|
+
'series_id': value['series_id'],
|
|
85
|
+
'source': value['source'],
|
|
86
|
+
'as_of': value['as_of'].toISOString().substring(0, 10),
|
|
87
|
+
'line': value['line'],
|
|
88
|
+
'name': value['name'],
|
|
89
|
+
'ticker': value['ticker'],
|
|
90
|
+
'cusip': value['cusip'],
|
|
91
|
+
'isin': value['isin'],
|
|
92
|
+
'sedol': value['sedol'],
|
|
93
|
+
'asset_class': value['asset_class'],
|
|
94
|
+
'shares': value['shares'],
|
|
95
|
+
'market_value_usd': value['market_value_usd'],
|
|
96
|
+
'notional_value_usd': value['notional_value_usd'],
|
|
97
|
+
'weight_pct': value['weight_pct'],
|
|
98
|
+
'sector': value['sector'],
|
|
99
|
+
'sector_basis': value['sector_basis'],
|
|
100
|
+
'country': value['country'],
|
|
101
|
+
'country_basis': value['country_basis'],
|
|
102
|
+
'issuer_cik': value['issuer_cik'],
|
|
103
|
+
'issuer_resolution': value['issuer_resolution'],
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -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,93 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.EtfWeightDimensionEnum = exports.EtfWeightSourceEnum = void 0;
|
|
17
|
+
exports.instanceOfEtfWeight = instanceOfEtfWeight;
|
|
18
|
+
exports.EtfWeightFromJSON = EtfWeightFromJSON;
|
|
19
|
+
exports.EtfWeightFromJSONTyped = EtfWeightFromJSONTyped;
|
|
20
|
+
exports.EtfWeightToJSON = EtfWeightToJSON;
|
|
21
|
+
exports.EtfWeightToJSONTyped = EtfWeightToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.EtfWeightSourceEnum = {
|
|
26
|
+
IssuerDaily: 'issuer_daily',
|
|
27
|
+
IssuerMonthly: 'issuer_monthly',
|
|
28
|
+
Nport: 'nport'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
exports.EtfWeightDimensionEnum = {
|
|
34
|
+
Sector: 'sector',
|
|
35
|
+
Country: 'country',
|
|
36
|
+
AssetClass: 'asset_class'
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the EtfWeight interface.
|
|
40
|
+
*/
|
|
41
|
+
function instanceOfEtfWeight(value) {
|
|
42
|
+
if (!('etf_symbol' in value) || value['etf_symbol'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('as_of' in value) || value['as_of'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('dimension' in value) || value['dimension'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('bucket' in value) || value['bucket'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
if (!('weight_pct' in value) || value['weight_pct'] === undefined)
|
|
53
|
+
return false;
|
|
54
|
+
if (!('basis' in value) || value['basis'] === undefined)
|
|
55
|
+
return false;
|
|
56
|
+
return true;
|
|
57
|
+
}
|
|
58
|
+
function EtfWeightFromJSON(json) {
|
|
59
|
+
return EtfWeightFromJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
function EtfWeightFromJSONTyped(json, ignoreDiscriminator) {
|
|
62
|
+
if (json == null) {
|
|
63
|
+
return json;
|
|
64
|
+
}
|
|
65
|
+
return {
|
|
66
|
+
'etf_symbol': json['etf_symbol'],
|
|
67
|
+
'source': json['source'],
|
|
68
|
+
'as_of': (new Date(json['as_of'])),
|
|
69
|
+
'dimension': json['dimension'],
|
|
70
|
+
'bucket': json['bucket'],
|
|
71
|
+
'weight_pct': json['weight_pct'],
|
|
72
|
+
'positions': json['positions'] == null ? undefined : json['positions'],
|
|
73
|
+
'basis': json['basis'],
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
function EtfWeightToJSON(json) {
|
|
77
|
+
return EtfWeightToJSONTyped(json, false);
|
|
78
|
+
}
|
|
79
|
+
function EtfWeightToJSONTyped(value, ignoreDiscriminator = false) {
|
|
80
|
+
if (value == null) {
|
|
81
|
+
return value;
|
|
82
|
+
}
|
|
83
|
+
return {
|
|
84
|
+
'etf_symbol': value['etf_symbol'],
|
|
85
|
+
'source': value['source'],
|
|
86
|
+
'as_of': value['as_of'].toISOString().substring(0, 10),
|
|
87
|
+
'dimension': value['dimension'],
|
|
88
|
+
'bucket': value['bucket'],
|
|
89
|
+
'weight_pct': value['weight_pct'],
|
|
90
|
+
'positions': value['positions'],
|
|
91
|
+
'basis': value['basis'],
|
|
92
|
+
};
|
|
93
|
+
}
|
package/dist/models/Event.d.ts
CHANGED
|
@@ -183,7 +183,7 @@ export interface Event {
|
|
|
183
183
|
*/
|
|
184
184
|
has_documents: boolean;
|
|
185
185
|
/**
|
|
186
|
-
* Webcast page of an upcoming dated call; null once published
|
|
186
|
+
* Webcast page of an upcoming dated call; null once published and for a `not_covered` call (`calendar.call.status`)
|
|
187
187
|
* @type {string}
|
|
188
188
|
* @memberof Event
|
|
189
189
|
*/
|
|
@@ -273,6 +273,7 @@ export declare const EventExpiredReasonEnum: {
|
|
|
273
273
|
readonly AgentDifferentDate: "agent_different_date";
|
|
274
274
|
readonly AgentNoWebcast: "agent_no_webcast";
|
|
275
275
|
readonly SupersededByReschedule: "superseded_by_reschedule";
|
|
276
|
+
readonly ResultsWithoutCall: "results_without_call";
|
|
276
277
|
};
|
|
277
278
|
export type EventExpiredReasonEnum = typeof EventExpiredReasonEnum[keyof typeof EventExpiredReasonEnum] | (string & {});
|
|
278
279
|
/**
|
package/dist/models/Event.js
CHANGED
|
@@ -73,7 +73,8 @@ exports.EventExpiredReasonEnum = {
|
|
|
73
73
|
SupersededEstimate: 'superseded_estimate',
|
|
74
74
|
AgentDifferentDate: 'agent_different_date',
|
|
75
75
|
AgentNoWebcast: 'agent_no_webcast',
|
|
76
|
-
SupersededByReschedule: 'superseded_by_reschedule'
|
|
76
|
+
SupersededByReschedule: 'superseded_by_reschedule',
|
|
77
|
+
ResultsWithoutCall: 'results_without_call'
|
|
77
78
|
};
|
|
78
79
|
/**
|
|
79
80
|
* Check if a given object implements the Event interface.
|
|
@@ -17,7 +17,7 @@ import type { EventCalendarCallSource } from './EventCalendarCallSource';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EventCalendarCall {
|
|
19
19
|
/**
|
|
20
|
-
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer)
|
|
20
|
+
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer), not_covered (a reported quarter of a call issuer that our coverage never saw: the call was likely held, we have no record). Clients must accept unknown enum values.
|
|
21
21
|
* @type {EventCalendarCallStatusEnum}
|
|
22
22
|
* @memberof EventCalendarCall
|
|
23
23
|
*/
|
|
@@ -63,6 +63,7 @@ export declare const EventCalendarCallStatusEnum: {
|
|
|
63
63
|
readonly NoCall: "no_call";
|
|
64
64
|
readonly Expired: "expired";
|
|
65
65
|
readonly NotExpected: "not_expected";
|
|
66
|
+
readonly NotCovered: "not_covered";
|
|
66
67
|
readonly Confirmed: "confirmed";
|
|
67
68
|
readonly Announced: "announced";
|
|
68
69
|
readonly Estimated: "estimated";
|
|
@@ -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,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfListEtfHoldings200Response = instanceOfListEtfHoldings200Response;
|
|
17
|
+
exports.ListEtfHoldings200ResponseFromJSON = ListEtfHoldings200ResponseFromJSON;
|
|
18
|
+
exports.ListEtfHoldings200ResponseFromJSONTyped = ListEtfHoldings200ResponseFromJSONTyped;
|
|
19
|
+
exports.ListEtfHoldings200ResponseToJSON = ListEtfHoldings200ResponseToJSON;
|
|
20
|
+
exports.ListEtfHoldings200ResponseToJSONTyped = ListEtfHoldings200ResponseToJSONTyped;
|
|
21
|
+
const EtfHolding_1 = require("./EtfHolding");
|
|
22
|
+
const ListEtfHoldings200ResponseMeta_1 = require("./ListEtfHoldings200ResponseMeta");
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the ListEtfHoldings200Response interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfListEtfHoldings200Response(value) {
|
|
27
|
+
if (!('data' in value) || value['data'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('has_more' in value) || value['has_more'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('next_cursor' in value) || value['next_cursor'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('meta' in value) || value['meta'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function ListEtfHoldings200ResponseFromJSON(json) {
|
|
38
|
+
return ListEtfHoldings200ResponseFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function ListEtfHoldings200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'data': (json['data'].map(EtfHolding_1.EtfHoldingFromJSON)),
|
|
46
|
+
'has_more': json['has_more'],
|
|
47
|
+
'next_cursor': json['next_cursor'],
|
|
48
|
+
'meta': (0, ListEtfHoldings200ResponseMeta_1.ListEtfHoldings200ResponseMetaFromJSON)(json['meta']),
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function ListEtfHoldings200ResponseToJSON(json) {
|
|
52
|
+
return ListEtfHoldings200ResponseToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function ListEtfHoldings200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
55
|
+
if (value == null) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'data': (value['data'].map(EtfHolding_1.EtfHoldingToJSON)),
|
|
60
|
+
'has_more': value['has_more'],
|
|
61
|
+
'next_cursor': value['next_cursor'],
|
|
62
|
+
'meta': (0, ListEtfHoldings200ResponseMeta_1.ListEtfHoldings200ResponseMetaToJSON)(value['meta']),
|
|
63
|
+
};
|
|
64
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { MetaCoverage } from './MetaCoverage';
|
|
13
|
+
import type { ListEtfHoldings200ResponseMetaComposition } from './ListEtfHoldings200ResponseMetaComposition';
|
|
14
|
+
/**
|
|
15
|
+
* Page metadata
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ListEtfHoldings200ResponseMeta
|
|
18
|
+
*/
|
|
19
|
+
export interface ListEtfHoldings200ResponseMeta {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {MetaCoverage}
|
|
23
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
24
|
+
*/
|
|
25
|
+
coverage?: MetaCoverage;
|
|
26
|
+
/**
|
|
27
|
+
* 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)
|
|
28
|
+
* @type {ListEtfHoldings200ResponseMetaSourceEnum}
|
|
29
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
30
|
+
*/
|
|
31
|
+
source?: ListEtfHoldings200ResponseMetaSourceEnum | null;
|
|
32
|
+
/**
|
|
33
|
+
* The date the composition is stated as of (etf=); null with company=
|
|
34
|
+
* @type {Date}
|
|
35
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
36
|
+
*/
|
|
37
|
+
as_of?: Date | null;
|
|
38
|
+
/**
|
|
39
|
+
* 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)
|
|
40
|
+
* @type {ListEtfHoldings200ResponseMetaReasonEnum}
|
|
41
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
42
|
+
*/
|
|
43
|
+
reason?: ListEtfHoldings200ResponseMetaReasonEnum | null;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {ListEtfHoldings200ResponseMetaComposition}
|
|
47
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
48
|
+
*/
|
|
49
|
+
composition?: ListEtfHoldings200ResponseMetaComposition | null;
|
|
50
|
+
/**
|
|
51
|
+
* company=: how many ETFs the store reads an issuer file for (the ETFs this list can name)
|
|
52
|
+
* @type {number}
|
|
53
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
54
|
+
*/
|
|
55
|
+
issuer_sourced_etfs?: number | null;
|
|
56
|
+
/**
|
|
57
|
+
* 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
|
|
58
|
+
* @type {boolean}
|
|
59
|
+
* @memberof ListEtfHoldings200ResponseMeta
|
|
60
|
+
*/
|
|
61
|
+
snapshot_changed?: boolean | null;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @export
|
|
65
|
+
*/
|
|
66
|
+
export declare const ListEtfHoldings200ResponseMetaSourceEnum: {
|
|
67
|
+
readonly IssuerDaily: "issuer_daily";
|
|
68
|
+
readonly IssuerMonthly: "issuer_monthly";
|
|
69
|
+
readonly Nport: "nport";
|
|
70
|
+
};
|
|
71
|
+
export type ListEtfHoldings200ResponseMetaSourceEnum = typeof ListEtfHoldings200ResponseMetaSourceEnum[keyof typeof ListEtfHoldings200ResponseMetaSourceEnum] | (string & {});
|
|
72
|
+
/**
|
|
73
|
+
* @export
|
|
74
|
+
*/
|
|
75
|
+
export declare const ListEtfHoldings200ResponseMetaReasonEnum: {
|
|
76
|
+
readonly SingleAssetTrust: "single_asset_trust";
|
|
77
|
+
readonly SourceStale: "source_stale";
|
|
78
|
+
readonly IssuerSourceUnavailable: "issuer_source_unavailable";
|
|
79
|
+
readonly WeightsUnavailable: "weights_unavailable";
|
|
80
|
+
};
|
|
81
|
+
export type ListEtfHoldings200ResponseMetaReasonEnum = typeof ListEtfHoldings200ResponseMetaReasonEnum[keyof typeof ListEtfHoldings200ResponseMetaReasonEnum] | (string & {});
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the ListEtfHoldings200ResponseMeta interface.
|
|
84
|
+
*/
|
|
85
|
+
export declare function instanceOfListEtfHoldings200ResponseMeta(value: object): value is ListEtfHoldings200ResponseMeta;
|
|
86
|
+
export declare function ListEtfHoldings200ResponseMetaFromJSON(json: any): ListEtfHoldings200ResponseMeta;
|
|
87
|
+
export declare function ListEtfHoldings200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEtfHoldings200ResponseMeta;
|
|
88
|
+
export declare function ListEtfHoldings200ResponseMetaToJSON(json: any): ListEtfHoldings200ResponseMeta;
|
|
89
|
+
export declare function ListEtfHoldings200ResponseMetaToJSONTyped(value?: ListEtfHoldings200ResponseMeta | null, ignoreDiscriminator?: boolean): any;
|