How to Get Fundamentals

From a ticker to statements, single numbers and ratios. The examples use Apple's 10-K for fiscal 2025.

#1. Find the filing

The list action of Filings shows a company's filings for a fiscal year, each with its id. The actions that read a filing take that id as filing_id, or ticker and fiscal_year, plus form_type and quarter for a quarterly report.

{"action": "list", "ticker": "AAPL", "fiscal_year": 2025}

#2. Read a statement

The get action of Statements and notes returns a statement as filed, every row with its value, period, unit and source. statement_type takes the five main statements by name, for US filings; role_label takes any statement or note by the name the filer gave it, and the list action shows those names.

{"action": "get", "ticker": "AAPL", "fiscal_year": 2025, "statement_type": "Income Statement"}

#3. Get single numbers

The get action of Financial facts looks up line items by name, each value with its period, unit and a link to its place in the filing.

{"action": "get", "ticker": "AAPL", "fiscal_year": 2025, "line_items": ["revenue", "net income"]}

To compare years or companies, pass one row per filing in filings. When the filings' fiscal years end on different dates, _warnings says so.

{"action": "get", "filings": [{"ticker": "AAPL", "fiscal_year": 2025}, {"ticker": "MSFT", "fiscal_year": 2025}], "line_items": ["revenue"]}

#4. Add the ratios

The get action of Computed metrics returns 82 metrics computed from the filing, each with its formula and the facts it used; category keeps one of six groups. US companies only, on the Starter plan or higher.

{"action": "get", "ticker": "AAPL", "fiscal_year": 2025, "category": "profitability"}

The history action returns the same metrics over many periods, up to 5 per page; sort set to period_end_desc starts from the latest.

{"action": "history", "ticker": "AAPL", "period_type": "annual", "sort": "period_end_desc", "page_size": 5, "metric_names": ["gross_margin"]}