Introduction
This endpoint provides national and local views of fair market value based on competitor vehicle listings and includes stats on days to sold.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/marketcheck/fairmarketvaluefromvrm?vehicle_registration_mark=AB21ABC¤t_mileage=12345&post_code=AB1ABC&radius_miles=30* If not supplied a default radius of 75 miles will be used.
Example Sandbox Request
https://sandbox.oneautoapi.com/marketcheck/fairmarketvaluefromvrm?vehicle_registration_mark=AB21ABC¤t_mileage=12345&post_code=AB1ABC&radius_miles=30* If not supplied a default radius of 75 miles will be used.
Request Parameters
vehicle_registration_mark
mandatory, string, e.g. AB21ABC
Vehicle registration number
current_mileage
mandatory, string, e.g. 12345
The current odometer reading of the vehicle
post_code
mandatory, string, e.g. AB1ABC
The location of the stock vehicle used as the centre of the search
radius_miles
optional, string, e.g. 30* If not supplied a default radius of 75 miles will be used.
The radius used to calculate the fair market value (between 25-100 miles)*
Sample Response
{
"success": true,
"result": {
"local_fair_market_value": 26754,
"national_fair_market_value": 26722,
"local_average_days_to_sold": 49,
"national_average_days_to_sold": 66
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
local_fair_market_value
e.g. 26754
The fair market value of the vehicle based on the post code and radius specified.
national_fair_market_value
e.g. 26722
The national fair market value of the vehicle.
local_average_days_to_sold
e.g. 49
The average days to sold based on the post code and radius specified
national_average_days_to_sold
e.g. 66
The national average days to sold.
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com
