You can explore our endpoints by searching or asking questions through the AI-powered doc system. See what product fits your user case by clicking a top-level grouping below.

Overview

Our API uses the OpenAPI 2.0 specification, making it easy for our partners to integrate. We want to ensure the best possible experience when integrating with our stack.

Environments

Regions

Certain API endpoints require that a region be passed as part of the request URL. Where necessary it is expected that region=au be included where region is required.

For example: https://api.autograb.com.au/v2/vehicle/239c8928fnc934fc?region=au

Supported Regions

API Keys

Your account manager will provision API keys for your account. If you require a key to be revoked please get in touch with your account manager.

Quota Limits

APIs have soft quota limits that are enforced based on your contract agreement. To discuss these limits please get in touch with your account manager.

Rate Limiting

We strictly monitor the number of requests per second — if you exceed your allocation the API will respond with HTTP 429 Too Many Requests. We will also return additional headers to help you better understand when rate limits will be applied.

The limits are applied per API product and are decided based on your contract agreement. Rate limits do not relate to quotas.

Key Types

Secret API Key

A secret API key is for the server side and should not be shared with the front end.

Example Key: sec_23hcfb8374bfhc833i4uhx

Public API Key

Your website uses a public API key to call the API. These keys are limited to your domain and are safe to share publicly.

Example Key: pub_3ficuhb34u8fnxu34h9fm

Authenticating Requests

All requests to our APIs must include an ApiKey header for authentication.

Include your API key in the request headers as shown below:

Other Authentication Methods

We also support , and you can read more about this authentication mechanism here.

To retrieve the registration status & write-off information for a given vehicle, you can call the status endpoint.

Australia

In Australia, merely call the /v2/vehicles/{number_plate}/status endpoint with region=au. You must send the state in its short format, you can use the long format for front-end purposes if you require. Refer to the Australian state table under the Registration Search heading in this guide for a list.

The Upstream API allows you to search for registration authority information by registration plate or VIN. You will receive back what the vehicle is registered as with varying structured data that the authority holds.

You can request information on anything with a registration plate, which means motorbikes, caravans, trucks and so on.

Importantly you will not receive a vehicle ID with these responses as we only maintain a catalogue for passenger vehicles. We are unable to match other vehicles like motorbikes or heavy trucks and are therefore unable to provide additional functions like valuation.

The request requires only a region, vin or registration plate and state plus an API key.

Example

Overview

The Market Overlay Statistics API delivers statistics we generate on your behalf from the Market Overlay endpoint.

As this endpoint is part of the market overlay route you can enhance your payload with additional features. Refer to the features on the market overlay to see what's available.

The Residual Value prediction API uses current market trends to influence the depreciation curve of newer vehicles. The API allows you to influence the outcome of the prediction by either mutating stored Recommended Retail Price or by providing your own Retail Value for the car.

Overview

In a scenario where you want to understand the vehicle ID or data on listed vehicles, you can use the marketplace search system.

Prerequisites to access.

1. To be approved to access this special use case endpoint, contact your account manager.

The Sourcing API set allows you to find listing data for comparative and market insights. This API requires and an appropriate license attached to it.

The external_dms_id to use with the external enquiry endpoint will be provided by AutoGrab, if you do not currently have an ID please reach out to AutoGrab to obtain one.

Creating a stock feed

Your organisation will need at least one stock feed before uploading stock to the platform.

To create a stock feed, make a single POST request to the following Autograb API:

POST /v2/stock?region=au

If you know a vehicles ID already and would like summary data you can leverage a basic vehicle search.

Example Response

OAuth will only work for agreed AutoGrab api_v2 REST endpoints where an ApiKey has already been provisioned.

OAuth integration consists of 2 basic components:

1. Token management (ensure your system always has a valid OAuth token available)

2. REST api call signing using a valid token

The create insurance claim endpoint triggers the generation of a PAV assessment in the AutoGrab PAV tool, which can then be accessed via the UI.

This allows for external systems to automate the generation of the PAV assessment for a user to then access later by a direct URL using the Claim ID

Access PAV via URL

Once a PAV is successfully generated, you can generate a URL to access the PAV assessment via AutoGrabs front end using the following format:

This allows for use cases such as adding a button on a UI that can auto redirect a user to the AutoGrab PAV platform to quickly access the specific PAV assessment.

You can use our test cases to confirm your implementation on our production endpoints. All requests using these values are not billable.

Test Cases

Refer below to set of test cases. They are all linked and refer back to the same vehicle IDs

Supported Endpoints

Test cases are supported across a range of API endpoints listed below. If the endpoint you are testing with is not listed get in touch to request test data.

• /valuations/predict

• /valuations/vins

• /valuations/registrations

Implementation Guide

