@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,212 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface FundHolding
20
+ */
21
+ export interface FundHolding {
22
+ /**
23
+ * The fund: its SEC series id, or cik:<registrant CIK> for a unit investment trust that files without a series
24
+ * @type {string}
25
+ * @memberof FundHolding
26
+ */
27
+ fund_key: string;
28
+ /**
29
+ * SEC series id (S + 9 digits); null for a fund without a series
30
+ * @type {string}
31
+ * @memberof FundHolding
32
+ */
33
+ series_id?: string | null;
34
+ /**
35
+ * Fund (series) name as reported
36
+ * @type {string}
37
+ * @memberof FundHolding
38
+ */
39
+ series_name?: string | null;
40
+ /**
41
+ * Registrant (trust) CIK, 10 digits
42
+ * @type {string}
43
+ * @memberof FundHolding
44
+ */
45
+ registrant_cik?: string | null;
46
+ /**
47
+ * Registrant (trust) name as reported
48
+ * @type {string}
49
+ * @memberof FundHolding
50
+ */
51
+ registrant_name?: string | null;
52
+ /**
53
+ * Tickers of the fund's share classes (SEC Series and Class list; a unit trust's own SEC-stated tickers)
54
+ * @type {Array<string>}
55
+ * @memberof FundHolding
56
+ */
57
+ class_tickers: Array<string>;
58
+ /**
59
+ * Date the holdings are reported as of (YYYY-MM-DD)
60
+ * @type {Date}
61
+ * @memberof FundHolding
62
+ */
63
+ report_date?: Date | null;
64
+ /**
65
+ * NPORT-P accession number of the report
66
+ * @type {string}
67
+ * @memberof FundHolding
68
+ */
69
+ accession_number: string;
70
+ /**
71
+ * Issuer CIK of the holding, 10 digits; null when it did not resolve (or on accession= rows, as filed)
72
+ * @type {string}
73
+ * @memberof FundHolding
74
+ */
75
+ issuer_cik?: string | null;
76
+ /**
77
+ * Issuer name
78
+ * @type {string}
79
+ * @memberof FundHolding
80
+ */
81
+ issuer_name?: string | null;
82
+ /**
83
+ * Holding CUSIP; null on company= rows (a fund's positions in the issuer summed)
84
+ * @type {string}
85
+ * @memberof FundHolding
86
+ */
87
+ cusip?: string | null;
88
+ /**
89
+ * Holding ISIN; null on company= rows
90
+ * @type {string}
91
+ * @memberof FundHolding
92
+ */
93
+ isin?: string | null;
94
+ /**
95
+ * Holding ticker (company= rows: the requested company's ticker; else as the fund stated it)
96
+ * @type {string}
97
+ * @memberof FundHolding
98
+ */
99
+ ticker?: string | null;
100
+ /**
101
+ * Value in USD as the fund reported it; null when none was stated
102
+ * @type {number}
103
+ * @memberof FundHolding
104
+ */
105
+ value_usd?: number | null;
106
+ /**
107
+ * Percent of the fund's net assets (7.1 = 7.1 %)
108
+ * @type {number}
109
+ * @memberof FundHolding
110
+ */
111
+ pct_nav?: number | null;
112
+ /**
113
+ * Shares, principal or contracts held (see unit); null when the summed positions state different units
114
+ * @type {number}
115
+ * @memberof FundHolding
116
+ */
117
+ balance?: number | null;
118
+ /**
119
+ * Unit of balance: NS shares, PA principal amount, NC contracts, OU other
120
+ * @type {string}
121
+ * @memberof FundHolding
122
+ */
123
+ unit?: string | null;
124
+ /**
125
+ * N-PORT asset category (EC equity common, EP equity preferred, DBT debt, …)
126
+ * @type {string}
127
+ * @memberof FundHolding
128
+ */
129
+ asset_cat?: string | null;
130
+ /**
131
+ * How issuer_cik was found: cusip_cache, isin, ticker, not_equity (no issuer for a non-equity holding) or unresolved; null on accession= rows
132
+ * @type {string}
133
+ * @memberof FundHolding
134
+ */
135
+ issuer_resolution?: string | null;
136
+ }
137
+
138
+ /**
139
+ * Check if a given object implements the FundHolding interface.
140
+ */
141
+ export function instanceOfFundHolding(value: object): value is FundHolding {
142
+ if (!('fund_key' in value) || value['fund_key'] === undefined) return false;
143
+ if (!('class_tickers' in value) || value['class_tickers'] === undefined) return false;
144
+ if (!('accession_number' in value) || value['accession_number'] === undefined) return false;
145
+ return true;
146
+ }
147
+
148
+ export function FundHoldingFromJSON(json: any): FundHolding {
149
+ return FundHoldingFromJSONTyped(json, false);
150
+ }
151
+
152
+ export function FundHoldingFromJSONTyped(json: any, ignoreDiscriminator: boolean): FundHolding {
153
+ if (json == null) {
154
+ return json;
155
+ }
156
+ return {
157
+
158
+ 'fund_key': json['fund_key'],
159
+ 'series_id': json['series_id'] == null ? undefined : json['series_id'],
160
+ 'series_name': json['series_name'] == null ? undefined : json['series_name'],
161
+ 'registrant_cik': json['registrant_cik'] == null ? undefined : json['registrant_cik'],
162
+ 'registrant_name': json['registrant_name'] == null ? undefined : json['registrant_name'],
163
+ 'class_tickers': json['class_tickers'],
164
+ 'report_date': json['report_date'] == null ? undefined : (new Date(json['report_date'])),
165
+ 'accession_number': json['accession_number'],
166
+ 'issuer_cik': json['issuer_cik'] == null ? undefined : json['issuer_cik'],
167
+ 'issuer_name': json['issuer_name'] == null ? undefined : json['issuer_name'],
168
+ 'cusip': json['cusip'] == null ? undefined : json['cusip'],
169
+ 'isin': json['isin'] == null ? undefined : json['isin'],
170
+ 'ticker': json['ticker'] == null ? undefined : json['ticker'],
171
+ 'value_usd': json['value_usd'] == null ? undefined : json['value_usd'],
172
+ 'pct_nav': json['pct_nav'] == null ? undefined : json['pct_nav'],
173
+ 'balance': json['balance'] == null ? undefined : json['balance'],
174
+ 'unit': json['unit'] == null ? undefined : json['unit'],
175
+ 'asset_cat': json['asset_cat'] == null ? undefined : json['asset_cat'],
176
+ 'issuer_resolution': json['issuer_resolution'] == null ? undefined : json['issuer_resolution'],
177
+ };
178
+ }
179
+
180
+ export function FundHoldingToJSON(json: any): FundHolding {
181
+ return FundHoldingToJSONTyped(json, false);
182
+ }
183
+
184
+ export function FundHoldingToJSONTyped(value?: FundHolding | null, ignoreDiscriminator: boolean = false): any {
185
+ if (value == null) {
186
+ return value;
187
+ }
188
+
189
+ return {
190
+
191
+ 'fund_key': value['fund_key'],
192
+ 'series_id': value['series_id'],
193
+ 'series_name': value['series_name'],
194
+ 'registrant_cik': value['registrant_cik'],
195
+ 'registrant_name': value['registrant_name'],
196
+ 'class_tickers': value['class_tickers'],
197
+ 'report_date': value['report_date'] == null ? value['report_date'] : value['report_date'].toISOString().substring(0,10),
198
+ 'accession_number': value['accession_number'],
199
+ 'issuer_cik': value['issuer_cik'],
200
+ 'issuer_name': value['issuer_name'],
201
+ 'cusip': value['cusip'],
202
+ 'isin': value['isin'],
203
+ 'ticker': value['ticker'],
204
+ 'value_usd': value['value_usd'],
205
+ 'pct_nav': value['pct_nav'],
206
+ 'balance': value['balance'],
207
+ 'unit': value['unit'],
208
+ 'asset_cat': value['asset_cat'],
209
+ 'issuer_resolution': value['issuer_resolution'],
210
+ };
211
+ }
212
+
@@ -13,6 +13,14 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { InsiderTradeFootnote } from './InsiderTradeFootnote';
17
+ import {
18
+ InsiderTradeFootnoteFromJSON,
19
+ InsiderTradeFootnoteFromJSONTyped,
20
+ InsiderTradeFootnoteToJSON,
21
+ InsiderTradeFootnoteToJSONTyped,
22
+ } from './InsiderTradeFootnote';
23
+
16
24
  /**
17
25
  *
18
26
  * @export
@@ -145,6 +153,90 @@ export interface InsiderTrade {
145
153
  * @memberof InsiderTrade
146
154
  */
