# Código Postal

Consulta os detalhes de um código de endereçamento postal brasileiro, incluindo:

  • Logradouro, bairro, cidade e estado
  • Código IBGE do município

# Consulta CEP

GET /zip/:code

Parâmetro Descrição
code
Obrigatório
CEP com 8 dígitos

# Exemplos

/zip/05426200
{
  "municipality": 3550308,
  "zip": "05426200",
  "street": "Avenida Brigadeiro Faria Lima",
  "district": "Pinheiros",
  "city": "São Paulo",
  "state": "SP"
}
/zip/12345678
{
  "code": 404,
  "message": "zip does not exist"
}

# Tipagem

Propriedade Tipo Descrição
municipality number Código IBGE do município
zip string CEP
street string Logradouro
district string Bairro
city string Nome da cidade
state string Sigla da UF