An example implementation could run a test as part of an integration test or development process. For example, you could test a valuation flow by first using a registration plate to get the ID (which is also test data) and send that to a /predict to get a valuation and a market overlay.

AutoGrab’s confidence score is derived from a statistical process that reflects how confident the valuation model is in its predicted value. The score ranges between 0 and 1, where higher values indicate stronger confidence in the accuracy of the prediction, and lower values suggest greater uncertainty.

Interpreting the Confidence Score

• High Confidence (e.g., >0.8): The valuation model is highly certain about the estimated retail value, supported by a large dataset and strong model accuracy.

• Medium Confidence (e.g., 0.5–0.8): The prediction is reasonable but may require additional validation due to a smaller sample size or price volatility.

• Low Confidence (e.g., <0.5): The prediction is uncertain, often due to limited data availability or high market volatility.

Factors Affecting Confidence Scores

• Data Quality and Availability:

  • High-quality, complete data for a vehicle variant increases the confidence score.

  • Listings with poor data quality (e.g., missing mileage, unknown price) are excluded from AutoGrab’s valuation model.

• Model Fit:

Applications of Confidence Scores

• Informed Decision-Making: AutoGrab’s confidence score helps customers determine whether additional inspection or pricing validation is needed before acquiring a vehicle.

• Risk Mitigation: A low confidence score highlights higher risks, enabling AutoGrab’s customers to approach vehicle transactions with caution and avoid potential losses.

• Enhanced Transparency: Including confidence scores alongside valuations enhances trust and confidence with AutoGrab’s clients, allowing them to assess the reliability of predictions.

This framework ensures AutoGrab provides reliable valuations while highlighting areas that may require further analysis.

The AutoGrab AutoGauge is an endpoint that delivers market benchmarking information with inputs of listing information. It supports a range of inputs depending on your use case.

Using /v2/valuations/gauge/ you can generate responses to make your own AutoGauges. The post body you use depends on the data you have and the commercial model you are open to.

Example Post Body

The body of the request can accept a range of inputs depending on your listing data. All available inputs are below.

The response for this request is below. The AutoGauge can be presented with a broad range of vehicle identifiers and will consider them dependent on your commercial agreement. In the scenario above, the AutoGrab ID was presented and used, and all other inputs were supplied as backups.

Use Case Driven Implementation Examples

Marketplace Implementation

If you are a marketplace you will store your own marketplace IDs against each listing. You can submit those via the request body to produce an AutoGauge response.

Dealer Website Implementation (AutoGrab Customer)

As a customer with an existing AutoGrab API integration, you will likely have stored the AutoGrab IDs from vehicle search steps you've previously taken. In this case supply your known vehicle_id as part of the request. This is the lowest-cost implementation as it does not require a VIN or Registration search.

Dealer Website Implementation (Non-Direct Customer)

As an app or new customer, you may only have the VIN and registration information for your vehicles. You can pass them into the request body as below.

Overview

The widget can capture leads by auto-filling vehicle information, asking key questions and making a conditional offer informed by your preset valuation strategy.

It is highly customisable to your dealership brand or corporate imagery requirements, feeling at home on your existing website.

The resulting leads are deployed over email or select LMS providers depending on your region.

Example Implementations

You can find an example of the valuation widget operating on the. For a more brand / corporate imagery-compliant implementation refer to

Implementation

Speak to your sales rep about your desired implementation pattern. We will supply you with staging and production iFrame url code as part of your deployment process.

Position On Page

You have two options to embed the iframe inside your website. In both these options, it is critical that you set the iframe width to 650px and centred.

Popup - holding the iframe in a popup container and ensuring you conform to the AUTOGRAB_VALUATION_HIDE to event listening to close the popup container and AUTOGRAB_VALUATION_DIMENSIONS resize the height dynamically.

On Page - holding the iframe on a page ensuring you let us know so we can remove the close button. Since the page can still extend vertically you need to respond to the AUTOGRAB_VALUATION_DIMENSIONS alert.

Event Listeners

The valuation widget will send messages you need to pay attention to via the iframe postMessage function. The messages are as follows.

AUTOGRAB_VALUATION_SUCCESS

The widget loaded successfully, no intervention is needed.

AUTOGRAB_VALUATION_ERROR

There was an exception or error delivering the iframe contents.

AUTOGRAB_VALUATION_HIDE

The close button at the end of the workflow or close X in the interface has been pressed.

AUTOGRAB_VALUATION_DIMENSIONS

The iframe has resized due to changed in the contents. Please respond by resizing the iframe container to hold the new contents without cropping.

AUTOGRAB_VALUATION_COMPLETE

The valuation widget has created a lead. Monitor this event with your analytics product to denote a successful lead conversion.

