Api documentation

Api documentation

Vehicle API

Vehicle API
 
 

Page Content


Overview

The Vehicle API is comprised of a collection of resources that provide access to an array of automotive datasets related directly to the automotive vehicle. First, you need to know the five components that fully describe an automotive vehicle:

Vehicle Make Vehicle Model Vehicle Model Year Vehicle Trim Vehicle Style

For example:

Honda Accord 2013 EX 2.4-liter 4-cylinder CVT Automatic w/Navigation

Would match to:

(Honda) (Accord) (2013) (EX) (2.4-liter 4-cylinder CVT Automatic w/Navigation)

(make) (model) (year) (trim) (style)

You will see many references throughout the documentation for vehicle (or car) Model Year ID and Style ID. Most of the endpoints offered throughout the API require one of these IDs. Getting familiar with them is essential to taking full advantage of the Edmunds API.

If you haven’t yet, this might be a good time to read the API Overview page to familiarize yourself with some of the core concepts required to use the API.

Back to top

Quick Start

Let’s get right to it, shall we? Here’s a few REST calls that should get you started using the API with ease. You could copy and paste these calls into your browser, add your API key to them and then press ENTER! Once you’re comfortable with these calls, you should think about downloading our Javascript SDK. It will make your development life with the Edmunds API even easier.

Example 1: Get a list of all car makes

https://api.edmunds.com/api/vehicle/v2/makes?fmt=json&api_key={your API key}

Example 2: Get a list of all new car makes

https://api.edmunds.com/api/vehicle/v2/makes?state=new&fmt=json&api_key={your API key}

Example 3: Get model, model year, style and trim data for Honda

https://api.edmunds.com/api/vehicle/v2/honda/models?fmt=json&api_key={your API key}

Example 4: Get model, model year, style and trim data for 2001 Honda

https://api.edmunds.com/api/vehicle/v2/honda/models?year=2001&fmt=json&api_key={your API key}

Example 5: Get the total number of all new Acura models in the Edmunds data

https://api.edmunds.com/api/vehicle/v2/acura/models/count?state=new&fmt=json&api_key={your API key}

Example 6: Get a list of styles for 2001 Honda Accord

https://api.edmunds.com/api/vehicle/v2/honda/accord/2001?fmt=json&api_key={your API key}

Example 7: Get a list of Maintenance Schedules for 2001 Honda Accord

https://api.edmunds.com/v1/api/maintenance/actionrepository/findbymodelyearid?modelyearid=100537293&fmt=json&api_key={your API key}

Example 8: Get the TMV® for 2001 Honda Accord EX 4dr Sedan (2.3L 4cyl 4A) w/ Outstanding condition and 25,000 miles in the 90069 area

https://api.edmunds.com/v1/api/tmv/tmvservice/calculateusedtmv?styleid=100001210&condition=Outstanding&mileage=25000&zip=90069&fmt=json&api_key={your API key}

Back to top

Static Datasets

Some of our datasets are static and don’t change often (if at all.) Here’s the most common static datasets you will need to make API calls and understand API response. More specific datasets (e.g. equipment types, option types, etc) are mentioned in the resources for which they’re relevant.

Vehicle Types        
• Car • Truck • SUV • Van • Minivan
Vehicle Categories (aka submodels)      
• 4dr Hatchback • 2dr Hatchback • 2dr SUV • 4dr SUV
• Cargo Minivan • Cargo Van • Convertible • Convertible SUV
• Coup • Crew Cab Pickup • Extended Cab Pickup • Passenger Minivan
• Passenger Van • Regular Cab Pickup • Sedan • Wagon
Vehicle Sizes    
• Compact • Midsize • Large
Fuel Types    
• Electric • Natural-gas-cng • gas
• hybrid • Flex-fuel-ffv • diesel
Driven Wheels  
• all-wheel-drive • four-wheel-drive
• front-wheel-drive • rear-wheel-drive

Back to top

API Uses

Here are some common uses of the Vehicle API:

  • Get all vehicle specs
  • Get all maintenance schedules for a particular car model year
  • Price out a used vehicle to determine the trade-in value
  • Determine the True Cost to Own® of a specific car style
  • Decode a VIN
  • Get consumer ratings and reviews

Back to top

Available Resources

Specification Service Pricing Review Media
Make Maintenance Schedule True Market Value® Edmunds Grade Ratings Vehicle Photos
Model Recalls True Cost to Own® Consumer Ratings and Reviews  
Model Year and trim        
Style        
Engine and Transmission        
Colors and Options        
Equipment        
VIN and SquishVin        

All of these resources are accessible in the table of contents on the left.

Back to top