Skip to content

Home

GitHub Workflow Status Coveralls github CodeFactor Grade Downloads Ratings Version

BrazilCEP is a minimalist and easy-to-use python library designed to query CEP (brazilian zip codes) data.

Its objective is to provide a common query interface to all these search services, facilitating the integration of Python applications with these services.

>>> get_address_from_cep('37503-130')
{
    'bairro': 'str',
    'cep': 'str',
    'cidade': 'str',
    'logradouro': 'str',
    'uf': 'str',
    'complemento': 'str',
}

Tip

BrazilCEP is the new name of former PyCEPCorreio python library. If you want to migrate the old code to the new version, please see the migrate section.

Features

  • Cross-platform: Windows, Mac, and Linux are officially supported.
  • Works with Python 3.8, 3.9, 3.10 and 3.11.
  • Currently supports several CEP API's:
  • ViaCEP
  • ApiCEP (WideNet)

BrazilCEP started as a personal study project and evolved into a serious and open source project that is used by many developers on a daily basis.