Sign in

v3

latestOpenAPI 3.1.02026-07-26490368.4 KB
Standardized

Get the list of all standardized metrics.

Returns the list of all standardized metrics.

get/v1/standardized-metrics-list/{templateType}/{statementType}

Path parameters

templateType'standard' | 'capital-markets' | 'financials' | 'insurance' | 'utilities' | 'real-estate' required

Reporting template category

Example:standard

Reporting template category

statementType'income-statement' | 'balance-sheet' | 'cash-flow-statement' required

Financial statement category

Example:income-statement

Financial statement category

Query parameters

apiKeystring

API Key (alternatively send via X-Api-Key header)

API Key (alternatively send via X-Api-Key header)

Response

Standardized metrics list

reportingTemplate'Standard' | 'Capital Markets' | 'Financials' | 'Insurance' | 'Utilities' | 'Real Estate' required

Example response

{
  "reportingTemplate": "Standard",
  "metrics": [
    {
      "standardizedMetricId": "income_statement_total_revenues",
      "metricName": "Total Revenues",
      "metricFormat": "number",
      "isCurrency": true,
      "headers": [
        "Income"
      ],
      "definition": "The total amount of income generated from the sale of goods or services.",
      "subComponents": [
        {
          "uid": 1001,
          "metricId": "income_statement_gross_profit",
          "metricName": "Gross Profit",
          "operation": "+"
        }
      ]
    }
  ]
}