Leitura, por sistema, dos mesmos dados que você já consulta no Portal do Parceiro: carteiras, posição, estoque, eventos, covenants e relatórios de gestão.
Ambiente de homologação — dados de testeGET /api/v1/status: a resposta lista as carteiras que a chave enxerga.curl -s "https://api-homolog.admaas.com.br/api/v1/status" \
-H "Authorization: Bearer $ADMAAS_CHAVE"| Ambiente | Endereço | Chave começa com |
|---|---|---|
| Homologação | https://api-homolog.admaas.com.br | adm_hml_ |
| Produção | https://api.admaas.com.br | adm_live_ |
Uma chave só funciona no seu ambiente. A homologação usa uma cópia dos dados para teste: os números não valem como posição oficial.
Envie a chave em todas as chamadas, no cabeçalho Authorization:
Authorization: Bearer adm_hml_BMSEC.xxxxxxxxxxxx.<segredo>O cabeçalho X-Api-Key: <chave> também é aceito. A chave vale por 12 meses; antes do vencimento, peça uma nova. Toda chamada é feita por HTTPS.
A chave enxerga exatamente as carteiras liberadas para o seu acesso. Se uma carteira for incluída ou retirada do seu acesso, a mudança vale na chamada seguinte, sem trocar a chave.
Cada chave pode fazer até 60 chamadas por minuto e 20.000 por dia. O dia vira à meia-noite, horário de Brasília.
| Cabeçalho da resposta | Significado |
|---|---|
X-Cota-Minuto-Restante | Chamadas que ainda cabem no minuto corrente. |
X-Cota-Dia-Restante | Chamadas que ainda cabem no dia. |
Retry-After | Segundos para tentar de novo, quando a cota estoura (resposta 429). |
Toda resposta é JSON em UTF-8. Valores em reais vêm como número decimal; datas no formato AAAA-MM-DD e instantes em ISO 8601 (UTC).
{
"dados": { ... },
"meta": { "geradoEm": "2026-11-03T13:00:00.000Z", "carteiraId": 123 }
}{
"erro": {
"codigo": "carteira_nao_encontrada",
"mensagem": "Carteira não encontrada ou fora do acesso desta chave."
}
}Todos são de leitura (GET). O {id} da carteira vem de /api/v1/carteiras.
/api/v1/statusConfirma que a chave funciona e mostra o que ela enxerga: nome, validade, ambiente, carteiras liberadas e o consumo da cota. Use como primeiro teste da integração.
curl -s "https://api-homolog.admaas.com.br/api/v1/status" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/carteirasCarteiras liberadas para a chave, com o resumo consolidado de cada uma: ativo, caixa, PL, cota e passivo agregado.
curl -s "https://api-homolog.admaas.com.br/api/v1/carteiras" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/carteiras/{id}/posicaoPosição da carteira na data mais recente processada: composição do ativo, caixa, PL e cota.
curl -s "https://api-homolog.admaas.com.br/api/v1/carteiras/{id}/posicao" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/carteiras/{id}/analiseIndicadores do estoque: volumes cedidos e recebidos, inadimplência por faixa, concentração e evolução mensal.
curl -s "https://api-homolog.admaas.com.br/api/v1/carteiras/{id}/analise" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/carteiras/{id}/estoqueContratos do estoque, com saldo, atraso e situação, em páginas.
pagina | Número da página, a partir de 1. |
busca | Parte do número do contrato ou do nome do devedor. |
situacao | em_dia, vencido_1_90, vencido_90, quitado ou todos. |
curl -s "https://api-homolog.admaas.com.br/api/v1/carteiras/{id}/estoque?pagina=1&situacao=vencido_1_90" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/carteiras/{id}/eventos/{aba}Analítico da carteira linha a linha. A aba escolhe a visão: parcela, contrato, cessao ou liquidacao.
de, ate | Período, no formato AAAA-MM-DD. |
pagina | Número da página, a partir de 1. |
busca | Parte do contrato ou do devedor. |
soAbertas | true para trazer só parcelas em aberto. |
curl -s "https://api-homolog.admaas.com.br/api/v1/carteiras/{id}/eventos/liquidacao?de=2026-10-01&ate=2026-10-31" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/carteiras/{id}/covenantsCovenants ativos da carteira: situação de cada regra, quebras em aberto e eventos programados.
curl -s "https://api-homolog.admaas.com.br/api/v1/carteiras/{id}/covenants" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/relatoriosÍndice dos relatórios de gestão publicados das carteiras liberadas, com as operações (dealId) e as competências disponíveis.
curl -s "https://api-homolog.admaas.com.br/api/v1/relatorios" \
-H "Authorization: Bearer $ADMAAS_CHAVE"/api/v1/relatorios/{dealId}/{competencia}O relatório publicado de uma operação numa competência (AAAA-MM). Use o índice acima para saber o que existe.
curl -s "https://api-homolog.admaas.com.br/api/v1/relatorios/{dealId}/2026-10" \
-H "Authorization: Bearer $ADMAAS_CHAVE"| Status | Código | Quando acontece |
|---|---|---|
| 400 | parametro_invalido | Algum parâmetro está fora do formato. A mensagem diz qual. |
| 401 | chave_invalida | Chave ausente, errada, expirada, revogada ou de outro ambiente. |
| 404 | carteira_nao_encontrada | A carteira não existe ou não está liberada para a chave. |
| 404 | relatorio_nao_encontrado | O relatório não existe ou não está liberado para a chave. |
| 429 | cota_excedida | Cota da chave atingida. Respeite o Retry-After. |
| 429 | muitas_requisicoes | Excesso de chamadas do mesmo endereço IP. |
| 500 | erro_interno | Falha do nosso lado. Tente de novo; se persistir, fale conosco. |
| 503 | indisponivel | Serviço temporariamente indisponível. Tente de novo em instantes. |
de e ate.Retry-After antes de tentar de novo. Ao receber 500 ou 503, tente de novo com espera crescente (1 s, 2 s, 4 s...).Dúvidas, novas chaves e revogações: fale com a equipe de administração da BM SEC pelo seu canal habitual. Informe o início da chave (por exemplo, adm_hml_BMSEC.xxxxxxxxxxxx), nunca o segredo.
O uso da API é regido pelo termo de uso da API, parte do contrato de prestação de serviço.