- Previous: Make Repository
- Up: The Vehicle API V1
- Next: Style Repository
Model Repository
The Model Repository provides Model information about a particular Make.
Go to:
Please read the API Documentation page for information that applies to all our APIs.
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/{method}Response Formattop
All method responsed are JSON obects with a root property called, modelHolder. The value of modelHolder is an array of Model objects:
{
"modelHolder": [
model_object_1,
model_object_2,
model_object_3,
....
....
]
}Each model object is a JSON object of the following format:
{
"makeId": [integer],
"makeName": [string]
"makeNiceName": [string],
"id": [string],
"name": [string],
"niceName": [string],
"make": [object],
"modelYears": [
modelyear_object_1,
modelyear_object_2,
...
],
"attributionGroups": [object]
"categories": [object],
"publicationStates": [object],
"subModels": [object]
}The properties of the Model object are:
- makeId: The make ID
- makeName: The name of the vehicle make
- makeNiceName: The make's nice name, or URL-friendly name
- id: The model ID
- name: The model name
- niceName: The model's nice name, or URL-friendly name
- make: An object that has the API link to the vehicle make details
- modelYears: An array of model year objects
- attributeGroups: [description]
- categories: The model various types
- publicationStates: An array of available publication states
- subModels: List of available submidels
Sample Requesttop
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findmodelsbymakeandpublicationstate?make=honda&state=new&api_key=xxxxxxxxxx&fmt=jsonSample Response
{
"modelHolder": [
{
"makeId": 200001444,
"makeName": "Honda",
"makeNiceName": "honda",
"id": "Honda_CR_V",
"name": "CR-V",
"niceName": "crv",
"make": {
"link": "/api/vehicle/honda"
},
"modelYears": [
{
"link": "/api/vehicle/honda/crv/2006",
"id": "100506803",
"year": "2006"
},
{
"link": "/api/vehicle/honda/crv/2001",
"id": "100000120",
"year": "2001"
},
...
...
{
"link": "/api/vehicle/honda/crv/2005",
"id": "100505003",
"year": "2005"
},
{
"link": "/api/vehicle/honda/crv/2000",
"id": "422",
"year": "2000"
}
],
"attributeGroups": {
"MAIN": {
"id": 1,
"name": "MAIN",
"attributes": {
"USE_IN_NEW": {
"id": 10,
"name": "USE_IN_NEW",
"value": "Y"
},
"NAME": {
"id": 1,
"name": "NAME",
"value": "CR-V"
},
"YEAR": {
"id": 2,
"name": "YEAR",
"value": "2011"
},
"STAGE": {
"id": 669,
"name": "STAGE",
"value": "COMPLETED"
},
"USE_IN_FUTURE": {
"id": 595,
"name": "USE_IN_FUTURE",
"value": "N"
},
"USE_IN_PRE_PRODUCTION": {
"id": 12,
"name": "USE_IN_PRE_PRODUCTION",
"value": "N"
},
"USE_IN_USED": {
"id": 11,
"name": "USE_IN_USED",
"value": "N"
},
"MODEL_LINK_CODE": {
"id": 20,
"name": "MODEL_LINK_CODE",
"value": "M030281"
}
}
},
"LEGACY": {
"id": 64,
"name": "LEGACY",
"attributes": {
"ED_MODEL_ID": {
"id": 3,
"name": "ED_MODEL_ID",
"value": "100533329"
}
}
}
},
"categories": {
"Crossover": [
"Crossover"
],
"Vehicle Size": [
"Midsize",
"Compact"
],
"PRIMARY_BODY_TYPE": [
"SUV"
],
"Vehicle Style": [
"4dr SUV"
],
"Vehicle Type": [
"SUV"
],
"Tier Five - Vehicle Market Perception": [
"Crossover",
"N/A"
]
},
"publicationStates": [
"USED",
"PRE_PROD",
"NEW",
"NEW_USED"
],
"subModels": {
"USED": [
{
"identifier": "SUV",
"name": "CR-V SUV",
"ruleType": "",
"styleIds": [
100698749,
100650233,
100650234,
100650235,
100650236,
100650237
],
"publicationStates": [
"USED"
],
"submodelUsedDefaultStyle": {
"link": "/api/vehicle/style/100650233"
}
}
],
"PRE_PROD": [
{
"identifier": "SUV",
"name": "CR-V SUV",
"ruleType": "",
"styleIds": [
101323927
],
"publicationStates": [
"PRE_PROD"
],
"submodelNewDefaultStyle": {
"link": "/api/vehicle/style/101323927"
}
}
],
"NEW": [
{
"identifier": "SUV",
"name": "CR-V SUV",
"ruleType": "",
"styleIds": [
101358302,
101358303,
101358309,
101358308,
101358288,
101358307,
101358289,
101358306,
101358305,
101358304
],
"publicationStates": [
"NEW"
],
"submodelNewDefaultStyle": {
"link": "/api/vehicle/style/101358288"
}
}
]
}
},
{
"makeId": 200001444,
"makeName": "Honda",
"makeNiceName": "honda",
"id": "Honda_Odyssey",
"name": "Odyssey",
"niceName": "odyssey",
"make": {
"link": "/api/vehicle/honda"
},
"modelYears": [
{
"link": "/api/vehicle/honda/odyssey/2008",
"id": "100524311",
"year": "2008"
},
{
"link": "/api/vehicle/honda/odyssey/1997",
"id": "2164",
"year": "1997"
},
...
...
{
"link": "/api/vehicle/honda/odyssey/2009",
"id": "100526089",
"year": "2009"
}
],
"attributeGroups": {
"MAIN": {
"id": 1,
"name": "MAIN",
"attributes": {
"USE_IN_NEW": {
"id": 10,
"name": "USE_IN_NEW",
"value": "Y"
},
"NAME": {
"id": 1,
"name": "NAME",
"value": "Odyssey"
},
"YEAR": {
"id": 2,
"name": "YEAR",
"value": "2011"
},
"STAGE": {
"id": 669,
"name": "STAGE",
"value": "COMPLETED"
},
"USE_IN_FUTURE": {
"id": 595,
"name": "USE_IN_FUTURE",
"value": "N"
},
"USE_IN_PRE_PRODUCTION": {
"id": 12,
"name": "USE_IN_PRE_PRODUCTION",
"value": "N"
},
"USE_IN_USED": {
"id": 11,
"name": "USE_IN_USED",
"value": "N"
},
"MODEL_LINK_CODE": {
"id": 20,
"name": "MODEL_LINK_CODE",
"value": "M030283"
}
}
},
"LEGACY": {
"id": 64,
"name": "LEGACY",
"attributes": {
"ED_MODEL_ID": {
"id": 3,
"name": "ED_MODEL_ID",
"value": "100530590"
}
}
}
},
"categories": {
"Vehicle Size": [
"Large",
"Compact"
],
"PRIMARY_BODY_TYPE": [
"Minivan"
],
"Vehicle Style": [
"Passenger Minivan"
],
"Vehicle Type": [
"Minivan"
],
"Tier Five - Vehicle Market Perception": [
"N/A"
]
},
"publicationStates": [
"USED",
"NEW",
"NEW_USED"
],
"subModels": {
"USED": [
{
"identifier": "Minivan",
"name": "Odyssey Minivan",
"ruleType": "",
"styleIds": [
100952864,
100952865,
100952866,
100952863,
100952862,
100952861,
100952860
],
"publicationStates": [
"USED"
],
"submodelUsedDefaultStyle": {
"link": "/api/vehicle/style/100952860"
}
}
],
"NEW": [
{
"identifier": "Minivan",
"name": "Odyssey Minivan",
"ruleType": "",
"styleIds": [
101358233,
101358235,
101358236,
101358237,
101358238,
101260557,
101358257
],
"publicationStates": [
"NEW"
],
"submodelNewDefaultStyle": {
"link": "/api/vehicle/style/101260557"
}
}
]
}
},
...
...
]
}
Available Methodstop
| Method | Description |
|---|---|
findbyid |
Get a vehicle's model details by the model ID |
| Get a vehicle's model details by the make ID | |
findfuturemodelsbymakeid |
Get a list of all future models by the make ID |
findmodelbymakemodelname |
Get a vehicle model by the make and model names |
findmodelsbymake |
Get a list of models by the make name |
findmodelsbymakeandpublicationstate |
Get a list of models by the make name and the publication state |
findmodelsbymakeandyear |
Get a list of models by the make name and year |
findnewandusedmodelsbymakeid |
Get a list of new and used models by the make ID |
findnewmodelsbymakeid |
Get a list of new models by the make ID |
findusedmodelsbymakeid |
Get a list of used models by the make ID |
Method: findbyid
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findbyid?id=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle model ID |
Yes |
Method: findbymakeid
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findbymakeid?makeid=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make ID |
Yes |
Method: findfuturemodelsbymakeid
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findfuturemodelsbymakeid?makeId=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make ID |
Yes |
Method: findmodelbymakemodelname
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findmodelbymakemodelname?make=xxx&model=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make name (use niceName value) |
Yes |
model
Vehicle model name (use niceName value) |
Yes |
Method: findmodelsbymake
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findmodelsbymake?make=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make name (use niceName value) |
Yes |
Method: findmodelsbymakeandpublicationstate
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findmodelsbymakeandpublicationstate?make=xxx&state=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make name (use niceName value) |
Yes |
|
state The publication state (new|used|future) |
Yes |
Method: findmodelsbymakeandyear
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findmodelsbymakeandyear?make=xxx&year=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
make Vehicle make name (use niceName value) |
Yes |
year
The four-digit year |
Yes |
Method: findnewandusedmodelsbymakeid
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findnewandusedmodelsbymakeid?makeId=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make ID |
Yes |
Method: findnewmodelsbymakeid
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findnewmodelsbymakeid?makeId=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make ID |
Yes |
Method: findusedmodelsbymakeid
URL
http://api.edmunds.com/{version}/api/vehicle/modelrepository/findusedmodelsbymakeid?makeId=xxx&api_key=xxxxxxxxxx&fmt=jsonParameters
| Name and Description | Required? |
|
Vehicle make ID |
Yes |
- Previous: Make Repository
- Up: The Vehicle API V1
- Next: Style Repository
3 Comments
Janex Software – 1 year ago
I tried this request and I got an INCORRECT_PARAMS error even when I specified the right param: http://api.edmunds.com/v1/api/vehicle/modelrepository/findnewandusedmodelsbymakeid?makeId=200002038&api_key=MY API KEY&fmt=json
markevans – 1 year ago
The methods appear to be inconsistent with use of "makeId" and "makeid". That particular method appears to require that the "makeid" parameter be spelled using a lower case "i". Others want "makeId".
Ismail Elshareef – 1 year ago
Yes, we're aware of the inconsistencies in the API. We're standardizing all of that in API 2.0.
Please sign in to post a comment.