https://github.com/juniorkrz/placa-fipe-api

Consultas FIPE pela placa do veículo
https://github.com/juniorkrz/placa-fipe-api

fastapi fipe fipe-api placa-de-carro

Last synced: about 2 months ago
JSON representation

Consultas FIPE pela placa do veículo

• Host: GitHub
• URL: https://github.com/juniorkrz/placa-fipe-api
• Owner: juniorkrz
• License: mit
• Created: 2023-06-30T16:32:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-05T04:17:22.000Z (6 months ago)
• Last Synced: 2024-10-14T08:08:31.913Z (2 months ago)
• Topics: fastapi, fipe, fipe-api, placa-de-carro
• Language: Python
• Homepage:
• Size: 27.3 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# placa-fipe-api

Consulta de veículos na tabela FIPE com base na placa do veículo.

## Obtenha um API Token em ScrapingAnt

Para usar a placa-fipe-api, é necessário um token de API do ScrapingAnt para contornar verificações anti-webscraping.

O ScrapingAnt fornece 1.000 consultas gratuitas por mês.

Você pode criar uma conta em [ScrapingAnt][scrapingant] e obter seu token API lá.

## Instalação das dependências

```

pip install -r requirements.txt

```

## Iniciar o servidor

```

uvicorn fipe.main:app --host 0.0.0.0 --port 8000

```

## Via Docker

```

docker run --name placa-fipe-api -e SA_TOKENS="token1,token2,token3" -p 8000:8000 juniorkrz/placa-fipe-api

```

Lembre-se de substituir `"token1,token2,token3"` pelos seus tokens reais, separados por vírgula. Você pode adicionar quantos tokens forem necessários.

## Descrição

Este projeto permite realizar consultas na FIPE utilizando a placa do veículo. Ele oferece as seguintes funcionalidades:

- Obter informações de um veículo específico com base na placa.

- Converter placas do antigo padrão para o padrão Mercosul e vice-versa.

- Verificar se uma placa é do padrão Mercosul ou não.

- Obter o nome de um estado brasileiro a partir de sua sigla.

## Endpoints

## /estado/{sigla}

Obtém o nome de um estado brasileiro com base na sigla informada.

## /consulta/{placa}

Realiza a consulta de um veículo com base na placa informada.

## /converter/{placa}

Converte a placa informada para o padrão Mercosul ou vice-versa.

## /mercosul/{placa}

Verifica se a placa informada é do padrão Mercosul.

## Autor

- [Antônio Roberto Júnior][krz]

## Licença

Este projeto está licenciado sob a [MIT License][license].

[krz]: https://github.com/juniorkrz

[license]: https://github.com/juniorkrz/placa-fipe-api/blob/master/LICENSE

[scrapingant]: https://scrapingant.com