Skip to main content
GET

When to use it

Call it before a large /batch or /crawl to confirm you have enough balance, or after a run to reconcile what was actually billed. Every field is scoped to the account behind the X-API-Key you send — there is no account selector.

Reading the numbers

credits_used is the sum of billed usage in the current calendar month. It resets on the 1st. remaining_credits is the live balance, not monthly_credits - credits_used. Top-ups add to the balance without changing the monthly allowance, so the two values diverge as soon as you buy extra credits. breakdown groups the month’s consumption by endpoint, so you can tell a /crawl bill apart from a /scrape bill.

Rate limit

30 requests per minute, per account. This endpoint is not meant for polling — poll GET /jobs/{job_id} for job progress instead.

Example

cURL
The MCP get_usage tool returns the same data over the MCP protocol — see MCP integration.

Authorizations

X-API-Key
string
header
required

Response

Uso mensal da conta

Resposta de GET /account/usage (RF-010 / D-11).

breakdown
UsageBreakdownItem · object[]
required

Consumo do mês agrupado por endpoint.

credits_used
integer
required

Soma dos créditos consumidos no mês-calendário corrente.

monthly_credits
integer
required

Franquia mensal do plano.

plan
string
required

Plano da conta: free, starter, growth ou scale.

remaining_credits
integer
required

Saldo disponível em accounts.balance. Inclui créditos de top-up, por isso não é necessariamente monthly_credits - credits_used.