Documentação

Integre em minutos

Teste a busca ao vivo, copie um exemplo na sua linguagem e coloque endereços oficiais na sua aplicação hoje.

Busca de CEP ao vivo

Digite um CEP e veja a resposta real da API. Sem cadastro para testar.

🔎 Consultar CEP

Aguardando consulta…
⚙️ A demo aponta para https://cep.branux.com.br. Enquanto o endpoint de produção é liberado para o seu domínio, a página usa uma fonte pública de demonstração para você visualizar o formato da resposta.

Autenticação

Três formas de acesso, do protótipo à produção corporativa:

API Key (recomendado para apps)

Envie sua chave no cabeçalho X-Api-Key:

curl "https://branux-cep.branux.com.br/api/cep/v2/enderecos/01001000" \
  -H "X-Api-Key: bcep_a1b2c3d.SUACHAVESECRETA"

JWT corporativo

Use o mesmo token do Branux ERP, com isolamento por empresa (multi-tenant por subdomínio):

curl "https://branux-cep.com.br/api/cep/v2/enderecos/01001000" \
  -H "Authorization: Bearer SEU_TOKEN_JWT"

Anônimo

Sem chave, limitado a 100 consultas/dia por IP — ideal para testes e provas de conceito.

Exemplos de código

Busca por CEP nas linguagens mais usadas:

const cep = "01001000";
const r = await fetch(`https://branux-cep.branux.com.br/api/cep/v2/enderecos/${cep}`, {
  headers: { "X-Api-Key": "bcep_a1b2c3d.SUACHAVESECRETA" }
});
const endereco = await r.json();
console.log(endereco.logradouro, endereco.localidade, endereco.uf);
$ch = curl_init("https://branux-cep.branux.com.br/api/cep/v2/enderecos/01001000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: bcep_a1b2c3d.SUACHAVESECRETA"]);
$endereco = json_decode(curl_exec($ch), true);
echo $endereco["logradouro"];
import requests
r = requests.get(
    "https://cep.branux.com.br/api/cep/v2/enderecos/01001000",
    headers={"X-Api-Key": "bcep_a1b2c3d.SUACHAVESECRETA"})
endereco = r.json()
print(endereco["logradouro"], endereco["localidade"], endereco["uf"])
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "bcep_a1b2c3d.SUACHAVESECRETA");
var json = await http.GetStringAsync(
    "https://branux-cep.branux.com.br/api/cep/v2/enderecos/01001000");
Console.WriteLine(json);

Endereços

MétodoEndpointDescrição
GET/api/cep/v2/enderecos/{cep}Endereço completo de um CEP
GET/api/cep/v2/enderecos?uf=&localidade=&logradouro=Busca reversa por filtros

Exemplo de resposta:

{
  "cep": "01001000",
  "logradouro": "Praça da Sé",
  "complemento": "lado ímpar",
  "bairro": "Sé",
  "localidade": "São Paulo",
  "uf": "SP"
}

Dados geográficos

MétodoEndpointDescrição
GET/api/cep/v1/ufsLista as 27 UFs
GET/api/cep/v1/localidades/{uf}Cidades de uma UF
GET/api/cep/v1/bairros/{uf}/localidades/{localidade}Bairros de uma cidade
GET/api/cep/v1/atualizacaoVersão atual do DNE carregado

Unidades dos Correios

MétodoEndpointDescrição
GET/api/cep/v1/localidades/cliquesPontos Clique & Retire
GET/api/cep/v1/localidades/caixas-postaisAgências com caixa postal
GET/api/cep/v1/localidades/agencias-modularesAgências modulares

Administração (planos Negócios e Enterprise)

MétodoEndpointDescrição
POST/api/cep/admin/api-keysCria nova API Key
DEL/api/cep/admin/api-keys/{id}Revoga uma chave
POST/api/cep/admin/cep/importar-csvImporta base própria (CSV)

Códigos de resposta

CódigoSignificado
200Sucesso — endereço encontrado
204Consulta válida, sem resultados
400Requisição malformada (ex.: CEP inválido)
401Não autenticado
403Sem permissão para o recurso
429Cota excedida — aguarde ou faça upgrade
Pronto para produção? Escolha um plano →