PHPackages                             corviz/brasilapi-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. [API Development](/categories/api)
4. /
5. corviz/brasilapi-php

ActiveLibrary[API Development](/categories/api)

corviz/brasilapi-php
====================

A PHP SDK for BrasilAPI

v1.1.1(2y ago)11421MITPHPPHP >=8.1

Since Feb 23Pushed 2y ago2 watchersCompare

[ Source](https://github.com/Corviz/brasilapi-php)[ Packagist](https://packagist.org/packages/corviz/brasilapi-php)[ RSS](/packages/corviz-brasilapi-php/feed)WikiDiscussions master Synced yesterday

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

BrasilApi PHP
=============

[](#brasilapi-php)

A PHP SDK for BrasilAPI project (PHP 8.1+)

Install with composer
---------------------

[](#install-with-composer)

```
composer require corviz/brasilapi-php

```

How to use
----------

[](#how-to-use)

- Every api segment (or sub-path) is represented by a class in this SDK. Eg:
    - `/banks/` -> `BanksApi`
    - `/cep/` -> `CepApi`
    - `/cnpj/` -> `CnpjApi`
    - And so on...
- Each api response is stored into a data transfer object (`BankData`, `CnpjData`, etc...)
- Every unsuccessful request will throw an `GuzzleException`
- All indexes have the same name as documented in the [official api docs](https://brasilapi.com.br/docs).
- Indexes that are composed by two or more words, are formatted as **lowerSnakeCase**

Environment variables
---------------------

[](#environment-variables)

`BRASILAPI_TIMEOUT` - maximum request time in seconds

`BRASILAPI_PROXY` - Proxy configuration for guzzle (ip)

Usage examples
--------------

[](#usage-examples)

### Example 1. Listing all banks:

[](#example-1-listing-all-banks)

```
use Corviz\BrasilAPI\BankApi;

$banks = BankApi::all();

foreach ($banks as $bank) {
    echo $bank->code, ' - ', $bank->name;
}
```

### Example 2. Show address data by CEP (ZIP code)

[](#example-2-show-address-data-by-cep-zip-code)

```
use Corviz\BrasilAPI\CepApi;

$address = CepApi::get('13087901');

echo $address->street; //Avenida Guilherme Campos
echo $address->neighborhood; //Jardim Santa Genebra
echo $address->city; //Campinas

//and so on...
```

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity56

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 ~97 days

Total

3

Last Release

1033d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5069326?v=4)[Carlos Alberto Bertholdo Carucce](/maintainers/carloscarucce)[@carloscarucce](https://github.com/carloscarucce)

---

Top Contributors

[![carloscarucce](https://avatars.githubusercontent.com/u/5069326?v=4)](https://github.com/carloscarucce "carloscarucce (36 commits)")

### Embed Badge

![Health badge](/badges/corviz-brasilapi-php/health.svg)

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

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.6M985](/packages/statamic-cms)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M47](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k38](/packages/neuron-core-neuron-ai)[avalara/avataxclient

Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API.

528.5M7](/packages/avalara-avataxclient)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)

PHPackages © 2026

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