hubmais / h-brasilapi

1.0.0 2026-10-13 17:14 UTC

Requires

• php: ^7.2 || ^8.0
• guzzlehttp/guzzle: ^7.2

Requires (Dev)

• pestphp/pest: ^2.36

MIT

Published on Packagist.org on 2026-10-13 17:16 UTC

README

Este é um pacote que consome o endpoint da Brasil API e seus métodos para php e Laravel.

📦 Instalação

Requisitos:

• php (versão >=7.2)
• composer (mais recente)

O plugin pode ser adicionado a seu projeto com o comando abaixo:

composer require hubmais/h-brasilapi

Laravel

Esse plugin pode ser usado em Laravel, a partir da versão 10. Após a instalação é necessário executar o comando abaixo:

php artisan vendor:publish --provider="Hubmais\HBrasilApi\Providers\HBrasilApiServiceProvider"

🚀 Inicializando

Inicializando sem Facade

<?php

use Hubmais\HBrasilApi\Support\Client;
use Hubmais\HBrasilApi\HBrasilApi;

$HBrasilApi = new HBrasilApi(new Client('https://brasilapi.com.br/api'));

Usando por injeção de dependencias no Laravel

use Hubmais\HBrasilApi\HBrasilApi;

class ExampleController
{
    public function buscaCep(HBrasilApi $hBrasilApi)
    {
        return response()->json($hBrasilApi->geography()->postalCodeDetails(cep: '01431000'));
    }
}

Usando via Facades

use HBrasilApi;

HBrasilApi::geography()->postalCodeDetails('01431000');

📚 Exemplos

Os exemplos abaixo estão sendo apresentados via Facades no Laravel

Empresarial

Busca por CNPJ na API Minha Receita.

use HBrasilApi;

HBrasilApi::enterprise()->cnpj(cnpj: '19131243000197');

Busca e listagem completa de códigos NCM.

use HBrasilApi;

HBrasilApi::enterprise()->ncm();

Avalia o status de um dominio .br

use HBrasilApi;

HBrasilApi::enterprise()->registrobr(domain: 'brasilapi.com.br');

Financeiro

Lista e busca os bancos do Brasil

use HBrasilApi;

HBrasilApi::finance()->banks();

Lista todas as moedas disponíveis para consulta de câmbio.

use HBrasilApi;

HBrasilApi::finance()->currencies();

Busca pelo câmbio do Real com outra moeda, em uma data específica

use HBrasilApi;

HBrasilApi::finance()->currencyExhangeRate(
    currency: 'USD', 
    date: date('Y-m-d', strtotime('-7 days'))
);

Retorna as corretoras nos arquivos da CVM.

use HBrasilApi;

HBrasilApi::finance()->brokerageFirms();

Retorna lista de fundos de investimentos registrados na CVM.

use HBrasilApi;

HBrasilApi::finance()->funds();

Busca por detalhes de um registro de fundo na CVM.

use HBrasilApi;

HBrasilApi::finance()->fundDetails();

Retorna informações de todos os participantes do PIX no dia atual ou último dia útil.

use HBrasilApi;

HBrasilApi::finance()->pix();

Retorna as taxas de juros e alguns índices oficiais do Brasil

use HBrasilApi;

HBrasilApi::finance()->taxes();

Retorna a lista de tickers das empresas listadas na B3

use HBrasilApi;

HBrasilApi::finance()->tikers();

Retorna a lista de tickers de fundos de investimento listados na B3

use HBrasilApi;

HBrasilApi::finance()->tikersByType(typeFund: 'FII');

FIPE

Lista as marcas de veículos referente ao tipo de veículo

use HBrasilApi;

HBrasilApi::fipe()->vehicleMakers(vehicleType: 'carros');

Consulta o preço do veículo segundo a tabela FIPE.

use HBrasilApi;

HBrasilApi::fipe()->price(fipeCode: '001004-9');

Lista as tabelas de referência existentes.

use HBrasilApi;

HBrasilApi::fipe()->tableReferences();

Lista os veículos de acordo com a marca e o tipo de veículo

use HBrasilApi;

HBrasilApi::fipe()->vehicleTypes(
    vehicleType: 'carros', 
    makerCode: 123
);

Lista os anos e combustíveis disponíveis para um modelo de veículo específico

use HBrasilApi;

HBrasilApi::fipe()->vehicleYears(
    vehicleType: 'carros', 
    makerCode: 123,
    modelCode: 1
);

Consulta os dados completos de um veículo (preço e código FIPE) usando a hierarquia de navegação

use HBrasilApi;

HBrasilApi::fipe()->vehicleDetails(
    vehicleType: 'carros', 
    makerCode: 123,
    modelCode: 1,
    yearCode: '1998-1'
);

Lista as marcas de todos os tipos de veículo

use HBrasilApi;

HBrasilApi::fipe()->makers();

Geográfico

Busca por CEP com múltiplos providers de fallback.

use HBrasilApi;

HBrasilApi::geography()->postalCodeDetails(cep: '01431000');

Listar localidades

use HBrasilApi;

HBrasilApi::geography()->cities();

Condições atuais nas capitais

use HBrasilApi;

HBrasilApi::geography()->climaActual();

Previsão meteorológica para, até, 6 dias

use HBrasilApi;

HBrasilApi::geography()->climaPrevisionDay(cityCode: 4750);

Previsão meteorológica com base na latitude e longitude

use HBrasilApi;

HBrasilApi::geography()->climaPrevisionWeekly(
    lat: -21.166666, 
    long: -50.184665928
);

Previsão oceânica para, até, 6 dias

use HBrasilApi;

HBrasilApi::geography()->oceanPrevision(cityCode: 4750);

Retorna estado e lista de DDD

use HBrasilApi;

HBrasilApi::geography()->dddStates();

Retorna estado e lista de cidades

use HBrasilApi;

HBrasilApi::geography()->dddCities();

IBGE

Retorna os municípios da unidade federativa

use HBrasilApi;

HBrasilApi::ibge()->cities(uf: 'SP');

Retorna informações de todos estados do Brasil

use HBrasilApi;

HBrasilApi::ibge()->states();

Retorna as classes CNAE registradas no IBGE

use HBrasilApi;

HBrasilApi::ibge()->cnaeClasses();

Retorna as informações das regiões do Brasil

use HBrasilApi;

HBrasilApi::ibge()->regionCodes();

Busca as informações de uma região à partir da sigla ou código

use HBrasilApi;

HBrasilApi::ibge()->regions(regionCode: 3);

GERAL

Consulta de feriados nacionais brasileiros. Calcula automaticamente feriados móveis (como Páscoa, Carnaval) e inclui todos os feriados fixos estabelecidos pela legislação federal.

use HBrasilApi;

HBrasilApi::general()->holidays(ano: intVal(date('Y')));

Informações sobre o livro a partir do ISBN

use HBrasilApi;

HBrasilApi::general()->isbn(isbn: 9788545702870);

✅ Rodando os Testes

Para rodar o pacote de testes execute:

./vendor/bin/pest

📄 Licença

Este pacote é um software de código aberto licenciado sob a licença MIT.