CONTENTS
×In order to start using the API you will need your Unique Key and a password provided by E-Drive Auto. If you have any questions, please contact us at sanjar@edriveauto.com
URL |
URL https://api.edriveauto.com/api/Account/login |
||||||||||||
REST Method Name |
REST Method Name login |
||||||||||||
Method |
Method POST |
||||||||||||
Format |
Format JSON |
||||||||||||
Url Params |
|
||||||||||||
JSON Response Data Object |
JSON Response Data Object {"username" : {string}, "role" : {string} "originalUserName" : {string} "accessToken" : {string} "refreshToken" : {string} } |
||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response:
{"username": "398996FF-8F92-4247-9175-B52D1A0964F3", |
URL |
URL https://api.edriveauto.com/api/Account/refresh-token |
||||||
REST Method Name |
REST Method Name refresh-token |
||||||
Method |
Method POST |
||||||
Format |
Format JSON |
||||||
Url Params |
|
||||||
JSON Response Data Object |
JSON Response Data Object {"username" : {string}, "role" : {string} "originalUserName" : {string} "accessToken" : {string} "refreshToken" : {string} } |
||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response:
{"username": "398996FF-8F92-4247-9175-B52D1A0964F3", |
Returns a list of vehicle makes for a specific year in JSON format. Items are ordered by name.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
||||||
REST Method Name |
REST Method Name get-makes |
||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-makes?year={year} |
||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-makes?year=2014 |
||||||
Method |
Method GET |
||||||
Format |
Format JSON |
||||||
Url Params |
|
||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id": 3,"name": "Acura"},{"id": 5,"name": "Aston Martin"},{"id": 6,"name": "Audi"}, {"id": 8,"name": "Bentley"},{"id": 7,"name": "BMW"},{"id": 10,"name": "Buick"}, {"id": 11,"name": "Cadillac"},{"id": 12,"name": "Chevrolet"},{"id": 13,"name": "Chrysler"}, {"id": 15,"name": "Dodge"},{"id": 18,"name": "Ferrari"},{"id": 17,"name": "FIAT"}, {"id": 20,"name": "Ford"},{"id": 21,"name": "GMC"},{"id": 24,"name": "Honda"}, {"id": 25,"name": "Hyundai"},{"id": 26,"name": "Infiniti"},{"id": 28,"name": "Jaguar"}, {"id": 29,"name": "Jeep"},{"id": 30,"name": "Kia"},{"id": 31,"name": "Lamborghini"}, {"id": 32,"name": "Land Rover"},{"id": 33,"name": "Lexus"},{"id": 34,"name": "Lincoln"}, {"id": 35,"name": "Lotus"},{"id": 37,"name": "Maserati"},{"id": 39,"name": "Mazda"}, {"id": 41,"name": "Mercedes-Benz"},{"id": 36,"name": "MINI"},{"id": 43,"name": "Mitsubishi"}, {"id": 44,"name": "Nissan"},{"id": 49,"name": "Porsche"},{"id": 50,"name": "Ram"}, {"id": 51,"name": "Rolls-Royce"},{"id": 54,"name": "Scion"},{"id": 62,"name": "smart"}, {"id": 56,"name": "Subaru"},{"id": 58,"name": "Tesla"},{"id": 59,"name": "Toyota"}, {"id": 60,"name": "Volkswagen"},{"id": 61,"name": "Volvo"}] |
||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of vehicle models for a specific year and make in JSON format. Items are ordered by name. It depends on makeID parameter retrieved from the get-makes REST Method as id.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
|||||||||
REST Method Name |
REST Method Name get-models |
|||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-models?makeID={makeID}&year={year} |
|||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-models?makeID=25&year=2014 |
|||||||||
Method |
Method GET |
|||||||||
Format |
Format JSON |
|||||||||
Url Params |
|
|||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
|||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id": 472,"name": "Accent"},{"id": 473,"name": "Azera"},{"id": 474,"name": "Elantra"}, {"id": 475,"name": "Elantra Coupe"},{"id": 476,"name": "Elantra GT"},{"id": 479,"name": "Equus"}, {"id": 483,"name": "Genesis"},{"id": 484,"name": "Genesis Coupe"},{"id": 485,"name": "Santa Fe"}, {"id": 486,"name": "Santa Fe Sport"},{"id": 488,"name": "Sonata"},{"id": 489,"name": "Sonata Hybrid"}, {"id": 492,"name": "Tucson"},{"id": 493,"name": "Veloster"}] |
|||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of vehicle trim styles for a specific YMM in JSON format. Items are ordered by name. It depends on modelID parameter retrieved from the get-models REST Method as id.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
|||||||||
REST Method Name |
REST Method Name get-trim-styles |
|||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-trim-styles?modelID={modelID}&year={year} |
|||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-trim-styles?modelID=474&year=2014 |
|||||||||
Method |
Method GET |
|||||||||
Format |
Format JSON |
|||||||||
Url Params |
|
|||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
|||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id": 795,"name": "Limited"},{"id": 405,"name": "Limited PZEV"},{"id": 1200,"name": "SE"}, {"id": 2638,"name": "Sport"},{"id": 770,"name": "Sport PZEV"}] |
|||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of vehicle body styles for a specific YMMT in JSON format. Items are ordered by name. It depends on modelID and trimID parameters retrieved from the respective get-models and get-trim-styles REST Methods as id.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
||||||||||||
REST Method Name |
REST Method Name Get-body-styles |
||||||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/Get-body-styles?modelID={modelID}&year={year}&trimID={trimID} |
||||||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/Get-body-styles?modelID=474&year=2014&trimID=795 |
||||||||||||
Method |
Method GET |
||||||||||||
Format |
Format JSON |
||||||||||||
Url Params |
|
||||||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id":3,"name":"Sedan"}] |
||||||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of engines available for a specific body style of YMMT in JSON format. Items are ordered by name. It depends on modelID, trimID and bodyID parameters retrieved from the respective get-models, get-trim-styles and Get-body-styles REST Methods as id.
Please note that this method is applicable to E-Drive Auto proprietary data. If you are using BlackBook as data source, you do not need this method.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
|||||||||||||||
REST Method Name |
REST Method Name get-engines |
|||||||||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-engines?modelID={modelID}&year={year}&trimID={trimID}&bodyID={bodyID} |
|||||||||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-engines?modelID=474&year=2014&trimID=795&bodyID=3 |
|||||||||||||||
Method |
Method GET |
|||||||||||||||
Format |
Format JSON |
|||||||||||||||
Url Params |
|
|||||||||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
|||||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id":532,"name":"0L 0cyl"}] |
|||||||||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of transmissions available for a specific vehicle defined in terms of YMMT, body style and engine in JSON format. Items are ordered by name. It depends on modelID, trimID, bodyID and engineID parameters retrieved from the respective get-models, get-trim-styles, Get-body-styles and get-engines REST Methods as id.
Please note that this method is applicable to E-Drive Auto proprietary data. If you are using BlackBook as data source, you do not need this method.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
||||||||||||||||||
REST Method Name |
REST Method Name get-transmissions |
||||||||||||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-transmissions?modelID={modelID}&year={year}&trimID={trimID}&bodyID={bodyID}&engineID={engineID} |
||||||||||||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-transmissions?modelID=474&year=2014&trimID=795&bodyID=3&engineID=532 |
||||||||||||||||||
Method |
Method GET |
||||||||||||||||||
Format |
Format JSON |
||||||||||||||||||
Url Params |
|
||||||||||||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
||||||||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id":9,"name":"6 speed Shiftable automatic"}] |
||||||||||||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of drive types available for a specific vehicle defined in terms of YMMT, body style, engine and transmission in JSON format. Items are ordered by name. It depends on modelID, trimID, bodyID, engineID and transmissionID parameters retrieved from the respective get-models, get-trim-styles, Get-body-styles, get-engines and get-transmissions REST Methods as id.
Please note that this method is applicable to E-Drive Auto proprietary data. If you are using BlackBook as data source, you do not need this method.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
|||||||||||||||||||||
REST Method Name |
REST Method Name get-drivetrains |
|||||||||||||||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-drivetrains?modelID={modelID}&year={year}&trimID={trimID}&bodyID={bodyID}&engineID={engineID}&transmissionID={transmissionID} |
|||||||||||||||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-drivetrains?modelID=474&year=2014&trimID=795&bodyID=3&engineID=532&transmissionID=9 |
|||||||||||||||||||||
Method |
Method GET |
|||||||||||||||||||||
Format |
Format JSON |
|||||||||||||||||||||
Url Params |
|
|||||||||||||||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string} } |
|||||||||||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id":1,"name":"FWD (front wheel drive)"}] |
|||||||||||||||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a list of options available for a specific vehicle defined in terms of YMMT, body style, engine, transmission and drive type in JSON format. It depends on modelID, trimID, bodyID, engineID, transmissionID and driveTrainID parameters retrieved from the respective get-models, get-trim-styles, Get-body-styles, get-engines, get-transmissions and get-drivetrains REST Methods as id.
Please note that if you are using BlackBook as data source, you do not need to provide optional engineID, transmissionID, and driveTrainID parameters.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
||||||||||||||||||||||||
REST Method Name |
REST Method Name get-options |
||||||||||||||||||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-options?modelID={modelID}&year={year}&trimID={trimID}&bodyID={bodyID}&engineID={engineID}&transmissionID={transmissionID}&driveTrainID={driveTrainID} |
||||||||||||||||||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-options?modelID=474&year=2014&trimID=795&bodyID=3&engineID=532&transmissionID=9&driveTrainID=1 |
||||||||||||||||||||||||
Method |
Method GET |
||||||||||||||||||||||||
Format |
Format JSON |
||||||||||||||||||||||||
Url Params |
|
||||||||||||||||||||||||
JSON Response Data Object |
JSON Response Data Object {"id" : {integer}, "name" : {string}, "description" : {string}, "baseMSRP" : {integer}, "categoryName" : {string}, } |
||||||||||||||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"id": 90380,"name": "Limited Technology Package","description": "Navigation system with high resolution 7.0\" screen; 360-watt premium audio with external amplifier; Power tilt/slide sunroof; Dual automatic temperature control with Clean Air Ionizer and Auto-Defogger System; Proximity key entry with electronic push button start; Engine immobilizer", "baseMSRP": 2750,"categoryName": "Package"},{"id": 638697,"name": "Cargo Tray","description": null,"baseMSRP": 80,"categoryName": "Interior"},{"id": 638698,"name": "Auto-Dimming Mirror W/Homelink","description": null,"baseMSRP": 275,"categoryName": "Interior"}, {"id": 638699,"name": "Carpeted Floor Mats","description": null,"baseMSRP": 125,"categoryName": "Interior"},{"id": 638700,"name": "Cargo Net","description": null,"baseMSRP": 50,"categoryName": "Interior"},{"id": 638701,"name": "Bongiovi DPS Audio Kit","description": null,"baseMSRP": 350,"categoryName": "Interior"}, {"id": 638702,"name": "Remote Engine Start","description": null,"baseMSRP": 350,"categoryName": "Mechanical"},{"id": 638703,"name": "First Aid Kit","description": null,"baseMSRP": 30,"categoryName": "Safety"},{"id": 638704,"name": "Option Package 01","description": "Vehicle with standard equipment","baseMSRP": 0,"categoryName": "Package"}, {"id": 638705,"name": "Wheel Locks","description": null,"baseMSRP": 55,"categoryName": "Exterior"},{"id": 638706,"name": "Rear Spoiler","description": null,"baseMSRP": 295,"categoryName": "Exterior"},{"id": 638707,"name": "Mud Guards","description": null,"baseMSRP": 95,"categoryName": "Exterior"}, {"id": 638708,"name": "Rear Bumper Applique","description": null,"baseMSRP": 70,"categoryName": "Exterior"}] |
||||||||||||||||||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
Returns a series of values for each level of the VRM diamond, including average market price, for a specific vehicle defined in terms of YMMT, body style, engine, transmission and drive type in JSON format. It depends on modelID, trimID, bodyID, engineID, transmissionID, driveTrainID and a list of selected option id's parameters retrieved from the respective get-models, get-trim-styles, Get-body-styles, get-engines, get-transmissions, get-drivetrains and get-options REST Methods as id.
Please note that if you are using BlackBook as data source, you'll need to provide a list of selected option names from the previous method if any, not id's. You do not need to provide optional engineID, transmissionID, and driveTrainID parameters.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
|||||||||||||||||||||||||||||||||
REST Method Name |
REST Method Name get-trade-in |
|||||||||||||||||||||||||||||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/get-trade-in?modelID={modelID}&year={year}&trimID={trimID}&bodyID={bodyID}&engineID={engineID}&transmissionID={transmissionID}&driveTrainID={driveTrainID}&mileage={mileage}&zipCode={zipCode}&optionIdCslList={optionIdCsl} |
|||||||||||||||||||||||||||||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/get-trade-in?modelID=474&year=2014&trimID=795&bodyID=3&engineID=532&transmissionID=9&driveTrainID=1&mileage=96010&zipCode=19808&optionIdCslList=638697%2C638698 |
|||||||||||||||||||||||||||||||||
Method |
Method GET |
|||||||||||||||||||||||||||||||||
Format |
Format JSON |
|||||||||||||||||||||||||||||||||
Url Params |
|
|||||||||||||||||||||||||||||||||
JSON Response Data Object |
JSON Response Data Object {"averagePrice" : {integer}, "cleanPrice" : {integer}, "roughPrice" : {integer}, "mileageAdjustedValue" : {integer}, "optionsAddedValue" : {integer}, } |
|||||||||||||||||||||||||||||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: {"averagePrice": 29069,"cleanPrice": 32221,"roughPrice": 24995,"mileageAdjustedValue": 26130,"optionsAddedValue": 0} |
|||||||||||||||||||||||||||||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |
This method is used for decoding VIN and returns full vehicle details. It's a standalone feature and does not depend on any of TradeVue REST API methods above.
For some VINs the decoder returns several vehicles which differ by Trim, Engine or Transmission. Because it is not always possible to decode these parameters, the decoder returns all possible variations of a vehicle for a given VIN.
Base URL |
Base URL https://api.edriveauto.com/api/TradeVue/ |
||||||
REST Method Name |
REST Method Name decode-vin |
||||||
URI Template |
URI Template https://api.edriveauto.com/api/TradeVue/decode-vin?vin={vin} |
||||||
Sample Call |
Sample Call https://api.edriveauto.com/api/TradeVue/decode-vin?vin=1B3EL46X34N240453 |
||||||
Method |
Method GET |
||||||
Format |
Format JSON |
||||||
Url Params |
|
||||||
JSON Response Data Object |
JSON Response Data Object {"vehicleName" : {string}, "year" : {integer}, "make" : {string}, "model" : {string}, "trim" : {string}, "body" : {string}, "engineSize" : {nullable decimal}, "engineType" : {string}, "engineCylinder" : {nullable integer}, "transmission" : {string}, "transmissionType" : {string}, "automaticType" : {string}, "numberOfSpeeds" : {string}, "vehicleType" : {string}, "makeID" : {integer}, "modelID" : {integer}, "transmissionID" : {integer}, "bodyID" : {integer}, "engineID" : {integer}, "trimID" : {integer}, "fuelType" : {string}, "drivenWheels" : {string}, "drivenWheelsShortName" : {string}, "doors" : {nullable integer}, "baseMSRP" : {nullable integer}, "mpgCity" : {nullable integer}, "mpgHighway" : {nullable integer} } |
||||||
Success Response |
Success Response Example:Status Code: 200 (Success) JSON Response: [{"vehicleName":"SXT 4dr Sedan (2.4L 4cyl 4A)","year":2004, |
||||||
Error Response |
Error Response Example:Status Code: 401 (Unauthorized) |