The Valuation API set allows you to predict current and future prices on vehicles. This API requires authentication and an appropriate license attached to it.

The Vehicle Data API set allows you to find descriptive information on a vehicle at the level of granularity you require. This API requires authentication and an appropriate license attached to it.

The Vehicle Search API set allows you to find matching vehicles within our database. This API requires and an appropriate license attached to it.

Overview

To request an extensive factory build data list call the /build-data endpoint. If the relevant manufacturer is participating in our Options data product you will see it in the response.

If we are unable to provide build information for the requested VIN we will return an error like this.

If you are not using a valid VIN we will respond with this.

Overview

The Personal Property Securities Register (PPSR) is a national online register managed by the federal government. Individuals and organisations can use the PPSR to register and search for debts and other security interests in personal property such as cars, boats and artworks.

In our context you are able to generate a standard report by sending the following params to the certificates endpoint.

The response will contain structured information about the certificate as well as the PDF itself under the URL parameter.

If you wish to view an example PPSR you can find one below.

AutoGrab hosts a range of embeddable products you can use to rapidly deploy solutions to the market to engage new customers and delight existing ones.

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 search.

Features

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

Extended Data

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

Upstream Data

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

Vehicle Age

This feature will return structured data on the age of a vehicle from the registration authority. Use features=vehicle_age to receive this payload.

Writeoff Information

This feature will return information about the write-off status of a vehicle. Use features=writeoff_info

Registration Status

This feature will return information about the registration status of a vehicle. Use features=registration_status

Build Data

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

The State Parameter

This is a required parameter for the region. You must send the state in its short format; you can use the extended format for front-end purposes if necessary.

Overview

The widget can show regionalised market insights based on input vehicles. It is customisable to your brand via a hero brand icon. The resulting market information can help your customers understand the market reception to a given vehicle.

Implementation

Speak to your sales rep about your desired implementation pattern. We will supply you with staging and production iFrame url code as part of your deployment process.

Implementation of the trigger to present this iframe is the responsibility of the site owner.

There are two options for the implementation of the overlay:

• Auto-Search

  • By providing a stringified vehicle description, AutoGrab will automatically match the vehicle based on the description and value based on the odometer provided when triggering the overlay widget. If the vehicle is incorrect, the user can override it.

• Manual Selection

Example Auto Search Implementation Inputs

To load the iframe where an attempt will be made to identify if, the vehicle description and odo will need to be provided:

Example Implementation iFrame

Example UI

Position On Page

You have two options to embed the iframe inside your website. In both these options, it is critical that you set the iframe width to 650px and centered.

Popup - holding the iframe in a popup container and ensuring you conform to the AUTOGRAB_INSIGHTS_HIDE to event listening to close the popup container and AUTOGRAB_INSIGHTS_DIMENSIONS resize the height dynamically.

On Page - holding the iframe on a page ensuring you let us know so we can remove the close button. Since the page can still extend vertically you need to respond to the AUTOGRAB_INSIGHTS_DIMENSIONS alert.

Event Listeners

The valuation widget will send messages you need to pay attention to via the iframe postMessage function. The messages are as follows.

AUTOGRAB_INSIGHTS_SUCCESS

The widget loaded successfully, no intervention is needed.

AUTOGRAB_INSIGHTS_ERROR

There was an exception or error delivering the iframe contents.

AUTOGRAB_INSIGHTS_HIDE

The close button at the end of the workflow or close X in the interface has been pressed.

AUTOGRAB_INSIGHTS_DIMENSIONS

The iframe has resized due to changes in the contents. Please respond by resizing the iframe container to hold the new contents without cropping.

AutoGrab can provide valuation and vehicle info certificates for you to offer through your own products in Australia. To request a certificate use the v2/certificates/generate endpoint and pass in the , that you have previously run as well as the type of certificate you'd like

CarAnalysis

Standard CarAnalysis

For a standard CarAnalysis certificate, you can submit a request as below to receive the payload with summary info as well as the URL of the pdf. This certificate does include a PPSR report.

An example response is below.

If you wish to view an example CarAnalysis including PPSR you can find one below.

CarAnalysis Without Valuation

There may be user experiences where you do not wish to show a valuation on your certificates. You can use car-analysis as the type to request this. The response you will receive will be the same as above but the PDF will not have a valuation present.

If you wish to view an example CarAnalysis excluding a Valuation you can find one below.

Car Analysis Standalone

This is a CarAnalysis report without a PPSR or Valuation. To request this certificate type use car-analysis-standalone.

An example response is below

If you wish to view an example CarAnalysis Standalone you can find one below.

White Label

We offer white-label of certificates and can configure them to your brand guidelines. Contact us to learn more about the commercial arrangements. Technically you would just need to include a brand parameter in your request body.

