Skip to main content
GET
/
tools
/
api
/
get-accounts
cURL
curl --request GET \
  --url https://www.pierre.finance/tools/api/get-accounts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "accountId": "acc_123456789",
      "providerCode": "NUBANK",
      "accountName": "Conta Corrente",
      "accountType": "BANK",
      "accountSubtype": "CHECKING_ACCOUNT",
      "accountBalance": 1500.50,
      "accountCurrencyCode": "BRL",
      "accountMarketingName": "Nubank Conta",
      "bankData": {
        "transferNumber": "123456789",
        "closingBalance": 1500.50,
        "automaticallyInvestedBalance": 0
      }
    },
    {
      "accountId": "acc_987654321",
      "providerCode": "ITAU",
      "accountName": "Cartão de Crédito",
      "accountType": "CREDIT",
      "accountSubtype": "CREDIT_CARD",
      "accountBalance": -2500.00,
      "accountCurrencyCode": "BRL",
      "accountMarketingName": "Itaú Cartão",
      "creditData": {
        "brand": "VISA",
        "level": "GOLD",
        "status": "ACTIVE",
        "creditLimit": 10000.00,
        "balanceDueDate": "2024-02-15",
        "minimumPayment": 250.00,
        "balanceCloseDate": "2024-01-31",
        "availableCreditLimit": 7500.00,
        "balanceForeignCurrency": null
      }
    }
  ],
  "count": 2,
  "timestamp": "2024-01-15T10:30:00Z"
}
Este endpoint retorna todas as contas financeiras do usuário autenticado.

​
Descrição

O endpoint GET /tools/api/get-accounts retorna todas as contas financeiras associadas ao usuário autenticado, incluindo contas bancárias, cartões de crédito, investimentos e empréstimos.

​
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

​
Resposta

​
Sucesso (200)

{
  "success": true,
  "data": [
    {
      "accountId": "acc_123456789",
      "providerCode": "NUBANK",
      "accountName": "Conta Corrente",
      "accountType": "BANK",
      "accountSubtype": "CHECKING_ACCOUNT",
      "accountBalance": 1500.50,
      "accountCurrencyCode": "BRL",
      "accountMarketingName": "Nubank Conta",
      "bankData": {
        "transferNumber": "123456789",
        "closingBalance": 1500.50,
        "automaticallyInvestedBalance": 0
      }
    },
    {
      "accountId": "acc_987654321",
      "providerCode": "ITAU",
      "accountName": "Cartão de Crédito",
      "accountType": "CREDIT",
      "accountSubtype": "CREDIT_CARD",
      "accountBalance": -2500.00,
      "accountCurrencyCode": "BRL",
      "accountMarketingName": "Itaú Cartão",
      "creditData": {
        "brand": "VISA",
        "level": "GOLD",
        "status": "ACTIVE",
        "creditLimit": 10000.00,
        "balanceDueDate": "2024-02-15",
        "minimumPayment": 250.00,
        "balanceCloseDate": "2024-01-31",
        "availableCreditLimit": 7500.00,
        "balanceForeignCurrency": null
      }
    }
  ],
  "count": 2,
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Erro de Autenticação (401)

{
  "error": "Invalid or inactive API key",
  "message": "Please check your API key and try again",
  "type": "invalid_api_key"
}

​
Erro de Assinatura (401)

{
  "error": "No active subscription found",
  "message": "Please activate your subscription to access financial data",
  "type": "no_subscription",
  "nextSteps": [
    "Visit https://pierre.finance to activate your subscription",
    "Contact support if you need assistance"
  ]
}

​
Campos da Resposta

​
success
boolean
required
Indica se a requisição foi bem-sucedida
​
data
array
required
Array com as contas financeiras do usuário
​
count
number
required
Número total de contas retornadas
​
timestamp
string
required
Timestamp da requisição em formato ISO 8601

​
Exemplos de Uso

​
cURL

curl -X GET 'https://www.pierre.finance/tools/api/get-accounts' \
  -H 'Authorization: Bearer sk-your-api-key-here'

​
JavaScript

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

const data = await response.json();
console.log(data);

​
Python

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

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

​
Códigos de Status

  • 200: Sucesso - Contas retornadas
  • 401: Erro de autenticação ou assinatura
  • 500: Erro interno do servidor
Este endpoint retorna dados em tempo real das contas conectadas. Para dados mais recentes, use o endpoint de sincronização manual.

Authorizations

​
Authorization
string
header
required

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

Response

Lista de contas financeiras

​
success
boolean
Example:

true

​
data
any[]
​
count
number
Example:

3

​
timestamp
string<date-time>