# Pierre Open Finance

> Documentação da API Pierre Open Finance para acesso a dados financeiros

## Docs

- [Pierre Finance API](https://docs.pierre.finance/index.md): Acesse os dados do Open Finance através de APIs REST e MCP
- [Quickstart](https://docs.pierre.finance/quickstart.md): Comece a usar a Pierre Open Finance API em 5 minutos
- [REST API](https://docs.pierre.finance/api-services/rest-api.md): Acesse dados financeiros através de endpoints REST
- [MCP Server](https://docs.pierre.finance/api-services/mcp-server.md): Conecte editores diretamente aos dados financeiros através do protocolo MCP
- [Autenticação](https://docs.pierre.finance/api-services/authentication.md): Como autenticar e obter acesso aos serviços da Pierre Finance
- [Cursor Setup](https://docs.pierre.finance/editor-integration/cursor.md): Configure Cursor para acessar dados financeiros através do servidor MCP
- [Claude Code Integration](https://docs.pierre.finance/editor-integration/claude-code.md): Configure o Claude Code CLI para acessar dados financeiros através do MCP
- [Windsurf Integration](https://docs.pierre.finance/editor-integration/windsurf.md): Configure o Windsurf para acessar dados financeiros através do MCP
- [Outros Editores](https://docs.pierre.finance/editor-integration/other-editors.md): Configuração para outros editores e ferramentas que suportam MCP
- [API Reference Introduction](https://docs.pierre.finance/api-reference/introduction.md): Documentação completa da Pierre Finance API para acesso a dados financeiros
- [Get API Key Info](https://docs.pierre.finance/api-reference/rest/get-api-key-info.md): Get information about how to generate and use API keys for Pierre Finance
- [Get Accounts](https://docs.pierre.finance/api-reference/rest/get-accounts.md): Retorna todas as contas financeiras do usuário. Requer API key para autenticação e assinatura ativa.
- [Get Balance](https://docs.pierre.finance/api-reference/rest/get-balance.md): Obtém o saldo total e detalhes de todas as contas bancárias
- [Get Balance by Account](https://docs.pierre.finance/api-reference/rest/get-balance-by-account.md): Obtém o saldo e detalhes de uma conta bancária específica
- [Get Transactions](https://docs.pierre.finance/api-reference/rest/get-transactions.md): Retrieves the user's financial transaction history within a specific period with intelligent filtering and automatic categorization. Supports filtering by account type, transaction type, category, amount ranges, and natural language queries via clientMessage parameter. Applies two processing stages:…
- [Get Installments](https://docs.pierre.finance/api-reference/rest/get-installments.md): Retrieve all installments transactions of the period. Fetches ALL installments (past, current, and future) for purchases made within the specified period. Requires API key for authentication and active subscription.
- [Get Bills](https://docs.pierre.finance/api-reference/rest/get-bills.md): Retorna faturas de cartão de crédito vencidas (apenas faturas já fechadas e com vencimento passado) do usuário autenticado. Requer API key para autenticação e assinatura ativa.
- [Get Bill Summary](https://docs.pierre.finance/api-reference/rest/get-bill-summary.md): Retorna o resumo da fatura atual do(s) cartão(ões) de crédito do usuário: limite total, limite disponível, período considerado e o valor aproximado da fatura. Requer API key para autenticação e assinatura ativa.
- [Manage Closing Date](https://docs.pierre.finance/api-reference/rest/manage-closing-date.md): Gerencia datas de fechamento de cartões de crédito. Permite listar contas, criar, atualizar, deletar e consultar datas de fechamento. Requer API key para autenticação e assinatura ativa.
- [Create Spending Limit](https://docs.pierre.finance/api-reference/rest/create-spending-limit.md): Cria um novo limite de gastos personalizado para uma categoria específica. Requer API key para autenticação e assinatura ativa. O usuário deve ter cota disponível baseada no seu plano (Basic: 0 limites, Pro: 2 limites, Premium: 5 limites).
- [List Spending Limits](https://docs.pierre.finance/api-reference/rest/list-spending-limits.md): Lista todos os limites de gastos do usuário com informações detalhadas de uso atual e validação automática de quota. Para cada limite, calcula automaticamente o valor gasto no período atual, porcentagem de uso, valor restante e status visual. Por padrão retorna apenas limites ativos, mas pode inclui…
- [Get Spending Limit Transactions](https://docs.pierre.finance/api-reference/rest/get-spending-limit-transactions.md): Retorna o status detalhado de um limite de gastos específico, incluindo valor gasto atual, porcentagem do limite, próximos alertas e histórico de transações. Calcula automaticamente o período baseado na configuração do limite. Requer API key para autenticação e assinatura ativa.
- [Update Spending Limit](https://docs.pierre.finance/api-reference/rest/update-spending-limit.md): Atualiza um limite de gastos existente. Permite modificar categoria, valor, período e status ativo. O usuário só pode atualizar seus próprios limites. Requer API key para autenticação e assinatura ativa.
- [Delete Spending Limit](https://docs.pierre.finance/api-reference/rest/delete-spending-limit.md): Exclui permanentemente um limite de gastos. O usuário só pode excluir seus próprios limites. Esta operação não pode ser desfeita. Requer API key para autenticação e assinatura ativa.
- [Confirm Spending Limit](https://docs.pierre.finance/api-reference/rest/confirm-spending-limit.md): Confirma a criação de um limite de gastos após receber aviso sobre gastos atuais. Permite agendar o limite para o próximo período se necessário. Requer API key para autenticação e assinatura ativa.
- [Create Payment Reminder](https://docs.pierre.finance/api-reference/rest/create-payment-reminder.md): Cria um novo lembrete de pagamento. Permite criar lembretes únicos ou recorrentes com notificações via WhatsApp e Email. Requer API key para autenticação e assinatura ativa. O usuário deve ter cota disponível baseada no seu plano.
- [List Payment Reminders](https://docs.pierre.finance/api-reference/rest/list-payment-reminders.md): Lista todos os lembretes de pagamento do usuário com informações de cota. Permite filtrar por status (active, all, upcoming, overdue). Requer API key para autenticação e assinatura ativa.
- [Update Payment Reminder](https://docs.pierre.finance/api-reference/rest/update-payment-reminder.md): Atualiza um lembrete de pagamento existente. Permite modificar título, valor, datas, padrão de recorrência e status. O usuário só pode atualizar seus próprios lembretes. Requer API key para autenticação e assinatura ativa.
- [Delete Payment Reminder](https://docs.pierre.finance/api-reference/rest/delete-payment-reminder.md): Exclui ou cancela um lembrete de pagamento. Por padrão realiza exclusão lógica (marca como inactive), mas pode fazer exclusão permanente com hardDelete=true. O usuário só pode excluir seus próprios lembretes. Requer API key para autenticação e assinatura ativa.
- [Get Expensive Categories](https://docs.pierre.finance/api-reference/rest/get-expensive-categories.md): Retorna as 3 categorias mais caras no período especificado. Por padrão, analisa os últimos 7 dias. Requer API key para autenticação e assinatura ativa.
- [Get Memories](https://docs.pierre.finance/api-reference/rest/get-memories.md): Adiciona uma mensagem do usuário (se fornecida) e recupera memórias formatadas para uso em prompts. Requer API key para autenticação e assinatura ativa. Requer configuração do Mem0.
- [Get Open Finance Connection Flow](https://docs.pierre.finance/api-reference/rest/get-open-finance-connection-flow.md): Inicia o fluxo de conexão Open Finance via WhatsApp. Para usuários Premium, envia um fluxo interativo com lista de bancos. Para usuários Basic/Pro, envia notificação de acesso limitado. Requer API key para autenticação e assinatura ativa.
- [Manual Update](https://docs.pierre.finance/api-reference/rest/manual-update.md): Synchronizes all connected financial accounts and transactions with the latest data from banks and credit card providers. Requires API key for authentication and active subscription.
- [MCP Server Introduction](https://docs.pierre.finance/api-reference/mcp/introduction.md): Introdução ao servidor MCP da Pierre Finance
- [MCP Tools](https://docs.pierre.finance/api-reference/mcp/tools.md): Ferramentas disponíveis no servidor MCP da Pierre Finance

## OpenAPI Specs

- [openapi](https://docs.pierre.finance/api-reference/openapi.json)

## Optional

- [Chat](https://pierre.finance/chat)
- [Get API Key](https://pierre.finance/api-key)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.