amazingbits/zipcode-finder

A library to find addresses by passing zip-codes

1.0.1 2023-09-12 19:05 UTC

MIT

• Guilherme Andrade

README

This library generates an array with address informations by passing a zip code.

The zip code must be in this format: 00000-000 to work correctly.

The example file in root demonstrate how it works.

Thes library use the following APIs to search addresses by zipcode:

• ViaCEP
• CDN API CEP
• OpenCEP

To use this library, just init Search class from namespace Amazingbits\ZipcodeFinder\UseCase\Search\Search and call the method getAddressFromZipCode() passing a zip code with this format: 00000-000. It returns an array with: cep, street, district, city and state or false.

Click here to repository.