LogoLogo
API StatusSupportPostmanContact Us
๐Ÿ‡ฒ๐Ÿ‡พ MY AutoGrab API Doc
๐Ÿ‡ฒ๐Ÿ‡พ MY AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • API Test Cases
    • FAQ
  • Authentication
    • API Key
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • Registration Plate Search
    • Facet Search
    • Vehicle ID Search
    • Marketplace ID Lookup
  • Sourcing
    • Sourcing Basics
    • Market Overlay
    • Market Statistics
    • Stock Feeds
  • Vehicle Data
    • Vehicle Data Basics
    • Detailed Specifications Data
    • Vehicle History
    • Factory Build Data
  • Valuation
    • Valuation Basics
    • Valuation Predict
    • Residual Valuations
    • Max Offer Configuration
    • Gauge API
  • Embeddable Products
    • Embeddable Basics
    • Gauge Widget
    • Valuation Widget
    • Market Overlay Widget
  • REPORTS
    • Car Analysis
    • Certificates
  • Customer Recapture
    • Customer Recapture API
    • Webhooks
  • Insurance
    • Pre-Accident Valuation
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 ยฉ AutoGrab Pty Ltd. ABN 79 638 468 569

On this page

Was this helpful?

Export as PDF
  1. Vehicle Search

Registration Plate Search

Find vehicle information from a registration plate.

PreviousPlain-text SearchNextFacet Search

Last updated 3 months ago

Was this helpful?

Overview

The Vehicle Registration API allows you to search for a vehicle by supplying its number plate. The request requires a region, the state (dependent on region), the number plate, and the API key. It will return either a matching vehicle or a null.

If a matching vehicle cannot be identified in all cases, we will return the upstream_vehicle field, allowing you to identify how the relevant road transport authority describes the car. Depending on your use case, you may wish to allow front-end users to manually classify the vehicle using the guide to fill out a Facet-style.

Features

You can request more data than the standard payload by leveraging a range of features described below.

Ensure your commercial agreement has these features enabled if you require them.

Extended Data

This feature will return an extended payload of vehicle data from the registration authority. Use features=extended_data to receive this payload.

   "extended_data": {
        "body_type_description": "CAR/SEDAN",
        "color_description": "WHITE",
        "engine_number": "DKJ039523",
        "make_code": "VOLKS",
        "make_description": "",
        "model_code": "",
        "model_description": "POLO",
        "vehicle_type_description": "CAR / SMALL PASSENGER VEHICLE"

Upstream Data

This feature will return structured descriptive data from the registration authority. Use features=additional_upstream_data to receive this payload.

    "additional_upstream_data": {
        "vin": "WVWZZZAWZKU065305",
        "year": "2019",
        "make": "Volkswagen",
        "model": "Polo",
        "badge": "AW",
        "series": "85TSI Comfortline",
        "fuel_type": "95 RON PULP",
        "body_style": "Hatch",
        "transmission": "7 auto",
        "capacity_cc": "1000",
        "colour": "White",
        "title": "2019 Volkswagen AW Polo 85TSI Comfortline 4 Hatch 7sp auto 1.0L 1000cc 3cyl T/Petrol 2018"

Build Data

"build_data": {
        "vin": "WAUZZZ8V7K1028938",
        "make": "AUDI",
        "model": "A3",
        "features": [
            {
                "code": "0A1",
                "value": "2 doors"
            },
            {
                "code": "0AE",
                "value": "Front stabilizer bar"
            },
            {
                "code": "0B2",
                "value": "Wheelbase"
            },
        ],
        "build_date": "2019-03-20"

This feature will return the options fitted to the vehicle based on your . It will show all options, the price and if it is fitted to the vehicle or not. Usefeatures=build_data

Refer to reference material for more information on supported OEMs.

Factory Build Data
Factory Build Data
search

Get a vehicle by its registration number

get

Get a vehicle by its registration number

Authorizations
Path parameters
plate_numberstringRequired

Plate number of the registered vehicle

Query parameters
statestringOptional

State is used in the AU region to narrow down a numberplate

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.

featuresstringOptional

Comma separated list of additional registration lookup data codes, if using (e.g. additional_upstream_data)

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
400
Bad Request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
get
GET /v2/vehicles/registrations/{plate_number} HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "vehicle": {
    "id": "text",
    "region": "au",
    "title": "text",
    "year": 1,
    "make": "text",
    "model": "text",
    "badge": "text",
    "series": "text",
    "body_type": "text",
    "body_config": "text",
    "transmission": "text",
    "wheelbase": "text",
    "fuel": "text",
    "engine": "text",
    "drive": "text",
    "num_doors": 1
  },
  "upstream_vehicle": "text",
  "confidence": "standard",
  "colour": "text",
  "vin": "text",
  "additional_vehicles": [
    {
      "id": "text",
      "region": "au",
      "title": "text",
      "year": 1,
      "make": "text",
      "model": "text",
      "badge": "text",
      "series": "text",
      "body_type": "text",
      "body_config": "text",
      "transmission": "text",
      "wheelbase": "text",
      "fuel": "text",
      "engine": "text",
      "drive": "text",
      "num_doors": 1
    }
  ],
  "extended_data": null,
  "registration_status": {
    "expiry_date": "text",
    "status": "text"
  },
  "vehicle_age": {
    "compliance_plate": "text",
    "year_of_manufacture": 1
  },
  "writeoff_info": {},
  "build_data": {
    "vin": "text",
    "build_date": "text",
    "make": "text",
    "model": "text",
    "features": [
      {
        "code": "text",
        "value": "text"
      }
    ]
  },
  "odo_history": [
    {
      "read_date": "text",
      "odometer": 1
    }
  ],
  "odo_prediction": {
    "prediction": 1,
    "days_since_read": 1,
    "avg_yearly": 1,
    "avg_daily": 1,
    "ag_market_avg": 1
  },
  "vsrr": {
    "fuel_economy": {
      "star_rating": 1,
      "consumption": 1
    },
    "emissions": {
      "co2": 1,
      "star_rating": 1
    },
    "pollutants": {
      "star_rating": 1,
      "test_regime": "text"
    },
    "safety": {
      "driver": {
        "star_rating": 1,
        "test_regime": "text"
      }
    }
  }
}
  • Overview
  • GETGet a vehicle by its registration number
  • Features
  • Extended Data
  • Upstream Data
  • Build Data