List metric snapshots
list_metric_snapshotsDiscover computed metric snapshots for a ticker: returns metric_group_id entries (and filing metadata) you feed into get_metrics_bundle or get_metrics_subset. Required: ticker. You must supply at least one of fiscal_year or a valid as_of_date (YYYY-MM-DD). Optional: form_types (list — accepts 10-K / 10-Q / 20-F / 40-F; omit to include every form for the ticker), quarter. Use this when the user wants metrics but you only know ticker/year or as-of date. Results may be truncated by your plan's history window or coverage scope — check _warnings. Companies outside your plan's coverage scope return 403 PLAN_TIER_INSUFFICIENT_COVERAGE. Computed metrics exist for US (SEC) companies only; other jurisdictions fail fast (400 METRICS_UNSUPPORTED_FOR_) with no credits charged. 10 credits. POST /api/v1/metric/filings; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ticker | Yes | Company ticker, e.g. "AAPL" (US) or "000100" (Korea). | |
| quarter | No | Quarter label, e.g. "Q1"–"Q4" or "FY". Only needed to disambiguate quarterly filings. | |
| as_of_date | No | As-of date "YYYY-MM-DD"; excludes filings filed after this date. Defaults to no cutoff. | |
| form_types | No | Optional form filter, e.g. ["10-K", "10-Q"] (≤ 8). Omit to include every form. Supply at least one of fiscal_year or as_of_date. | |
| fiscal_year | No | Reporting fiscal year (1990–2100). Required together with ticker when filing_id is omitted. |