@invinite-org/data-api-client 0.2.0 → 0.2.1
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/dist/apis/EarningsCallsApi.d.ts +4 -4
- package/dist/apis/EarningsCallsApi.js +4 -4
- package/dist/esm/apis/EarningsCallsApi.d.ts +4 -4
- package/dist/esm/apis/EarningsCallsApi.js +4 -4
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +1 -1
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +1 -1
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +1 -1
- package/docs/EarningsCallsApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +4 -4
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +1 -1
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -1
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +1 -1
|
@@ -352,12 +352,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
352
352
|
*/
|
|
353
353
|
earningsCallsCompanyDocumentsRequestOpts(requestParameters: EarningsCallsCompanyDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
354
354
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
356
356
|
* Company documents
|
|
357
357
|
*/
|
|
358
358
|
earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>>;
|
|
359
359
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
361
361
|
* Company documents
|
|
362
362
|
*/
|
|
363
363
|
earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response>;
|
|
@@ -394,12 +394,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
394
394
|
*/
|
|
395
395
|
earningsCallsDocumentsRequestOpts(requestParameters: EarningsCallsDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
396
396
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
398
398
|
* Earnings call documents
|
|
399
399
|
*/
|
|
400
400
|
earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>>;
|
|
401
401
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
403
403
|
* Earnings call documents
|
|
404
404
|
*/
|
|
405
405
|
earningsCallsDocuments(requestParameters?: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response>;
|
|
@@ -368,7 +368,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
368
368
|
});
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
372
372
|
* Company documents
|
|
373
373
|
*/
|
|
374
374
|
earningsCallsCompanyDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -379,7 +379,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
379
379
|
});
|
|
380
380
|
}
|
|
381
381
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
383
383
|
* Company documents
|
|
384
384
|
*/
|
|
385
385
|
earningsCallsCompanyDocuments(requestParameters, initOverrides) {
|
|
@@ -581,7 +581,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
581
581
|
});
|
|
582
582
|
}
|
|
583
583
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
585
585
|
* Earnings call documents
|
|
586
586
|
*/
|
|
587
587
|
earningsCallsDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -592,7 +592,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
592
592
|
});
|
|
593
593
|
}
|
|
594
594
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
596
596
|
* Earnings call documents
|
|
597
597
|
*/
|
|
598
598
|
earningsCallsDocuments() {
|
|
@@ -352,12 +352,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
352
352
|
*/
|
|
353
353
|
earningsCallsCompanyDocumentsRequestOpts(requestParameters: EarningsCallsCompanyDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
354
354
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
356
356
|
* Company documents
|
|
357
357
|
*/
|
|
358
358
|
earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>>;
|
|
359
359
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
361
361
|
* Company documents
|
|
362
362
|
*/
|
|
363
363
|
earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response>;
|
|
@@ -394,12 +394,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
394
394
|
*/
|
|
395
395
|
earningsCallsDocumentsRequestOpts(requestParameters: EarningsCallsDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
396
396
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
398
398
|
* Earnings call documents
|
|
399
399
|
*/
|
|
400
400
|
earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>>;
|
|
401
401
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
403
403
|
* Earnings call documents
|
|
404
404
|
*/
|
|
405
405
|
earningsCallsDocuments(requestParameters?: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response>;
|
|
@@ -365,7 +365,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
365
365
|
});
|
|
366
366
|
}
|
|
367
367
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
369
369
|
* Company documents
|
|
370
370
|
*/
|
|
371
371
|
earningsCallsCompanyDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -376,7 +376,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
376
376
|
});
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
380
380
|
* Company documents
|
|
381
381
|
*/
|
|
382
382
|
earningsCallsCompanyDocuments(requestParameters, initOverrides) {
|
|
@@ -578,7 +578,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
578
578
|
});
|
|
579
579
|
}
|
|
580
580
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
582
582
|
* Earnings call documents
|
|
583
583
|
*/
|
|
584
584
|
earningsCallsDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -589,7 +589,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
589
589
|
});
|
|
590
590
|
}
|
|
591
591
|
/**
|
|
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.
|
|
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
593
593
|
* Earnings call documents
|
|
594
594
|
*/
|
|
595
595
|
earningsCallsDocuments() {
|
|
@@ -58,7 +58,7 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
58
58
|
*/
|
|
59
59
|
group: string | null;
|
|
60
60
|
/**
|
|
61
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
61
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
62
62
|
* @type {string}
|
|
63
63
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
64
64
|
*/
|
|
@@ -106,7 +106,7 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
106
106
|
*/
|
|
107
107
|
group: string | null;
|
|
108
108
|
/**
|
|
109
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
109
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
110
110
|
* @type {string}
|
|
111
111
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
112
112
|
*/
|
|
@@ -112,7 +112,7 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
|
|
|
112
112
|
*/
|
|
113
113
|
group: string | null;
|
|
114
114
|
/**
|
|
115
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
115
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
116
116
|
* @type {string}
|
|
117
117
|
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
118
118
|
*/
|
|
@@ -58,7 +58,7 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
58
58
|
*/
|
|
59
59
|
group: string | null;
|
|
60
60
|
/**
|
|
61
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
61
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
62
62
|
* @type {string}
|
|
63
63
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
64
64
|
*/
|
|
@@ -106,7 +106,7 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
106
106
|
*/
|
|
107
107
|
group: string | null;
|
|
108
108
|
/**
|
|
109
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
109
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
110
110
|
* @type {string}
|
|
111
111
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
112
112
|
*/
|
|
@@ -112,7 +112,7 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
|
|
|
112
112
|
*/
|
|
113
113
|
group: string | null;
|
|
114
114
|
/**
|
|
115
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
115
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
116
116
|
* @type {string}
|
|
117
117
|
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
118
118
|
*/
|
package/docs/EarningsCallsApi.md
CHANGED
|
@@ -399,7 +399,7 @@ example().catch(console.error);
|
|
|
399
399
|
|
|
400
400
|
Company documents
|
|
401
401
|
|
|
402
|
-
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.
|
|
402
|
+
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
403
403
|
|
|
404
404
|
### Example
|
|
405
405
|
|
|
@@ -699,7 +699,7 @@ example().catch(console.error);
|
|
|
699
699
|
|
|
700
700
|
Earnings call documents
|
|
701
701
|
|
|
702
|
-
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.
|
|
702
|
+
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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
703
703
|
|
|
704
704
|
### Example
|
|
705
705
|
|
package/package.json
CHANGED
|
@@ -844,7 +844,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
844
844
|
}
|
|
845
845
|
|
|
846
846
|
/**
|
|
847
|
-
* 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.
|
|
847
|
+
* 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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
848
848
|
* Company documents
|
|
849
849
|
*/
|
|
850
850
|
async earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>> {
|
|
@@ -855,7 +855,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
855
855
|
}
|
|
856
856
|
|
|
857
857
|
/**
|
|
858
|
-
* 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.
|
|
858
|
+
* 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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
859
859
|
* Company documents
|
|
860
860
|
*/
|
|
861
861
|
async earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response> {
|
|
@@ -1096,7 +1096,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1096
1096
|
}
|
|
1097
1097
|
|
|
1098
1098
|
/**
|
|
1099
|
-
* 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.
|
|
1099
|
+
* 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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
1100
1100
|
* Earnings call documents
|
|
1101
1101
|
*/
|
|
1102
1102
|
async earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>> {
|
|
@@ -1107,7 +1107,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1107
1107
|
}
|
|
1108
1108
|
|
|
1109
1109
|
/**
|
|
1110
|
-
* 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.
|
|
1110
|
+
* 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; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `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.
|
|
1111
1111
|
* Earnings call documents
|
|
1112
1112
|
*/
|
|
1113
1113
|
async earningsCallsDocuments(requestParameters: EarningsCallsDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response> {
|
|
@@ -62,7 +62,7 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
62
62
|
*/
|
|
63
63
|
group: string | null;
|
|
64
64
|
/**
|
|
65
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
65
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
66
66
|
* @type {string}
|
|
67
67
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
68
68
|
*/
|
|
@@ -110,7 +110,7 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
110
110
|
*/
|
|
111
111
|
group: string | null;
|
|
112
112
|
/**
|
|
113
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
113
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
114
114
|
* @type {string}
|
|
115
115
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
116
116
|
*/
|
|
@@ -116,7 +116,7 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
|
|
|
116
116
|
*/
|
|
117
117
|
group: string | null;
|
|
118
118
|
/**
|
|
119
|
-
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "
|
|
119
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
|
|
120
120
|
* @type {string}
|
|
121
121
|
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
122
122
|
*/
|