Skip to main content
Glama

Get metrics time series

get_metrics_timeseries
Read-onlyIdempotent

Time 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

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number (default 1).
sortNo"period_end_asc" (default) or "period_end_desc".period_end_asc
tickerYesCompany ticker, e.g. "AAPL" (US) or "000100" (Korea).
page_sizeNoRows per page, 1–5 (default 3).
as_of_dateNoAs-of date "YYYY-MM-DD"; excludes filings filed after this date. Defaults to no cutoff.
period_typeNo"quarterly" (default) or "annual". annual covers 10-K / 20-F / 40-F (incl. Korean annual); quarterly covers 10-Q (incl. Korean quarterly).quarterly
metric_namesNoOptional metric ids to include, e.g. ["gross_margin"]. Omit for all.
end_period_endNoOptional upper bound on the reporting period end, "YYYY-MM-DD".
formula_overrideNoOptional 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_modeNoWhen 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_startNoOptional lower bound on the reporting period start, "YYYY-MM-DD".
accept_suggested_formulaNoWhen true, accept the server's suggested formula for metrics that need one to compute.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark this read-only/idempotent; the description adds substantial non-obvious behavior: plan-tier truncation with `_warnings`, 403 PLAN_TIER_INSUFFICIENT_COVERAGE, 400 METRICS_UNSUPPORTED_FOR_<jurisdiction> with no credits charged, and plan requirements for formula_override. It also clarifies jurisdiction-specific form-type coverage. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but front-loaded: purpose and use case appear in the first two sentences before optional parameters and error handling. It is long because the tool is complex, and nearly every sentence carries operational information; minor redundancy with schema parameter descriptions keeps it from a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 12-parameter tool with no output schema, it covers required input, defaults, paging, date filters, plan limits, error codes, and jurisdiction caveats. It does not detail the response shape beyond paging and `_warnings`, but the operational guidance is sufficient to invoke correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers all 12 parameters, so baseline is 3; the description adds value by explaining period_type's form-type implications (10-K/20-F/40-F vs 10-Q, Korean DART equivalence), light_weight_mode's effect on audit fields, and plan gating for formula_override. This goes beyond the schema's own descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Time series of metrics for a ticker across many periods' — a specific verb, resource, and scope — and immediately frames the use case ('trends like gross margin or revenue over time'). It clearly distinguishes itself from sibling metrics tools by emphasizing multi-period time series and paging.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states 'Use for trends like gross margin or revenue over time, with paging,' giving clear context for when to call it. It does not explicitly name sibling alternatives or state when not to use it, so it stops short of full exclusion guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources