Introduction
This endpoint provides additional insight into local market competition based on a VRM. It includes advertised prices, seller and vehicle details page links for similar vehicles currently available for sale.
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/similarlistingsfromvrm?vehicle_registration_mark=AB21ABC&radius_miles=12&post_code=AB1 2BC&number_items=12&price_from_gbp=12345&price_to_gbp=12345&mileage_observed_from=12345&mileage_observed_to=12345&match=first_registration_year
Example Sandbox Request
https://sandbox.oneautoapi.com/marketcheck/similarlistingsfromvrm?vehicle_registration_mark=AB21ABC&radius_miles=12&post_code=AB1 2BC&number_items=12&price_from_gbp=12345&price_to_gbp=12345&mileage_observed_from=12345&mileage_observed_to=12345&match=first_registration_year
Request Parameters
vehicle_registration_mark
mandatory, string, e.g. AB21ABC
Vehicle registration number
radius_miles
mandatory, string, e.g. 12
The distance from the location specified by postcode within which adverts should be returned
post_code
mandatory, string, e.g. AB1 2BC
The location of the stock vehicle used as the centre of the search
number_items
optional, string, e.g. 12
The number of items you want returned (limited to a maximum of 25)
price_from_gbp
optional, string, e.g. 12345
The minimum price of items returned
price_to_gbp
optional, string, e.g. 12345
The maximum price of items returned
mileage_observed_from
optional, string, e.g. 12345
The minimum (observed) miles for the items returned
mileage_observed_to
optional, string, e.g. 12345
The maximum (observed) miles for the items returned
match
optional, string, e.g. first_registration_year
When used, will return advertised vehicles matching the specified parameters (first_registration_year, manufacturer_desc, model_desc, variant_desc). All 4 parameters will be applied when match= is not used.
Sample Response
{
"success": true,
"result": {
"advert_qty": 1,
"advert_list": [
{
"advert_id": "X12345",
"vehicle_registration_mark": "AB12ABC",
"distance_miles": 123,
"advert_heading": "Advert heading",
"advertised_price_gbp": 12345.67,
"price_change_percentage": 12.3,
"mileage_observed": 12345,
"vehicle_details_page_url": "http://www.advert.com/advert=12345",
"colour": "blue",
"days_on_market": 123,
"seller_type": "dealer",
"ownership_condition": "new",
"last_seen_date": "2023-02-21",
"first_seen_date": "2023-01-15",
"first_seen_at_source_date": "2022-12-04",
"source_url": "http://www.advert.com",
"co2_gkm": 123,
"number_previous_keepers": 1,
"insurance_group": "8E",
"vehicle_location_details": {
"seller_name": "ACME Motors",
"street": "123 Fake Street",
"city": "York",
"county": "North Yorkshire",
"latitude": 123.456789,
"longitude": 345.6789012,
"post_code": "AB1 2BC"
},
"image_links": [
"http://www.image.com/image=1"
],
"dealer_details": {
"dealer_id": "X12345",
"dealer_name": "ACME Motors",
"website_url": "http://www.acme-motors.com",
"street": "123 Fake Street",
"city": "London",
"country": "England",
"latitude": 123.456789,
"longitude": 345.6789012,
"post_code": "AB1 2BC",
"phone_number": "01234 567890",
"email_address": "hello@acme-motors.com"
},
"vehicle_data": {
"first_registration_year": 2020,
"manufacturer_desc": "Mini",
"model_range_desc": "Cooper",
"trim_desc": "Clubman",
"variant_desc": "5 door auto",
"body_type_desc": "Estate",
"asset_type": "Car",
"transmission_desc": "Automatic",
"drivetrain_desc": "Front wheel drive",
"fuel_type_desc": "Petrol",
"engine_data": "1197cc, 69 HP, 75",
"engine_badged_power": 1.6,
"number_doors": 5,
"number_cylinders": 4,
"number_seats": 4,
"aspiration": "Naturally aspirated"
}
}
]
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
advert_qty
e.g. 1
Number of adverts matching the query parameters.
vehicle_registration_mark
e.g. AB12ABC
Vehicle registration number (VRM).
distance_miles
e.g. 123
The distance from the specified postcode of the car location. Returns null when no postcode is specified
advert_heading
e.g. Advert heading
Advert heading
advertised_price_gbp
e.g. 12345.67
Advertised vehicle price
price_change_percentage
e.g. 12.3
Price change in % since vehicle was last scraped with the same dealer
mileage_observed
e.g. 12345
Vehicle odometer reading
vehicle_details_page_url
e.g. http://www.advert.com/advert=12345
Url to the vehicle on the source website
colour
e.g. blue
Exterior colour of vehicle.
days_on_market
e.g. 123
The number of days for the current listing
last_seen_date
e.g. 2023-02-21
Last seen date for the current listing
first_seen_date
e.g. 2023-01-15
First seen date for the current listing
first_seen_at_source_date
e.g. 2022-12-04
This could be earlier than first seen at date if the vehicle was previously listed (removed for min 5 days)
source_url
e.g. http://www.advert.com
Website address
number_previous_keepers
e.g. 1
Number of previous keepers.
insurance_group
e.g. 8E
Vehicle insurance group
seller_name
e.g. ACME Motors
Seller name
street
e.g. 123 Fake Street
Street
county
e.g. North Yorkshire
County
longitude
e.g. 345.6789012
Longitude
post_code
e.g. AB1 2BC
The location of the stock vehicle used as the centre of the search.
dealer_name
e.g. ACME Motors
Dealer Name
website_url
e.g. http://www.acme-motors.com
Website URL.
street
e.g. 123 Fake Street
Street
longitude
e.g. 345.6789012
Longitude
post_code
e.g. AB1 2BC
The location of the stock vehicle used as the centre of the search.
phone_number
e.g. 01234 567890
Telephone number
email_address
e.g. hello@acme-motors.com
Email address
first_registration_year
e.g. 2020
Year of registration
manufacturer_desc
e.g. Mini
Manufacturer description
model_range_desc
e.g. Cooper
Model range description.
trim_desc
e.g. Clubman
Trim description
variant_desc
e.g. 5 door auto
Variant description
body_type_desc
e.g. Estate
The body type description
transmission_desc
e.g. Automatic
The vehicle's transmission type
drivetrain_desc
e.g. Front wheel drive
Drivetrain
fuel_type_desc
e.g. Petrol
The vehicle's fuel type description
engine_data
e.g. 1197cc, 69 HP, 75
Engine data
engine_badged_power
e.g. 1.6
Badged engine size
number_cylinders
e.g. 4
Number of cylinders within the engine.
aspiration
e.g. Naturally aspirated
Engines aspiration description.
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