API reference

REST, sem MCP.

A mesma superfície de leitura das tools, em HTTP. Use quando o consumidor é o seu backend, e não um cliente de IA.

Base URLhttps://A DEFINIR (base da REST API)a definir
Estado desta entrega: as rotas abaixo estão listadas a partir de uma fonte única (lib/content.ts) e existem como esqueleto. Elas vão responder com o adapter Open Finance no próximo ciclo.

Endpoints

17 rotas · 13 tools equivalentes
GET/v1/toolsesqueleto

Lista as tools do servidor MCP e seus argumentos (mesma fonte de /docs).

GET/v1/connectionsesqueleto

Lista as conexões bancárias da conta autenticada.

POST/v1/connectionsesqueleto

Inicia uma nova conexão com um banco via Open Finance e devolve a URL de consentimento.

body
connector_id
string
client_ref
string (opcional)
GET/v1/connections/{connection_id}/statusesqueleto

Estado de sincronização e consentimento de uma conexão.

POST/v1/connections/{connection_id}/syncesqueleto

Pede uma ressincronização imediata da conexão.

DELETE/v1/connections/{connection_id}esqueleto

Revoga o consentimento Open Finance e apaga os dados daquela conexão.

GET/v1/banksesqueleto

Busca instituições do Open Finance pelo nome.

Query
query
q
string
limit
number (opcional)
GET/v1/accountsesqueleto

Lista contas bancárias e cartões, filtráveis por conexão e tipo.

Query
query
connection_id
string (opcional)
type
BANK | CREDIT (opcional)
GET/v1/accounts/balanceesqueleto

Saldo por conta em lote.

Query
query
account_ids
string[] separado por vírgula (máx. 50)
GET/v1/accounts/{account_id}/transactionsesqueleto

Extrato de uma conta com filtro por período, busca e paginação.

Query
query
from
data ISO (opcional)
to
data ISO (opcional)
q
string[] separado por vírgula (opcional)
page
number (opcional)
page_size
number (opcional)
GET/v1/spendingesqueleto

Consolidado de gastos: total, evolução no tempo e principais categorias.

Query
query
connection_id
string (opcional)
from
data ISO (opcional)
to
data ISO (opcional)
granularity
day | month (opcional)
top_n
number (opcional)
GET/v1/credit-cards/{account_id}/billsesqueleto

Faturas de um cartão de crédito.

Query
query
page
number (opcional)
page_size
number (opcional)
GET/v1/credit-cards/billsesqueleto

Detalhe de faturas por id, com lançamentos opcionais.

Query
query
bill_ids
string[] separado por vírgula
include_transactions
boolean (opcional)
GET/v1/investmentsesqueleto

Carteira de investimentos.

Query
query
connection_id
string (opcional)
type
string (opcional)
page
number (opcional)
GET/v1/investments/{investment_id}/transactionsesqueleto

Movimentação de uma posição de investimento.

Query
query
page
number (opcional)
GET/v1/loansesqueleto

Contratos de empréstimo por conexão.

Query
query
connection_ids
string[] separado por vírgula
GET/v1/categoriesesqueleto

Taxonomia de categorias de transação.