147
155
  side: InsiderTradeSideEnum;
156
+ /**
157
+ * Date of the transaction (YYYY-MM-DD); sec_api rows (realtime Form 4 feed) leave it null
158
+ * @type {Date}
159
+ * @memberof InsiderTrade
160
+ */
161
+ transaction_date: Date | null;
162
+ /**
163
+ * Deemed execution date (YYYY-MM-DD) when the filing states one
164
+ * @type {Date}
165
+ * @memberof InsiderTrade
166
+ */
167
+ deemed_execution_date: Date | null;
168
+ /**
169
+ * 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
170
+ * @type {string}
171
+ * @memberof InsiderTrade
172
+ */
173
+ owner_cik: string | null;
174
+ /**
175
+ * Ownership form: D = direct, I = indirect; sec_api rows (realtime Form 4 feed) leave it null
176
+ * @type {InsiderTradeDirectIndirectEnum}
177
+ * @memberof InsiderTrade
178
+ */
179
+ direct_indirect: InsiderTradeDirectIndirectEnum | null;
180
+ /**
181
+ * Nature of an indirect ownership as filed (e.g. By Trust)
182
+ * @type {string}
183
+ * @memberof InsiderTrade
184
+ */
185
+ nature_of_ownership: string | null;
186
+ /**
187
+ * true = a derivative-security line (option, RSU, warrant); false = a non-derivative line (sec_api rows are always false)
188
+ * @type {boolean}
189
+ * @memberof InsiderTrade
190
+ */
191
+ is_derivative: boolean;
192
+ /**
193
+ * Conversion or exercise price of a derivative security
194
+ * @type {number}
195
+ * @memberof InsiderTrade
196
+ */
197
+ conversion_exercise_price: number | null;
198
+ /**
199
+ * Date the derivative becomes exercisable (YYYY-MM-DD)
200
+ * @type {Date}
201
+ * @memberof InsiderTrade
202
+ */
203
+ exercise_date: Date | null;
204
+ /**
205
+ * Expiration date of the derivative (YYYY-MM-DD)
206
+ * @type {Date}
207
+ * @memberof InsiderTrade
208
+ */
209
+ expiration_date: Date | null;
210
+ /**
211
+ * Title of the security underlying a derivative
212
+ * @type {string}
213
+ * @memberof InsiderTrade
214
+ */
215
+ underlying_security_title: string | null;
216
+ /**
217
+ * Number of underlying shares of a derivative
218
+ * @type {number}
219
+ * @memberof InsiderTrade
220
+ */
221
+ underlying_shares: number | null;
222
+ /**
223
+ * The filing's footnotes referenced by this line; sec_api rows (realtime Form 4 feed) leave it null
224
+ * @type {Array<InsiderTradeFootnote>}
225
+ * @memberof InsiderTrade
226
+ */
227
+ footnotes: Array<InsiderTradeFootnote> | null;
228
+ /**
229
+ * 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
230
+ * @type {boolean}
231
+ * @memberof InsiderTrade
232
+ */
233
+ is_10b5_1: boolean | null;
234
+ /**
235
+ * 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
236
+ * @type {InsiderTradeSourceEnum}
237
+ * @memberof InsiderTrade
238
+ */
239
+ source: InsiderTradeSourceEnum;
148
240
  }
