Skip to main content
GET
/
tools
/
api
/
get-balance
cURL
curl --request GET \
  --url https://www.pierre.finance/tools/api/get-balance \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "total_balance": 1500.50,
    "accounts": [
      {
        "name": "Conta Principal",
        "balance": 1000.00,
        "account_type": "BANK",
        "account_subtype": "CHECKING_ACCOUNT"
      },
      {
        "name": "Conta Poupança",
        "balance": 500.50,
        "account_type": "BANK",
        "account_subtype": "SAVINGS_ACCOUNT"
      }
    ]
  },
  "timestamp": "2024-01-01T00:00:00.000Z"
}
Este endpoint obtém o saldo total e detalhes de todas as contas bancárias conectadas à conta do usuário.

​
Descrição

O endpoint GET /tools/api/get-balance retorna o saldo total consolidado de todas as contas bancárias do usuário autenticado.

​
Autenticação

Este endpoint requer autenticação via Bearer token e assinatura ativa.
​
Authorization
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

​
Parâmetros de Query

​
Response

{
  "success": true,
  "data": {
    "total_balance": 1500.50,
    "accounts": [
      {
        "name": "Conta Principal",
        "balance": 1000.00,
        "account_type": "BANK",
        "account_subtype": "CHECKING_ACCOUNT"
      },
      {
        "name": "Conta Poupança",
        "balance": 500.50,
        "account_type": "BANK",
        "account_subtype": "SAVINGS_ACCOUNT"
      }
    ]
  },
  "timestamp": "2024-01-01T00:00:00.000Z"
}

​
Response Fields

​
Objeto Account

​
Respostas de Erro

{
  "error": "Invalid or inactive API key",
  "message": "Invalid or inactive API key",
  "type": "invalid_api_key",
  "nextSteps": [
    "Visit https://pierre.finance/api-key to generate a new API key",
    "Make sure the API key is active and not expired"
  ]
}

{
  "error": "Internal server error"
}

​
Exemplos de Uso

​
cURL

curl -X GET "https://www.pierre.finance/tools/api/get-balance" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json"

​
JavaScript

const response = await fetch('https://www.pierre.finance/tools/api/get-balance', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log('Saldo total:', data.data.total_balance);
console.log('Contas:', data.data.accounts);

​
Python

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
}

response = requests.get('https://www.pierre.finance/tools/api/get-balance', headers=headers)
data = response.json()

print(f"Saldo total: {data['data']['total_balance']}")
print(f"Contas: {data['data']['accounts']}")

​
Observações

  • Apenas contas bancárias são incluídas no cálculo do saldo
  • Contas de cartão de crédito são excluídas deste endpoint
  • O saldo total é a soma de todos os saldos individuais das contas
  • Os saldos das contas são em tempo real e refletem o estado atual das contas conectadas

Authorizations

​
Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Response

Dados de saldo consolidado

​
success
boolean
Example:

true

​
data
any
​
timestamp
string<date-time>