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

# Consumo y límites

> Devuelve el consumo y los límites de la clave de API que hace la llamada.

Campos de la respuesta:
- `name`, `prefix` y `tier`: el nombre de la clave, su prefijo visible y su plan.
- `limits`: `rate_per_min` (límite de pedidos por minuto), `monthly_credits` (créditos mensuales que rigen) y
 `request_source_calls` (cantidad máxima de lecturas a fuentes de datos que puede hacer una sola consulta;
 pasado ese límite, la consulta responde `503` o declara el paso en `degraded_sources`).
- `credits`: el saldo del mes, con `limit`, `used`, `reserved` (créditos de pedidos que siguen en curso),
 `remaining`, `reset` (momento de la renovación, en segundos Unix, el primer día de cada mes a las 00:00 UTC) y
 `shared` (`true` si el saldo es de toda la organización).
- `usage`: `month` y `total`, cada uno con `requests`, `credits` y `failed` (pedidos con status 400 o mayor,
 registrados con 0 créditos), y `by_endpoint`, el desglose por ruta.

Es el mismo saldo que informan los headers `X-Credits-*` de cada respuesta.

**Costo:** sin cargo.



## OpenAPI

````yaml /openapi.es.json get /v1/account
openapi: 3.1.0
info:
  title: API de blockgence
  description: >-
    La API de **blockgence** da acceso al rastreo de fondos, la atribución de
    entidades y el screening de riesgo

    explicable sobre varias redes, con la evidencia de cada resultado.


    ### Autenticación

    Todas las rutas `/v1/*` requieren una **clave de API**, en el header
    `X-API-Key: <clave>` o en

    `Authorization: Bearer <clave>`. La clave la entrega su organización. Las
    rutas de verificación de evidencia

    (`/v1/evidence/*`) no requieren clave.


    ### Créditos y límites

    Cada plan tiene un **límite de pedidos por minuto** y una **cantidad mensual
    de créditos**. Cada operación indica

    su costo en créditos. **Solo se cobran las respuestas correctas (status
    menor que 400):** una respuesta de error

    queda registrada con 0 créditos. El consumo se consulta en `GET
    /v1/account`.


    ### Datos que no se pudieron leer

    Si la fuente de datos no puede leer lo pedido, la respuesta es `503
    source_unavailable`, sin cobro, con la

    fuente, la red, la consulta, el motivo y si conviene reintentar. Si falla un
    paso intermedio, la respuesta es 200

    y lo declara en `degraded_sources` y en el `coverage_gaps` del nodo o la
    arista: en esos casos, la ausencia de

    datos no significa ausencia de movimientos.


    ### Redes

    `ethereum`, `bsc`, `polygon`, `arbitrum`, `base` y `optimism`; además `tron`
    para rastreo, ficha, fondeo, sondeo

    de redes y transacciones. Qué se puede consultar en cada red se indica en
    `GET /v1/chains`, sin costo. Las redes

    `monero`, `bitcoin`, `litecoin` y `solana` se reconocen en `/screening` y
    `/address`, donde la red se deduce del

    formato de la dirección. Cualquier otra red responde `400`: nunca se
    reemplaza 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: Plataforma
    description: >-
      Qué redes hay, qué se puede consultar en cada una, con qué fuentes y con
      qué metodología. Sin costo.
  - name: Rastreo
    description: >-
      Rastreo del flujo de fondos y lecturas de una dirección o una transacción:
      grafo en los dos sentidos con consistencia temporal, fondeo, contrapartes,
      puentes, swaps, mezcladores, etiquetas y datos on-chain.
  - name: Screening
    description: >-
      Screening de riesgo de una dirección, con una recomendación (allow, review
      o block), sus razones y sus fuentes.
  - name: Contratos
    description: Inspección de contratos y simulación de una transacción antes de firmarla.
  - name: Tokens
    description: >-
      Ficha de un token, con su emisor, su suministro, sus tenedores y sus
      señales de riesgo.
  - name: Compromiso
    description: >-
      Vector de compromiso de una billetera robada, es decir, cómo se perdió el
      control de los fondos.
  - name: Incidentes
    description: >-
      Respuesta a incidentes de víctimas, hackeos y estafas: playbook, pedidos
      de congelamiento a emisores, post-mortem y entregables.
  - name: Copiloto
    description: >-
      Copiloto de investigación con IA, que responde en lenguaje natural y cita
      la evidencia (streaming SSE).
  - name: Casos
    description: >-
      Casos de investigación para guardar, compartir y exportar, con su
      evidencia, su actividad y sus anotaciones.
  - name: Permisos
    description: >-
      Aprobaciones, delegaciones y firmas que dan acceso a los fondos de una
      dirección (ERC-20, Permit2 y EIP-7702).
  - name: Guard
    description: >-
      Vigilancia de billeteras y protocolos, con alertas por webhook y por
      correo.
  - name: Travel Rule
    description: >-
      Travel Rule sin conexión con terceros: desafío de titularidad,
      contraparte, conciliación y validación de mensajes IVMS101.
  - name: Auditoría
    description: >-
      Auditoría de smart contracts, con el estado, los hallazgos y la evidencia
      de cada auditoría.
  - name: Evidencia
    description: >-
      Verificación de la evidencia sellada, con la clave pública de firma y los
      sellos de tiempo. No requiere clave de API ni cobra.
  - name: Monero
    description: >-
      Ficha pública de una transacción de Monero y verificación de una prueba de
      pago. Monero no publica remitentes ni montos, por lo que no se rastrea.
  - name: Cuenta
    description: Consumo y límites de su clave de API.
  - name: Íconos
    description: Logos de entidades para mostrar grafos en su propia interfaz. Sin costo.
  - name: Servicio
    description: Estado del servicio.
