@invinite-org/data-api-client 5.6.0 → 5.7.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 +26 -0
- package/dist/apis/HoldingsApi.d.ts +33 -0
- package/dist/apis/HoldingsApi.js +79 -1
- package/dist/apis/IPOsApi.d.ts +54 -0
- package/dist/apis/IPOsApi.js +137 -1
- package/dist/apis/InsiderTradesApi.d.ts +3 -0
- package/dist/apis/InsiderTradesApi.js +9 -0
- package/dist/esm/apis/HoldingsApi.d.ts +33 -0
- package/dist/esm/apis/HoldingsApi.js +78 -0
- package/dist/esm/apis/IPOsApi.d.ts +54 -0
- package/dist/esm/apis/IPOsApi.js +136 -0
- package/dist/esm/apis/InsiderTradesApi.d.ts +3 -0
- package/dist/esm/apis/InsiderTradesApi.js +9 -0
- package/dist/esm/models/Company.d.ts +1 -1
- package/dist/esm/models/Filer.d.ts +6 -0
- package/dist/esm/models/Filer.js +2 -0
- package/dist/esm/models/FilerDetail.d.ts +14 -0
- package/dist/esm/models/FilerDetail.js +6 -0
- package/dist/esm/models/FilerFund.d.ts +45 -0
- package/dist/esm/models/FilerFund.js +52 -0
- package/dist/esm/models/FilerFundAdviser.d.ts +56 -0
- package/dist/esm/models/FilerFundAdviser.js +59 -0
- package/dist/esm/models/FilerFundReturn.d.ts +62 -0
- package/dist/esm/models/FilerFundReturn.js +63 -0
- package/dist/esm/models/FilerFundSeries.d.ts +217 -0
- package/dist/esm/models/FilerFundSeries.js +169 -0
- package/dist/esm/models/FilerFundShareClass.d.ts +44 -0
- package/dist/esm/models/FilerFundShareClass.js +51 -0
- package/dist/esm/models/FilerPrivateOfferings.d.ts +62 -0
- package/dist/esm/models/FilerPrivateOfferings.js +63 -0
- package/dist/esm/models/FundHolding.d.ts +140 -0
- package/dist/esm/models/FundHolding.js +83 -0
- package/dist/esm/models/InsiderTrade.d.ts +101 -0
- package/dist/esm/models/InsiderTrade.js +71 -0
- package/dist/esm/models/InsiderTradeFootnote.d.ts +38 -0
- package/dist/esm/models/InsiderTradeFootnote.js +47 -0
- package/dist/esm/models/ListFundHoldings200Response.d.ts +52 -0
- package/dist/esm/models/ListFundHoldings200Response.js +57 -0
- package/dist/esm/models/ListOfferings200Response.d.ts +52 -0
- package/dist/esm/models/ListOfferings200Response.js +57 -0
- package/dist/esm/models/ListOfferings200ResponseMeta.d.ts +39 -0
- package/dist/esm/models/ListOfferings200ResponseMeta.js +44 -0
- package/dist/esm/models/Offering.d.ts +275 -0
- package/dist/esm/models/Offering.js +209 -0
- package/dist/esm/models/OfferingRelatedPerson.d.ts +44 -0
- package/dist/esm/models/OfferingRelatedPerson.js +51 -0
- package/dist/esm/models/index.d.ts +13 -0
- package/dist/esm/models/index.js +13 -0
- package/dist/models/Company.d.ts +1 -1
- package/dist/models/Filer.d.ts +6 -0
- package/dist/models/Filer.js +2 -0
- package/dist/models/FilerDetail.d.ts +14 -0
- package/dist/models/FilerDetail.js +6 -0
- package/dist/models/FilerFund.d.ts +45 -0
- package/dist/models/FilerFund.js +59 -0
- package/dist/models/FilerFundAdviser.d.ts +56 -0
- package/dist/models/FilerFundAdviser.js +66 -0
- package/dist/models/FilerFundReturn.d.ts +62 -0
- package/dist/models/FilerFundReturn.js +70 -0
- package/dist/models/FilerFundSeries.d.ts +217 -0
- package/dist/models/FilerFundSeries.js +177 -0
- package/dist/models/FilerFundShareClass.d.ts +44 -0
- package/dist/models/FilerFundShareClass.js +58 -0
- package/dist/models/FilerPrivateOfferings.d.ts +62 -0
- package/dist/models/FilerPrivateOfferings.js +70 -0
- package/dist/models/FundHolding.d.ts +140 -0
- package/dist/models/FundHolding.js +90 -0
- package/dist/models/InsiderTrade.d.ts +101 -0
- package/dist/models/InsiderTrade.js +72 -1
- package/dist/models/InsiderTradeFootnote.d.ts +38 -0
- package/dist/models/InsiderTradeFootnote.js +54 -0
- package/dist/models/ListFundHoldings200Response.d.ts +52 -0
- package/dist/models/ListFundHoldings200Response.js +64 -0
- package/dist/models/ListOfferings200Response.d.ts +52 -0
- package/dist/models/ListOfferings200Response.js +64 -0
- package/dist/models/ListOfferings200ResponseMeta.d.ts +39 -0
- package/dist/models/ListOfferings200ResponseMeta.js +51 -0
- package/dist/models/Offering.d.ts +275 -0
- package/dist/models/Offering.js +217 -0
- package/dist/models/OfferingRelatedPerson.d.ts +44 -0
- package/dist/models/OfferingRelatedPerson.js +58 -0
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/docs/CompaniesApi.md +2 -2
- package/docs/Filer.md +2 -0
- package/docs/FilerDetail.md +4 -0
- package/docs/FilerFund.md +39 -0
- package/docs/FilerFundAdviser.md +43 -0
- package/docs/FilerFundReturn.md +45 -0
- package/docs/FilerFundSeries.md +93 -0
- package/docs/FilerFundShareClass.md +39 -0
- package/docs/FilerPrivateOfferings.md +45 -0
- package/docs/FundHolding.md +70 -0
- package/docs/HoldingsApi.md +105 -0
- package/docs/IPOsApi.md +195 -0
- package/docs/InsiderTrade.md +28 -0
- package/docs/InsiderTradeFootnote.md +37 -0
- package/docs/InsiderTradesApi.md +10 -1
- package/docs/ListFundHoldings200Response.md +41 -0
- package/docs/ListOfferings200Response.md +41 -0
- package/docs/ListOfferings200ResponseMeta.md +37 -0
- package/docs/Offering.md +111 -0
- package/docs/OfferingRelatedPerson.md +39 -0
- package/package.json +1 -1
- package/src/apis/HoldingsApi.ts +107 -0
- package/src/apis/IPOsApi.ts +186 -0
- package/src/apis/InsiderTradesApi.ts +15 -0
- package/src/models/Company.ts +1 -1
- package/src/models/Filer.ts +8 -0
- package/src/models/FilerDetail.ts +30 -0
- package/src/models/FilerFund.ts +92 -0
- package/src/models/FilerFundAdviser.ts +102 -0
- package/src/models/FilerFundReturn.ts +111 -0
- package/src/models/FilerFundSeries.ts +360 -0
- package/src/models/FilerFundShareClass.ts +84 -0
- package/src/models/FilerPrivateOfferings.ts +111 -0
- package/src/models/FundHolding.ts +212 -0
- package/src/models/InsiderTrade.ts +152 -0
- package/src/models/InsiderTradeFootnote.ts +75 -0
- package/src/models/ListFundHoldings200Response.ts +108 -0
- package/src/models/ListOfferings200Response.ts +108 -0
- package/src/models/ListOfferings200ResponseMeta.ts +81 -0
- package/src/models/Offering.ts +433 -0
- package/src/models/OfferingRelatedPerson.ts +84 -0
- package/src/models/index.ts +13 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { OfferingRelatedPersonFromJSON, OfferingRelatedPersonToJSON, } from './OfferingRelatedPerson';
|
|
15
|
+
/**
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const OfferingSecurityTypesEnum = {
|
|
19
|
+
Equity: 'equity',
|
|
20
|
+
Debt: 'debt',
|
|
21
|
+
OptionToAcquire: 'option_to_acquire',
|
|
22
|
+
SecurityToBeAcquired: 'security_to_be_acquired',
|
|
23
|
+
PooledInvestmentFund: 'pooled_investment_fund',
|
|
24
|
+
TenantInCommon: 'tenant_in_common',
|
|
25
|
+
MineralProperty: 'mineral_property',
|
|
26
|
+
Other: 'other'
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Check if a given object implements the Offering interface.
|
|
30
|
+
*/
|
|
31
|
+
export function instanceOfOffering(value) {
|
|
32
|
+
if (!('offering_id' in value) || value['offering_id'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('file_number' in value) || value['file_number'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('first_accession' in value) || value['first_accession'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('latest_accession' in value) || value['latest_accession'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('accessions' in value) || value['accessions'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('primary_issuer_cik' in value) || value['primary_issuer_cik'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('issuer_name' in value) || value['issuer_name'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('co_issuer_ciks' in value) || value['co_issuer_ciks'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('filed_first' in value) || value['filed_first'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('filed_latest' in value) || value['filed_latest'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
if (!('sale_date' in value) || value['sale_date'] === undefined)
|
|
53
|
+
return false;
|
|
54
|
+
if (!('first_sale_yet_to_occur' in value) || value['first_sale_yet_to_occur'] === undefined)
|
|
55
|
+
return false;
|
|
56
|
+
if (!('amendment_count' in value) || value['amendment_count'] === undefined)
|
|
57
|
+
return false;
|
|
58
|
+
if (!('original_held' in value) || value['original_held'] === undefined)
|
|
59
|
+
return false;
|
|
60
|
+
if (!('is_amendment' in value) || value['is_amendment'] === undefined)
|
|
61
|
+
return false;
|
|
62
|
+
if (!('exemptions' in value) || value['exemptions'] === undefined)
|
|
63
|
+
return false;
|
|
64
|
+
if (!('industry_group' in value) || value['industry_group'] === undefined)
|
|
65
|
+
return false;
|
|
66
|
+
if (!('investment_fund_type' in value) || value['investment_fund_type'] === undefined)
|
|
67
|
+
return false;
|
|
68
|
+
if (!('is_40_act' in value) || value['is_40_act'] === undefined)
|
|
69
|
+
return false;
|
|
70
|
+
if (!('security_types' in value) || value['security_types'] === undefined)
|
|
71
|
+
return false;
|
|
72
|
+
if (!('is_business_combination' in value) || value['is_business_combination'] === undefined)
|
|
73
|
+
return false;
|
|
74
|
+
if (!('more_than_one_year' in value) || value['more_than_one_year'] === undefined)
|
|
75
|
+
return false;
|
|
76
|
+
if (!('min_investment' in value) || value['min_investment'] === undefined)
|
|
77
|
+
return false;
|
|
78
|
+
if (!('total_offering_amount' in value) || value['total_offering_amount'] === undefined)
|
|
79
|
+
return false;
|
|
80
|
+
if (!('total_sold' in value) || value['total_sold'] === undefined)
|
|
81
|
+
return false;
|
|
82
|
+
if (!('total_remaining' in value) || value['total_remaining'] === undefined)
|
|
83
|
+
return false;
|
|
84
|
+
if (!('indefinite_amount' in value) || value['indefinite_amount'] === undefined)
|
|
85
|
+
return false;
|
|
86
|
+
if (!('has_non_accredited' in value) || value['has_non_accredited'] === undefined)
|
|
87
|
+
return false;
|
|
88
|
+
if (!('non_accredited_count' in value) || value['non_accredited_count'] === undefined)
|
|
89
|
+
return false;
|
|
90
|
+
if (!('investor_count' in value) || value['investor_count'] === undefined)
|
|
91
|
+
return false;
|
|
92
|
+
if (!('revenue_range' in value) || value['revenue_range'] === undefined)
|
|
93
|
+
return false;
|
|
94
|
+
if (!('net_asset_value_range' in value) || value['net_asset_value_range'] === undefined)
|
|
95
|
+
return false;
|
|
96
|
+
if (!('sales_commission' in value) || value['sales_commission'] === undefined)
|
|
97
|
+
return false;
|
|
98
|
+
if (!('finders_fee' in value) || value['finders_fee'] === undefined)
|
|
99
|
+
return false;
|
|
100
|
+
if (!('related_persons' in value) || value['related_persons'] === undefined)
|
|
101
|
+
return false;
|
|
102
|
+
if (!('sic_code' in value) || value['sic_code'] === undefined)
|
|
103
|
+
return false;
|
|
104
|
+
if (!('jurisdiction' in value) || value['jurisdiction'] === undefined)
|
|
105
|
+
return false;
|
|
106
|
+
if (!('entity_type' in value) || value['entity_type'] === undefined)
|
|
107
|
+
return false;
|
|
108
|
+
if (!('year_of_inc' in value) || value['year_of_inc'] === undefined)
|
|
109
|
+
return false;
|
|
110
|
+
return true;
|
|
111
|
+
}
|
|
112
|
+
export function OfferingFromJSON(json) {
|
|
113
|
+
return OfferingFromJSONTyped(json, false);
|
|
114
|
+
}
|
|
115
|
+
export function OfferingFromJSONTyped(json, ignoreDiscriminator) {
|
|
116
|
+
if (json == null) {
|
|
117
|
+
return json;
|
|
118
|
+
}
|
|
119
|
+
return {
|
|
120
|
+
'offering_id': json['offering_id'],
|
|
121
|
+
'file_number': json['file_number'],
|
|
122
|
+
'first_accession': json['first_accession'],
|
|
123
|
+
'latest_accession': json['latest_accession'],
|
|
124
|
+
'accessions': json['accessions'],
|
|
125
|
+
'primary_issuer_cik': json['primary_issuer_cik'],
|
|
126
|
+
'issuer_name': json['issuer_name'],
|
|
127
|
+
'co_issuer_ciks': json['co_issuer_ciks'],
|
|
128
|
+
'filed_first': (json['filed_first'] == null ? null : new Date(json['filed_first'])),
|
|
129
|
+
'filed_latest': (json['filed_latest'] == null ? null : new Date(json['filed_latest'])),
|
|
130
|
+
'sale_date': (json['sale_date'] == null ? null : new Date(json['sale_date'])),
|
|
131
|
+
'first_sale_yet_to_occur': json['first_sale_yet_to_occur'],
|
|
132
|
+
'amendment_count': json['amendment_count'],
|
|
133
|
+
'original_held': json['original_held'],
|
|
134
|
+
'is_amendment': json['is_amendment'],
|
|
135
|
+
'exemptions': json['exemptions'],
|
|
136
|
+
'industry_group': json['industry_group'],
|
|
137
|
+
'investment_fund_type': json['investment_fund_type'],
|
|
138
|
+
'is_40_act': json['is_40_act'],
|
|
139
|
+
'security_types': json['security_types'],
|
|
140
|
+
'is_business_combination': json['is_business_combination'],
|
|
141
|
+
'more_than_one_year': json['more_than_one_year'],
|
|
142
|
+
'min_investment': json['min_investment'],
|
|
143
|
+
'total_offering_amount': json['total_offering_amount'],
|
|
144
|
+
'total_sold': json['total_sold'],
|
|
145
|
+
'total_remaining': json['total_remaining'],
|
|
146
|
+
'indefinite_amount': json['indefinite_amount'],
|
|
147
|
+
'has_non_accredited': json['has_non_accredited'],
|
|
148
|
+
'non_accredited_count': json['non_accredited_count'],
|
|
149
|
+
'investor_count': json['investor_count'],
|
|
150
|
+
'revenue_range': json['revenue_range'],
|
|
151
|
+
'net_asset_value_range': json['net_asset_value_range'],
|
|
152
|
+
'sales_commission': json['sales_commission'],
|
|
153
|
+
'finders_fee': json['finders_fee'],
|
|
154
|
+
'related_persons': (json['related_persons'].map(OfferingRelatedPersonFromJSON)),
|
|
155
|
+
'sic_code': json['sic_code'],
|
|
156
|
+
'jurisdiction': json['jurisdiction'],
|
|
157
|
+
'entity_type': json['entity_type'],
|
|
158
|
+
'year_of_inc': json['year_of_inc'],
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
export function OfferingToJSON(json) {
|
|
162
|
+
return OfferingToJSONTyped(json, false);
|
|
163
|
+
}
|
|
164
|
+
export function OfferingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
165
|
+
if (value == null) {
|
|
166
|
+
return value;
|
|
167
|
+
}
|
|
168
|
+
return {
|
|
169
|
+
'offering_id': value['offering_id'],
|
|
170
|
+
'file_number': value['file_number'],
|
|
171
|
+
'first_accession': value['first_accession'],
|
|
172
|
+
'latest_accession': value['latest_accession'],
|
|
173
|
+
'accessions': value['accessions'],
|
|
174
|
+
'primary_issuer_cik': value['primary_issuer_cik'],
|
|
175
|
+
'issuer_name': value['issuer_name'],
|
|
176
|
+
'co_issuer_ciks': value['co_issuer_ciks'],
|
|
177
|
+
'filed_first': value['filed_first'] == null ? value['filed_first'] : value['filed_first'].toISOString().substring(0, 10),
|
|
178
|
+
'filed_latest': value['filed_latest'] == null ? value['filed_latest'] : value['filed_latest'].toISOString().substring(0, 10),
|
|
179
|
+
'sale_date': value['sale_date'] == null ? value['sale_date'] : value['sale_date'].toISOString().substring(0, 10),
|
|
180
|
+
'first_sale_yet_to_occur': value['first_sale_yet_to_occur'],
|
|
181
|
+
'amendment_count': value['amendment_count'],
|
|
182
|
+
'original_held': value['original_held'],
|
|
183
|
+
'is_amendment': value['is_amendment'],
|
|
184
|
+
'exemptions': value['exemptions'],
|
|
185
|
+
'industry_group': value['industry_group'],
|
|
186
|
+
'investment_fund_type': value['investment_fund_type'],
|
|
187
|
+
'is_40_act': value['is_40_act'],
|
|
188
|
+
'security_types': value['security_types'],
|
|
189
|
+
'is_business_combination': value['is_business_combination'],
|
|
190
|
+
'more_than_one_year': value['more_than_one_year'],
|
|
191
|
+
'min_investment': value['min_investment'],
|
|
192
|
+
'total_offering_amount': value['total_offering_amount'],
|
|
193
|
+
'total_sold': value['total_sold'],
|
|
194
|
+
'total_remaining': value['total_remaining'],
|
|
195
|
+
'indefinite_amount': value['indefinite_amount'],
|
|
196
|
+
'has_non_accredited': value['has_non_accredited'],
|
|
197
|
+
'non_accredited_count': value['non_accredited_count'],
|
|
198
|
+
'investor_count': value['investor_count'],
|
|
199
|
+
'revenue_range': value['revenue_range'],
|
|
200
|
+
'net_asset_value_range': value['net_asset_value_range'],
|
|
201
|
+
'sales_commission': value['sales_commission'],
|
|
202
|
+
'finders_fee': value['finders_fee'],
|
|
203
|
+
'related_persons': (value['related_persons'].map(OfferingRelatedPersonToJSON)),
|
|
204
|
+
'sic_code': value['sic_code'],
|
|
205
|
+
'jurisdiction': value['jurisdiction'],
|
|
206
|
+
'entity_type': value['entity_type'],
|
|
207
|
+
'year_of_inc': value['year_of_inc'],
|
|
208
|
+
};
|
|
209
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
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
|
+
* A related person of a Form D offering (executive officer, director, promoter) as filed
|
|
14
|
+
* @export
|
|
15
|
+
* @interface OfferingRelatedPerson
|
|
16
|
+
*/
|
|
17
|
+
export interface OfferingRelatedPerson {
|
|
18
|
+
/**
|
|
19
|
+
* Name as filed (first, middle, last)
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof OfferingRelatedPerson
|
|
22
|
+
*/
|
|
23
|
+
name: string;
|
|
24
|
+
/**
|
|
25
|
+
* Relationships as filed: Executive Officer, Director, Promoter
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof OfferingRelatedPerson
|
|
28
|
+
*/
|
|
29
|
+
relationships: Array<string>;
|
|
30
|
+
/**
|
|
31
|
+
* Clarification of the relationship as filed
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof OfferingRelatedPerson
|
|
34
|
+
*/
|
|
35
|
+
clarification: string | null;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the OfferingRelatedPerson interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfOfferingRelatedPerson(value: object): value is OfferingRelatedPerson;
|
|
41
|
+
export declare function OfferingRelatedPersonFromJSON(json: any): OfferingRelatedPerson;
|
|
42
|
+
export declare function OfferingRelatedPersonFromJSONTyped(json: any, ignoreDiscriminator: boolean): OfferingRelatedPerson;
|
|
43
|
+
export declare function OfferingRelatedPersonToJSON(json: any): OfferingRelatedPerson;
|
|
44
|
+
export declare function OfferingRelatedPersonToJSONTyped(value?: OfferingRelatedPerson | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the OfferingRelatedPerson interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfOfferingRelatedPerson(value) {
|
|
18
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('relationships' in value) || value['relationships'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('clarification' in value) || value['clarification'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
export function OfferingRelatedPersonFromJSON(json) {
|
|
27
|
+
return OfferingRelatedPersonFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
export function OfferingRelatedPersonFromJSONTyped(json, ignoreDiscriminator) {
|
|
30
|
+
if (json == null) {
|
|
31
|
+
return json;
|
|
32
|
+
}
|
|
33
|
+
return {
|
|
34
|
+
'name': json['name'],
|
|
35
|
+
'relationships': json['relationships'],
|
|
36
|
+
'clarification': json['clarification'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export function OfferingRelatedPersonToJSON(json) {
|
|
40
|
+
return OfferingRelatedPersonToJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
export function OfferingRelatedPersonToJSONTyped(value, ignoreDiscriminator = false) {
|
|
43
|
+
if (value == null) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'name': value['name'],
|
|
48
|
+
'relationships': value['relationships'],
|
|
49
|
+
'clarification': value['clarification'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -55,7 +55,13 @@ export * from './Filer';
|
|
|
55
55
|
export * from './FilerDetail';
|
|
56
56
|
export * from './FilerDetailFormerNamesInner';
|
|
57
57
|
export * from './FilerDetailSuccessorsInner';
|
|
58
|
+
export * from './FilerFund';
|
|
59
|
+
export * from './FilerFundAdviser';
|
|
60
|
+
export * from './FilerFundReturn';
|
|
61
|
+
export * from './FilerFundSeries';
|
|
62
|
+
export * from './FilerFundShareClass';
|
|
58
63
|
export * from './FilerListing';
|
|
64
|
+
export * from './FilerPrivateOfferings';
|
|
59
65
|
export * from './Filing';
|
|
60
66
|
export * from './FilingDetail';
|
|
61
67
|
export * from './FilingDocument';
|
|
@@ -69,6 +75,7 @@ export * from './FilingSource';
|
|
|
69
75
|
export * from './FiscalPeriod';
|
|
70
76
|
export * from './FormCatalogEntry';
|
|
71
77
|
export * from './FormulaMember';
|
|
78
|
+
export * from './FundHolding';
|
|
72
79
|
export * from './GetAsReportedFinancials200Response';
|
|
73
80
|
export * from './GetAsReportedFinancialsDetailed200Response';
|
|
74
81
|
export * from './GetAsReportedFinancialsPresentation200Response';
|
|
@@ -85,6 +92,7 @@ export * from './HitMatch';
|
|
|
85
92
|
export * from './Holding';
|
|
86
93
|
export * from './HoldingChange';
|
|
87
94
|
export * from './InsiderTrade';
|
|
95
|
+
export * from './InsiderTradeFootnote';
|
|
88
96
|
export * from './InvestorDocument';
|
|
89
97
|
export * from './InvestorDocumentSearchHit';
|
|
90
98
|
export * from './Ipo';
|
|
@@ -115,6 +123,7 @@ export * from './ListFilings200ResponseMeta';
|
|
|
115
123
|
export * from './ListFilings200ResponseMetaFormFacetInner';
|
|
116
124
|
export * from './ListFiscalPeriods200Response';
|
|
117
125
|
export * from './ListFormCatalog200Response';
|
|
126
|
+
export * from './ListFundHoldings200Response';
|
|
118
127
|
export * from './ListGrowth200Response';
|
|
119
128
|
export * from './ListGuidance200Response';
|
|
120
129
|
export * from './ListHoldingChanges200Response';
|
|
@@ -128,6 +137,8 @@ export * from './ListMappingRules200Response';
|
|
|
128
137
|
export * from './ListMarketHolidays200Response';
|
|
129
138
|
export * from './ListMetricCatalog200Response';
|
|
130
139
|
export * from './ListNews200Response';
|
|
140
|
+
export * from './ListOfferings200Response';
|
|
141
|
+
export * from './ListOfferings200ResponseMeta';
|
|
131
142
|
export * from './ListParticipants200Response';
|
|
132
143
|
export * from './ListPeople200Response';
|
|
133
144
|
export * from './ListQa200Response';
|
|
@@ -164,6 +175,8 @@ export * from './NewsSearchHitItem';
|
|
|
164
175
|
export * from './NewsText';
|
|
165
176
|
export * from './NewsTextBlocksInner';
|
|
166
177
|
export * from './NewsTextCoverage';
|
|
178
|
+
export * from './Offering';
|
|
179
|
+
export * from './OfferingRelatedPerson';
|
|
167
180
|
export * from './Participation';
|
|
168
181
|
export * from './ParticipationEvidenceInner';
|
|
169
182
|
export * from './PdfDocument';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -57,7 +57,13 @@ export * from './Filer';
|
|
|
57
57
|
export * from './FilerDetail';
|
|
58
58
|
export * from './FilerDetailFormerNamesInner';
|
|
59
59
|
export * from './FilerDetailSuccessorsInner';
|
|
60
|
+
export * from './FilerFund';
|
|
61
|
+
export * from './FilerFundAdviser';
|
|
62
|
+
export * from './FilerFundReturn';
|
|
63
|
+
export * from './FilerFundSeries';
|
|
64
|
+
export * from './FilerFundShareClass';
|
|
60
65
|
export * from './FilerListing';
|
|
66
|
+
export * from './FilerPrivateOfferings';
|
|
61
67
|
export * from './Filing';
|
|
62
68
|
export * from './FilingDetail';
|
|
63
69
|
export * from './FilingDocument';
|
|
@@ -71,6 +77,7 @@ export * from './FilingSource';
|
|
|
71
77
|
export * from './FiscalPeriod';
|
|
72
78
|
export * from './FormCatalogEntry';
|
|
73
79
|
export * from './FormulaMember';
|
|
80
|
+
export * from './FundHolding';
|
|
74
81
|
export * from './GetAsReportedFinancials200Response';
|
|
75
82
|
export * from './GetAsReportedFinancialsDetailed200Response';
|
|
76
83
|
export * from './GetAsReportedFinancialsPresentation200Response';
|
|
@@ -87,6 +94,7 @@ export * from './HitMatch';
|
|
|
87
94
|
export * from './Holding';
|
|
88
95
|
export * from './HoldingChange';
|
|
89
96
|
export * from './InsiderTrade';
|
|
97
|
+
export * from './InsiderTradeFootnote';
|
|
90
98
|
export * from './InvestorDocument';
|
|
91
99
|
export * from './InvestorDocumentSearchHit';
|
|
92
100
|
export * from './Ipo';
|
|
@@ -117,6 +125,7 @@ export * from './ListFilings200ResponseMeta';
|
|
|
117
125
|
export * from './ListFilings200ResponseMetaFormFacetInner';
|
|
118
126
|
export * from './ListFiscalPeriods200Response';
|
|
119
127
|
export * from './ListFormCatalog200Response';
|
|
128
|
+
export * from './ListFundHoldings200Response';
|
|
120
129
|
export * from './ListGrowth200Response';
|
|
121
130
|
export * from './ListGuidance200Response';
|
|
122
131
|
export * from './ListHoldingChanges200Response';
|
|
@@ -130,6 +139,8 @@ export * from './ListMappingRules200Response';
|
|
|
130
139
|
export * from './ListMarketHolidays200Response';
|
|
131
140
|
export * from './ListMetricCatalog200Response';
|
|
132
141
|
export * from './ListNews200Response';
|
|
142
|
+
export * from './ListOfferings200Response';
|
|
143
|
+
export * from './ListOfferings200ResponseMeta';
|
|
133
144
|
export * from './ListParticipants200Response';
|
|
134
145
|
export * from './ListPeople200Response';
|
|
135
146
|
export * from './ListQa200Response';
|
|
@@ -166,6 +177,8 @@ export * from './NewsSearchHitItem';
|
|
|
166
177
|
export * from './NewsText';
|
|
167
178
|
export * from './NewsTextBlocksInner';
|
|
168
179
|
export * from './NewsTextCoverage';
|
|
180
|
+
export * from './Offering';
|
|
181
|
+
export * from './OfferingRelatedPerson';
|
|
169
182
|
export * from './Participation';
|
|
170
183
|
export * from './ParticipationEvidenceInner';
|
|
171
184
|
export * from './PdfDocument';
|
package/dist/models/Company.d.ts
CHANGED
|
@@ -119,7 +119,7 @@ export interface Company {
|
|
|
119
119
|
*/
|
|
120
120
|
employees: number | null;
|
|
121
121
|
/**
|
|
122
|
-
* Market capitalization;
|
|
122
|
+
* Market capitalization; for an ETF: fund net assets from its latest public N-PORT report (single-class funds only), else null
|
|
123
123
|
* @type {number}
|
|
124
124
|
* @memberof Company
|
|
125
125
|
*/
|
package/dist/models/Filer.d.ts
CHANGED
|
@@ -64,6 +64,12 @@ export interface Filer {
|
|
|
64
64
|
* @memberof Filer
|
|
65
65
|
*/
|
|
66
66
|
listing: FilerListing | null;
|
|
67
|
+
/**
|
|
68
|
+
* Number of Form D private offerings naming the filer (`phase=pre_ipo` lists); null on other lists and while Form D data is not served (optional: answers captured before release 5.7 lack it)
|
|
69
|
+
* @type {number}
|
|
70
|
+
* @memberof Filer
|
|
71
|
+
*/
|
|
72
|
+
private_offerings_count?: number | null;
|
|
67
73
|
}
|
|
68
74
|
/**
|
|
69
75
|
* @export
|
package/dist/models/Filer.js
CHANGED
|
@@ -68,6 +68,7 @@ function FilerFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
68
68
|
'forms': json['forms'],
|
|
69
69
|
'stated_tickers': json['stated_tickers'],
|
|
70
70
|
'listing': (0, FilerListing_1.FilerListingFromJSON)(json['listing']),
|
|
71
|
+
'private_offerings_count': json['private_offerings_count'] == null ? undefined : json['private_offerings_count'],
|
|
71
72
|
};
|
|
72
73
|
}
|
|
73
74
|
function FilerToJSON(json) {
|
|
@@ -86,5 +87,6 @@ function FilerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
86
87
|
'forms': value['forms'],
|
|
87
88
|
'stated_tickers': value['stated_tickers'],
|
|
88
89
|
'listing': (0, FilerListing_1.FilerListingToJSON)(value['listing']),
|
|
90
|
+
'private_offerings_count': value['private_offerings_count'],
|
|
89
91
|
};
|
|
90
92
|
}
|
|
@@ -13,6 +13,8 @@ import type { FilerDetailSuccessorsInner } from './FilerDetailSuccessorsInner';
|
|
|
13
13
|
import type { ProposedTicker } from './ProposedTicker';
|
|
14
14
|
import type { FilerDetailFormerNamesInner } from './FilerDetailFormerNamesInner';
|
|
15
15
|
import type { FilerListing } from './FilerListing';
|
|
16
|
+
import type { FilerPrivateOfferings } from './FilerPrivateOfferings';
|
|
17
|
+
import type { FilerFund } from './FilerFund';
|
|
16
18
|
/**
|
|
17
19
|
* One SEC filer's registry identity
|
|
18
20
|
* @export
|
|
@@ -93,6 +95,18 @@ export interface FilerDetail {
|
|
|
93
95
|
* @memberof FilerDetail
|
|
94
96
|
*/
|
|
95
97
|
successors?: Array<FilerDetailSuccessorsInner> | null;
|
|
98
|
+
/**
|
|
99
|
+
* With `expand=fund`: the registered investment company's fund series (SEC N-CEN census, risk/return prospectus data, N-PORT net assets); null for a filer without fund series and while fund data is not served
|
|
100
|
+
* @type {FilerFund}
|
|
101
|
+
* @memberof FilerDetail
|
|
102
|
+
*/
|
|
103
|
+
fund?: FilerFund | null;
|
|
104
|
+
/**
|
|
105
|
+
* With `expand=private_offerings`: summary of the filer's Form D private offerings (GET /v1/offerings?company=); null for a filer without Form D offerings and while Form D data is not served. Only for filers the SEC registry knows
|
|
106
|
+
* @type {FilerPrivateOfferings}
|
|
107
|
+
* @memberof FilerDetail
|
|
108
|
+
*/
|
|
109
|
+
private_offerings?: FilerPrivateOfferings | null;
|
|
96
110
|
}
|
|
97
111
|
/**
|
|
98
112
|
* @export
|
|
@@ -23,6 +23,8 @@ const FilerDetailSuccessorsInner_1 = require("./FilerDetailSuccessorsInner");
|
|
|
23
23
|
const ProposedTicker_1 = require("./ProposedTicker");
|
|
24
24
|
const FilerDetailFormerNamesInner_1 = require("./FilerDetailFormerNamesInner");
|
|
25
25
|
const FilerListing_1 = require("./FilerListing");
|
|
26
|
+
const FilerPrivateOfferings_1 = require("./FilerPrivateOfferings");
|
|
27
|
+
const FilerFund_1 = require("./FilerFund");
|
|
26
28
|
/**
|
|
27
29
|
* @export
|
|
28
30
|
*/
|
|
@@ -75,6 +77,8 @@ function FilerDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
75
77
|
'proposed_symbols': json['proposed_symbols'] == null ? undefined : (json['proposed_symbols'].map(ProposedTicker_1.ProposedTickerFromJSON)),
|
|
76
78
|
'former_names': json['former_names'] == null ? undefined : (json['former_names'].map(FilerDetailFormerNamesInner_1.FilerDetailFormerNamesInnerFromJSON)),
|
|
77
79
|
'successors': json['successors'] == null ? undefined : (json['successors'].map(FilerDetailSuccessorsInner_1.FilerDetailSuccessorsInnerFromJSON)),
|
|
80
|
+
'fund': json['fund'] == null ? undefined : (0, FilerFund_1.FilerFundFromJSON)(json['fund']),
|
|
81
|
+
'private_offerings': json['private_offerings'] == null ? undefined : (0, FilerPrivateOfferings_1.FilerPrivateOfferingsFromJSON)(json['private_offerings']),
|
|
78
82
|
};
|
|
79
83
|
}
|
|
80
84
|
function FilerDetailToJSON(json) {
|
|
@@ -97,5 +101,7 @@ function FilerDetailToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
97
101
|
'proposed_symbols': value['proposed_symbols'] == null ? undefined : (value['proposed_symbols'].map(ProposedTicker_1.ProposedTickerToJSON)),
|
|
98
102
|
'former_names': value['former_names'] == null ? undefined : (value['former_names'].map(FilerDetailFormerNamesInner_1.FilerDetailFormerNamesInnerToJSON)),
|
|
99
103
|
'successors': value['successors'] == null ? undefined : (value['successors'].map(FilerDetailSuccessorsInner_1.FilerDetailSuccessorsInnerToJSON)),
|
|
104
|
+
'fund': (0, FilerFund_1.FilerFundToJSON)(value['fund']),
|
|
105
|
+
'private_offerings': (0, FilerPrivateOfferings_1.FilerPrivateOfferingsToJSON)(value['private_offerings']),
|
|
100
106
|
};
|
|
101
107
|
}
|
|
@@ -0,0 +1,45 @@
|
|
|
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 { FilerFundSeries } from './FilerFundSeries';
|
|
13
|
+
/**
|
|
14
|
+
* A registered investment company's fund series (SEC N-CEN, risk/return prospectus data, N-PORT)
|
|
15
|
+
* @export
|
|
16
|
+
* @interface FilerFund
|
|
17
|
+
*/
|
|
18
|
+
export interface FilerFund {
|
|
19
|
+
/**
|
|
20
|
+
* Registration form of the investment company: N-1A (open-end fund, ETF) or N-2 (closed-end fund); null when mixed or unknown
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof FilerFund
|
|
23
|
+
*/
|
|
24
|
+
investment_company_type: string | null;
|
|
25
|
+
/**
|
|
26
|
+
* Number of fund series
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof FilerFund
|
|
29
|
+
*/
|
|
30
|
+
series_count: number;
|
|
31
|
+
/**
|
|
32
|
+
* The fund series
|
|
33
|
+
* @type {Array<FilerFundSeries>}
|
|
34
|
+
* @memberof FilerFund
|
|
35
|
+
*/
|
|
36
|
+
series: Array<FilerFundSeries>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the FilerFund interface.
|
|
40
|
+
*/
|
|
41
|
+
export declare function instanceOfFilerFund(value: object): value is FilerFund;
|
|
42
|
+
export declare function FilerFundFromJSON(json: any): FilerFund;
|
|
43
|
+
export declare function FilerFundFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilerFund;
|
|
44
|
+
export declare function FilerFundToJSON(json: any): FilerFund;
|
|
45
|
+
export declare function FilerFundToJSONTyped(value?: FilerFund | null, ignoreDiscriminator?: boolean): any;
|