@invinite-org/data-api-client 5.6.0 → 5.9.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 (141) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/dist/apis/EventsApi.d.ts +2 -2
  3. package/dist/apis/EventsApi.js +2 -2
  4. package/dist/apis/HoldingsApi.d.ts +33 -0
  5. package/dist/apis/HoldingsApi.js +79 -1
  6. package/dist/apis/IPOsApi.d.ts +54 -0
  7. package/dist/apis/IPOsApi.js +137 -1
  8. package/dist/apis/InsiderTradesApi.d.ts +3 -0
  9. package/dist/apis/InsiderTradesApi.js +9 -0
  10. package/dist/esm/apis/EventsApi.d.ts +2 -2
  11. package/dist/esm/apis/EventsApi.js +2 -2
  12. package/dist/esm/apis/HoldingsApi.d.ts +33 -0
  13. package/dist/esm/apis/HoldingsApi.js +78 -0
  14. package/dist/esm/apis/IPOsApi.d.ts +54 -0
  15. package/dist/esm/apis/IPOsApi.js +136 -0
  16. package/dist/esm/apis/InsiderTradesApi.d.ts +3 -0
  17. package/dist/esm/apis/InsiderTradesApi.js +9 -0
  18. package/dist/esm/models/Company.d.ts +1 -1
  19. package/dist/esm/models/Event.d.ts +2 -1
  20. package/dist/esm/models/Event.js +2 -1
  21. package/dist/esm/models/EventCalendarCall.d.ts +2 -1
  22. package/dist/esm/models/EventCalendarCall.js +1 -0
  23. package/dist/esm/models/Filer.d.ts +6 -0
  24. package/dist/esm/models/Filer.js +2 -0
  25. package/dist/esm/models/FilerDetail.d.ts +14 -0
  26. package/dist/esm/models/FilerDetail.js +6 -0
  27. package/dist/esm/models/FilerFund.d.ts +45 -0
  28. package/dist/esm/models/FilerFund.js +52 -0
  29. package/dist/esm/models/FilerFundAdviser.d.ts +56 -0
  30. package/dist/esm/models/FilerFundAdviser.js +59 -0
  31. package/dist/esm/models/FilerFundReturn.d.ts +62 -0
  32. package/dist/esm/models/FilerFundReturn.js +63 -0
  33. package/dist/esm/models/FilerFundSeries.d.ts +217 -0
  34. package/dist/esm/models/FilerFundSeries.js +169 -0
  35. package/dist/esm/models/FilerFundShareClass.d.ts +44 -0
  36. package/dist/esm/models/FilerFundShareClass.js +51 -0
  37. package/dist/esm/models/FilerPrivateOfferings.d.ts +62 -0
  38. package/dist/esm/models/FilerPrivateOfferings.js +63 -0
  39. package/dist/esm/models/FundHolding.d.ts +140 -0
  40. package/dist/esm/models/FundHolding.js +83 -0
  41. package/dist/esm/models/InsiderTrade.d.ts +101 -0
  42. package/dist/esm/models/InsiderTrade.js +71 -0
  43. package/dist/esm/models/InsiderTradeFootnote.d.ts +38 -0
  44. package/dist/esm/models/InsiderTradeFootnote.js +47 -0
  45. package/dist/esm/models/ListFundHoldings200Response.d.ts +52 -0
  46. package/dist/esm/models/ListFundHoldings200Response.js +57 -0
  47. package/dist/esm/models/ListOfferings200Response.d.ts +52 -0
  48. package/dist/esm/models/ListOfferings200Response.js +57 -0
  49. package/dist/esm/models/ListOfferings200ResponseMeta.d.ts +39 -0
  50. package/dist/esm/models/ListOfferings200ResponseMeta.js +44 -0
  51. package/dist/esm/models/Offering.d.ts +275 -0
  52. package/dist/esm/models/Offering.js +209 -0
  53. package/dist/esm/models/OfferingRelatedPerson.d.ts +44 -0
  54. package/dist/esm/models/OfferingRelatedPerson.js +51 -0
  55. package/dist/esm/models/index.d.ts +13 -0
  56. package/dist/esm/models/index.js +13 -0
  57. package/dist/models/Company.d.ts +1 -1
  58. package/dist/models/Event.d.ts +2 -1
  59. package/dist/models/Event.js +2 -1
  60. package/dist/models/EventCalendarCall.d.ts +2 -1
  61. package/dist/models/EventCalendarCall.js +1 -0
  62. package/dist/models/Filer.d.ts +6 -0
  63. package/dist/models/Filer.js +2 -0
  64. package/dist/models/FilerDetail.d.ts +14 -0
  65. package/dist/models/FilerDetail.js +6 -0
  66. package/dist/models/FilerFund.d.ts +45 -0
  67. package/dist/models/FilerFund.js +59 -0
  68. package/dist/models/FilerFundAdviser.d.ts +56 -0
  69. package/dist/models/FilerFundAdviser.js +66 -0
  70. package/dist/models/FilerFundReturn.d.ts +62 -0
  71. package/dist/models/FilerFundReturn.js +70 -0
  72. package/dist/models/FilerFundSeries.d.ts +217 -0
  73. package/dist/models/FilerFundSeries.js +177 -0
  74. package/dist/models/FilerFundShareClass.d.ts +44 -0
  75. package/dist/models/FilerFundShareClass.js +58 -0
  76. package/dist/models/FilerPrivateOfferings.d.ts +62 -0
  77. package/dist/models/FilerPrivateOfferings.js +70 -0
  78. package/dist/models/FundHolding.d.ts +140 -0
  79. package/dist/models/FundHolding.js +90 -0
  80. package/dist/models/InsiderTrade.d.ts +101 -0
  81. package/dist/models/InsiderTrade.js +72 -1
  82. package/dist/models/InsiderTradeFootnote.d.ts +38 -0
  83. package/dist/models/InsiderTradeFootnote.js +54 -0
  84. package/dist/models/ListFundHoldings200Response.d.ts +52 -0
  85. package/dist/models/ListFundHoldings200Response.js +64 -0
  86. package/dist/models/ListOfferings200Response.d.ts +52 -0
  87. package/dist/models/ListOfferings200Response.js +64 -0
  88. package/dist/models/ListOfferings200ResponseMeta.d.ts +39 -0
  89. package/dist/models/ListOfferings200ResponseMeta.js +51 -0
  90. package/dist/models/Offering.d.ts +275 -0
  91. package/dist/models/Offering.js +217 -0
  92. package/dist/models/OfferingRelatedPerson.d.ts +44 -0
  93. package/dist/models/OfferingRelatedPerson.js +58 -0
  94. package/dist/models/index.d.ts +13 -0
  95. package/dist/models/index.js +13 -0
  96. package/docs/CompaniesApi.md +2 -2
  97. package/docs/EventsApi.md +1 -1
  98. package/docs/Filer.md +2 -0
  99. package/docs/FilerDetail.md +4 -0
  100. package/docs/FilerFund.md +39 -0
  101. package/docs/FilerFundAdviser.md +43 -0
  102. package/docs/FilerFundReturn.md +45 -0
  103. package/docs/FilerFundSeries.md +93 -0
  104. package/docs/FilerFundShareClass.md +39 -0
  105. package/docs/FilerPrivateOfferings.md +45 -0
  106. package/docs/FundHolding.md +70 -0
  107. package/docs/HoldingsApi.md +105 -0
  108. package/docs/IPOsApi.md +195 -0
  109. package/docs/InsiderTrade.md +28 -0
  110. package/docs/InsiderTradeFootnote.md +37 -0
  111. package/docs/InsiderTradesApi.md +10 -1
  112. package/docs/ListFundHoldings200Response.md +41 -0
  113. package/docs/ListOfferings200Response.md +41 -0
  114. package/docs/ListOfferings200ResponseMeta.md +37 -0
  115. package/docs/Offering.md +111 -0
  116. package/docs/OfferingRelatedPerson.md +39 -0
  117. package/package.json +1 -1
  118. package/src/apis/EventsApi.ts +2 -2
  119. package/src/apis/HoldingsApi.ts +107 -0
  120. package/src/apis/IPOsApi.ts +186 -0
  121. package/src/apis/InsiderTradesApi.ts +15 -0
  122. package/src/models/Company.ts +1 -1
  123. package/src/models/Event.ts +3 -2
  124. package/src/models/EventCalendarCall.ts +2 -1
  125. package/src/models/Filer.ts +8 -0
  126. package/src/models/FilerDetail.ts +30 -0
  127. package/src/models/FilerFund.ts +92 -0
  128. package/src/models/FilerFundAdviser.ts +102 -0
  129. package/src/models/FilerFundReturn.ts +111 -0
  130. package/src/models/FilerFundSeries.ts +360 -0
  131. package/src/models/FilerFundShareClass.ts +84 -0
  132. package/src/models/FilerPrivateOfferings.ts +111 -0
  133. package/src/models/FundHolding.ts +212 -0
  134. package/src/models/InsiderTrade.ts +152 -0
  135. package/src/models/InsiderTradeFootnote.ts +75 -0
  136. package/src/models/ListFundHoldings200Response.ts +108 -0
  137. package/src/models/ListOfferings200Response.ts +108 -0
  138. package/src/models/ListOfferings200ResponseMeta.ts +81 -0
  139. package/src/models/Offering.ts +433 -0
  140. package/src/models/OfferingRelatedPerson.ts +84 -0
  141. package/src/models/index.ts +13 -0
