@invinite-org/data-api-client 0.5.0 → 0.6.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 +12 -0
- package/dist/apis/IPOsApi.d.ts +55 -2
- package/dist/apis/IPOsApi.js +95 -3
- package/dist/apis/SECFilingsApi.d.ts +2 -2
- package/dist/apis/SECFilingsApi.js +2 -2
- package/dist/esm/apis/IPOsApi.d.ts +55 -2
- package/dist/esm/apis/IPOsApi.js +94 -2
- package/dist/esm/apis/SECFilingsApi.d.ts +2 -2
- package/dist/esm/apis/SECFilingsApi.js +2 -2
- package/dist/esm/models/IposList200ResponseIposInner.d.ts +7 -0
- package/dist/esm/models/IposList200ResponseIposInner.js +5 -0
- package/dist/esm/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
- package/dist/esm/models/IposList200ResponseIposInnerRegistration.js +67 -0
- package/dist/esm/models/IposRegistrationsList200Response.d.ts +39 -0
- package/dist/esm/models/IposRegistrationsList200Response.js +46 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +149 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +63 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +63 -0
- package/dist/esm/models/ProposedSymbol.d.ts +56 -0
- package/dist/esm/models/ProposedSymbol.js +59 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
- package/dist/esm/models/WebSocketFiling.d.ts +14 -1
- package/dist/esm/models/WebSocketFiling.js +9 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/IposList200ResponseIposInner.d.ts +7 -0
- package/dist/models/IposList200ResponseIposInner.js +5 -0
- package/dist/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
- package/dist/models/IposList200ResponseIposInnerRegistration.js +75 -0
- package/dist/models/IposRegistrationsList200Response.d.ts +39 -0
- package/dist/models/IposRegistrationsList200Response.js +53 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +157 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +70 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +70 -0
- package/dist/models/ProposedSymbol.d.ts +56 -0
- package/dist/models/ProposedSymbol.js +66 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
- package/dist/models/WebSocketFiling.d.ts +14 -1
- package/dist/models/WebSocketFiling.js +9 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/IPOsApi.md +94 -1
- package/docs/IposList200ResponseIposInner.md +2 -0
- package/docs/IposList200ResponseIposInnerRegistration.md +41 -0
- package/docs/IposRegistrationsList200Response.md +36 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +76 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.md +44 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerMassive.md +45 -0
- package/docs/ProposedSymbol.md +43 -0
- package/docs/SECFilingsApi.md +3 -3
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +2 -0
- package/docs/WebSocketFiling.md +5 -0
- package/package.json +1 -1
- package/src/apis/IPOsApi.ts +121 -2
- package/src/apis/SECFilingsApi.ts +2 -2
- package/src/models/IposList200ResponseIposInner.ts +17 -0
- package/src/models/IposList200ResponseIposInnerRegistration.ts +109 -0
- package/src/models/IposRegistrationsList200Response.ts +82 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +302 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.ts +111 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.ts +111 -0
- package/src/models/ProposedSymbol.ts +102 -0
- package/src/models/SecFilingsList200ResponseCompaniesInner.ts +2 -2
- package/src/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.ts +17 -0
- package/src/models/WebSocketFiling.ts +27 -1
- package/src/models/index.ts +6 -0
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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. 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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
20
|
+
*/
|
|
21
|
+
export interface IposRegistrationsList200ResponseRegistrationsInnerFilingsInner {
|
|
22
|
+
/**
|
|
23
|
+
* SEC accession number
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
26
|
+
*/
|
|
27
|
+
accession_number: string;
|
|
28
|
+
/**
|
|
29
|
+
* SEC form type (S-1, S-1/A, F-1, F-1/A, 8-A12B, CERT, EFFECT, 424B4, 424B1, RW)
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
32
|
+
*/
|
|
33
|
+
form_type: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* What the filing meant for the registration: registration, exchange_approval, effective, priced or withdrawn
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
38
|
+
*/
|
|
39
|
+
signal: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* SEC acceptance time (ISO 8601 UTC)
|
|
42
|
+
* @type {Date}
|
|
43
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
44
|
+
*/
|
|
45
|
+
filed_at: Date | null;
|
|
46
|
+
/**
|
|
47
|
+
* Filing date (YYYY-MM-DD); null when the filing is not archived
|
|
48
|
+
* @type {Date}
|
|
49
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
50
|
+
*/
|
|
51
|
+
filing_date: Date | null;
|
|
52
|
+
/**
|
|
53
|
+
* URL to the archived filing HTML; null when the filing is not archived
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
56
|
+
*/
|
|
57
|
+
html_url: string | null;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the IposRegistrationsList200ResponseRegistrationsInnerFilingsInner interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfIposRegistrationsList200ResponseRegistrationsInnerFilingsInner(value: object): value is IposRegistrationsList200ResponseRegistrationsInnerFilingsInner {
|
|
64
|
+
if (!('accession_number' in value) || value['accession_number'] === undefined) return false;
|
|
65
|
+
if (!('form_type' in value) || value['form_type'] === undefined) return false;
|
|
66
|
+
if (!('signal' in value) || value['signal'] === undefined) return false;
|
|
67
|
+
if (!('filed_at' in value) || value['filed_at'] === undefined) return false;
|
|
68
|
+
if (!('filing_date' in value) || value['filing_date'] === undefined) return false;
|
|
69
|
+
if (!('html_url' in value) || value['html_url'] === undefined) return false;
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerFromJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerFilingsInner {
|
|
74
|
+
return IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200ResponseRegistrationsInnerFilingsInner {
|
|
78
|
+
if (json == null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
'accession_number': json['accession_number'],
|
|
84
|
+
'form_type': json['form_type'],
|
|
85
|
+
'signal': json['signal'],
|
|
86
|
+
'filed_at': (json['filed_at'] == null ? null : new Date(json['filed_at'])),
|
|
87
|
+
'filing_date': (json['filing_date'] == null ? null : new Date(json['filing_date'])),
|
|
88
|
+
'html_url': json['html_url'],
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerToJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerFilingsInner {
|
|
93
|
+
return IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerToJSONTyped(json, false);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerToJSONTyped(value?: IposRegistrationsList200ResponseRegistrationsInnerFilingsInner | null, ignoreDiscriminator: boolean = false): any {
|
|
97
|
+
if (value == null) {
|
|
98
|
+
return value;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
return {
|
|
102
|
+
|
|
103
|
+
'accession_number': value['accession_number'],
|
|
104
|
+
'form_type': value['form_type'],
|
|
105
|
+
'signal': value['signal'],
|
|
106
|
+
'filed_at': value['filed_at'] == null ? value['filed_at'] : value['filed_at'].toISOString(),
|
|
107
|
+
'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0,10),
|
|
108
|
+
'html_url': value['html_url'],
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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. 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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* The matching row of the Massive IPO calendar (GET /v1/ipos, by ticker and issuer name); null when none matched. Its values never overwrite the SEC ones
|
|
18
|
+
* @export
|
|
19
|
+
* @interface IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
20
|
+
*/
|
|
21
|
+
export interface IposRegistrationsList200ResponseRegistrationsInnerMassive {
|
|
22
|
+
/**
|
|
23
|
+
* Ticker on the Massive calendar (the `ticker` of GET /v1/ipos)
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
26
|
+
*/
|
|
27
|
+
ticker: string;
|
|
28
|
+
/**
|
|
29
|
+
* Massive IPO status (pending, new, history, withdrawn, …)
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
32
|
+
*/
|
|
33
|
+
ipo_status: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Expected or actual listing day (YYYY-MM-DD)
|
|
36
|
+
* @type {Date}
|
|
37
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
38
|
+
*/
|
|
39
|
+
listing_date: Date | null;
|
|
40
|
+
/**
|
|
41
|
+
* Low end of the Massive price range (decimal string)
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
44
|
+
*/
|
|
45
|
+
price_low: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* High end of the Massive price range (decimal string)
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
50
|
+
*/
|
|
51
|
+
price_high: string | null;
|
|
52
|
+
/**
|
|
53
|
+
* Massive final issue price (decimal string)
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
56
|
+
*/
|
|
57
|
+
final_price: string | null;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the IposRegistrationsList200ResponseRegistrationsInnerMassive interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfIposRegistrationsList200ResponseRegistrationsInnerMassive(value: object): value is IposRegistrationsList200ResponseRegistrationsInnerMassive {
|
|
64
|
+
if (!('ticker' in value) || value['ticker'] === undefined) return false;
|
|
65
|
+
if (!('ipo_status' in value) || value['ipo_status'] === undefined) return false;
|
|
66
|
+
if (!('listing_date' in value) || value['listing_date'] === undefined) return false;
|
|
67
|
+
if (!('price_low' in value) || value['price_low'] === undefined) return false;
|
|
68
|
+
if (!('price_high' in value) || value['price_high'] === undefined) return false;
|
|
69
|
+
if (!('final_price' in value) || value['final_price'] === undefined) return false;
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerMassiveFromJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerMassive {
|
|
74
|
+
return IposRegistrationsList200ResponseRegistrationsInnerMassiveFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerMassiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200ResponseRegistrationsInnerMassive {
|
|
78
|
+
if (json == null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
'ticker': json['ticker'],
|
|
84
|
+
'ipo_status': json['ipo_status'],
|
|
85
|
+
'listing_date': (json['listing_date'] == null ? null : new Date(json['listing_date'])),
|
|
86
|
+
'price_low': json['price_low'],
|
|
87
|
+
'price_high': json['price_high'],
|
|
88
|
+
'final_price': json['final_price'],
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerMassiveToJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerMassive {
|
|
93
|
+
return IposRegistrationsList200ResponseRegistrationsInnerMassiveToJSONTyped(json, false);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function IposRegistrationsList200ResponseRegistrationsInnerMassiveToJSONTyped(value?: IposRegistrationsList200ResponseRegistrationsInnerMassive | null, ignoreDiscriminator: boolean = false): any {
|
|
97
|
+
if (value == null) {
|
|
98
|
+
return value;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
return {
|
|
102
|
+
|
|
103
|
+
'ticker': value['ticker'],
|
|
104
|
+
'ipo_status': value['ipo_status'],
|
|
105
|
+
'listing_date': value['listing_date'] == null ? value['listing_date'] : value['listing_date'].toISOString().substring(0,10),
|
|
106
|
+
'price_low': value['price_low'],
|
|
107
|
+
'price_high': value['price_high'],
|
|
108
|
+
'final_price': value['final_price'],
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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. 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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* A ticker the registration statement says the issuer applied, intends or was approved to list under
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ProposedSymbol
|
|
20
|
+
*/
|
|
21
|
+
export interface ProposedSymbol {
|
|
22
|
+
/**
|
|
23
|
+
* Proposed ticker, upper case (`ABCD.WS` for warrants)
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof ProposedSymbol
|
|
26
|
+
*/
|
|
27
|
+
symbol: string;
|
|
28
|
+
/**
|
|
29
|
+
* NASDAQ, NYSE, NYSE American, NYSE Arca or Cboe BZX; null when the prospectus names none
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof ProposedSymbol
|
|
32
|
+
*/
|
|
33
|
+
exchange: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* common, ads, units, warrants, rights, preferred or other
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ProposedSymbol
|
|
38
|
+
*/
|
|
39
|
+
security_class: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* How it was read: regex or llm
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof ProposedSymbol
|
|
44
|
+
*/
|
|
45
|
+
source: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* The ticker and issuer name are also on the Massive IPO calendar (GET /v1/ipos) — a hint, not an identity
|
|
48
|
+
* @type {boolean}
|
|
49
|
+
* @memberof ProposedSymbol
|
|
50
|
+
*/
|
|
51
|
+
ipo_calendar_match: boolean;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the ProposedSymbol interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfProposedSymbol(value: object): value is ProposedSymbol {
|
|
58
|
+
if (!('symbol' in value) || value['symbol'] === undefined) return false;
|
|
59
|
+
if (!('exchange' in value) || value['exchange'] === undefined) return false;
|
|
60
|
+
if (!('security_class' in value) || value['security_class'] === undefined) return false;
|
|
61
|
+
if (!('source' in value) || value['source'] === undefined) return false;
|
|
62
|
+
if (!('ipo_calendar_match' in value) || value['ipo_calendar_match'] === undefined) return false;
|
|
63
|
+
return true;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function ProposedSymbolFromJSON(json: any): ProposedSymbol {
|
|
67
|
+
return ProposedSymbolFromJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function ProposedSymbolFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProposedSymbol {
|
|
71
|
+
if (json == null) {
|
|
72
|
+
return json;
|
|
73
|
+
}
|
|
74
|
+
return {
|
|
75
|
+
|
|
76
|
+
'symbol': json['symbol'],
|
|
77
|
+
'exchange': json['exchange'],
|
|
78
|
+
'security_class': json['security_class'],
|
|
79
|
+
'source': json['source'],
|
|
80
|
+
'ipo_calendar_match': json['ipo_calendar_match'],
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function ProposedSymbolToJSON(json: any): ProposedSymbol {
|
|
85
|
+
return ProposedSymbolToJSONTyped(json, false);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function ProposedSymbolToJSONTyped(value?: ProposedSymbol | null, ignoreDiscriminator: boolean = false): any {
|
|
89
|
+
if (value == null) {
|
|
90
|
+
return value;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
return {
|
|
94
|
+
|
|
95
|
+
'symbol': value['symbol'],
|
|
96
|
+
'exchange': value['exchange'],
|
|
97
|
+
'security_class': value['security_class'],
|
|
98
|
+
'source': value['source'],
|
|
99
|
+
'ipo_calendar_match': value['ipo_calendar_match'],
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
|
|
@@ -28,11 +28,11 @@ import {
|
|
|
28
28
|
*/
|
|
29
29
|
export interface SecFilingsList200ResponseCompaniesInner {
|
|
30
30
|
/**
|
|
31
|
-
* Ticker symbol
|
|
31
|
+
* Ticker symbol; null for a company that is not listed yet (pre-IPO)
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof SecFilingsList200ResponseCompaniesInner
|
|
34
34
|
*/
|
|
35
|
-
ticker: string;
|
|
35
|
+
ticker: string | null;
|
|
36
36
|
/**
|
|
37
37
|
* CIK (with or without leading zeros)
|
|
38
38
|
* @type {string}
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { ProposedSymbol } from './ProposedSymbol';
|
|
17
|
+
import {
|
|
18
|
+
ProposedSymbolFromJSON,
|
|
19
|
+
ProposedSymbolFromJSONTyped,
|
|
20
|
+
ProposedSymbolToJSON,
|
|
21
|
+
ProposedSymbolToJSONTyped,
|
|
22
|
+
} from './ProposedSymbol';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
*
|
|
18
26
|
* @export
|
|
@@ -79,6 +87,12 @@ export interface SecFilingsList200ResponseCompaniesInnerFilingsInner {
|
|
|
79
87
|
* @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
80
88
|
*/
|
|
81
89
|
period_end: Date | null;
|
|
90
|
+
/**
|
|
91
|
+
* Tickers the registration statement proposes (S-1, S-1/A, F-1, F-1/A only). null = not a registration form (or not read), [] = none found
|
|
92
|
+
* @type {Array<ProposedSymbol>}
|
|
93
|
+
* @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
94
|
+
*/
|
|
95
|
+
proposed_symbols: Array<ProposedSymbol> | null;
|
|
82
96
|
}
|
|
83
97
|
|
|
84
98
|
/**
|
|
@@ -95,6 +109,7 @@ export function instanceOfSecFilingsList200ResponseCompaniesInnerFilingsInner(va
|
|
|
95
109
|
if (!('form_type' in value) || value['form_type'] === undefined) return false;
|
|
96
110
|
if (!('html_url' in value) || value['html_url'] === undefined) return false;
|
|
97
111
|
if (!('period_end' in value) || value['period_end'] === undefined) return false;
|
|
112
|
+
if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined) return false;
|
|
98
113
|
return true;
|
|
99
114
|
}
|
|
100
115
|
|
|
@@ -118,6 +133,7 @@ export function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped
|
|
|
118
133
|
'form_type': json['form_type'],
|
|
119
134
|
'html_url': json['html_url'],
|
|
120
135
|
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
136
|
+
'proposed_symbols': (json['proposed_symbols'] == null ? null : (json['proposed_symbols'] as Array<any>).map(ProposedSymbolFromJSON)),
|
|
121
137
|
};
|
|
122
138
|
}
|
|
123
139
|
|
|
@@ -142,6 +158,7 @@ export function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(v
|
|
|
142
158
|
'form_type': value['form_type'],
|
|
143
159
|
'html_url': value['html_url'],
|
|
144
160
|
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0,10),
|
|
161
|
+
'proposed_symbols': (value['proposed_symbols'] == null ? null : (value['proposed_symbols'] as Array<any>).map(ProposedSymbolToJSON)),
|
|
145
162
|
};
|
|
146
163
|
}
|
|
147
164
|
|
|
@@ -13,8 +13,16 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { ProposedSymbol } from './ProposedSymbol';
|
|
17
|
+
import {
|
|
18
|
+
ProposedSymbolFromJSON,
|
|
19
|
+
ProposedSymbolFromJSONTyped,
|
|
20
|
+
ProposedSymbolToJSON,
|
|
21
|
+
ProposedSymbolToJSONTyped,
|
|
22
|
+
} from './ProposedSymbol';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
|
-
*
|
|
25
|
+
* A new SEC filing, the same fields as a GET /v1/sec-filings/filings row plus `ticker`. Until 2026-10 the frame forwarded the upstream camelCase envelope (`schemaVersion`, `eventKey`, `filing.accessionNumber`, …) instead of this documented shape; it now is exactly this object
|
|
18
26
|
* @export
|
|
19
27
|
* @interface WebSocketFiling
|
|
20
28
|
*/
|
|
@@ -79,6 +87,18 @@ export interface WebSocketFiling {
|
|
|
79
87
|
* @memberof WebSocketFiling
|
|
80
88
|
*/
|
|
81
89
|
period_end: Date | null;
|
|
90
|
+
/**
|
|
91
|
+
* Ticker of the company's primary listing; null for a company that is not listed yet (pre-IPO)
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof WebSocketFiling
|
|
94
|
+
*/
|
|
95
|
+
ticker: string | null;
|
|
96
|
+
/**
|
|
97
|
+
* Tickers a registration statement (S-1, S-1/A, F-1, F-1/A) proposes; null when the filing carries none
|
|
98
|
+
* @type {Array<ProposedSymbol>}
|
|
99
|
+
* @memberof WebSocketFiling
|
|
100
|
+
*/
|
|
101
|
+
proposed_symbols: Array<ProposedSymbol> | null;
|
|
82
102
|
}
|
|
83
103
|
|
|
84
104
|
/**
|
|
@@ -95,6 +115,8 @@ export function instanceOfWebSocketFiling(value: object): value is WebSocketFili
|
|
|
95
115
|
if (!('form_type' in value) || value['form_type'] === undefined) return false;
|
|
96
116
|
if (!('html_url' in value) || value['html_url'] === undefined) return false;
|
|
97
117
|
if (!('period_end' in value) || value['period_end'] === undefined) return false;
|
|
118
|
+
if (!('ticker' in value) || value['ticker'] === undefined) return false;
|
|
119
|
+
if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined) return false;
|
|
98
120
|
return true;
|
|
99
121
|
}
|
|
100
122
|
|
|
@@ -118,6 +140,8 @@ export function WebSocketFilingFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
118
140
|
'form_type': json['form_type'],
|
|
119
141
|
'html_url': json['html_url'],
|
|
120
142
|
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
143
|
+
'ticker': json['ticker'],
|
|
144
|
+
'proposed_symbols': (json['proposed_symbols'] == null ? null : (json['proposed_symbols'] as Array<any>).map(ProposedSymbolFromJSON)),
|
|
121
145
|
};
|
|
122
146
|
}
|
|
123
147
|
|
|
@@ -142,6 +166,8 @@ export function WebSocketFilingToJSONTyped(value?: WebSocketFiling | null, ignor
|
|
|
142
166
|
'form_type': value['form_type'],
|
|
143
167
|
'html_url': value['html_url'],
|
|
144
168
|
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0,10),
|
|
169
|
+
'ticker': value['ticker'],
|
|
170
|
+
'proposed_symbols': (value['proposed_symbols'] == null ? null : (value['proposed_symbols'] as Array<any>).map(ProposedSymbolToJSON)),
|
|
145
171
|
};
|
|
146
172
|
}
|
|
147
173
|
|
package/src/models/index.ts
CHANGED
|
@@ -142,6 +142,11 @@ export * from './InstitutionalOwnershipTransactions200ResponseTransactionsInner'
|
|
|
142
142
|
export * from './InternalServerError';
|
|
143
143
|
export * from './IposList200Response';
|
|
144
144
|
export * from './IposList200ResponseIposInner';
|
|
145
|
+
export * from './IposList200ResponseIposInnerRegistration';
|
|
146
|
+
export * from './IposRegistrationsList200Response';
|
|
147
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInner';
|
|
148
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
|
|
149
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
|
|
145
150
|
export * from './MarketHolidays200Response';
|
|
146
151
|
export * from './MarketHolidays200ResponseHolidaysInner';
|
|
147
152
|
export * from './MatchSpan';
|
|
@@ -152,6 +157,7 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
|
|
|
152
157
|
export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
|
|
153
158
|
export * from './NotFoundError';
|
|
154
159
|
export * from './PresentationFact';
|
|
160
|
+
export * from './ProposedSymbol';
|
|
155
161
|
export * from './SearchCoverage';
|
|
156
162
|
export * from './SearchCoverageLeg';
|
|
157
163
|
export * from './SecFilingsAvailableFormTypes200Response';
|