CONTENTS

×

REST API DOCUMENTATION

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

Login

URL

URL

https://api.edriveauto.com/api/Account/login
REST Method Name

REST Method Name

login
Method

Method

POST
Format

Format

JSON
Url Params
Parameter Name Data Type Sample Value
username string 398996FF-8F92-4247-9175-B52D1A0964F3
password string 123456
role string Dealer
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",
"role": "Dealer",
"originalUserName": null,
"accessToken": "LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9eyJhbGciOiJodHRwOi8vd3d3yZSNobWFjLXNoYTI1NiIs
InR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb20aXR5L2NsYWltcy9uYW1lIjoiRENENzNGNjctRUYwRS00RkFB
LThGMkYtQTZFNDQ3NDEwQkI5IiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2FwLm9yZy93cy8yMDA1LzA1L2lkZW5Z0LmNvbS93
cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiRGVhbGVyIiwiZXhwIjoxNjU3NjM5MzgzLCJpc3MiOiJodHRwczovL
2FwaS5lZHJpdmVhdXRvLmNvbSIsImF1ZCI6Imh0dHBzOi8vYXBpLmVkcml2ZWF1dG8uY29tIn0.giZGdNpPUmFhvbMdU0syL0
gSTDGFKdWPX4H97BT9OFM",
"refreshToken": "+1eedrj0H2XC3cNY=SHOHNYrhtOaX9M1ZpGxkqSo8GoV"}

Refresh Token

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
Parameter Name Data Type Sample Value
refreshToken string +1eedrj0H2XC3cNY=SHOHNYrhtOaX9M1ZpGxkqSo8GoV
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",
"role": "Dealer",
"originalUserName": null,
"accessToken": "JhbGciOiJodHlIjoiRENENzNGNjctRUYwLnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9eyRS00RkFBL
ThGMkYtQTZFNDQ3NDEwQkI5IiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2FwLm9yRwOi8vd3d3yZSNobWFjLXNoYTI1NiIsIn
R5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb20aXR5L2NsYWltcy9uYW1Zy93cy8yMDA1LzA1L2lkZW5Z0LmNvb
S93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiRGVhbGVyIiwiZXhwIjoxNjU3NjM5MzgzLCJpc3MiOiJodHRw
czovL2FwaS5lZHJpdmVhdXRvLmNvbSIsImF1ZCI6Imh0dHBzOi8vYXBpLmVkcml2ZWF1dG8uY29tIn0.giZGdNpPUmFhvbMd
U0syL0gSTDGFKdWPX4H97BT9OFM",
"refreshToken": "+1eedrj0H2XC3cNY=SHOHNYrhtOaX9M1ZpGxkqSo8GoV"}

Get Vehicle Makes

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
Parameter Name Data Type Sample Value
year integer 2014
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)

Get Vehicle Models

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
Parameter Name Data Type Sample Value
makeID integer 25
year integer 2014
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)

Get Trim Styles

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
Parameter Name Data Type Sample Value
modelID integer 474
year integer 2014
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)

Get Body Styles

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
Parameter Name Data Type Sample Value
modelID integer 474
year integer 2014
trimID integer 795
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)

Get Engines

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.

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
Parameter Name Data Type Sample Value
modeID integer 474
year integer 2014
trimID integer 795
bodyID integer 3
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)

Get Transmissions

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.

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
Parameter Name Data Type Sample Value
modelID integer 474
year integer 2014
trimID integer 795
bodyID integer 3
engineID integer 532
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)

Get DriveTrains

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.

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
Parameter Name Data Type Sample Value
modelID integer 474
year integer 2014
trimID integer 795
bodyID integer 3
engineID integer 532
TransmissionID integer 9
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)

Get Vehicle Appraisal Value

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 and DrivetrainID parameters retrieved from the respective GetModels, GetTrimStyles, GetBodyStyles, GetEngines, GetTransmissions and GetDrivetrains REST Methods as ID.

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}
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
Method

Method

GET
Format

Format

JSON
Url Params
Parameter Name Data Type Sample Value
modelID integer 474
year integer 2014
trimID integer 795
bodyID integer 3
engineID integer 532
transmissionID integer 9
driveTrainID integer 1
mileage integer 96010
zipCode string 19808
JSON Response Data Object

JSON Response Data Object

{
    "medianPrice" : {double},
    "standardDeviation" : {double},
    "topPriceLevel" : {double},
    "bottomPriceLevel" : {double},
}
Success Response

Success Response

Example:
Status Code: 200 (Success)
JSON Response:

{"medianPrice": 0,"standardDeviation": 0,"topPriceLevel": 0,"bottomPriceLevel": 0}
Error Response

Error Response

Example:
Status Code: 401 (Unauthorized)

Decode VIN

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
Parameter Name Data Type Sample Value
vin string 1B3EL46X34N240453
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,
"make":"Dodge","model":"Stratus","trim":"SXT","body":"Sedan"
,"engineSize":2.40,"engineType":"gas","engineCylinder":4,
"transmission":"4A","transmissionType":"AUTOMATIC",
"automaticType":null,"numberOfSpeeds":"4","vehicleType":"Car",
"makeID":15,"modelID":312,"transmissionID":1,"bodyID":3,"engineID":683,
"trimID":2601,"fuelType":"regular unleaded","drivenWheels":"front wheel drive","doors":4,"baseMSRP":19970,
"mpgCity":20,"mpgHighway":27}]
Error Response

Error Response

Example:
Status Code: 401 (Unauthorized)

Contact Us