Fundamentals Metrics API
Browse standardized metric ids—revenue, margins, ratios, balance-sheet lines—before requesting values. Optional category filters; pass ids on Fundamentals.
curl -X GET "https://example.com/v2/fundamentals/metrics?category=RATIOS&subcategory=LIQUIDITY&pit_data_items=false"{ "category": "RATIOS", "subcategory": "LIQUIDITY", "metric_data_type": null, "pit_data_items": false, "count": 9, "categories": [ "INCOME_STATEMENT", "BALANCE_SHEET", "CASH_FLOW", "RATIOS", "MARKET_DATA", "MISCELLANEOUS" ], "subcategories": [ "INCOME_STATEMENT", "NON-OPERATING", "PER_SHARE", "SUPPLEMENTAL", "EXPENSES", "OPERATING_COST", "NON-RECURRING_ITEMS", "REVENUES", "NET_INCOME", "ASSETS", "BALANCE_SHEET", "LIABILITIES", "SHAREHOLDERS_EQUITY", "CHANGE_IN_CASH", "FINANCING_ACTIVITIES", "OPERATING_ACTIVITIES", "INVESTING_ACTIVITIES", "FINANCIAL", "GROWTH_RATE", "LIQUIDITY", "PROFITABILITY", "SIZE", "VALUATION", "MARKET_DATA", "INDICATOR" ], "metrics": [ { "metric": "cashConversionCycle", "name": "Cash Conversion Cycle", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": "CCC = DIO + DSO − DPO (Investopedia)", "data_type": "float", "factor": 1, "formula": "daysOfInventoryOutstanding + daysOfSalesOutstanding - daysOfPayablesOutstanding", "formula_display": "daysOfInventoryOutstanding + daysOfSalesOutstanding - daysOfPayablesOutstanding", "layer": "source_table", "is_currency": false, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "ratio" }, { "metric": "cashRatio", "name": "Cash Ratio", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": "cash & ST investments / CL", "data_type": "float", "factor": 1, "formula": "div_safe(to_float(balance.cashAndShortTermInvestments), to_float(balance.totalCurrentLiabilities))", "formula_display": "cashAndShortTermInvestments / totalCurrentLiabilities", "layer": "source_table", "is_currency": false, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "ratio" }, { "metric": "currentRatio", "name": "Current Ratio", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": "Liquidity measure of current assets covering current liabilities.", "methodology": "CFA Institute #1. Current assets / current liabilities. Uses period-end balances; CFA often prefers period averages.", "data_type": "float", "factor": 1, "formula": "div_safe(to_float(balance.totalCurrentAssets), to_float(balance.totalCurrentLiabilities))", "formula_display": "totalCurrentAssets / totalCurrentLiabilities", "layer": "source_table", "is_currency": false, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "ratio" }, { "metric": "grahamNetNet", "name": "Graham Net Net", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": "Graham net-net working capital", "data_type": "float", "factor": 1, "formula": "to_float(balance.totalCurrentAssets) - to_float(balance.totalLiabilities)", "formula_display": "totalCurrentAssets - totalLiabilities", "layer": "source_table", "is_currency": true, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "money" }, { "metric": "netCurrentAssetValue", "name": "Net Current Asset Value", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": "Graham NCAV", "data_type": "float", "factor": 1, "formula": "to_float(balance.totalCurrentAssets) - to_float(balance.totalCurrentLiabilities) - to_float(balance.totalDebt)", "formula_display": "totalCurrentAssets - totalCurrentLiabilities - totalDebt", "layer": "source_table", "is_currency": true, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "money" }, { "metric": "netWorkingCapital", "name": "Net Working Capital", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": null, "data_type": "float", "factor": 1, "formula": "to_float(balance.totalCurrentAssets) - to_float(balance.totalCurrentLiabilities)", "formula_display": "totalCurrentAssets - totalCurrentLiabilities", "layer": "source_table", "is_currency": true, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "money" }, { "metric": "operatingCycle", "name": "Operating Cycle", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": "DIO + DSO", "data_type": "float", "factor": 1, "formula": "daysOfInventoryOutstanding + daysOfSalesOutstanding", "formula_display": "daysOfInventoryOutstanding + daysOfSalesOutstanding", "layer": "source_table", "is_currency": false, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "ratio" }, { "metric": "quickRatio", "name": "Quick Ratio", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": null, "is_pit": false, "is_non_pit": true, "description": null, "methodology": "CFA acid-test: (CA − inventory − prepaids) / CL", "data_type": "float", "factor": 1, "formula": "div_safe(to_float(balance.totalCurrentAssets) - to_float(balance.inventory) - coalesce(to_float(balance.prepaids), 0), to_float(balance.totalCurrentLiabilities))", "formula_display": "(totalCurrentAssets - inventory - coalesceprepaids / (0), totalCurrentLiabilities)", "layer": "source_table", "is_currency": false, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "ratio" }, { "metric": "workingCapital", "name": "Working Capital", "category": "RATIOS", "subcategory": "LIQUIDITY", "base_code": "netWorkingCapital", "is_pit": false, "is_non_pit": true, "description": null, "methodology": "current assets − current liabilities", "data_type": "float", "factor": 1, "formula": "to_float(balance.totalCurrentAssets) - to_float(balance.totalCurrentLiabilities)", "formula_display": "totalCurrentAssets - totalCurrentLiabilities", "layer": "source_table", "is_currency": true, "periodicities": [ "fy", "quarter", "ttm" ], "value_type": "money" } ]}Query Parameters
category?string
INCOME_STATEMENT, BALANCE_SHEET, CASH_FLOW, RATIOS, MARKET_DATA, or MISCELLANEOUS. Omit to return every category. See Fundamentals Overview.
Value in
- "INCOME_STATEMENT"
- "BALANCE_SHEET"
- "CASH_FLOW"
- "RATIOS"
- "MARKET_DATA"
- "MISCELLANEOUS"
subcategory?string
Sub-category that currently has metrics. Can be used without category. See Fundamentals Overview.
Value in
- "INCOME_STATEMENT"
- "NON-OPERATING"
- "PER_SHARE"
- "SUPPLEMENTAL"
- "EXPENSES"
- "OPERATING_COST"
- "NON-RECURRING_ITEMS"
- "REVENUES"
- "NET_INCOME"
- "ASSETS"
- "BALANCE_SHEET"
- "LIABILITIES"
- "SHAREHOLDERS_EQUITY"
- "CHANGE_IN_CASH"
- "FINANCING_ACTIVITIES"
- "OPERATING_ACTIVITIES"
- "INVESTING_ACTIVITIES"
- "FINANCIAL"
- "GROWTH_RATE"
- "LIQUIDITY"
- "PROFITABILITY"
- "SIZE"
- "VALUATION"
- "MARKET_DATA"
- "INDICATOR"
metric_data_type?string
float, integer, or string. Omit to return every type.
Value in
- "float"
- "integer"
- "string"
pit_data_items?boolean
true returns metrics available in point-in-time datasets. false (default) returns non-PIT period-end metrics.
Default
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json