PHPackages                             hertzogjr/fipe-php-sdk - 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. hertzogjr/fipe-php-sdk

ActiveLibrary

hertzogjr/fipe-php-sdk
======================

An unofficial fipe api sdk.

v1.0.0(1w ago)02↓100%MITPHPPHP ^8.4CI passing

Since Mar 14Pushed 1w agoCompare

[ Source](https://github.com/Hertzogjr/fipe-php-sdk)[ Packagist](https://packagist.org/packages/hertzogjr/fipe-php-sdk)[ RSS](/packages/hertzogjr-fipe-php-sdk/feed)WikiDiscussions main Synced today

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

FIPE PHP SDK
============

[](#fipe-php-sdk)

SDK não oficial para a [API FIPE](https://veiculos.fipe.org.br/api/veiculos/), que fornece a tabela de preços de referência de veículos do mercado brasileiro.

Considerações importantes
-------------------------

[](#considerações-importantes)

> **A FIPE não disponibiliza uma API pública oficial.** O endpoint utilizado por este SDK é o mesmo consumido pelo site da FIPE internamente, sem qualquer garantia de estabilidade, autenticação ou termos de uso formais. Utilize com responsabilidade.

- **Limite de requisições:** O servidor da FIPE bloqueia IPs que realizam muitas requisições em um curto período de tempo. Se você pretende fazer um volume grande de consultas, considere implementar um proxy ou cache para distribuir e reduzir as chamadas.
- **Sem SLA:** Como não é uma API pública, a FIPE pode alterar ou remover os endpoints a qualquer momento sem aviso prévio.

Requisitos
----------

[](#requisitos)

- PHP 8.4+
- Composer

Instalação
----------

[](#instalação)

```
composer require hertzogjr/fipe-php-sdk
```

Uso
---

[](#uso)

Todos os recursos são acessados através do `FipeClient`:

```
use Hertzogjr\\FipePhpSdk\FipeClient;

$client = new FipeClient();
```

---

### Tabelas de Referência

[](#tabelas-de-referência)

Retorna todas as tabelas de referência mensais disponíveis na API FIPE.

```
$result = $client->referenceTable()->all();

// $result['data'] → FipeReferenceTableEntity[]
foreach ($result['data'] as $table) {
    echo $table->code;  // ex: "319"
    echo $table->month; // ex: "janeiro/2025"
}
```

---

### Marcas

[](#marcas)

Retorna as marcas disponíveis para um tipo de veículo e tabela de referência.

```
use Hertzogjr\\FipePhpSdk\Make\DTOs\MakesByVehicleTypeDTO;
use Hertzogjr\\FipePhpSdk\Vehicle\Enums\FipeVehicleTypeEnum;

$result = $client->make()->byVehicleType(
    new MakesByVehicleTypeDTO(
        fipeVehicleType: FipeVehicleTypeEnum::CAR,
        referenceTableCode: '319',
    )
);

// $result['data'] → FipeMakeEntity[]
foreach ($result['data'] as $make) {
    echo $make->label; // ex: "Fiat"
    echo $make->value; // ex: "21" (código da marca)
}
```

**Tipos de veículo disponíveis:**

EnumDescrição`FipeVehicleTypeEnum::CAR`Carro`FipeVehicleTypeEnum::MOTORCYCLE`Moto`FipeVehicleTypeEnum::TRUCK`Caminhão---

### Modelos

[](#modelos)

#### Todos os modelos de uma marca

[](#todos-os-modelos-de-uma-marca)

Retorna os modelos e os anos disponíveis para uma marca.

```
use Hertzogjr\\FipePhpSdk\Model\DTOs\ModelsByMakePayloadDTO;

$result = $client->model()->all(
    new ModelsByMakePayloadDTO(
        makeCode: '21',
        referenceCode: '319',
        vehicleType: FipeVehicleTypeEnum::CAR,
    )
);

// $result['data']['Modelos'] → FipeModelEntity[]
// $result['data']['Anos']    → FipeYearEntity[]
foreach ($result['data']['Modelos'] as $model) {
    echo $model->label; // ex: "Uno"
    echo $model->value; // ex: "5941"
}
```

#### Anos de um modelo

[](#anos-de-um-modelo)

Retorna os anos disponíveis para um modelo específico.

```
use Hertzogjr\\FipePhpSdk\Model\DTOs\ModelYearsPayloadDTO;

$result = $client->model()->years(
    new ModelYearsPayloadDTO(
        makeCode: '21',
        referenceCode: '319',
        vehicleType: FipeVehicleTypeEnum::CAR,
        modelCode: '5941',
    )
);

// $result['data'] → FipeYearEntity[]
foreach ($result['data'] as $year) {
    echo $year->label; // ex: "2021 Gasolina"
    echo $year->value; // ex: "2021-1" (anoModelo-codigoCombustivel)
}
```

#### Modelos por ano

[](#modelos-por-ano)

Retorna os modelos de uma marca filtrados por um ano e tipo de combustível específicos.

```
use Hertzogjr\\FipePhpSdk\Model\DTOs\ModelsByYearPayloadDTO;

$result = $client->model()->byYear(
    new ModelsByYearPayloadDTO(
        makeCode: '21',
        referenceCode: '319',
        vehicleType: FipeVehicleTypeEnum::CAR,
        yearCode: '2021-1', // formato: "anoModelo-codigoCombustivel"
    )
);

// $result['data'] → FipeModelEntity[]
```

---

### Veículo

[](#veículo)

Retorna os dados completos de precificação FIPE para um veículo específico.

```
use Hertzogjr\\FipePhpSdk\Vehicle\DTOs\VehiclePayloadDTO;

$result = $client->vehicle()->get(
    new VehiclePayloadDTO(
        referenceCode: '319',
        makeCode: '21',
        modelCode: '5941',
        vehicleType: FipeVehicleTypeEnum::CAR,
        yearCode: '2021-1', // formato: "anoModelo-codigoCombustivel"
    )
);

// $result['data'] → FipeVehicleEntity
$vehicle = $result['data'];
echo $vehicle->make;             // ex: "Fiat"
echo $vehicle->model;            // ex: "Uno"
echo $vehicle->modelYear;        // ex: 2021
echo $vehicle->value;            // ex: "R$ 45.123,00"
echo $vehicle->fipeCode;         // ex: "021004-9"
echo $vehicle->fuel;             // ex: "Gasolina"
echo $vehicle->fuelAbbreviation; // ex: "G"
echo $vehicle->referenceMonth;   // ex: "janeiro/2025"
echo $vehicle->consultationDate; // ex: "segunda-feira, 13 de janeiro de 2025 12:34:56"
```

---

### Tratamento de Exceções

[](#tratamento-de-exceções)

Cada domínio possui sua própria exception com construtores nomeados:

```
use Hertzogjr\\FipePhpSdk\ReferenceTable\FipeReferenceTableException;
use Hertzogjr\\FipePhpSdk\Make\FipeMakeException;
use Hertzogjr\\FipePhpSdk\Model\FipeModelException;
use Hertzogjr\\FipePhpSdk\Vehicle\FipeVehicleException;

try {
    $result = $client->vehicle()->get($payload);
} catch (FipeVehicleException $e) {
    // Lançado em falha de conexão, parâmetros inválidos ou veículo não encontrado
    echo $e->getMessage();
}
```

---

Desenvolvimento
---------------

[](#desenvolvimento)

```
composer install       # Instalar dependências
composer run test      # Executar testes com Pest
composer run format    # Formatar código com Laravel Pint
```

Contribuições
-------------

[](#contribuições)

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues, sugerir melhorias ou enviar pull requests.

Licença
-------

[](#licença)

MIT

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance98

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity50

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

Unknown

Total

1

Last Release

9d ago

### Community

Maintainers

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

---

Top Contributors

[![Hertzogjr](https://avatars.githubusercontent.com/u/88346377?v=4)](https://github.com/Hertzogjr "Hertzogjr (1 commits)")

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/hertzogjr-fipe-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/hertzogjr-fipe-php-sdk/health.svg)](https://phpackages.com/packages/hertzogjr-fipe-php-sdk)
```

PHPackages © 2026

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