@@ -0,0 +1,83 @@
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 FundHolding interface.
16
+ */
17
+ export function instanceOfFundHolding(value) {
18
+ if (!('fund_key' in value) || value['fund_key'] === undefined)
19
+ return false;
20
+ if (!('class_tickers' in value) || value['class_tickers'] === undefined)
21
+ return false;
22
+ if (!('accession_number' in value) || value['accession_number'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function FundHoldingFromJSON(json) {
27
+ return FundHoldingFromJSONTyped(json, false);
28
+ }
29
+ export function FundHoldingFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'fund_key': json['fund_key'],
35
+ 'series_id': json['series_id'] == null ? undefined : json['series_id'],
36
+ 'series_name': json['series_name'] == null ? undefined : json['series_name'],
37
+ 'registrant_cik': json['registrant_cik'] == null ? undefined : json['registrant_cik'],
38
+ 'registrant_name': json['registrant_name'] == null ? undefined : json['registrant_name'],
39
+ 'class_tickers': json['class_tickers'],
40
+ 'report_date': json['report_date'] == null ? undefined : (new Date(json['report_date'])),
41
+ 'accession_number': json['accession_number'],
42
+ 'issuer_cik': json['issuer_cik'] == null ? undefined : json['issuer_cik'],
43
+ 'issuer_name': json['issuer_name'] == null ? undefined : json['issuer_name'],
44
+ 'cusip': json['cusip'] == null ? undefined : json['cusip'],
45
+ 'isin': json['isin'] == null ? undefined : json['isin'],
46
+ 'ticker': json['ticker'] == null ? undefined : json['ticker'],
47
+ 'value_usd': json['value_usd'] == null ? undefined : json['value_usd'],
48
+ 'pct_nav': json['pct_nav'] == null ? undefined : json['pct_nav'],
49
+ 'balance': json['balance'] == null ? undefined : json['balance'],
50
+ 'unit': json['unit'] == null ? undefined : json['unit'],
51
+ 'asset_cat': json['asset_cat'] == null ? undefined : json['asset_cat'],
52
+ 'issuer_resolution': json['issuer_resolution'] == null ? undefined : json['issuer_resolution'],
53
+ };
54
+ }
55
+ export function FundHoldingToJSON(json) {
56
+ return FundHoldingToJSONTyped(json, false);
57
+ }
58
+ export function FundHoldingToJSONTyped(value, ignoreDiscriminator = false) {
59
+ if (value == null) {
60
+ return value;
61
+ }
62
+ return {
63
+ 'fund_key': value['fund_key'],
64
+ 'series_id': value['series_id'],
65
+ 'series_name': value['series_name'],
66
+ 'registrant_cik': value['registrant_cik'],
67
+ 'registrant_name': value['registrant_name'],
68
+ 'class_tickers': value['class_tickers'],
69
+ 'report_date': value['report_date'] == null ? value['report_date'] : value['report_date'].toISOString().substring(0, 10),
70
+ 'accession_number': value['accession_number'],
71
+ 'issuer_cik': value['issuer_cik'],
72
+ 'issuer_name': value['issuer_name'],
73
+ 'cusip': value['cusip'],
74
+ 'isin': value['isin'],
75
+ 'ticker': value['ticker'],
76
+ 'value_usd': value['value_usd'],
77
+ 'pct_nav': value['pct_nav'],
78
+ 'balance': value['balance'],
79
+ 'unit': value['unit'],
80
+ 'asset_cat': value['asset_cat'],
81
+ 'issuer_resolution': value['issuer_resolution'],
82
+ };
83
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { InsiderTradeFootnote } from './InsiderTradeFootnote';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -141,6 +142,90 @@ export interface InsiderTrade {
141
142
  * @memberof InsiderTrade
142
143
  */
143
144
  side: InsiderTradeSideEnum;
145
+ /**
146
+ * Date of the transaction (YYYY-MM-DD); sec_api rows (realtime Form 4 feed) leave it null
147
+ * @type {Date}
148
+ * @memberof InsiderTrade
149
+ */
150
+ transaction_date: Date | null;
151
+ /**
152
+ * Deemed execution date (YYYY-MM-DD) when the filing states one
153
+ * @type {Date}
154
+ * @memberof InsiderTrade
155
+ */
156
+ deemed_execution_date: Date | null;
157
+ /**
158
+ * CIK of the reporting owner (10 digits); one row per owner of a joint filing; sec_api rows (realtime Form 4 feed) leave it null
159
+ * @type {string}
160
+ * @memberof InsiderTrade
161
+ */
162
+ owner_cik: string | null;
163
+ /**
164
+ * Ownership form: D = direct, I = indirect; sec_api rows (realtime Form 4 feed) leave it null
165
+ * @type {InsiderTradeDirectIndirectEnum}
166
+ * @memberof InsiderTrade
167
+ */
168
+ direct_indirect: InsiderTradeDirectIndirectEnum | null;
169
+ /**
170
+ * Nature of an indirect ownership as filed (e.g. By Trust)
171
+ * @type {string}
172
+ * @memberof InsiderTrade
173
+ */
174
+ nature_of_ownership: string | null;
175
+ /**
176
+ * true = a derivative-security line (option, RSU, warrant); false = a non-derivative line (sec_api rows are always false)
177
+ * @type {boolean}
178
+ * @memberof InsiderTrade
179
+ */
180
+ is_derivative: boolean;
181
+ /**
182
+ * Conversion or exercise price of a derivative security
183
+ * @type {number}
184
+ * @memberof InsiderTrade
185
+ */
186
+ conversion_exercise_price: number | null;
187
+ /**
188
+ * Date the derivative becomes exercisable (YYYY-MM-DD)
189
+ * @type {Date}
190
+ * @memberof InsiderTrade
191
+ */
192
+ exercise_date: Date | null;
193
+ /**
194
+ * Expiration date of the derivative (YYYY-MM-DD)
195
+ * @type {Date}
196
+ * @memberof InsiderTrade
197
+ */
198
+ expiration_date: Date | null;
199
+ /**
200
+ * Title of the security underlying a derivative
201
+ * @type {string}
202
+ * @memberof InsiderTrade
203
+ */
204
+ underlying_security_title: string | null;
205
+ /**
206
+ * Number of underlying shares of a derivative
207
+ * @type {number}
208
+ * @memberof InsiderTrade
209
+ */
210
+ underlying_shares: number | null;
211
+ /**
212
+ * The filing's footnotes referenced by this line; sec_api rows (realtime Form 4 feed) leave it null
213
+ * @type {Array<InsiderTradeFootnote>}
214
+ * @memberof InsiderTrade
215
+ */
216
+ footnotes: Array<InsiderTradeFootnote> | null;
217
+ /**
218
+ * true = the filer marked the transaction as made under a Rule 10b5-1 trading plan; sec_api rows (realtime Form 4 feed) leave it null
219
+ * @type {boolean}
220
+ * @memberof InsiderTrade
221
+ */
222
+ is_10b5_1: boolean | null;
223
+ /**
224
+ * Origin of the row: sec_api = the realtime Form 4 feed; f345 = the SEC insider transactions dataset (Forms 3, 4, 5), whose rows carry the fields above
225
+ * @type {InsiderTradeSourceEnum}
226
+ * @memberof InsiderTrade
227
+ */
228
+ source: InsiderTradeSourceEnum;
144
229
  }
145
230
  /**
146
231
  * @export
@@ -150,6 +235,22 @@ export declare const InsiderTradeSideEnum: {
150
235
  readonly Sell: "sell";
151
236
  };
152
237
  export type InsiderTradeSideEnum = typeof InsiderTradeSideEnum[keyof typeof InsiderTradeSideEnum] | (string & {});
238
+ /**
239
+ * @export
240
+ */
241
+ export declare const InsiderTradeDirectIndirectEnum: {
242
+ readonly D: "D";
243
+ readonly I: "I";
244
+ };
245
+ export type InsiderTradeDirectIndirectEnum = typeof InsiderTradeDirectIndirectEnum[keyof typeof InsiderTradeDirectIndirectEnum] | (string & {});
246
+ /**
247
+ * @export
248
+ */
249
+ export declare const InsiderTradeSourceEnum: {
250
+ readonly SecApi: "sec_api";
251
+ readonly F345: "f345";
252
+ };
253
+ export type InsiderTradeSourceEnum = typeof InsiderTradeSourceEnum[keyof typeof InsiderTradeSourceEnum] | (string & {});
153
254
  /**
154
255
  * Check if a given object implements the InsiderTrade interface.
155
256
  */
@@ -11,6 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { InsiderTradeFootnoteFromJSON, InsiderTradeFootnoteToJSON, } from './InsiderTradeFootnote';
14
15
  /**
15
16
  * @export
16
17
  */
@@ -18,6 +19,20 @@ export const InsiderTradeSideEnum = {
18
19
  Buy: 'buy',
19
20
  Sell: 'sell'
20
21
  };
22
+ /**
23
+ * @export
24
+ */
25
+ export const InsiderTradeDirectIndirectEnum = {
26
+ D: 'D',
27
+ I: 'I'
28
+ };
29
+ /**
30
+ * @export
31
+ */
32
+ export const InsiderTradeSourceEnum = {
33
+ SecApi: 'sec_api',
34
+ F345: 'f345'
35
+ };
21
36
  /**
22
37
  * Check if a given object implements the InsiderTrade interface.
23
38
  */
@@ -56,6 +71,34 @@ export function instanceOfInsiderTrade(value) {
56
71
  return false;
57
72
  if (!('side' in value) || value['side'] === undefined)
58
73
  return false;
74
+ if (!('transaction_date' in value) || value['transaction_date'] === undefined)
75
+ return false;
76
+ if (!('deemed_execution_date' in value) || value['deemed_execution_date'] === undefined)
77
+ return false;
78
+ if (!('owner_cik' in value) || value['owner_cik'] === undefined)
79
+ return false;
80
+ if (!('direct_indirect' in value) || value['direct_indirect'] === undefined)
81
+ return false;
82
+ if (!('nature_of_ownership' in value) || value['nature_of_ownership'] === undefined)
83
+ return false;
84
+ if (!('is_derivative' in value) || value['is_derivative'] === undefined)
85
+ return false;
86
+ if (!('conversion_exercise_price' in value) || value['conversion_exercise_price'] === undefined)
87
+ return false;
88
+ if (!('exercise_date' in value) || value['exercise_date'] === undefined)
89
+ return false;
90
+ if (!('expiration_date' in value) || value['expiration_date'] === undefined)
91
+ return false;
92
+ if (!('underlying_security_title' in value) || value['underlying_security_title'] === undefined)
93
+ return false;
94
+ if (!('underlying_shares' in value) || value['underlying_shares'] === undefined)
95
+ return false;
96
+ if (!('footnotes' in value) || value['footnotes'] === undefined)
97
+ return false;
98
+ if (!('is_10b5_1' in value) || value['is_10b5_1'] === undefined)
99
+ return false;
100
+ if (!('source' in value) || value['source'] === undefined)
101
+ return false;
59
102
  return true;
60
103
  }
61
104
  export function InsiderTradeFromJSON(json) {
@@ -87,6 +130,20 @@ export function InsiderTradeFromJSONTyped(json, ignoreDiscriminator) {
87
130
  'shares_owned_following_transaction': json['shares_owned_following_transaction'],
88
131
  'shares_owned_before_transaction': json['shares_owned_before_transaction'] == null ? undefined : json['shares_owned_before_transaction'],
89
132
  'side': json['side'],
133
+ 'transaction_date': (json['transaction_date'] == null ? null : new Date(json['transaction_date'])),
134
+ 'deemed_execution_date': (json['deemed_execution_date'] == null ? null : new Date(json['deemed_execution_date'])),
135
+ 'owner_cik': json['owner_cik'],
136
+ 'direct_indirect': json['direct_indirect'],
137
+ 'nature_of_ownership': json['nature_of_ownership'],
138
+ 'is_derivative': json['is_derivative'],
139
+ 'conversion_exercise_price': json['conversion_exercise_price'],
140
+ 'exercise_date': (json['exercise_date'] == null ? null : new Date(json['exercise_date'])),
141
+ 'expiration_date': (json['expiration_date'] == null ? null : new Date(json['expiration_date'])),
142
+ 'underlying_security_title': json['underlying_security_title'],
143
+ 'underlying_shares': json['underlying_shares'],
144
+ 'footnotes': (json['footnotes'] == null ? null : json['footnotes'].map(InsiderTradeFootnoteFromJSON)),
145
+ 'is_10b5_1': json['is_10b5_1'],
146
+ 'source': json['source'],
90
147
  };
91
148
  }
92
149
  export function InsiderTradeToJSON(json) {
@@ -118,5 +175,19 @@ export function InsiderTradeToJSONTyped(value, ignoreDiscriminator = false) {
118
175
  'shares_owned_following_transaction': value['shares_owned_following_transaction'],
119
176
  'shares_owned_before_transaction': value['shares_owned_before_transaction'],
120
177
  'side': value['side'],
178
+ 'transaction_date': value['transaction_date'] == null ? value['transaction_date'] : value['transaction_date'].toISOString().substring(0, 10),
179
+ 'deemed_execution_date': value['deemed_execution_date'] == null ? value['deemed_execution_date'] : value['deemed_execution_date'].toISOString().substring(0, 10),
180
+ 'owner_cik': value['owner_cik'],
181
+ 'direct_indirect': value['direct_indirect'],
182
+ 'nature_of_ownership': value['nature_of_ownership'],
183
+ 'is_derivative': value['is_derivative'],
184
+ 'conversion_exercise_price': value['conversion_exercise_price'],
185
+ 'exercise_date': value['exercise_date'] == null ? value['exercise_date'] : value['exercise_date'].toISOString().substring(0, 10),
186
+ 'expiration_date': value['expiration_date'] == null ? value['expiration_date'] : value['expiration_date'].toISOString().substring(0, 10),
187
+ 'underlying_security_title': value['underlying_security_title'],
188
+ 'underlying_shares': value['underlying_shares'],
189
+ 'footnotes': (value['footnotes'] == null ? null : value['footnotes'].map(InsiderTradeFootnoteToJSON)),
190
+ 'is_10b5_1': value['is_10b5_1'],
191
+ 'source': value['source'],
121
192
  };
122
193
  }
@@ -0,0 +1,38 @@
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 footnote of an insider filing
14
+ * @export
15
+ * @interface InsiderTradeFootnote
16
+ */
17
+ export interface InsiderTradeFootnote {
18
+ /**
19
+ * Footnote id as filed (F1, F2, …)
20
+ * @type {string}
21
+ * @memberof InsiderTradeFootnote
22
+ */
23
+ id: string;
24
+ /**
25
+ * Footnote text
26
+ * @type {string}
27
+ * @memberof InsiderTradeFootnote
28
+ */
29
+ text: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the InsiderTradeFootnote interface.
33
+ */
34
+ export declare function instanceOfInsiderTradeFootnote(value: object): value is InsiderTradeFootnote;
35
+ export declare function InsiderTradeFootnoteFromJSON(json: any): InsiderTradeFootnote;
36
+ export declare function InsiderTradeFootnoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): InsiderTradeFootnote;
37
+ export declare function InsiderTradeFootnoteToJSON(json: any): InsiderTradeFootnote;
38
+ export declare function InsiderTradeFootnoteToJSONTyped(value?: InsiderTradeFootnote | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
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 InsiderTradeFootnote interface.
16
+ */
17
+ export function instanceOfInsiderTradeFootnote(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('text' in value) || value['text'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function InsiderTradeFootnoteFromJSON(json) {
25
+ return InsiderTradeFootnoteFromJSONTyped(json, false);
26
+ }
27
+ export function InsiderTradeFootnoteFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'id': json['id'],
33
+ 'text': json['text'],
34
+ };
35
+ }
36
+ export function InsiderTradeFootnoteToJSON(json) {
37
+ return InsiderTradeFootnoteToJSONTyped(json, false);
38
+ }
39
+ export function InsiderTradeFootnoteToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'id': value['id'],
45
+ 'text': value['text'],
46
+ };
47
+ }
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ListHoldings200ResponseMeta } from './ListHoldings200ResponseMeta';
13
+ import type { FundHolding } from './FundHolding';
14
+ /**
15
+ * A page of FundHolding rows (the list envelope, R3)
16
+ * @export
17
+ * @interface ListFundHoldings200Response
18
+ */
19
+ export interface ListFundHoldings200Response {
20
+ /**
21
+ * The rows of this page
22
+ * @type {Array<FundHolding>}
23
+ * @memberof ListFundHoldings200Response
24
+ */
25
+ data: Array<FundHolding>;
26
+ /**
27
+ * true when a next page exists
28
+ * @type {boolean}
29
+ * @memberof ListFundHoldings200Response
30
+ */
31
+ has_more: boolean;
32
+ /**
33
+ * Opaque cursor of the next page; null on the last page
34
+ * @type {string}
35
+ * @memberof ListFundHoldings200Response
36
+ */
37
+ next_cursor: string | null;
38
+ /**
39
+ *
40
+ * @type {ListHoldings200ResponseMeta}
41
+ * @memberof ListFundHoldings200Response
42
+ */
43
+ meta: ListHoldings200ResponseMeta;
44
+ }
45
+ /**
46
+ * Check if a given object implements the ListFundHoldings200Response interface.
47
+ */
48
+ export declare function instanceOfListFundHoldings200Response(value: object): value is ListFundHoldings200Response;
49
+ export declare function ListFundHoldings200ResponseFromJSON(json: any): ListFundHoldings200Response;
50
+ export declare function ListFundHoldings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListFundHoldings200Response;
51
+ export declare function ListFundHoldings200ResponseToJSON(json: any): ListFundHoldings200Response;
52
+ export declare function ListFundHoldings200ResponseToJSONTyped(value?: ListFundHoldings200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ListHoldings200ResponseMetaFromJSON, ListHoldings200ResponseMetaToJSON, } from './ListHoldings200ResponseMeta';
15
+ import { FundHoldingFromJSON, FundHoldingToJSON, } from './FundHolding';
16
+ /**
17
+ * Check if a given object implements the ListFundHoldings200Response interface.
18
+ */
19
+ export function instanceOfListFundHoldings200Response(value) {
20
+ if (!('data' in value) || value['data'] === undefined)
21
+ return false;
22
+ if (!('has_more' in value) || value['has_more'] === undefined)
23
+ return false;
24
+ if (!('next_cursor' in value) || value['next_cursor'] === undefined)
25
+ return false;
26
+ if (!('meta' in value) || value['meta'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function ListFundHoldings200ResponseFromJSON(json) {
31
+ return ListFundHoldings200ResponseFromJSONTyped(json, false);
32
+ }
33
+ export function ListFundHoldings200ResponseFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'data': (json['data'].map(FundHoldingFromJSON)),
39
+ 'has_more': json['has_more'],
40
+ 'next_cursor': json['next_cursor'],
41
+ 'meta': ListHoldings200ResponseMetaFromJSON(json['meta']),
42
+ };
43
+ }
44
+ export function ListFundHoldings200ResponseToJSON(json) {
45
+ return ListFundHoldings200ResponseToJSONTyped(json, false);
46
+ }
47
+ export function ListFundHoldings200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(FundHoldingToJSON)),
53
+ 'has_more': value['has_more'],
54
+ 'next_cursor': value['next_cursor'],
55
+ 'meta': ListHoldings200ResponseMetaToJSON(value['meta']),
56
+ };
57
+ }
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ListOfferings200ResponseMeta } from './ListOfferings200ResponseMeta';
13
+ import type { Offering } from './Offering';
14
+ /**
15
+ * A page of Offering rows (the list envelope, R3)
16
+ * @export
17
+ * @interface ListOfferings200Response
18
+ */
19
+ export interface ListOfferings200Response {
20
+ /**
21
+ * The rows of this page
22
+ * @type {Array<Offering>}
23
+ * @memberof ListOfferings200Response
24
+ */
25
+ data: Array<Offering>;
26
+ /**
27
+ * true when a next page exists
28
+ * @type {boolean}
29
+ * @memberof ListOfferings200Response
30
+ */
31
+ has_more: boolean;
32
+ /**
33
+ * Opaque cursor of the next page; null on the last page
34
+ * @type {string}
35
+ * @memberof ListOfferings200Response
36
+ */
37
+ next_cursor: string | null;
38
+ /**
39
+ *
40
+ * @type {ListOfferings200ResponseMeta}
41
+ * @memberof ListOfferings200Response
42
+ */
43
+ meta: ListOfferings200ResponseMeta;
44
+ }
45
+ /**
46
+ * Check if a given object implements the ListOfferings200Response interface.
47
+ */
48
+ export declare function instanceOfListOfferings200Response(value: object): value is ListOfferings200Response;
49
+ export declare function ListOfferings200ResponseFromJSON(json: any): ListOfferings200Response;
50
+ export declare function ListOfferings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOfferings200Response;
51
+ export declare function ListOfferings200ResponseToJSON(json: any): ListOfferings200Response;
52
+ export declare function ListOfferings200ResponseToJSONTyped(value?: ListOfferings200Response | null, ignoreDiscriminator?: boolean): any;