149
241
 
150
242
 
@@ -157,6 +249,24 @@ export const InsiderTradeSideEnum = {
157
249
  } as const;
158
250
  export type InsiderTradeSideEnum = typeof InsiderTradeSideEnum[keyof typeof InsiderTradeSideEnum] | (string & {});
159
251
 
252
+ /**
253
+ * @export
254
+ */
255
+ export const InsiderTradeDirectIndirectEnum = {
256
+ D: 'D',
257
+ I: 'I'
258
+ } as const;
259
+ export type InsiderTradeDirectIndirectEnum = typeof InsiderTradeDirectIndirectEnum[keyof typeof InsiderTradeDirectIndirectEnum] | (string & {});
260
+
261
+ /**
262
+ * @export
263
+ */
264
+ export const InsiderTradeSourceEnum = {
265
+ SecApi: 'sec_api',
266
+ F345: 'f345'
267
+ } as const;
268
+ export type InsiderTradeSourceEnum = typeof InsiderTradeSourceEnum[keyof typeof InsiderTradeSourceEnum] | (string & {});
269
+
160
270
 
161
271
  /**
162
272
  * Check if a given object implements the InsiderTrade interface.
@@ -179,6 +289,20 @@ export function instanceOfInsiderTrade(value: object): value is InsiderTrade {
179
289
  if (!('total' in value) || value['total'] === undefined) return false;
180
290
  if (!('shares_owned_following_transaction' in value) || value['shares_owned_following_transaction'] === undefined) return false;
181
291
  if (!('side' in value) || value['side'] === undefined) return false;
292
+ if (!('transaction_date' in value) || value['transaction_date'] === undefined) return false;
293
+ if (!('deemed_execution_date' in value) || value['deemed_execution_date'] === undefined) return false;
294
+ if (!('owner_cik' in value) || value['owner_cik'] === undefined) return false;
295
+ if (!('direct_indirect' in value) || value['direct_indirect'] === undefined) return false;
296
+ if (!('nature_of_ownership' in value) || value['nature_of_ownership'] === undefined) return false;
297
+ if (!('is_derivative' in value) || value['is_derivative'] === undefined) return false;
298
+ if (!('conversion_exercise_price' in value) || value['conversion_exercise_price'] === undefined) return false;
299
+ if (!('exercise_date' in value) || value['exercise_date'] === undefined) return false;
300
+ if (!('expiration_date' in value) || value['expiration_date'] === undefined) return false;
301
+ if (!('underlying_security_title' in value) || value['underlying_security_title'] === undefined) return false;
302
+ if (!('underlying_shares' in value) || value['underlying_shares'] === undefined) return false;
303
+ if (!('footnotes' in value) || value['footnotes'] === undefined) return false;
304
+ if (!('is_10b5_1' in value) || value['is_10b5_1'] === undefined) return false;
305
+ if (!('source' in value) || value['source'] === undefined) return false;
182
306
  return true;
183
307
  }
184
308
 
@@ -213,6 +337,20 @@ export function InsiderTradeFromJSONTyped(json: any, ignoreDiscriminator: boolea
213
337
  'shares_owned_following_transaction': json['shares_owned_following_transaction'],
214
338
  'shares_owned_before_transaction': json['shares_owned_before_transaction'] == null ? undefined : json['shares_owned_before_transaction'],
215
339
  'side': json['side'],
340
+ 'transaction_date': (json['transaction_date'] == null ? null : new Date(json['transaction_date'])),
341
+ 'deemed_execution_date': (json['deemed_execution_date'] == null ? null : new Date(json['deemed_execution_date'])),
342
+ 'owner_cik': json['owner_cik'],
343
+ 'direct_indirect': json['direct_indirect'],
344
+ 'nature_of_ownership': json['nature_of_ownership'],
345
+ 'is_derivative': json['is_derivative'],
346
+ 'conversion_exercise_price': json['conversion_exercise_price'],
347
+ 'exercise_date': (json['exercise_date'] == null ? null : new Date(json['exercise_date'])),
348
+ 'expiration_date': (json['expiration_date'] == null ? null : new Date(json['expiration_date'])),
349
+ 'underlying_security_title': json['underlying_security_title'],
350
+ 'underlying_shares': json['underlying_shares'],
351
+ 'footnotes': (json['footnotes'] == null ? null : (json['footnotes'] as Array<any>).map(InsiderTradeFootnoteFromJSON)),
352
+ 'is_10b5_1': json['is_10b5_1'],
353
+ 'source': json['source'],
216
354
  };
217
355
  }
218
356
 
@@ -248,6 +386,20 @@ export function InsiderTradeToJSONTyped(value?: InsiderTrade | null, ignoreDiscr
248
386
  'shares_owned_following_transaction': value['shares_owned_following_transaction'],
249
387
  'shares_owned_before_transaction': value['shares_owned_before_transaction'],
250
388
  'side': value['side'],
389
+ 'transaction_date': value['transaction_date'] == null ? value['transaction_date'] : value['transaction_date'].toISOString().substring(0,10),
390
+ 'deemed_execution_date': value['deemed_execution_date'] == null ? value['deemed_execution_date'] : value['deemed_execution_date'].toISOString().substring(0,10),
391
+ 'owner_cik': value['owner_cik'],
392
+ 'direct_indirect': value['direct_indirect'],
393
+ 'nature_of_ownership': value['nature_of_ownership'],
394
+ 'is_derivative': value['is_derivative'],
395
+ 'conversion_exercise_price': value['conversion_exercise_price'],
396
+ 'exercise_date': value['exercise_date'] == null ? value['exercise_date'] : value['exercise_date'].toISOString().substring(0,10),
397
+ 'expiration_date': value['expiration_date'] == null ? value['expiration_date'] : value['expiration_date'].toISOString().substring(0,10),
398
+ 'underlying_security_title': value['underlying_security_title'],
399
+ 'underlying_shares': value['underlying_shares'],
400
+ 'footnotes': (value['footnotes'] == null ? null : (value['footnotes'] as Array<any>).map(InsiderTradeFootnoteToJSON)),
401
+ 'is_10b5_1': value['is_10b5_1'],
402
+ 'source': value['source'],
251
403
  };
252
404
  }
253
405
 
@@ -0,0 +1,75 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * One footnote of an insider filing
18
+ * @export
19
+ * @interface InsiderTradeFootnote
20
+ */
21
+ export interface InsiderTradeFootnote {
22
+ /**
23
+ * Footnote id as filed (F1, F2, …)
24
+ * @type {string}
25
+ * @memberof InsiderTradeFootnote
26
+ */
27
+ id: string;
28
+ /**
29
+ * Footnote text
30
+ * @type {string}
31
+ * @memberof InsiderTradeFootnote
32
+ */
33
+ text: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the InsiderTradeFootnote interface.
38
+ */
39
+ export function instanceOfInsiderTradeFootnote(value: object): value is InsiderTradeFootnote {
40
+ if (!('id' in value) || value['id'] === undefined) return false;
41
+ if (!('text' in value) || value['text'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function InsiderTradeFootnoteFromJSON(json: any): InsiderTradeFootnote {
46
+ return InsiderTradeFootnoteFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function InsiderTradeFootnoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): InsiderTradeFootnote {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'id': json['id'],
56
+ 'text': json['text'],
57
+ };
58
+ }
59
+
60
+ export function InsiderTradeFootnoteToJSON(json: any): InsiderTradeFootnote {
61
+ return InsiderTradeFootnoteToJSONTyped(json, false);
62
+ }
63
+
64
+ export function InsiderTradeFootnoteToJSONTyped(value?: InsiderTradeFootnote | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'id': value['id'],
72
+ 'text': value['text'],
73
+ };
74
+ }
75
+
@@ -0,0 +1,108 @@
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
+ import { mapValues } from '../runtime';
16
+ import type { ListHoldings200ResponseMeta } from './ListHoldings200ResponseMeta';
17
+ import {
18
+ ListHoldings200ResponseMetaFromJSON,
19
+ ListHoldings200ResponseMetaFromJSONTyped,
20
+ ListHoldings200ResponseMetaToJSON,
21
+ ListHoldings200ResponseMetaToJSONTyped,
22
+ } from './ListHoldings200ResponseMeta';
23
+ import type { FundHolding } from './FundHolding';
24
+ import {
25
+ FundHoldingFromJSON,
26
+ FundHoldingFromJSONTyped,
27
+ FundHoldingToJSON,
28
+ FundHoldingToJSONTyped,
29
+ } from './FundHolding';
30
+
31
+ /**
32
+ * A page of FundHolding rows (the list envelope, R3)
33
+ * @export
34
+ * @interface ListFundHoldings200Response
35
+ */
36
+ export interface ListFundHoldings200Response {
37
+ /**
38
+ * The rows of this page
39
+ * @type {Array<FundHolding>}
40
+ * @memberof ListFundHoldings200Response
41
+ */
42
+ data: Array<FundHolding>;
43
+ /**
44
+ * true when a next page exists
45
+ * @type {boolean}
46
+ * @memberof ListFundHoldings200Response
47
+ */
48
+ has_more: boolean;
49
+ /**
50
+ * Opaque cursor of the next page; null on the last page
51
+ * @type {string}
52
+ * @memberof ListFundHoldings200Response
53
+ */
54
+ next_cursor: string | null;
55
+ /**
56
+ *
57
+ * @type {ListHoldings200ResponseMeta}
58
+ * @memberof ListFundHoldings200Response
59
+ */
60
+ meta: ListHoldings200ResponseMeta;
61
+ }
62
+
63
+ /**
64
+ * Check if a given object implements the ListFundHoldings200Response interface.
65
+ */
66
+ export function instanceOfListFundHoldings200Response(value: object): value is ListFundHoldings200Response {
67
+ if (!('data' in value) || value['data'] === undefined) return false;
68
+ if (!('has_more' in value) || value['has_more'] === undefined) return false;
69
+ if (!('next_cursor' in value) || value['next_cursor'] === undefined) return false;
70
+ if (!('meta' in value) || value['meta'] === undefined) return false;
71
+ return true;
72
+ }
73
+
74
+ export function ListFundHoldings200ResponseFromJSON(json: any): ListFundHoldings200Response {
75
+ return ListFundHoldings200ResponseFromJSONTyped(json, false);
76
+ }
77
+
78
+ export function ListFundHoldings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListFundHoldings200Response {
79
+ if (json == null) {
80
+ return json;
81
+ }
82
+ return {
83
+
84
+ 'data': ((json['data'] as Array<any>).map(FundHoldingFromJSON)),
85
+ 'has_more': json['has_more'],
86
+ 'next_cursor': json['next_cursor'],
87
+ 'meta': ListHoldings200ResponseMetaFromJSON(json['meta']),
88
+ };
89
+ }
90
+
91
+ export function ListFundHoldings200ResponseToJSON(json: any): ListFundHoldings200Response {
92
+ return ListFundHoldings200ResponseToJSONTyped(json, false);
93
+ }
94
+
95
+ export function ListFundHoldings200ResponseToJSONTyped(value?: ListFundHoldings200Response | null, ignoreDiscriminator: boolean = false): any {
96
+ if (value == null) {
97
+ return value;
98
+ }
99
+
100
+ return {
101
+
102
+ 'data': ((value['data'] as Array<any>).map(FundHoldingToJSON)),
103
+ 'has_more': value['has_more'],
104
+ 'next_cursor': value['next_cursor'],
105
+ 'meta': ListHoldings200ResponseMetaToJSON(value['meta']),
106
+ };
107
+ }
108
+