BY Tools

CEP API

GET

https://api.bytools.tech/api/v1/public/geradores/cep

geradorescep

Responsável:Cristiano Cardoso

O Gerador de CEP retorna endereços fictícios para uso em validações de formulários e desenvolvimento de sistemas.

Dados Gerados

CEP: Código postal válido

Endereço: Nome da rua ou avenida

Bairro: Região correspondente

Cidade: Nome da cidade

Estado: Sigla do estado correspondente

Como Usar

Basta realizar uma requisição GET para o endpoint correspondente. A resposta retornará um endereço completo com um CEP válido para testes.

Atenção: Testar a API diretamente pela documentação consome seu limite de requisições.

Requisição

Parâmetros Query

points

boolean

requerido

Define se deve incluir pontuação no número gerado

Exemplo:

true

city

string

requerido

Retorna com pontuação ou não

state

enum<string>

requerido

A partir de qual cidade

Valores permitidos:

ACALAPAMBACEDFESGOMAMTMSMGPAPBPRPEPIRJRNRSRORRSCSPSETO

Parâmetros Header

X-API-KEY

string

requerido

Você consegue gerar o token em configurações

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.bytools.tech/api/v1/public/geradores/cep?points=true&city&state' \
--header 'X-API-KEY;'

Respostas

🟢200200

application/json

Body

data

object

requerido

cep

string

requerido

address

string

requerido

district

string

requerido

city

string

requerido

state

string

requerido

Exemplo

{
  "data": {
    "cep": "06093-901",
    "address": "Avenida Marechal Rondon 300",
    "district": "Centro",
    "city": "Osasco",
    "state": "SP"
  }
}

🟠401401

🟠422422

Modified at 2025-03-20 16:41:33

CEP API

Dados Gerados#

Como Usar#

Requisição

Exemplos de Requisição

Respostas

Dados Gerados

Como Usar