@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
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A ticker the registration statement says the issuer applied, intends or was approved to list under
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ProposedSymbol
|
|
16
|
+
*/
|
|
17
|
+
export interface ProposedSymbol {
|
|
18
|
+
/**
|
|
19
|
+
* Proposed ticker, upper case (`ABCD.WS` for warrants)
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ProposedSymbol
|
|
22
|
+
*/
|
|
23
|
+
symbol: string;
|
|
24
|
+
/**
|
|
25
|
+
* NASDAQ, NYSE, NYSE American, NYSE Arca or Cboe BZX; null when the prospectus names none
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ProposedSymbol
|
|
28
|
+
*/
|
|
29
|
+
exchange: string | null;
|
|
30
|
+
/**
|
|
31
|
+
* common, ads, units, warrants, rights, preferred or other
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ProposedSymbol
|
|
34
|
+
*/
|
|
35
|
+
security_class: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* How it was read: regex or llm
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ProposedSymbol
|
|
40
|
+
*/
|
|
41
|
+
source: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* The ticker and issuer name are also on the Massive IPO calendar (GET /v1/ipos) — a hint, not an identity
|
|
44
|
+
* @type {boolean}
|
|
45
|
+
* @memberof ProposedSymbol
|
|
46
|
+
*/
|
|
47
|
+
ipo_calendar_match: boolean;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the ProposedSymbol interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfProposedSymbol(value: object): value is ProposedSymbol;
|
|
53
|
+
export declare function ProposedSymbolFromJSON(json: any): ProposedSymbol;
|
|
54
|
+
export declare function ProposedSymbolFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProposedSymbol;
|
|
55
|
+
export declare function ProposedSymbolToJSON(json: any): ProposedSymbol;
|
|
56
|
+
export declare function ProposedSymbolToJSONTyped(value?: ProposedSymbol | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfProposedSymbol = instanceOfProposedSymbol;
|
|
17
|
+
exports.ProposedSymbolFromJSON = ProposedSymbolFromJSON;
|
|
18
|
+
exports.ProposedSymbolFromJSONTyped = ProposedSymbolFromJSONTyped;
|
|
19
|
+
exports.ProposedSymbolToJSON = ProposedSymbolToJSON;
|
|
20
|
+
exports.ProposedSymbolToJSONTyped = ProposedSymbolToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ProposedSymbol interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfProposedSymbol(value) {
|
|
25
|
+
if (!('symbol' in value) || value['symbol'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('exchange' in value) || value['exchange'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('security_class' in value) || value['security_class'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('ipo_calendar_match' in value) || value['ipo_calendar_match'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function ProposedSymbolFromJSON(json) {
|
|
38
|
+
return ProposedSymbolFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function ProposedSymbolFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'symbol': json['symbol'],
|
|
46
|
+
'exchange': json['exchange'],
|
|
47
|
+
'security_class': json['security_class'],
|
|
48
|
+
'source': json['source'],
|
|
49
|
+
'ipo_calendar_match': json['ipo_calendar_match'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
function ProposedSymbolToJSON(json) {
|
|
53
|
+
return ProposedSymbolToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
function ProposedSymbolToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'symbol': value['symbol'],
|
|
61
|
+
'exchange': value['exchange'],
|
|
62
|
+
'security_class': value['security_class'],
|
|
63
|
+
'source': value['source'],
|
|
64
|
+
'ipo_calendar_match': value['ipo_calendar_match'],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { SearchCoverageLeg } from './SearchCoverageLeg';
|
|
13
13
|
/**
|
|
14
|
-
* How much of the searched scope the
|
|
14
|
+
* How much of the searched scope the text index covers
|
|
15
15
|
* @export
|
|
16
16
|
* @interface SearchCoverage
|
|
17
17
|
*/
|
|
@@ -28,12 +28,6 @@ export interface SearchCoverage {
|
|
|
28
28
|
* @memberof SearchCoverage
|
|
29
29
|
*/
|
|
30
30
|
lexical: SearchCoverageLeg | null;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {SearchCoverageLeg}
|
|
34
|
-
* @memberof SearchCoverage
|
|
35
|
-
*/
|
|
36
|
-
semantic: SearchCoverageLeg | null;
|
|
37
31
|
/**
|
|
38
32
|
* Why the answer may be incomplete
|
|
39
33
|
* @type {Array<SearchCoverageReasonsEnum>}
|
|
@@ -56,10 +50,6 @@ export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEn
|
|
|
56
50
|
export declare const SearchCoverageReasonsEnum: {
|
|
57
51
|
readonly LexicalBackfillPending: "lexical_backfill_pending";
|
|
58
52
|
readonly ProjectionFailed: "projection_failed";
|
|
59
|
-
readonly SemanticIndexMissing: "semantic_index_missing";
|
|
60
|
-
readonly SemanticBackfillPending: "semantic_backfill_pending";
|
|
61
|
-
readonly LexicalUnavailable: "lexical_unavailable";
|
|
62
|
-
readonly SemanticUnavailable: "semantic_unavailable";
|
|
63
53
|
readonly CoverageUnavailable: "coverage_unavailable";
|
|
64
54
|
};
|
|
65
55
|
export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
|
|
@@ -34,10 +34,6 @@ exports.SearchCoverageCompletenessEnum = {
|
|
|
34
34
|
exports.SearchCoverageReasonsEnum = {
|
|
35
35
|
LexicalBackfillPending: 'lexical_backfill_pending',
|
|
36
36
|
ProjectionFailed: 'projection_failed',
|
|
37
|
-
SemanticIndexMissing: 'semantic_index_missing',
|
|
38
|
-
SemanticBackfillPending: 'semantic_backfill_pending',
|
|
39
|
-
LexicalUnavailable: 'lexical_unavailable',
|
|
40
|
-
SemanticUnavailable: 'semantic_unavailable',
|
|
41
37
|
CoverageUnavailable: 'coverage_unavailable'
|
|
42
38
|
};
|
|
43
39
|
/**
|
|
@@ -48,8 +44,6 @@ function instanceOfSearchCoverage(value) {
|
|
|
48
44
|
return false;
|
|
49
45
|
if (!('lexical' in value) || value['lexical'] === undefined)
|
|
50
46
|
return false;
|
|
51
|
-
if (!('semantic' in value) || value['semantic'] === undefined)
|
|
52
|
-
return false;
|
|
53
47
|
if (!('reasons' in value) || value['reasons'] === undefined)
|
|
54
48
|
return false;
|
|
55
49
|
return true;
|
|
@@ -64,7 +58,6 @@ function SearchCoverageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
64
58
|
return {
|
|
65
59
|
'completeness': json['completeness'],
|
|
66
60
|
'lexical': (0, SearchCoverageLeg_1.SearchCoverageLegFromJSON)(json['lexical']),
|
|
67
|
-
'semantic': (0, SearchCoverageLeg_1.SearchCoverageLegFromJSON)(json['semantic']),
|
|
68
61
|
'reasons': json['reasons'],
|
|
69
62
|
};
|
|
70
63
|
}
|
|
@@ -78,7 +71,6 @@ function SearchCoverageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
78
71
|
return {
|
|
79
72
|
'completeness': value['completeness'],
|
|
80
73
|
'lexical': (0, SearchCoverageLeg_1.SearchCoverageLegToJSON)(value['lexical']),
|
|
81
|
-
'semantic': (0, SearchCoverageLeg_1.SearchCoverageLegToJSON)(value['semantic']),
|
|
82
74
|
'reasons': value['reasons'],
|
|
83
75
|
};
|
|
84
76
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The
|
|
13
|
+
* The text index (lexical and literal); null when the counts could not be read
|
|
14
14
|
* @export
|
|
15
15
|
* @interface SearchCoverageLeg
|
|
16
16
|
*/
|
|
@@ -17,11 +17,11 @@ import type { SecFilingsList200ResponseCompaniesInnerFilingsInner } from './SecF
|
|
|
17
17
|
*/
|
|
18
18
|
export interface SecFilingsList200ResponseCompaniesInner {
|
|
19
19
|
/**
|
|
20
|
-
* Ticker symbol
|
|
20
|
+
* Ticker symbol; null for a company that is not listed yet (pre-IPO)
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof SecFilingsList200ResponseCompaniesInner
|
|
23
23
|
*/
|
|
24
|
-
ticker: string;
|
|
24
|
+
ticker: string | null;
|
|
25
25
|
/**
|
|
26
26
|
* CIK (with or without leading zeros)
|
|
27
27
|
* @type {string}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ProposedSymbol } from './ProposedSymbol';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -75,6 +76,12 @@ export interface SecFilingsList200ResponseCompaniesInnerFilingsInner {
|
|
|
75
76
|
* @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
76
77
|
*/
|
|
77
78
|
period_end: Date | null;
|
|
79
|
+
/**
|
|
80
|
+
* Tickers the registration statement proposes (S-1, S-1/A, F-1, F-1/A only). null = not a registration form (or not read), [] = none found
|
|
81
|
+
* @type {Array<ProposedSymbol>}
|
|
82
|
+
* @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
83
|
+
*/
|
|
84
|
+
proposed_symbols: Array<ProposedSymbol> | null;
|
|
78
85
|
}
|
|
79
86
|
/**
|
|
80
87
|
* Check if a given object implements the SecFilingsList200ResponseCompaniesInnerFilingsInner interface.
|
|
@@ -18,6 +18,7 @@ exports.SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSON = SecFilings
|
|
|
18
18
|
exports.SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped = SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped;
|
|
19
19
|
exports.SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSON = SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSON;
|
|
20
20
|
exports.SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped = SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped;
|
|
21
|
+
const ProposedSymbol_1 = require("./ProposedSymbol");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the SecFilingsList200ResponseCompaniesInnerFilingsInner interface.
|
|
23
24
|
*/
|
|
@@ -42,6 +43,8 @@ function instanceOfSecFilingsList200ResponseCompaniesInnerFilingsInner(value) {
|
|
|
42
43
|
return false;
|
|
43
44
|
if (!('period_end' in value) || value['period_end'] === undefined)
|
|
44
45
|
return false;
|
|
46
|
+
if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined)
|
|
47
|
+
return false;
|
|
45
48
|
return true;
|
|
46
49
|
}
|
|
47
50
|
function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSON(json) {
|
|
@@ -62,6 +65,7 @@ function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped(json,
|
|
|
62
65
|
'form_type': json['form_type'],
|
|
63
66
|
'html_url': json['html_url'],
|
|
64
67
|
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
68
|
+
'proposed_symbols': (json['proposed_symbols'] == null ? null : json['proposed_symbols'].map(ProposedSymbol_1.ProposedSymbolFromJSON)),
|
|
65
69
|
};
|
|
66
70
|
}
|
|
67
71
|
function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSON(json) {
|
|
@@ -82,5 +86,6 @@ function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(value, i
|
|
|
82
86
|
'form_type': value['form_type'],
|
|
83
87
|
'html_url': value['html_url'],
|
|
84
88
|
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0, 10),
|
|
89
|
+
'proposed_symbols': (value['proposed_symbols'] == null ? null : value['proposed_symbols'].map(ProposedSymbol_1.ProposedSymbolToJSON)),
|
|
85
90
|
};
|
|
86
91
|
}
|
|
@@ -9,8 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ProposedSymbol } from './ProposedSymbol';
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
+
* 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
|
|
14
15
|
* @export
|
|
15
16
|
* @interface WebSocketFiling
|
|
16
17
|
*/
|
|
@@ -75,6 +76,18 @@ export interface WebSocketFiling {
|
|
|
75
76
|
* @memberof WebSocketFiling
|
|
76
77
|
*/
|
|
77
78
|
period_end: Date | null;
|
|
79
|
+
/**
|
|
80
|
+
* Ticker of the company's primary listing; null for a company that is not listed yet (pre-IPO)
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof WebSocketFiling
|
|
83
|
+
*/
|
|
84
|
+
ticker: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Tickers a registration statement (S-1, S-1/A, F-1, F-1/A) proposes; null when the filing carries none
|
|
87
|
+
* @type {Array<ProposedSymbol>}
|
|
88
|
+
* @memberof WebSocketFiling
|
|
89
|
+
*/
|
|
90
|
+
proposed_symbols: Array<ProposedSymbol> | null;
|
|
78
91
|
}
|
|
79
92
|
/**
|
|
80
93
|
* Check if a given object implements the WebSocketFiling interface.
|
|
@@ -18,6 +18,7 @@ exports.WebSocketFilingFromJSON = WebSocketFilingFromJSON;
|
|
|
18
18
|
exports.WebSocketFilingFromJSONTyped = WebSocketFilingFromJSONTyped;
|
|
19
19
|
exports.WebSocketFilingToJSON = WebSocketFilingToJSON;
|
|
20
20
|
exports.WebSocketFilingToJSONTyped = WebSocketFilingToJSONTyped;
|
|
21
|
+
const ProposedSymbol_1 = require("./ProposedSymbol");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the WebSocketFiling interface.
|
|
23
24
|
*/
|
|
@@ -42,6 +43,10 @@ function instanceOfWebSocketFiling(value) {
|
|
|
42
43
|
return false;
|
|
43
44
|
if (!('period_end' in value) || value['period_end'] === undefined)
|
|
44
45
|
return false;
|
|
46
|
+
if (!('ticker' in value) || value['ticker'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined)
|
|
49
|
+
return false;
|
|
45
50
|
return true;
|
|
46
51
|
}
|
|
47
52
|
function WebSocketFilingFromJSON(json) {
|
|
@@ -62,6 +67,8 @@ function WebSocketFilingFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
62
67
|
'form_type': json['form_type'],
|
|
63
68
|
'html_url': json['html_url'],
|
|
64
69
|
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
70
|
+
'ticker': json['ticker'],
|
|
71
|
+
'proposed_symbols': (json['proposed_symbols'] == null ? null : json['proposed_symbols'].map(ProposedSymbol_1.ProposedSymbolFromJSON)),
|
|
65
72
|
};
|
|
66
73
|
}
|
|
67
74
|
function WebSocketFilingToJSON(json) {
|
|
@@ -82,5 +89,7 @@ function WebSocketFilingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
82
89
|
'form_type': value['form_type'],
|
|
83
90
|
'html_url': value['html_url'],
|
|
84
91
|
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0, 10),
|
|
92
|
+
'ticker': value['ticker'],
|
|
93
|
+
'proposed_symbols': (value['proposed_symbols'] == null ? null : value['proposed_symbols'].map(ProposedSymbol_1.ProposedSymbolToJSON)),
|
|
85
94
|
};
|
|
86
95
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -140,6 +140,11 @@ export * from './InstitutionalOwnershipTransactions200ResponseTransactionsInner'
|
|
|
140
140
|
export * from './InternalServerError';
|
|
141
141
|
export * from './IposList200Response';
|
|
142
142
|
export * from './IposList200ResponseIposInner';
|
|
143
|
+
export * from './IposList200ResponseIposInnerRegistration';
|
|
144
|
+
export * from './IposRegistrationsList200Response';
|
|
145
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInner';
|
|
146
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
|
|
147
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
|
|
143
148
|
export * from './MarketHolidays200Response';
|
|
144
149
|
export * from './MarketHolidays200ResponseHolidaysInner';
|
|
145
150
|
export * from './MatchSpan';
|
|
@@ -150,6 +155,7 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
|
|
|
150
155
|
export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
|
|
151
156
|
export * from './NotFoundError';
|
|
152
157
|
export * from './PresentationFact';
|
|
158
|
+
export * from './ProposedSymbol';
|
|
153
159
|
export * from './SearchCoverage';
|
|
154
160
|
export * from './SearchCoverageLeg';
|
|
155
161
|
export * from './SecFilingsAvailableFormTypes200Response';
|
package/dist/models/index.js
CHANGED
|
@@ -158,6 +158,11 @@ __exportStar(require("./InstitutionalOwnershipTransactions200ResponseTransaction
|
|
|
158
158
|
__exportStar(require("./InternalServerError"), exports);
|
|
159
159
|
__exportStar(require("./IposList200Response"), exports);
|
|
160
160
|
__exportStar(require("./IposList200ResponseIposInner"), exports);
|
|
161
|
+
__exportStar(require("./IposList200ResponseIposInnerRegistration"), exports);
|
|
162
|
+
__exportStar(require("./IposRegistrationsList200Response"), exports);
|
|
163
|
+
__exportStar(require("./IposRegistrationsList200ResponseRegistrationsInner"), exports);
|
|
164
|
+
__exportStar(require("./IposRegistrationsList200ResponseRegistrationsInnerFilingsInner"), exports);
|
|
165
|
+
__exportStar(require("./IposRegistrationsList200ResponseRegistrationsInnerMassive"), exports);
|
|
161
166
|
__exportStar(require("./MarketHolidays200Response"), exports);
|
|
162
167
|
__exportStar(require("./MarketHolidays200ResponseHolidaysInner"), exports);
|
|
163
168
|
__exportStar(require("./MatchSpan"), exports);
|
|
@@ -168,6 +173,7 @@ __exportStar(require("./MetadataAvailableSectionIds200ResponseFormTypesInner"),
|
|
|
168
173
|
__exportStar(require("./MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner"), exports);
|
|
169
174
|
__exportStar(require("./NotFoundError"), exports);
|
|
170
175
|
__exportStar(require("./PresentationFact"), exports);
|
|
176
|
+
__exportStar(require("./ProposedSymbol"), exports);
|
|
171
177
|
__exportStar(require("./SearchCoverage"), exports);
|
|
172
178
|
__exportStar(require("./SearchCoverageLeg"), exports);
|
|
173
179
|
__exportStar(require("./SecFilingsAvailableFormTypes200Response"), exports);
|
package/docs/EarningsCallsApi.md
CHANGED
|
@@ -601,7 +601,7 @@ example().catch(console.error);
|
|
|
601
601
|
|
|
602
602
|
Search investor documents
|
|
603
603
|
|
|
604
|
-
Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
604
|
+
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.
|
|
605
605
|
|
|
606
606
|
### Example
|
|
607
607
|
|
|
@@ -621,10 +621,10 @@ async function example() {
|
|
|
621
621
|
const api = new EarningsCallsApi(config);
|
|
622
622
|
|
|
623
623
|
const body = {
|
|
624
|
-
// string | The keywords
|
|
624
|
+
// string | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for
|
|
625
625
|
q: Azure growth,
|
|
626
|
-
// 'lexical' | 'literal' |
|
|
627
|
-
mode:
|
|
626
|
+
// 'lexical' | 'literal' | lexical (keywords and phrases, default) or literal (exact characters) (optional)
|
|
627
|
+
mode: lexical,
|
|
628
628
|
// 'true' | 'false' | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) (optional)
|
|
629
629
|
caseSensitive: false,
|
|
630
630
|
// string | Search one company\'s documents (ticker or CIK, US only) (optional)
|
|
@@ -658,8 +658,8 @@ example().catch(console.error);
|
|
|
658
658
|
|
|
659
659
|
| Name | Type | Description | Notes |
|
|
660
660
|
|------------- | ------------- | ------------- | -------------|
|
|
661
|
-
| **q** | `string` | The keywords
|
|
662
|
-
| **mode** | `lexical`, `literal
|
|
661
|
+
| **q** | `string` | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for | [Defaults to `undefined`] |
|
|
662
|
+
| **mode** | `lexical`, `literal` | lexical (keywords and phrases, default) or literal (exact characters) | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
663
663
|
| **caseSensitive** | `true`, `false` | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
664
664
|
| **identifier** | `string` | Search one company\'s documents (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
|
|
665
665
|
| **kind** | `Array<string>` | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing | [Optional] |
|
|
@@ -689,7 +689,6 @@ example().catch(console.error);
|
|
|
689
689
|
| **400** | Bad Request - Invalid request parameters | - |
|
|
690
690
|
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
691
691
|
| **404** | Not Found - Resource not found | - |
|
|
692
|
-
| **429** | Rate limited (Retry-After) | - |
|
|
693
692
|
| **500** | Internal Server Error - Server error occurred | - |
|
|
694
693
|
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
695
694
|
|
|
@@ -1972,7 +1971,7 @@ example().catch(console.error);
|
|
|
1972
1971
|
|
|
1973
1972
|
Search earnings calls
|
|
1974
1973
|
|
|
1975
|
-
\"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
1974
|
+
\"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.
|
|
1976
1975
|
|
|
1977
1976
|
### Example
|
|
1978
1977
|
|
|
@@ -1992,10 +1991,10 @@ async function example() {
|
|
|
1992
1991
|
const api = new EarningsCallsApi(config);
|
|
1993
1992
|
|
|
1994
1993
|
const body = {
|
|
1995
|
-
// string | The keywords
|
|
1994
|
+
// string | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for
|
|
1996
1995
|
q: Azure growth,
|
|
1997
|
-
// 'lexical' | 'literal' |
|
|
1998
|
-
mode:
|
|
1996
|
+
// 'lexical' | 'literal' | lexical (keywords and phrases, default) or literal (exact characters) (optional)
|
|
1997
|
+
mode: lexical,
|
|
1999
1998
|
// 'true' | 'false' | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) (optional)
|
|
2000
1999
|
caseSensitive: false,
|
|
2001
2000
|
// string | Search one call (optional)
|
|
@@ -2031,8 +2030,8 @@ example().catch(console.error);
|
|
|
2031
2030
|
|
|
2032
2031
|
| Name | Type | Description | Notes |
|
|
2033
2032
|
|------------- | ------------- | ------------- | -------------|
|
|
2034
|
-
| **q** | `string` | The keywords
|
|
2035
|
-
| **mode** | `lexical`, `literal
|
|
2033
|
+
| **q** | `string` | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for | [Defaults to `undefined`] |
|
|
2034
|
+
| **mode** | `lexical`, `literal` | lexical (keywords and phrases, default) or literal (exact characters) | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
2036
2035
|
| **caseSensitive** | `true`, `false` | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
2037
2036
|
| **eventId** | `string` | Search one call | [Optional] [Defaults to `undefined`] |
|
|
2038
2037
|
| **identifier** | `string` | Search one company\'s calls (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
|
|
@@ -2063,7 +2062,6 @@ example().catch(console.error);
|
|
|
2063
2062
|
| **400** | Bad Request - Invalid request parameters | - |
|
|
2064
2063
|
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2065
2064
|
| **404** | Not Found - Resource not found | - |
|
|
2066
|
-
| **429** | Rate limited (Retry-After) | - |
|
|
2067
2065
|
| **500** | Internal Server Error - Server error occurred | - |
|
|
2068
2066
|
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
2069
2067
|
|
package/docs/HitMatch.md
CHANGED
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`type` | string
|
|
11
11
|
`lexical_rank` | number
|
|
12
|
-
`semantic_rank` | number
|
|
13
12
|
`spans` | [Array<MatchSpan>](MatchSpan.md)
|
|
14
13
|
|
|
15
14
|
## Example
|
|
@@ -21,7 +20,6 @@ import type { HitMatch } from '@invinite-org/data-api-client'
|
|
|
21
20
|
const example = {
|
|
22
21
|
"type": null,
|
|
23
22
|
"lexical_rank": null,
|
|
24
|
-
"semantic_rank": null,
|
|
25
23
|
"spans": null,
|
|
26
24
|
} satisfies HitMatch
|
|
27
25
|
|