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

# Metrics

> Free.



## OpenAPI

````yaml api-reference/openapi.standard.json GET /metrics
openapi: 3.1.0
info:
  title: Syrto API - standard endpoints
  version: 1.7.0
  description: >-
    Financial, corporate and market data on Italian companies.


    Every call answers `200 { data, meta }`; `meta.usage.quantity` is what the
    call consumed, in

    credits, and `meta.warnings` lists any non-fatal caveats (empty when there
    are none). Every field

    is always present and unknown values are null. Percentages are fractions
    (0.15 = 15%).


    **Authentication.** Every call needs an API key, sent as `Authorization:
    Bearer sk_...` over

    HTTPS - never in a URL. Keys are scoped to your organization: admins create
    and revoke them in the

    Syrto dashboard (https://dashboard.syrto.ai/api-keys). A missing or
    unrecognised key is a 401

    (`missing_api_key`, `invalid_api_key`); a 503 `auth_unavailable` means the
    key could not be

    checked right now, so retry with backoff rather than rotating it.


    **Billing basis.** negativities, rna and structure bill once per legal
    entity: the individual and

    consolidated records of the same company count once. Every other endpoint
    bills per record (or per

    call), so individual and consolidated count separately. A tax id always
    resolves to a single record

    (`statementBasis`, individual by default): a company is billed twice only
    when both of its

    companyIds are passed. A market call is priced per call, whatever the size
    of its set: omitting

    `filters` and `seedId`, or sending `filters: {}`, is the whole of Italy, at
    the same price.

    notFound entries are never billed, and neither is any error.
servers:
  - url: https://api.syrto.ai
security: []
tags:
  - name: Company data
    description: Identity, risk flags, state aid and branches of known companies.
  - name: Governance
    description: Ownership, officers, beneficial owners and group.
  - name: Financials
    description: Statement items, reclassified statements, indices and spider graph.
  - name: Composite
    description: Comparable companies.
  - name: Search
    description: The companies of a filtered set, row by row.
  - name: Market
    description: Aggregates over a filtered set.
  - name: Catalog
    description: Free reference data.
paths:
  /metrics:
    get:
      tags:
        - Catalog
      summary: 'The 55 indices: slug, localized name, category, kind, unit and formula.'
      description: Free.
      operationId: metrics
      parameters:
        - schema:
            type: string
            enum:
              - it
              - en
            description: >-
              Language of metric names, labels and descriptions (never of field
              names or slugs). Omitted: the account's default.
          required: false
          description: >-
            Language of metric names, labels and descriptions (never of field
            names or slugs). Omitted: the account's default.
          name: language
          in: query
      responses:
        '200':
          description: >-
            The 55 indices: slug, localized name, category, kind, unit and
            formula.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MetricCatalog'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
        '401':
          description: missing_api_key | invalid_api_key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: credits_exhausted | limit_reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: client_not_configured | not_entitled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: unknown_endpoint | not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: invalid_params
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: rate_limited
          headers:
            Retry-After:
              description: >-
                Seconds to wait before retrying. Neither a 429 nor a 504 is
                billed. A 504 whose query had reached the data service leaves it
                running, and its answer is cached, so the same call after this
                delay is usually fast.
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: upstream_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: auth_unavailable | entitlement_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '504':
          description: upstream_timeout
          headers:
            Retry-After:
              description: >-
                Seconds to wait before retrying. Neither a 429 nor a 504 is
                billed. A 504 whose query had reached the data service leaves it
                running, and its answer is cached, so the same call after this
                delay is usually fast.
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    MetricCatalog:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/MetricDefinition'
      required:
        - items
    ResponseMeta:
      type: object
      properties:
        requestId:
          type: string
        endpoint:
          type: string
        usage:
          $ref: '#/components/schemas/Usage'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Warning'
          description: Empty when there are none.
      required:
        - requestId
        - endpoint
        - usage
        - warnings
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - missing_api_key
                - invalid_api_key
                - credits_exhausted
                - limit_reached
                - client_not_configured
                - not_entitled
                - unknown_endpoint
                - not_found
                - payload_too_large
                - unsupported_media_type
                - invalid_params
                - rate_limited
                - internal_error
                - upstream_error
                - auth_unavailable
                - entitlement_unavailable
                - upstream_timeout
            message:
              type: string
            requestId:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
                required:
                  - path
                  - message
          required:
            - code
            - message
            - requestId
      required:
        - error
    MetricDefinition:
      type: object
      properties:
        slug:
          $ref: '#/components/schemas/MetricSlug'
        name:
          type: string
          description: Localized; not part of the contract.
        category:
          $ref: '#/components/schemas/MetricCategory'
        kind:
          type: string
          enum:
            - index
            - absolute
          description: >-
            `absolute` is an amount: comparing it with marketValue says how BIG
            the company is against its peers, not how good.
        unit:
          $ref: '#/components/schemas/MetricUnit'
        formulaLatex:
          type:
            - string
            - 'null'
          description: >-
            How the metric is computed, as a LaTeX formula (render it). Null for
            items read directly from the statement.
      required:
        - slug
        - name
        - category
        - kind
        - unit
        - formulaLatex
    Usage:
      type: object
      properties:
        quantity:
          type: number
        unit:
          type: string
      required:
        - quantity
        - unit
    Warning:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
    MetricSlug:
      type: string
      enum:
        - revenues_from_sales_and_services
        - value_of_production
        - profit
        - added_value
        - ebitda
        - ebit
        - added_value_employee
        - ebitda_margin
        - ebit_margin
        - roe
        - roa
        - sales_assets
        - revenue_cagr_3_years
        - ebitda_cagr_3_years
        - personnel_cost_to_revenue
        - raw_materials_contribution
        - services_and_leases_contribution
        - net_working_capital
        - ufcf
        - cash_ratio
        - quick_ratio
        - secondary_liquidity
        - days_sales_outstanding
        - days_sales_outstanding_commercial_receivables
        - days_payable_outstanding
        - dpo_commercial_debt
        - days_sales_inventory
        - cash_conversion_cycle
        - cash_conversion_cycle_commercial
        - net_financial_position
        - current_net_financial_position
        - net_financial_position_ebitda
        - debt_ebitda_ratio
        - indeb_ratio
        - financial_leverage
        - over_indebtedness_ratio
        - interest_coverage_ratio_ebitda_based
        - debt_service_cover_ratio_ebitda_version
        - debt_service_cover_ratio_cash_flow_based
        - cost_borrowed_money
        - financial_sustainability
        - financial_charges_on_nfp
        - capex
        - invested_capital
        - equity_ratio
        - self_coverage
        - financial_debt_net_worth
        - non_curr_liabilities_fixed_asset_ratio
        - capex_sales_ratio
        - debt_on_revenue
        - short_term_debt_on_revenue
        - current_debt_to_total_debt_ratio
        - curr_asset_total_asset_ratio
        - cash_curr_asset_ratio
        - tfr_contribution
      description: >-
        One of the 55 indices; GET /metrics (free) lists them with their names,
        units and formulas. Slugs are part of the contract; names are localized.
    MetricCategory:
      type: string
      enum:
        - profitability
        - liquidity
        - solvency
        - structure
    MetricUnit:
      type: string
      enum:
        - eur
        - pct
        - ratio
        - days
        - eur_per_head
        - count
      description: >-
        `pct` is a fraction, never multiplied: 0.15 is 15%, and it may exceed 1
        or be negative. `eur_per_head` is euro per employee.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Org-scoped WorkOS API key (sk_...), sent as `Authorization: Bearer
        <key>`. Admins create and revoke keys in the Syrto dashboard:
        https://dashboard.syrto.ai/api-keys

````

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