Consulta o consumo da própria API key

Quantas chamadas a sua API key fez num período, por produto, separando as cobradas das não cobradas. É a mesma contagem usada na cobrança.

Não exige escopo: qualquer cliente ativo consulta o próprio consumo, e nunca o de outro cliente. A consulta não é cobrada, mas conta no limite de requisições por minuto, num contador próprio (não gasta o limite de nenhum produto).

Período: from e to são opcionais e inclusivos, em UTC. Data pura cobre o dia inteiro; data e hora sem fuso são lidas em UTC. Sem nenhum dos dois, os últimos 30 dias até agora. A janela vai até 366 dias.

O que conta:

• calculators: as calculadoras; queries: as consultas síncronas, as assíncronas (contadas no disparo) e o JusScore (slug: "jus-score", contado quando a consulta conclui). Só aparecem produtos com consumo no período, ordenados por slug.
• billable: chamadas cobradas. Inclui a consulta que rodou e não achou dado (404 no_data_found). nonBillable: chamadas que falharam e não são cobradas. calls = billable + nonBillable, e totals soma todos os produtos.
• Uma chamada repetida com o mesmo X-Request-Id conta uma vez, como na cobrança, ainda que tenha sido executada de novo.
• A consulta aos índices de correção (GET /api/v1/calculadoras/indices-correcao) é apoio às calculadoras e não conta como consumo.
• Recusas antes do produto (401, 403, 429, 400 de validação) não contam.
• O histórico começa quando esta contagem passou a ser registrada, pouco antes da publicação desta rota; chamadas anteriores não aparecem.

Valores em créditos ou em reais ainda não estão disponíveis.

GET /api/v1/consumo

Consulta o consumo da própria API key

cURL

curl --request GET \
  --url https://api.jusfy.dev/calculators/api/v1/consumo \
  --header 'x-api-key: <api-key>'

200

Example

{
  "statusCode": 200,
  "message": "Consumo consultado com sucesso",
  "timestamp": "2026-10-21T18:00:00.000Z",
  "path": "/api/v1/consumo",
  "result": {
    "period": {
      "from": "2026-10-01T00:00:00.000Z",
      "to": "2026-10-21T23:59:59.999Z"
    },
    "totals": {
      "calls": 132,
      "billable": 122,
      "nonBillable": 10
    },
    "calculators": [
      {
        "slug": "trabalhista",
        "calls": 100,
        "billable": 95,
        "nonBillable": 5
      }
    ],
    "queries": [
      {
        "slug": "cnh",
        "calls": 30,
        "billable": 25,
        "nonBillable": 5
      },
      {
        "slug": "jus-score",
        "calls": 2,
        "billable": 2,
        "nonBillable": 0
      }
    ]
  }
}

Autorizações

x-api-key · string · header · obrigatório

Parâmetros de consulta

from · string

Início do período, inclusivo, em ISO 8601. Data pura (2026-10-01) começa às 00:00:00.000 UTC; data e hora sem fuso são lidas em UTC. Sem from, 30 dias antes de to.

Exemplo:

"2026-10-01"

to · string

Fim do período, inclusivo, em ISO 8601. Data pura (2026-10-21) termina às 23:59:59.999 UTC. Sem to, o momento da chamada.

Exemplo:

"2026-10-21"

Resposta

200

application/json

Consumo do cliente no período, por produto.

The response is of type object.