Power up your marketing with personalised content.
Identify inventory based on a registration mark and budget - to deliver high performing campaigns with personalised selections of vehicles. Suitable for email marketing, renewals and enhanced user experience for apps and websites.
Key Features
VRM-based
Identify suitable vehicles from a registration mark
Drive Campaigns
Identify newer, better vehicles for repeat business
Budget Search
Filter to a budget
Brand Preference
Target specific brands of interest
Location Based
Target vehicles within a postcode radius
600,000+ Vehicles
Live dealer inventory, updated daily
Sample Response
V2
Documentation
Introduction
Allows you to search for suitable replacement vehicles in a geographic radius based on a VRM. Results can be targeted to particular manufacturers or a specific dealer website and vehicles are returned in descending price order
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/inventoryfromvrm?vehicle_registration_mark=AB21ABC&price_to_gbp=12345&post_code=AB1 2CD&radius_miles=12&required_manufacturers=BMW&source_url=dealer_domain.co.uk¤t_mileage=12345&price_from_gbp=12345&advert_qty=20
Example Sandbox Request
https://sandbox.oneautoapi.com/marketcheck/inventoryfromvrm?vehicle_registration_mark=AB21ABC&price_to_gbp=12345&post_code=AB1 2CD&radius_miles=12&required_manufacturers=BMW&source_url=dealer_domain.co.uk¤t_mileage=12345&price_from_gbp=12345&advert_qty=20
Request Parameters
vehicle_registration_mark
mandatory, string, e.g. AB21ABC
Vehicle registration number
price_to_gbp
mandatory, string, e.g. 12345
The maximum price of items returned
post_code
optional, string, e.g. AB1 2CD
Postcode for the area of interest e.g AB1ABC
radius_miles
optional, string, e.g. 12
The maximum distance from the specified postcode
required_manufacturers
optional, string, e.g. BMW
The manufacturer(s) returned within the search
source_url
optional, string, e.g. dealer_domain.co.uk
The source url for a specific dealer
current_mileage
optional, string, e.g. 12345
The current mileage of the vehicle in full
price_from_gbp
mandatory, string, e.g. 12345
The minimum price of items returned
advert_qty
optional, string, e.g. 20
The number of adverts returned per page. Defaults to 50 if not specified
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": "London",
"county": "Lancashire",
"latitude": 123.456789,
"longitude": 345.6789012,
"post_code": "AB1 2CD"
},
"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 2CD",
"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
}
}
],
"more_results": true
},
"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.
advert_id
e.g. X12345
Advert Id
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
seller_type
e.g. dealer
e.g. dealer
ownership_condition
e.g. new
e.g. new or used
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
co2_gkm
e.g. 123
CO2 in g/km
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
city
e.g. London
City
county
e.g. Lancashire
County
latitude
e.g. 123.456789
Latitude
longitude
e.g. 345.6789012
Longitude
post_code
e.g. AB1 2CD
The location of the stock vehicle used as the centre of the search.
dealer_id
e.g. X12345
Dealer Id
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
city
e.g. London
City
country
e.g. England
Country
latitude
e.g. 123.456789
Latitude
longitude
e.g. 345.6789012
Longitude
post_code
e.g. AB1 2CD
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
asset_type
e.g. Car
The asset type.
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_doors
e.g. 5
Number of doors.
number_cylinders
e.g. 4
Number of cylinders within the engine.
number_seats
e.g. 4
Number of seats.
more_results
e.g. true
The total number of adverts that can be returned.
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