API Console

• Dealership Details

  • List Methods
  • Expand Methods

  • GET Get dealer by ID /api/dealer/v2/dealers/:id

    Find a rooftop dealerships and its details, including franchises and repairshops.

    Parameter	Value	Type	Description
    :id		integer	Dealer ID
    view	basic full	enumerated	The response payload
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Search for a dealership /api/dealer/v2/dealers/

    Find dealerships based on specific set of parameters.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zip code
    radius		integer	The radius of search area
    make		string	The vehicle make nicename
    state	new used	enumerated	The types of vehicles this dealership sells
    pageNum		integer	The page number of results
    pageSize		integer	The page size of results (i.e. how many results per page to show)
    sortby	distance:ASC distance:DESC name:ASC name:DESC	enumerated	The sorting strategy for the results
    keyword		string	Comma-separated list of keywords
    view	basic full	enumerated	The response payload
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get dealership count /api/dealer/v2/dealers/count

    Get the number of dealerships based on specific set of parameters.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zip code
    radius		integer	The radius of search area
    make		string	The vehicle make nicename
    state	new used	enumerated	The types of vehicles this dealership sells
    keyword		string	Comma-separated list of keywords
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Franchise Details

  • List Methods
  • Expand Methods

  • GET Get franchise by ID /api/dealer/v2/franchises/:id

    Get a dealership franchise details.

    Parameter	Value	Type	Description
    :id		integer	Franchise ID
    view	basic full	enumerated	The response payload
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Search for a franchise /api/dealer/v2/franchises/

    Find dealership franchises based on specific set of parameters.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zip code
    radius		integer	The radius of search area
    make		string	The vehicle make nicename
    state	new used	enumerated	The types of vehicles this dealership sells
    pageNum		integer	The page number of results
    pageSize		integer	The page size of results (i.e. how many results per page to show)
    sortby	distance:ASC distance:DESC name:ASC name:DESC	enumerated	The sorting strategy for the results
    keyword		string	Comma-separated list of keywords
    view	basic full	enumerated	The response payload
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get franchise count /api/dealer/v2/franchises/count

    Get the number of franchises based on specific set of parameters.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zip code
    radius		integer	The radius of search area
    make		string	The vehicle make nicename
    state	new used	enumerated	The types of vehicles this dealership sells
    keyword		string	Comma-separated list of keywords
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Repairshop Details

  • List Methods
  • Expand Methods

  • GET Get repairshop by ID /api/dealer/v2/repairshops/:id

    Get a dealership repairshop details.

    Parameter	Value	Type	Description
    :id		integer	Repairshop ID
    view	basic full	enumerated	The response payload
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Search for a repairshop /api/dealer/v2/repairshops/

    Find dealership repairshops based on specific set of parameters.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zip code
    radius		integer	The radius of search area
    make		string	The vehicle make nicename
    pageNum		integer	The page number of results
    pageSize		integer	The page size of results (i.e. how many results per page to show)
    sortby	distance:ASC distance:DESC name:ASC name:DESC	enumerated	The sorting strategy for the results
    keyword		string	Comma-separated list of keywords
    view	basic full	enumerated	The response payload
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get repairshops count /api/dealer/v2/repairshops/count

    Get the number of repairshops based on specific set of parameters.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zip code
    radius		integer	The radius of search area
    make		string	The vehicle make nicename
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Dealership Ratings and Reviews

  • List Methods
  • Expand Methods

  • GET Get Content by Dealer ID /v1/api/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	Value	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	json	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 /v1/api/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	Value	Type	Description
    zipcode		integer	Five-digit zipcode
    make		string	Vehicle make nicename
    limit		string	query filter. limit=[index of review],[# of reviews]
    fmt	json	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 /v1/content/

    Get articles and editorial content by an article category OR a vehicle's make and model niceNames. You have to specify either a category OR a vehicle to get results. You also specify both if you want to narrow down the result set.

    Parameter	Value	Type	Description
    category	auto finance awards best cars lists car news car buying car leasing car technology driving editor reviews extended warranties fuel economy how-to advice insurance maintenance & repair road tests selling top 10 lists vehicle safety warranties	enumerated	The article category
    make		string	Vehicle make nicename
    model		string	Vehicle model nicename
    year		integer	Vehicle year (YYYY)
    limit		string	query filter. limit=[index of article],[# of articles]
    fmt	json xml	enumerated	Response format (json OR xml)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Editor Reviews /v1/content/editorreviews

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

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

  • GET Get Make overview /api/editorial/v2/:makeNiceName

    Get the Editorial content for the given make similar with website page: http://www.edmunds.com/{make}

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Model overview /api/editorial/v2/:makeNiceName/:modelNiceName

    Get the Editorial content for the given make/model similar with website: http://www.edmunds.com/{make}/{model}

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Model/Year overview /api/editorial/v2/:makeNiceName/:modelNiceName/:year

    Get the Editorial content for the given make/model/year similar with website: http://www.edmunds.com/{make}/{model}/{year}

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    :year		integer	Vehicle four-digit year
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Road test articles for Make/Model/Year /api/editorial/v2/:makeNiceName/:modelNiceName/:year/roadtests

    Get the Road test articles content for the given make/model/year similar with website

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    :year		integer	Vehicle four-digit year
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get articles by tags or Make/Model/Year /api/editorial/v2/articles

    Get the articles content for the given tags or make/model/year

    Parameter	Value	Type	Description
    tag	coupe hatchback mini minivan pickup sedan suv truck wagon autoshow awards car-buying car-news comparison-tests diesel editor-reviews features hydrogen long-term-road-tests maintenance road-tests safety top-10-lists vehicle-debuts	enumerated	Tags of the articles. Required if make or year parameters are not specified
    make		string	Vehicle make niceName. Required if tag or year parameters are not specified or model parameter is specified
    model		string	Vehicle model niceName
    year		integer	Vehicle four-digit year. Required if make or tag parameters are not specified
    pagenum		integer	Pagination starting index
    pagesize		integer	Pagination response size. The max value is 50
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Search Inventory Listings

  • List Methods
  • Expand Methods

  • GET Get Inventory Listings by Franchise ID (Legacy) /api/inventory/v1/getall

    Lookup a inventory at a particular dealer franchise

    Parameter	Value	Type	Description
    dealerId		string	The dealership Franchise ID
    types	USED NEW CPO ALL	enumerated	The type of inventory
    sort		string	The desired sort (i.e. price:asc)
    basicFilter		string	Narrow down response by key:�value�
    pageNumber		string	Pagination starting index
    pageSize		string	Pagination response size
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Inventory Listings by Zipcode (Legacy) /api/inventory/v1/getall

    Lookup inventory listings by Zip Code

    Parameter	Value	Type	Description
    zipcode		string	The zipcode for the area where to search
    range		string	Radius of search
    make		string	Car make name (case sensitive). (required if dealer ID is not supplied)
    model		string	Car model name (case sensitive). (required if make is supplied)
    submodel		string	Car submodel name (case sensitive). (required if make is supplied)
    dealerId		string	The dealership ID
    types	USED NEW CPO ALL	enumerated	The type of inventory
    sort		string	The desired sort (i.e. price:asc)
    basicFilter		string	Narrow down response by key:�value�
    pageNumber		string	Pagination starting index
    pageSize		string	Pagination response size
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Inventory Listings by Franchise ID /api/inventory/v2/franchises/:franchiseId

    Lookup a inventory at a particular dealer franchise

    Parameter	Value	Type	Description
    :franchiseId		string	The dealership Franchise ID
    type	used new cpo	enumerated	The type of inventory
    intcolor	black blue brown cream gold gray green orange purple red silver white yellow	enumerated	The interior color of inventory
    extcolor	black blue brown cream gold gray green orange purple red silver white yellow	enumerated	The exterior color of inventory
    intcolorhex		string	The interior HEX color code of inventory
    extcolorhex		string	The exterior HEX color code of inventory
    fuel	gasoline diesel electric natural-gas	enumerated	The fuel type of inventory
    cylinder	0 3 4 5 6 8 10 12 16	enumerated	The cylinders count of inventory
    engine	gas flex-fuel hybrid diesel natural-gas	enumerated	The engine type of inventory
    transmission	automatic manual automated-manula direct-drive	enumerated	The transmission type of inventory
    msrpmin		double	The lower limit of inventory MSRP
    msrpmax		double	The upper limit of inventory MSRP
    lpmin		double	The lower limit of Lease Promise Program monthly payment
    lpmax		double	The upper limit of Lease Promise Program monthly payment
    pagenum		integer	Pagination starting index
    pagesize		integer	Pagination response size. The max value is 50
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Inventory Listings by Stock Number /api/inventory/v2/stocks/:stockNumber

    Lookup inventory listings by stock number

    Parameter	Value	Type	Description
    :stockNumber		string	The stock number of inventory
    franchiseid		string	The dealership Franchise ID
    pagenum		integer	Pagination starting index
    pagesize		integer	Pagination response size. The max value is 50
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Inventory Listings by ZipCode /api/inventory/v2/inventories

    Lookup inventory listings by Zip Code

    Parameter	Value	Type	Description
    zipcode		string	The zipcode for the area where to search
    radius		integer	Radius of search
    make		string	Vehicle make name (required if model is supplied)
    model		string	Vehicle model name
    year		integer	Vehicle four-digit year
    body	sedan suv pickup hatchback minivan coupe station-wagon truck convertible van	enumerated	The body type of inventory
    type	used new cpo	enumerated	The type of inventory
    intcolor	black blue brown cream gold gray green orange purple red silver white yellow	enumerated	The interior color of inventory
    extcolor	black blue brown cream gold gray green orange purple red silver white yellow	enumerated	The exterior color of inventory
    intcolorhex		string	The interior HEX color code of inventory
    extcolorhex		string	The exterior HEX color code of inventory
    fuel	gasoline diesel electric natural-gas	enumerated	The fuel type of inventory
    cylinder	0 3 4 5 6 8 10 12 16	enumerated	The cylinders count of inventory
    engine	gas flex-fuel hybrid diesel natural-gas	enumerated	The engine type of inventory
    transmission	automatic manual automated-manula direct-drive	enumerated	The transmission type of inventory
    msrpmin		double	The lower limit of inventory MSRP
    msrpmax		double	The upper limit of inventory MSRP
    lpmin		double	The lower limit of Lease Promise Program monthly payment
    lpmax		double	The upper limit of Lease Promise Program monthly payment
    pagenum		integer	Pagination starting index
    pagesize		integer	Pagination response size. The max value is 50
    sortby	distance:asc distance:desc	enumerated	The sorting strategy for the results
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Inventory Listings by Style ID and Zipcode /api/inventory/v2/styles/:styleId

    Lookup inventory listings by Style ID and Zip Code

    Parameter	Value	Type	Description
    :styleId		string	Edmunds vehicle style ID
    zipcode		string	The zipcode for the area where to search
    radius		integer	Radius of search
    type	used new cpo	enumerated	The type of inventory
    intcolor	black blue brown cream gold gray green orange purple red silver white yellow	enumerated	The interior color of inventory
    extcolor	black blue brown cream gold gray green orange purple red silver white yellow	enumerated	The exterior color of inventory
    intcolorhex		string	The interior HEX color code of inventory
    extcolorhex		string	The exterior HEX color code of inventory
    msrpmin		double	The lower limit of inventory MSRP
    msrpmax		double	The upper limit of inventory MSRP
    lpmin		double	The lower limit of Lease Promise Program monthly payment
    lpmax		double	The upper limit of Lease Promise Program monthly payment
    pagenum		integer	Pagination starting index
    pagesize		integer	Pagination response size. The max value is 50
    view	basic full	enumerated	The response payload
    fmt	json	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 Run Inventory Lookup by VIN (Legacy) /api/inventory/v1/lookup

    Lookup an inventory item by VIN

    Parameter	Value	Type	Description
    vin		string	Vehicle VIN (Vehicle Identification Number)
    zipcode		string	Vehicle Zip Code
    range		string	Zip Code Radius
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Inventory by VIN /api/inventory/v2/vins/:vin

    Lookup an inventory item by VIN v2

    Parameter	Value	Type	Description
    :vin		string	Vehicle VIN (Vehicle Identification Number)
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Photos

  • List Methods
  • Expand Methods

  • GET Get Photos by Vehicle Style ID (Legacy) /v1/api/vehiclephoto/service/findphotosbystyleid

    Get vehicle photos by Edmunds vehicle style ID

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

  • GET Get Photos by Style ID /api/media/v2/styles/:styleId/photos

    Get vehicle photos by Edmunds vehicle style ID

    Parameter	Value	Type	Description
    :styleId		string	Edmunds vehicle style ID
    category	interior exterior	enumerated	Photos category
    width	87 98 131 150 175 185 196 276 300 396 400 423 500 600 717 815 1280 1600	enumerated	Photos width
    height	55 65 87 100 110 123 131 184 200 264 267 282 315 400 478 544 854 1067	enumerated	Photos height
    shottype	FQ RQ I RI S CARGO E W D CC F R DETAIL B O PROFILE	enumerated	Photos shot type abbreviation
    pagenum		integer	The page number of results
    pagesize		integer	The page size of results (i.e. how many results per page to show)
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Photos by Vehicle Make and Model /api/media/v2/:makeNiceName/:modelNiceName/photos

    Get photos by vehicle make and model niceNames

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    category	interior exterior	enumerated	Photos category
    width	87 98 131 150 175 185 196 276 300 396 400 423 500 600 717 815 1280 1600	enumerated	Photos width
    height	55 65 87 100 110 123 131 184 200 264 267 282 315 400 478 544 854 1067	enumerated	Photos height
    shottype	FQ RQ I RI S CARGO E W D CC F R DETAIL B O PROFILE	enumerated	Photos shot type abbreviation
    pagenum		integer	The page number of results
    pagesize		integer	The page size of results (i.e. how many results per page to show)
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Photos by Vehicle Make, Model and Year /api/media/v2/:makeNiceName/:modelNiceName/:year/photos

    Get photos by vehicle make and model niceNames and year

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    :year		integer	Vehicle four-digit year
    category	interior exterior	enumerated	Photos category
    width	87 98 131 150 175 185 196 276 300 396 400 423 500 600 717 815 1280 1600	enumerated	Photos width
    height	55 65 87 100 110 123 131 184 200 264 267 282 315 400 478 544 854 1067	enumerated	Photos height
    shottype	FQ RQ I RI S CARGO E W D CC F R DETAIL B O PROFILE	enumerated	Photos shot type abbreviation
    pagenum		integer	The page number of results
    pagesize		integer	The page size of results (i.e. how many results per page to show)
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Photos by tags /api/media/v2/photoset

    Get photos by tags

    Parameter	Value	Type	Description
    tag		string	Photos tags
    category	interior exterior	enumerated	Photos category
    width	87 98 131 150 175 185 196 276 300 396 400 423 500 600 717 815 1280 1600	enumerated	Photos width
    height	55 65 87 100 110 123 131 184 200 264 267 282 315 400 478 544 854 1067	enumerated	Photos height
    shottype	FQ RQ I RI S CARGO E W D CC F R DETAIL B O PROFILE	enumerated	Photos shot type abbreviation
    pagenum		integer	The page number of results
    pagesize		integer	The page size of results (i.e. how many results per page to show)
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Spec: Vehicle Make

  • List Methods
  • Expand Methods

  • GET Get All Car Makes /api/vehicle/v2/makes

    Get a list of all vehicle makes (new, used and future) and their models. Click here for full documentation.

    Parameter	Value	Type	Description
    state	new used future	enumerated	The state of the car make
    year		integer	The four-digit year of interest
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Car Make Details by Make Nicename /api/vehicle/v2/:makeNiceName

    Get the car make details by its URL-friendly name, or niceName. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint)
    state	new used future	enumerated	The state of the car make
    year		integer	The four-digit year of interest
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Car Makes Count /api/vehicle/v2/makes/count

    Get the car makes count in total and per criteria. Click here for full documentation.

    Parameter	Value	Type	Description
    state	new used future	enumerated	The state of the car make
    year		integer	The four-digit year of interest
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Spec: Vehicle Model

  • List Methods
  • Expand Methods

  • GET Get Car Model Details by Car Make and Model Nicenames /api/vehicle/v2/:makeNiceName/:modelNiceName

    Get a vehicle model by its Edmunds Vehicle Make and Model niceNames. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint in the Vehicle Makes resource)
    :modelNiceName		string	Car model niceName
    state	new used future	enumerated	The state of the car make
    year		integer	The four-digit year of interest
    submodel		string	The vehicle submodel niceName
    category	4dr Hatchback Coupe Convertible Sedan 2dr Hatchback Wagon Regular Cab Pickup Extended Cab Pickup Crew Cab Pickup 2dr SUV 4dr SUV Convertible SUV Cargo Van Passenger Van Cargo Minivan Passenger Minivan	enumerated	Vehicle category
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get All Car Models by a Car Make Nicename /api/vehicle/v2/:makeNiceName/models

    Get a list of car models for a specific car make by the make's niceName. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint in the Vehicle Makes resource)
    state	new used future	enumerated	The state of the car make
    year		integer	The four-digit year of interest
    submodel		string	The vehicle submodel niceName
    category	4dr Hatchback Coupe Convertible Sedan 2dr Hatchback Wagon Regular Cab Pickup Extended Cab Pickup Crew Cab Pickup 2dr SUV 4dr SUV Convertible SUV Cargo Van Passenger Van Cargo Minivan Passenger Minivan	enumerated	Vehicle category
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Car Models Count /api/vehicle/v2/:makeNiceName/models/count

    Get car models count for a specific car make. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint in the Vehicle Makes resource)
    state	new used future	enumerated	The state of the car make
    year		integer	The four-digit year of interest
    submodel		string	The vehicle submodel niceName
    category	4dr Hatchback Coupe Convertible Sedan 2dr Hatchback Wagon Regular Cab Pickup Extended Cab Pickup Crew Cab Pickup 2dr SUV 4dr SUV Convertible SUV Cargo Van Passenger Van Cargo Minivan Passenger Minivan	enumerated	Vehicle category
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Spec: Vehicle Model Year

  • List Methods
  • Expand Methods

  • GET Get Car Model Year by Car Make and Model Nicenames /api/vehicle/v2/:makeNiceName/:modelNiceName/years

    Get a vehicle's model year details by providing its vehicle Make and Model niceNames. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint in the Vehicle Makes resource)
    :modelNiceName		string	Car model niceName
    state	new used future	enumerated	The state of the car make
    submodel		string	The vehicle submodel niceName
    category	4dr Hatchback Coupe Convertible Sedan 2dr Hatchback Wagon Regular Cab Pickup Extended Cab Pickup Crew Cab Pickup 2dr SUV 4dr SUV Convertible SUV Cargo Van Passenger Van Cargo Minivan Passenger Minivan	enumerated	Vehicle category
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Car Model Year by Car Make and Model Nicenames and the Car Year /api/vehicle/v2/:makeNiceName/:modelNiceName/:year

    Get a list of all Model Years and Styles for a specific vehicle by its Make/Model/Year details. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint in the Vehicle Makes resource)
    :modelNiceName		string	Car model niceName
    :year		string	Car model year
    submodel		string	The vehicle submodel niceName
    category	4dr Hatchback Coupe Convertible Sedan 2dr Hatchback Wagon Regular Cab Pickup Extended Cab Pickup Crew Cab Pickup 2dr SUV 4dr SUV Convertible SUV Cargo Van Passenger Van Cargo Minivan Passenger Minivan	enumerated	Vehicle category
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Car Model Years Count by Vehicle Make and Model Nicenames /api/vehicle/v2/:makeNiceName/:modelNiceName/years/count

    Get the total count of car make years for a specific car make and model. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Car make niceName (you get the niceName from the Get All Car Makes endpoint in the Vehicle Makes resource)
    :modelNiceName		string	Car model niceName
    state	new used future	enumerated	The state of the car make
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Spec: Vehicle Style

  • List Methods
  • Expand Methods

  • GET Get Style Details by ID /api/vehicle/v2/styles/:id

    Get vehicle style details by Edmunds vehicle style ID. Click here for full documentation.

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

  • GET Get Styles Details by Vehicle Make/Model/Year /api/vehicle/v2/:makeNiceName/:modelNiceName/:year/styles

    Get vehicle style details by vehicle make and model niceNames and year. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    :year		string	Vehicle four-digit year
    state	new used future	enumerated	The state of the car style
    submodel		string	The vehicle submodel
    category	4dr Hatchback Coupe Convertible Sedan 2dr Hatchback Wagon Regular Cab Pickup Extended Cab Pickup Crew Cab Pickup 2dr SUV 4dr SUV Convertible SUV Cargo Van Passenger Van Cargo Minivan Passenger Minivan	enumerated	Vehicle category (e.g. sedan, suv, ...etc)
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Styles Count by Vehicle Make/Model/Year /api/vehicle/v2/:makeNiceName/:modelNiceName/:year/styles/count

    Get vehicle style count by vehicle make and model niceNames and year. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    :year		string	Vehicle four-digit year
    state	new used future	enumerated	The state of the car style
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Styles Count by Vehicle Make and Model /api/vehicle/v2/:makeNiceName/:modelNiceName/styles/count

    Get vehicle style count by vehicle make and model niceNames. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    :modelNiceName		string	Vehicle model niceName
    state	new used future	enumerated	The state of the car style
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Styles Count by Vehicle Make /api/vehicle/v2/:makeNiceName/styles/count

    Get vehicle style count by vehicle make niceName. Click here for full documentation.

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle make niceName
    state	new used future	enumerated	The state of the car style
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Styles Count /api/vehicle/v2/styles/count

    Get vehicle style count. Click here for full documentation.

    Parameter	Value	Type	Description
    state	new used future	enumerated	The state of the car style
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Styles Details by Vehicle Chrome ID /api/vehicle/v2/partners/chrome/styles/:chromeId

    Get vehicle style details by Chrome Data vehicle ID. **this is an endpoint only provided to explicit partners of both Chrome Data and Edmunds.com, please contact us to inquire.

    Parameter	Value	Type	Description
    :chromeId		string	The Chrome ID for a vehicle
    view	basic full	enumerated	The response payload
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Spec: Vehicle Colors and Options

  • List Methods
  • Expand Methods

  • GET Get List of Options by Style ID /api/vehicle/v2/styles/:id/options

    Get list of options and their details for a specific style ID

    Parameter	Value	Type	Description
    :id		string	Edmunds vehicle style ID
    category	Interior Exterior Roof Interior Trim Mechanical Package Additional Fees Other	enumerated	Option category
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Options Details by ID /api/vehicle/v2/options/:id

    Get options detail by option ID

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

  • GET Get List of Colors by Style ID /api/vehicle/v2/styles/:id/colors

    Get list of colors and their details for a specific Edmunds style ID

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

  • GET Get Colors Details by ID /api/vehicle/v2/colors/:id

    Get colors detail by color ID

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

