Get financial ratios
get_ratiosRatios computed from a company's latest snapshot by formulas with stable ids (bank.roe, corp.roic). Every value gives its unit, period and the snapshot figures it was computed from, each with its value and source document ids. Banks use the bank template (quarterly values annualised); US companies use the corporate template (annual, quarterly and trailing four quarters, ttm), which includes credit metrics, liquidity, earnings quality and forensic scores; scores, credit reconciliations and the liquidity cover also give their parts, named with their coefficients in the catalogue. A value computed with an estimated input, such as the lease cost of the latest fiscal year for quarters that do not report it, names it in estimates; a ratio that a rule leaves out for the company gives the reason in excluded. Call without ratios to list the catalogue of one frequency.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | last period, in the same forms | |
| from | No | first period: a fiscal year (2024), a fiscal quarter (FY2024 Q2) or an ISO date | |
| limit | No | maximum values, latest periods kept (default 120) | |
| ratios | No | ratio ids or short names, for example ["roe", "corp.operating_margin"]; leave empty for all | |
| compact | No | true for the values with their units only, without the conventions, the catalogue entries, the inputs and the citation format | |
| company | Yes | company id from search_companies | |
| category | No | keep one category, for example Profitability | |
| frequency | No | default annual |