Ctrlk
API StatusSupportPostmanContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
successbooleanOptionalDefault: true
totalnumberOptional
confidencestring · enumOptional

The confidence that the vehicle list represents the same vehicle that was described in the input. If this is "reduced", there may be discrepancies in vehicle properties such as fuel type, transmission type, or body type. We recommended displaying a warning on your frontend if a "reduced" quality match is returned.

Possible values:
get/v2/vehicles/
GET /v2/vehicles/?search=text 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"
}

Example

Example Payload

PreviousVehicle Searching BasicsNextRegistration Plate Search

Was this helpful?