• Spec: Vehicle Engine & Transmission

  • List Methods
  • Expand Methods

  • GET Get List of Engines by Style ID /api/vehicle/v2/styles/:id/engines

    Get list of engines and their details for a specific Edmunds style ID

    Parameter	Value	Type	Description
    :id		string	Edmunds vehicle style ID
    availability	standard optional	enumerated	Option category
    name		string	Engine name
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Engine Details by ID /api/vehicle/v2/engines/:id

    Get vehicle engine details by engine ID

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

  • GET Get List of Transmissions by Style ID /api/vehicle/v2/styles/:id/transmissions

    Get list of transmission and their details for a specific Edmunds style ID

    Parameter	Value	Type	Description
    :id		string	Edmunds vehicle style ID
    availability	standard optional	enumerated	Option category
    name		string	Transmission name
    fmt	json	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 ID /api/vehicle/v2/transmissions/:id

    Get vehicle transmission details by transmission ID

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

• Spec: Vehicle Equipment

  • List Methods
  • Expand Methods

  • GET Get Equipment Details by Style ID /api/vehicle/v2/styles/:id/equipment

    Get list of equipment details for a specific style ID

    Parameter	Value	Type	Description
    :id		string	Edmunds vehicle style ID
    availability	standard optional used	enumerated	Equipment availability
    equipmentType	AUDIO_SYSTEM COLOR ENGINE MANUFACTURER MIRRORS OPTION OTHER TELEMATICS TIRES	enumerated	Equipment category
    name	1ST_ROW_SEATS 2ND_ROW_SEATS 3RD_ROW_SEATS 4TH_ROW_SEATS 5TH_ROW_SEATS AIR_CONDITIONING AIRBAGS AUDIO_SYSTEM BRAKE_SYSTEM CARGO_DIMENSIONS COLLISION_SAFETY_SYSTEM COLOR CONVERTIBLE_ROOF DIFFERENTIAL DOORS DRIVE_TYPE DRIVER_SEAT ENGINE EXTERIOR_DIMENSIONS EXTERIOR_LIGHTS FRONT_PASSENGER_SEAT INSTRUMENTATION INTERIOR_DIMENSIONS MANUFACTURER MIRRORS MOBILE_CONNECTIVITY NAVIGATION_SYSTEM PARKING_AID POWER_OUTLETS SEATBELTS SEATING_CONFIGURATION SECURITY SPARE_TIRE/WHEEL SPECIFICATIONS STEERING STEERING_WHEEL STORAGE SUNROOF SUSPENSION TECHNOLOGY_FEATURE TELEMATICS TIRES TRAILER_TOWING_EQUIPMENT TRANSMISSION TRUCK_BED TRUNK VIDEO_SYSTEM WARRANTY WHEELS WINDOWS	enumerated	Equipment category
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get Equipment Details by ID /api/vehicle/v2/equipment/:id

    Get equipment details by ID

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

