Endpoints
GET /account/usage
Uso mensal de créditos e saldo restante da conta autenticada.
GET
Quando usar
Chame antes de um/batch ou /crawl grande para confirmar que há saldo, ou
depois de uma execução para conciliar o que foi de fato cobrado. Todos os campos
são da conta por trás da X-API-Key enviada — não existe seletor de conta.
Como ler os números
credits_used é a soma do consumo cobrado no mês-calendário corrente.
Zera no dia 1º.
remaining_credits é o saldo real, não monthly_credits - credits_used.
Top-ups somam ao saldo sem alterar a franquia mensal, então os dois valores
divergem assim que você compra créditos avulsos.
breakdown agrupa o consumo do mês por endpoint, permitindo separar a cobrança
de um /crawl da de um /scrape.
Rate limit
30 requisições por minuto, por conta. Este endpoint não serve para polling — useGET /jobs/{job_id} para acompanhar o progresso de um job.
Exemplo
cURL
Relacionado
A tool MCPget_usage devolve os mesmos dados pelo protocolo MCP —
veja Integração MCP.Autorizações
Resposta
Uso mensal da conta
Resposta de GET /account/usage (RF-010 / D-11).
Consumo do mês agrupado por endpoint.
Soma dos créditos consumidos no mês-calendário corrente.
Franquia mensal do plano.
Plano da conta: free, starter, growth ou scale.
Saldo disponível em accounts.balance. Inclui créditos de top-up, por isso não é necessariamente monthly_credits - credits_used.