A apiGetCep disponibiliza a consulta de endereçamento com base nos ceps do território brasileiro.
São catalogado cerca de 1.264.636 ceps, alocados em banco de dados próprio.
Informações disponíveis para acesso via API:
- cep
- logradouro
- complemento
- bairro
- cidade
- estado
- uf
- endereço Postal
Para realizar consultas de endereçamento utilize: https://apigetcep.cloud/:cep, onde ":cep" deverá ser a numeração do cep que deseja buscar as informações.
- Exemplo: https://apigetcep.cloud/77001219
Requisições para a API devem seguir os padrões:
| Método | Descrição |
|---|---|
GET |
Retorna informações de endereçamentos. |
| Código | Descrição |
|---|---|
200 |
Requisição executada com sucesso (success). |
400 |
Erros de validação ou os campos informados não existem no sistema. |
404 |
Registro pesquisado não encontrado (Not found). |
405 |
Método não permitido. |
422 |
Dados informados estão fora do escopo definido para o campo. |
429 |
Número máximo de requisições atingido. (aguarde alguns segundos e tente novamente) |
500 |
Erro interno do servidor. |
Existe o limite de 30 requisições por minuto por aplicação/usuário, onde é possível realizar até 5 consultas a cada 10 segundos.
Por questões de segurança, todas as requisições serão feitas através do protocolo HTTPS.
- Response 200 (application/json)
- Para o exemplo: https://apigetcep.cloud/77001219
{
"success": true,
"data": {
"cep": "77001-219",
"uf": "TO",
"bairro": "Plano Diretor Norte",
"complemento": null,
"cidade": "Palmas",
"logradouro": "Quadra ACSU NO 40 Rua NS A",
"estado": "Tocantins",
"enderecoPostal": "Quadra ACSU NO 40 Rua NS A, Plano Diretor Norte, 77001-219, Palmas/TO"
}
}
- Response 4xx ou 500 (application/json)
{
"error": *,
"success": false
}
Onde * é correspondente à messagem relativa ao erro.
Caio Queiroz
Esta Api esta sob a licença MIT.