With GET parameters:
PARAMETER | DESCRIPTION | REQUIRED | EXAMPLE |
---|---|---|---|
vin | The vehicle identification number | Yes | 5UXKR0C58JL074657 |
mileage | The current mileage of the vehicle (if not specified, average mileage is used) | (optional) | 90000 |
period | Number of days to look back for sales data (max: 365) | (optional) | 90 |
PARAMETER | DESCRIPTION | REQUIRED | EXAMPLE |
---|---|---|---|
license_plate | License plate number | Yes | S8TAN |
state_code | State code | Yes | AL |
mileage | The current mileage of the vehicle (if not specified, average mileage is used) | (optional) | 90000 |
period | Number of days to look back for sales data (max: 365) | (optional) | 90 |
Response attributes:
PARAMETER | DESCRIPTION | EXAMPLE |
---|---|---|
success | Whether market value data has been retrieved | true |
vehicle | The vehicle title (Make, Model, Year, Trim) | 2018 BMW X5 XDrive35i |
mileage | The mileage used to compute the market value | 40476 |
count | The number of data points used for estimate | 8862 |
average_market_price | The estimate average market price | 42664.68 |
standard_deviation | Standard deviation of prices | 5872 |
statistical_confidence | The statistical confidence in the market value | 99% |
sales_period | The date range of the historical sales data used | [“2021-05-03″,”2023-04-18”] |
prices | The estimated average market, below market, and above market prices | {“average”:42664.68, “below”:36792.32, “above”:48537.04} |
Success
{
"service": "vmv",
"date": "05/19/2023 01:18:37 AM",
"vin": "5UXKR0C58JL074657",
"status": "SUCCESS",
"vehicle": "2018 BMW X5 XDrive35i",
"mileage": 40476,
"count": 8862,
"average_market_price": 42664.68,
"market_prices": {
"average": 42664.68,
"below": 36792.32,
"above": 48537.04,
"distribution": [
{
"group": {
"min": 21980,
"max": 34855,
"count": 887
}
},
{
"group": {
"min": 34855,
"max": 37998,
"count": 886
}
},
{
"group": {
"min": 37998,
"max": 39997,
"count": 886
}
},
{
"group": {
"min": 39997,
"max": 41980,
"count": 886
}
},
{
"group": {
"min": 41980,
"max": 43288,
"count": 887
}
},
{
"group": {
"min": 43288,
"max": 44501,
"count": 886
}
},
{
"group": {
"min": 44501,
"max": 45835,
"count": 886
}
},
{
"group": {
"min": 45835,
"max": 46995,
"count": 886
}
},
{
"group": {
"min": 46995,
"max": 49352,
"count": 886
}
},
{
"group": {
"min": 49352,
"max": 64235,
"count": 886
}
}
]
},
"standard_deviation": 5872,
"sales_period": [
"2021-05-03",
"2023-04-18"
],
"adjustments": {
"mileage": {
"average": 40476.49,
"input": 40476.49,
"adjustment": 0
}
},
"statistical_confidence": "99%"
}
Failed
{
"service": "vmv",
"date": "05/19/2023 01:50:38 AM",
"vin": "5UXKR0C58JL07465",
"code": "400",
"status": "FAILED",
"message": "invalid vin."
}