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

# Aportar un label privado de tu API key (o de un caso, con X-Case-Id)

> Guarda una label privada de la key (o de la UI) que la aporta; con `X-Case-Id`, del caso.

**Costo:** 1 crédito de base (solo si la respuesta es < 400; algunas rutas cobran menos si reusan un resultado guardado).



## OpenAPI

````yaml /openapi.json post /v1/labels
openapi: 3.1.0
info:
  title: blockgence API
  description: >

    **blockgence** expone como API todo el motor de *blockchain intelligence*:

    rastreo de fondos (tracing), atribución de entidades y screening de riesgo

    explicable (glass-box), sobre múltiples chains EVM.


    ### Autenticación

    Todas las rutas `/v1/*` requieren una **API key**. Mandala en el header

    `X-API-Key: <key>` (o `Authorization: Bearer <key>`). La key te la entrega
    tu

    organización o el administrador. En esta página: **Authorize** → pegá la
    key, y cada

    «Try it out» → «Execute» es una request real, que se cobra igual que desde
    tu código.

    Las rutas de verificación de evidencia (`/v1/evidence/*`) son abiertas.


    ### Límites

    Cada tier tiene un **rate-limit por minuto** y una **cuota mensual de
    créditos**.

    Cada endpoint consume créditos según su costo (`/trace` es el más caro); el
    costo puede

    variar por método y sub-ruta. **Solo se cobran las respuestas exitosas
    (status < 400)**:

    una request que termina en error queda registrada con 0 créditos. Consultá
    tu consumo en

    tiempo real con `GET /v1/account`.


    ### Fallas de la fuente de datos

    Si la fuente de datos falla al leer lo que pediste, la respuesta es `503
    source_unavailable`

    (sin cobro), con la fuente, la chain, la consulta, el motivo y si conviene
    reintentar. Si

    falla un salto intermedio, la respuesta es 200 y lo declara en
    `degraded_sources` (y en el

    `coverage_gaps` del nodo o la arista): ahí, la ausencia de datos no es
    ausencia de movimientos.


    ### Chains soportadas

    `ethereum`, `bsc`, `polygon`, `arbitrum`, `base`, `optimism`; además `tron`
    (rastreo, ficha, fondeo, probe y tx: ver «Tron» en `docs/API.md`). Qué
    fuente sirve cada consulta y con qué límite está en `GET /v1/chains` (0
    créditos). Conocidas y no consultadas (valen en `/screening` y `/address`,
    donde la chain la define el formato de la address): `monero`, `bitcoin`,
    `litecoin`, `solana`.

    Cualquier otra chain es `400`: nunca se sustituye por Ethereum.
  contact:
    name: blockgence
    url: https://www.blockgence.com/
  version: 1.0.0
servers:
  - url: https://app.blockgence.com
    description: Producción
security: []
tags:
  - name: Platform
    description: >-
      Qué chains hay y qué puede servir cada una (registro y matriz de
      capacidades), con qué fuentes y con qué metodología. Costo: 0 créditos.
  - name: Tracking
    description: >-
      Rastreo del flujo de fondos y lecturas de una address o una tx: grafo
      bidireccional con consistencia temporal, fondeo, contrapartes, bridges,
      swaps, mixers, labels y datos on-chain.
  - name: Screening
    description: >-
      Screening de riesgo: ¿esta address es riesgosa? Recomendación
      allow/review/block, con las razones y su fuente.
  - name: Contracts
    description: Inspector de contratos y simulación de transacciones antes de firmar.
  - name: Tokens
    description: 'Ficha de un token: emisor, supply, holders y señales de riesgo.'
  - name: Compromise
    description: 'Vector de compromiso de una wallet robada: cómo se perdió el control.'
  - name: Incident
    description: >-
      Respuesta a incidentes: víctima, hack y estafa. Playbook, freeze de fondos
      en emisores, post-mortem y entregables.
  - name: Copilot
    description: >-
      Copiloto forense con IA: investigá en lenguaje natural, con narrativa
      citada (streaming SSE).
  - name: Cases
    description: >-
      Casos: guardar, compartir y exportar investigaciones, con su evidencia,
      actividad y anotaciones.
  - name: Permissions
    description: >-
      Approvals, delegaciones y firmas que dan acceso a los fondos de una
      address (ERC-20, Permit2, EIP-7702).
  - name: Guard
    description: >-
      Blockgence Guard: vigilancia activa de wallets y protocolos, con alertas
      por webhook y correo.
  - name: Travel Rule
    description: >-
      Travel Rule sin red: desafío de titularidad, contraparte, conciliación y
      validación de mensajes IVMS101.
  - name: Auditoría
    description: >-
      Auditoría de smart contracts: pedir una revisión, su estado y hallazgos,
      las addresses desplegadas y las notas del equipo.
  - name: Evidencia
    description: >-
      Verificación de la evidencia sellada: clave pública de firma y sellos de
      tiempo. Abiertas: no piden API key ni cobran.
  - name: Monero
    description: >-
      Ficha pública de una tx de Monero y prueba de pago XMR (tx key u
      OutProof/InProof), verificada localmente y sellada. Monero no publica
      remitentes ni montos: no se rastrea.
  - name: Account
    description: Tu consumo y límites (self-service).
  - name: Icons
    description: >-
      Logos de entidades para renderizar grafos en tu UI. Cache-first
      (TrustWallet, 1inch, favicons oficiales). Costo: 0 créditos.
  - name: Meta
    description: Health y estado operacional (sin auth).
