PHPackages                             josenildols/viacep-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. josenildols/viacep-php

ActiveLibrary[Utility & Helpers](/categories/utility)

josenildols/viacep-php
======================

ViaCEP PHP

v1.0.0(8y ago)71.3k4[1 PRs](https://github.com/JosenildoLS/viaCEP-PHP/pulls)MITPHPPHP ~5.6|~7.0

Since Feb 4Pushed 5y agoCompare

[ Source](https://github.com/JosenildoLS/viaCEP-PHP)[ Packagist](https://packagist.org/packages/josenildols/viacep-php)[ Docs](https://github.com/josenildoLS)[ RSS](/packages/josenildols-viacep-php/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (2)Used By (0)

viaCEP PHP
==========

[](#viacep-php)

[![GitHub license](https://camo.githubusercontent.com/dd2e80080bea08a8bc2dcabaaccef58e97d893f5398f9bfe615d9f4f03cb1b18/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f4a6f73656e696c646f4c532f7669614345502d5048502e7376673f7374796c653d666c61742d737175617265)](https://github.com/JosenildoLS/viaCEP-PHP/blob/master/LICENSE)[![GitHub issues](https://camo.githubusercontent.com/3d0fe9b2bc151deafc49b8bee31d600e627fc636a445f7ee8359aaa233a79175/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f4a6f73656e696c646f4c532f7669614345502d5048502e7376673f7374796c653d666c61742d737175617265)](https://github.com/JosenildoLS/viaCEP-PHP/issues)[![GitHub forks](https://camo.githubusercontent.com/753679a6c62450e7ac230baa375cef3b66de2b7dacfa518d3722753059d02d16/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f4a6f73656e696c646f4c532f7669614345502d5048502e7376673f7374796c653d666c61742d737175617265)](https://github.com/JosenildoLS/viaCEP-PHP/network)[![GitHub stars](https://camo.githubusercontent.com/13fd5928b702ce6ac8f90a5561f0bb1cf7ac6f581eb086808f7c9ead8954ddd2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f4a6f73656e696c646f4c532f7669614345502d5048502e7376673f7374796c653d666c61742d737175617265)](https://github.com/JosenildoLS/viaCEP-PHP/stargazers)[![Twitter](https://camo.githubusercontent.com/7cb7efda1acb7f01b6e434ffa9ec1e8296c4127e4189714347c623a9d952e05b/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f75726c2f68747470732f6769746875622e636f6d2f4a6f73656e696c646f4c532f7669614345502d5048502e7376673f7374796c653d736f6369616c267374796c653d666c61742d737175617265)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FJosenildoLS%2FviaCEP-PHP)

Faça busca por endereços do Brasil utilizando o [ViaCEP](https://viacep.com.br) REST API.

Instalação
----------

[](#instalação)

Via Composer

```
$ composer require josenildols/viacep-php
```

Como instanciar
---------------

[](#como-instanciar)

```
use JosenildoLS\viaCEP;

$cep = new viaCEP();
$cep->find('01001-000');
```

### Retorno em Array

[](#retorno-em-array)

```
$array = $cep->toArray();

/*
O resultado deverá ser algo assim:

Array
(
    [cep] => 01001-000
    [logradouro] => Praça da Sé
    [complemento] => lado ímpar
    [bairro] => Sé
    [localidade] => São Paulo
    [uf] => SP
    [unidade] =>
    [ibge] => 3550308
    [gia] => 1004
)

*/
```

### Retorno JSON

[](#retorno-json)

```
$json = $cep->toJson();

/*
O resultado deverá ser algo assim:

{
    cep: "01001-000",
    logradouro: "Praça da Sé",
    complemento: "lado ímpar",
    bairro: "Sé",
    localidade: "São Paulo",
    uf: "SP",
    unidade: "",
    ibge: "3550308",
    gia: "1004"
}
*/
```

### Retorno Piped

[](#retorno-piped)

```
$piped = $cep->toPiped();

/*
O resultado deverá ser algo assim:

cep:01001-000|logradouro:Praça da Sé|complemento:lado ímpar|bairro:Sé|localidade:São Paulo|uf:SP|unidade:|ibge:3550308|gia:1004
*/
```

### Retorno Querty

[](#retorno-querty)

```
$querty = $cep->toQuerty();

/*
O resultado deverá ser algo assim:

cep=01001-000&logradouro=Pra%C3%A7a+da+S%C3%A9&complemento=lado+%C3%ADmpar&bairro=S%C3%A9&localidade=S%C3%A3o+Paulo&uf=SP&unidade=&ibge=3550308&gia=1004
*/
```

### Salvar em .XML

[](#salvar-em-xml)

```
$cep->toXML("nome_da_pasta");

/*
O resultado deverá ser algo assim, devo ressaltar que o nome_da_pasta é opcional:

	01001-000
	Praça da Sé
	lado ímpar
	Sé
	São Paulo
	SP

	3550308
	1004

*/
```

### Salvar em .CSV

[](#salvar-em-csv)

```
$cep->toCSV("nome_da_pasta");

/*
O resultado deverá ser algo assim, devo ressaltar que o nome_da_pastaé opcional:

cep,logradouro,complemento,bairro,localidade,uf,unidade,ibge,gia
01001-000,Praça da Sé,lado ímpar,Sé,São Paulo,SP,,3550308,1004

*/
```

Licença
-------

[](#licença)

Sobre a licença MIT (MIT). Por favor, veja [License File](LICENSE.md) para mais informações.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3020d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/fd7f5107e26051676a2b3c7ed8083c9bb0d7dc3e85cbe7366953788e3d395d4a?d=identicon)[JosenildoLS](/maintainers/JosenildoLS)

---

Top Contributors

[![JosenildoLS](https://avatars.githubusercontent.com/u/34739822?v=4)](https://github.com/JosenildoLS "JosenildoLS (19 commits)")

---

Tags

cepzipcodebrazilviacepjosenildoLS

### Embed Badge

![Health badge](/badges/josenildols-viacep-php/health.svg)

```
[![Health](https://phpackages.com/badges/josenildols-viacep-php/health.svg)](https://phpackages.com/packages/josenildols-viacep-php)
```

###  Alternatives

[flyingluscas/viacep-php

ViaCEP PHP SDK

3640.2k](/packages/flyingluscas-viacep-php)[cagartner/correios-consulta

Package para pesquisa de serviços de busca por cep, calculo de frete e etc, diretamente nos serviços dos Correios.

159301.8k](/packages/cagartner-correios-consulta)[flyingluscas/correios-php

Uma maneira fácil de interagir com as principais funcionalidades dos Correios.

141362.4k3](/packages/flyingluscas-correios-php)[jarouche/viacep

Classe para pesquisar o CEP atraves do servico gratuito viacep

3324.4k](/packages/jarouche-viacep)[jansenfelipe/cep-gratis

Com esse pacote você poderá realizar consultas de CEP gratuitamente.

689.4k](/packages/jansenfelipe-cep-gratis)[magedev/brazilzipcode

Magento 2 module to use brazil zipcode search services.

1119.1k1](/packages/magedev-brazilzipcode)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)