Plain-text Search
Get results with a text string search
Last updated
Was this helpful?
🇬🇧 UK AutoGrab API Doc
Get results with a text string search
Last updated
Was this helpful?
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.
/v2/vehicles?region=uk&search=2019 Volkswagen Polo SExample 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
The query by which to search the cars
The number of vehicles to be returned
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.
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
GET /v2/vehicles/ HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Accept: */*
{
"success": true,
"vehicles": [
{
"id": "text",
"title": "text",
"year": 1,
"make": "text",
"model": "text",
"badge": "text",
"series": "text",
"model_year": "text",
"release_month": 1,
"release_year": 1,
"body_type": "text",
"body_config": "text",
"transmission": "text",
"transmission_type": "text",
"wheelbase": "text",
"wheelbase_type": "text",
"fuel": "text",
"fuel_type": "text",
"engine": "text",
"engine_type": "text",
"drive": "text",
"drive_type": "text",
"num_doors": 1,
"num_seats": 1,
"num_gears": 1,
"num_cylinders": 1,
"capacity_cc": 1,
"power_kw": 1,
"torque_nm": 1,
"range": 1
}
],
"total": 1,
"confidence": "standard"
}