> ## 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.

# Metriche

> Gratuito.



## OpenAPI

````yaml api-reference/openapi.standard.it.json GET /metrics
openapi: 3.1.0
info:
  title: Syrto API - endpoint standard
  version: 1.7.0
  description: >-
    Dati finanziari, societari e di mercato sulle aziende italiane.


    Ogni chiamata risponde `200 { data, meta }`; `meta.usage.quantity` è quanto
    ha consumato la

    chiamata, in crediti, e `meta.warnings` elenca eventuali avvertenze non
    bloccanti (vuoto quando non

    ce ne sono). Ogni campo è sempre presente e i valori sconosciuti sono null.
    Le percentuali sono

    frazioni (0,15 = 15%).


    **Autenticazione.** Ogni chiamata richiede una chiave API, inviata come
    `Authorization: Bearer sk_...`

    su HTTPS - mai in un URL. Le chiavi sono legate alla tua organizzazione: gli
    admin le creano e le

    revocano nella dashboard Syrto (https://dashboard.syrto.ai/api-keys). Una
    chiave mancante o non

    riconosciuta è un 401 (`missing_api_key`, `invalid_api_key`); un 503
    `auth_unavailable` significa

    che in questo momento non è stato possibile verificare la chiave, quindi
    riprova con backoff invece di

    ruotarla.


    **Base di addebito.** negativities, rna e structure addebitano una volta per
    persona giuridica: il

    record individuale e quello consolidato della stessa azienda contano una
    volta. Ogni altro endpoint

    addebita per record (o per chiamata), quindi individuale e consolidato
    contano separatamente. Un

    codice fiscale si risolve sempre in un solo record (`statementBasis`,
    individuale per impostazione

    predefinita): un'azienda viene addebitata due volte solo se vengono passati
    entrambi i suoi

    companyId. Una chiamata di mercato ha un prezzo per chiamata, qualunque sia
    la dimensione

    dell'insieme: omettere `filters` e `seedId`, o inviare `filters: {}`,
    significa tutta l'Italia, allo

    stesso prezzo. Le voci notFound non vengono mai addebitate, e nemmeno alcun
    errore.
servers:
  - url: https://api.syrto.ai
security: []
tags:
  - name: Company data
    description: Identità, indicatori di rischio, aiuti di Stato e sedi di aziende note.
  - name: Governance
    description: Proprietà, dirigenti, titolari effettivi e gruppo.
  - name: Financials
    description: Voci di bilancio, bilanci riclassificati, indici e grafico spider.
  - name: Composite
    description: Aziende comparabili.
  - name: Search
    description: Le aziende di un insieme filtrato, riga per riga.
  - name: Market
    description: Aggregati su un insieme filtrato.
  - name: Catalog
    description: Dati di riferimento gratuiti.
paths:
  /metrics:
    get:
      tags:
        - Catalog
      summary: 'I 55 indici: slug, nome localizzato, categoria, tipo, unità e formula.'
      description: Gratuito.
      operationId: metrics
      parameters:
        - schema:
            type: string
            enum:
              - it
              - en
            description: >-
              Lingua di nomi, etichette e descrizioni delle metriche (mai dei
              nomi dei campi o degli slug). Omessa: la lingua predefinita
              dell'account.
          required: false
          description: >-
            Lingua di nomi, etichette e descrizioni delle metriche (mai dei nomi
            dei campi o degli slug). Omessa: la lingua predefinita dell'account.
          name: language
          in: query
      responses:
        '200':
          description: >-
            I 55 indici: slug, nome localizzato, categoria, tipo, unità e
            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: >-
                Secondi da attendere prima di riprovare. Né un 429 né un 504
                vengono addebitati. Un 504 la cui query aveva raggiunto il
                servizio dati lo lascia in esecuzione, e la sua risposta viene
                messa in cache, quindi la stessa chiamata dopo questo intervallo
                è di solito veloce.
              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: >-
                Secondi da attendere prima di riprovare. Né un 429 né un 504
                vengono addebitati. Un 504 la cui query aveva raggiunto il
                servizio dati lo lascia in esecuzione, e la sua risposta viene
                messa in cache, quindi la stessa chiamata dopo questo intervallo
                è di solito veloce.
              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: Vuoto quando non ce ne sono.
      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: Localizzato; non fa parte del contratto.
        category:
          $ref: '#/components/schemas/MetricCategory'
        kind:
          type: string
          enum:
            - index
            - absolute
          description: >-
            `absolute` è un importo: confrontarlo con marketValue dice quanto è
            GRANDE l'azienda rispetto ai suoi pari, non quanto sia buona.
        unit:
          $ref: '#/components/schemas/MetricUnit'
        formulaLatex:
          type:
            - string
            - 'null'
          description: >-
            Come si calcola la metrica, come formula LaTeX (da renderizzare).
            Null per gli elementi letti direttamente dal bilancio.
      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: >-
        Uno dei 55 indici; GET /metrics (gratuito) li elenca con nomi, unità e
        formule. Gli slug fanno parte del contratto; i nomi sono localizzati.
    MetricCategory:
      type: string
      enum:
        - profitability
        - liquidity
        - solvency
        - structure
    MetricUnit:
      type: string
      enum:
        - eur
        - pct
        - ratio
        - days
        - eur_per_head
        - count
      description: >-
        `pct` è una frazione, mai moltiplicata: 0,15 equivale al 15%, e può
        superare 1 o essere negativa. `eur_per_head` è euro per dipendente.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chiave API di organizzazione WorkOS (sk_...), inviata come
        `Authorization: Bearer <key>`. Gli admin creano e revocano le chiavi
        nella dashboard Syrto: https://dashboard.syrto.ai/api-keys

````

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