Documentação

Consultar um CEP

Devolve o logradouro, o bairro, a cidade e a UF de um CEP.

GET
/postal-codes/{postal_code}

Autenticação

apiKey
headerAuthorizationBearer <chave de API>

Chave de API no cabeçalho Authorization: Bearer cf_live_.... Crie e revogue chaves no painel, em Desenvolvedores > Chaves de API.

Parâmetros de caminho

postal_code*string

O CEP, com ou sem hífen.

Formato^[0-9]{5}-?[0-9]{3}$

Corpo da resposta

O endereço do CEP.

application/json
  1. response

O endereço de um CEP, segundo a base de CEPs dos Correios.

object*string

Tipo do objeto. Sempre postal_code.

postal_code*string

O CEP no formato 00000-000.

Formato^[0-9]{5}-[0-9]{3}$
street*|

Logradouro do CEP. null quando o CEP vale para a cidade inteira, comum em cidades pequenas.

neighborhood*|

Bairro do CEP. null quando o CEP vale para a cidade inteira.

city*string

Cidade do CEP.

state*string

UF do CEP.

Valores possíveis

  • AC: Acre
  • AL: Alagoas
  • AP: Amapá
  • AM: Amazonas
  • BA: Bahia
  • CE: Ceará
  • DF: Distrito Federal
  • ES: Espírito Santo
  • GO: Goiás
  • MA: Maranhão
  • MT: Mato Grosso
  • MS: Mato Grosso do Sul
  • MG: Minas Gerais
  • PA: Pará
  • PB: Paraíba
  • PR: Paraná
  • PE: Pernambuco
  • PI: Piauí
  • RJ: Rio de Janeiro
  • RN: Rio Grande do Norte
  • RS: Rio Grande do Sul
  • RO: Rondônia
  • RR: Roraima
  • SC: Santa Catarina
  • SP: São Paulo
  • SE: Sergipe
  • TO: Tocantins
Valores"AC""AL""AP""AM""BA""CE""DF""ES""GO""MA""MT""MS""MG""PA""PB""PR""PE""PI""RJ""RN""RS""RO""RR""SC""SP""SE""TO"
curl "https://api.cartaflow.com.br/v1/postal-codes/string" \  -H "Authorization: Bearer $CARTAFLOW_API_KEY"
{  "object": "postal_code",  "postal_code": "01001-000",  "street": "Praça da Sé",  "neighborhood": "Sé",  "city": "São Paulo",  "state": "SP"}