The Vehicle Search API allows you to search for matching vehicles by plain-text input. The API will return an array of vehicles and the confidence score in a match for that given vehicle.
The request requires a region, search string & API key. The default page length is 10, however, you can adjust this based on your requirements.
Example
/v2/vehicles?region=au&search=2019 Volkswagen Polo S
Example Payload
{"success":true,"vehicles": [ {"id":"4678970977026048","legacy_id":"4678970977026048","badge":"GTI","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo GTI AW Auto MY19","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":1984,"power_kw":147,"torque_nm":320,"range":784,"num_cylinders":4,"num_doors":5,"num_gears":6,"num_seats":5,"model_year":"MY19","release_month":8,"release_year":2018 }, {"id":"4960445953736704","legacy_id":"4960445953736704","badge":"70TSI Trendline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 70TSI Trendline AW Manual MY19","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Manual","wheelbase_type":null,"capacity_cc":999,"power_kw":70,"torque_nm":175,"range":1000,"num_cylinders":3,"num_doors":5,"num_gears":5,"num_seats":5,"model_year":"MY19","release_month":8,"release_year":2018 }, {"id":"5241920930447360","legacy_id":"5241920930447360","badge":"85TSI Comfortline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 85TSI Comfortline AW Manual MY19","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Manual","wheelbase_type":null,"capacity_cc":999,"power_kw":85,"torque_nm":200,"range":909,"num_cylinders":3,"num_doors":5,"num_gears":6,"num_seats":5,"model_year":"MY19","release_month":8,"release_year":2018 }, {"id":"5804870883868672","legacy_id":"5804870883868672","badge":"85TSI Comfortline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 85TSI Comfortline AW Auto MY19","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":999,"power_kw":85,"torque_nm":200,"range":909,"num_cylinders":3,"num_doors":5,"num_gears":7,"num_seats":5,"model_year":"MY19","release_month":8,"release_year":2018 }, {"id":"6367820837289984","legacy_id":"6367820837289984","badge":"70TSI Trendline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 70TSI Trendline AW Auto MY19","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":999,"power_kw":70,"torque_nm":175,"range":930,"num_cylinders":3,"num_doors":5,"num_gears":7,"num_seats":5,"model_year":"MY19","release_month":8,"release_year":2018 }, {"id":"4936256697925632","legacy_id":"4936256697925632","badge":"85TSI Comfortline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 85TSI Comfortline AW Auto MY20","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":999,"power_kw":85,"torque_nm":200,"range":889,"num_cylinders":3,"num_doors":5,"num_gears":7,"num_seats":5,"model_year":"MY20","release_month":7,"release_year":2019 }, {"id":"5217731674636288","legacy_id":"5217731674636288","badge":"85TSI Style","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 85TSI Style AW Auto MY20","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":999,"power_kw":85,"torque_nm":200,"range":889,"num_cylinders":3,"num_doors":5,"num_gears":7,"num_seats":5,"model_year":"MY20","release_month":7,"release_year":2019 }, {"id":"5499206651346944","legacy_id":"5499206651346944","badge":"70TSI Trendline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 70TSI Trendline AW Auto MY20","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":999,"power_kw":70,"torque_nm":175,"range":909,"num_cylinders":3,"num_doors":5,"num_gears":7,"num_seats":5,"model_year":"MY20","release_month":7,"release_year":2019 }, {"id":"6062156604768256","legacy_id":"6062156604768256","badge":"85TSI Comfortline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 85TSI Comfortline AW Manual MY20","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Manual","wheelbase_type":null,"capacity_cc":999,"power_kw":85,"torque_nm":200,"range":909,"num_cylinders":3,"num_doors":5,"num_gears":6,"num_seats":5,"model_year":"MY20","release_month":7,"release_year":2019 }, {"id":"6343631581478912","legacy_id":"6343631581478912","badge":"GTI","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo GTI AW Auto MY20","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Automatic","wheelbase_type":null,"capacity_cc":1984,"power_kw":147,"torque_nm":320,"range":784,"num_cylinders":4,"num_doors":5,"num_gears":6,"num_seats":5,"model_year":"MY20","release_month":7,"release_year":2019 }, {"id":"6625106558189568","legacy_id":"6625106558189568","badge":"70TSI Trendline","make":"Volkswagen","model":"Polo","series":"AW","title":"2019 Volkswagen Polo 70TSI Trendline AW Manual MY20","year":"2019","body_config_type":null,"body_type":"Hatchback","drive_type":"Front Wheel Drive","engine_type":"Piston","fuel_type":"Petrol","transmission_type":"Manual","wheelbase_type":null,"capacity_cc":999,"power_kw":70,"torque_nm":175,"range":976,"num_cylinders":3,"num_doors":5,"num_gears":5,"num_seats":5,"model_year":"MY20","release_month":7,"release_year":2019 } ],"total":11,"confidence":"standard"}
Search for a vehicle with a query string
Search for a vehicle with a query string
GET/v2/vehicles/
Authorization
Query parameters
search*string
The query by which to search the cars
countnumber
The number of vehicles to be returned
prefer_more_resultsboolean
If enabled, a larger selection of vehicles may be returned and a manual selection would be required to select the correct vehicle. This is disabled by default in favor of a system which will infer the correct vehicle and order the results by likelihood of behind correct.
regionenum
The region to perform this request in
aunzukmy
reference_idstring
An optional reference id which will be stored against usage records if supplied
Response
Success
Body
successboolean
vehiclesarray of object
idstring
titlestring
yearnumber
makestring
modelstring
badgestring
seriesstring
model_yearstring
release_monthnumber
release_yearnumber
body_typestring
The generic body shape of the vehicle (e.g. Sedan, SUV, etc...)
body_configstring
The body config/cab type of the vehicle (e.g. Dual Cab, Single Cab, etc...)
transmissionstring
The specific transmission type used in the vehicle
transmission_typestring
The generic transmission type (e.g. Automatic, Manual)
wheelbasestring
The same value as wheelbase_type, provided for backwards compatability
wheelbase_typestring
The generic wheelbase type of the vehicle (e.g. SWB, LWB)
fuelstring
The same value as fuel_type, provided for backwards compatability
fuel_typestring
The generic fuel type of the vehicle (e.g. Petrol, Diesel, Electric, etc...)
enginestring
The same value as engine_type, provided for backwards compatability
engine_typestring
The generic engine type of the vehicle (e.g. Piston, Rotary, etc...)
drivestring
The specific drive type of the vehicle (e.g. 4x4 Dual Range, FWD, AWD, etc...)
drive_typestring
The generic drive type of the vehicle (e.g. Four Wheel Drive, Front Wheel Drive)
num_doorsnumber
num_seatsnumber
num_gearsnumber
num_cylindersnumber
capacity_ccnumber
power_kwnumber
torque_nmnumber
rangenumber
totalnumber
confidenceenum
The confidence that the vehicle list represents the same vehicle that was described in the input. If this is "reduced", there may be discrepancies in vehicle properties such as fuel type, transmission type, or body type. We recommended displaying a warning on your frontend if a "reduced" quality match is returned.