Search Vehicle by Facets

The Vehicle Facets API allows you to narrow down the matching vehicle based on the vehicle's parameters. The facets available are: year, make, model, badge, series, transmission, body, body_style, fuel, engine and wheelbase.

Please note that this API is an exact match search. For clarity this means that a search as follows ("Raptor"):

year=2023&make=Ford&model=Ranger&badge=Raptor

Will not return any results.

However a search as follows ("RAPTOR"):

year=2023&make=Ford&model=Ranger&badge=RAPTOR

Will return a result set.

Subsequently it is important to utilise the Facet Search to identify the appropriate facet descriptors.

Search for a vehicle by facet

get

Search for a vehicle by facet, return matching vehicles

Query parameters

yearstringOptional

The build year of the vehicle

Example: 2009

makestringOptional

The make of the vehicle

Example: Nissan

modelstringOptional

The model of the vehicle

Example: Skyline

badgestringOptional

The badge of the vehicle

Example: 370GT Type SP

seriesstringOptional

The series of the vehicle

Example: V36

transmissionstringOptional

The specific transmission type (e.g. Sports Automatic, Automated Manual, etc...)

Example: Sports Automatic

transmission_typestringOptional

The basic transmission type (i.e. Automatic, Manual or Reduction Gear)

Example: Automatic

body_typestringOptional

The body type of the vehicle (e.g. Hatchback, Sedan, etc...)

Example: Sedan

fuelstringOptional

The fuel type of the vehicle (e.g. Petrol, Diesel, etc...)

Example: Petrol

drivestringOptional

The specific drive type (e.g. AWD, 4WD, 4x4 Dual Range, etc...)

Example: RWD

drive_typestringOptional

The basic drive type of the vehicle (e.g. Front Wheel Drive, Rear Wheel Drive, etc...)

Example: Rear Wheel Drive

limitintegerOptional

The maximum number of results to return per facet query (default: 5)

Example: 5

reference_idstringOptional

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

Example: MY_REFERENCE_123

Responses

200

Vehicle Search Response

application/json

successbooleanOptional

Whether or not the identify new owner transaction was successful

Example: true

totalintegerOptional

Total number of vehicles found matching the search parameter

Example: 10

400

Bad Request / Validation Failed

application/json

404

Resource for id cannot be found

application/json

500

Unknown error on the service side

application/json

get

/v1/vehicles/facets/search

HTTPcURLJavaScriptPython

GET /v1/vehicles/facets/search HTTP/1.1
Accept: */*

{
  "success": true,
  "vehicles": [
    {
      "id": 2983792384791283,
      "region": "au",
      "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,
      "options": []
    }
  ],
  "total": 10
}