@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
|
@@ -384,12 +384,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
384
384
|
*/
|
|
385
385
|
earningsCallsDocumentSearchRequestOpts(requestParameters: EarningsCallsDocumentSearchRequest): Promise<runtime.RequestOpts>;
|
|
386
386
|
/**
|
|
387
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
387
|
+
* 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.
|
|
388
388
|
* Search investor documents
|
|
389
389
|
*/
|
|
390
390
|
earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>>;
|
|
391
391
|
/**
|
|
392
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
392
|
+
* 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.
|
|
393
393
|
* Search investor documents
|
|
394
394
|
*/
|
|
395
395
|
earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response>;
|
|
@@ -594,12 +594,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
594
594
|
*/
|
|
595
595
|
earningsCallsSearchRequestOpts(requestParameters: EarningsCallsSearchRequest): Promise<runtime.RequestOpts>;
|
|
596
596
|
/**
|
|
597
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
597
|
+
* \"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.
|
|
598
598
|
* Search earnings calls
|
|
599
599
|
*/
|
|
600
600
|
earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>>;
|
|
601
601
|
/**
|
|
602
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
602
|
+
* \"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.
|
|
603
603
|
* Search earnings calls
|
|
604
604
|
*/
|
|
605
605
|
earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response>;
|
|
@@ -841,8 +841,6 @@ export type EarningsCallsDiffVsEnum = typeof EarningsCallsDiffVsEnum[keyof typeo
|
|
|
841
841
|
export declare const EarningsCallsDocumentSearchModeEnum: {
|
|
842
842
|
readonly Lexical: "lexical";
|
|
843
843
|
readonly Literal: "literal";
|
|
844
|
-
readonly Semantic: "semantic";
|
|
845
|
-
readonly Hybrid: "hybrid";
|
|
846
844
|
};
|
|
847
845
|
export type EarningsCallsDocumentSearchModeEnum = typeof EarningsCallsDocumentSearchModeEnum[keyof typeof EarningsCallsDocumentSearchModeEnum];
|
|
848
846
|
/**
|
|
@@ -1054,8 +1052,6 @@ export type EarningsCallsQaIncludeEnum = typeof EarningsCallsQaIncludeEnum[keyof
|
|
|
1054
1052
|
export declare const EarningsCallsSearchModeEnum: {
|
|
1055
1053
|
readonly Lexical: "lexical";
|
|
1056
1054
|
readonly Literal: "literal";
|
|
1057
|
-
readonly Semantic: "semantic";
|
|
1058
|
-
readonly Hybrid: "hybrid";
|
|
1059
1055
|
};
|
|
1060
1056
|
export type EarningsCallsSearchModeEnum = typeof EarningsCallsSearchModeEnum[keyof typeof EarningsCallsSearchModeEnum];
|
|
1061
1057
|
/**
|
|
@@ -504,7 +504,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
504
504
|
});
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
507
|
+
* 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.
|
|
508
508
|
* Search investor documents
|
|
509
509
|
*/
|
|
510
510
|
earningsCallsDocumentSearchRaw(requestParameters, initOverrides) {
|
|
@@ -515,7 +515,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
515
515
|
});
|
|
516
516
|
}
|
|
517
517
|
/**
|
|
518
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
518
|
+
* 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.
|
|
519
519
|
* Search investor documents
|
|
520
520
|
*/
|
|
521
521
|
earningsCallsDocumentSearch(requestParameters, initOverrides) {
|
|
@@ -1472,7 +1472,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1472
1472
|
});
|
|
1473
1473
|
}
|
|
1474
1474
|
/**
|
|
1475
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
1475
|
+
* \"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.
|
|
1476
1476
|
* Search earnings calls
|
|
1477
1477
|
*/
|
|
1478
1478
|
earningsCallsSearchRaw(requestParameters, initOverrides) {
|
|
@@ -1483,7 +1483,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1483
1483
|
});
|
|
1484
1484
|
}
|
|
1485
1485
|
/**
|
|
1486
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
1486
|
+
* \"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.
|
|
1487
1487
|
* Search earnings calls
|
|
1488
1488
|
*/
|
|
1489
1489
|
earningsCallsSearch(requestParameters, initOverrides) {
|
|
@@ -2173,9 +2173,7 @@ export const EarningsCallsDiffVsEnum = {
|
|
|
2173
2173
|
*/
|
|
2174
2174
|
export const EarningsCallsDocumentSearchModeEnum = {
|
|
2175
2175
|
Lexical: 'lexical',
|
|
2176
|
-
Literal: 'literal'
|
|
2177
|
-
Semantic: 'semantic',
|
|
2178
|
-
Hybrid: 'hybrid'
|
|
2176
|
+
Literal: 'literal'
|
|
2179
2177
|
};
|
|
2180
2178
|
/**
|
|
2181
2179
|
* @export
|
|
@@ -2363,9 +2361,7 @@ export const EarningsCallsQaIncludeEnum = {
|
|
|
2363
2361
|
*/
|
|
2364
2362
|
export const EarningsCallsSearchModeEnum = {
|
|
2365
2363
|
Lexical: 'lexical',
|
|
2366
|
-
Literal: 'literal'
|
|
2367
|
-
Semantic: 'semantic',
|
|
2368
|
-
Hybrid: 'hybrid'
|
|
2364
|
+
Literal: 'literal'
|
|
2369
2365
|
};
|
|
2370
2366
|
/**
|
|
2371
2367
|
* @export
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { type IposList200Response } from '../models/IposList200Response';
|
|
14
|
+
import { type IposRegistrationsList200Response } from '../models/IposRegistrationsList200Response';
|
|
14
15
|
export interface IposListRequest {
|
|
15
16
|
startDate?: Date;
|
|
16
17
|
endDate?: Date;
|
|
@@ -18,6 +19,15 @@ export interface IposListRequest {
|
|
|
18
19
|
limit?: number;
|
|
19
20
|
offset?: number;
|
|
20
21
|
}
|
|
22
|
+
export interface IposRegistrationsListRequest {
|
|
23
|
+
startDate?: Date;
|
|
24
|
+
endDate?: Date;
|
|
25
|
+
stage?: Array<IposRegistrationsListStageEnum>;
|
|
26
|
+
isSpac?: IposRegistrationsListIsSpacEnum;
|
|
27
|
+
sort?: IposRegistrationsListSortEnum;
|
|
28
|
+
limit?: number;
|
|
29
|
+
offset?: number;
|
|
30
|
+
}
|
|
21
31
|
/**
|
|
22
32
|
*
|
|
23
33
|
*/
|
|
@@ -27,15 +37,29 @@ export declare class IPOsApi extends runtime.BaseAPI {
|
|
|
27
37
|
*/
|
|
28
38
|
iposListRequestOpts(requestParameters: IposListRequest): Promise<runtime.RequestOpts>;
|
|
29
39
|
/**
|
|
30
|
-
* List all IPOs. Minimum tier for redistribute: PRO.
|
|
40
|
+
* 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.
|
|
31
41
|
* List IPOs
|
|
32
42
|
*/
|
|
33
43
|
iposListRaw(requestParameters: IposListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IposList200Response>>;
|
|
34
44
|
/**
|
|
35
|
-
* List all IPOs. Minimum tier for redistribute: PRO.
|
|
45
|
+
* 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.
|
|
36
46
|
* List IPOs
|
|
37
47
|
*/
|
|
38
48
|
iposList(requestParameters?: IposListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IposList200Response>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates request options for iposRegistrationsList without sending the request
|
|
51
|
+
*/
|
|
52
|
+
iposRegistrationsListRequestOpts(requestParameters: IposRegistrationsListRequest): Promise<runtime.RequestOpts>;
|
|
53
|
+
/**
|
|
54
|
+
* 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.
|
|
55
|
+
* List IPO registrations (SEC)
|
|
56
|
+
*/
|
|
57
|
+
iposRegistrationsListRaw(requestParameters: IposRegistrationsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IposRegistrationsList200Response>>;
|
|
58
|
+
/**
|
|
59
|
+
* 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.
|
|
60
|
+
* List IPO registrations (SEC)
|
|
61
|
+
*/
|
|
62
|
+
iposRegistrationsList(requestParameters?: IposRegistrationsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IposRegistrationsList200Response>;
|
|
39
63
|
}
|
|
40
64
|
/**
|
|
41
65
|
* @export
|
|
@@ -45,3 +69,32 @@ export declare const IposListSortEnum: {
|
|
|
45
69
|
readonly Desc: "desc";
|
|
46
70
|
};
|
|
47
71
|
export type IposListSortEnum = typeof IposListSortEnum[keyof typeof IposListSortEnum];
|
|
72
|
+
/**
|
|
73
|
+
* @export
|
|
74
|
+
*/
|
|
75
|
+
export declare const IposRegistrationsListStageEnum: {
|
|
76
|
+
readonly Registered: "registered";
|
|
77
|
+
readonly PriceRange: "price_range";
|
|
78
|
+
readonly ExchangeApproved: "exchange_approved";
|
|
79
|
+
readonly Effective: "effective";
|
|
80
|
+
readonly Priced: "priced";
|
|
81
|
+
readonly Trading: "trading";
|
|
82
|
+
readonly Withdrawn: "withdrawn";
|
|
83
|
+
};
|
|
84
|
+
export type IposRegistrationsListStageEnum = typeof IposRegistrationsListStageEnum[keyof typeof IposRegistrationsListStageEnum];
|
|
85
|
+
/**
|
|
86
|
+
* @export
|
|
87
|
+
*/
|
|
88
|
+
export declare const IposRegistrationsListIsSpacEnum: {
|
|
89
|
+
readonly True: "true";
|
|
90
|
+
readonly False: "false";
|
|
91
|
+
};
|
|
92
|
+
export type IposRegistrationsListIsSpacEnum = typeof IposRegistrationsListIsSpacEnum[keyof typeof IposRegistrationsListIsSpacEnum];
|
|
93
|
+
/**
|
|
94
|
+
* @export
|
|
95
|
+
*/
|
|
96
|
+
export declare const IposRegistrationsListSortEnum: {
|
|
97
|
+
readonly Asc: "asc";
|
|
98
|
+
readonly Desc: "desc";
|
|
99
|
+
};
|
|
100
|
+
export type IposRegistrationsListSortEnum = typeof IposRegistrationsListSortEnum[keyof typeof IposRegistrationsListSortEnum];
|
package/dist/esm/apis/IPOsApi.js
CHANGED
|
@@ -22,6 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
24
|
import { IposList200ResponseFromJSON, } from '../models/IposList200Response';
|
|
25
|
+
import { IposRegistrationsList200ResponseFromJSON, } from '../models/IposRegistrationsList200Response';
|
|
25
26
|
/**
|
|
26
27
|
*
|
|
27
28
|
*/
|
|
@@ -65,7 +66,7 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
65
66
|
});
|
|
66
67
|
}
|
|
67
68
|
/**
|
|
68
|
-
* List all IPOs. Minimum tier for redistribute: PRO.
|
|
69
|
+
* 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.
|
|
69
70
|
* List IPOs
|
|
70
71
|
*/
|
|
71
72
|
iposListRaw(requestParameters, initOverrides) {
|
|
@@ -76,7 +77,7 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
76
77
|
});
|
|
77
78
|
}
|
|
78
79
|
/**
|
|
79
|
-
* List all IPOs. Minimum tier for redistribute: PRO.
|
|
80
|
+
* 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.
|
|
80
81
|
* List IPOs
|
|
81
82
|
*/
|
|
82
83
|
iposList() {
|
|
@@ -85,6 +86,71 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
85
86
|
return yield response.value();
|
|
86
87
|
});
|
|
87
88
|
}
|
|
89
|
+
/**
|
|
90
|
+
* Creates request options for iposRegistrationsList without sending the request
|
|
91
|
+
*/
|
|
92
|
+
iposRegistrationsListRequestOpts(requestParameters) {
|
|
93
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
94
|
+
const queryParameters = {};
|
|
95
|
+
if (requestParameters['startDate'] != null) {
|
|
96
|
+
queryParameters['start_date'] = requestParameters['startDate'].toISOString().substring(0, 10);
|
|
97
|
+
}
|
|
98
|
+
if (requestParameters['endDate'] != null) {
|
|
99
|
+
queryParameters['end_date'] = requestParameters['endDate'].toISOString().substring(0, 10);
|
|
100
|
+
}
|
|
101
|
+
if (requestParameters['stage'] != null) {
|
|
102
|
+
queryParameters['stage'] = requestParameters['stage'];
|
|
103
|
+
}
|
|
104
|
+
if (requestParameters['isSpac'] != null) {
|
|
105
|
+
queryParameters['is_spac'] = requestParameters['isSpac'];
|
|
106
|
+
}
|
|
107
|
+
if (requestParameters['sort'] != null) {
|
|
108
|
+
queryParameters['sort'] = requestParameters['sort'];
|
|
109
|
+
}
|
|
110
|
+
if (requestParameters['limit'] != null) {
|
|
111
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
112
|
+
}
|
|
113
|
+
if (requestParameters['offset'] != null) {
|
|
114
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
115
|
+
}
|
|
116
|
+
const headerParameters = {};
|
|
117
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
118
|
+
const token = this.configuration.accessToken;
|
|
119
|
+
const tokenString = yield token("bearerAuth", []);
|
|
120
|
+
if (tokenString) {
|
|
121
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
let urlPath = `/v1/ipos/registrations`;
|
|
125
|
+
return {
|
|
126
|
+
path: urlPath,
|
|
127
|
+
method: 'GET',
|
|
128
|
+
headers: headerParameters,
|
|
129
|
+
query: queryParameters,
|
|
130
|
+
};
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* 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.
|
|
135
|
+
* List IPO registrations (SEC)
|
|
136
|
+
*/
|
|
137
|
+
iposRegistrationsListRaw(requestParameters, initOverrides) {
|
|
138
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
139
|
+
const requestOptions = yield this.iposRegistrationsListRequestOpts(requestParameters);
|
|
140
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
141
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => IposRegistrationsList200ResponseFromJSON(jsonValue));
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* 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.
|
|
146
|
+
* List IPO registrations (SEC)
|
|
147
|
+
*/
|
|
148
|
+
iposRegistrationsList() {
|
|
149
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
150
|
+
const response = yield this.iposRegistrationsListRaw(requestParameters, initOverrides);
|
|
151
|
+
return yield response.value();
|
|
152
|
+
});
|
|
153
|
+
}
|
|
88
154
|
}
|
|
89
155
|
/**
|
|
90
156
|
* @export
|
|
@@ -93,3 +159,29 @@ export const IposListSortEnum = {
|
|
|
93
159
|
Asc: 'asc',
|
|
94
160
|
Desc: 'desc'
|
|
95
161
|
};
|
|
162
|
+
/**
|
|
163
|
+
* @export
|
|
164
|
+
*/
|
|
165
|
+
export const IposRegistrationsListStageEnum = {
|
|
166
|
+
Registered: 'registered',
|
|
167
|
+
PriceRange: 'price_range',
|
|
168
|
+
ExchangeApproved: 'exchange_approved',
|
|
169
|
+
Effective: 'effective',
|
|
170
|
+
Priced: 'priced',
|
|
171
|
+
Trading: 'trading',
|
|
172
|
+
Withdrawn: 'withdrawn'
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* @export
|
|
176
|
+
*/
|
|
177
|
+
export const IposRegistrationsListIsSpacEnum = {
|
|
178
|
+
True: 'true',
|
|
179
|
+
False: 'false'
|
|
180
|
+
};
|
|
181
|
+
/**
|
|
182
|
+
* @export
|
|
183
|
+
*/
|
|
184
|
+
export const IposRegistrationsListSortEnum = {
|
|
185
|
+
Asc: 'asc',
|
|
186
|
+
Desc: 'desc'
|
|
187
|
+
};
|
|
@@ -60,12 +60,12 @@ export declare class SECFilingsApi extends runtime.BaseAPI {
|
|
|
60
60
|
*/
|
|
61
61
|
secFilingsListRequestOpts(requestParameters: SecFilingsListRequest): Promise<runtime.RequestOpts>;
|
|
62
62
|
/**
|
|
63
|
-
* Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
63
|
+
* 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.
|
|
64
64
|
* SEC filings
|
|
65
65
|
*/
|
|
66
66
|
secFilingsListRaw(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsList200Response>>;
|
|
67
67
|
/**
|
|
68
|
-
* Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
68
|
+
* 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.
|
|
69
69
|
* SEC filings
|
|
70
70
|
*/
|
|
71
71
|
secFilingsList(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsList200Response>;
|
|
@@ -118,7 +118,7 @@ export class SECFilingsApi extends runtime.BaseAPI {
|
|
|
118
118
|
});
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
* Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
121
|
+
* 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.
|
|
122
122
|
* SEC filings
|
|
123
123
|
*/
|
|
124
124
|
secFilingsListRaw(requestParameters, initOverrides) {
|
|
@@ -129,7 +129,7 @@ export class SECFilingsApi extends runtime.BaseAPI {
|
|
|
129
129
|
});
|
|
130
130
|
}
|
|
131
131
|
/**
|
|
132
|
-
* Fetch SEC filings for a company. Minimum tier for display: FREE.
|
|
132
|
+
* 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.
|
|
133
133
|
* SEC filings
|
|
134
134
|
*/
|
|
135
135
|
secFilingsList(requestParameters, initOverrides) {
|
|
@@ -48,8 +48,6 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
48
48
|
export declare const EarningsCallsDocumentSearch200ResponseModeEnum: {
|
|
49
49
|
readonly Lexical: "lexical";
|
|
50
50
|
readonly Literal: "literal";
|
|
51
|
-
readonly Semantic: "semantic";
|
|
52
|
-
readonly Hybrid: "hybrid";
|
|
53
51
|
};
|
|
54
52
|
export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
|
|
55
53
|
/**
|
|
@@ -18,9 +18,7 @@ import { SearchCoverageFromJSON, SearchCoverageToJSON, } from './SearchCoverage'
|
|
|
18
18
|
*/
|
|
19
19
|
export const EarningsCallsDocumentSearch200ResponseModeEnum = {
|
|
20
20
|
Lexical: 'lexical',
|
|
21
|
-
Literal: 'literal'
|
|
22
|
-
Semantic: 'semantic',
|
|
23
|
-
Hybrid: 'hybrid'
|
|
21
|
+
Literal: 'literal'
|
|
24
22
|
};
|
|
25
23
|
/**
|
|
26
24
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
@@ -17,7 +17,7 @@ import type { HitMatch } from './HitMatch';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
19
19
|
/**
|
|
20
|
-
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
|
|
20
|
+
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
|
|
21
21
|
* @type {number}
|
|
22
22
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
23
23
|
*/
|
|
@@ -48,8 +48,6 @@ export interface EarningsCallsSearch200Response {
|
|
|
48
48
|
export declare const EarningsCallsSearch200ResponseModeEnum: {
|
|
49
49
|
readonly Lexical: "lexical";
|
|
50
50
|
readonly Literal: "literal";
|
|
51
|
-
readonly Semantic: "semantic";
|
|
52
|
-
readonly Hybrid: "hybrid";
|
|
53
51
|
};
|
|
54
52
|
export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
|
|
55
53
|
/**
|
|
@@ -18,9 +18,7 @@ import { SearchCoverageFromJSON, SearchCoverageToJSON, } from './SearchCoverage'
|
|
|
18
18
|
*/
|
|
19
19
|
export const EarningsCallsSearch200ResponseModeEnum = {
|
|
20
20
|
Lexical: 'lexical',
|
|
21
|
-
Literal: 'literal'
|
|
22
|
-
Semantic: 'semantic',
|
|
23
|
-
Hybrid: 'hybrid'
|
|
21
|
+
Literal: 'literal'
|
|
24
22
|
};
|
|
25
23
|
/**
|
|
26
24
|
* Check if a given object implements the EarningsCallsSearch200Response interface.
|
|
@@ -97,7 +97,7 @@ export interface EarningsCallsSearch200ResponseHitsInner {
|
|
|
97
97
|
*/
|
|
98
98
|
text_truncated: boolean;
|
|
99
99
|
/**
|
|
100
|
-
* Relevance per mode: lexical =
|
|
100
|
+
* Relevance per mode: lexical = BM25 with `identifier` / `event_id` (an answer attached to its question scores 0.99 × the question), else ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first)
|
|
101
101
|
* @type {number}
|
|
102
102
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
103
103
|
*/
|
|
@@ -17,25 +17,19 @@ import type { MatchSpan } from './MatchSpan';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface HitMatch {
|
|
19
19
|
/**
|
|
20
|
-
* The
|
|
20
|
+
* The mode that found the passage
|
|
21
21
|
* @type {HitMatchTypeEnum}
|
|
22
22
|
* @memberof HitMatch
|
|
23
23
|
*/
|
|
24
24
|
type: HitMatchTypeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* 1-based rank
|
|
26
|
+
* 1-based rank of the passage in the answer
|
|
27
27
|
* @type {number}
|
|
28
28
|
* @memberof HitMatch
|
|
29
29
|
*/
|
|
30
|
-
lexical_rank: number
|
|
30
|
+
lexical_rank: number;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {number}
|
|
34
|
-
* @memberof HitMatch
|
|
35
|
-
*/
|
|
36
|
-
semantic_rank: number | null;
|
|
37
|
-
/**
|
|
38
|
-
* Matched characters in `text`; empty for semantic matches
|
|
32
|
+
* Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
|
|
39
33
|
* @type {Array<MatchSpan>}
|
|
40
34
|
* @memberof HitMatch
|
|
41
35
|
*/
|
|
@@ -47,8 +41,6 @@ export interface HitMatch {
|
|
|
47
41
|
export declare const HitMatchTypeEnum: {
|
|
48
42
|
readonly Lexical: "lexical";
|
|
49
43
|
readonly Literal: "literal";
|
|
50
|
-
readonly Semantic: "semantic";
|
|
51
|
-
readonly Hybrid: "hybrid";
|
|
52
44
|
};
|
|
53
45
|
export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
|
|
54
46
|
/**
|