Endpoints

Endpoints

Exemplo

Example

curl https://api.alicercelabs.com.br/api/v1/pix/participantes \
          -H "Authorization: Bearer <token>"

{
          "success": true,
          "data": [
            {
              "ispb": "00360305",
              "nome": "CAIXA ECONOMICA FEDERAL",
              "nome_reduzido": "CAIXA ECONOMICA FEDERAL",
              "modalidade_participacao": "Provedor de Conta Transacional",
              "tipo_participacao": "Direta"
            }
          ],
          "meta": { "elapsed_ms": 320, "request_id": "..." }
        }

Erros possíveis

Possible errors

Sem fonte oficial estruturada

No structured official source

O Banco Central só publica a lista de participantes do PIX em PDF, não em CSV ou JSON — investigamos e documentamos isso em detalhe no plano público de implantação das APIs da BrasilAPI. Diferente do resto das APIs financeiras desta plataforma, aqui não tem "fonte primária própria + fallback": é um proxy direto pra BrasilAPI, com cache, até aparecer uma fonte estruturada oficial que valha a pena consumir direto.

The Central Bank only publishes the PIX participants list as a PDF, not CSV or JSON — we investigated and documented this in detail in the public BrasilAPI rollout plan. Unlike the rest of this platform's financial APIs, there's no "own primary source + fallback" here: it's a direct proxy to BrasilAPI, with cache, until a structured official source worth consuming directly shows up.

Usando o SDK

Using the SDK

SDKs oficiais: Go · Python · JavaScript.

Official SDKs: Go · Python · JavaScript.

Listar participantes

List participants

import (
	"context"
	"fmt"

	alicercelabs "github.com/alicercelabs/alicercesdk-go"
)

client := alicercelabs.New("alk_...") // ou um token JWT de login/register
ctx := context.Background()

participantes, err := client.PIX.Participantes(ctx)
if err != nil {
	panic(err)
}
fmt.Println(len(participantes), "participantes")

from alicercelabs import AlicerceLabs

client = AlicerceLabs(api_key="alk_...")  # ou um token JWT de login/register

participantes = client.pix.participantes()
print(len(participantes), "participantes")

import { AlicerceLabs } from "alicercesdk-javascript";

const client = new AlicerceLabs("alk_..."); // ou um token JWT de login/register

const participantes = await client.pix.participantes();
console.log(participantes.length, "participantes");

Limites

Limits

100/dia · 4/hora sem token, por IP chamador; com token (JWT de login ou API key gerada no painel), 1.000/dia · 41/hora. Resposta em cache por 24h.

100/day · 4/hour without a token, per calling IP; with one (a login JWT or an API key generated in the panel), 1,000/day · 41/hour. Response cached for 24h.