Get metrics time series
get_metrics_timeseriesTime series of metrics for a ticker across many periods (quarterly or annual). Use for trends like gross margin or revenue over time, with paging. Required: ticker. period_type is quarterly or annual (default quarterly). period_type=annual covers 10-K plus foreign-issuer annual forms (20-F, 40-F); period_type=quarterly covers 10-Q (foreign issuers have no quarterly counterpart); Korean (DART) filings use the same form types (annual = 10-K, quarterly = 10-Q). Optional: start_period_start, end_period_end, metric_names, as_of_date, accept_suggested_formula, formula_override, sort (period_end_asc|period_end_desc), page, page_size (1–5), light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). 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. POST /api/v1/metric/historical; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number (default 1). | |
| sort | No | "period_end_asc" (default) or "period_end_desc". | period_end_asc |
| ticker | Yes | Company ticker, e.g. "AAPL" (US) or "000100" (Korea). | |
| page_size | No | Rows per page, 1–5 (default 3). | |
| as_of_date | No | As-of date "YYYY-MM-DD"; excludes filings filed after this date. Defaults to no cutoff. | |
| period_type | No | "quarterly" (default) or "annual". annual covers 10-K / 20-F / 40-F (incl. Korean annual); quarterly covers 10-Q (incl. Korean quarterly). | quarterly |
| metric_names | No | Optional metric ids to include, e.g. ["gross_margin"]. Omit for all. | |
| end_period_end | No | Optional upper bound on the reporting period end, "YYYY-MM-DD". | |
| formula_override | No | Optional per-metric formula overrides, keyed by metric id, e.g. {"interest_coverage": {"concepts": ["OperatingIncomeLoss", "InterestExpense"], "operators": ["/"]}}. Each entry lists XBRL concepts and the operators combining them. Requires the Pro plan or higher. | |
| light_weight_mode | No | When true, return a leaner payload (drops the most verbose nested fields). Charged the same. Saves context when you already know exactly what you need. | |
| start_period_start | No | Optional lower bound on the reporting period start, "YYYY-MM-DD". | |
| accept_suggested_formula | No | When true, accept the server's suggested formula for metrics that need one to compute. |