Pular para o conteúdo principal

Endpoint

GET https://api.bunny.build/api/v1/cep-lookup/:cep

Autenticação

HeaderObrigatórioValor
X-API-KeySimSua chave de API (bun_...)

Visão geral

Converta qualquer CEP brasileiro em endereço completo instantaneamente. A API de CEP da Bunny retorna logradouro, bairro, cidade e estado para qualquer CEP de 8 dígitos válido, sem necessidade de formatação prévia.

Casos de uso

  • Preenchimento automático de formulários de endereço no checkout
  • Validação de destinos de entrega
  • Enriquecimento de cadastros de clientes com dados de localização
  • Construção de mapas de área de entrega

Detalhes

Remova o hífen antes de passar o CEP. Aceita 01310100 ou 01310-100. Ambos funcionam. Retorna campos nulos para CEPs que cobrem um município inteiro sem logradouro específico.

Parâmetros de rota

ParâmetroTipoObrigatórioDescrição
cepstringSimCEP brasileiro, somente dígitos (ex.: 01310100)

Resposta

200 OK

CampoTipoDescrição
cepstringO CEP consultado
streetstring | nullNome do logradouro
complementstring | nullComplemento
districtstring | nullBairro
citystring | nullCidade
statestring | nullUF (ex.: SP)
Exemplo
{
  "cep": "01310100",
  "street": "Avenida Paulista",
  "complement": "de 1 a 610 - lado par",
  "district": "Bela Vista",
  "city": "São Paulo",
  "state": "SP"
}

401 Unauthorized

{
  "detail": "Missing API key. Include X-API-Key header."
}

402 Payment Required

{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}

404 Not Found

CEP não encontrado.
{
  "detail": "CEP not found"
}

422 Unprocessable Entity

Formato de CEP inválido.
{
  "detail": "Invalid CEP format"
}

429 Too Many Requests

{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}

Exemplo cURL

curl https://api.bunny.build/api/v1/cep-lookup/01310100 \
  -H "X-API-Key: bun_sua_chave_api"