Overview

This API enables the caller to obtain all of the information necessary to configure and price vehicles within the country or geography for which it is hosted.

From here you can get all kinds of characteristics and information of a vehicle.

Identifiers and all types of information that is required in most part of the methods are returned here.

And most importantly, get the values of the vehicle you want from the Price Advisor.

SecurityToken

• In order to use this API you must have a SecurityToken (all methods require it).
• If it wasn't provided you can get it by using the /Gps/Login method using your username/password.
• If you don't have either the Security Token or the username/password yet, please request it from your service provider contact.
• We recommend to save the security token in config file or cache as it will be the same for the following requests.

Some parameters are optional, and are used mostly to filter the output of the call.

All responses are wrapped in a JSON wrapper with a "ResponseStatus" value and the response itself.

ResponseStatus value equal than "1" it means that everything has gone well, but when it comes to another value it is because something is wrong.

All methods that recive "vehicleID" were modified to more accurately represent each specific country, this methods now allow the following parameters to return a single vehicle:

• Portugal: ExternalID + Year
• Brazil: ExternalID + Year
• UK: ExternalID + Year
• Australia: ExternalID + Year
• Canada: ExternalID + TransmissionTypeID + EngineID + DriveTrainID

Environments

API Production URL: https://api.kbb.com.au/

API Staging URL: https://api.stg.kbb.com.au/

Note: The Staging/Test environment mirrors the Production environment in both functionality and data returned.