• Spec: Vehicle SquishVINs

  • List Methods
  • Expand Methods

  • GET Get Vehicle Details by SquishVIN /api/vehicle/v2/squishvins/:id/

    Get vehicle details for a squishVIN (basically the first 11 digits of the VIN minus the 9th digit which is a check digit)

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

• Spec: 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	Value	Type	Description
    zip		string	Zipcode
    styleid		string	Vehicle Style ID
    fmt	json	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	Value	Type	Description
    zip		string	Zipcode
    styleid		string	Vehicle Style ID
    optionid		string	Vehicle Option ID
    selected		string	Vehicle Option ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Spec: VIN Decoding

  • List Methods
  • Expand Methods

  • GET Get Basic Vehicle Information by VIN (NEW CARS ONLY) /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. Limited to: Non-Commercial vehicles for sale in the USA, built after 1990

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

  • GET Get Full Vehicle Details by VIN /api/vehicle/v2/vins/:vin

    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. Limited to: Non-Commercial vehicles for sale in the USA, built after 1990

    Parameter	Value	Type	Description
    :vin		string	Vehicle VIN
    manufacturerCode		string	The vehicle manufacturer (i.e. OEM) code for this vehicle.
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Pricing: True Cost to Own (TCO®)

  • 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	Value	Type	Description
    :styleid		string	Vehicle style ID
    :zip		string	five-digit zipcode
    fmt	json	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	Value	Type	Description
    :styleid		string	Vehicle style ID
    :zip		string	Five-digit zipcode
    fmt	json	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	Value	Type	Description
    :styleid		string	Vehicle style ID
    :zip		string	Five-digit zipcode
    fmt	json	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

    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	Value	Type	Description
    :styleid		string	Vehicle style ID
    :zip		string	Five-digit zipcode
    fmt	json	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	json	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	Value	Type	Description
    makeid		string	The Car Make ID
    fmt	json	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	Value	Type	Description
    make		string	Vehicle make niceName
    model		string	Vehicle model niceName
    year		string	Vehicle year (YYYY)
    submodel		string	Vehicle submodel
    makeyear		string	The vehicle make year
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get TCO® details for a NEW car /api/tco/v1/details/allnewtcobystyleidzipandstate/:styleid/:zip/:state

    Get the 5-year breakdown values of all TCO categories for a NEW vehicle based on its specified style Id, zip code, and state code.

    Parameter	Value	Type	Description
    :styleid		string	Vehicle style ID
    :zip		string	Five-digit zipcode
    :state		string	US State Code (e.g. CA, NY, NJ, PA, ...etc)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Get TCO® details for a USED car /api/tco/v1/details/allusedtcobystyleidzipandstate/:styleid/:zip/:state

    Get the 5-year breakdown values of all TCO categories for a USED vehicle based on its specified style Id, zip code, and state code.

    Parameter	Value	Type	Description
    :styleid		string	Vehicle style ID
    :zip		string	Five-digit zipcode
    :state		string	US State Code (e.g. CA, NY, NJ, PA, ...etc)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Pricing: True Market Value® (TMV®)

  • List Methods
  • Expand Methods

  • GET Calculate for New Vehicle with Car Make/Year, MSRP and Zip Code /api/v1/vehicle/:makeNiceName/:year/price

    Parameter	Value	Type	Description
    :makeNiceName		string	Vehicle Make niceName
    :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	all-wheel-drive front-wheel-drive rear-wheel-drive four-wheel-drive	string	Vehicle drive type name
    fuelType	electric natural-gas-cng gas flex-fuel-ffv diesel hybrid	string	Name of the type of fuel the vehicle engine uses
    cylinders		string	The number of cylinders the vehicle engine has
    compressorType	supercharger twin-turbocharger turbocharger	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 New Vehicle with Car VIN, MSRP and Zip Code /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	Value	Type	Description
    :vin		string	Vehicle VIN
    zip		string	Five-digit zipcode
    msrp		string	Vehicle MSRP
    color	black dark-blue dark-brown dark-green dark-red gold gray light-blue light-brown light-green off-whitecream orange other purple red silver white yellow	enumerated	Vehicle color (i.e. black, white, blue, ...etc)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET Calculate for New Vehicle with Car Style ID and Zip Code /v1/api/tmv/tmvservice/calculatenewtmv

    Parameter	Value	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	json	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 with Car Style ID, Condition, Mileage and Zip Code /v1/api/tmv/tmvservice/calculateusedtmv

    Parameter	Value	Type	Description
    styleid		string	Vehicle style ID
    condition	Outstanding Clean Average Rough Damaged	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	json	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	Value	Type	Description
    styleid		string	Vehicle style ID
    zip		string	Five-digit zipcode
    fmt	json	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	Value	Type	Description
    styleid		string	Vehicle style ID
    zip		string	Five-digit zipcode
    fmt	json	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	Value	Type	Description
    id		string	Incentive ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired