@invinite-org/data-api-client 0.4.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/EarningsCallsApi.d.ts +4 -8
- package/dist/apis/EarningsCallsApi.js +6 -10
- 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/EarningsCallsApi.d.ts +4 -8
- package/dist/esm/apis/EarningsCallsApi.js +6 -10
- 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/EarningsCallsDocumentSearch200Response.d.ts +0 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +1 -3
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +0 -2
- package/dist/esm/models/EarningsCallsSearch200Response.js +1 -3
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/HitMatch.d.ts +4 -12
- package/dist/esm/models/HitMatch.js +1 -7
- 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/SearchCoverage.d.ts +1 -11
- package/dist/esm/models/SearchCoverage.js +0 -8
- package/dist/esm/models/SearchCoverageLeg.d.ts +1 -1
- 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/EarningsCallsDocumentSearch200Response.d.ts +0 -2
- package/dist/models/EarningsCallsDocumentSearch200Response.js +1 -3
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/EarningsCallsSearch200Response.d.ts +0 -2
- package/dist/models/EarningsCallsSearch200Response.js +1 -3
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/HitMatch.d.ts +4 -12
- package/dist/models/HitMatch.js +1 -7
- 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/SearchCoverage.d.ts +1 -11
- package/dist/models/SearchCoverage.js +0 -8
- package/dist/models/SearchCoverageLeg.d.ts +1 -1
- 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/EarningsCallsApi.md +12 -14
- package/docs/HitMatch.md +0 -2
- 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/SearchCoverage.md +1 -3
- package/docs/SearchCoverageLeg.md +1 -1
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +2 -0
- package/docs/WebSocketFiling.md +5 -0
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +6 -10
- package/src/apis/IPOsApi.ts +121 -2
- package/src/apis/SECFilingsApi.ts +2 -2
- package/src/models/EarningsCallsDocumentSearch200Response.ts +1 -3
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -1
- package/src/models/EarningsCallsSearch200Response.ts +1 -3
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +1 -1
- package/src/models/HitMatch.ts +5 -16
- 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/SearchCoverage.ts +1 -14
- package/src/models/SearchCoverageLeg.ts +1 -1
- 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`] |
|
package/docs/SearchCoverage.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# SearchCoverage
|
|
3
3
|
|
|
4
|
-
How much of the searched scope the
|
|
4
|
+
How much of the searched scope the text index covers
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`completeness` | string
|
|
11
11
|
`lexical` | [SearchCoverageLeg](SearchCoverageLeg.md)
|
|
12
|
-
`semantic` | [SearchCoverageLeg](SearchCoverageLeg.md)
|
|
13
12
|
`reasons` | Array<string>
|
|
14
13
|
|
|
15
14
|
## Example
|
|
@@ -21,7 +20,6 @@ import type { SearchCoverage } from '@invinite-org/data-api-client'
|
|
|
21
20
|
const example = {
|
|
22
21
|
"completeness": null,
|
|
23
22
|
"lexical": null,
|
|
24
|
-
"semantic": null,
|
|
25
23
|
"reasons": null,
|
|
26
24
|
} satisfies SearchCoverage
|
|
27
25
|
|
|
@@ -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
|
@@ -1008,7 +1008,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1008
1008
|
}
|
|
1009
1009
|
|
|
1010
1010
|
/**
|
|
1011
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
1011
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1012
1012
|
* Search investor documents
|
|
1013
1013
|
*/
|
|
1014
1014
|
async earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>> {
|
|
@@ -1019,7 +1019,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1019
1019
|
}
|
|
1020
1020
|
|
|
1021
1021
|
/**
|
|
1022
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
1022
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1023
1023
|
* Search investor documents
|
|
1024
1024
|
*/
|
|
1025
1025
|
async earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response> {
|
|
@@ -2141,7 +2141,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2141
2141
|
}
|
|
2142
2142
|
|
|
2143
2143
|
/**
|
|
2144
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
2144
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
2145
2145
|
* Search earnings calls
|
|
2146
2146
|
*/
|
|
2147
2147
|
async earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>> {
|
|
@@ -2152,7 +2152,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2152
2152
|
}
|
|
2153
2153
|
|
|
2154
2154
|
/**
|
|
2155
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
2155
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
2156
2156
|
* Search earnings calls
|
|
2157
2157
|
*/
|
|
2158
2158
|
async earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response> {
|
|
@@ -2944,9 +2944,7 @@ export type EarningsCallsDiffVsEnum = typeof EarningsCallsDiffVsEnum[keyof typeo
|
|
|
2944
2944
|
*/
|
|
2945
2945
|
export const EarningsCallsDocumentSearchModeEnum = {
|
|
2946
2946
|
Lexical: 'lexical',
|
|
2947
|
-
Literal: 'literal'
|
|
2948
|
-
Semantic: 'semantic',
|
|
2949
|
-
Hybrid: 'hybrid'
|
|
2947
|
+
Literal: 'literal'
|
|
2950
2948
|
} as const;
|
|
2951
2949
|
export type EarningsCallsDocumentSearchModeEnum = typeof EarningsCallsDocumentSearchModeEnum[keyof typeof EarningsCallsDocumentSearchModeEnum];
|
|
2952
2950
|
/**
|
|
@@ -3157,9 +3155,7 @@ export type EarningsCallsQaIncludeEnum = typeof EarningsCallsQaIncludeEnum[keyof
|
|
|
3157
3155
|
*/
|
|
3158
3156
|
export const EarningsCallsSearchModeEnum = {
|
|
3159
3157
|
Lexical: 'lexical',
|
|
3160
|
-
Literal: 'literal'
|
|
3161
|
-
Semantic: 'semantic',
|
|
3162
|
-
Hybrid: 'hybrid'
|
|
3158
|
+
Literal: 'literal'
|
|
3163
3159
|
} as const;
|
|
3164
3160
|
export type EarningsCallsSearchModeEnum = typeof EarningsCallsSearchModeEnum[keyof typeof EarningsCallsSearchModeEnum];
|
|
3165
3161
|
/**
|