akkru_metrics

Metric set id from action "list". One of metric_group_id, filing_id, or ticker with fiscal_year names the filing.

Filing id from akkru_filings action "list". One of metric_group_id, filing_id, or ticker with fiscal_year names the filing.

Company ticker, e.g. "AAPL" (US), "000100" (Korea), "1332" (Japan), "VIRI_F" (Europe), "600519_CN" (China A-share); any symbol the company has traded under.

Form, default "10-K": "10-K" or "10-Q" for US filers, "20-F" or "40-F" for foreign issuers filing with the SEC. Korean, Japanese, Chinese and European filings use "10-K" for annual and "10-Q" for interim reports.

Fiscal year of the filing (1990-2100).

"FY", "Q1", "Q2", "Q3" or "Q4". list: filters the list, omit for every quarter; get: needed only when the fiscal year has several filings of the form; the error then lists the quarters on file.

Forms to include, e.g. ["10-K", "10-Q"] (up to 8). Default: every form.

Metric ids, e.g. ["gross_margin", "pe_ratio"]. get: only these; history: only these (default all). The names are in action "catalog".

One group of metrics: profitability, growth, financial_health, efficiency, cash_flow or valuation.

true: price-based ratios at the filing-date price only, without the current-price block; with all metrics or with category valuation.

Current share price in USD; price-based ratios are then also computed at it (above 0, at most 10,000,000, at most 4 decimals). Without it the current-price block says it is missing.

Fallback exchange rate, used only when the current rate for a foreign-currency filing is briefly unavailable (above 0, at most 1,000,000, at most 6 decimals).

true: compute the metrics that need a formula choice with the suggested formula.

Your own formula per metric id, e.g. {"interest_coverage": {"concepts": ["OperatingIncomeLoss", "InterestExpense"], "operators": ["/"]}}. Pro plan or higher.

Date "YYYY-MM-DD": only what had been filed by that day counts. Default: no cutoff.

"quarterly" (default) or "annual". annual covers 10-K, 20-F and 40-F; quarterly covers 10-Q.

Earliest period start, "YYYY-MM-DD".

Latest period end, "YYYY-MM-DD".

"period_end_asc" (default) or "period_end_desc".

Page number, from 1; the response's next_page gives the next one.

history: periods per page, 1-5 (default 3); search: rows per page, 1-100 (default 50), with page times page_size at most 500.

Conditions and sort: {"filter": <tree>, "sort_by"?: <metric id, or "ticker", "period_end", "filing_date", "match_count">, "sort_order"?: "asc" or "desc"}. A tree is a leaf {"metric": <id>, "op": ">", ">=", "<", "<=" or "between", "value": <number, or [low, high] for between>} with at most one of "for_latest", "for_consecutive", "for_at_least": N; or {"and": [...]}, {"or": [...]}, {"not": <tree>}. 1-10 leaves, nesting depth at most 4.

How many filings back the conditions look (1-120, default 1); cut to your plan's history window.

true: quarterly filings count too; default annual only.

Only these companies (up to 100); any symbol a company has traded under. Default: every company.

Leave these companies out (up to 100).

true: only rows whose values are in USD.

Only companies in these sectors (names from akkru_metrics action "catalog"). Pro plan or higher.

false: the 13 price-based valuation ratios cannot be used in conditions or sorting; default true.

Conditions ignore metric values derived these ways, e.g. "composite" (the kinds are in action "catalog").

Extra metric ids to return next to the ones in the conditions (up to 10).

true (default): one row per company; false: one row per filing.

Response detail: "full" (default) returns the most detail available; "light" leaves out the bulkiest fields, such as breakdown lists; "minimal" returns the values with only what defines them. All three are charged the same. One of full, light, minimal.