Search Vehicle by Plain Text
The Search by Plain Text 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 search string. The default page length is 10, however, you can adjust this based on your requirements.
The API utilises a case insensitive approach to search the string provided. It should be noted however that in order to provide the best possible results, it is important to provide as much information as possible.
For the best results, the minimum requirements are:
Year
Make
Model
Badge
However other aspects that improve the search are:
Fuel type (e.g. Petrol)
Cab type (Dual Cab)
Number of gears (7 Speed)
Search for a vehicle by plain text query string, returns all matching vehicles
The query by which to search for a specific vehicle
2019 Volkswagen Polo SThe number of vehicles to be returned (default:25)
25Vehicle Search Response
Bad Request / Validation Failed
Resource for id cannot be found
Unknown error on the service side
GET /v1/vehicles/search?search=2019+Volkswagen+Polo+S HTTP/1.1
Host:
Accept: */*
{
"success": true,
"vehicles": [
{
"id": 2983792384791283,
"region": "nz",
"title": "2007 Mitsubishi Outlander XLS Automatic",
"year": 2007,
"make": "Mitsubishi",
"model": "Outlander",
"badge": "XLS",
"series": null,
"model_year": null,
"release_month": 1,
"release_year": 2007,
"body_type": "Wagon",
"body_config": null,
"transmission": "Continuously Variable (CVT)",
"transmission_type": "Automatic",
"wheelbase": null,
"wheelbase_type": null,
"fuel": "Petrol",
"fuel_type": "Petrol",
"engine": "Piston",
"engine_type": "Piston",
"drive": "AWD",
"drive_type": "Four Wheel Drive",
"num_doors": 5,
"num_seats": 5,
"num_gears": 6,
"num_cylinders": 4,
"capacity_cc": 2359,
"power_kw": 127,
"torque_nm": 230,
"range": 250
}
],
"total": 10
}Last updated