Pesquisa avançada de CEPs

GET/v1/ceps

Retorna uma lista paginada de CEPs com base nos filtros fornecidos. - O resultado da consulta é paginado com limite de 200 itens por pagina. - Limite global de 2.000 itens. - Cada consulta consome 2 créditos. - Disponível somente nos planos pagos.

URL base: https://api.nextapi.com.br. Autenticação: Authorization: Bearer SEU_TOKEN.

Exemplo de requisição

Substitua os valores de exemplo pelos dados da sua consulta. O código não executa uma chamada automaticamente.

cURL

curl --request GET 'https://api.nextapi.com.br/v1/ceps' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'

Parâmetros

Nome	Local	Obrigatório	Tipo / regras	Descrição
`uf`	query	Não	`string`	Sigla do estado (ex: SP, RJ)
`idMunicipio`	query	Não	`integer (int32)`	Código do município
`nomeMunicipio`	query	Não	`string`	Nome do município para filtro (busca parcial)
`logradouro`	query	Não	`string`	Nome do logradouro para filtro (busca parcial)
`q`	query	Não	`string`	Busca global, realiza busca por palavra/texto nos campos cep, logradouro, localidade, nomeMunicipio e uf
`page`	query	Não	`integer (int32)`	Número da página (padrão: 1)
`pageSize`	query	Não	`integer (int32)`	Quantidade de itens por página (máx: 200)

Respostas HTTP

Status	Descrição	Formato JSON
`200`	Operação realizada com sucesso	CepItemResponsePagedResult
`400`	Erro nos parametros informados na requisição	IErrorCodeModel
`405`	Falta de créditos para realizar a consulta	IErrorCodeModel
`500`	Erro ao processar a requisição	objeto

Envie Accept: application/json para solicitar JSON. Autenticação e limites também podem gerar erros antes da execução da operação. Consulte o guia de tratamento de erros.

Resposta de sucesso

Exemplo estrutural gerado do schema: os valores abaixo são ilustrativos, não representam uma consulta real. Campos anuláveis podem retornar null.

JSON · estrutura ilustrativa

{
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "items": [
    {
      "cep": "string",
      "logradouro": "string",
      "localidade": "string",
      "idMunicipio": 0,
      "nomeMunicipio": "string",
      "uf": "string",
      "latitude": 0,
      "longitude": 0,
      "dataAtualizacao": "2026-01-01T00:00:00",
      "codigoIbge": {
        "municipio": 0,
        "estado": 0,
        "pais": 0
      }
    }
  ]
}

Campos da resposta

Modelo: CepItemResponsePagedResult

CepItemResponsePagedResult

Campo	Tipo	Obrigatório	Descrição / regras
`page`	`integer (int32)`	Não marcado no contrato	—
`pageSize`	`integer (int32)`	Não marcado no contrato	—
`total`	`integer (int64)`	Não marcado no contrato	—
`items`	`CepItemResponse[]`	Não marcado no contrato	—

CepItemResponse

Campo	Tipo	Obrigatório	Descrição / regras
`cep`	`string \| null`	Sim	—
`logradouro`	`string \| null`	Não marcado no contrato	—
`localidade`	`string \| null`	Não marcado no contrato	—
`idMunicipio`	`integer (int32) \| null`	Não marcado no contrato	—
`nomeMunicipio`	`string \| null`	Não marcado no contrato	—
`uf`	`string \| null`	Não marcado no contrato	—
`latitude`	`number (double) \| null`	Não marcado no contrato	—
`longitude`	`number (double) \| null`	Não marcado no contrato	—
`dataAtualizacao`	`string (date-time) \| null`	Não marcado no contrato	—
`codigoIbge`	`CepCodigoIbgeResponse`	Não marcado no contrato	—

CepCodigoIbgeResponse

Campo	Tipo	Obrigatório	Descrição / regras
`municipio`	`integer (int32) \| null`	Não marcado no contrato	—
`estado`	`integer (int32) \| null`	Não marcado no contrato	—
`pais`	`integer (int32) \| null`	Não marcado no contrato	—

Contrato desta operação

OpenAPI · JSON

{
  "tags": [
    "CEPs"
  ],
  "summary": "Pesquisa avançada de CEPs",
  "description": "Retorna uma lista paginada de CEPs com base nos filtros fornecidos.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Limite global de 2.000 itens.\n- Cada consulta consome 2 créditos.\n- Disponível somente nos planos pagos.",
  "parameters": [
    {
      "name": "uf",
      "in": "query",
      "description": "Sigla do estado (ex: SP, RJ)",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "idMunicipio",
      "in": "query",
      "description": "Código do município",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "nomeMunicipio",
      "in": "query",
      "description": "Nome do município para filtro (busca parcial)",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "logradouro",
      "in": "query",
      "description": "Nome do logradouro para filtro (busca parcial)",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "q",
      "in": "query",
      "description": "Busca global, realiza busca por palavra/texto nos campos cep, logradouro, localidade, nomeMunicipio e uf",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "page",
      "in": "query",
      "description": "Número da página (padrão: 1)",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "description": "Quantidade de itens por página (máx: 200)",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operação realizada com sucesso",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CepItemResponsePagedResult"
          }
        },
        "text/xml": {
          "schema": {
            "$ref": "#/components/schemas/CepItemResponsePagedResult"
          }
        }
      }
    },
    "400": {
      "description": "Erro nos parametros informados na requisição",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        },
        "text/xml": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        }
      }
    },
    "405": {
      "description": "Falta de créditos para realizar a consulta",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        },
        "text/xml": {
          "schema": {
            "$ref": "#/components/schemas/IErrorCodeModel"
          }
        }
      }
    },
    "500": {
      "description": "Erro ao processar a requisição",
      "content": {
        "application/json": {
          "schema": {}
        },
        "text/xml": {
          "schema": {}
        }
      }
    }
  },
  "method": "GET",
  "path": "/v1/ceps",
  "slug": "get-v1-ceps"
}