# Packages
# README
Go API client for fipe
API de Consulta Tabela FIPE fornece preços médios de veículos no mercado nacional. Atualizada mensalmente com dados extraidos da tabela FIPE.
Essa API Fipe utiliza banco de dados próprio, onde todas as requisições acontecem internamente, sem sobrecarregar o Web Service da Fipe, evitando assim bloqueios por múltiplos acessos.
A API está online desde 2015 e totalmente gratuíta. Gostaria que ele continuasse gratuíta? O que acha de me pagar uma cerveja? 🍺
Fipe API SDKs
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 2.0.0
- Package version: 2.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/deividfortuna/fipe
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import fipe "github.com/parallelum/fipe-go"
To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), fipe.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), fipe.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration.
An operation is uniquely identified by "{classname}Service.{nickname}" string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), fipe.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), fipe.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to https://parallelum.com.br/fipe/api/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| FipeApi | GetBrandsByType | Get /{vehicleType}/brands | Brands by type |
| FipeApi | GetFipeInfo | Get /{vehicleType}/brands/{brandId}/models/{modelId}/years/{yearId} | Fipe info |
| FipeApi | GetHistoryByFipeCode | Get /{vehicleType}/{fipeCode}/years/{yearId}/history | Fipe price history by Fipe code |
| FipeApi | GetInfoByFipeCode | Get /{vehicleType}/{fipeCode}/years/{yearId} | Fipe info by Fipe code |
| FipeApi | GetModelsByBrand | Get /{vehicleType}/brands/{brandId}/models | Models by brand |
| FipeApi | GetReferences | Get /references | Fipe month references |
| FipeApi | GetYearByModel | Get /{vehicleType}/brands/{brandId}/models/{modelId}/years | Years by model |
| FipeApi | GetYearsByFipeCode | Get /{vehicleType}/{fipeCode}/years | Years by Fipe code |
Documentation For Models
Documentation For Authorization
Endpoints do not require authorization.
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime