What is API Console?

The API Console (aka I/O Docs) is an interactive tool that enables you to interact with the Edmunds API without writing a single line of code! Discover, learn, test and debug live API calls within seconds. For more details on authentication, method references and special requirements, please see the API Documentation section. You must be signed in before using this tool. If you already have an account, you can sign in, otherwise, please register now.

Compliance Notice

Please ensure you're in compliance with our Terms of Service and all API-specific Special Requirements (listed on each API's documentation page) before making any code or application that uses our API public. For more information, please email us at "api [at] edmunds.com"

Available APIs:

You can select the API you want to interact with from the drop-down menu below: Dealer API, Editorial API, Inventory API and Vehicle API.

Under each API, you will find a list of resources under which API methods exist. Resources are organized in a matter that makes sense to the end consumer of this API (i.e. the developer.)

For any questions or comments, please email us at "api [at] edmunds.com"

OAuth 2.0 Flow:

Existing Client Credentials:

API Key:

Shared Secret:

App/Key: Manually provide key information

Client ID:

Client Secret:

Client ID:

Client Secret:

Username:

Password:

Client ID:

Client Secret:

Authorization Code:

Access Token:

Username:

Password:

Dealer Details

List Methods

Expand Methods

GET Dealer Lookup /dealer

Find a dealerships associated with a given criteria like zipcode, Make or Style ID amongst other things.

Parameter	Type	Description
zipcode	integer	Five-digit zipcode
makeName	string	Vehicle make name
model	string	Vehicle model name
styleid	string	Vehicle style ID
radius	integer	The radius of the search (in miles)
fmt	enumerated	Response format
callback	string	The callback function that the JSON response will be wrapped in if desired

Dealer Ratings and Reviews

List Methods

Expand Methods

GET Get Content by Dealer ID /drrrepository/getdrrbydealerid

The Dealer Ratings and Reviews are submited by visitors to Edmunds.com. In order to get that content, you need to provide either the Dealer ID of the dealership on which you want to get data.

