Plain-text Search

Get results with a text string search

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.

Search for a vehicle with a query string

get

Search for a vehicle with a query string

Authorizations
ApiKeystringRequired
Query parameters
searchstringRequired

The query by which to search the cars

countnumber · max: 100Optional

The number of vehicles to be returned

prefer_more_resultsbooleanOptional

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.

regionstring · enumOptional

The region to perform this request in

Possible values:
reference_idstringOptional

An optional reference id which will be stored against usage records if supplied

Responses
200

Success

application/json
Responseall of
get
/v2/vehicles/

Example

Example Payload

PreviousVehicle Searching BasicsNextVRM Search

Last updated

Was this helpful?