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

ActiveLibrary

macromindonline/zipcode
=======================

ZipCode From Brazil

v1.1(10y ago)013MITPHPPHP >=5.3.0

Since Oct 5Pushed 8y ago1 watchersCompare

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

READMEChangelogDependencies (4)Versions (3)Used By (0)

CANDUCCI ZIPCODE
================

[](#canducci-zipcode)

**Web Service provided by **

[![Canducci ZipCode](https://camo.githubusercontent.com/91a964a7a7fed1760a66bfbe59a92a6c231ca1755e44ee715553886848e7b69a/687474703a2f2f693636362e70686f746f6275636b65742e636f6d2f616c62756d732f767632352f6e6574647261676f6f6e2f6365705f7a70736f717461653568722e706e67)](https://packagist.org/packages/canducci/zipcode)

[![Build Status](https://camo.githubusercontent.com/81fb3a49cbd931da3a2794c690d170631646c3a592b1294e48f75dd3698481b9/68747470733a2f2f7472617669732d63692e6f72672f6e6574647261676f6f6e2f7a6970636f64652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/netdragoon/zipcode)[![Packagist](https://camo.githubusercontent.com/43ff7afcdb9d96e922b5b0ff5194932356643ea0e968c13b7ffc478b75b3ac5d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f63616e64756363692f7a6970636f64652e7376673f7374796c653d666c6174)](https://packagist.org/packages/canducci/zipcode)[![Packagist](https://camo.githubusercontent.com/f8d40ad4ce157e0b729e73f2486697eb169a5282924cafbcb2b0e92c4383cabd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f63616e64756363692f7a6970636f64652e737667)](https://packagist.org/packages/canducci/zipcode)[![Packagist](https://camo.githubusercontent.com/c18ff44f7ba716d80db0d8e3796e996d8a7ae20ab9f8976e7d341975b22ff564/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f63616e64756363692f7a6970636f64652e7376673f6c6162656c3d76657273696f6e)](https://packagist.org/packages/canducci/zipcode)

### Demo

[](#demo)

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

Quick start
-----------

[](#quick-start)

### Required setup

[](#required-setup)

In the `require` key of `composer.json` file add the following

```
"canducci/zipcode": "1.*"
```

Run the Composer update comand

```
$ composer update

```

In your `config/app.php` add `'Canducci\ZipCode\Providers\ZipCodeServiceProvider'` and `'Canducci\ZipCode\Providers\ZipCodeAddressServiceProvider'` to the end of the `providers` array:

```
'providers' => array(
    ...,
    Canducci\ZipCode\Providers\ZipCodeServiceProvider::class,
    Canducci\ZipCode\Providers\ZipCodeAddressServiceProvider::class,

),
```

At the end of `config/app.php` add `'ZipCode' => 'Canducci\ZipCode\Facade\ZipCode'` and add `'Address'` => 'Canducci\\ZipCode\\Facades\\ZipCodeAddress' to the `aliases` array:

```
'aliases' => array(
    ...,
    'ZipCode'   => Canducci\ZipCode\Facades\ZipCode::class,
    'Address'   => Canducci\ZipCode\Facades\ZipCodeAddress::class,

),
```

\##How to Use

To use is very simple, pass the ZIP and calls the various types of returns, like this:

**Package ZipCode**

\##Facade

**Add namespace:**

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

**Code Example**

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

\##Helper

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

\##Injection **Add Namespace**

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

**Code Example**

```
public function index(ZipCodeContract $zipcode)
{

      $zipCodeInfo = $zipcode->find('01414000');

```

\##Traits **Add Namespace**

```
use Canducci\ZipCode\ZipCodeTrait;
```

**Code Example**

```
class WelcomeController extends Controller {

	use ZipCodeTrait;

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

```

Summary of How to Use
---------------------

[](#summary-of-how-to-use)

**Code**

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

$zipCodeInfo = $zipcode->find('01414000', false); //Contracts

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

$zipCodeInfo = $this->zipcode('01414000', true); //Traist
```

**Return**

The return can be null or class instance ZipCodeInfo (`Canducci\ZipCode\ZipCodeInfo`)

**Methods ZipCodeInfo**:

- *Json => `getJson()`*

```
if ($zipCodeInfo)
{

    $zipCodeInfo->getJson();

    {
        "cep": "01414-001",
        "logradouro": "Rua Haddock Lobo",
        "bairro": "Cerqueira César",
        "localidade": "São Paulo",
        "uf": "SP",
        "ibge": "3550308",
        "complemento": ""
		"gia": 1004
    }

}
```

- *Array => `getArray()`*

```
if ($zipCodeInfo)
{

    $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
    )

}
```

- *Object => `getObject()`*

```
if ($zipCodeInfo)
{

    $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
    )

}
```

\##Renew item from cache

```
$zipCodeInfo  = ZipCode::find('01414001', true);

if ($zipCodeInfo)
{

    $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
    )
}
```

**Package Address**

***Obs: follows the same coding of ZipCode***

\###To add to the list of UF:

```
use Canducci\ZipCode\ZipCodeUf;
```

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

\###To search for all zip of a particular city , uf and address

```
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]);

}
```

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 66.7% 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 ~132 days

Total

2

Last Release

3741d ago

### Community

Maintainers

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

---

Top Contributors

[![fulviocanducci](https://avatars.githubusercontent.com/u/25593291?v=4)](https://github.com/fulviocanducci "fulviocanducci (28 commits)")[![netdragoon](https://avatars.githubusercontent.com/u/15145509?v=4)](https://github.com/netdragoon "netdragoon (13 commits)")[![vluzrmos](https://avatars.githubusercontent.com/u/450848?v=4)](https://github.com/vluzrmos "vluzrmos (1 commits)")

---

Tags

ziplaravel5cepzipcodecep from brazil

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[canducci/zipcode

ZipCode From Brazil

4555.1k](/packages/canducci-zipcode)[flyingluscas/viacep-php

ViaCEP PHP SDK

3640.2k](/packages/flyingluscas-viacep-php)

PHPackages © 2026

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