@invinite-org/data-api-client 0.1.0 → 0.2.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 +0 -1
- package/dist/apis/EarningsCallsApi.d.ts +20 -6
- package/dist/apis/EarningsCallsApi.js +34 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +20 -6
- package/dist/esm/apis/EarningsCallsApi.js +33 -6
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +46 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +25 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +25 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +47 -3
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +26 -1
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +26 -1
- package/docs/AccountApi.md +1 -1
- package/docs/AsReportedBalanceSheetApi.md +16 -16
- package/docs/AsReportedCashFlowStatementApi.md +16 -16
- package/docs/AsReportedIncomeStatementApi.md +16 -16
- package/docs/AsReportedSnapshotApi.md +13 -13
- package/docs/CompanyApi.md +18 -18
- package/docs/EarningsCallsApi.md +210 -189
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +8 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +6 -0
- package/docs/FinancialMetricsApi.md +17 -17
- package/docs/IPOsApi.md +5 -5
- package/docs/InsiderTradesApi.md +7 -7
- package/docs/InstitutionalOwnershipApi.md +23 -23
- package/docs/MarketApi.md +3 -3
- package/docs/SECFilingsApi.md +15 -15
- package/docs/SegmentedFinancialsApi.md +12 -12
- package/docs/StandardizedBalanceSheetApi.md +16 -16
- package/docs/StandardizedCashFlowStatementApi.md +16 -16
- package/docs/StandardizedIncomeStatementApi.md +16 -16
- package/docs/StandardizedSnapshotApi.md +13 -13
- package/package.json +4 -4
- package/src/apis/EarningsCallsApi.ts +48 -6
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +75 -7
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +42 -0
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +42 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -79,6 +79,11 @@ export interface EarningsCallsCompanyDocumentsRequest {
|
|
|
79
79
|
year?: number;
|
|
80
80
|
period?: EarningsCallsCompanyDocumentsPeriodEnum;
|
|
81
81
|
eventId?: string;
|
|
82
|
+
category?: Array<string>;
|
|
83
|
+
group?: string;
|
|
84
|
+
fiscalYear?: number;
|
|
85
|
+
fiscalQuarter?: number;
|
|
86
|
+
include?: Array<EarningsCallsCompanyDocumentsIncludeEnum>;
|
|
82
87
|
limit?: number;
|
|
83
88
|
offset?: number;
|
|
84
89
|
}
|
|
@@ -108,6 +113,8 @@ export interface EarningsCallsDocumentsRequest {
|
|
|
108
113
|
date?: Date;
|
|
109
114
|
eventType?: EarningsCallsDocumentsEventTypeEnum;
|
|
110
115
|
kind?: Array<string>;
|
|
116
|
+
category?: Array<string>;
|
|
117
|
+
group?: string;
|
|
111
118
|
include?: Array<string>;
|
|
112
119
|
limit?: number;
|
|
113
120
|
offset?: number;
|
|
@@ -345,12 +352,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
345
352
|
*/
|
|
346
353
|
earningsCallsCompanyDocumentsRequestOpts(requestParameters: EarningsCallsCompanyDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
347
354
|
/**
|
|
348
|
-
* A company\'s investor-relations documents
|
|
355
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
349
356
|
* Company documents
|
|
350
357
|
*/
|
|
351
358
|
earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>>;
|
|
352
359
|
/**
|
|
353
|
-
* A company\'s investor-relations documents
|
|
360
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
354
361
|
* Company documents
|
|
355
362
|
*/
|
|
356
363
|
earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response>;
|
|
@@ -373,12 +380,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
373
380
|
*/
|
|
374
381
|
earningsCallsDocumentSearchRequestOpts(requestParameters: EarningsCallsDocumentSearchRequest): Promise<runtime.RequestOpts>;
|
|
375
382
|
/**
|
|
376
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
383
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
377
384
|
* Search investor documents
|
|
378
385
|
*/
|
|
379
386
|
earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>>;
|
|
380
387
|
/**
|
|
381
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
382
389
|
* Search investor documents
|
|
383
390
|
*/
|
|
384
391
|
earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response>;
|
|
@@ -387,12 +394,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
387
394
|
*/
|
|
388
395
|
earningsCallsDocumentsRequestOpts(requestParameters: EarningsCallsDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
389
396
|
/**
|
|
390
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
397
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
391
398
|
* Earnings call documents
|
|
392
399
|
*/
|
|
393
400
|
earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>>;
|
|
394
401
|
/**
|
|
395
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
402
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
396
403
|
* Earnings call documents
|
|
397
404
|
*/
|
|
398
405
|
earningsCallsDocuments(requestParameters?: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response>;
|
|
@@ -799,6 +806,13 @@ export declare const EarningsCallsCompanyDocumentsPeriodEnum: {
|
|
|
799
806
|
readonly Fy: "FY";
|
|
800
807
|
};
|
|
801
808
|
export type EarningsCallsCompanyDocumentsPeriodEnum = typeof EarningsCallsCompanyDocumentsPeriodEnum[keyof typeof EarningsCallsCompanyDocumentsPeriodEnum];
|
|
809
|
+
/**
|
|
810
|
+
* @export
|
|
811
|
+
*/
|
|
812
|
+
export declare const EarningsCallsCompanyDocumentsIncludeEnum: {
|
|
813
|
+
readonly Calls: "calls";
|
|
814
|
+
};
|
|
815
|
+
export type EarningsCallsCompanyDocumentsIncludeEnum = typeof EarningsCallsCompanyDocumentsIncludeEnum[keyof typeof EarningsCallsCompanyDocumentsIncludeEnum];
|
|
802
816
|
/**
|
|
803
817
|
* @export
|
|
804
818
|
*/
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.EarningsCallsTranscriptVersionsEventTypeEnum = exports.EarningsCallsTranscriptDiffEventTypeEnum = exports.EarningsCallsTranscriptFormatEnum = exports.EarningsCallsTranscriptEventTypeEnum = exports.EarningsCallsSlidesEventTypeEnum = exports.EarningsCallsSearchTypeEnum = exports.EarningsCallsQaIncludeEnum = exports.EarningsCallsQaEventTypeEnum = exports.EarningsCallsProsodySectionEnum = exports.EarningsCallsProsodyEventTypeEnum = exports.EarningsCallsPriceAttributionEventTypeEnum = exports.EarningsCallsPressReleaseIncludeEnum = exports.EarningsCallsPressReleaseEventTypeEnum = exports.EarningsCallsParticipantsIncludeEnum = exports.EarningsCallsParticipantsEventTypeEnum = exports.EarningsCallsMetricsEventTypeEnum = exports.EarningsCallsLiveStreamEventTypeEnum = exports.EarningsCallsGuidanceHistoryBasisEnum = exports.EarningsCallsGuidanceHistoryPeriodKindEnum = exports.EarningsCallsExtractionsReviewEnum = exports.EarningsCallsExtractionsKindEnum = exports.EarningsCallsExtractionsEventTypeEnum = exports.EarningsCallsEventsSortEnum = exports.EarningsCallsEventsIncludeEnum = exports.EarningsCallsEventIncludeEnum = exports.EarningsCallsDocumentsEventTypeEnum = exports.EarningsCallsDocumentSearchTableEnum = exports.EarningsCallsDiffVsEnum = exports.EarningsCallsDiffEventTypeEnum = exports.EarningsCallsCompanyDocumentsPeriodEnum = exports.EarningsCallsCalendarSortEnum = exports.EarningsCallsCalendarSessionEnum = exports.EarningsCallsCalendarStatusEnum = exports.EarningsCallsAudioEventTypeEnum = exports.EarningsCallsApi = void 0;
|
|
25
|
+
exports.EarningsCallsTranscriptVersionsEventTypeEnum = exports.EarningsCallsTranscriptDiffEventTypeEnum = exports.EarningsCallsTranscriptFormatEnum = exports.EarningsCallsTranscriptEventTypeEnum = exports.EarningsCallsSlidesEventTypeEnum = exports.EarningsCallsSearchTypeEnum = exports.EarningsCallsQaIncludeEnum = exports.EarningsCallsQaEventTypeEnum = exports.EarningsCallsProsodySectionEnum = exports.EarningsCallsProsodyEventTypeEnum = exports.EarningsCallsPriceAttributionEventTypeEnum = exports.EarningsCallsPressReleaseIncludeEnum = exports.EarningsCallsPressReleaseEventTypeEnum = exports.EarningsCallsParticipantsIncludeEnum = exports.EarningsCallsParticipantsEventTypeEnum = exports.EarningsCallsMetricsEventTypeEnum = exports.EarningsCallsLiveStreamEventTypeEnum = exports.EarningsCallsGuidanceHistoryBasisEnum = exports.EarningsCallsGuidanceHistoryPeriodKindEnum = exports.EarningsCallsExtractionsReviewEnum = exports.EarningsCallsExtractionsKindEnum = exports.EarningsCallsExtractionsEventTypeEnum = exports.EarningsCallsEventsSortEnum = exports.EarningsCallsEventsIncludeEnum = exports.EarningsCallsEventIncludeEnum = exports.EarningsCallsDocumentsEventTypeEnum = exports.EarningsCallsDocumentSearchTableEnum = exports.EarningsCallsDiffVsEnum = exports.EarningsCallsDiffEventTypeEnum = exports.EarningsCallsCompanyDocumentsIncludeEnum = exports.EarningsCallsCompanyDocumentsPeriodEnum = exports.EarningsCallsCalendarSortEnum = exports.EarningsCallsCalendarSessionEnum = exports.EarningsCallsCalendarStatusEnum = exports.EarningsCallsAudioEventTypeEnum = exports.EarningsCallsApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const EarningsCallsAnalysts200Response_1 = require("../models/EarningsCallsAnalysts200Response");
|
|
28
28
|
const EarningsCallsAudio200Response_1 = require("../models/EarningsCallsAudio200Response");
|
|
@@ -329,6 +329,21 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
329
329
|
if (requestParameters['eventId'] != null) {
|
|
330
330
|
queryParameters['event_id'] = requestParameters['eventId'];
|
|
331
331
|
}
|
|
332
|
+
if (requestParameters['category'] != null) {
|
|
333
|
+
queryParameters['category'] = requestParameters['category'];
|
|
334
|
+
}
|
|
335
|
+
if (requestParameters['group'] != null) {
|
|
336
|
+
queryParameters['group'] = requestParameters['group'];
|
|
337
|
+
}
|
|
338
|
+
if (requestParameters['fiscalYear'] != null) {
|
|
339
|
+
queryParameters['fiscal_year'] = requestParameters['fiscalYear'];
|
|
340
|
+
}
|
|
341
|
+
if (requestParameters['fiscalQuarter'] != null) {
|
|
342
|
+
queryParameters['fiscal_quarter'] = requestParameters['fiscalQuarter'];
|
|
343
|
+
}
|
|
344
|
+
if (requestParameters['include'] != null) {
|
|
345
|
+
queryParameters['include'] = requestParameters['include'];
|
|
346
|
+
}
|
|
332
347
|
if (requestParameters['limit'] != null) {
|
|
333
348
|
queryParameters['limit'] = requestParameters['limit'];
|
|
334
349
|
}
|
|
@@ -353,7 +368,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
353
368
|
});
|
|
354
369
|
}
|
|
355
370
|
/**
|
|
356
|
-
* A company\'s investor-relations documents
|
|
371
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
357
372
|
* Company documents
|
|
358
373
|
*/
|
|
359
374
|
earningsCallsCompanyDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -364,7 +379,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
364
379
|
});
|
|
365
380
|
}
|
|
366
381
|
/**
|
|
367
|
-
* A company\'s investor-relations documents
|
|
382
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
368
383
|
* Company documents
|
|
369
384
|
*/
|
|
370
385
|
earningsCallsCompanyDocuments(requestParameters, initOverrides) {
|
|
@@ -486,7 +501,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
486
501
|
});
|
|
487
502
|
}
|
|
488
503
|
/**
|
|
489
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
504
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
490
505
|
* Search investor documents
|
|
491
506
|
*/
|
|
492
507
|
earningsCallsDocumentSearchRaw(requestParameters, initOverrides) {
|
|
@@ -497,7 +512,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
497
512
|
});
|
|
498
513
|
}
|
|
499
514
|
/**
|
|
500
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
515
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
501
516
|
* Search investor documents
|
|
502
517
|
*/
|
|
503
518
|
earningsCallsDocumentSearch(requestParameters, initOverrides) {
|
|
@@ -533,6 +548,12 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
533
548
|
if (requestParameters['kind'] != null) {
|
|
534
549
|
queryParameters['kind'] = requestParameters['kind'];
|
|
535
550
|
}
|
|
551
|
+
if (requestParameters['category'] != null) {
|
|
552
|
+
queryParameters['category'] = requestParameters['category'];
|
|
553
|
+
}
|
|
554
|
+
if (requestParameters['group'] != null) {
|
|
555
|
+
queryParameters['group'] = requestParameters['group'];
|
|
556
|
+
}
|
|
536
557
|
if (requestParameters['include'] != null) {
|
|
537
558
|
queryParameters['include'] = requestParameters['include'];
|
|
538
559
|
}
|
|
@@ -560,7 +581,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
560
581
|
});
|
|
561
582
|
}
|
|
562
583
|
/**
|
|
563
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
584
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
564
585
|
* Earnings call documents
|
|
565
586
|
*/
|
|
566
587
|
earningsCallsDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -571,7 +592,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
571
592
|
});
|
|
572
593
|
}
|
|
573
594
|
/**
|
|
574
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
595
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
575
596
|
* Earnings call documents
|
|
576
597
|
*/
|
|
577
598
|
earningsCallsDocuments() {
|
|
@@ -2117,6 +2138,12 @@ exports.EarningsCallsCompanyDocumentsPeriodEnum = {
|
|
|
2117
2138
|
H2: 'H2',
|
|
2118
2139
|
Fy: 'FY'
|
|
2119
2140
|
};
|
|
2141
|
+
/**
|
|
2142
|
+
* @export
|
|
2143
|
+
*/
|
|
2144
|
+
exports.EarningsCallsCompanyDocumentsIncludeEnum = {
|
|
2145
|
+
Calls: 'calls'
|
|
2146
|
+
};
|
|
2120
2147
|
/**
|
|
2121
2148
|
* @export
|
|
2122
2149
|
*/
|
|
@@ -79,6 +79,11 @@ export interface EarningsCallsCompanyDocumentsRequest {
|
|
|
79
79
|
year?: number;
|
|
80
80
|
period?: EarningsCallsCompanyDocumentsPeriodEnum;
|
|
81
81
|
eventId?: string;
|
|
82
|
+
category?: Array<string>;
|
|
83
|
+
group?: string;
|
|
84
|
+
fiscalYear?: number;
|
|
85
|
+
fiscalQuarter?: number;
|
|
86
|
+
include?: Array<EarningsCallsCompanyDocumentsIncludeEnum>;
|
|
82
87
|
limit?: number;
|
|
83
88
|
offset?: number;
|
|
84
89
|
}
|
|
@@ -108,6 +113,8 @@ export interface EarningsCallsDocumentsRequest {
|
|
|
108
113
|
date?: Date;
|
|
109
114
|
eventType?: EarningsCallsDocumentsEventTypeEnum;
|
|
110
115
|
kind?: Array<string>;
|
|
116
|
+
category?: Array<string>;
|
|
117
|
+
group?: string;
|
|
111
118
|
include?: Array<string>;
|
|
112
119
|
limit?: number;
|
|
113
120
|
offset?: number;
|
|
@@ -345,12 +352,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
345
352
|
*/
|
|
346
353
|
earningsCallsCompanyDocumentsRequestOpts(requestParameters: EarningsCallsCompanyDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
347
354
|
/**
|
|
348
|
-
* A company\'s investor-relations documents
|
|
355
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
349
356
|
* Company documents
|
|
350
357
|
*/
|
|
351
358
|
earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>>;
|
|
352
359
|
/**
|
|
353
|
-
* A company\'s investor-relations documents
|
|
360
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
354
361
|
* Company documents
|
|
355
362
|
*/
|
|
356
363
|
earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response>;
|
|
@@ -373,12 +380,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
373
380
|
*/
|
|
374
381
|
earningsCallsDocumentSearchRequestOpts(requestParameters: EarningsCallsDocumentSearchRequest): Promise<runtime.RequestOpts>;
|
|
375
382
|
/**
|
|
376
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
383
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
377
384
|
* Search investor documents
|
|
378
385
|
*/
|
|
379
386
|
earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>>;
|
|
380
387
|
/**
|
|
381
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
382
389
|
* Search investor documents
|
|
383
390
|
*/
|
|
384
391
|
earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response>;
|
|
@@ -387,12 +394,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
387
394
|
*/
|
|
388
395
|
earningsCallsDocumentsRequestOpts(requestParameters: EarningsCallsDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
389
396
|
/**
|
|
390
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
397
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
391
398
|
* Earnings call documents
|
|
392
399
|
*/
|
|
393
400
|
earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>>;
|
|
394
401
|
/**
|
|
395
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
402
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
396
403
|
* Earnings call documents
|
|
397
404
|
*/
|
|
398
405
|
earningsCallsDocuments(requestParameters?: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response>;
|
|
@@ -799,6 +806,13 @@ export declare const EarningsCallsCompanyDocumentsPeriodEnum: {
|
|
|
799
806
|
readonly Fy: "FY";
|
|
800
807
|
};
|
|
801
808
|
export type EarningsCallsCompanyDocumentsPeriodEnum = typeof EarningsCallsCompanyDocumentsPeriodEnum[keyof typeof EarningsCallsCompanyDocumentsPeriodEnum];
|
|
809
|
+
/**
|
|
810
|
+
* @export
|
|
811
|
+
*/
|
|
812
|
+
export declare const EarningsCallsCompanyDocumentsIncludeEnum: {
|
|
813
|
+
readonly Calls: "calls";
|
|
814
|
+
};
|
|
815
|
+
export type EarningsCallsCompanyDocumentsIncludeEnum = typeof EarningsCallsCompanyDocumentsIncludeEnum[keyof typeof EarningsCallsCompanyDocumentsIncludeEnum];
|
|
802
816
|
/**
|
|
803
817
|
* @export
|
|
804
818
|
*/
|
|
@@ -326,6 +326,21 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
326
326
|
if (requestParameters['eventId'] != null) {
|
|
327
327
|
queryParameters['event_id'] = requestParameters['eventId'];
|
|
328
328
|
}
|
|
329
|
+
if (requestParameters['category'] != null) {
|
|
330
|
+
queryParameters['category'] = requestParameters['category'];
|
|
331
|
+
}
|
|
332
|
+
if (requestParameters['group'] != null) {
|
|
333
|
+
queryParameters['group'] = requestParameters['group'];
|
|
334
|
+
}
|
|
335
|
+
if (requestParameters['fiscalYear'] != null) {
|
|
336
|
+
queryParameters['fiscal_year'] = requestParameters['fiscalYear'];
|
|
337
|
+
}
|
|
338
|
+
if (requestParameters['fiscalQuarter'] != null) {
|
|
339
|
+
queryParameters['fiscal_quarter'] = requestParameters['fiscalQuarter'];
|
|
340
|
+
}
|
|
341
|
+
if (requestParameters['include'] != null) {
|
|
342
|
+
queryParameters['include'] = requestParameters['include'];
|
|
343
|
+
}
|
|
329
344
|
if (requestParameters['limit'] != null) {
|
|
330
345
|
queryParameters['limit'] = requestParameters['limit'];
|
|
331
346
|
}
|
|
@@ -350,7 +365,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
350
365
|
});
|
|
351
366
|
}
|
|
352
367
|
/**
|
|
353
|
-
* A company\'s investor-relations documents
|
|
368
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
354
369
|
* Company documents
|
|
355
370
|
*/
|
|
356
371
|
earningsCallsCompanyDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -361,7 +376,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
361
376
|
});
|
|
362
377
|
}
|
|
363
378
|
/**
|
|
364
|
-
* A company\'s investor-relations documents
|
|
379
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### 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.
|
|
365
380
|
* Company documents
|
|
366
381
|
*/
|
|
367
382
|
earningsCallsCompanyDocuments(requestParameters, initOverrides) {
|
|
@@ -483,7 +498,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
483
498
|
});
|
|
484
499
|
}
|
|
485
500
|
/**
|
|
486
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
501
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
487
502
|
* Search investor documents
|
|
488
503
|
*/
|
|
489
504
|
earningsCallsDocumentSearchRaw(requestParameters, initOverrides) {
|
|
@@ -494,7 +509,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
494
509
|
});
|
|
495
510
|
}
|
|
496
511
|
/**
|
|
497
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
512
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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.
|
|
498
513
|
* Search investor documents
|
|
499
514
|
*/
|
|
500
515
|
earningsCallsDocumentSearch(requestParameters, initOverrides) {
|
|
@@ -530,6 +545,12 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
530
545
|
if (requestParameters['kind'] != null) {
|
|
531
546
|
queryParameters['kind'] = requestParameters['kind'];
|
|
532
547
|
}
|
|
548
|
+
if (requestParameters['category'] != null) {
|
|
549
|
+
queryParameters['category'] = requestParameters['category'];
|
|
550
|
+
}
|
|
551
|
+
if (requestParameters['group'] != null) {
|
|
552
|
+
queryParameters['group'] = requestParameters['group'];
|
|
553
|
+
}
|
|
533
554
|
if (requestParameters['include'] != null) {
|
|
534
555
|
queryParameters['include'] = requestParameters['include'];
|
|
535
556
|
}
|
|
@@ -557,7 +578,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
557
578
|
});
|
|
558
579
|
}
|
|
559
580
|
/**
|
|
560
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
581
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
561
582
|
* Earnings call documents
|
|
562
583
|
*/
|
|
563
584
|
earningsCallsDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -568,7 +589,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
568
589
|
});
|
|
569
590
|
}
|
|
570
591
|
/**
|
|
571
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
592
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
572
593
|
* Earnings call documents
|
|
573
594
|
*/
|
|
574
595
|
earningsCallsDocuments() {
|
|
@@ -2113,6 +2134,12 @@ export const EarningsCallsCompanyDocumentsPeriodEnum = {
|
|
|
2113
2134
|
H2: 'H2',
|
|
2114
2135
|
Fy: 'FY'
|
|
2115
2136
|
};
|
|
2137
|
+
/**
|
|
2138
|
+
* @export
|
|
2139
|
+
*/
|
|
2140
|
+
export const EarningsCallsCompanyDocumentsIncludeEnum = {
|
|
2141
|
+
Calls: 'calls'
|
|
2142
|
+
};
|
|
2116
2143
|
/**
|
|
2117
2144
|
* @export
|
|
2118
2145
|
*/
|