@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.
Files changed (125) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/dist/apis/HoldingsApi.d.ts +33 -0
  3. package/dist/apis/HoldingsApi.js +79 -1
  4. package/dist/apis/IPOsApi.d.ts +54 -0
  5. package/dist/apis/IPOsApi.js +137 -1
  6. package/dist/apis/InsiderTradesApi.d.ts +3 -0
  7. package/dist/apis/InsiderTradesApi.js +9 -0
  8. package/dist/esm/apis/HoldingsApi.d.ts +33 -0
  9. package/dist/esm/apis/HoldingsApi.js +78 -0
  10. package/dist/esm/apis/IPOsApi.d.ts +54 -0
  11. package/dist/esm/apis/IPOsApi.js +136 -0
  12. package/dist/esm/apis/InsiderTradesApi.d.ts +3 -0
  13. package/dist/esm/apis/InsiderTradesApi.js +9 -0
  14. package/dist/esm/models/Company.d.ts +1 -1
  15. package/dist/esm/models/Filer.d.ts +6 -0
  16. package/dist/esm/models/Filer.js +2 -0
  17. package/dist/esm/models/FilerDetail.d.ts +14 -0
  18. package/dist/esm/models/FilerDetail.js +6 -0
  19. package/dist/esm/models/FilerFund.d.ts +45 -0
  20. package/dist/esm/models/FilerFund.js +52 -0
  21. package/dist/esm/models/FilerFundAdviser.d.ts +56 -0
  22. package/dist/esm/models/FilerFundAdviser.js +59 -0
  23. package/dist/esm/models/FilerFundReturn.d.ts +62 -0
  24. package/dist/esm/models/FilerFundReturn.js +63 -0
  25. package/dist/esm/models/FilerFundSeries.d.ts +217 -0
  26. package/dist/esm/models/FilerFundSeries.js +169 -0
  27. package/dist/esm/models/FilerFundShareClass.d.ts +44 -0
  28. package/dist/esm/models/FilerFundShareClass.js +51 -0
  29. package/dist/esm/models/FilerPrivateOfferings.d.ts +62 -0
  30. package/dist/esm/models/FilerPrivateOfferings.js +63 -0
  31. package/dist/esm/models/FundHolding.d.ts +140 -0
  32. package/dist/esm/models/FundHolding.js +83 -0
  33. package/dist/esm/models/InsiderTrade.d.ts +101 -0
  34. package/dist/esm/models/InsiderTrade.js +71 -0
  35. package/dist/esm/models/InsiderTradeFootnote.d.ts +38 -0
  36. package/dist/esm/models/InsiderTradeFootnote.js +47 -0
  37. package/dist/esm/models/ListFundHoldings200Response.d.ts +52 -0
  38. package/dist/esm/models/ListFundHoldings200Response.js +57 -0
  39. package/dist/esm/models/ListOfferings200Response.d.ts +52 -0
  40. package/dist/esm/models/ListOfferings200Response.js +57 -0
  41. package/dist/esm/models/ListOfferings200ResponseMeta.d.ts +39 -0
  42. package/dist/esm/models/ListOfferings200ResponseMeta.js +44 -0
  43. package/dist/esm/models/Offering.d.ts +275 -0
  44. package/dist/esm/models/Offering.js +209 -0
  45. package/dist/esm/models/OfferingRelatedPerson.d.ts +44 -0
  46. package/dist/esm/models/OfferingRelatedPerson.js +51 -0
  47. package/dist/esm/models/index.d.ts +13 -0
  48. package/dist/esm/models/index.js +13 -0
  49. package/dist/models/Company.d.ts +1 -1
  50. package/dist/models/Filer.d.ts +6 -0
  51. package/dist/models/Filer.js +2 -0
  52. package/dist/models/FilerDetail.d.ts +14 -0
  53. package/dist/models/FilerDetail.js +6 -0
  54. package/dist/models/FilerFund.d.ts +45 -0
  55. package/dist/models/FilerFund.js +59 -0
  56. package/dist/models/FilerFundAdviser.d.ts +56 -0
  57. package/dist/models/FilerFundAdviser.js +66 -0
  58. package/dist/models/FilerFundReturn.d.ts +62 -0
  59. package/dist/models/FilerFundReturn.js +70 -0
  60. package/dist/models/FilerFundSeries.d.ts +217 -0
  61. package/dist/models/FilerFundSeries.js +177 -0
  62. package/dist/models/FilerFundShareClass.d.ts +44 -0
  63. package/dist/models/FilerFundShareClass.js +58 -0
  64. package/dist/models/FilerPrivateOfferings.d.ts +62 -0
  65. package/dist/models/FilerPrivateOfferings.js +70 -0
  66. package/dist/models/FundHolding.d.ts +140 -0
  67. package/dist/models/FundHolding.js +90 -0
  68. package/dist/models/InsiderTrade.d.ts +101 -0
  69. package/dist/models/InsiderTrade.js +72 -1
  70. package/dist/models/InsiderTradeFootnote.d.ts +38 -0
  71. package/dist/models/InsiderTradeFootnote.js +54 -0
  72. package/dist/models/ListFundHoldings200Response.d.ts +52 -0
  73. package/dist/models/ListFundHoldings200Response.js +64 -0
  74. package/dist/models/ListOfferings200Response.d.ts +52 -0
  75. package/dist/models/ListOfferings200Response.js +64 -0
  76. package/dist/models/ListOfferings200ResponseMeta.d.ts +39 -0
  77. package/dist/models/ListOfferings200ResponseMeta.js +51 -0
  78. package/dist/models/Offering.d.ts +275 -0
  79. package/dist/models/Offering.js +217 -0
  80. package/dist/models/OfferingRelatedPerson.d.ts +44 -0
  81. package/dist/models/OfferingRelatedPerson.js +58 -0
  82. package/dist/models/index.d.ts +13 -0
  83. package/dist/models/index.js +13 -0
  84. package/docs/CompaniesApi.md +2 -2
  85. package/docs/Filer.md +2 -0
  86. package/docs/FilerDetail.md +4 -0
  87. package/docs/FilerFund.md +39 -0
  88. package/docs/FilerFundAdviser.md +43 -0
  89. package/docs/FilerFundReturn.md +45 -0
  90. package/docs/FilerFundSeries.md +93 -0
  91. package/docs/FilerFundShareClass.md +39 -0
  92. package/docs/FilerPrivateOfferings.md +45 -0
  93. package/docs/FundHolding.md +70 -0
  94. package/docs/HoldingsApi.md +105 -0
  95. package/docs/IPOsApi.md +195 -0
  96. package/docs/InsiderTrade.md +28 -0
  97. package/docs/InsiderTradeFootnote.md +37 -0
  98. package/docs/InsiderTradesApi.md +10 -1
  99. package/docs/ListFundHoldings200Response.md +41 -0
  100. package/docs/ListOfferings200Response.md +41 -0
  101. package/docs/ListOfferings200ResponseMeta.md +37 -0
  102. package/docs/Offering.md +111 -0
  103. package/docs/OfferingRelatedPerson.md +39 -0
  104. package/package.json +1 -1
  105. package/src/apis/HoldingsApi.ts +107 -0
  106. package/src/apis/IPOsApi.ts +186 -0
  107. package/src/apis/InsiderTradesApi.ts +15 -0
  108. package/src/models/Company.ts +1 -1
  109. package/src/models/Filer.ts +8 -0
  110. package/src/models/FilerDetail.ts +30 -0
  111. package/src/models/FilerFund.ts +92 -0
  112. package/src/models/FilerFundAdviser.ts +102 -0
  113. package/src/models/FilerFundReturn.ts +111 -0
  114. package/src/models/FilerFundSeries.ts +360 -0
  115. package/src/models/FilerFundShareClass.ts +84 -0
  116. package/src/models/FilerPrivateOfferings.ts +111 -0
  117. package/src/models/FundHolding.ts +212 -0
  118. package/src/models/InsiderTrade.ts +152 -0
  119. package/src/models/InsiderTradeFootnote.ts +75 -0
  120. package/src/models/ListFundHoldings200Response.ts +108 -0
  121. package/src/models/ListOfferings200Response.ts +108 -0
  122. package/src/models/ListOfferings200ResponseMeta.ts +81 -0
  123. package/src/models/Offering.ts +433 -0
  124. package/src/models/OfferingRelatedPerson.ts +84 -0
  125. package/src/models/index.ts +13 -0
