---
title: "Consulta o saldo de uma conta em tempo real"
method: GET
path: "/api/v1/accounts/realtime-balance"
tags: ["Contas"]
---

# Consulta o saldo de uma conta em tempo real

`GET /api/v1/accounts/realtime-balance`

## Request

- Base URL: `https://snabber.com.br`
- URL: `https://snabber.com.br/api/v1/accounts/realtime-balance`
- Auth: HTTP bearer

Pergunta ao parceiro de Open Finance o saldo atual da conta diretamente na instituição, sem rodar uma sincronização. É uma consulta pura: nada é gravado na Snabber, então `balance`, `provider_updated_at` e o histórico de saldo da conta seguem refletindo a última sincronização — cabe a quem chama decidir o que fazer com esta leitura mais recente. Nem todo conector oferece saldo em tempo real; quando não oferece, o parceiro devolve o saldo da última coleta dele e a resposta traz `is_realtime: false`. O mesmo vale quando a consulta em tempo real falha: em vez de erro, a resposta devolve o último saldo conhecido com `is_realtime: false` e `collected_at` dizendo quando o parceiro coletou aquele número — então sempre confira `is_realtime` antes de tratar o valor como sendo do instante da chamada. Atenção: por vir da instituição naquele instante, um saldo em tempo real pode já refletir um lançamento que ainda não aparece em `/api/v1/transactions`. Cada chamada consulta o parceiro, então use com parcimônia — vale o limite de requisições da sua chave.

## Query parameters

- `workspace_id` integer
- `account_id` integer, required

## Response `200`

Saldo consultado no parceiro

- RealtimeBalance
  - `data` object
    - `account_id` integer
    - `balance` number
    - `is_realtime` boolean: false = o valor devolvido não é do instante da chamada, e sim o último saldo conhecido — porque o conector não oferece consulta em tempo real ou porque ela falhou agora. Nesse caso, use `collected_at` para saber de quando ele é.
    - `collected_at` string, date-time, nullable: Quando o parceiro coletou o saldo devolvido, junto à instituição. Nulo quando `is_realtime` é true (aí o saldo é do momento da consulta) ou quando a conexão ainda não sincronizou desde a versão 7.4.2.
    - `queried_at` string, date-time: Momento desta consulta
  - `meta` object
    - `workspace_id` integer

## Other responses

- `400`: Parâmetro inválido, ou conta que não é conectada via Open Finance
- `401`: Chave de API ausente, inválida, revogada ou expirada
- `403`: Plano do usuário não tem acesso à API (downgrade para free)
- `404`: Conta não encontrada neste workspace
- `409`: A conexão Open Finance da conta não está mais ativa; é preciso reconectar
- `429`: Limite de requisições excedido

---

[API](https://skmtc.dev/snabber/apis/snabber-api.md) · [All operations](https://skmtc.dev/snabber/apis/snabber-api/llms.txt) · [OpenAPI document](https://skmtc.dev/snabber/apis/snabber-api/revisions/bf5841cbd8ce?raw)