Table of Contents
What is the Kelly Blue Book API and what does it do
The Kelly Blue Book API is a RESTful API that provides a simple interface to Kelly Blue Book data. The API allows developers to seamlessly integrate KBB data into their own applications and websites. The entire API is implemented in JSON, making it easy to read and interpret. There are no internal database structures to worry about; the data is just provided. All of the data relevant to a single vehicle or a set of vehicles is available in a single JSON response.
The API offers three major classes of information: Vehicles, Registrants, and Quotes. Each of these has its own paginated data which provides more detailed information on the corresponding class. Within each class, there are a number of fields that provide unique values of interest for various purposes.
Vehicles:
The vehicles object provides information on the vehicle in general. The object is paginated; all fields are included on a single page (the first page), but additional pages can be accessed for more results. The full list of fields includes the following:
How to use the KBB API to get car values
Use the KBB API to retrieve comprehensive pricing data for cars, trucks, and motorcycles in a customized format. When using the API to retrieve vehicle values, you can use multiple parameters to customize your results and get exactly what you need. You can also access the data through the KBB API Explorer.
What You’ll Need
Authorization credentials: Your user account on KBB.com and your API key.
Your user account on KBB.com and your API key. URL: The KBB URL to get the data you want. (For example, https://www.kbb.com/api/values?key=xxxxxxx.)
The KBB URL to get the data you want. (For example, https://www.kbb.com/api/values?key=xxxxxxx. JSON format data: The KBB API will return the data you requested in the JavaScript Object Notation (JSON) format.
The KBB API will return the data you requested in the JavaScript Object Notation (JSON) format. Data analysis software: To turn your JSON-formatted data into information that makes sense.
Step 1: Get a KBB API Key
The different functions of the KBB API
The KBB API has a number of functions that you can use to retrieve and format data according to your needs. Before making a request, ensure the parameters you will use are included. You can also get vehicle information through the KBB API Explorer, which provides features such as filters, sorting and pagination. A full list of parameters and example requests is available on the KBB API website.
To get vehicle information from the KBB API, use the following parameters.
Parameter Description REQUEST_KEY Returns a string representation of the request made. This is required for all requests. REQUEST_URI Returns the URL where the JSON or XML requests are sent. ACCESS_KEY Returns a string that represents the key used to authenticate to this API service. ACCESS_SECRET Returns a string that represents the secret used to authenticate to this API service. deviceTransforms This parameter is used to indicate whether you are accessing the API through a device.
1. GET_VEHICLE_HISTORIES /vehicle/history/:vehicleId(:[startDate],[endDate])
This function retrieves vehicle history (i.e. odometer readings and cost estimates) information for a specified vehicle.
Request Parameters:
Parameter Description vehicleId Vehicle ID, as specified in the API request. startDate Start date of the history. endDate End date of the history.
Default response format:
{ “vehicles”: [{ “id”: “Vehicle_ID”, “vehicleDetails”: { “startDate”: 1490358400000, //Optional. The start date for which mileage details are given }, }, …] }
Examples of how to use the KBB API in your own projects
Use the KBB API to retrieve pricing data for cars and trucks. The URL you request will contain the classification, keyword, make and model, and year parameters. The default format for data is JSON, but XML is also available. A full list of parameters is available at http://www.kbb.com/kbbauth/.
For example, to retrieve data for the Chrysler 300C (2008), you would initiate a GET request as follows:
http://www.kbb.com/kbbauth/?key=YOUR_API_KEY&carClass=300C&keyword=chrysler&make=chrysler&model=300c&year=2008
If you are interested in the auto industry, you may want to try out our Auto Industry API for more than just pricing data. You can find out more about this API here.
The data returned includes vehicle features, but will not include vehicle specific data like trim levels, colors and options.
