PHPackages                             kseven/phpviacep - 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. kseven/phpviacep

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

kseven/phpviacep
================

ViaCEP PHP SDK

v1.0.1(3y ago)017MITPHPPHP ^7.4 || ^8.0

Since Feb 15Pushed 3y ago1 watchersCompare

[ Source](https://github.com/KDevelopement/PHPViaCEP)[ Packagist](https://packagist.org/packages/kseven/phpviacep)[ Docs](https://github.com/KS7ven/PHPViaCEP)[ RSS](/packages/kseven-phpviacep/feed)WikiDiscussions master Synced today

READMEChangelog (2)Dependencies (4)Versions (3)Used By (0)

ViaCEP PHP SDK
==============

[](#viacep-php-sdk)

[![Latest Version on Packagist](https://camo.githubusercontent.com/bc43a8682f7214a36272ac7d8fc7480b83c5b800ba88e20f54826ca806945ec1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b736576656e2f7068707669616365702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/kseven/phpviacep)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/66a44c291e597c4d57efdb9642ab34eea49e042089e7776e4f3bd6dbca335731/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6b736576656e2f7068707669616365702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/kseven/phpviacep)[![Coverage Status](https://camo.githubusercontent.com/e43231fe4b11f56381e342b159bc1ea3d232728010c64aaf855b1ad0836ff390/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f4b533776656e2f5048505669614345502f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/KS7ven/PHPViaCEP?branch=master)[![](https://github.com/KS7ven/PHPViaCEP/workflows/PHPUnit/badge.svg)](https://github.com/KS7ven/PHPViaCEP/actions/workflows/phpunit.yml)[![](https://github.com/KS7ven/PHPViaCEP/workflows/PHPStan/badge.svg)](https://github.com/KS7ven/PHPViaCEP/actions/workflows/phpstan.yml)[![](https://github.com/KS7ven/PHPViaCEP/workflows/Deptrac/badge.svg)](https://github.com/KS7ven/PHPViaCEP/actions/workflows/deptrac.yml)

Pesquise endereços por CEP usando a API REST [ViaCEP](https://viacep.com.br).

Instalar
--------

[](#instalar)

Via Composer

```
$ composer require kseven/phpviacep
```

Uso
---

[](#uso)

### findByZipCode (Sem retorno de chamada)

[](#findbyzipcode-sem-retorno-de-chamada)

Encontre o endereço pelo código postal.

```
use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000')->toArray();

/*
Deve retornar algo assim:

[
    'zipCode' => '01001-000',
    'street' => 'Praça da Sé',
    'complement' => 'lado ímpar',
    'neighborhood' => 'Sé',
    'city' => 'São Paulo',
    'state' => 'SP',
    'ibge' => '3550308',
]
*/

$Address = $ViaCEP->findByZipCode('01001-000')->toJson();

/*
Deve retornar algo assim:

{
    "zipCode": "01001-000",
    "street": "Praça da Sé",
    "complement": "lado ímpar",
    "neighborhood": "Sé",
    "city": "São Paulo",
    "state": "SP",
    "ibge": "3550308"
}
*/
```

### findByZipCode (Com retorno de chamada)

[](#findbyzipcode-com-retorno-de-chamada)

Encontre o endereço por código postal, com retorno de chamada.

```
use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000', 'callback_name')->withCallback();

/*
Deve retornar algo assim:

callback_name({
    "cep": "01001-000",
    "logradouro": "Praça da Sé",
    "complemento": "lado ímpar",
    "bairro": "Sé",
    "localidade": "São Paulo",
    "uf": "SP",
    "ibge": "3550308",
    "gia": "1004",
    "ddd": "11",
    "siafi": "7107"
});
*/
```

### findByStreetName

[](#findbystreetname)

Pesquise endereços usando estado, cidade e nome de uma rua.

```
use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Addresses = $ViaCEP->findByStreetName('SP', 'São Paulo', 'Gomes de Carvalho');

/*
Deve retornar algo assim:

[
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ],
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ]
]
*/
```

Registo de alterações
---------------------

[](#registo-de-alterações)

Consulte [CHANGELOG](CHANGELOG.md) para obter mais informações sobre o que mudou recentemente.

Contribuindos
-------------

[](#contribuindos)

Consulte [CONTRIBUINDO](CONTRIBUINDO.md) e [CONDUTA](CONDUTA.md) para obter detalhes.

Segurança
---------

[](#segurança)

Se você descobrir algum problema relacionado à segurança, envie um e-mail para  em vez de usar o rastreador de problemas.

Credits
-------

[](#credits)

- [K'Seven](https://github.com/KS7ven)
- [All Contributors](../../contributors)

Licença
-------

[](#licença)

A licença MIT (MIT). Consulte [Arquivo de licença](LICENSE.md) para obter mais informações..

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity52

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

Every ~0 days

Total

2

Last Release

1234d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/370be5a4a8a82b20f3c9a77adc97316236c3473f87419f3595b5080bf5252bf0?d=identicon)[kseven](/maintainers/kseven)

---

Top Contributors

[![ksevendev](https://avatars.githubusercontent.com/u/32661918?v=4)](https://github.com/ksevendev "ksevendev (27 commits)")

---

Tags

phpviacep-apiaddresscepzipcodebrazilviacependerecoskSeven

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/kseven-phpviacep/health.svg)

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

###  Alternatives

[flyingluscas/viacep-php

ViaCEP PHP SDK

3640.6k](/packages/flyingluscas-viacep-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k38](/packages/neuron-core-neuron-ai)[spatie/laravel-export

Create a static site bundle from a Laravel app

674146.0k6](/packages/spatie-laravel-export)[oat-sa/tao-core

TAO core extension

66143.7k121](/packages/oat-sa-tao-core)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

252.5k](/packages/eslazarev-wildberries-sdk)

PHPackages © 2026

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