Api documentation

Api documentation

Get Model Year and Style Details for a Car Make and Model

Spec: Model
 
 
v3 v2
 
 

Response format

JSON Response

  1. {
  2. "id": {integer},
  3. "make": {object},
  4. "name": {string},
  5. "niceName": {string},
  6. "state": {array of strings}, // only when view=full
  7. "years": {array of objects}
  8. }
Property Description Visibility
id The Edmunds ID for the car make/model Edmunds, Partners, Public
make The car make details (i.e. id, name, niceName) Edmunds, Partners, Public
name The name of this car model Edmunds, Partners, Public
niceName URL-friendly car model name Edmunds, Partners, Public
states The state of this car model (i.e. NEW, USED, FUTURE) Edmunds, Partners, Public
years Array of model year details, including styles Edmunds, Partners, Public

Each element in the years array follows this format:

  1. {
  2. "id": {integer},
  3. "states": {array of strings}, // only when view=full
  4. "styles": {array of objects},
  5. "year": {integer}
  6. }
Property Description Visibility
id The Edmunds ID for the car model year Edmunds, Partners, Public
states The state of this model/year (e.g. NEW, USED, FUTURE) Edmunds, Partners, Public
styles List of styles belonging to this model year (see below) Edmunds, Partners, Public
year The car year Edmunds, Partners, Public

Each element in the styles array follows this format:

  1. {
  2. "id": {integer},
  3. "name": {string},
  4. "submodel": {object},
  5. "trim": {string},
  6. "states": {array of strings} // only when view=full
  7. }
Property Description Visibility
id The Edmunds ID for the car style Edmunds, Partners, Public
name The car style name Edmunds, Partners, Public
submodel The vehicle submodel (body and modelName info) Edmunds, Partners, Public
trim The vehicle trim for this car style Edmunds, Partners, Public
states The state of this car style (e.g. NEW, USED, FUTURE) Edmunds, Partners, Public

Each submodel object follows this format:

  1. {
  2. "body": {string},
  3. "fuel": {string}, // is not always populated
  4. "tuner": {string}, // is not always populated
  5. "modelName": {string},
  6. "niceName": {string}
  7. }
Property Description Visibility
body The type of car body (e.g. “Sedan”, “Hatchback”) Edmunds, Partners, Public
fuel The type of car fuel (e.g. “Hybrid”, “Diesel”, “Electric”) Edmunds, Partners, Public
tuner The type of car tuner (e.g. “Base”, “Sport”) Edmunds, Partners, Public
modelName The name of this submodel (e.g. “Civic Hatchback”, “X5 SUV Diesel”) Edmunds, Partners, Public
niceName The nice name of this submodel (e.g. “sedan”, “diesel”) Edmunds, Partners, Public