API ReferenceFundamentals
Key metrics (snapshot)
/api/v3/fundamentals/metrics_snapshot- Plan
- Free and up
- Price
- 1 credit per call
- MCP tool
fundamentals_metrics_ snapshot
Latest fundamentals snapshot for a ticker in one call: profile, latest fiscal year and quarter, a trailing-twelve-months block (income, cash flow, ratios), the latest quarter-end balance sheet, the latest quarter's ratios and fiscal-year growth. The blocks cover DIFFERENT periods and units, and each says so: period (type quarter, fiscal_year, ttm (four consecutive quarters), partial_ttm (anything less) or point_in_time, with fiscal_year, fiscal_quarter, start, end) and units per numeric field (percent, fraction, usd, usd_per_share, multiple, shares, count; reporting_currency with a currency code when not US dollars). ttm.ttm_ratios and growth are PERCENT numbers (roe_ttm 84.23 = 84.23%); ratios is FRACTIONS of the latest quarter alone, not annualized (roe 0.2812 = 28.12% that quarter); ratio blocks carry definitions. TTM sums four CONSECUTIVE fiscal quarters: with fewer, or a gap, the sums are null and ttm_status says why; a field some quarters leave empty is summed over the rest and named in ttm_underfilled_fields. TTM EPS is on today's share basis (eps_ttm_basis). Dividends: dividend holds split-adjusted trailing and indicated dividends per share with their dates; in dividends, dividends_per_share is the fiscal year's paid over that year's shares as filed, payout_ratio is a PERCENT, and dividend_history rows carry per_share_split_adjusted. Call this for a quick 'how profitable is X, how fast is it growing' check; use fundamentals_metrics when the user needs the per-period history. Statement blocks carry statement_check. An unknown symbol is refused 404 unknown_ticker (not billed).
Parameters
Query
tickerstringRequiredResponse
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Fundamentals). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.
A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.
Errors
No error is billed. The body is { "ok": false, "error", "detail", "request_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed. |
401 unauthorized | Missing or invalid API key. |
402 plan_required | Your plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed. |
403 scope_denied | This API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed. |
404 unknown_ticker | No data source lists this ticker, active or delisted: the market-data listing and the security master both say it does not exist. param names the parameter. Not billed. Best-effort: it is answered only when the route itself found nothing, and after 20 lookups of new symbols per API key per minute the route's own answer stands. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The request ran past the server's time budget; retry. Not billed. |
This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.
Guides
Read the Fundamentals guide for this endpoint's fields and examples.