/metric/all

Conditional. 1–10⁹.

Conditional. 1–10⁹.

Conditional, with fiscal_year. 1–32 characters.

Conditional, with ticker. 1990–2100.

Only with ticker and fiscal_year.

Default 10-K

Only with ticker and fiscal_year.

Default null

YYYY-MM-DD: exclude this filing if its filing date is after this date.

Default null

When true, applies suggested formula hints included with the filing’s metrics (if any).

Default false

Per-metric overrides. Keys are metric names (e.g. "operating_margin"). Values are objects containing "concepts" (array of strings, at most 50 entries per metric) and "operators" (array of strings, e.g. ["+", "-"], length must be exactly len(concepts) - 1). A lone top-level { "concepts": ... } object is invalid.

Default null

USD price used to compute realtime price-sensitive metrics (market_cap, pe_ratio, enterprise_value, price_to_book, price_to_sales, price_to_cash_flow, ev_to_ebitda, ev_to_revenue, ev_to_fcf, fcf_yield, dividend_yield, buyback_yield, owner_earnings_yield). Must be > 0, ≤ 10,000,000, with at most 4 decimal places. Pass the USD price as-is for all filings, including foreign-issuer ADRs. Invalid values return HTTP 422 without charging credits. When omitted, the realtime block is replaced by { "status": "missing", "hint": "..." } and the same hint appears in _warnings.

Default null

Optional fallback FX rate (units of the filing's reporting_currency per 1 USD), used only when an up-to-date conversion rate is temporarily unavailable for foreign-issuer ADR filings. Must be > 0, ≤ 1,000,000, with at most 6 decimal places. Invalid values return HTTP 422 without charging credits.

Default null

"light" leaves out each metric's components. See Light and minimal views.

Default "full"

158.

The metric group ID actually used (may be null if excluded by as_of_date).

Echo of flags and formula inputs.

Filing identity and SEC base URL. source_url_prefix may be null; combine it with each fact’s source_locator (see below) to build the SEC viewer URL.

Array of segment data.

Object containing metrics that do not depend on stock price. Within each metric, nested fact_refs / components entries that expose fact_id also expose source_locator (may be null).

Object containing metrics that depend on stock price: a filing_date_price + historical pair (the metrics computed from the filing-date stock price) and, when the filing has price-sensitive metrics, a realtime sub-object (computed from the request's current_price; when realtime cannot be computed it is { "status": "missing" | "missing_fx_fallback", "hint": "..." }). For foreign-issuer ADR filings each computed metric carries a price_used block — see Response conventions. Same source_locator convention on nested fact references where fact_id is present. POST /metric/all/filing-date returns the filing-date block only.

Present whenever the response would include a realtime block. status is "ok" (price applied), "missing" (no current_price supplied), or "missing_fx_fallback" (foreign-issuer filing and an up-to-date conversion rate is temporarily unavailable). When ok, also includes price, price_date, source: "user_supplied", and fx_fallback_used: true if the caller-supplied current_fx_rate was used because an up-to-date rate was unavailable. mode is always present; on the two non-ok statuses a message states what to send.

Optional root fields, present when the filing has them.

Present (true) when this filing had a later amendment merged in. The returned metric values are already the amended figures.

Optional root field, present when the ticker has corporate action events in the lookback window. Contains events_in_lookback and events_after_period_end (relative to this filing's period end); each event carries ex_date, ratio, type (forward / reverse), event_type (e.g. stock_split, stock_dividend), affects_total_shares, affects_holder_share_count, and relevant_to_metrics. Also carries adjustment_factor_to_today (factor converting this filing's per-share basis to the current basis), adjustment_factor_anchor (the date the factor is anchored on), and adjustment_factor_anchor_basis (how the anchor is chosen; period_end). When adjustment_factor_to_today is not 1, three per-share metrics — pe_ratio, dividend_yield, eps_growth_yoy — additionally carry adjusted_value, adjustment_factor, and comparable_to_current_basis, so values from this filing can be compared on the current per-share basis; when it is 1 the filing is already on that basis and those three fields are absent. Total values (revenue, market_cap, etc.) are unaffected. Tickers with no events in the window omit the field entirely.

Optional; warnings about amendments or formulas.