@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,64 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Invinite API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2026-11-13
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfListOfferings200Response = instanceOfListOfferings200Response;
17
+ exports.ListOfferings200ResponseFromJSON = ListOfferings200ResponseFromJSON;
18
+ exports.ListOfferings200ResponseFromJSONTyped = ListOfferings200ResponseFromJSONTyped;
19
+ exports.ListOfferings200ResponseToJSON = ListOfferings200ResponseToJSON;
20
+ exports.ListOfferings200ResponseToJSONTyped = ListOfferings200ResponseToJSONTyped;
21
+ const ListOfferings200ResponseMeta_1 = require("./ListOfferings200ResponseMeta");
22
+ const Offering_1 = require("./Offering");
23
+ /**
24
+ * Check if a given object implements the ListOfferings200Response interface.
25
+ */
26
+ function instanceOfListOfferings200Response(value) {
27
+ if (!('data' in value) || value['data'] === undefined)
28
+ return false;
29
+ if (!('has_more' in value) || value['has_more'] === undefined)
30
+ return false;
31
+ if (!('next_cursor' in value) || value['next_cursor'] === undefined)
32
+ return false;
33
+ if (!('meta' in value) || value['meta'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ function ListOfferings200ResponseFromJSON(json) {
38
+ return ListOfferings200ResponseFromJSONTyped(json, false);
39
+ }
40
+ function ListOfferings200ResponseFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'data': (json['data'].map(Offering_1.OfferingFromJSON)),
46
+ 'has_more': json['has_more'],
47
+ 'next_cursor': json['next_cursor'],
48
+ 'meta': (0, ListOfferings200ResponseMeta_1.ListOfferings200ResponseMetaFromJSON)(json['meta']),
49
+ };
50
+ }
51
+ function ListOfferings200ResponseToJSON(json) {
52
+ return ListOfferings200ResponseToJSONTyped(json, false);
53
+ }
54
+ function ListOfferings200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'data': (value['data'].map(Offering_1.OfferingToJSON)),
60
+ 'has_more': value['has_more'],
61
+ 'next_cursor': value['next_cursor'],
62
+ 'meta': (0, ListOfferings200ResponseMeta_1.ListOfferings200ResponseMetaToJSON)(value['meta']),
63
+ };
64
+ }
@@ -0,0 +1,39 @@
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 { MetaCoverage } from './MetaCoverage';
13
+ /**
14
+ * Page metadata
15
+ * @export
16
+ * @interface ListOfferings200ResponseMeta
17
+ */
18
+ export interface ListOfferings200ResponseMeta {
19
+ /**
20
+ *
21
+ * @type {MetaCoverage}
22
+ * @memberof ListOfferings200ResponseMeta
23
+ */
24
+ coverage?: MetaCoverage;
25
+ /**
26
+ * Instant the page reads the offerings at
27
+ * @type {Date}
28
+ * @memberof ListOfferings200ResponseMeta
29
+ */
30
+ pinned_at?: Date | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the ListOfferings200ResponseMeta interface.
34
+ */
35
+ export declare function instanceOfListOfferings200ResponseMeta(value: object): value is ListOfferings200ResponseMeta;
36
+ export declare function ListOfferings200ResponseMetaFromJSON(json: any): ListOfferings200ResponseMeta;
37
+ export declare function ListOfferings200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOfferings200ResponseMeta;
38
+ export declare function ListOfferings200ResponseMetaToJSON(json: any): ListOfferings200ResponseMeta;
39
+ export declare function ListOfferings200ResponseMetaToJSONTyped(value?: ListOfferings200ResponseMeta | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Invinite API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2026-11-13
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfListOfferings200ResponseMeta = instanceOfListOfferings200ResponseMeta;
17
+ exports.ListOfferings200ResponseMetaFromJSON = ListOfferings200ResponseMetaFromJSON;
18
+ exports.ListOfferings200ResponseMetaFromJSONTyped = ListOfferings200ResponseMetaFromJSONTyped;
19
+ exports.ListOfferings200ResponseMetaToJSON = ListOfferings200ResponseMetaToJSON;
20
+ exports.ListOfferings200ResponseMetaToJSONTyped = ListOfferings200ResponseMetaToJSONTyped;
21
+ const MetaCoverage_1 = require("./MetaCoverage");
22
+ /**
23
+ * Check if a given object implements the ListOfferings200ResponseMeta interface.
24
+ */
25
+ function instanceOfListOfferings200ResponseMeta(value) {
26
+ return true;
27
+ }
28
+ function ListOfferings200ResponseMetaFromJSON(json) {
29
+ return ListOfferings200ResponseMetaFromJSONTyped(json, false);
30
+ }
31
+ function ListOfferings200ResponseMetaFromJSONTyped(json, ignoreDiscriminator) {
32
+ if (json == null) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'coverage': json['coverage'] == null ? undefined : (0, MetaCoverage_1.MetaCoverageFromJSON)(json['coverage']),
37
+ 'pinned_at': json['pinned_at'] == null ? undefined : (new Date(json['pinned_at'])),
38
+ };
39
+ }
40
+ function ListOfferings200ResponseMetaToJSON(json) {
41
+ return ListOfferings200ResponseMetaToJSONTyped(json, false);
42
+ }
43
+ function ListOfferings200ResponseMetaToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'coverage': (0, MetaCoverage_1.MetaCoverageToJSON)(value['coverage']),
49
+ 'pinned_at': value['pinned_at'] == null ? value['pinned_at'] : value['pinned_at'].toISOString(),
50
+ };
51
+ }
@@ -0,0 +1,275 @@
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 { OfferingRelatedPerson } from './OfferingRelatedPerson';
13
+ /**
14
+ * One Form D private offering (Regulation D / Section 4(a)(5) exempt offering): the latest filing's facts and the held filing history
15
+ * @export
16
+ * @interface Offering
17
+ */
18
+ export interface Offering {
19
+ /**
20
+ * Offering id: SEC's Form D file number (one per offering; every amendment keeps it), or the first accession number for an offering whose filings state none
21
+ * @type {string}
22
+ * @memberof Offering
23
+ */
24
+ offering_id: string;
25
+ /**
26
+ * Form D file number (021-…); null when the offering is keyed by its first accession
27
+ * @type {string}
28
+ * @memberof Offering
29
+ */
30
+ file_number: string | null;
31
+ /**
32
+ * Accession number of the earliest held filing of the offering
33
+ * @type {string}
34
+ * @memberof Offering
35
+ */
36
+ first_accession: string;
37
+ /**
38
+ * Accession number of the latest filing (the row's facts are from it)
39
+ * @type {string}
40
+ * @memberof Offering
41
+ */
42
+ latest_accession: string;
43
+ /**
44
+ * Accession numbers of the held filings, in filing order
45
+ * @type {Array<string>}
46
+ * @memberof Offering
47
+ */
48
+ accessions: Array<string>;
49
+ /**
50
+ * Primary issuer CIK, 10 digits
51
+ * @type {string}
52
+ * @memberof Offering
53
+ */
54
+ primary_issuer_cik: string;
55
+ /**
56
+ * Primary issuer name as filed
57
+ * @type {string}
58
+ * @memberof Offering
59
+ */
60
+ issuer_name: string | null;
61
+ /**
62
+ * CIKs of the other issuers of the offering, 10 digits
63
+ * @type {Array<string>}
64
+ * @memberof Offering
65
+ */
66
+ co_issuer_ciks: Array<string>;
67
+ /**
68
+ * Filing date of the earliest held filing
69
+ * @type {Date}
70
+ * @memberof Offering
71
+ */
72
+ filed_first: Date | null;
73
+ /**
74
+ * Filing date of the latest filing
75
+ * @type {Date}
76
+ * @memberof Offering
77
+ */
78
+ filed_latest: Date | null;
79
+ /**
80
+ * Date of first sale as filed
81
+ * @type {Date}
82
+ * @memberof Offering
83
+ */
84
+ sale_date: Date | null;
85
+ /**
86
+ * The first sale has yet to occur
87
+ * @type {boolean}
88
+ * @memberof Offering
89
+ */
90
+ first_sale_yet_to_occur: boolean | null;
91
+ /**
92
+ * Number of held amendments (D/A)
93
+ * @type {number}
94
+ * @memberof Offering
95
+ */
96
+ amendment_count: number;
97
+ /**
98
+ * The original Form D is inside the held window (five years of quarterly data sets); false = the history starts with an amendment
99
+ * @type {boolean}
100
+ * @memberof Offering
101
+ */
102
+ original_held: boolean;
103
+ /**
104
+ * The latest filing is an amendment (D/A)
105
+ * @type {boolean}
106
+ * @memberof Offering
107
+ */
108
+ is_amendment: boolean;
109
+ /**
110
+ * Federal exemptions and exclusions claimed, as filed: 06b (Rule 506(b)), 06c (Rule 506(c)), 04 (Rule 504), 4a5, 3C, 3C.1, 3C.7, …
111
+ * @type {Array<string>}
112
+ * @memberof Offering
113
+ */
114
+ exemptions: Array<string>;
115
+ /**
116
+ * Industry group as filed (Pooled Investment Fund, Other Technology, …)
117
+ * @type {string}
118
+ * @memberof Offering
119
+ */
120
+ industry_group: string | null;
121
+ /**
122
+ * Investment fund type as filed (Hedge Fund, Private Equity Fund, …)
123
+ * @type {string}
124
+ * @memberof Offering
125
+ */
126
+ investment_fund_type: string | null;
127
+ /**
128
+ * The issuer is registered (or must register) under the Investment Company Act of 1940
129
+ * @type {boolean}
130
+ * @memberof Offering
131
+ */
132
+ is_40_act: boolean | null;
133
+ /**
134
+ * Types of securities offered
135
+ * @type {Array<OfferingSecurityTypesEnum>}
136
+ * @memberof Offering
137
+ */
138
+ security_types: Array<OfferingSecurityTypesEnum>;
139
+ /**
140
+ * The offering is made in connection with a business combination
141
+ * @type {boolean}
142
+ * @memberof Offering
143
+ */
144
+ is_business_combination: boolean | null;
145
+ /**
146
+ * The offering is expected to last more than one year
147
+ * @type {boolean}
148
+ * @memberof Offering
149
+ */
150
+ more_than_one_year: boolean | null;
151
+ /**
152
+ * Minimum investment accepted from an outside investor (USD)
153
+ * @type {number}
154
+ * @memberof Offering
155
+ */
156
+ min_investment: number | null;
157
+ /**
158
+ * Total offering amount (USD); null when indefinite
159
+ * @type {number}
160
+ * @memberof Offering
161
+ */
162
+ total_offering_amount: number | null;
163
+ /**
164
+ * Total amount sold (USD)
165
+ * @type {number}
166
+ * @memberof Offering
167
+ */
168
+ total_sold: number | null;
169
+ /**
170
+ * Total amount remaining to be sold (USD); null when indefinite
171
+ * @type {number}
172
+ * @memberof Offering
173
+ */
174
+ total_remaining: number | null;
175
+ /**
176
+ * The offering amount is stated as indefinite
177
+ * @type {boolean}
178
+ * @memberof Offering
179
+ */
180
+ indefinite_amount: boolean;
181
+ /**
182
+ * Securities were sold to non-accredited investors
183
+ * @type {boolean}
184
+ * @memberof Offering
185
+ */
186
+ has_non_accredited: boolean | null;
187
+ /**
188
+ * Number of non-accredited investors who invested
189
+ * @type {number}
190
+ * @memberof Offering
191
+ */
192
+ non_accredited_count: number | null;
193
+ /**
194
+ * Total number of investors who invested
195
+ * @type {number}
196
+ * @memberof Offering
197
+ */
198
+ investor_count: number | null;
199
+ /**
200
+ * Issuer revenue range as filed (No Revenues, $1 - $1,000,000, Decline to Disclose, …)
201
+ * @type {string}
202
+ * @memberof Offering
203
+ */
204
+ revenue_range: string | null;
205
+ /**
206
+ * Issuer net asset value range as filed (funds)
207
+ * @type {string}
208
+ * @memberof Offering
209
+ */
210
+ net_asset_value_range: string | null;
211
+ /**
212
+ * Sales commissions (USD)
213
+ * @type {number}
214
+ * @memberof Offering
215
+ */
216
+ sales_commission: number | null;
217
+ /**
218
+ * Finders' fees (USD)
219
+ * @type {number}
220
+ * @memberof Offering
221
+ */
222
+ finders_fee: number | null;
223
+ /**
224
+ * Related persons as filed
225
+ * @type {Array<OfferingRelatedPerson>}
226
+ * @memberof Offering
227
+ */
228
+ related_persons: Array<OfferingRelatedPerson>;
229
+ /**
230
+ * SIC code of the issuer
231
+ * @type {string}
232
+ * @memberof Offering
233
+ */
234
+ sic_code: string | null;
235
+ /**
236
+ * Jurisdiction of incorporation as filed
237
+ * @type {string}
238
+ * @memberof Offering
239
+ */
240
+ jurisdiction: string | null;
241
+ /**
242
+ * Entity type as filed (Corporation, Limited Partnership, …)
243
+ * @type {string}
244
+ * @memberof Offering
245
+ */
246
+ entity_type: string | null;
247
+ /**
248
+ * Year of incorporation as filed (a year, or Over Five Years / Within Last Five Years)
249
+ * @type {string}
250
+ * @memberof Offering
251
+ */
252
+ year_of_inc: string | null;
253
+ }
254
+ /**
255
+ * @export
256
+ */
257
+ export declare const OfferingSecurityTypesEnum: {
258
+ readonly Equity: "equity";
259
+ readonly Debt: "debt";
260
+ readonly OptionToAcquire: "option_to_acquire";
261
+ readonly SecurityToBeAcquired: "security_to_be_acquired";
262
+ readonly PooledInvestmentFund: "pooled_investment_fund";
263
+ readonly TenantInCommon: "tenant_in_common";
264
+ readonly MineralProperty: "mineral_property";
265
+ readonly Other: "other";
266
+ };
267
+ export type OfferingSecurityTypesEnum = typeof OfferingSecurityTypesEnum[keyof typeof OfferingSecurityTypesEnum] | (string & {});
268
+ /**
269
+ * Check if a given object implements the Offering interface.
270
+ */
271
+ export declare function instanceOfOffering(value: object): value is Offering;
272
+ export declare function OfferingFromJSON(json: any): Offering;
273
+ export declare function OfferingFromJSONTyped(json: any, ignoreDiscriminator: boolean): Offering;
274
+ export declare function OfferingToJSON(json: any): Offering;
275
+ export declare function OfferingToJSONTyped(value?: Offering | null, ignoreDiscriminator?: boolean): any;