API Reference

Consultar

get
https://api.focusnfe.com.br/v2/ceps

Esta operação permite consultar CEPs utilizando os seguintes critérios de pesquisa:

  • codigo_ibge: Pesquisa pelo CEP referente a uma localidade, conforme o código IBGE do município
  • uf: Pesquisa utilizando os dois caracteres referentes à Unidade da Federação. Ex: 'PR'.
  • logradouro: Pesquisa pelo logradouro completo ou por parte dele. Mínimo de 3 caracteres.
  • localidade: Pesquisa pelo nome completo da localidade ou por parte dele.

É necessário informar ao menos dois parâmetros para consulta. No caso especial de municípios que possuem um único CEP (não dividido em logradouros), é possível realizar a consulta informando apenas o parâmetro codigo_ibge.

Query Params
string

Código IBGE (7 dígitos) do município

string
length between 2 and 2

Sigla da Unidade da Federação (UF)

string
length ≥ 3

Logradouro completo ou parte dele (mínimo 3 caracteres)

string

Nome da localidade (município, distrito ou povoado) completo ou parte

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 21 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html

Updated 21 days ago