get_metrics
Get financial metrics/ratios for NZX companies. 46 ratios: profitability (incl. comprehensive_roe, oci_divergence), leverage (incl. paid_in_capital_ratio), cash flow, dividends, growth (incl. share_capital_growth), valuation, composite. Use for screening or comparison.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_metrics"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | For single ticker: "snapshot" (default) or "historical" | |
| sort | No | Sort by metric (e.g. "pe_ratio", "roe", "dividend_yield") | |
| year | No | Year or range filter | |
| limit | No | Max results | |
| order | No | "asc" or "desc" | |
| sector | No | Filter by sector (list mode only) | |
| ticker | No | Specific ticker for detailed metrics with live valuation. Omit for list of all companies. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | The tool payload. Null when the call did not produce one — read meta.availability_status to find out why, and do not treat null as zero, empty or "none found". | |
| meta | Yes | ||
| tool | Yes | Tool that produced this result. | |
| schema_version | Yes | Envelope contract version. Bumps only on a breaking shape change. |