PHPackages                             canducci/zipcode - 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. canducci/zipcode

ActiveLibrary

canducci/zipcode
================

ZipCode From Brazil

v3.0.7(1y ago)4555.1k↓35.7%17MITPHPPHP >=8.3.2CI failing

Since Oct 5Pushed 1y ago3 watchersCompare

[ Source](https://github.com/netdragoon/zipcode)[ Packagist](https://packagist.org/packages/canducci/zipcode)[ Docs](https://github.com/netdragoon/zipcode)[ RSS](/packages/canducci-zipcode/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (4)Versions (21)Used By (0)

Canducci Zipcode
================

[](#canducci-zipcode)

### Laravel pacote do Web Service [VIACEP web service](http://viacep.com.br/) -

[](#laravel-pacote-do-web-service-viacep-web-service---httpviacepcombr)

---

[![Downloads](https://camo.githubusercontent.com/43ff7afcdb9d96e922b5b0ff5194932356643ea0e968c13b7ffc478b75b3ac5d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f63616e64756363692f7a6970636f64652e7376673f7374796c653d666c6174)](https://packagist.org/packages/canducci/zipcode)[![Version](https://camo.githubusercontent.com/c18ff44f7ba716d80db0d8e3796e996d8a7ae20ab9f8976e7d341975b22ff564/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f63616e64756363692f7a6970636f64652e7376673f6c6162656c3d76657273696f6e)](https://packagist.org/packages/canducci/zipcode)[![PHP Composer](https://github.com/netdragoon/zipcode/workflows/PHP%20Composer/badge.svg)](https://github.com/netdragoon/zipcode/workflows/PHP%20Composer/badge.svg)

[See Demo](http://zipcodedemo.herokuapp.com/)

Utilizando composer: [Composer](https://getcomposer.org/)
---------------------------------------------------------

[](#utilizando-composer-composer)

```
composer require canducci/zipcode
```

Adicione as classes no final do array de `providers` no arquivo `config/app.php`:

```
'providers' => [
    // ...,
    Canducci\ZipCode\Providers\ZipCodeServiceProvider::class,
    Canducci\ZipCode\Providers\ZipCodeAddressServiceProvider::class,
],
```

e adicione os seus apelidos no array `aliases`:

```
'aliases' => [
    // ...,
    'ZipCode'   => Canducci\ZipCode\Facades\ZipCode::class,
    'Address'   => Canducci\ZipCode\Facades\ZipCodeAddress::class,
],
```

para finalizar precisa dar um:

```
php artisan vendor:publish
```

após digitar esse comando vai aparecer um menu de opções então escolha `Canducci\ZipCode\Providers\ZipCodeServiceProvider` para publicar o arquivo de configuração (`simplecache.php`) na pasta `config/`

Como utilizar?
--------------

[](#como-utilizar)

Temos 4 caminhos para usufruir desse pacote:

- [Facade](#facade)
- [Helper](#helper)
- [Injection](#injection)
- or [Trait](#trait)

### Facade

[](#facade)

```
use Canducci\ZipCode\Facades\ZipCode;

$zipCodeInfo = ZipCode::find('01414-001');
```

### Helper

[](#helper)

```
$zipCodeInfo = zipcode('01414000');
```

### Injection

[](#injection)

```
use Canducci\ZipCode\Contracts\ZipCodeContract;

public function index(ZipCodeContract $zipcode)
{
      $zipCodeInfo = $zipcode->find('01414-000');
}
```

### Trait

[](#trait)

```
use Canducci\ZipCode\ZipCodeTrait;

class WelcomeController extends Controller
{
    use ZipCodeTrait;

    public function index()
    {
        $zipCodeInfo =	$this->zipcode('01414000');
    }
}
```

Há diversas formas de chegar no mesmo resultado:

```
$zipCodeInfo = ZipCode::find('01414000'); // Facade

$zipCodeInfo = $zipcode->find('01414-000'); // Contract

$zipCodeInfo = zipcode('01414000'); // Helper

$zipCodeInfo = $this->zipcode('01414-000'); // Trait
```

---

### Cache renovar

[](#cache-renovar)

Pode forçar um item a renovar seu cache com o segundo parâmetro:

```
$zipCodeInfo = ZipCode::find('01414000', true); // Facade

$zipCodeInfo = $zipcode->find('01414-000', true); // Contract

$zipCodeInfo = zipcode('01414000', true); // Helper

$zipCodeInfo = $this->zipcode('01414-000', true); // Trait
```

---

### Tipos de retornos

[](#tipos-de-retornos)

Por padrão o retorno é nulo ou a instância da classe `Canducci\ZipCode\ZipCodeInfo`, e com esse retorno de classe existe os tipos `array`, `object` e `json` texto:

- [Array](#array)
- [Json](#json)
- [Object](#object)

```
if ($zipCodeInfo) // null or ZipCodeInfo
{
    $arr = $zipCodeInfo->getArray(); // Array

    $json = $zipCodeInfo->getJson(); // Json

    $obj = $zipCodeInfo->getObject(); // Object
}
```

#### Array

[](#array)

```
if ($zipCodeInfo)
{
    $arr = $zipCodeInfo->getArray();
    /*
    Array
    (
        [cep] => 01414-001
        [logradouro] => Rua Haddock Lobo
        [bairro] => Cerqueira César
        [localidade] => São Paulo
        [uf] => SP
        [ibge] => 3550308,
        [complemento] =>
        [gia] => 1004,
        [siafi] => 0
        [ddd] = 11,
        [unidade] = '',
        [estado] = '',
        [regiao] = ''
    )
    */
}
```

#### Json

[](#json)

```
if ($zipCodeInfo)
{
    $json = $zipCodeInfo->getJson();
    /*
    {
        "cep": "01414-001",
        "logradouro": "Rua Haddock Lobo",
        "bairro": "Cerqueira César",
        "localidade": "São Paulo",
        "uf": "SP",
        "ibge": "3550308",
        "complemento": ""
        "gia": 1004,
        "ddd": "11",
        "siafi": 0,
        "unidade": '',
        "estado": '',
        "regiao": ''
    }
    */
}
```

#### Object

[](#object)

```
if ($zipCodeInfo)
{
    $obj = $zipCodeInfo->getObject();
    /*
    stdClass Object
    (
        [cep] => 01414-001
        [logradouro] => Rua Haddock Lobo
        [bairro] => Cerqueira César
        [localidade] => São Paulo
        [uf] => SP
        [ibge] => 3550308
        [complemento] =>
        [gia] => 1004
        [siafi] => 0
        [ddd] = 011,
        [unidade] = '',
        [estado] = '',
        [regiao] = ''
    )
    */
}
```

---

### Faça a buscas de varios endereços informando, `uf`, `cidade` e `endereço`:

[](#faça-a-buscas-de-varios-endereços-informando-uf-cidade-e-endereço)

```
public function get(Request $request)
{
    $uf = $request->get('uf');
    $city = $request->get('cidade');
    $address = $request->get('endereco')
    $zipcodeaddressinfo = zipcodeaddress($uf, $city, $address);
    if ($zipcodeaddressinfo)
        return $zipcodeaddressinfo->getJson();
    return Response::json(['error' => 1]);
}
```

---

### Lista de Unidade Federativa:

[](#lista-de-unidade-federativa)

```
use Canducci\ZipCode\ZipCodeUf;

$lists = ZipCodeUf::lists();
```

###  Health Score

51

—

FairBetter than 96% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity42

Moderate usage in the ecosystem

Community19

Small or concentrated contributor base

Maturity87

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 74.8% 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

Every ~223 days

Recently: every ~388 days

Total

16

Last Release

522d ago

Major Versions

v1.1 → v2.02019-01-30

v2.0.3 → v3.0-beta2020-09-11

PHP version history (3 changes)v1.0PHP >=5.3.0

v3.0-betaPHP >=7.2.7

v3.0.7PHP >=8.3.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/43fc765f09ee564408d8da952d2ea824c1c8d2ab7e0aa055885fa011d92082fa?d=identicon)[fulviocanducci](/maintainers/fulviocanducci)

---

Top Contributors

[![fulviocanducci](https://avatars.githubusercontent.com/u/25593291?v=4)](https://github.com/fulviocanducci "fulviocanducci (77 commits)")[![netdragoon](https://avatars.githubusercontent.com/u/15145509?v=4)](https://github.com/netdragoon "netdragoon (15 commits)")[![giovannipds](https://avatars.githubusercontent.com/u/1820017?v=4)](https://github.com/giovannipds "giovannipds (7 commits)")[![jakjr](https://avatars.githubusercontent.com/u/3920960?v=4)](https://github.com/jakjr "jakjr (2 commits)")[![carusogabriel](https://avatars.githubusercontent.com/u/16328050?v=4)](https://github.com/carusogabriel "carusogabriel (1 commits)")[![vluzrmos](https://avatars.githubusercontent.com/u/450848?v=4)](https://github.com/vluzrmos "vluzrmos (1 commits)")

---

Tags

cepfacadeinjectionjsonrenewaltraitlaravelzipcepzipcodecep from brazil

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/canducci-zipcode/health.svg)

```
[![Health](https://phpackages.com/badges/canducci-zipcode/health.svg)](https://phpackages.com/packages/canducci-zipcode)
```

###  Alternatives

[madnest/madzipper

Easier zip file handling for Laravel applications.

1382.3M6](/packages/madnest-madzipper)

PHPackages © 2026

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