Parameter	Type	Description
dealerid	integer	The ID of the dealership. You can get that from the 'Dealer Lookup' method.
limit	string	query filter. limit=[index of review],[# of reviews]
fmt	enumerated	Response format
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Content by Zipcode and Vehicle Make /drrrepository/getdrrbyzipcodeandmake

The Dealer Ratings and Reviews are submited by visitors to Edmunds.com. In order to get that content, you need to provide the vehicle make and zipcode of the dealerships on which you want to get data.

Parameter	Type	Description
zipcode	integer	Five-digit zipcode
make	string	Vehicle make name
limit	string	query filter. limit=[index of review],[# of reviews]
fmt	enumerated	Response format
callback	string	The callback function that the JSON response will be wrapped in if desired

Editorial Content

List Methods

Expand Methods

GET Get Content /content/

Get articles and editorial content by category or vehicle name. You have to specify either a category OR a vehicle to get results. You also specify both if you want to narrow down the resultset.

Parameter	Type	Description
category	enumerated	The article category
make	string	Vehicle make name
model	string	Vehicle model name
year	integer	Vehicle year (YYYY)
limit	string	query filter. limit=[index of article],[# of articles]
fmt	enumerated	Response format
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Editor Reviews /content/editorreviews

Get the Editor Review for a vehicle. This includes all the itemized sections like pros, cons, what's new, ...etc.

Parameter	Type	Description
make	string	Vehicle make name
model	string	Vehicle model name
year	integer	Vehicle year (YYYY)
fmt	enumerated	Response format
callback	string	The callback function that the JSON response will be wrapped in if desired

Get Inventory Item by VIN

List Methods

Expand Methods

GET Inventory Lookup by VIN /v1/api/inventory/getinventorybyvin

Lookup an inventory item by VIN

Parameter	Type	Description
vin	integer	VIN (Vehicle Identification Number)
fmt	enumerated	Response format
callback	string	The callback function that the JSON response will be wrapped in if desired

Media: Vehicle Photo

List Methods

Expand Methods

GET Get by Vehicle Style ID /v1/api/vehiclephoto/service/findphotosbystyleid

Get vehicle photos by Edmunds vehicle style ID

Parameter	Type	Description
styleId	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Pricing: Edmunds True Cost to Own™

List Methods

Expand Methods

GET Calculate for New Vehicles /v1/api/tco/newtruecosttoownbystyleidandzip/:styleid/:zip

Get the total 5-year True Cost to Own for a new vehicle

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate for Used Vehicles /v1/api/tco/usedtruecosttoownbystyleidandzip/:styleid/:zip

Get the total 5-year True Cost to Own for a used vehicle

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate Total Cash Price for New Vehicle /v1/api/tco/newtotalcashpricebystyleidandzip/:styleid/:zip

The Total Cash Price displayed is the vehicle's True Market Value® price plus the Typically Equipped options, destination charge, base tax and fees assessed by your state, and, if applicable, gas guzzler tax; less any widely available manufacturer-to-customer cash rebates. (However, we do not account for other types of cash rebates or incentives because of the variability of those offers and their eligibility requirements.)

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate Total Cash Price for Used Vehicles /v1/api/tco/usedtotalcashpricebystyleidandzip/:styleid/:zip

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Vehicle Makes with TCO Data /v1/api/tco/getmakeswithtcodata

Get a list of vehicle makes with available True Cost to Own data

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Vehicle Models with TCO Data /v1/api/tco/getmodelswithtcodata

Get a list of vehicle models with available True Cost to Own data

Parameter	Type	Description
makeid	string	The Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Vehicle Styles with TCO Data /v1/api/tco/getstyleswithtcodatabysubmodel

Get a list of vehicle styles with available True Cost to Own data

Parameter	Type	Description
make	string	Vehicle make name
model	string	Vehicle model name
year	string	Vehicle year (YYYY)
submodel	string	Vehicle submodel
makeyear	string	The vehicle make year
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate Resale Value for a Used Vehicle /v1/api/tco/resalevaluesbystyleidandzip/:styleid/:zip

Get the resale value of a vehicle over the next 5 years

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate The Depreciation Value of a Used Vehicle /v1/api/tco/usedtotalcashpricebystyleidandzip/:styleid/:zip

Get the depreciation value in dollars over the next 5 years for a used vehicle

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate The Depreciation Value of a New Vehicle /v1/api/tco/newtotalcashpricebystyleidandzip/:styleid/:zip

Get the depreciation value in dollars over the next 5 years for a new vehicle

Parameter	Type	Description
:styleid	string	Vehicle style ID
:zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Pricing: Edmunds True Market Value™

List Methods

Expand Methods

GET Calculate for New Vehicle /api/v1/vehicle/:make/:year/price

Parameter	Type	Description
:make	string	Vehicle Make name
:year	string	Vehicle model four-digit year
msrp	string	Vehicle MSRP
zip	string	Five-digit zipcode
color	string	Vehicle color (i.e. black, white, blue, ..etc)
model	string	Vehicle Model name
vehicleStyle	string	Vehicle Style name
drivenWheels	string	Vehicle drive type name
fuelType	string	Name of the type of fuel the vehicle engine uses
cylinders	string	The number of cylinders the vehicle engine has
compressorType	string	The name of the aspiration of the vehicle engine
trim	string	Vehicle trim name
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate for Used Vehicles /v1/api/tmv/tmvservice/calculateusedtmv

Parameter	Type	Description
styleid	string	Vehicle style ID
condition	enumerated	Vehicle condition
mileage	string	Vehicle milage (e.g. 24000)
zip	string	Five-digit zipcode
colorid	string	Vehicle color ID (&colorid=xxx&colorid=xxx&colorid=xxx for multiples)
optionid	string	Vehicle option ID (&optionid=xxx&optionid=xxx&optionid=xxx for multiples)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate for the Typically Equipped Vehicle /v1/api/tmv/tmvservice/calculatetypicallyequippedusedtmv

Parameter	Type	Description
styleid	string	Vehicle style ID
zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Calculate for the Certified Vehicle /v1/api/tmv/tmvservice/findcertifiedpriceforstyle

Parameter	Type	Description
styleid	string	Vehicle style ID
zip	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET DEPRECATED (REMOVED ON 08/01/13): Calculate for New Vehicle /v1/api/tmv/tmvservice/calculatenewtmv

Parameter	Type	Description
styleid	string	Vehicle style ID
zip	string	Five-digit zipcode
colorid	string	Vehicle color ID (&colorid=xxx&colorid=xxx&colorid=xxx for multiples)
optionid	string	Vehicle option ID (&optionid=xxx&optionid=xxx&optionid=xxx for multiples)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Pricing: Incentives and Rebates

List Methods

Expand Methods

GET Get by ID /v1/api/incentive/incentiverepository/findbyid

Get incentives and rebates by ID

Parameter	Type	Description
id	string	Incentive ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Make ID /v1/api/incentive/incentiverepository/findincentivesbymakeid

Get incentives and rebates by vehicle make ID

Parameter	Type	Description
makeid	string	Vehicle make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Style ID /v1/api/incentive/incentiverepository/findincentivesbystyleid

Get incentives and rebates by vehicle style ID

Parameter	Type	Description
styleid	string	Vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Category and Zipcode /v1/api/incentive/incentiverepository/findincentivesbycategoryandzipcode

Get incentives and rebates by vehicle category and zipcode

Parameter	Type	Description
category	enumerated	Vehicle category
zipcode	string	Five-digit Zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Make ID and Zipcode /v1/api/incentive/incentiverepository/findincentivesbymakeidandzipcode

Get incentives and rebates by vehicle make ID and zipcode

Parameter	Type	Description
makeid	string	Vehicle make ID
zipcode	string	Five-digit Zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Model Year ID and Zipcode /v1/api/incentive/incentiverepository/findincentivesbymodelyearidandzipcode

Get incentives and rebates by vehicle model year ID and zipcode

Parameter	Type	Description
modelyearid	string	Vehicle model year ID
zipcode	string	Five-digit ZIP code
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Style ID and Zipcode /v1/api/incentive/incentiverepository/findincentivesbystyleidandzipcode

Get incentives and rebates by vehicle style ID and zipcode

Parameter	Type	Description
styleid	string	Vehicle style ID
zipcode	string	Five-digit Zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Reviews: UGC Vehicle Ratings and Reviews

List Methods

Expand Methods

GET Get by Vehicle Make/Model/Year /v1/api/crrrepository/getcrrformakemodelyear

Get vehicle ratings and reviews by providing vehicle make/model/year info

Parameter	Type	Description
make	string	Vehicle make ID
model	string	Vehicle model ID
year	string	Vehicle four-digit year
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Service: Vehicle Maintenance

List Methods

Expand Methods

GET Get by ID /v1/api/maintenance/action/:id

Get a specific maintenance schedule by ID

Parameter	Type	Description
:id	string	Vehicle maintenance action ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Model Year ID /v1/api/maintenance/actionrepository/findbymodelyearid

Get a specific maintenance schedule for a certain vehicle model year ID

Parameter	Type	Description
modelyearid	string	Vehicle model year ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Vehicle Model Years with Maintenance Schedules /v1/api/maintenance/actionrepository/findmodelyearidswithmaintenanceschedule

Get a list of all vehicle model years with a maintenace schedule

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

Service: Vehicle Recalls

List Methods

Expand Methods

GET Get by ID /v1/api/maintenance/recall/:id

Get a specific vehicle recall by ID

Parameter	Type	Description
:id	string	Vehicle recall ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Model Year ID /v1/api/maintenance/recallrepository/findbymodelyearid

Get a specific vehicle recall for a certain vehicle model year ID

Parameter	Type	Description
modelyearid	string	Vehicle model year ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Service: Vehicle Service Bulletin

List Methods

Expand Methods

GET Get by ID /v1/api/maintenance/servicebulletin/:id

Get a specific vehicle service bulletin by ID

Parameter	Type	Description
:id	string	Vehicle service bulletin ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get by Vehicle Model Year ID /v1/api/maintenance/servicebulletinrepository/findbymodelyearid

Get a specific vehicle service bulletin for a certain vehicle model year ID

Parameter	Type	Description
modelyearid	string	Vehicle model year ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Service: Vehicle Notes

List Methods

Expand Methods

GET Get by Vehicle Style ID /v1/api/maintenance/stylesnotes/:styleid

Get maintenance notes for a specific vehicle

Parameter	Type	Description
:styleid	string	Vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Service: Local Labor Rate

List Methods

Expand Methods

GET Get by Zipcode /v1/api/maintenance/ziplaborrate/:zipcode

Get service labor rates in dollars per hour for a zipcode

Parameter	Type	Description
:zipcode	string	Five-digit zipcode
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Specs: Vehicle Make

List Methods

Expand Methods

GET Get All Makes /v1/api/vehicle/makerepository/findall

Get a list of all new, used and future vehicle makes and links to their models.

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Make by ID /v1/api/vehicle/makerepository/findbyid

Get a vehicle make by its Edmunds Vehicle Make ID

Parameter	Type	Description
id	string	Edmunds Vehicle Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get All Future Makes /v1/api/vehicle/makerepository/findfuturemakes

Get a list of all future vehicle makes

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Make by Name /v1/api/vehicle/makerepository/findmakebyname

Get vehicle make details by its name

Parameter	Type	Description
name	string	The name of the vehicle make. Use the niceName value of the make (e.g. Aston Martin is aston-martin).
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Make by the Model Year ID /v1/api/vehicle/makerepository/findmakesbymodelyear

Get the vehicle make by providing the Model Year ID of the vehicle

Parameter	Type	Description
year	integer	The four-digit year of interest
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Makes by The Publication State (i.e. new, used or future) /v1/api/vehicle/makerepository/findmakesbypublicationstate

Get vehicle makes that live in a specific publication state

Parameter	Type	Description
state	enumerated	The vehicle publication state
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get New/Used Makes /v1/api/vehicle/makerepository/findnewandused

Get vehicle makes that have the publication state of 'new' and/or 'used'

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Find New/Used Makes by The Model Year ID /v1/api/vehicle/makerepository/findnewandusedmakesbymodelyear

Get vehicle make that has the publication state of 'new' and/or 'used' by the Model Year ID of that vehicle

Parameter	Type	Description
year	string	The four-digit year of interest
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get New Makes Only /v1/api/vehicle/makerepository/findnewmakes

Get vehicle makes that are listed as 'new' on Edmunds.com

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Used Makes Only /v1/api/vehicle/makerepository/findusedmakes

Get vehicle makes that are listed as 'used' on Edmunds.com

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

Specs: Vehicle Model

List Methods

Expand Methods

GET Get Model by ID /v1/api/vehicle/modelrepository/findbyid

Get a vehicle model by its Edmunds Vehicle Model ID

Parameter	Type	Description
id	string	Edmunds Vehicle Model ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Models by Make ID /v1/api/vehicle/modelrepository/findbymakeid

Get a list of vehicle models by vehicle make ID

Parameter	Type	Description
makeid	string	Edmunds Vehicle Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Future Models by Make ID /v1/api/vehicle/modelrepository/findfuturemodelsbymakeid

Get vehicle make details by its name

Parameter	Type	Description
makeid	string	Edmunds Vehicle Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Models by Vehicle Make and Model Name /v1/api/vehicle/modelrepository/findmodelbymakemodelname

Get vehicle model details by providing vehicle make and model names

Parameter	Type	Description
make	string	Vehicle make name
model	string	Vehicle model name
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Models by Vehicle Make Name /v1/api/vehicle/modelrepository/findmodelsbymake

Get vehicle model details by vehicle make name

Parameter	Type	Description
make	string	Vehicle make name
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Models by Vehicle Make Name and Publication State /v1/api/vehicle/modelrepository/findmodelsbymakeandpublicationstate

Get vehicle models by vehicle make name and publication state

Parameter	Type	Description
make	string	Vehicle make name
state	enumerated	The vehicle publication state
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Models by Vehicle Make and Year /v1/api/vehicle/modelrepository/findmodelsbymakeandyear

Get vehicle model details by providing vehicle make and year

Parameter	Type	Description
make	string	Vehicle make name
year	integer	Vehicle Year (YYYY)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get New/Used Models by Make ID /v1/api/vehicle/modelrepository/findnewandusedmodelsbymakeid

Get a list of new/used vehicle models by vehicle make ID

Parameter	Type	Description
makeId	string	Edmunds Vehicle Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get New Models by Make ID /v1/api/vehicle/modelrepository/findnewmodelsbymakeid

Get a list of new vehicle models by vehicle make ID

Parameter	Type	Description
makeId	string	Edmunds Vehicle Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Used Models by Make ID /v1/api/vehicle/modelrepository/findusedmodelsbymakeid

Get a list of used vehicle models by vehicle make ID

Parameter	Type	Description
makeId	string	Edmunds Vehicle Make ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Specs: Vehicle Model/Year

List Methods

Expand Methods

GET Get Model Year by ID /v1/api/vehicle/modelyearrepository/findbyid

Get a model year vehicle's details by providing its ID

Parameter	Type	Description
id	string	The Model Year ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Model Years for Vehicle Make/Model/Year /v1/api/vehicle/modelyearrepository/foryearmakemodel

Get a list of all Make Models by Vehicle Make/Model/Year

Parameter	Type	Description
make	string	Vehicle make name (use niceName value).
model	string	Vehicle model name (use niceName value).
year	string	Vehicle year (YYYY)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Model Years by Vehicle Make and Year /v1/api/vehicle/modelyearrepository/findmodelyearsbymakeandyear

Get a list of all Model Years by Vehicle Make name and Vehicle Year

Parameter	Type	Description
make	string	Vehicle make name (use niceName value)
year	string	Vehicle year (YYYY)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Model Years by Vehicle Make and Model /v1/api/vehicle/modelyearrepository/findmodelyearsbymakemodel

Get a list of all Model Years by Vehicle Make and Model names

Parameter	Type	Description
make	string	Vehicle make name (use niceName value)
model	string	Vehicle model name (use niceName value)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get New/Used Model Years by Vehicle Make ID and Year /v1/api/vehicle/modelyearrepository/findnewandusedmodelyearsbymakeidandyear

Get a list of all new/used Model Years by vehicle make ID and vehicle year

Parameter	Type	Description
makeid	string	Vehicle Make ID
year	string	Vehicle Year (YYYY)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Model Years from Vehicle Model ID /v1/api/vehicle/modelyearrepository/formodelid

Get list of Model Years from vehicle model ID

Parameter	Type	Description
modelid	string	Vehicle model ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get New Model Years by Vehicle Model ID /v1/api/vehicle/modelyearrepository/findnewmodelyearsbymodelid

Get a list of all new Model Years that fall under the givien vehicle model ID

Parameter	Type	Description
modelId	string	Vehicle model ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Used Model Years by Vehicle Model ID /v1/api/vehicle/modelyearrepository/findusedmodelyearsbymodelid

Get a list of all used Model Years that fall under the givien vehicle model ID

Parameter	Type	Description
modelId	string	Vehicle model ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Future Model Years by Vehicle Model ID /v1/api/vehicle/modelyearrepository/findfuturemodelyearsbymodelid

Get a list of all future Model Years that fall under the givien vehicle model ID

Parameter	Type	Description
modelId	string	Vehicle model ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Model Years by Vehicle Category and Publication State /v1/api/vehicle/modelyearrepository/findyearsbycategoryandpublicationstate

Get list of all Model Years that belong to the specified vehicle category and publication state

Parameter	Type	Description
category	enumerated	Vehicle category (e.g. sedan, suv, ...etc)
state	enumerated	Vehicle publication state (e.g. new, used, future)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Years of New Vehicles /v1/api/vehicle/modelyearrepository/finddistinctyearwithnew

Get a list of years under which vehicles are listed as 'NEW'

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Years of New/Used Vehicles /v1/api/vehicle/modelyearrepository/finddistinctyearwithneworused

Get a list of years under which vehicles are listed as 'NEW' or 'USED'

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Years of Used Vehicles /v1/api/vehicle/modelyearrepository/finddistinctyearwithused

Get a list of years under which vehicles are listed as 'USED'

Parameter	Value	Type	Description
fmt		enumerated	Response format (json only)
callback		string	The callback function that the JSON response will be wrapped in if desired

Specs: Vehicle Style & Trim

List Methods

Expand Methods

GET Get Style by ID /v1/api/vehicle/stylerepository/findbyid

Get vehicle style details by Edmunds vehicle style ID

Parameter	Type	Description
id	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Style by Vehicle Make/Model/Year /v1/api/vehicle/stylerepository/findstylesbymakemodelyear

Get vehicle style details by vehicle make and model names and year

Parameter	Type	Description
make	string	Vehicle make name
model	string	Vehicle model name
year	string	Vehicle four-digit year
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Style by Vehicle Model Year ID /v1/api/vehicle/stylerepository/findstylesbymodelyearid

Get vehicle style details by Edmunds vehicle model year ID

Parameter	Type	Description
modelyearid	string	Vehicle Model Year ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Style Value by Style IDs /v1/api/vehicle/stylerepository/findstylesbystyleids

Get vehicle trims by Edmunds vehicle style IDs

Parameter	Type	Description
styleids	string	Edmunds vehicle style IDs (separated by comma)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Trim Value by Style IDs /v1/api/vehicle/stylerepository/findtrimsbystyleids

Get vehicle trims by Edmunds vehicle style IDs

Parameter	Type	Description
styleids	string	Edmunds vehicle style IDs (separated by comma)
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Specs: Vehicle Engine & Transmission

List Methods

Expand Methods

GET Get Engine Details by Style ID /v1/api/vehicle/equipmentrepository/findenginesbystyleid

Get vehicle engine details by Edmunds vehicle style ID

Parameter	Type	Description
styleid	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Transmission Details by Style ID /v1/api/vehicle/equipmentrepository/findtransmissionsbystyleid

Get vehicle transmission details by Edmunds vehicle style ID

Parameter	Type	Description
styleid	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Specs: Vehicle Configuration

List Methods

Expand Methods

GET Get the default configured vehicle by zipcode and style ID /v1/api/configurator/default

Get vehicle style details by VIN

Parameter	Type	Description
zip	string	Zipcode
styleid	string	Vehicle Style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get the configured vehicle with options /v1/api/configurator/withOptions

Get vehicle style details by VIN

Parameter	Type	Description
zip	string	Zipcode
styleid	string	Vehicle Style ID
optionid	string	Vehicle Option ID
selected	string	Vehicle Option ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Options by Vehicle Style ID /v1/api/vehicle-directory-ajax/vehicle-options/options

Get available vehicle options by vehicle style ID

Parameter	Type	Description
styleId	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Colors by Vehicle Style ID /v1/api/vehicle-directory-ajax/vehicle-options/colors

Get available vehicle colors by vehicle style ID

Parameter	Type	Description
styleId	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Equipment by Vehicle Model Year ID and Equipment Type /v1/api/vehicle/equipmentrepository/findbytypeandmodelyearid

Get available new vehicle options by vehicle style ID (enclosed under usedEquipment object)

Parameter	Type	Description
type	enumerated	Vehicle equipment type
modelyearid	string	Vehicle model year ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Equipment by Equipment ID /v1/api/vehicle/equipment/:equipmentId

Get vehicle equipment by equipment ID

Parameter	Type	Description
:equipmentId	string	Equipment ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET DEPRECATED (REMOVED ON 08/01/13): Get Configuration of a New Vehicle by Vehicle Style ID /v1/api/vehicle/styleconfig/:styleId

Get available new vehicle options by vehicle style ID (enclosed under FeaturesMap object)

Parameter	Type	Description
:styleId	string	Edmunds vehicle style ID
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET DEPRECATED (REMOVED ON 08/01/13): Get Configuration of a Used Vehicle by Vehicle Style ID /v1/api/vehicle/style/:styleId

Get available new vehicle options by vehicle style ID (enclosed under usedEquipment object)

Parameter	Type	Description
:styleId	string	Edmunds vehicle style ID
fmt	enumerated	Detailed Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

Tools: VIN Decoding and Pricing

List Methods

Expand Methods

GET Get Basic Vehicle Information by VIN /api/v1/vehicle/vin/:vin/configuration

Get vehicle make, model, year, type, fuel type, number of cylinders and list of styles by decoding the vehicle's VIN

Parameter	Value	Type	Description
:vin		string	Vehicle VIN
callback		string	The callback function that the JSON response will be wrapped in if desired

GET Get Full Vehicle Details by VIN /v1/api/toolsrepository/vindecoder

Get all vehicle details from make, model, year and fuel type to list of options, features and standard equipment. All this information is returned by decoding the vehicle's VIN

Parameter	Type	Description
vin	string	Vehicle VIN
fmt	enumerated	Response format (json only)
callback	string	The callback function that the JSON response will be wrapped in if desired

GET Get Basic Vehicle Information and Pricing for NEW VEHICLES ONLY by VIN, Zipcode and MSRP /api/v1/vehicle/vin/:vin/price

Get basic vehicle information and pricing by supplying the vehicle's VIN, MSRP price and the zipcode in which it's located

Parameter	Type	Description
:vin	string	Vehicle VIN
zip	string	Five-digit zipcode
msrp	string	Vehicle MSRP
color	string	Vehicle color (i.e. black, white, blue, ...etc)
callback	string	The callback function that the JSON response will be wrapped in if desired

What is API Console?

Compliance Notice

Available APIs:

Select an API Dealer API Editorial API Inventory API Vehicle API

Dealer Details List Methods Expand Methods

Dealer Ratings and Reviews List Methods Expand Methods

Editorial Content List Methods Expand Methods

Get Inventory Item by VIN List Methods Expand Methods

Media: Vehicle Photo List Methods Expand Methods

Pricing: Edmunds True Cost to Own™ List Methods Expand Methods

Pricing: Edmunds True Market Value™ List Methods Expand Methods

Pricing: Incentives and Rebates List Methods Expand Methods

Reviews: UGC Vehicle Ratings and Reviews List Methods Expand Methods

Service: Vehicle Maintenance List Methods Expand Methods

Service: Vehicle Recalls List Methods Expand Methods

Service: Vehicle Service Bulletin List Methods Expand Methods

Service: Vehicle Notes List Methods Expand Methods

Service: Local Labor Rate List Methods Expand Methods

Specs: Vehicle Make List Methods Expand Methods

Specs: Vehicle Model List Methods Expand Methods

Specs: Vehicle Model/Year List Methods Expand Methods

Specs: Vehicle Style & Trim List Methods Expand Methods

Specs: Vehicle Engine & Transmission List Methods Expand Methods

Specs: Vehicle Configuration List Methods Expand Methods

Tools: VIN Decoding and Pricing List Methods Expand Methods

Dealer Details

List Methods

Expand Methods

Dealer Ratings and Reviews

List Methods

Expand Methods

Editorial Content

List Methods

Expand Methods

Get Inventory Item by VIN

List Methods

Expand Methods

Media: Vehicle Photo

List Methods

Expand Methods

Pricing: Edmunds True Cost to Own™

List Methods

Expand Methods

Pricing: Edmunds True Market Value™

List Methods

Expand Methods

Pricing: Incentives and Rebates

List Methods

Expand Methods

Reviews: UGC Vehicle Ratings and Reviews

List Methods

Expand Methods

Service: Vehicle Maintenance

List Methods

Expand Methods

Service: Vehicle Recalls

List Methods

Expand Methods

Service: Vehicle Service Bulletin

List Methods

Expand Methods

Service: Vehicle Notes

List Methods

Expand Methods

Service: Local Labor Rate

List Methods

Expand Methods

Specs: Vehicle Make

List Methods

Expand Methods

Specs: Vehicle Model

List Methods

Expand Methods

Specs: Vehicle Model/Year

List Methods

Expand Methods

Specs: Vehicle Style & Trim

List Methods

Expand Methods

Specs: Vehicle Engine & Transmission

List Methods

Expand Methods

Specs: Vehicle Configuration

List Methods

Expand Methods

Tools: VIN Decoding and Pricing

List Methods

Expand Methods