cURL
curl --request GET \
--url https://www.pierre.finance/tools/api/get-balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.pierre.finance/tools/api/get-balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.pierre.finance/tools/api/get-balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.pierre.finance/tools/api/get-balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.pierre.finance/tools/api/get-balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.pierre.finance/tools/api/get-balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.pierre.finance/tools/api/get-balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
Accounts & Balance
Get Balance
Obtém o saldo total e detalhes de todas as contas bancárias
GET
/
tools
/
api
/
get-balance
cURL
curl --request GET \
--url https://www.pierre.finance/tools/api/get-balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.pierre.finance/tools/api/get-balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.pierre.finance/tools/api/get-balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.pierre.finance/tools/api/get-balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.pierre.finance/tools/api/get-balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.pierre.finance/tools/api/get-balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.pierre.finance/tools/api/get-balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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 endpointGET /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.string
required
Bearer token com a API key do usuário. Formato:
Bearer sk-your-api-key-hereParâ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

