> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rangler.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List standardized financial metrics

> Return supported financial metric names, definitions, and units.

Requires paid access.



## OpenAPI

````yaml /openapi.json get /v1/standardized-metrics-list
openapi: 3.1.0
info:
  title: Rangler API
  version: 1.0.0
  description: >-
    Customer-facing Rangler API for companies, standardized financials, filings,
    funds, market data, events, and webhooks.
servers:
  - url: https://api.rangler.co
    description: Live
  - url: https://sandbox-api.rangler.co
    description: Sandbox
security: []
tags:
  - name: Analyst estimates
    description: Consensus forecasts, revisions, contributor accuracy, and source evidence.
  - name: Analyst recommendations
    description: Analyst ratings, target-price views, and company recommendation history.
  - name: Calendar
    description: Company events and calendar exports.
  - name: Companies
    description: >-
      Company lookup, issuer details, dividends, daily trades, meeting media,
      and mentions.
  - name: Events
    description: >-
      Read earlier events and check for missed deliveries across the market, a
      company, or a fund.
  - name: Financials
    description: >-
      Standardized financial statements, reported tables, ratios, and links to
      filing sources.
  - name: Filings
    description: Filings, board changes, insider dealings, and extracted filing mentions.
  - name: Funds
    description: Fund directories, disclosures, snapshots, holdings, and performance data.
  - name: Markets
    description: Market directories and regular-session clock data.
  - name: News
    description: Company news developments and company-filtered news search.
paths:
  /v1/standardized-metrics-list:
    get:
      tags:
        - Financials
      summary: List standardized financial metrics
      description: |-
        Return supported financial metric names, definitions, and units.

        Requires paid access.
      operationId: get_v1_standardized-metrics-list
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatementMetricCatalogResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: unauthorized
                      code: unauthorized
                      message: Authentication required.
                      request_id: 28fa6152-7081-492e-8a7e-00beb237b689
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: forbidden
                      code: forbidden
                      message: Paid access is required.
                      request_id: 5c253b3e-778e-4a58-aaf8-07cb21e03563
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: validation_error
                      code: validation_error
                      message: Request validation failed
                      request_id: c5964dca-d290-4465-a3dc-f92d42aa9b17
                      details:
                        - type: missing
                          loc:
                            - query
                            - ticker
                          msg: Field required
                          input: null
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: rate_limit_exceeded
                      code: rate_limit_exceeded
                      message: Rate limit exceeded
                      request_id: cc4d369a-2c69-4ee2-909e-985ea35d14a9
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: internal_server_error
                      code: internal_server_error
                      message: Internal Server Error
                      request_id: 70b63aba-b8a3-41c2-bb0c-fbe67d84d37d
      security:
        - RanglerApiKey: []
components:
  schemas:
    StatementMetricCatalogResponse:
      properties:
        version:
          type: string
          title: Version
          description: Metric catalog version.
        units:
          additionalProperties:
            $ref: '#/components/schemas/StatementUnitConvention'
          type: object
          title: Units
        metrics:
          additionalProperties:
            $ref: '#/components/schemas/StatementMetricDefinitionRead'
          type: object
          title: Metrics
      type: object
      required:
        - version
        - units
        - metrics
      title: StatementMetricCatalogResponse
      description: Standard financial metric definitions and units.
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    StatementUnitConvention:
      properties:
        label:
          type: string
          title: Label
        description:
          type: string
          title: Description
        value_representation:
          type: string
          title: Value Representation
        scale:
          type: integer
          title: Scale
          default: 1
        currency_field:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency Field
      type: object
      required:
        - label
        - description
        - value_representation
      title: StatementUnitConvention
    StatementMetricDefinitionRead:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        definition:
          type: string
          title: Definition
        statement_types:
          items:
            type: string
          type: array
          title: Statement Types
        unit:
          type: string
          title: Unit
        display_unit:
          type: string
          title: Display Unit
        value_representation:
          type: string
          title: Value Representation
        source:
          type: string
          const: reported
          title: Source
          default: reported
      type: object
      required:
        - key
        - label
        - definition
        - unit
        - display_unit
        - value_representation
      title: StatementMetricDefinitionRead
    ErrorObject:
      type: object
      required:
        - type
        - code
        - message
        - request_id
      properties:
        type:
          type: string
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: array
              items:
                additionalProperties: true
                type: object
            - type: 'null'
  securitySchemes:
    RanglerApiKey:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.