@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,93 @@
1
+
2
+ # FilerFundSeries
3
+
4
+ One fund series of a registered investment company
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `fund_key` | string
11
+ `series_id` | string
12
+ `series_name` | string
13
+ `registrant_cik` | string
14
+ `is_etf` | boolean
15
+ `is_index` | boolean
16
+ `is_fund_of_funds` | boolean
17
+ `is_money_market` | boolean
18
+ `is_target_date` | boolean
19
+ `exchange` | string
20
+ `share_classes` | [Array<FilerFundShareClass>](FilerFundShareClass.md)
21
+ `advisers` | [Array<FilerFundAdviser>](FilerFundAdviser.md)
22
+ `expense_ratio_net` | number
23
+ `expense_ratio_gross` | number
24
+ `expense_ratio_as_of` | Date
25
+ `expense_ratio_class_id` | string
26
+ `returns` | [Array<FilerFundReturn>](FilerFundReturn.md)
27
+ `creation_unit_shares` | number
28
+ `redeemed_creation_unit_shares` | number
29
+ `creation_cash_pct_avg` | number
30
+ `authorized_participant_count` | number
31
+ `net_assets_usd` | number
32
+ `net_assets_as_of` | Date
33
+ `net_assets_scope` | string
34
+ `latest_report_date` | Date
35
+ `ncen_report_period` | Date
36
+ `rr_report_period` | Date
37
+ `ncen_accession_number` | string
38
+ `rr_accession_number` | string
39
+ `nport_accession_number` | string
40
+
41
+ ## Example
42
+
43
+ ```typescript
44
+ import type { FilerFundSeries } from '@invinite-org/data-api-client'
45
+
46
+ // TODO: Update the object below with actual values
47
+ const example = {
48
+ "fund_key": S000002277,
49
+ "series_id": null,
50
+ "series_name": null,
51
+ "registrant_cik": null,
52
+ "is_etf": null,
53
+ "is_index": null,
54
+ "is_fund_of_funds": null,
55
+ "is_money_market": null,
56
+ "is_target_date": null,
57
+ "exchange": ARCX,
58
+ "share_classes": null,
59
+ "advisers": null,
60
+ "expense_ratio_net": 0.00030,
61
+ "expense_ratio_gross": null,
62
+ "expense_ratio_as_of": null,
63
+ "expense_ratio_class_id": null,
64
+ "returns": null,
65
+ "creation_unit_shares": null,
66
+ "redeemed_creation_unit_shares": null,
67
+ "creation_cash_pct_avg": null,
68
+ "authorized_participant_count": null,
69
+ "net_assets_usd": null,
70
+ "net_assets_as_of": null,
71
+ "net_assets_scope": null,
72
+ "latest_report_date": null,
73
+ "ncen_report_period": null,
74
+ "rr_report_period": null,
75
+ "ncen_accession_number": null,
76
+ "rr_accession_number": null,
77
+ "nport_accession_number": null,
78
+ } satisfies FilerFundSeries
79
+
80
+ console.log(example)
81
+
82
+ // Convert the instance to a JSON string
83
+ const exampleJSON: string = JSON.stringify(example)
84
+ console.log(exampleJSON)
85
+
86
+ // Parse the JSON string back to an object
87
+ const exampleParsed = JSON.parse(exampleJSON) as FilerFundSeries
88
+ console.log(exampleParsed)
89
+ ```
90
+
91
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
92
+
93
+
@@ -0,0 +1,39 @@
1
+
2
+ # FilerFundShareClass
3
+
4
+ One share class of a fund series
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `class_id` | string
11
+ `ticker` | string
12
+ `class_name` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { FilerFundShareClass } from '@invinite-org/data-api-client'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "class_id": C000007593,
22
+ "ticker": null,
23
+ "class_name": null,
24
+ } satisfies FilerFundShareClass
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as FilerFundShareClass
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,45 @@
1
+
2
+ # FilerPrivateOfferings
3
+
4
+ Summary of the Form D offerings naming the filer (primary issuer or co-issuer)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `count` | number
11
+ `first_filed` | Date
12
+ `latest_filed` | Date
13
+ `total_sold` | number
14
+ `latest_exemptions` | Array<string>
15
+ `latest_offering_id` | string
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { FilerPrivateOfferings } from '@invinite-org/data-api-client'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "count": null,
25
+ "first_filed": null,
26
+ "latest_filed": null,
27
+ "total_sold": null,
28
+ "latest_exemptions": null,
29
+ "latest_offering_id": null,
30
+ } satisfies FilerPrivateOfferings
31
+
32
+ console.log(example)
33
+
34
+ // Convert the instance to a JSON string
35
+ const exampleJSON: string = JSON.stringify(example)
36
+ console.log(exampleJSON)
37
+
38
+ // Parse the JSON string back to an object
39
+ const exampleParsed = JSON.parse(exampleJSON) as FilerPrivateOfferings
40
+ console.log(exampleParsed)
41
+ ```
42
+
43
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
44
+
45
+
@@ -0,0 +1,70 @@
1
+
2
+ # FundHolding
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `fund_key` | string
10
+ `series_id` | string
11
+ `series_name` | string
12
+ `registrant_cik` | string
13
+ `registrant_name` | string
14
+ `class_tickers` | Array<string>
15
+ `report_date` | Date
16
+ `accession_number` | string
17
+ `issuer_cik` | string
18
+ `issuer_name` | string
19
+ `cusip` | string
20
+ `isin` | string
21
+ `ticker` | string
22
+ `value_usd` | number
23
+ `pct_nav` | number
24
+ `balance` | number
25
+ `unit` | string
26
+ `asset_cat` | string
27
+ `issuer_resolution` | string
28
+
29
+ ## Example
30
+
31
+ ```typescript
32
+ import type { FundHolding } from '@invinite-org/data-api-client'
33
+
34
+ // TODO: Update the object below with actual values
35
+ const example = {
36
+ "fund_key": null,
37
+ "series_id": null,
38
+ "series_name": null,
39
+ "registrant_cik": null,
40
+ "registrant_name": null,
41
+ "class_tickers": null,
42
+ "report_date": null,
43
+ "accession_number": null,
44
+ "issuer_cik": null,
45
+ "issuer_name": null,
46
+ "cusip": null,
47
+ "isin": null,
48
+ "ticker": null,
49
+ "value_usd": null,
50
+ "pct_nav": null,
51
+ "balance": null,
52
+ "unit": null,
53
+ "asset_cat": null,
54
+ "issuer_resolution": null,
55
+ } satisfies FundHolding
56
+
57
+ console.log(example)
58
+
59
+ // Convert the instance to a JSON string
60
+ const exampleJSON: string = JSON.stringify(example)
61
+ console.log(exampleJSON)
62
+
63
+ // Parse the JSON string back to an object
64
+ const exampleParsed = JSON.parse(exampleJSON) as FundHolding
65
+ console.log(exampleParsed)
66
+ ```
67
+
68
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
69
+
70
+
@@ -4,11 +4,116 @@ All URIs are relative to *https://api.data.invinite.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
+ | [**listFundHoldings**](HoldingsApi.md#listfundholdings) | **GET** /v1/fund-holdings | List N-PORT fund holdings |
7
8
  | [**listHoldingChanges**](HoldingsApi.md#listholdingchanges) | **GET** /v1/holding-changes | List 13F position changes |
8
9
  | [**listHoldings**](HoldingsApi.md#listholdings) | **GET** /v1/holdings | List 13F holdings |
9
10
 
10
11
 
11
12
 
13
+ ## listFundHoldings
14
+
15
+ > ListFundHoldings200Response listFundHoldings(company, filer, series, accession, periodEnd, sort, fields, limit, cursor)
16
+
17
+ List N-PORT fund holdings
18
+
19
+ N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
20
+
21
+ ### Example
22
+
23
+ ```ts
24
+ import {
25
+ Configuration,
26
+ HoldingsApi,
27
+ } from '@invinite-org/data-api-client';
28
+ import type { ListFundHoldingsRequest } from '@invinite-org/data-api-client';
29
+
30
+ async function example() {
31
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
32
+ const config = new Configuration({
33
+ // Configure HTTP bearer authorization: bearerAuth
34
+ accessToken: "YOUR BEARER TOKEN",
35
+ });
36
+ const api = new HoldingsApi(config);
37
+
38
+ const body = {
39
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. (optional)
40
+ company: AAPL,
41
+ // string | Fund registrant CIK (one): its fund portfolio (optional)
42
+ filer: 0000036405,
43
+ // string | SEC series id of one fund (S + 9 digits; a unit investment trust without a series: cik:<registrant CIK>); with filer=, required when the registrant files for more than one fund (optional)
44
+ series: S000002277,
45
+ // string | NPORT-P filing: its reported holdings as filed (optional)
46
+ accession: 0001752724-26-123456,
47
+ // Date | Each fund\'s latest report on or before this date (optional)
48
+ periodEnd: 2026-06-30,
49
+ // '-value_usd' | Sort field: `-value_usd` (the only order the store serves); the id tiebreaker is always appended (optional)
50
+ sort: -value_usd,
51
+ // string | Comma list of root-level fields to keep (R7) (optional)
52
+ fields: fiscal_year,period_end,
53
+ // number | Rows per page (default 25, max 1 000 on 13F rows) (optional)
54
+ limit: 100,
55
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
56
+ cursor: eyJ2IjoyfQ,
57
+ } satisfies ListFundHoldingsRequest;
58
+
59
+ try {
60
+ const data = await api.listFundHoldings(body);
61
+ console.log(data);
62
+ } catch (error) {
63
+ console.error(error);
64
+ }
65
+ }
66
+
67
+ // Run the test
68
+ example().catch(console.error);
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+
74
+ | Name | Type | Description | Notes |
75
+ |------------- | ------------- | ------------- | -------------|
76
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. | [Optional] [Defaults to `undefined`] |
77
+ | **filer** | `string` | Fund registrant CIK (one): its fund portfolio | [Optional] [Defaults to `undefined`] |
78
+ | **series** | `string` | SEC series id of one fund (S + 9 digits; a unit investment trust without a series: cik:&lt;registrant CIK&gt;); with filer&#x3D;, required when the registrant files for more than one fund | [Optional] [Defaults to `undefined`] |
79
+ | **accession** | `string` | NPORT-P filing: its reported holdings as filed | [Optional] [Defaults to `undefined`] |
80
+ | **periodEnd** | `Date` | Each fund\&#39;s latest report on or before this date | [Optional] [Defaults to `undefined`] |
81
+ | **sort** | `-value_usd` | Sort field: &#x60;-value_usd&#x60; (the only order the store serves); the id tiebreaker is always appended | [Optional] [Defaults to `&#39;-value_usd&#39;`] [Enum: -value_usd] |
82
+ | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
83
+ | **limit** | `number` | Rows per page (default 25, max 1 000 on 13F rows) | [Optional] [Defaults to `25`] |
84
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
85
+
86
+ ### Return type
87
+
88
+ [**ListFundHoldings200Response**](ListFundHoldings200Response.md)
89
+
90
+ ### Authorization
91
+
92
+ [bearerAuth](../README.md#bearerAuth)
93
+
94
+ ### HTTP request headers
95
+
96
+ - **Content-Type**: Not defined
97
+ - **Accept**: `application/json`, `application/problem+json`
98
+
99
+
100
+ ### HTTP response details
101
+ | Status code | Description | Response headers |
102
+ |-------------|-------------|------------------|
103
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
104
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
105
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
106
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
107
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
108
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
109
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
110
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
111
+ | **500** | 500: internal | * X-Request-Id - <br> |
112
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
113
+
114
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
115
+
116
+
12
117
  ## listHoldingChanges
13
118
 
14
119
  > ListHoldingChanges200Response listHoldingChanges(company, filer, periodEnd, priorPeriodEnd, type, fields, limit, cursor)
package/docs/IPOsApi.md CHANGED
@@ -5,7 +5,9 @@ All URIs are relative to *https://api.data.invinite.com*
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
7
  | [**getIpo**](IPOsApi.md#getipo) | **GET** /v1/ipos/{ipo_id} | Get an offering |
8
+ | [**getOffering**](IPOsApi.md#getoffering) | **GET** /v1/offerings/{offering_id} | Get a Form D private offering |
8
9
  | [**listIpos**](IPOsApi.md#listipos) | **GET** /v1/ipos | List offerings |
10
+ | [**listOfferings**](IPOsApi.md#listofferings) | **GET** /v1/offerings | List Form D private offerings |
9
11
 
10
12
 
11
13
 
@@ -92,6 +94,89 @@ example().catch(console.error);
92
94
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
93
95
 
94
96
 
97
+ ## getOffering
98
+
99
+ > Offering getOffering(offeringId, fields)
100
+
101
+ Get a Form D private offering
102
+
103
+ One Form D private offering by its id (the Form D file number, e.g. &#x60;021-528681&#x60;), with the latest filing\&#39;s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: &#x60;company&#x3D;&#x60; answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
104
+
105
+ ### Example
106
+
107
+ ```ts
108
+ import {
109
+ Configuration,
110
+ IPOsApi,
111
+ } from '@invinite-org/data-api-client';
112
+ import type { GetOfferingRequest } from '@invinite-org/data-api-client';
113
+
114
+ async function example() {
115
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
116
+ const config = new Configuration({
117
+ // Configure HTTP bearer authorization: bearerAuth
118
+ accessToken: "YOUR BEARER TOKEN",
119
+ });
120
+ const api = new IPOsApi(config);
121
+
122
+ const body = {
123
+ // string | Offering id: the Form D file number, or the first accession number of an offering whose filings state none
124
+ offeringId: 021-528681,
125
+ // string | Comma list of root-level fields to keep (R7) (optional)
126
+ fields: fiscal_year,period_end,
127
+ } satisfies GetOfferingRequest;
128
+
129
+ try {
130
+ const data = await api.getOffering(body);
131
+ console.log(data);
132
+ } catch (error) {
133
+ console.error(error);
134
+ }
135
+ }
136
+
137
+ // Run the test
138
+ example().catch(console.error);
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+
144
+ | Name | Type | Description | Notes |
145
+ |------------- | ------------- | ------------- | -------------|
146
+ | **offeringId** | `string` | Offering id: the Form D file number, or the first accession number of an offering whose filings state none | [Defaults to `undefined`] |
147
+ | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
148
+
149
+ ### Return type
150
+
151
+ [**Offering**](Offering.md)
152
+
153
+ ### Authorization
154
+
155
+ [bearerAuth](../README.md#bearerAuth)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: `application/json`, `application/problem+json`
161
+
162
+
163
+ ### HTTP response details
164
+ | Status code | Description | Response headers |
165
+ |-------------|-------------|------------------|
166
+ | **200** | The resource | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
167
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
168
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
169
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
170
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
171
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
172
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
173
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
174
+ | **500** | 500: internal | * X-Request-Id - <br> |
175
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
176
+
177
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
178
+
179
+
95
180
  ## listIpos
96
181
 
97
182
  > ListIpos200Response listIpos(stage, isSpac, listingDateGte, listingDateGt, listingDateLte, listingDateLt, company, sort, fields, limit, cursor)
@@ -200,3 +285,113 @@ example().catch(console.error);
200
285
 
201
286
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
202
287
 
288
+
289
+ ## listOfferings
290
+
291
+ > ListOfferings200Response listOfferings(company, filedAtGte, filedAtLte, exemption, industry, totalSoldGte, isAmendment, sort, fields, limit, cursor)
292
+
293
+ List Form D private offerings
294
+
295
+ Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\&#39;s quarterly Form D data sets, five years held: one row per offering (SEC\&#39;s Form D file number; every amendment folds into it) with the latest filing\&#39;s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: &#x60;company&#x3D;&#x60; (one issuer CIK or listed ticker), &#x60;filed_at.gte|lte&#x60; (latest filing date), &#x60;exemption&#x3D;&#x60;, &#x60;industry&#x3D;&#x60;, &#x60;total_sold.gte&#x60;, &#x60;is_amendment&#x60;. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: &#x60;company&#x3D;&#x60; answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
296
+
297
+ ### Example
298
+
299
+ ```ts
300
+ import {
301
+ Configuration,
302
+ IPOsApi,
303
+ } from '@invinite-org/data-api-client';
304
+ import type { ListOfferingsRequest } from '@invinite-org/data-api-client';
305
+
306
+ async function example() {
307
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
308
+ const config = new Configuration({
309
+ // Configure HTTP bearer authorization: bearerAuth
310
+ accessToken: "YOUR BEARER TOKEN",
311
+ });
312
+ const api = new IPOsApi(config);
313
+
314
+ const body = {
315
+ // string | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering (optional)
316
+ company: 0001991882,
317
+ // Date | Latest filing on or after this date (optional)
318
+ filedAtGte: 2026-01-01,
319
+ // Date | Latest filing on or before this date (optional)
320
+ filedAtLte: 2026-09-30,
321
+ // string | Offerings claiming this exemption, as filed (06b, 06c, 04, 3C.7, …) (optional)
322
+ exemption: 06c,
323
+ // string | Industry group as filed (case-insensitive exact match) (optional)
324
+ industry: Pooled Investment Fund,
325
+ // number | Total amount sold at least this many USD (optional)
326
+ totalSoldGte: 1000000,
327
+ // boolean | true = offerings whose latest filing is an amendment (D/A); false = an original Form D (optional)
328
+ isAmendment: false,
329
+ // '-filed_latest' | Sort field: `-filed_latest` (the only order the store serves); the offering id tiebreaker is always appended (optional)
330
+ sort: -filed_latest,
331
+ // string | Comma list of root-level fields to keep (R7) (optional)
332
+ fields: fiscal_year,period_end,
333
+ // number | Rows per page (default 25, max 200) (optional)
334
+ limit: 25,
335
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
336
+ cursor: eyJ2IjoyfQ,
337
+ } satisfies ListOfferingsRequest;
338
+
339
+ try {
340
+ const data = await api.listOfferings(body);
341
+ console.log(data);
342
+ } catch (error) {
343
+ console.error(error);
344
+ }
345
+ }
346
+
347
+ // Run the test
348
+ example().catch(console.error);
349
+ ```
350
+
351
+ ### Parameters
352
+
353
+
354
+ | Name | Type | Description | Notes |
355
+ |------------- | ------------- | ------------- | -------------|
356
+ | **company** | `string` | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering | [Optional] [Defaults to `undefined`] |
357
+ | **filedAtGte** | `Date` | Latest filing on or after this date | [Optional] [Defaults to `undefined`] |
358
+ | **filedAtLte** | `Date` | Latest filing on or before this date | [Optional] [Defaults to `undefined`] |
359
+ | **exemption** | `string` | Offerings claiming this exemption, as filed (06b, 06c, 04, 3C.7, …) | [Optional] [Defaults to `undefined`] |
360
+ | **industry** | `string` | Industry group as filed (case-insensitive exact match) | [Optional] [Defaults to `undefined`] |
361
+ | **totalSoldGte** | `number` | Total amount sold at least this many USD | [Optional] [Defaults to `undefined`] |
362
+ | **isAmendment** | `boolean` | true &#x3D; offerings whose latest filing is an amendment (D/A); false &#x3D; an original Form D | [Optional] [Defaults to `undefined`] |
363
+ | **sort** | `-filed_latest` | Sort field: &#x60;-filed_latest&#x60; (the only order the store serves); the offering id tiebreaker is always appended | [Optional] [Defaults to `&#39;-filed_latest&#39;`] [Enum: -filed_latest] |
364
+ | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
365
+ | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
366
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
367
+
368
+ ### Return type
369
+
370
+ [**ListOfferings200Response**](ListOfferings200Response.md)
371
+
372
+ ### Authorization
373
+
374
+ [bearerAuth](../README.md#bearerAuth)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: Not defined
379
+ - **Accept**: `application/json`, `application/problem+json`
380
+
381
+
382
+ ### HTTP response details
383
+ | Status code | Description | Response headers |
384
+ |-------------|-------------|------------------|
385
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
386
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
387
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
388
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
389
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
390
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
391
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
392
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
393
+ | **500** | 500: internal | * X-Request-Id - <br> |
394
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
395
+
396
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
397
+
@@ -27,6 +27,20 @@ Name | Type
27
27
  `shares_owned_following_transaction` | number
28
28
  `shares_owned_before_transaction` | number
29
29
  `side` | string
30
+ `transaction_date` | Date
31
+ `deemed_execution_date` | Date
32
+ `owner_cik` | string
33
+ `direct_indirect` | string
34
+ `nature_of_ownership` | string
35
+ `is_derivative` | boolean
36
+ `conversion_exercise_price` | number
37
+ `exercise_date` | Date
38
+ `expiration_date` | Date
39
+ `underlying_security_title` | string
40
+ `underlying_shares` | number
41
+ `footnotes` | [Array&lt;InsiderTradeFootnote&gt;](InsiderTradeFootnote.md)
42
+ `is_10b5_1` | boolean
43
+ `source` | string
30
44
 
31
45
  ## Example
32
46
 
@@ -56,6 +70,20 @@ const example = {
56
70
  "shares_owned_following_transaction": null,
57
71
  "shares_owned_before_transaction": null,
58
72
  "side": null,
73
+ "transaction_date": Tue Nov 10 01:00:00 CET 2026,
74
+ "deemed_execution_date": null,
75
+ "owner_cik": 0001496686,
76
+ "direct_indirect": D,
77
+ "nature_of_ownership": null,
78
+ "is_derivative": false,
79
+ "conversion_exercise_price": null,
80
+ "exercise_date": null,
81
+ "expiration_date": null,
82
+ "underlying_security_title": null,
83
+ "underlying_shares": null,
84
+ "footnotes": null,
85
+ "is_10b5_1": null,
86
+ "source": sec_api,
59
87
  } satisfies InsiderTrade
60
88
 
61
89
  console.log(example)
@@ -0,0 +1,37 @@
1
+
2
+ # InsiderTradeFootnote
3
+
4
+ One footnote of an insider filing
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `id` | string
11
+ `text` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { InsiderTradeFootnote } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "id": F1,
21
+ "text": null,
22
+ } satisfies InsiderTradeFootnote
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as InsiderTradeFootnote
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+