Get efficiency metrics
get_efficiency_metricsTurnover ratios and working-capital days (10 metrics): asset_turnover, inventory_turnover, receivables_turnover, days_inventory, days_receivable, days_payable, cash_conversion_cycle, payables_turnover, net_operating_assets, net_operating_asset_turnover. Flat 148-credit cost. POST /api/v1/metric/efficiency; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of_date | No | As-of date "YYYY-MM-DD"; excludes filings filed after this date. Defaults to no cutoff. | |
| current_price | No | Current share price in USD for realtime price-sensitive ratios (> 0, ≤ 10,000,000, ≤ 4 decimals). Omit to get a hint instead. | |
| current_fx_rate | No | Fallback FX rate, used only when an up-to-date conversion rate is briefly unavailable on foreign-issuer filings (> 0, ≤ 1,000,000, ≤ 6 decimals). | |
| metric_group_id | Yes | Snapshot id from list_metric_snapshots identifying one filing-period's computed metrics. | |
| 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. | |
| accept_suggested_formula | No | When true, accept the server's suggested formula for metrics that need one to compute. |