IR Earnings Decks
get_ir_documentsRetrieve IR earnings-PRESENTATION-DECK text — forward guidance, operational KPIs, and segment outlook that are ONLY in the company's investor-relations slide deck and NOT in the SEC 8-K/10-Q release text or XBRL.
Reach for this when get_metric_history / get_xbrl_facts have no series for a KPI or guidance figure, or the 8-K earnings release from get_filing_section lacks it (decks are a separate source): production or revenue guidance ranges, segment/division outlook, KPIs shown as slide charts (e.g., berth capacity %, Mboed production guidance, adjusted-EBITDA guidance).
Use Cases:
"OXY Q3 2024 production guidance" -> get_ir_documents("OXY", fiscal_year=2024, fiscal_period="Q3", query="production guidance")
"NCLH berth capacity outlook" -> get_ir_documents("NCLH", fiscal_year=2021, fiscal_period="Q3", query="berth")
"KNTK adjusted EBITDA guidance range" -> get_ir_documents("KNTK", fiscal_year=2023, fiscal_period="Q3", query="EBITDA")
Each deck returns its title, original IR url, a stable MetricDuck-hosted gcs_uri, and the matching slide text cited by page. Pass a query to land on the exact page; omit it for a bounded prefix of the latest deck. Resolve by ticker or cik; narrow with fiscal_year/fiscal_period.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cik | No | 10-digit SEC CIK as an alternative to ticker (e.g., '0000797468'). | |
| mode | No | Response mode. 'full' (default): slide TEXT for the matched deck(s) — combine with query/period to pull a figure. 'list': a cheap one-row-per-item INVENTORY of the company's served IR documents (doc_kind, period, date, links; NO slide text) — use to answer "what IR materials does X have?". In list mode `query` is ignored (it filters slide text). | |
| query | No | Keyword filter over slide text — returns ONLY the deck pages whose text matches every word (whole-word AND, case-insensitive). Use this to pull a specific figure (e.g., query="production guidance", "berth capacity", "adjusted EBITDA guidance") so the response cites the exact page instead of dumping the deck. | |
| ticker | No | Company ticker symbol (e.g., 'OXY'). Required unless cik is provided. | |
| fiscal_year | No | Fiscal year of the deck (e.g., 2024). Narrows to one period when combined with fiscal_period. | |
| fiscal_period | No | Fiscal period: 'Q3' (with fiscal_year) or combined '2024Q3'. Omit to return the latest deck(s). |