@@ -0,0 +1,169 @@
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 { FilerFundReturnFromJSON, FilerFundReturnToJSON, } from './FilerFundReturn';
15
+ import { FilerFundAdviserFromJSON, FilerFundAdviserToJSON, } from './FilerFundAdviser';
16
+ import { FilerFundShareClassFromJSON, FilerFundShareClassToJSON, } from './FilerFundShareClass';
17
+ /**
18
+ * @export
19
+ */
20
+ export const FilerFundSeriesNetAssetsScopeEnum = {
21
+ Fund: 'fund',
22
+ Series: 'series'
23
+ };
24
+ /**
25
+ * Check if a given object implements the FilerFundSeries interface.
26
+ */
27
+ export function instanceOfFilerFundSeries(value) {
28
+ if (!('fund_key' in value) || value['fund_key'] === undefined)
29
+ return false;
30
+ if (!('series_id' in value) || value['series_id'] === undefined)
31
+ return false;
32
+ if (!('series_name' in value) || value['series_name'] === undefined)
33
+ return false;
34
+ if (!('registrant_cik' in value) || value['registrant_cik'] === undefined)
35
+ return false;
36
+ if (!('is_etf' in value) || value['is_etf'] === undefined)
37
+ return false;
38
+ if (!('is_index' in value) || value['is_index'] === undefined)
39
+ return false;
40
+ if (!('is_fund_of_funds' in value) || value['is_fund_of_funds'] === undefined)
41
+ return false;
42
+ if (!('is_money_market' in value) || value['is_money_market'] === undefined)
43
+ return false;
44
+ if (!('is_target_date' in value) || value['is_target_date'] === undefined)
45
+ return false;
46
+ if (!('exchange' in value) || value['exchange'] === undefined)
47
+ return false;
48
+ if (!('share_classes' in value) || value['share_classes'] === undefined)
49
+ return false;
50
+ if (!('advisers' in value) || value['advisers'] === undefined)
51
+ return false;
52
+ if (!('expense_ratio_net' in value) || value['expense_ratio_net'] === undefined)
53
+ return false;
54
+ if (!('expense_ratio_gross' in value) || value['expense_ratio_gross'] === undefined)
55
+ return false;
56
+ if (!('expense_ratio_as_of' in value) || value['expense_ratio_as_of'] === undefined)
57
+ return false;
58
+ if (!('expense_ratio_class_id' in value) || value['expense_ratio_class_id'] === undefined)
59
+ return false;
60
+ if (!('returns' in value) || value['returns'] === undefined)
61
+ return false;
62
+ if (!('creation_unit_shares' in value) || value['creation_unit_shares'] === undefined)
63
+ return false;
64
+ if (!('redeemed_creation_unit_shares' in value) || value['redeemed_creation_unit_shares'] === undefined)
65
+ return false;
66
+ if (!('creation_cash_pct_avg' in value) || value['creation_cash_pct_avg'] === undefined)
67
+ return false;
68
+ if (!('authorized_participant_count' in value) || value['authorized_participant_count'] === undefined)
69
+ return false;
70
+ if (!('net_assets_usd' in value) || value['net_assets_usd'] === undefined)
71
+ return false;
72
+ if (!('net_assets_as_of' in value) || value['net_assets_as_of'] === undefined)
73
+ return false;
74
+ if (!('net_assets_scope' in value) || value['net_assets_scope'] === undefined)
75
+ return false;
76
+ if (!('latest_report_date' in value) || value['latest_report_date'] === undefined)
77
+ return false;
78
+ if (!('ncen_report_period' in value) || value['ncen_report_period'] === undefined)
79
+ return false;
80
+ if (!('rr_report_period' in value) || value['rr_report_period'] === undefined)
81
+ return false;
82
+ if (!('ncen_accession_number' in value) || value['ncen_accession_number'] === undefined)
83
+ return false;
84
+ if (!('rr_accession_number' in value) || value['rr_accession_number'] === undefined)
85
+ return false;
86
+ if (!('nport_accession_number' in value) || value['nport_accession_number'] === undefined)
87
+ return false;
88
+ return true;
89
+ }
90
+ export function FilerFundSeriesFromJSON(json) {
91
+ return FilerFundSeriesFromJSONTyped(json, false);
92
+ }
93
+ export function FilerFundSeriesFromJSONTyped(json, ignoreDiscriminator) {
94
+ if (json == null) {
95
+ return json;
96
+ }
97
+ return {
98
+ 'fund_key': json['fund_key'],
99
+ 'series_id': json['series_id'],
100
+ 'series_name': json['series_name'],
101
+ 'registrant_cik': json['registrant_cik'],
102
+ 'is_etf': json['is_etf'],
103
+ 'is_index': json['is_index'],
104
+ 'is_fund_of_funds': json['is_fund_of_funds'],
105
+ 'is_money_market': json['is_money_market'],
106
+ 'is_target_date': json['is_target_date'],
107
+ 'exchange': json['exchange'],
108
+ 'share_classes': (json['share_classes'].map(FilerFundShareClassFromJSON)),
109
+ 'advisers': (json['advisers'].map(FilerFundAdviserFromJSON)),
110
+ 'expense_ratio_net': json['expense_ratio_net'],
111
+ 'expense_ratio_gross': json['expense_ratio_gross'],
112
+ 'expense_ratio_as_of': (json['expense_ratio_as_of'] == null ? null : new Date(json['expense_ratio_as_of'])),
113
+ 'expense_ratio_class_id': json['expense_ratio_class_id'],
114
+ 'returns': (json['returns'].map(FilerFundReturnFromJSON)),
115
+ 'creation_unit_shares': json['creation_unit_shares'],
116
+ 'redeemed_creation_unit_shares': json['redeemed_creation_unit_shares'],
117
+ 'creation_cash_pct_avg': json['creation_cash_pct_avg'],
118
+ 'authorized_participant_count': json['authorized_participant_count'],
119
+ 'net_assets_usd': json['net_assets_usd'],
120
+ 'net_assets_as_of': (json['net_assets_as_of'] == null ? null : new Date(json['net_assets_as_of'])),
121
+ 'net_assets_scope': json['net_assets_scope'],
122
+ 'latest_report_date': (json['latest_report_date'] == null ? null : new Date(json['latest_report_date'])),
123
+ 'ncen_report_period': (json['ncen_report_period'] == null ? null : new Date(json['ncen_report_period'])),
124
+ 'rr_report_period': (json['rr_report_period'] == null ? null : new Date(json['rr_report_period'])),
125
+ 'ncen_accession_number': json['ncen_accession_number'],
126
+ 'rr_accession_number': json['rr_accession_number'],
127
+ 'nport_accession_number': json['nport_accession_number'],
128
+ };
129
+ }
130
+ export function FilerFundSeriesToJSON(json) {
131
+ return FilerFundSeriesToJSONTyped(json, false);
132
+ }
133
+ export function FilerFundSeriesToJSONTyped(value, ignoreDiscriminator = false) {
134
+ if (value == null) {
135
+ return value;
136
+ }
137
+ return {
138
+ 'fund_key': value['fund_key'],
139
+ 'series_id': value['series_id'],
140
+ 'series_name': value['series_name'],
141
+ 'registrant_cik': value['registrant_cik'],
142
+ 'is_etf': value['is_etf'],
143
+ 'is_index': value['is_index'],
144
+ 'is_fund_of_funds': value['is_fund_of_funds'],
145
+ 'is_money_market': value['is_money_market'],
146
+ 'is_target_date': value['is_target_date'],
147
+ 'exchange': value['exchange'],
148
+ 'share_classes': (value['share_classes'].map(FilerFundShareClassToJSON)),
149
+ 'advisers': (value['advisers'].map(FilerFundAdviserToJSON)),
150
+ 'expense_ratio_net': value['expense_ratio_net'],
151
+ 'expense_ratio_gross': value['expense_ratio_gross'],
152
+ 'expense_ratio_as_of': value['expense_ratio_as_of'] == null ? value['expense_ratio_as_of'] : value['expense_ratio_as_of'].toISOString().substring(0, 10),
153
+ 'expense_ratio_class_id': value['expense_ratio_class_id'],
154
+ 'returns': (value['returns'].map(FilerFundReturnToJSON)),
155
+ 'creation_unit_shares': value['creation_unit_shares'],
156
+ 'redeemed_creation_unit_shares': value['redeemed_creation_unit_shares'],
157
+ 'creation_cash_pct_avg': value['creation_cash_pct_avg'],
158
+ 'authorized_participant_count': value['authorized_participant_count'],
159
+ 'net_assets_usd': value['net_assets_usd'],
160
+ 'net_assets_as_of': value['net_assets_as_of'] == null ? value['net_assets_as_of'] : value['net_assets_as_of'].toISOString().substring(0, 10),
161
+ 'net_assets_scope': value['net_assets_scope'],
162
+ 'latest_report_date': value['latest_report_date'] == null ? value['latest_report_date'] : value['latest_report_date'].toISOString().substring(0, 10),
163
+ 'ncen_report_period': value['ncen_report_period'] == null ? value['ncen_report_period'] : value['ncen_report_period'].toISOString().substring(0, 10),
164
+ 'rr_report_period': value['rr_report_period'] == null ? value['rr_report_period'] : value['rr_report_period'].toISOString().substring(0, 10),
165
+ 'ncen_accession_number': value['ncen_accession_number'],
166
+ 'rr_accession_number': value['rr_accession_number'],
167
+ 'nport_accession_number': value['nport_accession_number'],
168
+ };
169
+ }
@@ -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
+ * One share class of a fund series
14
+ * @export
15
+ * @interface FilerFundShareClass
16
+ */
17
+ export interface FilerFundShareClass {
18
+ /**
19
+ * SEC class id (C + 9 digits)
20
+ * @type {string}
21
+ * @memberof FilerFundShareClass
22
+ */
23
+ class_id: string;
24
+ /**
25
+ * Ticker of the class as the filer stated it
26
+ * @type {string}
27
+ * @memberof FilerFundShareClass
28
+ */
29
+ ticker: string | null;
30
+ /**
31
+ * Class name as reported
32
+ * @type {string}
33
+ * @memberof FilerFundShareClass
34
+ */
35
+ class_name: string | null;
36
+ }
37
+ /**
38
+ * Check if a given object implements the FilerFundShareClass interface.
39
+ */
40
+ export declare function instanceOfFilerFundShareClass(value: object): value is FilerFundShareClass;
41
+ export declare function FilerFundShareClassFromJSON(json: any): FilerFundShareClass;
42
+ export declare function FilerFundShareClassFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilerFundShareClass;
43
+ export declare function FilerFundShareClassToJSON(json: any): FilerFundShareClass;
44
+ export declare function FilerFundShareClassToJSONTyped(value?: FilerFundShareClass | 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 FilerFundShareClass interface.
16
+ */
17
+ export function instanceOfFilerFundShareClass(value) {
18
+ if (!('class_id' in value) || value['class_id'] === undefined)
19
+ return false;
20
+ if (!('ticker' in value) || value['ticker'] === undefined)
21
+ return false;
22
+ if (!('class_name' in value) || value['class_name'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function FilerFundShareClassFromJSON(json) {
27
+ return FilerFundShareClassFromJSONTyped(json, false);
28
+ }
29
+ export function FilerFundShareClassFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'class_id': json['class_id'],
35
+ 'ticker': json['ticker'],
36
+ 'class_name': json['class_name'],
37
+ };
38
+ }
39
+ export function FilerFundShareClassToJSON(json) {
40
+ return FilerFundShareClassToJSONTyped(json, false);
41
+ }
42
+ export function FilerFundShareClassToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'class_id': value['class_id'],
48
+ 'ticker': value['ticker'],
49
+ 'class_name': value['class_name'],
50
+ };
51
+ }
@@ -0,0 +1,62 @@
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
+ * Summary of the Form D offerings naming the filer (primary issuer or co-issuer)
14
+ * @export
15
+ * @interface FilerPrivateOfferings
16
+ */
17
+ export interface FilerPrivateOfferings {
18
+ /**
19
+ * Number of offerings
20
+ * @type {number}
21
+ * @memberof FilerPrivateOfferings
22
+ */
23
+ count: number;
24
+ /**
25
+ * Earliest filing date over the offerings
26
+ * @type {Date}
27
+ * @memberof FilerPrivateOfferings
28
+ */
29
+ first_filed: Date | null;
30
+ /**
31
+ * Latest filing date over the offerings
32
+ * @type {Date}
33
+ * @memberof FilerPrivateOfferings
34
+ */
35
+ latest_filed: Date | null;
36
+ /**
37
+ * Sum of the amounts sold the offerings state (USD); null when none states one
38
+ * @type {number}
39
+ * @memberof FilerPrivateOfferings
40
+ */
41
+ total_sold: number | null;
42
+ /**
43
+ * Exemptions claimed by the latest offering, as filed
44
+ * @type {Array<string>}
45
+ * @memberof FilerPrivateOfferings
46
+ */
47
+ latest_exemptions: Array<string>;
48
+ /**
49
+ * Offering id of the latest offering (GET /v1/offerings/{offering_id})
50
+ * @type {string}
51
+ * @memberof FilerPrivateOfferings
52
+ */
53
+ latest_offering_id: string | null;
54
+ }
55
+ /**
56
+ * Check if a given object implements the FilerPrivateOfferings interface.
57
+ */
58
+ export declare function instanceOfFilerPrivateOfferings(value: object): value is FilerPrivateOfferings;
59
+ export declare function FilerPrivateOfferingsFromJSON(json: any): FilerPrivateOfferings;
60
+ export declare function FilerPrivateOfferingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilerPrivateOfferings;
61
+ export declare function FilerPrivateOfferingsToJSON(json: any): FilerPrivateOfferings;
62
+ export declare function FilerPrivateOfferingsToJSONTyped(value?: FilerPrivateOfferings | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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 FilerPrivateOfferings interface.
16
+ */
17
+ export function instanceOfFilerPrivateOfferings(value) {
18
+ if (!('count' in value) || value['count'] === undefined)
19
+ return false;
20
+ if (!('first_filed' in value) || value['first_filed'] === undefined)
21
+ return false;
22
+ if (!('latest_filed' in value) || value['latest_filed'] === undefined)
23
+ return false;
24
+ if (!('total_sold' in value) || value['total_sold'] === undefined)
25
+ return false;
26
+ if (!('latest_exemptions' in value) || value['latest_exemptions'] === undefined)
27
+ return false;
28
+ if (!('latest_offering_id' in value) || value['latest_offering_id'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function FilerPrivateOfferingsFromJSON(json) {
33
+ return FilerPrivateOfferingsFromJSONTyped(json, false);
34
+ }
35
+ export function FilerPrivateOfferingsFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'count': json['count'],
41
+ 'first_filed': (json['first_filed'] == null ? null : new Date(json['first_filed'])),
42
+ 'latest_filed': (json['latest_filed'] == null ? null : new Date(json['latest_filed'])),
43
+ 'total_sold': json['total_sold'],
44
+ 'latest_exemptions': json['latest_exemptions'],
45
+ 'latest_offering_id': json['latest_offering_id'],
46
+ };
47
+ }
48
+ export function FilerPrivateOfferingsToJSON(json) {
49
+ return FilerPrivateOfferingsToJSONTyped(json, false);
50
+ }
51
+ export function FilerPrivateOfferingsToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'count': value['count'],
57
+ 'first_filed': value['first_filed'] == null ? value['first_filed'] : value['first_filed'].toISOString().substring(0, 10),
58
+ 'latest_filed': value['latest_filed'] == null ? value['latest_filed'] : value['latest_filed'].toISOString().substring(0, 10),
59
+ 'total_sold': value['total_sold'],
60
+ 'latest_exemptions': value['latest_exemptions'],
61
+ 'latest_offering_id': value['latest_offering_id'],
62
+ };
63
+ }
@@ -0,0 +1,140 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface FundHolding
16
+ */
17
+ export interface FundHolding {
18
+ /**
19
+ * The fund: its SEC series id, or cik:<registrant CIK> for a unit investment trust that files without a series
20
+ * @type {string}
21
+ * @memberof FundHolding
22
+ */
23
+ fund_key: string;
24
+ /**
25
+ * SEC series id (S + 9 digits); null for a fund without a series
26
+ * @type {string}
27
+ * @memberof FundHolding
28
+ */
29
+ series_id?: string | null;
30
+ /**
31
+ * Fund (series) name as reported
32
+ * @type {string}
33
+ * @memberof FundHolding
34
+ */
35
+ series_name?: string | null;
36
+ /**
37
+ * Registrant (trust) CIK, 10 digits
38
+ * @type {string}
39
+ * @memberof FundHolding
40
+ */
41
+ registrant_cik?: string | null;
42
+ /**
43
+ * Registrant (trust) name as reported
44
+ * @type {string}
45
+ * @memberof FundHolding
46
+ */
47
+ registrant_name?: string | null;
48
+ /**
49
+ * Tickers of the fund's share classes (SEC Series and Class list; a unit trust's own SEC-stated tickers)
50
+ * @type {Array<string>}
51
+ * @memberof FundHolding
52
+ */
53
+ class_tickers: Array<string>;
54
+ /**
55
+ * Date the holdings are reported as of (YYYY-MM-DD)
56
+ * @type {Date}
57
+ * @memberof FundHolding
58
+ */
59
+ report_date?: Date | null;
60
+ /**
61
+ * NPORT-P accession number of the report
62
+ * @type {string}
63
+ * @memberof FundHolding
64
+ */
65
+ accession_number: string;
66
+ /**
67
+ * Issuer CIK of the holding, 10 digits; null when it did not resolve (or on accession= rows, as filed)
68
+ * @type {string}
69
+ * @memberof FundHolding
70
+ */
71
+ issuer_cik?: string | null;
72
+ /**
73
+ * Issuer name
74
+ * @type {string}
75
+ * @memberof FundHolding
76
+ */
77
+ issuer_name?: string | null;
78
+ /**
79
+ * Holding CUSIP; null on company= rows (a fund's positions in the issuer summed)
80
+ * @type {string}
81
+ * @memberof FundHolding
82
+ */
83
+ cusip?: string | null;
84
+ /**
85
+ * Holding ISIN; null on company= rows
86
+ * @type {string}
87
+ * @memberof FundHolding
88
+ */
89
+ isin?: string | null;
90
+ /**
91
+ * Holding ticker (company= rows: the requested company's ticker; else as the fund stated it)
92
+ * @type {string}
93
+ * @memberof FundHolding
94
+ */
95
+ ticker?: string | null;
96
+ /**
97
+ * Value in USD as the fund reported it; null when none was stated
98
+ * @type {number}
99
+ * @memberof FundHolding
100
+ */
101
+ value_usd?: number | null;
102
+ /**
103
+ * Percent of the fund's net assets (7.1 = 7.1 %)
104
+ * @type {number}
105
+ * @memberof FundHolding
106
+ */
107
+ pct_nav?: number | null;
108
+ /**
109
+ * Shares, principal or contracts held (see unit); null when the summed positions state different units
110
+ * @type {number}
111
+ * @memberof FundHolding
112
+ */
113
+ balance?: number | null;
114
+ /**
115
+ * Unit of balance: NS shares, PA principal amount, NC contracts, OU other
116
+ * @type {string}
117
+ * @memberof FundHolding
118
+ */
119
+ unit?: string | null;
120
+ /**
121
+ * N-PORT asset category (EC equity common, EP equity preferred, DBT debt, …)
122
+ * @type {string}
123
+ * @memberof FundHolding
124
+ */
125
+ asset_cat?: string | null;
126
+ /**
127
+ * How issuer_cik was found: cusip_cache, isin, ticker, not_equity (no issuer for a non-equity holding) or unresolved; null on accession= rows
128
+ * @type {string}
129
+ * @memberof FundHolding
130
+ */
131
+ issuer_resolution?: string | null;
132
+ }
133
+ /**
134
+ * Check if a given object implements the FundHolding interface.
135
+ */
136
+ export declare function instanceOfFundHolding(value: object): value is FundHolding;
137
+ export declare function FundHoldingFromJSON(json: any): FundHolding;
138
+ export declare function FundHoldingFromJSONTyped(json: any, ignoreDiscriminator: boolean): FundHolding;
139
+ export declare function FundHoldingToJSON(json: any): FundHolding;
140
+ export declare function FundHoldingToJSONTyped(value?: FundHolding | null, ignoreDiscriminator?: boolean): any;