---
title: "Uso da conta"
method: GET
path: "/api/v2/user/usage"
tags: ["Conta"]
---

# Uso da conta

`GET /api/v2/user/usage`

## Request

- Base URL: `https://brapi.dev`
- URL: `https://brapi.dev/api/v2/user/usage`
- Auth: HTTP bearer

Quanto da sua cota você já gastou na janela atual.

A resposta traz `planName` (`free`, `startup` ou `pro`), `planLimit` com o
limite do plano, `currentUsage` com o consumo registrado, `remainingUsage` com
o saldo, `usageWindow` indicando se a contagem é por ciclo de cobrança ou por
30 dias móveis, e `subscriptionPeriod` com o período atual da assinatura.

A contagem vem do mesmo cache que o limitador usa, então ela pode ficar alguns
segundos atrás do consumo real.

```bash
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/user/usage"
```

## Query parameters

- `format` 'json': Formato da resposta. JSON é o formato suportado.

## Response `200`

Uso da conta retornado com sucesso.

- UserUsageResponse
  - `usage` UserUsageData, required
    - `planName` 'free' | 'startup' | 'pro', required
    - `planLimit` integer, required
    - `currentUsage` integer, required
    - `remainingUsage` integer, required
    - `usageWindow` UserUsageWindow, required
      - `type` 'billing-cycle' | 'rolling-30d', required
      - `start` string, date-time, required
      - `end` string, date-time, required
    - `subscriptionPeriod` UserSubscriptionPeriod, required
      - `start` string, date-time, nullable, required
      - `end` string, date-time, nullable, required
  - `requestedAt` string, date-time, required: Data e hora da requisição em ISO 8601.
  - `took` integer, required: Tempo de processamento, em milissegundos.

## Other responses

- `401`: Token ausente, inválido ou inativo.
- `404`: Usuário associado ao token não encontrado.
- `500`: Erro interno ao buscar o uso da conta.

## Changes

- **2026-08-21** `f19b0058d946`: 1 info
  - added the new optional `query` request parameter `format`
- **2026-04-26** `3ae1b2752c0b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/changes/api/v2/user/usage/get.md)

---

[API](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro.md) - [All operations](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/llms.txt) - [OpenAPI document](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/revisions/7c732d79148a?raw)