Catalogue Support

The detailed specifications endpoint supports multiple catalogues and their vehicle IDs. Below are the currently supported IDs:

• AutoGrab Vehicle IDs

• Jato Catalogue or Vehicle IDs

If no catalogue identifier is passed in as part of the call, the default is autograb

A vehicle ID can be obtained using any of our vehicle identifications and search endpoints:

Detailed Specifications using AutoGrab ID

Example Response

The values received for a given specifications call are based on what is contained in the configured API keys contract. In the above example, kerb_weight and tare_weight are returned.

Where relevant, an int_value and a string value for each specification will be returned.

Detailed Specifications with alternative Catalogue Codes

The detailed specifications endpoint will assume the ID being submitted is an AutoGrab vehicle ID unless the feature parameter catalogue .

Detailed Specifications using JATO Codes

When using Jato codes, the catalogue the feature parameter value is required to be set to jato

Example Request

Example Response

AutoGrab can service PDF reports over API that can then be handled in your application.

Report Features

The report endpoint has the ability to determine the content of the report based on the information that is handed to it.

Understanding AutoMate

It is designed to answer higher-level questions related to vehicles, automotive market trends, valuations, and more. By leveraging AutoGrab’s vehicle catalogue, valuations models, and market data, AutoMate provides helpful, broader guidance for users looking to learn about vehicle pricing, market dynamics, and industry updates.

However, since AutoMate’s outputs are based on aggregated data and model-driven analysis, there are important considerations to keep in mind when using it. This document outlines how AutoMate works, what it’s best used for, and what you should be aware of regarding data accuracy and completeness.

The AutoGrab AutoGauge is an iFrame widget that displays a valuation as well as some high-level market data for a vehicle listing. We host a configuration file that controls a range of labelling and styling variables that we will guide you through as part of your integration.

Query Parameters

Since the gauge operates in an iFrame, it is controlled using query parameters. These parameters are separated into two distinct groups: Base parameters and vehicle-type parameters. The base parameters are applicable for all use cases, whereas you only need to choose one set of vehicle-type parameters in order to use the gauge.

Base parameters

api_key: string; Your Gauge API Key (locked to your provided domains).

region: Region; The country code (‘au’, ‘nz’ or ‘my’)

odometer: number; The odometer reading for the vehicle you are valuing

listing_price: number; The listing price for the vehicle you are valuing

layout?: string; The desired layout style (‘horizontal’ or vertical). If a layout type is not provided, this will default to ‘vertical’.

Vehicle Type Parameters

These parameters are used to determine the type of vehicle that you are valuing, and only one of these sets of properties are required to match a vehicle. Depending on your use case, it may be easier to use certain sets of parameters over others.

vehicle_id The AutoGrab vehicle ID

marketplace and marketplace_id The marketplace domain name where the vehicle is publicly listed (e.g. ‘carsales.com.au’) and the unique listing ID on the marketplace (e.g. ‘OAG-AD-216621’)

vin The vehicle's VIN number

rego and state The registration plate (e.g. ‘BMT038’) and the registration state code. Registration state is only required in Australia (‘VIC’, ‘NSW’, ‘QLD’, ‘ACT’, ‘TAS’, ‘SA’ or ‘WA’)

vehicle_description The plain text vehicle description (e.g. ‘2019 Volkswagen Polo 85TSI Comfortline Auto MY19’)

Example Usage

With VIN

With Rego & State

With Marketplace/Marketplace ID

With Vehicle Description

Local Testing

To test the gauge locally, simply create an index.html file with the following contents:

You can then host this file on localhost:8080 using the npx-server package. You can use the ‘npx’ command line tool to do this:

> npx html-server ./index.html

The localhost:8080 URL is whitelisted for your API key, therefore enabling this workflow.

Event Listeners

If the Gauge is successfully rendered, we send a message via the iframe postMessage function. The way for a client to listen for the event is as follows:

There is no minimum valuation threshold set per API key. We can configure this to your requirements.

The Vehicle VIN API allows you to search for vehicles by VIN. The request requires only a region, VIN, and API key. It will either return a matching vehicle with possible option packs or a null.

Example Response

Features

The Sourcing API allows you to access lead and listing data from a variety of used car marketplaces.

This API requires and an appropriate license attached to it.

Market Overlay API

When viewing a lead on the web app, a view of similar leads that are currently listed for sale or recently sold is available on the side of the page (the 'Market Overlay'). The Market Overlay API gives you programmatic access to this data, enabling you to show price justifications or re-create our market comparison view for your own purposes.

To access a Market Overlay, you will need to specify a Vehicle ID to search for relevant listings. To retrieve a Vehicle ID, use any of the