@invinite-org/data-api-client 0.5.0 → 0.6.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.
- package/.openapi-generator/FILES +12 -0
- package/dist/apis/IPOsApi.d.ts +55 -2
- package/dist/apis/IPOsApi.js +95 -3
- package/dist/apis/SECFilingsApi.d.ts +2 -2
- package/dist/apis/SECFilingsApi.js +2 -2
- package/dist/esm/apis/IPOsApi.d.ts +55 -2
- package/dist/esm/apis/IPOsApi.js +94 -2
- package/dist/esm/apis/SECFilingsApi.d.ts +2 -2
- package/dist/esm/apis/SECFilingsApi.js +2 -2
- package/dist/esm/models/IposList200ResponseIposInner.d.ts +7 -0
- package/dist/esm/models/IposList200ResponseIposInner.js +5 -0
- package/dist/esm/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
- package/dist/esm/models/IposList200ResponseIposInnerRegistration.js +67 -0
- package/dist/esm/models/IposRegistrationsList200Response.d.ts +39 -0
- package/dist/esm/models/IposRegistrationsList200Response.js +46 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +149 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +63 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +63 -0
- package/dist/esm/models/ProposedSymbol.d.ts +56 -0
- package/dist/esm/models/ProposedSymbol.js +59 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
- package/dist/esm/models/WebSocketFiling.d.ts +14 -1
- package/dist/esm/models/WebSocketFiling.js +9 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/IposList200ResponseIposInner.d.ts +7 -0
- package/dist/models/IposList200ResponseIposInner.js +5 -0
- package/dist/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
- package/dist/models/IposList200ResponseIposInnerRegistration.js +75 -0
- package/dist/models/IposRegistrationsList200Response.d.ts +39 -0
- package/dist/models/IposRegistrationsList200Response.js +53 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +157 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +70 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +70 -0
- package/dist/models/ProposedSymbol.d.ts +56 -0
- package/dist/models/ProposedSymbol.js +66 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
- package/dist/models/WebSocketFiling.d.ts +14 -1
- package/dist/models/WebSocketFiling.js +9 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/IPOsApi.md +94 -1
- package/docs/IposList200ResponseIposInner.md +2 -0
- package/docs/IposList200ResponseIposInnerRegistration.md +41 -0
- package/docs/IposRegistrationsList200Response.md +36 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +76 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.md +44 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerMassive.md +45 -0
- package/docs/ProposedSymbol.md +43 -0
- package/docs/SECFilingsApi.md +3 -3
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +2 -0
- package/docs/WebSocketFiling.md +5 -0
- package/package.json +1 -1
- package/src/apis/IPOsApi.ts +121 -2
- package/src/apis/SECFilingsApi.ts +2 -2
- package/src/models/IposList200ResponseIposInner.ts +17 -0
- package/src/models/IposList200ResponseIposInnerRegistration.ts +109 -0
- package/src/models/IposRegistrationsList200Response.ts +82 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +302 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.ts +111 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.ts +111 -0
- package/src/models/ProposedSymbol.ts +102 -0
- package/src/models/SecFilingsList200ResponseCompaniesInner.ts +2 -2
- package/src/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.ts +17 -0
- package/src/models/WebSocketFiling.ts +27 -1
- package/src/models/index.ts +6 -0
package/docs/IPOsApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.data.invinite.com*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**iposList**](IPOsApi.md#iposlist) | **GET** /v1/ipos | List IPOs |
|
|
8
|
+
| [**iposRegistrationsList**](IPOsApi.md#iposregistrationslist) | **GET** /v1/ipos/registrations | List IPO registrations (SEC) |
|
|
8
9
|
|
|
9
10
|
|
|
10
11
|
|
|
@@ -14,7 +15,7 @@ All URIs are relative to *https://api.data.invinite.com*
|
|
|
14
15
|
|
|
15
16
|
List IPOs
|
|
16
17
|
|
|
17
|
-
List all IPOs. Minimum tier for redistribute: PRO.
|
|
18
|
+
List all IPOs of the Massive IPO calendar, keyed by ticker; rows usually appear near pricing. `registration` links a row to the SEC-sourced registration track (`GET /v1/ipos/registrations`) Massive matched to the same ticker, or is null. Minimum tier for redistribute: PRO.
|
|
18
19
|
|
|
19
20
|
### Example
|
|
20
21
|
|
|
@@ -93,3 +94,95 @@ example().catch(console.error);
|
|
|
93
94
|
|
|
94
95
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
95
96
|
|
|
97
|
+
|
|
98
|
+
## iposRegistrationsList
|
|
99
|
+
|
|
100
|
+
> IposRegistrationsList200Response iposRegistrationsList(startDate, endDate, stage, isSpac, sort, limit, offset)
|
|
101
|
+
|
|
102
|
+
List IPO registrations (SEC)
|
|
103
|
+
|
|
104
|
+
The SEC-sourced IPO calendar: one row per registration statement of a company that is not listed yet, from its first public S-1 or F-1 until it trades or is withdrawn, keyed by CIK. Each row carries the stage, the proposed ticker(s), the price range and final price from the prospectus, the SEC timestamps of every step, and the filings that moved it. `GET /v1/ipos` is a different source: the Massive IPO calendar, keyed by ticker, whose rows usually appear only near pricing. A registration shows up weeks earlier. `massive` holds the Massive row matched to a registration (by ticker and issuer name), `proposed_symbols[].ipo_calendar_match` flags a proposed ticker that is on that calendar, and each `GET /v1/ipos` row links back through `registration`. Pre-IPO companies have no ticker yet: read their filings with `GET /v1/sec-filings/filings?identifier=<cik>`. Minimum tier for redistribute: PRO.
|
|
105
|
+
|
|
106
|
+
### Example
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
import {
|
|
110
|
+
Configuration,
|
|
111
|
+
IPOsApi,
|
|
112
|
+
} from '@invinite-org/data-api-client';
|
|
113
|
+
import type { IposRegistrationsListRequest } from '@invinite-org/data-api-client';
|
|
114
|
+
|
|
115
|
+
async function example() {
|
|
116
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
117
|
+
const config = new Configuration({
|
|
118
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
119
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
120
|
+
});
|
|
121
|
+
const api = new IPOsApi(config);
|
|
122
|
+
|
|
123
|
+
const body = {
|
|
124
|
+
// Date | Registrations first made public on or after this day (YYYY-MM-DD, UTC) (optional)
|
|
125
|
+
startDate: 2026-09-01,
|
|
126
|
+
// Date | Registrations first made public on or before this day (YYYY-MM-DD, UTC) (optional)
|
|
127
|
+
endDate: 2026-10-31,
|
|
128
|
+
// Array<'registered' | 'price_range' | 'exchange_approved' | 'effective' | 'priced' | 'trading' | 'withdrawn'> | Filter by stage (repeatable). Default: every stage (optional)
|
|
129
|
+
stage: ["priced","trading"],
|
|
130
|
+
// 'true' | 'false' | true = blank-check companies (SPACs) only, false = no SPACs. Default: both (optional)
|
|
131
|
+
isSpac: false,
|
|
132
|
+
// 'asc' | 'desc' | Sort direction by first_public_at (optional)
|
|
133
|
+
sort: desc,
|
|
134
|
+
// number | Maximum number of registrations to return (optional)
|
|
135
|
+
limit: 5,
|
|
136
|
+
// number | Number of registrations to skip for pagination (optional)
|
|
137
|
+
offset: 0,
|
|
138
|
+
} satisfies IposRegistrationsListRequest;
|
|
139
|
+
|
|
140
|
+
try {
|
|
141
|
+
const data = await api.iposRegistrationsList(body);
|
|
142
|
+
console.log(data);
|
|
143
|
+
} catch (error) {
|
|
144
|
+
console.error(error);
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
// Run the test
|
|
149
|
+
example().catch(console.error);
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
| Name | Type | Description | Notes |
|
|
156
|
+
|------------- | ------------- | ------------- | -------------|
|
|
157
|
+
| **startDate** | `Date` | Registrations first made public on or after this day (YYYY-MM-DD, UTC) | [Optional] [Defaults to `undefined`] |
|
|
158
|
+
| **endDate** | `Date` | Registrations first made public on or before this day (YYYY-MM-DD, UTC) | [Optional] [Defaults to `undefined`] |
|
|
159
|
+
| **stage** | `registered`, `price_range`, `exchange_approved`, `effective`, `priced`, `trading`, `withdrawn` | Filter by stage (repeatable). Default: every stage | [Optional] [Enum: registered, price_range, exchange_approved, effective, priced, trading, withdrawn] |
|
|
160
|
+
| **isSpac** | `true`, `false` | true = blank-check companies (SPACs) only, false = no SPACs. Default: both | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
161
|
+
| **sort** | `asc`, `desc` | Sort direction by first_public_at | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
|
|
162
|
+
| **limit** | `number` | Maximum number of registrations to return | [Optional] [Defaults to `100`] |
|
|
163
|
+
| **offset** | `number` | Number of registrations to skip for pagination | [Optional] [Defaults to `0`] |
|
|
164
|
+
|
|
165
|
+
### Return type
|
|
166
|
+
|
|
167
|
+
[**IposRegistrationsList200Response**](IposRegistrationsList200Response.md)
|
|
168
|
+
|
|
169
|
+
### Authorization
|
|
170
|
+
|
|
171
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
172
|
+
|
|
173
|
+
### HTTP request headers
|
|
174
|
+
|
|
175
|
+
- **Content-Type**: Not defined
|
|
176
|
+
- **Accept**: `application/json`
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### HTTP response details
|
|
180
|
+
| Status code | Description | Response headers |
|
|
181
|
+
|-------------|-------------|------------------|
|
|
182
|
+
| **200** | Default Response | - |
|
|
183
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
184
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
185
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
186
|
+
|
|
187
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
188
|
+
|
|
@@ -28,6 +28,7 @@ Name | Type
|
|
|
28
28
|
`ticker` | string
|
|
29
29
|
`total_offer_size` | number
|
|
30
30
|
`us_code` | string
|
|
31
|
+
`registration` | [IposList200ResponseIposInnerRegistration](IposList200ResponseIposInnerRegistration.md)
|
|
31
32
|
|
|
32
33
|
## Example
|
|
33
34
|
|
|
@@ -58,6 +59,7 @@ const example = {
|
|
|
58
59
|
"ticker": null,
|
|
59
60
|
"total_offer_size": null,
|
|
60
61
|
"us_code": null,
|
|
62
|
+
"registration": null,
|
|
61
63
|
} satisfies IposList200ResponseIposInner
|
|
62
64
|
|
|
63
65
|
console.log(example)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# IposList200ResponseIposInnerRegistration
|
|
3
|
+
|
|
4
|
+
The SEC registration track (GET /v1/ipos/registrations) matched to this ticker; null when none is
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`cik` | string
|
|
11
|
+
`track_key` | string
|
|
12
|
+
`stage` | string
|
|
13
|
+
`final_offer_price` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { IposList200ResponseIposInnerRegistration } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"cik": null,
|
|
23
|
+
"track_key": null,
|
|
24
|
+
"stage": null,
|
|
25
|
+
"final_offer_price": null,
|
|
26
|
+
} satisfies IposList200ResponseIposInnerRegistration
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as IposList200ResponseIposInnerRegistration
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# IposRegistrationsList200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`registrations` | [Array<IposRegistrationsList200ResponseRegistrationsInner>](IposRegistrationsList200ResponseRegistrationsInner.md)
|
|
10
|
+
`next_url` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { IposRegistrationsList200Response } from '@invinite-org/data-api-client'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"registrations": null,
|
|
20
|
+
"next_url": null,
|
|
21
|
+
} satisfies IposRegistrationsList200Response
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as IposRegistrationsList200Response
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
|
|
2
|
+
# IposRegistrationsList200ResponseRegistrationsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`cik` | string
|
|
10
|
+
`company_name` | string
|
|
11
|
+
`track_key` | string
|
|
12
|
+
`form_family` | string
|
|
13
|
+
`stage` | string
|
|
14
|
+
`is_spac` | boolean
|
|
15
|
+
`proposed_symbols` | [Array<ProposedSymbol>](ProposedSymbol.md)
|
|
16
|
+
`exchange` | string
|
|
17
|
+
`price_range_low` | string
|
|
18
|
+
`price_range_high` | string
|
|
19
|
+
`shares_offered` | number
|
|
20
|
+
`final_offer_price` | string
|
|
21
|
+
`final_shares_offered` | number
|
|
22
|
+
`first_public_at` | Date
|
|
23
|
+
`price_range_at` | Date
|
|
24
|
+
`exchange_approved_at` | Date
|
|
25
|
+
`effective_at` | Date
|
|
26
|
+
`priced_at` | Date
|
|
27
|
+
`withdrawn_at` | Date
|
|
28
|
+
`first_trade_date` | Date
|
|
29
|
+
`massive` | [IposRegistrationsList200ResponseRegistrationsInnerMassive](IposRegistrationsList200ResponseRegistrationsInnerMassive.md)
|
|
30
|
+
`filings` | [Array<IposRegistrationsList200ResponseRegistrationsInnerFilingsInner>](IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.md)
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import type { IposRegistrationsList200ResponseRegistrationsInner } from '@invinite-org/data-api-client'
|
|
36
|
+
|
|
37
|
+
// TODO: Update the object below with actual values
|
|
38
|
+
const example = {
|
|
39
|
+
"cik": null,
|
|
40
|
+
"company_name": null,
|
|
41
|
+
"track_key": null,
|
|
42
|
+
"form_family": null,
|
|
43
|
+
"stage": null,
|
|
44
|
+
"is_spac": null,
|
|
45
|
+
"proposed_symbols": null,
|
|
46
|
+
"exchange": null,
|
|
47
|
+
"price_range_low": null,
|
|
48
|
+
"price_range_high": null,
|
|
49
|
+
"shares_offered": null,
|
|
50
|
+
"final_offer_price": null,
|
|
51
|
+
"final_shares_offered": null,
|
|
52
|
+
"first_public_at": null,
|
|
53
|
+
"price_range_at": null,
|
|
54
|
+
"exchange_approved_at": null,
|
|
55
|
+
"effective_at": null,
|
|
56
|
+
"priced_at": null,
|
|
57
|
+
"withdrawn_at": null,
|
|
58
|
+
"first_trade_date": null,
|
|
59
|
+
"massive": null,
|
|
60
|
+
"filings": null,
|
|
61
|
+
} satisfies IposRegistrationsList200ResponseRegistrationsInner
|
|
62
|
+
|
|
63
|
+
console.log(example)
|
|
64
|
+
|
|
65
|
+
// Convert the instance to a JSON string
|
|
66
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
67
|
+
console.log(exampleJSON)
|
|
68
|
+
|
|
69
|
+
// Parse the JSON string back to an object
|
|
70
|
+
const exampleParsed = JSON.parse(exampleJSON) as IposRegistrationsList200ResponseRegistrationsInner
|
|
71
|
+
console.log(exampleParsed)
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
75
|
+
|
|
76
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`accession_number` | string
|
|
10
|
+
`form_type` | string
|
|
11
|
+
`signal` | string
|
|
12
|
+
`filed_at` | Date
|
|
13
|
+
`filing_date` | Date
|
|
14
|
+
`html_url` | string
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { IposRegistrationsList200ResponseRegistrationsInnerFilingsInner } from '@invinite-org/data-api-client'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"accession_number": null,
|
|
24
|
+
"form_type": null,
|
|
25
|
+
"signal": null,
|
|
26
|
+
"filed_at": null,
|
|
27
|
+
"filing_date": null,
|
|
28
|
+
"html_url": null,
|
|
29
|
+
} satisfies IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as IposRegistrationsList200ResponseRegistrationsInnerFilingsInner
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
|
|
2
|
+
# IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
3
|
+
|
|
4
|
+
The matching row of the Massive IPO calendar (GET /v1/ipos, by ticker and issuer name); null when none matched. Its values never overwrite the SEC ones
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`ticker` | string
|
|
11
|
+
`ipo_status` | string
|
|
12
|
+
`listing_date` | Date
|
|
13
|
+
`price_low` | string
|
|
14
|
+
`price_high` | string
|
|
15
|
+
`final_price` | string
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { IposRegistrationsList200ResponseRegistrationsInnerMassive } from '@invinite-org/data-api-client'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"ticker": null,
|
|
25
|
+
"ipo_status": null,
|
|
26
|
+
"listing_date": null,
|
|
27
|
+
"price_low": null,
|
|
28
|
+
"price_high": null,
|
|
29
|
+
"final_price": null,
|
|
30
|
+
} satisfies IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
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 IposRegistrationsList200ResponseRegistrationsInnerMassive
|
|
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,43 @@
|
|
|
1
|
+
|
|
2
|
+
# ProposedSymbol
|
|
3
|
+
|
|
4
|
+
A ticker the registration statement says the issuer applied, intends or was approved to list under
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`symbol` | string
|
|
11
|
+
`exchange` | string
|
|
12
|
+
`security_class` | string
|
|
13
|
+
`source` | string
|
|
14
|
+
`ipo_calendar_match` | boolean
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { ProposedSymbol } from '@invinite-org/data-api-client'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"symbol": null,
|
|
24
|
+
"exchange": null,
|
|
25
|
+
"security_class": null,
|
|
26
|
+
"source": null,
|
|
27
|
+
"ipo_calendar_match": null,
|
|
28
|
+
} satisfies ProposedSymbol
|
|
29
|
+
|
|
30
|
+
console.log(example)
|
|
31
|
+
|
|
32
|
+
// Convert the instance to a JSON string
|
|
33
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
34
|
+
console.log(exampleJSON)
|
|
35
|
+
|
|
36
|
+
// Parse the JSON string back to an object
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as ProposedSymbol
|
|
38
|
+
console.log(exampleParsed)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
42
|
+
|
|
43
|
+
|
package/docs/SECFilingsApi.md
CHANGED
|
@@ -92,7 +92,7 @@ example().catch(console.error);
|
|
|
92
92
|
|
|
93
93
|
SEC filings
|
|
94
94
|
|
|
95
|
-
Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
95
|
+
Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
|
|
96
96
|
|
|
97
97
|
### Example
|
|
98
98
|
|
|
@@ -112,7 +112,7 @@ async function example() {
|
|
|
112
112
|
const api = new SECFilingsApi(config);
|
|
113
113
|
|
|
114
114
|
const body = {
|
|
115
|
-
// string | Ticker symbol or CIK
|
|
115
|
+
// string | Ticker symbol or CIK. A CIK also finds a registrant that is not listed yet (pre-IPO).
|
|
116
116
|
identifier: AAPL,
|
|
117
117
|
// string | SEC form type filter (e.g., 10-K, 10-Q, 8-K, 3, 4, 5, 13F-HR). Leave empty to return all form types. (optional)
|
|
118
118
|
formType: 10-K,
|
|
@@ -141,7 +141,7 @@ example().catch(console.error);
|
|
|
141
141
|
|
|
142
142
|
| Name | Type | Description | Notes |
|
|
143
143
|
|------------- | ------------- | ------------- | -------------|
|
|
144
|
-
| **identifier** | `string` | Ticker symbol or CIK | [Defaults to `undefined`] |
|
|
144
|
+
| **identifier** | `string` | Ticker symbol or CIK. A CIK also finds a registrant that is not listed yet (pre-IPO). | [Defaults to `undefined`] |
|
|
145
145
|
| **formType** | `string` | SEC form type filter (e.g., 10-K, 10-Q, 8-K, 3, 4, 5, 13F-HR). Leave empty to return all form types. | [Optional] [Defaults to `undefined`] |
|
|
146
146
|
| **sort** | `asc`, `desc` | Sort direction for filings by filing_date | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
|
|
147
147
|
| **limit** | `number` | Maximum number of filings to return | [Optional] [Defaults to `40`] |
|
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`form_type` | string
|
|
17
17
|
`html_url` | string
|
|
18
18
|
`period_end` | Date
|
|
19
|
+
`proposed_symbols` | [Array<ProposedSymbol>](ProposedSymbol.md)
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const example = {
|
|
|
34
35
|
"form_type": null,
|
|
35
36
|
"html_url": null,
|
|
36
37
|
"period_end": null,
|
|
38
|
+
"proposed_symbols": null,
|
|
37
39
|
} satisfies SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
38
40
|
|
|
39
41
|
console.log(example)
|
package/docs/WebSocketFiling.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# WebSocketFiling
|
|
3
3
|
|
|
4
|
+
A new SEC filing, the same fields as a GET /v1/sec-filings/filings row plus `ticker`. Until 2026-10 the frame forwarded the upstream camelCase envelope (`schemaVersion`, `eventKey`, `filing.accessionNumber`, …) instead of this documented shape; it now is exactly this object
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
@@ -16,6 +17,8 @@ Name | Type
|
|
|
16
17
|
`form_type` | string
|
|
17
18
|
`html_url` | string
|
|
18
19
|
`period_end` | Date
|
|
20
|
+
`ticker` | string
|
|
21
|
+
`proposed_symbols` | [Array<ProposedSymbol>](ProposedSymbol.md)
|
|
19
22
|
|
|
20
23
|
## Example
|
|
21
24
|
|
|
@@ -34,6 +37,8 @@ const example = {
|
|
|
34
37
|
"form_type": null,
|
|
35
38
|
"html_url": null,
|
|
36
39
|
"period_end": null,
|
|
40
|
+
"ticker": null,
|
|
41
|
+
"proposed_symbols": null,
|
|
37
42
|
} satisfies WebSocketFiling
|
|
38
43
|
|
|
39
44
|
console.log(example)
|
package/package.json
CHANGED
package/src/apis/IPOsApi.ts
CHANGED
|
@@ -23,6 +23,11 @@ import {
|
|
|
23
23
|
IposList200ResponseFromJSON,
|
|
24
24
|
IposList200ResponseToJSON,
|
|
25
25
|
} from '../models/IposList200Response';
|
|
26
|
+
import {
|
|
27
|
+
type IposRegistrationsList200Response,
|
|
28
|
+
IposRegistrationsList200ResponseFromJSON,
|
|
29
|
+
IposRegistrationsList200ResponseToJSON,
|
|
30
|
+
} from '../models/IposRegistrationsList200Response';
|
|
26
31
|
|
|
27
32
|
export interface IposListRequest {
|
|
28
33
|
startDate?: Date;
|
|
@@ -32,6 +37,16 @@ export interface IposListRequest {
|
|
|
32
37
|
offset?: number;
|
|
33
38
|
}
|
|
34
39
|
|
|
40
|
+
export interface IposRegistrationsListRequest {
|
|
41
|
+
startDate?: Date;
|
|
42
|
+
endDate?: Date;
|
|
43
|
+
stage?: Array<IposRegistrationsListStageEnum>;
|
|
44
|
+
isSpac?: IposRegistrationsListIsSpacEnum;
|
|
45
|
+
sort?: IposRegistrationsListSortEnum;
|
|
46
|
+
limit?: number;
|
|
47
|
+
offset?: number;
|
|
48
|
+
}
|
|
49
|
+
|
|
35
50
|
/**
|
|
36
51
|
*
|
|
37
52
|
*/
|
|
@@ -85,7 +100,7 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
85
100
|
}
|
|
86
101
|
|
|
87
102
|
/**
|
|
88
|
-
* List all IPOs. Minimum tier for redistribute: PRO.
|
|
103
|
+
* List all IPOs of the Massive IPO calendar, keyed by ticker; rows usually appear near pricing. `registration` links a row to the SEC-sourced registration track (`GET /v1/ipos/registrations`) Massive matched to the same ticker, or is null. Minimum tier for redistribute: PRO.
|
|
89
104
|
* List IPOs
|
|
90
105
|
*/
|
|
91
106
|
async iposListRaw(requestParameters: IposListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IposList200Response>> {
|
|
@@ -96,7 +111,7 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
96
111
|
}
|
|
97
112
|
|
|
98
113
|
/**
|
|
99
|
-
* List all IPOs. Minimum tier for redistribute: PRO.
|
|
114
|
+
* List all IPOs of the Massive IPO calendar, keyed by ticker; rows usually appear near pricing. `registration` links a row to the SEC-sourced registration track (`GET /v1/ipos/registrations`) Massive matched to the same ticker, or is null. Minimum tier for redistribute: PRO.
|
|
100
115
|
* List IPOs
|
|
101
116
|
*/
|
|
102
117
|
async iposList(requestParameters: IposListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IposList200Response> {
|
|
@@ -104,6 +119,81 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
104
119
|
return await response.value();
|
|
105
120
|
}
|
|
106
121
|
|
|
122
|
+
/**
|
|
123
|
+
* Creates request options for iposRegistrationsList without sending the request
|
|
124
|
+
*/
|
|
125
|
+
async iposRegistrationsListRequestOpts(requestParameters: IposRegistrationsListRequest): Promise<runtime.RequestOpts> {
|
|
126
|
+
const queryParameters: any = {};
|
|
127
|
+
|
|
128
|
+
if (requestParameters['startDate'] != null) {
|
|
129
|
+
queryParameters['start_date'] = (requestParameters['startDate'] as any).toISOString().substring(0,10);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
if (requestParameters['endDate'] != null) {
|
|
133
|
+
queryParameters['end_date'] = (requestParameters['endDate'] as any).toISOString().substring(0,10);
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
if (requestParameters['stage'] != null) {
|
|
137
|
+
queryParameters['stage'] = requestParameters['stage'];
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
if (requestParameters['isSpac'] != null) {
|
|
141
|
+
queryParameters['is_spac'] = requestParameters['isSpac'];
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
if (requestParameters['sort'] != null) {
|
|
145
|
+
queryParameters['sort'] = requestParameters['sort'];
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
if (requestParameters['limit'] != null) {
|
|
149
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
if (requestParameters['offset'] != null) {
|
|
153
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
157
|
+
|
|
158
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
159
|
+
const token = this.configuration.accessToken;
|
|
160
|
+
const tokenString = await token("bearerAuth", []);
|
|
161
|
+
|
|
162
|
+
if (tokenString) {
|
|
163
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
let urlPath = `/v1/ipos/registrations`;
|
|
168
|
+
|
|
169
|
+
return {
|
|
170
|
+
path: urlPath,
|
|
171
|
+
method: 'GET',
|
|
172
|
+
headers: headerParameters,
|
|
173
|
+
query: queryParameters,
|
|
174
|
+
};
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* The SEC-sourced IPO calendar: one row per registration statement of a company that is not listed yet, from its first public S-1 or F-1 until it trades or is withdrawn, keyed by CIK. Each row carries the stage, the proposed ticker(s), the price range and final price from the prospectus, the SEC timestamps of every step, and the filings that moved it. `GET /v1/ipos` is a different source: the Massive IPO calendar, keyed by ticker, whose rows usually appear only near pricing. A registration shows up weeks earlier. `massive` holds the Massive row matched to a registration (by ticker and issuer name), `proposed_symbols[].ipo_calendar_match` flags a proposed ticker that is on that calendar, and each `GET /v1/ipos` row links back through `registration`. Pre-IPO companies have no ticker yet: read their filings with `GET /v1/sec-filings/filings?identifier=<cik>`. Minimum tier for redistribute: PRO.
|
|
179
|
+
* List IPO registrations (SEC)
|
|
180
|
+
*/
|
|
181
|
+
async iposRegistrationsListRaw(requestParameters: IposRegistrationsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IposRegistrationsList200Response>> {
|
|
182
|
+
const requestOptions = await this.iposRegistrationsListRequestOpts(requestParameters);
|
|
183
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
184
|
+
|
|
185
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IposRegistrationsList200ResponseFromJSON(jsonValue));
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* The SEC-sourced IPO calendar: one row per registration statement of a company that is not listed yet, from its first public S-1 or F-1 until it trades or is withdrawn, keyed by CIK. Each row carries the stage, the proposed ticker(s), the price range and final price from the prospectus, the SEC timestamps of every step, and the filings that moved it. `GET /v1/ipos` is a different source: the Massive IPO calendar, keyed by ticker, whose rows usually appear only near pricing. A registration shows up weeks earlier. `massive` holds the Massive row matched to a registration (by ticker and issuer name), `proposed_symbols[].ipo_calendar_match` flags a proposed ticker that is on that calendar, and each `GET /v1/ipos` row links back through `registration`. Pre-IPO companies have no ticker yet: read their filings with `GET /v1/sec-filings/filings?identifier=<cik>`. Minimum tier for redistribute: PRO.
|
|
190
|
+
* List IPO registrations (SEC)
|
|
191
|
+
*/
|
|
192
|
+
async iposRegistrationsList(requestParameters: IposRegistrationsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IposRegistrationsList200Response> {
|
|
193
|
+
const response = await this.iposRegistrationsListRaw(requestParameters, initOverrides);
|
|
194
|
+
return await response.value();
|
|
195
|
+
}
|
|
196
|
+
|
|
107
197
|
}
|
|
108
198
|
|
|
109
199
|
/**
|
|
@@ -114,3 +204,32 @@ export const IposListSortEnum = {
|
|
|
114
204
|
Desc: 'desc'
|
|
115
205
|
} as const;
|
|
116
206
|
export type IposListSortEnum = typeof IposListSortEnum[keyof typeof IposListSortEnum];
|
|
207
|
+
/**
|
|
208
|
+
* @export
|
|
209
|
+
*/
|
|
210
|
+
export const IposRegistrationsListStageEnum = {
|
|
211
|
+
Registered: 'registered',
|
|
212
|
+
PriceRange: 'price_range',
|
|
213
|
+
ExchangeApproved: 'exchange_approved',
|
|
214
|
+
Effective: 'effective',
|
|
215
|
+
Priced: 'priced',
|
|
216
|
+
Trading: 'trading',
|
|
217
|
+
Withdrawn: 'withdrawn'
|
|
218
|
+
} as const;
|
|
219
|
+
export type IposRegistrationsListStageEnum = typeof IposRegistrationsListStageEnum[keyof typeof IposRegistrationsListStageEnum];
|
|
220
|
+
/**
|
|
221
|
+
* @export
|
|
222
|
+
*/
|
|
223
|
+
export const IposRegistrationsListIsSpacEnum = {
|
|
224
|
+
True: 'true',
|
|
225
|
+
False: 'false'
|
|
226
|
+
} as const;
|
|
227
|
+
export type IposRegistrationsListIsSpacEnum = typeof IposRegistrationsListIsSpacEnum[keyof typeof IposRegistrationsListIsSpacEnum];
|
|
228
|
+
/**
|
|
229
|
+
* @export
|
|
230
|
+
*/
|
|
231
|
+
export const IposRegistrationsListSortEnum = {
|
|
232
|
+
Asc: 'asc',
|
|
233
|
+
Desc: 'desc'
|
|
234
|
+
} as const;
|
|
235
|
+
export type IposRegistrationsListSortEnum = typeof IposRegistrationsListSortEnum[keyof typeof IposRegistrationsListSortEnum];
|
|
@@ -177,7 +177,7 @@ export class SECFilingsApi extends runtime.BaseAPI {
|
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
/**
|
|
180
|
-
* Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
180
|
+
* Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
|
|
181
181
|
* SEC filings
|
|
182
182
|
*/
|
|
183
183
|
async secFilingsListRaw(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsList200Response>> {
|
|
@@ -188,7 +188,7 @@ export class SECFilingsApi extends runtime.BaseAPI {
|
|
|
188
188
|
}
|
|
189
189
|
|
|
190
190
|
/**
|
|
191
|
-
* Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
191
|
+
* Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
|
|
192
192
|
* SEC filings
|
|
193
193
|
*/
|
|
194
194
|
async secFilingsList(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsList200Response> {
|