paths:
  /v1/labels:
    post:
      tags:
        - Tracking
      summary: Aportar un label privado de tu API key (o de un caso, con X-Case-Id)
      description: >-
        Guarda una label privada de la key (o de la UI) que la aporta; con
        `X-Case-Id`, del caso.


        **Costo:** 1 crédito de base (solo si la respuesta es < 400; algunas
        rutas cobran menos si reusan un resultado guardado).
      operationId: add_label_v1_labels_post
      parameters:
        - name: X-Case-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Case-Id
          description: >-
            Caso activo (opcional): el token de un caso que podés ver. La
            consulta queda en el registro de actividad de ese caso y resuelve
            también sus labels propias. Un caso que no existe, se borró o ya no
            está compartido con vos da `400 case_unavailable` y la consulta no
            se hace (sin cobro).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Label'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Falta la API key o es inválida o revocada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Cuota mensual de créditos agotada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Rate limit por minuto superado. Reintentá después de `Retry-After`
            segundos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            `source_unavailable`: la fuente de datos (o el índice de labels) no
            pudo leer lo pedido. Sin cobro. Si falla un salto intermedio la
            respuesta es 200 y lo declara en `degraded_sources`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceUnavailable'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    Label:
      properties:
        address:
          type: string
          title: Address
        chain:
          type: string
          title: Chain
          default: ethereum
        label:
          type: string
          title: Label
        category:
          type: string
          title: Category
          default: unknown
        source:
          type: string
          title: Source
          default: ''
        confidence:
          type: number
          title: Confidence
          default: 0.5
        method:
          type: string
          title: Method
          default: heuristic
        added_by:
          type: string
          title: Added By
          default: seed
        service_type:
          anyOf:
            - type: string
              enum:
                - instant-exchanger
                - privacy-pool
                - deposit-address
            - type: 'null'
          title: Service Type
        conflicting_tags:
          items:
            $ref: '#/components/schemas/ConflictingTag'
          type: array
          title: Conflicting Tags
        sanctions_history:
          items:
            $ref: '#/components/schemas/SanctionsEvent'
          type: array
          title: Sanctions History
        chain_basis:
          anyOf:
            - $ref: '#/components/schemas/LabelChainBasis'
            - type: 'null'
        entity:
          anyOf:
            - $ref: '#/components/schemas/EntityRef'
            - type: 'null'
        observed_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Observed At
        observed_basis:
          anyOf:
            - type: string
              enum:
                - source_row
                - source_snapshot
                - source_commit
                - measured
                - analyst
                - none
            - type: 'null'
          title: Observed Basis
        valid_until:
          anyOf:
            - type: string
            - type: 'null'
          title: Valid Until
        validity:
          anyOf:
            - type: string
              enum:
                - not_declared
                - ended
                - live
            - type: 'null'
          title: Validity
        license:
          anyOf:
            - $ref: '#/components/schemas/LabelLicense'
            - type: 'null'
      type: object
      required:
        - address
        - label
      title: Label
    Error:
      type: object
      title: Error
      description: >-
        Forma de todos los errores: un `detail` legible. Algunos agregan
        `error`, un código estable para reconocerlo sin leer el texto
        (`case_unavailable`, `case_read_only`, …).
      properties:
        detail:
          type: string
          description: Qué pasó, en una frase.
        error:
          type: string
          description: Código estable del error, cuando lo tiene.
      required:
        - detail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SourceUnavailable:
      type: object
      title: SourceUnavailable
      description: >-
        La fuente de datos no pudo leer lo pedido. No se cobran créditos. La
        ausencia de datos NO dice que la address esté limpia ni sin movimientos.
      properties:
        error:
          type: string
          enum:
            - source_unavailable
        detail:
          type: string
          description: Qué falló, dónde y si conviene reintentar.
        source:
          type: string
          description: >-
            Fuente que falló: `etherscan`, `blockscout`, `bitquery`, `goplus`,
            `osint`, `config`, …
        chain:
          type: string
        primitive:
          type: string
          description: Lectura de blockgence que falló.
        operation:
          type: string
          description: Llamada concreta a la fuente.
        target:
          type: string
          description: Lo consultado (address o tx), abreviado.
        reason:
          type: string
          description: >-
            Motivo estable: `rate_limited`, `quota_exhausted`, `not_in_plan`,
            `unauthorized`, `timeout`, `network`, `upstream_error`, … (tabla en
            docs/API.md).
        retryable:
          type: boolean
        http_status:
          type:
            - integer
            - 'null'
        retry_after:
          type:
            - integer
            - 'null'
          description: Segundos; viene también como header `Retry-After`.
        upstream_message:
          type:
            - string
            - 'null'
        source_fault:
          type: boolean
          description: >-
            Si fue una falla de la fuente o un tope de blockgence / una consulta
            que no se hizo.
        failure_cause:
          type: string
          description: Por qué, en una cláusula.
      required:
        - error
        - detail
        - source
        - reason
        - retryable
    ConflictingTag:
      properties:
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
          default: ''
        tag_type:
          type: string
          title: Tag Type
          default: ''
        category:
          type: string
          title: Category
          default: ''
        source:
          type: string
          title: Source
          default: blockscout
        applied:
          type: boolean
          title: Applied
          default: false
        reason:
          type: string
          title: Reason
          default: ''
      type: object
      required:
        - name
      title: ConflictingTag
      description: >-
        Tag de riesgo de un tercero que la clasificación NO aplicó a la
        `category`.


        Glass-box estructurado: antes estos tags viajaban solo como texto libre
        dentro de

        `Label.source` y el cliente no podía leerlos como dato. Caso típico: la
        hot wallet de

        FixedFloat trae los genéricos «Phish / Hack» y «Poisoning Address» junto
        al nombre de

        la entidad — el tag de identidad gana (`exchange`), pero el conflicto se
        muestra.

        NO mueve `category`, `risk.score` ni la recomendación: es contexto para
        ponderar.
    SanctionsEvent:
      properties:
        authority:
          type: string
          title: Authority
        list:
          type: string
          title: List
        programs:
          items:
            type: string
          type: array
          title: Programs
        action:
          type: string
          enum:
            - listed
            - delisted
          title: Action
        date:
          anyOf:
            - type: string
            - type: 'null'
          title: Date
        date_precision:
          type: string
          enum:
            - address
            - entity
            - unknown
          title: Date Precision
          default: unknown
        source_url:
          type: string
          title: Source Url
        entity:
          type: string
          title: Entity
          default: ''
        ref:
          type: string
          title: Ref
          default: ''
        as_of:
          anyOf:
            - type: string
            - type: 'null'
          title: As Of
        note:
          type: string
          title: Note
          default: ''
      type: object
      required:
        - authority
        - list
        - action
        - source_url
      title: SanctionsEvent
      description: >-
        Un hecho fechado de una lista de sanciones sobre una dirección: alta
        (`listed`) o baja

        (`delisted`), con la autoridad, la lista, los programas y la fuente que
        lo publica.


        Glass-box: hasta el 2026-09-18 el historial viajaba como texto dentro de
        `Label.source` y el

        front lo recuperaba con regex. `date_precision` dice QUÉ se fechó: OFAC
        publica en

        SDN_ADVANCED la fecha de alta de la ENTIDAD, no de cada dirección
        (Lazarus Group entró el

        2019-09-13 y la dirección de Ronin recién en la Recent Action del
        2022-04-14), así que esa fecha

        es `entity` y no se puede leer como «la dirección está designada desde
        ese día».


        Lo llenan solo las fuentes de sanciones: el seed de la lista OFAC
        vigente

        (`attribution/ofac_sdn.py`) y el registro de bajas
        (`attribution/sanctions.py`). Una label de

        usuario nunca lo trae (`labels._as_user_label` lo vacía).
    LabelChainBasis:
      properties:
        origin_chain:
          type: string
          title: Origin Chain
        applied_chain:
          type: string
          title: Applied Chain
        basis:
          type: string
          enum:
            - same_key
            - designation
            - not_applied
          title: Basis
        account_type:
          type: string
          title: Account Type
          default: ''
        key_chain:
          type: string
          title: Key Chain
          default: ''
        measured_block:
          anyOf:
            - type: integer
            - type: 'null'
          title: Measured Block
        measured_at:
          type: string
          title: Measured At
          default: ''
        note:
          type: string
          title: Note
          default: ''
      type: object
      required:
        - origin_chain
        - applied_chain
        - basis
      title: LabelChainBasis
      description: >-
        Por qué una label publicada para OTRA chain (`origin_chain` =
        `Label.chain`) aparece en la chain

        de la consulta (`applied_chain`). Lo pone el server al leer el índice
        (`labels.for_chain`); ninguna

        fuente ni cliente lo escribe. Sin este campo, la label es de la misma
        chain de la consulta (o de

        usuario, que vale en toda chain).
         • `same_key`: la address es una EOA medida (tiene clave), y la clave es la misma en toda chain
         EVM: la label se aplica acá como INFERENCIA declarada, con su categoría.
         • `designation`: la lista OFAC designa la address (y sus bajas la fechan): vale en toda chain EVM.
         • `not_applied`: contrato, cuenta sin prueba de clave o sin medir en su origen: en esta chain la
         misma address puede ser otra cosa, así que la label viaja como `context` (peso 0) y el nodo toma
         nombre y categoría de su propia chain.
    EntityRef:
      properties:
        id:
          type: string
          title: Id
        brand:
          type: string
          title: Brand
        kind:
          type: string
          title: Kind
          default: exchange
        countries:
          items:
            type: string
          type: array
          title: Countries
        registrations:
          items:
            $ref: '#/components/schemas/EntityRegistration'
          type: array
          title: Registrations
        basis:
          type: string
          enum:
            - label_name
            - registry_address
          title: Basis
          default: label_name
        note:
          type: string
          title: Note
          default: ''
      type: object
      required:
        - id
        - brand
      title: EntityRef
      description: >-
        La entidad regional a la que pertenece la MARCA de una label (ver el
        bloque de arriba).
    LabelLicense:
      properties:
        name:
          type: string
          title: Name
        spdx:
          type: string
          title: Spdx
          default: ''
        status:
          type: string
          enum:
            - ok
            - restricted
            - pending_review
            - not_licensed
          title: Status
        commercial_use:
          type: string
          title: Commercial Use
        packaged:
          type: boolean
          title: Packaged
          default: true
        url:
          type: string
          title: Url
          default: ''
        as_of:
          type: string
          title: As Of
          default: ''
      type: object
      required:
        - name
        - status
        - commercial_use
      title: LabelLicense
      description: >-
        La licencia de la FUENTE de una label (registro
        `attribution/provenance.py`, por `added_by`): qué licencia es,

        si permite el uso comercial y si el dato va en un entregable. None en la
        label = no consta.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    EntityRegistration:
      properties:
        country:
          type: string
          title: Country
        registry:
          type: string
          title: Registry
        registry_name:
          type: string
          title: Registry Name
          default: ''
        number:
          anyOf:
            - type: integer
            - type: 'null'
          title: Number
        legal_name:
          type: string
          title: Legal Name
          default: ''
        trade_name:
          type: string
          title: Trade Name
          default: ''
        tax_id:
          type: string
          title: Tax Id
          default: ''
        registered_at:
          type: string
          title: Registered At
          default: ''
        status:
          type: string
          enum:
            - listed
            - not_listed
          title: Status
          default: listed
        basis:
          items:
            type: string
          type: array
          title: Basis
        checked_at:
          type: string
          title: Checked At
          default: ''
        source_url:
          type: string
          title: Source Url
          default: ''
        review:
          type: string
          title: Review
          default: ''
      type: object
      required:
        - country
        - registry
      title: EntityRegistration
      description: >-
        Una inscripción de la marca en un registro público (hoy: Registro de
        PSAV de la CNV, Argentina).
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Tu API key en el header `X-API-Key`.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        La misma API key en `Authorization: Bearer <key>` (alternativa a
        `X-API-Key`).

````

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