PHPackages                             canducci/zipcodepostmon - 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/zipcodepostmon

ActiveLibrary

canducci/zipcodepostmon
=======================

ZipCode From Brazil

v1.2(7y ago)016MITPHPPHP >=5.3.0

Since Dec 14Pushed 7y agoCompare

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

READMEChangelog (8)Dependencies (2)Versions (9)Used By (0)

Zipcode Postmon
===============

[](#zipcode-postmon)

#### Web Service Postmon ZipCode - Github

[](#web-service-postmon-zipcode---github-httpsgithubcompostmonapipostmon)

[![Build Status](https://camo.githubusercontent.com/5c73476882e18d8dc3b788b2407c3a16d42274f3db0f77ed88c0feaa551d74af/68747470733a2f2f7472617669732d63692e6f72672f66756c76696f63616e64756363692f7a6970636f64652d706f73746d6f6e2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/fulviocanducci/zipcode-postmon)[![](https://camo.githubusercontent.com/66e2f15db3f05259914ec416363d0f0489d44f53213cd90ee277c292b0609cbe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f63616e64756363692f7a6970636f6465706f73746d6f6e2e737667)](https://packagist.org/packages/canducci/zipcodepostmon)[![](https://camo.githubusercontent.com/c93f9443c89a2935406913bd281bdf081aefa95ff1d014385e2ac1dbec7363a3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f63616e64756363692f7a6970636f6465706f73746d6f6e2e737667)](https://packagist.org/packages/canducci/zipcodepostmon)

Required setup
--------------

[](#required-setup)

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

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

Run the Composer update comand

```
$ composer update

```

Configure in Laravel
--------------------

[](#configure-in-laravel)

In your `config/app.php` add `Canducci\ZipCodePostmon\Providers\ZipCodeProvider::class` to the end of the `providers` array:

```
'providers' => array(
    ...,
    Canducci\ZipCodePostmon\Providers\ZipCodeProvider::class
),
```

At the end of `config/app.php` add `'ZipCodeRequest' => 'Canducci\ZipCodePostmon\Facades\ZipCodeRequest'` to the `aliases` array:

```
'aliases' => array(
    ...,
    'ZipCodeRequest' => Canducci\ZipCode\Facades\ZipCodeRequest::class,
),
```

How to Use
----------

[](#how-to-use)

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

#### 1) Facade

[](#1-facade)

- *Add namespace:*

```
use Canducci\ZipCodePostmon\Facades\ZipCodeRequest;
```

- *Code Example*

```
$zipCodeResult = ZipCodeRequest::find('01414-001');
```

#### 2) Helper

[](#2-helper)

- *Code Example*

```
$zipCodeResult = zipcode('01414000');
//or
$zipCodeResult = zipcode()->find('01414000');
```

#### 3) Injection

[](#3-injection)

- *Add Namespace*

```
use Canducci\ZipCodePostmon\ZipCodeRequest;
```

- *Code Example*

```
public function index(ZipCodeRequest $zipCodeRequest)
{
      $zipCodeResult = $zipCodeRequest->find('01414000');
}
```

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

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

- *Code*

```
$zipCodeResult = ZipCodeRequest::find('01414000'); //Facade
$zipCodeResult = $zipCodeRequest->find('01414000'); //Contracts
$zipCodeResult = zipcode('01414000'); // Helper
$zipCodeResult = zipcode()->find('01414000'); // Helper
```

- *Return*

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

- *Assessor Methods*

```
$zipCodeResult->getNumber() // 01414000
$zipCodeResult->getComplement() // até 1048 - lado par
$zipCodeResult->getDistrict() // Cerqueira César
$zipCodeResult->getAddress() // Rua Haddock Lobo

$zipCodeResult->getCity()->getAreaKm() // 1521,11
$zipCodeResult->getCity()->getCodeIbge() // 3550308
$zipCodeResult->getCity()->getName() // São Paulo

$zipCodeResult->getState()->getAreaKm() // 248.221,996
$zipCodeResult->getState()->getCodeIbge() // 35
$zipCodeResult->getState()->getName() // SP
$zipCodeResult->getState()->getFullName() // São Paulo
$zipCodeResult->getClient() // Empty ZipCode Extra
```

*Or*

```
$zipCodeResult->number // 01414000
$zipCodeResult->complement // até 1048 - lado par
$zipCodeResult->district // Cerqueira César
$zipCodeResult->address // Rua Haddock Lobo

$zipCodeResult->city->areaKm // 1521,11
$zipCodeResult->city->codeIbge // 3550308
$zipCodeResult->city->name // São Paulo

$zipCodeResult->state->areaKm // 248.221,996
$zipCodeResult->state->codeIbge // 35
$zipCodeResult->state->name // SP
$zipCodeResult->state->fullName // São Paulo
$zipCodeResult->client // Empty ZipCode Extra
```

- *Methods toArray and toJson*

```
$arrayResult = $zipCodeResult->toArray();

Array
(
    [district] => Cerqueira César
    [number] => 01414000
    [state] => Array
        (
            [areaKm] => 248.221,996
            [codeIbge] => 35
            [name] => SP
            [fullName] => São Paulo
        )

    [city] => Array
        (
            [areaKm] => 1521,11
            [codeIbge] => 3550308
            [name] => São Paulo
        )

    [complement] => até 1048 - lado par
    [address] => Rua Haddock Lobo
    [client] =>
)
```

```
$jsonResult = $zipCodeResult->toJson();
{
    "district": "Cerqueira C\u00e9sar",
    "number": "01414000",
    "state": {
        "areaKm": "248.221,996",
        "codeIbge": "35",
        "name": "SP",
        "fullName": "S\u00e3o Paulo"
    },
    "city": {
        "areaKm": "1521,11",
        "codeIbge": "3550308",
        "name": "S\u00e3o Paulo"
    },
    "complement": "at\u00e9 1048 - lado par",
    "address": "Rua Haddock Lobo",
    "client": ""
}
```

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity61

Established project with proven stability

 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

Every ~1 days

Total

8

Last Release

2693d ago

Major Versions

v0.3.1-beta → v1.02018-12-16

### 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 (55 commits)")

---

Tags

laravelzipcepzipcodecep from brazil

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[canducci/zipcode

ZipCode From Brazil

4555.1k](/packages/canducci-zipcode)[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)