paths:
  /v1/account:
    get:
      tags:
        - Cuenta
      summary: Consumo y límites
      description: >-
        Devuelve el consumo y los límites de la clave de API que hace la
        llamada.


        Campos de la respuesta:

        - `name`, `prefix` y `tier`: el nombre de la clave, su prefijo visible y
        su plan.

        - `limits`: `rate_per_min` (límite de pedidos por minuto),
        `monthly_credits` (créditos mensuales que rigen) y
         `request_source_calls` (cantidad máxima de lecturas a fuentes de datos que puede hacer una sola consulta;
         pasado ese límite, la consulta responde `503` o declara el paso en `degraded_sources`).
        - `credits`: el saldo del mes, con `limit`, `used`, `reserved` (créditos
        de pedidos que siguen en curso),
         `remaining`, `reset` (momento de la renovación, en segundos Unix, el primer día de cada mes a las 00:00 UTC) y
         `shared` (`true` si el saldo es de toda la organización).
        - `usage`: `month` y `total`, cada uno con `requests`, `credits` y
        `failed` (pedidos con status 400 o mayor,
         registrados con 0 créditos), y `by_endpoint`, el desglose por ruta.

        Es el mismo saldo que informan los headers `X-Credits-*` de cada
        respuesta.


        **Costo:** sin cargo.
      operationId: account_v1_account_get
      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 usted puede ver. La
            consulta queda registrada en ese caso y usa también sus etiquetas
            propias. Un caso que no existe, se borró o ya no está compartido con
            usted responde `400 case_unavailable` y la consulta no se hace, sin
            cobro.
      responses:
        '200':
          description: El consumo y los límites de la clave de API.
          content:
            application/json:
              schema: {}
        '401':
          description: Falta la clave de API, o es inválida o revocada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Se agotaron los créditos del mes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            El pedido no tiene la forma esperada; `detail` indica qué campo
            corregir.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Se superó el límite de pedidos por minuto. Reintente después de los
            segundos que indica `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      title: Error
      description: >-
        Forma común de los errores: un `detail` legible y, en muchos casos, un
        `error` con un código estable para reconocerlo sin interpretar el texto.
      properties:
        detail:
          type: string
          description: Qué ocurrió, 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
    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
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Su clave de API en el header `X-API-Key`.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        La misma clave de API en `Authorization: Bearer <clave>`, como
        alternativa a `X-API-Key`.

````

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