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.

Example

/v2/vehicles?region=nz&search=2019 Volkswagen Polo S

Example Payload

{
    "success": true,
    "vehicles": [
        {
            "id": "4664292750131200",
            "legacy_id": "4664292750131200",
            "badge": "TSI",
            "make": "Volkswagen",
            "model": "Polo",
            "series": null,
            "title": "2019 Volkswagen Polo TSI Manual",
            "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": null,
            "num_cylinders": 3,
            "num_doors": 5,
            "num_gears": 5,
            "num_seats": 5,
            "model_year": "MY19",
            "release_month": 7,
            "release_year": 2019
        },
        {
            "id": "4814155836030976",
            "legacy_id": "4814155836030976",
            "badge": "TSI",
            "make": "Volkswagen",
            "model": "Polo",
            "series": null,
            "title": "2019 Volkswagen Polo TSI Automatic",
            "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": null,
            "num_cylinders": 3,
            "num_doors": 5,
            "num_gears": 7,
            "num_seats": 5,
            "model_year": "MY19",
            "release_month": 1,
            "release_year": 2019
        },
        {
            "id": "5855535618326528",
            "legacy_id": "5855535618326528",
            "badge": "TSI",
            "make": "Volkswagen",
            "model": "Polo",
            "series": null,
            "title": "2019 Volkswagen Polo TSI Automatic",
            "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": null,
            "num_cylinders": 3,
            "num_doors": 5,
            "num_gears": 7,
            "num_seats": 5,
            "model_year": "MY20",
            "release_month": 10,
            "release_year": 2019
        },
        {
            "id": "5958589734715392",
            "legacy_id": "5958589734715392",
            "badge": "TSI",
            "make": "Volkswagen",
            "model": "Polo",
            "series": null,
            "title": "2019 Volkswagen Polo TSI Manual",
            "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": null,
            "num_cylinders": 3,
            "num_doors": 5,
            "num_gears": 5,
            "num_seats": 5,
            "model_year": "MY20",
            "release_month": 10,
            "release_year": 2019
        }
    ],
    "total": 4,
    "confidence": "standard"
}