LBHM Utils

Consultar CEP

Retorna o endereço completo correspondente a um CEP brasileiro.

Requisição

GET /api/v1/cep/{cep}
  • {cep} — CEP com 8 dígitos (somente números, sem traço). Ex.: 01001000.
  • Requer autenticação por chave de API (veja Autenticação).

Exemplo:

curl -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  https://utils.lbhm.com.br/api/v1/cep/01001000

Resposta

200 OK com um objeto JSON:

{
  "cep": "01001000",
  "logradouro": "Praça da Sé",
  "bairro": "Sé",
  "cidade": "São Paulo",
  "uf": "SP",
  "cod_municipio": "3550308",
  "cod_tipo_rua": "24",
  "tipo": "Praça"
}

Campos

Campo Descrição
cep CEP consultado (8 dígitos).
logradouro Nome do logradouro (rua, avenida, praça…).
bairro Bairro.
cidade Município.
uf Sigla da unidade federativa (estado).
cod_municipio Código do município (IBGE).
cod_tipo_rua Código do tipo de logradouro.
tipo Tipo do logradouro por extenso (Rua, Avenida, Praça…).

Erros

Status Quando ocorre
401 Unauthorized Chave de API ausente ou inválida.
404 Not Found CEP não encontrado na base.
422 Unprocessable Entity CEP em formato inválido (precisa ter 8 dígitos numéricos).

Exemplo de CEP não encontrado:

{
  "error": "cep_nao_encontrado"
}

Exemplo de CEP em formato inválido:

{
  "error": "cep_invalido"
}