Pular para o conteúdo
MyCEP
Menu

Documentação da API

API MyCEP para consulta de CEP e endereços

Integre sistemas, portais e rotinas internas com a base MyCEP. A API pública permite consultar um CEP específico ou pesquisar endereços por cidade e logradouro, retornando dados normalizados com bairro, UF e código IBGE quando disponíveis.

Referência interativa

Todos os endpoints, parâmetros e respostas — com “executar” no navegador usando a sua chave.

Exemplos de integração

O mesmo pedido em 8 linguagens. Troque a chave pelo valor gerado em Chaves de API.

curl "https://api.mycep.app.br/api/v1/search/cep/01001000" \
  -H "Authorization: Bearer cep_live_sua_chave_aqui"

Resposta

{
  "cep": "01001-000",
  "tipoLogradouro": "Praça",
  "logradouro": "da Sé",
  "bairro": "Sé",
  "cidade": "São Paulo",
  "uf": "SP",
  "ibge": "3550308",
  "latitude": -23.5505,
  "longitude": -46.6333,
  "geoPrecision": "street",
  "siafi": "7107",
  "ddd": "11",
  "timezone": "America/Sao_Paulo"
}

Buscar endereço por CEP

Use este endpoint quando o sistema já possui o CEP e precisa recuperar logradouro, bairro, cidade, UF e código IBGE.

GET /api/v1/search/cep/01001000
{
  "cep": "01001-000",
  "tipoLogradouro": "Praça",
  "logradouro": "da Sé",
  "bairro": "Sé",
  "cidade": "São Paulo",
  "uf": "SP",
  "ibge": "3550308",
  "latitude": -23.5505,
  "longitude": -46.6333,
  "geoPrecision": "street",
  "siafi": "7107",
  "ddd": "11",
  "timezone": "America/Sao_Paulo"
}

Buscar por cidade e logradouro

Use a busca textual para encontrar endereços quando o usuário informa cidade e parte do logradouro. Os dois parâmetros vão no caminho da URL em UTF-8 percent-encoded — é o que encodeURIComponent (JS), rawurlencode (PHP) e quote (Python) fazem. Acento enviado em ISO-8859-1 ou % literal sem virar %25 recebem 400.

GET /api/v1/search/address/Rio%20de%20Janeiro/Avenida%20Nilo%20Pe%C3%A7anha
{
  "addresses": [
    "…lista de endereços no mesmo formato…"
  ]
}

Autenticação e limites de uso

Assinantes autenticam por chave, não por IP. Crie uma chave em Conta → Chaves de API e envie-a no header Authorization: Bearer cep_live_…. Isso funciona de qualquer runtime — serverless, container ou função de borda — sem IP de saída fixo. A chave é exibida por inteiro apenas na criação: guardamos somente um hash.

Se quiser, cada chave aceita restrições opcionais de IP e de origem (Origin/Referer, para uso no navegador). Sem restrições, a chave vale de qualquer lugar; com elas, o que não bater é recusado.

A cota é mensal por assinante (o contador reseta no primeiro dia do mês, horário de Brasília) e varia por plano — veja planos. Ao esgotar, a API responde 429 com quota_exceeded.

A consulta pública anônima continua disponível em até 5 requisições por minuto e 30 por dia por endereço IP, sem campos de enriquecimento. Ao exceder qualquer um dos dois, o IP fica bloqueado por 6 horas. Para mais volume, crie uma conta grátis e use sua chave de API (500 consultas por mês).

Assinantes antigos que autenticam por IP cadastrado continuam funcionando com as condições do seu plano — a mudança para chave é opcional.

Sistemas parceiros (ex.: model5 clinic) usam uma chave de sistema no header Authorization: Bearer api_… — sem limite de consultas. Chaves MCP (mcp_…) valem só em POST /mcp e são recusadas na API REST.

Referência completa, com “try it” no navegador: /docs · documento OpenAPI: /openapi.json.

Operamos com monitoramento contínuo e esforços comerciais razoáveis de disponibilidade. SLA contratual com percentual garantido, IP dedicado e faturamento por contrato fazem parte do plano Enterprise.

Os exemplos desta página são ilustrativos e fornecidos no estado em que se encontram: não integram o objeto da assinatura e não constituem recomendação de arquitetura para o seu caso — ver a seção 12 dos Termos de Assinatura.

Campos retornados

cep CEP formatado (00000-000)
tipoLogradouro Tipo do logradouro (Rua, Avenida, Praça…)
logradouro Nome completo do logradouro
bairro Bairro, quando disponível
cidade / uf Município e unidade federativa
ibge Código IBGE do município