\FipeApi

All URIs are relative to https://parallelum.com.br/fipe/api/v2

Method	HTTP request	Description
GetBrandsByType	Get /{vehicleType}/brands	Brands by type
GetFipeInfo	Get /{vehicleType}/brands/{brandId}/models/{modelId}/years/{yearId}	Fipe info
GetHistoryByFipeCode	Get /{vehicleType}/{fipeCode}/years/{yearId}/history	Fipe price history by Fipe code
GetInfoByFipeCode	Get /{vehicleType}/{fipeCode}/years/{yearId}	Fipe info by Fipe code
GetModelsByBrand	Get /{vehicleType}/brands/{brandId}/models	Models by brand
GetReferences	Get /references	Fipe month references
GetYearByModel	Get /{vehicleType}/brands/{brandId}/models/{modelId}/years	Years by model
GetYearsByFipeCode	Get /{vehicleType}/{fipeCode}/years	Years by Fipe code

GetBrandsByType

[]NamedCode GetBrandsByType(ctx, vehicleType).Execute()

Brands by type

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetBrandsByType(context.Background(), vehicleType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetBrandsByType``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetBrandsByType`: []NamedCode
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetBrandsByType`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle

Other Parameters

Other parameters are passed through a pointer to a apiGetBrandsByTypeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]NamedCode

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFipeInfo

FipeResult GetFipeInfo(ctx, vehicleType, brandId, modelId, yearId).Reference(reference).Execute()

Fipe info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle
    brandId := int32(59) // int32 | Brand of the vehicle
    modelId := int32(5940) // int32 | Model of the vehicle
    yearId := "2014-3" // string | Year for the vehicle
    reference := int32(278) // int32 | Month reference code (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetFipeInfo(context.Background(), vehicleType, brandId, modelId, yearId).Reference(reference).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetFipeInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetFipeInfo`: FipeResult
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetFipeInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle
brandId	int32	Brand of the vehicle
modelId	int32	Model of the vehicle
yearId	string	Year for the vehicle

Other Parameters

Other parameters are passed through a pointer to a apiGetFipeInfoRequest struct via the builder pattern

Name	Type	Description	Notes

reference | int32 | Month reference code |

Return type

FipeResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHistoryByFipeCode

FipeHistoryResult GetHistoryByFipeCode(ctx, vehicleType, fipeCode, yearId).Execute()

Fipe price history by Fipe code

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle
    fipeCode := "004278-1" // string | Fipe internal reference code
    yearId := "2005-1" // string | Year for the vehicle

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetHistoryByFipeCode(context.Background(), vehicleType, fipeCode, yearId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetHistoryByFipeCode``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetHistoryByFipeCode`: FipeHistoryResult
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetHistoryByFipeCode`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle
fipeCode	string	Fipe internal reference code
yearId	string	Year for the vehicle

Other Parameters

Other parameters are passed through a pointer to a apiGetHistoryByFipeCodeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

FipeHistoryResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInfoByFipeCode

FipeResult GetInfoByFipeCode(ctx, vehicleType, fipeCode, yearId).Execute()

Fipe info by Fipe code

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle
    fipeCode := "004278-1" // string | Fipe internal reference code
    yearId := "2005-1" // string | Year for the vehicle

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetInfoByFipeCode(context.Background(), vehicleType, fipeCode, yearId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetInfoByFipeCode``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInfoByFipeCode`: FipeResult
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetInfoByFipeCode`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle
fipeCode	string	Fipe internal reference code
yearId	string	Year for the vehicle

Other Parameters

Other parameters are passed through a pointer to a apiGetInfoByFipeCodeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

FipeResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetModelsByBrand

[]NamedCode GetModelsByBrand(ctx, vehicleType, brandId).Execute()

Models by brand

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle
    brandId := int32(59) // int32 | Brand of the vehicle

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetModelsByBrand(context.Background(), vehicleType, brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetModelsByBrand``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetModelsByBrand`: []NamedCode
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetModelsByBrand`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle
brandId	int32	Brand of the vehicle

Other Parameters

Other parameters are passed through a pointer to a apiGetModelsByBrandRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]NamedCode

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetReferences

[]Reference GetReferences(ctx).Execute()

Fipe month references

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetReferences(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetReferences``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetReferences`: []Reference
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetReferences`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetReferencesRequest struct via the builder pattern

Return type

[]Reference

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetYearByModel

[]NamedCode GetYearByModel(ctx, vehicleType, brandId, modelId).Execute()

Years by model

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle
    brandId := int32(59) // int32 | Brand of the vehicle
    modelId := int32(5940) // int32 | Model of the vehicle

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetYearByModel(context.Background(), vehicleType, brandId, modelId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetYearByModel``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetYearByModel`: []NamedCode
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetYearByModel`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle
brandId	int32	Brand of the vehicle
modelId	int32	Model of the vehicle

Other Parameters

Other parameters are passed through a pointer to a apiGetYearByModelRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]NamedCode

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetYearsByFipeCode

[]NamedCode GetYearsByFipeCode(ctx, vehicleType, fipeCode).Execute()

Years by Fipe code

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/parallelum/fipe-go"
)

func main() {
    vehicleType := openapiclient.VehiclesType("cars") // VehiclesType | Type of vehicle
    fipeCode := "004278-1" // string | Fipe internal reference code

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FipeApi.GetYearsByFipeCode(context.Background(), vehicleType, fipeCode).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FipeApi.GetYearsByFipeCode``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetYearsByFipeCode`: []NamedCode
    fmt.Fprintf(os.Stdout, "Response from `FipeApi.GetYearsByFipeCode`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
vehicleType	VehiclesType	Type of vehicle
fipeCode	string	Fipe internal reference code

Other Parameters

Other parameters are passed through a pointer to a apiGetYearsByFipeCodeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]NamedCode

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FipeApi.md

Latest commit

History

FipeApi.md

File metadata and controls

\FipeApi

GetBrandsByType

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetFipeInfo

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetHistoryByFipeCode

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetInfoByFipeCode

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetModelsByBrand

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetReferences

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetYearByModel

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetYearsByFipeCode

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers