@invinite-org/data-api-client 0.9.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -1
- package/dist/apis/EarningsCallsApi.d.ts +12 -12
- package/dist/apis/EarningsCallsApi.js +12 -12
- package/dist/esm/apis/EarningsCallsApi.d.ts +12 -12
- package/dist/esm/apis/EarningsCallsApi.js +12 -12
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +2 -8
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -7
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +0 -4
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +1 -7
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSlides200ResponseDeck.d.ts +1 -7
- package/dist/esm/models/EarningsCallsSlides200ResponseDeck.js +0 -4
- package/dist/esm/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +1 -1
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +2 -8
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -7
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +0 -4
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +1 -7
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +1 -1
- package/dist/models/EarningsCallsSlides200ResponseDeck.d.ts +1 -7
- package/dist/models/EarningsCallsSlides200ResponseDeck.js +0 -4
- package/dist/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +1 -1
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +1 -1
- package/docs/EarningsCallsApi.md +6 -6
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +0 -2
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +0 -2
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +0 -2
- package/docs/EarningsCallsSlides200ResponseDeck.md +0 -2
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +12 -12
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +2 -11
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -10
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +1 -10
- package/src/models/EarningsCallsSearch200ResponseHitsInnerSlide.ts +1 -1
- package/src/models/EarningsCallsSlides200ResponseDeck.ts +1 -10
- package/src/models/EarningsCallsSlides200ResponseSlidesInner.ts +1 -1
- package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +1 -1
|
@@ -342,12 +342,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
342
342
|
*/
|
|
343
343
|
earningsCallsCompanyDocumentRequestOpts(requestParameters: EarningsCallsCompanyDocumentRequest): Promise<runtime.RequestOpts>;
|
|
344
344
|
/**
|
|
345
|
-
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`):
|
|
345
|
+
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
346
346
|
* Company document by ID
|
|
347
347
|
*/
|
|
348
348
|
earningsCallsCompanyDocumentRaw(requestParameters: EarningsCallsCompanyDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocument200Response>>;
|
|
349
349
|
/**
|
|
350
|
-
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`):
|
|
350
|
+
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
351
351
|
* Company document by ID
|
|
352
352
|
*/
|
|
353
353
|
earningsCallsCompanyDocument(requestParameters: EarningsCallsCompanyDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocument200Response>;
|
|
@@ -356,12 +356,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
356
356
|
*/
|
|
357
357
|
earningsCallsCompanyDocumentsRequestOpts(requestParameters: EarningsCallsCompanyDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
358
358
|
/**
|
|
359
|
-
* 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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. -
|
|
359
|
+
* 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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
360
360
|
* Company documents
|
|
361
361
|
*/
|
|
362
362
|
earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>>;
|
|
363
363
|
/**
|
|
364
|
-
* 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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. -
|
|
364
|
+
* 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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
365
365
|
* Company documents
|
|
366
366
|
*/
|
|
367
367
|
earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response>;
|
|
@@ -384,12 +384,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
384
384
|
*/
|
|
385
385
|
earningsCallsDocumentSearchRequestOpts(requestParameters: EarningsCallsDocumentSearchRequest): Promise<runtime.RequestOpts>;
|
|
386
386
|
/**
|
|
387
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a
|
|
387
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a permanent public URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
|
|
388
388
|
* Search investor documents
|
|
389
389
|
*/
|
|
390
390
|
earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>>;
|
|
391
391
|
/**
|
|
392
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a
|
|
392
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a permanent public URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
|
|
393
393
|
* Search investor documents
|
|
394
394
|
*/
|
|
395
395
|
earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response>;
|
|
@@ -398,12 +398,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
398
398
|
*/
|
|
399
399
|
earningsCallsDocumentsRequestOpts(requestParameters: EarningsCallsDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
400
400
|
/**
|
|
401
|
-
* 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 -
|
|
401
|
+
* 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 - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
402
402
|
* Earnings call documents
|
|
403
403
|
*/
|
|
404
404
|
earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>>;
|
|
405
405
|
/**
|
|
406
|
-
* 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 -
|
|
406
|
+
* 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 - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
407
407
|
* Earnings call documents
|
|
408
408
|
*/
|
|
409
409
|
earningsCallsDocuments(requestParameters?: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response>;
|
|
@@ -594,12 +594,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
594
594
|
*/
|
|
595
595
|
earningsCallsSearchRequestOpts(requestParameters: EarningsCallsSearchRequest): Promise<runtime.RequestOpts>;
|
|
596
596
|
/**
|
|
597
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a
|
|
597
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a permanent public URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
|
|
598
598
|
* Search earnings calls
|
|
599
599
|
*/
|
|
600
600
|
earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>>;
|
|
601
601
|
/**
|
|
602
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a
|
|
602
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a permanent public URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
|
|
603
603
|
* Search earnings calls
|
|
604
604
|
*/
|
|
605
605
|
earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response>;
|
|
@@ -608,12 +608,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
608
608
|
*/
|
|
609
609
|
earningsCallsSlidesRequestOpts(requestParameters: EarningsCallsSlidesRequest): Promise<runtime.RequestOpts>;
|
|
610
610
|
/**
|
|
611
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as
|
|
611
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
612
612
|
* Earnings call slides
|
|
613
613
|
*/
|
|
614
614
|
earningsCallsSlidesRaw(requestParameters: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSlides200Response>>;
|
|
615
615
|
/**
|
|
616
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as
|
|
616
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
617
617
|
* Earnings call slides
|
|
618
618
|
*/
|
|
619
619
|
earningsCallsSlides(requestParameters?: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSlides200Response>;
|
|
@@ -279,7 +279,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
279
279
|
});
|
|
280
280
|
}
|
|
281
281
|
/**
|
|
282
|
-
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`):
|
|
282
|
+
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
283
283
|
* Company document by ID
|
|
284
284
|
*/
|
|
285
285
|
earningsCallsCompanyDocumentRaw(requestParameters, initOverrides) {
|
|
@@ -290,7 +290,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
290
290
|
});
|
|
291
291
|
}
|
|
292
292
|
/**
|
|
293
|
-
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`):
|
|
293
|
+
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
294
294
|
* Company document by ID
|
|
295
295
|
*/
|
|
296
296
|
earningsCallsCompanyDocument(requestParameters, initOverrides) {
|
|
@@ -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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. -
|
|
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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. 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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. -
|
|
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`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
380
380
|
* Company documents
|
|
381
381
|
*/
|
|
382
382
|
earningsCallsCompanyDocuments(requestParameters, initOverrides) {
|
|
@@ -504,7 +504,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
504
504
|
});
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a
|
|
507
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a permanent public URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
|
|
508
508
|
* Search investor documents
|
|
509
509
|
*/
|
|
510
510
|
earningsCallsDocumentSearchRaw(requestParameters, initOverrides) {
|
|
@@ -515,7 +515,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
515
515
|
});
|
|
516
516
|
}
|
|
517
517
|
/**
|
|
518
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a
|
|
518
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a permanent public URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
|
|
519
519
|
* Search investor documents
|
|
520
520
|
*/
|
|
521
521
|
earningsCallsDocumentSearch(requestParameters, initOverrides) {
|
|
@@ -584,7 +584,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
584
584
|
});
|
|
585
585
|
}
|
|
586
586
|
/**
|
|
587
|
-
* 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 -
|
|
587
|
+
* 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 - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
588
588
|
* Earnings call documents
|
|
589
589
|
*/
|
|
590
590
|
earningsCallsDocumentsRaw(requestParameters, initOverrides) {
|
|
@@ -595,7 +595,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
595
595
|
});
|
|
596
596
|
}
|
|
597
597
|
/**
|
|
598
|
-
* 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 -
|
|
598
|
+
* 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 - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - 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. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
599
599
|
* Earnings call documents
|
|
600
600
|
*/
|
|
601
601
|
earningsCallsDocuments() {
|
|
@@ -1472,7 +1472,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1472
1472
|
});
|
|
1473
1473
|
}
|
|
1474
1474
|
/**
|
|
1475
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a
|
|
1475
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a permanent public URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
|
|
1476
1476
|
* Search earnings calls
|
|
1477
1477
|
*/
|
|
1478
1478
|
earningsCallsSearchRaw(requestParameters, initOverrides) {
|
|
@@ -1483,7 +1483,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1483
1483
|
});
|
|
1484
1484
|
}
|
|
1485
1485
|
/**
|
|
1486
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a
|
|
1486
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a permanent public URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
|
|
1487
1487
|
* Search earnings calls
|
|
1488
1488
|
*/
|
|
1489
1489
|
earningsCallsSearch(requestParameters, initOverrides) {
|
|
@@ -1540,7 +1540,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1540
1540
|
});
|
|
1541
1541
|
}
|
|
1542
1542
|
/**
|
|
1543
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as
|
|
1543
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
1544
1544
|
* Earnings call slides
|
|
1545
1545
|
*/
|
|
1546
1546
|
earningsCallsSlidesRaw(requestParameters, initOverrides) {
|
|
@@ -1551,7 +1551,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1551
1551
|
});
|
|
1552
1552
|
}
|
|
1553
1553
|
/**
|
|
1554
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as
|
|
1554
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
1555
1555
|
* Earnings call slides
|
|
1556
1556
|
*/
|
|
1557
1557
|
earningsCallsSlides() {
|
|
@@ -160,23 +160,17 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
160
160
|
*/
|
|
161
161
|
link_status: EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum | null;
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
* Permanent public download URL; null for a link-only row (use source_url)
|
|
164
164
|
* @type {string}
|
|
165
165
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
166
166
|
*/
|
|
167
167
|
url: string | null;
|
|
168
168
|
/**
|
|
169
|
-
*
|
|
169
|
+
* Permanent public URL of the per-page text (JSON); null before the text was extracted
|
|
170
170
|
* @type {string}
|
|
171
171
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
172
172
|
*/
|
|
173
173
|
pages_url: string | null;
|
|
174
|
-
/**
|
|
175
|
-
* When the signed URLs stop working
|
|
176
|
-
* @type {Date}
|
|
177
|
-
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
178
|
-
*/
|
|
179
|
-
expires_at: Date | null;
|
|
180
174
|
/**
|
|
181
175
|
* When we first stored the document
|
|
182
176
|
* @type {Date}
|
|
@@ -194,8 +194,6 @@ export function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
|
194
194
|
return false;
|
|
195
195
|
if (!('pages_url' in value) || value['pages_url'] === undefined)
|
|
196
196
|
return false;
|
|
197
|
-
if (!('expires_at' in value) || value['expires_at'] === undefined)
|
|
198
|
-
return false;
|
|
199
197
|
if (!('created_at' in value) || value['created_at'] === undefined)
|
|
200
198
|
return false;
|
|
201
199
|
if (!('updated_at' in value) || value['updated_at'] === undefined)
|
|
@@ -236,7 +234,6 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTy
|
|
|
236
234
|
'link_status': json['link_status'],
|
|
237
235
|
'url': json['url'],
|
|
238
236
|
'pages_url': json['pages_url'],
|
|
239
|
-
'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
|
|
240
237
|
'created_at': (new Date(json['created_at'])),
|
|
241
238
|
'updated_at': (new Date(json['updated_at'])),
|
|
242
239
|
'pages_json': json['pages_json'] == null ? undefined : json['pages_json'],
|
|
@@ -276,7 +273,6 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONType
|
|
|
276
273
|
'link_status': value['link_status'],
|
|
277
274
|
'url': value['url'],
|
|
278
275
|
'pages_url': value['pages_url'],
|
|
279
|
-
'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
|
|
280
276
|
'created_at': value['created_at'].toISOString(),
|
|
281
277
|
'updated_at': value['updated_at'].toISOString(),
|
|
282
278
|
'pages_json': value['pages_json'],
|
|
@@ -137,17 +137,11 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
137
137
|
*/
|
|
138
138
|
category: EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum | null;
|
|
139
139
|
/**
|
|
140
|
-
*
|
|
140
|
+
* Permanent public URL of the stored file; null for a link-only row
|
|
141
141
|
* @type {string}
|
|
142
142
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
143
143
|
*/
|
|
144
144
|
url: string | null;
|
|
145
|
-
/**
|
|
146
|
-
* When url stops working
|
|
147
|
-
* @type {Date}
|
|
148
|
-
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
149
|
-
*/
|
|
150
|
-
expires_at: Date | null;
|
|
151
145
|
}
|
|
152
146
|
/**
|
|
153
147
|
* @export
|
|
@@ -78,8 +78,6 @@ export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value)
|
|
|
78
78
|
return false;
|
|
79
79
|
if (!('url' in value) || value['url'] === undefined)
|
|
80
80
|
return false;
|
|
81
|
-
if (!('expires_at' in value) || value['expires_at'] === undefined)
|
|
82
|
-
return false;
|
|
83
81
|
return true;
|
|
84
82
|
}
|
|
85
83
|
export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON(json) {
|
|
@@ -111,7 +109,6 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
111
109
|
'group_label': json['group_label'],
|
|
112
110
|
'category': json['category'],
|
|
113
111
|
'url': json['url'],
|
|
114
|
-
'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
|
|
115
112
|
};
|
|
116
113
|
}
|
|
117
114
|
export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSON(json) {
|
|
@@ -143,6 +140,5 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
143
140
|
'group_label': value['group_label'],
|
|
144
141
|
'category': value['category'],
|
|
145
142
|
'url': value['url'],
|
|
146
|
-
'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
|
|
147
143
|
};
|
|
148
144
|
}
|
|
@@ -70,17 +70,11 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
|
|
|
70
70
|
*/
|
|
71
71
|
accession_number: string | null;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Permanent public download URL; null for link-only rows (sec_filing) or a failed download: use source_url
|
|
74
74
|
* @type {string}
|
|
75
75
|
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
76
76
|
*/
|
|
77
77
|
url: string | null;
|
|
78
|
-
/**
|
|
79
|
-
* When url stops working
|
|
80
|
-
* @type {Date}
|
|
81
|
-
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
82
|
-
*/
|
|
83
|
-
expires_at: Date | null;
|
|
84
78
|
/**
|
|
85
79
|
* MIME type
|
|
86
80
|
* @type {string}
|