1 of 46

🇬🇧 UK AutoGrab API Doc

AutoGrab Basics

AutoGrab Developer Hub

Welcome to the developer hub, this is your reference to integrate with all aspects of the system. We've got guides and reference materials to support and accelerate your development.

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.

Integration Overview

Key things to know before you start.

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

Environment

URL

Regions

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

For example: https://api.autograb.co.uk/v2/vehicle/3190324654943863?region=uk

Supported Regions

Country

Region Code

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.

Header

Example

Description

FAQ

These are frequently asked questions about AutoGrab and our products.

What is a VIN?

The car's vehicle identification number (VIN) is the identifying code for a specific automobile. The VIN serves as the car's fingerprint, as no two vehicles in operation have the same VIN. A VIN is composed of 17 characters (digits and capital letters) that act as a unique identifier for the vehicle. A VIN displays the car's unique features, specifications and manufacturer. The VIN can be used to track recalls, registrations, warranty claims, thefts and insurance coverage.

What is an AutoGrab ID?

An AutoGrab ID or AGID is a unique identifier for a vehicle in our catalogue. All vehicles inside AutoGrab reference this as the source of metadata about the vehicle.

How do AutoGrab Valuations Work?

AutoGrab’s Valuation captures the asking prices from the past week for a specific vehicle’s year, make, model, and variant at a given mileage, sourced from private sellers and dealers within a selected state. It excludes government charges but includes GST, assuming the vehicles are in good condition and fitted with standard OEM accessories.

Leveraging advanced machine learning and updated weekly, our pricing integrates active listings and recently delisted data from public marketplaces. AutoGrab emphasises the most recent data to deliver comprehensive valuations that reflect current market trends.

Each estimate includes a confidence score, which indicates AutoGrab’s certainty in the valuation. Two key factors determine this score:

How do I know the current status of each endpoint?

Go to to view the current system state and subscribe to notifications of incidents that are relevant to you.

Where can I get customer support?

You can get assistance by

submitting a support ticket at

Authentication

API Key

We support API Key based authentication, recommended if you build applications to integrate with our platform.

Do you need a key? Contact your sales rep or contact to request one to start developing.

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

A public API key is used on your website to call the API. These keys are limited to your domain and are safe to share publicly.

Example Key: pub_3ficuhb34u8fnxu34h9fm

Authenticating Requests

When making requests to the APIs, include the key in your request.

Other Authentication Methods

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

OAuth Authentication

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:

Token management (ensure your system always has a valid OAuth token available)
REST API call signing using a valid token

Token management

Before implementing token management, make sure you have a valid client_id and client_secret as provided by AutoGrab. (They will be provided by your sales rep.) These are the credentials you will use to get valid tokens from the AutoGrab auth-broker.

auth-broker POST call to receive a valid OAuth token

Copy

A valid token can be stored locally for use in subsequent api calls. It is recommended to calculate a safe expiry timestamp based on the expires_in property of the response body, and use this to pre-emptively refresh your token when it nears expiry.

REST api call signing

With a valid AutoGrab OAuth token to hand, each REST api call that you make can be authorised by encoding the as-provided token string into your Authorization header using Bearer prefix.

Troubleshooting

I don’t get a 200 response on my request-token calls Double-check your client_id and client_secret with AutoGrab. Double-check your Basic Auth encoding. Double check your content-type header and post body structure.

Vehicle Search

Vehicle Searching Basics

Vehicle discovery is the starting place for almost all functions on the AutoGrab API.

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

Vehicle ID Search

Get summary data on a vehicle by searching for its ID

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

Example Response

Marketplace ID Lookup

A special use case endpoint for our marketplace customers to find their own leads on AutoGrab systems.

Overview

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

Prerequisites to access.

Sourcing

Sourcing Basics

Find the right market data to inform your decision making

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

Market Statistics

Get key statistics on any vehicle ID

Overview

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

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

Stock Feeds

Pipe your stock feed into a range of AutoGrab products.

Creating a stock feed

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

Vehicle Data

Recall Search

Check the recall status of a vehicle

Overview

The Recall Check API allows you to access the current recall status of a given vehicle based on the registration. This API requires authentication and an appropriate license attached to it.

Factory Build Data

Request data the vehicle was fitted with at the factory

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.

{
    "error": true,
    "message": "Invalid or Unsupported VIN"
}

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

We are developing a version of this endpoint that groups each item under its relevant options pack. Stay tuned for this release.

For basic fittable options, that is the options packs available on the vehicle refer to the or endpoints.

Coverage

The Factory build data program covers most major manufacturers back to vehicles built in 1999. Contact us to request if we have coverage of a specific area.

As of 2023 the system has coverage across 40 manufacturers as below:

Abarth
Alfa Romeo
Alpina
Audi

Valuation

Valuation Basics

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.

Max Offer Configuration

Set and update your max offer config to refine your price predictions.

Embeddable Products

Embeddable Basics

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

Valuation Widget

The Valuation Widget offers an easy-to-configure and install instant cash offer journey for your website.

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

Please ensure your implementation meets the minimum event listener requirements.

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.

Market Overlay Widget

The Market Overlay widget system provides insights into the marketability of a given car in a marketplace.

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.

Reports

Car Analysis

Generate PDF reports of vehicles for users

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.

Customer Recapture

Insurance

Pre-Accident Valuation

Deliver you own PAV style product by leveraging a range of AutoGrab API products.

To deliver a PAV-style experience you can leverage existing API endpoints to deliver your desired UX. Below is a broad guide on how to achieve a similar outcome. Each integration will have nuances and specific commercial differences - don't hesitate to speak to your Integrations support person or sales executive for guidance.

Workflow Overview

Gauge Widget

AutoGrabs dynamic pricing indicator for your website

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.

You can access this over API if you would like to make your own implementation over the iFrame, read more here.

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’, 'uk', 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 The registration plate (e.g. ‘BMT038’).

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.

Market Overlay

Get a view of the market as it relates to a specific vehicle.

When viewing a lead on the web app, a view of similar leads 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 purposes.

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

When retrieving market data for a Vehicle ID, a best-effort attempt is made to find at least four listings. This search begins by looking at the latest 60 days, and if there is not enough data in this period, another 10 days of data is added until the minimum quota of four is reached.

If you would like a larger sample of market data, you can specify a minimum_days value and this will override the default minimum of 60 days.

Request Parameters

Name

Description

Features

Passing option feature parameters can enhance the market overlay. You can request a single feature or combine them to enrich your responses. Your sales representative must enable a unique permission for each feature.

Dealer Contact Details

This feature will deliver the contact details of the advertising dealership as per the listing. Use features=dealer_contact_details

Lead Starting Price

This feature will deliver the initial price the lead was advertised at. Use features=lead_starting_price

Lead Price Drops

wantThis feature will deliver the count of times the price has been dropped. If you would like to know what each drop (or increase) was consider the endpoint. Use features=lead_price_drops

Vehicle RRP

This feature will deliver the RRP of the vehicle when it was new according to our vehicle data catalogue, the same data and more is available via our . Use features=vehicle_rrp

All Listing URLs

This feature will deliver the listing URLs related to the lead across all sites it is listed on. Use features=listing_urls

Primary Cover Image

This feature will deliver the cover image for each record where available. Each image is stored for 90 days after delisting. Use features=cover_image

All Images

This feature will deliver all primary images for each record where available. Each image is stored for 90 days after delisting. Use features=all_images

Listing Details

This feature will deliver additional information on the listings that are associated with a given lead. Use features=listing_details

Primary Listing Description

This feature will deliver the primary listing description for each record where available. Use features=primary_description

Registration Plate

This feature will deliver the vehicle's registration plate in the market overlay payload. Use features=rego

VIN

This feature will deliver the vehicle's VIN in the market overlay payload. Use features=VIN

Stock Number

This feature will deliver the vehicle's stock number in the market overlay payload. Use features=stock_no

Average Kms

This feature will deliver the average kms and average odometer of the overlay calculated for you in the response. Use features=avg_kms

Average Price

This feature will deliver the average price of the overlay calculated for you in the response. Use features=avg_price

Upsert a max offer configuration

put

Upsert a max offer configuration

Authorizations

ApiKeystringRequired

Query parameters

regionstring · enumOptional

The region to perform this request in

Possible values:

Body

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

Responses

200

Success

application/json

successbooleanOptionalDefault: true

reconditioning_percentagenumberOptional

reconditioning_fixednumberOptional

profit_margin_percentagenumberOptional

profit_margin_fixednumberOptional

lot_percentagenumberOptional

lot_fixednumberOptional

transport_percentagenumberOptional

transport_fixednumberOptional

admin_percentagenumberOptional

admin_fixednumberOptional

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

404

Not Found

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

put

/v2/valuations/max_offer_configuration

Get the lead statistics used to justify pricing for a given AutoGrab Vehicle ID.

get

Get the lead statistics used to justify pricing for a given AutoGrab Vehicle ID.

Authorizations

ApiKeystringRequired

Path parameters

vehicle_idstringRequired

Query parameters

minimum_daysnumberOptional

The minimum number of days to show listings for

include_adjacent_yearsbooleanOptional

If enabled, vehicles that were manufactured up to one year before and one year after your chosen vehicle will also be included in the results.

exclude_outliersbooleanOptional

If enabled, leads that are considered outliers will be excluded from the results.

exclude_all_delistedbooleanOptional

If enabled, leads that are not currently on the market will be excluded from the results.

include_all_activebooleanOptional

If enabled, all listings that are currently on the market will be returned, instead of only listings which were uploaded within the specified timeframe (minimum_days). Additionally, if this is enabled, delisted leads will be returned based on the number of days since they were sold, rather than the number of days since they were listed.

include_trashbooleanOptional

If enabled, leads that are considered trash, written off, damaged, or missing details will be included in the results. The tag_ids array can then be used to determine if a lead is trash, damaged, etc.

featuresstringOptional

Comma separated array of additional overlay feature codes as specified in your contract

odometer_range_minnumberOptional

The minimum range observed against similar vehicles

odometer_range_maxnumberOptional

The maximum range observed against similar vehicles

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

successbooleanOptional

sample_sizenumberOptional

The number of leads in the given market overlay

days_checkednumberOptional

The number of days checked when going back to retrieve relevant leads

avg_days_to_sellnumberOptional

The average number of days to sell for delisted leads in this overlay. If there are no delisted leads in time timespan selected, this will be null.

outlier_countnumberOptional

The count of outliers detected in similar vehicles.

days_supplynumberOptional

The sale rate of vehicles of the sample time period.

avg_pricenumberOptional

The average price of the analysed similar vehicles.

min_pricenumberOptional

The minimum price of the analysed similar vehicles.

max_pricenumberOptional

The maximum price of the analysed similar vehicles.

avg_odometernumberOptional

The average odometer of the analysed similar vehicles.

min_odometernumberOptional

The minimum odometer of the analysed similar vehicles.

max_odometernumberOptional

The maximum odometer of the analysed similar vehicles.

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

get

/v2/sourcing/market_overlay/statistics/{vehicle_id}

Get the leads used to justify pricing for a given AutoGrab Vehicle ID.

get

Get the leads used to justify pricing for a given AutoGrab Vehicle ID.

Authorizations

ApiKeystringRequired

Path parameters

vehicle_idstringRequired

Query parameters

minimum_daysnumberOptional

The minimum number of days to show listings for

include_adjacent_yearsbooleanOptional

If enabled, vehicles that were manufactured up to one year before and one year after your chosen vehicle will also be included in the results.

exclude_outliersbooleanOptional

If enabled, leads that are considered outliers will be excluded from the results.

exclude_all_delistedbooleanOptional

If enabled, leads that are not currently on the market will be excluded from the results.

include_all_activebooleanOptional

include_trashbooleanOptional

featuresstringOptional

Comma separated array of additional overlay feature codes as specified in your contract

odometer_range_minnumberOptional

The minimum range observed against similar vehicles

odometer_range_maxnumberOptional

The maximum range observed against similar vehicles

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

successbooleanOptional

sample_sizenumberOptional

The number of leads in the given market overlay

days_checkednumberOptional

The number of days checked when going back to retrieve relevant leads

avg_days_to_sellnumberOptional

The average number of days to sell for delisted leads in this overlay. If there are no delisted leads in time timespan selected, this will be null.

outlier_countnumberOptional

The count of outliers detected in similar vehicles.

days_supplynumberOptional

The sale rate of vehicles of the sample time period.

avg_pricenumberOptional

The average price of the analysed similar vehicles.

min_pricenumberOptional

The minimum price of the analysed similar vehicles.

max_pricenumberOptional

The maximum price of the analysed similar vehicles.

avg_odometernumberOptional

The average odometer of the analysed similar vehicles.

min_odometernumberOptional

The minimum odometer of the analysed similar vehicles.

max_odometernumberOptional

The maximum odometer of the analysed similar vehicles.

idstringOptional

The AutoGrab Lead ID

colorstringOptional

The color of the vehicle, if applicable

drive_away_pricenumberOptional

The drive-away price

is_outlierbooleanOptional

Is the lead considered an outlier

kmsnumberOptional

The odometer reading for the listed vehicle

listing_urlstringOptional

The URL where the vehicle was listed for sale

listing_sourcesstring[]Optional

A list of marketplaces where the vehicle was listed for sale

listed_atstringOptional

The timestamp when the lead was posted online

pricebooleanOptional

The latest listing price

price_before_govt_chargesnumber[]Optional

The price before government charges

price_includes_govt_chargesboolean[]Optional

Indicates whether the price includes government charges

release_yearnumberOptional

The year when the vehicle or the vehicle's body design was released

release_monthnumberOptional

The calendar month as a number (1-12) when the vehicle or the vehicle's body design was released

removed_atstringOptional

The timestamp when the lead was sold or the listing was removed, or null when the listing is still active

seller_typestring · enumOptional

The type of seller that posted the listing

Possible values:

statestringOptional

The state or province where the vehicle was listed for sale in, or null when no location is specified

tag_idsstring[]Optional

An array of the tags applied to the lead on AutoGrab

vehicle_idstringOptional

The AutoGrab Vehicle ID

yearnumberOptional

The manufacturer year of the vehicle

all_imagesstring[]Optional

All images in the overlay lead

primary_descriptionstringOptional

The primary description of the overlay lead

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

get

/v2/sourcing/market_overlay/{vehicle_id}

Valuation Predictions

Generate market accurate predictions for vehicles.

Overview

The Valuation API can be used to determine the present retail & trade values, as well as the residual values of new vehicles.

This API requires authentication and an appropriate license attached to it.

To use the API, a Vehicle ID returned from the Vehicle Search API or Vehicle Facet API is required.

How is a valuation provided?

Each estimate includes a confidence score, which indicates AutoGrab’s certainty in the valuation. Two key factors determine this score:

The number of vehicles listed in the past 365 days for the specific vehicle type
A detailed accuracy analysis of the pricing algorithm for that vehicle type

The confidence score ranges from 0 to 1, with 1 representing the highest confidence level

Example

Request

To retrieve a Vehicle ID, use the .

Starting with a vehicle ID post it to /v2/valuations/predict

The is optional and can be used to further refine your pricing prediction.

The Catalogue field is optional and will default to 'autograb' and the vehicle ID for performing a valuation. If you have access to Jato catalogue information, 'jato' can be passed as the catalogue and a JATO ID as the vehicle_id. The valuation will then be performed using the JATO information.

Response

Pricing ID

The payload returned by price prediction requests will include an ID, which you can use to refer to the pricing request in the future. The /v2/valuations/history/{PRICING_ID method will return the response from a previous pricing request, and you can also use the Pricing ID to track price changes with the Price Changes API, if licenced.

To get a paginated list of all your previous price predictions, you can use the /v2/valuations/history endpoint.

Condition Score

By supplying a condition score, you can manipulate the trade_price returned by the prediction endpoint. The condition score can be between 1 and 5. A condition of 1 being poor condition and a condition of 5 excellent condition.

Supplying any other numbers will return the default trade_price which assumes excellent condition.

If you're building a user interface where you allow the user to choose a condition it is recommended you follow the industry standard in the table below.

Condition

Condition Score

Features

Positive Equity

The positive equity feature identifies if the vehicle is in positive equity and the current equity position. To add an equity calculation to the Predict call, use features=equity

Copy

Valuation Bounds

If you require the upper and lower bounds used to calculate a prediction, you can use features=bounds.

Copy

Adjustments

Both the Residual Value and Used Value APIs support pricing adjustments. These can be used to retrieve a more accurate price prediction of a vehicle if the provided price is not already accurate enough.

Recommended Retail Price Adjustment

CommentTo adjust the stored Recommended Retail Price you can supply a rrp_adjustment value in the payload which accepts a number — positive or negative.CommentThis is useful when a car is fitted with factory extras, the Price When New can be increased for each of the options to get a better price prediction.Comment

Recommended Retail Price Overwrite

To adjust the stored Recommended Retail Price you can supply a rrp_adjustment value in the payload which accepts a number — positive or negative.

Predicted Retail and Trade Price Adjustments

The Pricing Adjustments API (/v2/valuations/adjustments) allows you to configure fixed or percentage adjustments for specific Vehicle IDs.

Per-Vehicle pricing adjustments will apply to price predictions that you perform using the same API Key and for the same Vehicle ID.

If you set a Retail Price Adjustment for a vehicle, the trade price will also be affected because the trade price is derived from the retail price. If you set an adjustment for both the retail price and the trade price, both adjustments will be applied to the trade price while the retail price is only affected by the retail price adjustment.

When you perform a price prediction, you will receive a summary of the price adjustments that were applied, if any.

Example

Below is an example price prediction payload with predicted trade and retail adjustments applied.

Copy

Predicted Retail and Trade Price Overrides

In addition to price adjustments, you also have the option to override retail and trade prices for specific vehicle IDs where the odometer reading falls within a set range. Price overrides are configured using the Price Override API at /v2/valuations/adjustments/{VEHICLE_ID}/overrides.

If you have configured a retail or trade price override that applies to a price prediction, the overridden price will be returned instead of the AutoGrab valuation. This will bypass any price adjustments that you may have configured, and the response payload will indicate this with the {overridden: true} flag.

Retail price overrides will impact the predicted trade price in the same way that retail price adjustments impact the trade-price - unless you have configured a trade price override. Suppose you have both a trade override and a retail override. In that case, the two overridden prices will be returned without pre-processing (except for calculating condition scores, if applicable - see below).

Example

Below is an example price prediction payload where price adjustments and price overrides have been configured. In this example, the retail price adjustment has been overridden by the retail price override, and the trade price adjustment has been applied.

Copy

Search for a vehicle by facet, return matching vehicles

get

Search for vehicles by facets - minimum of year, make and model are required to return results and additional facets

Authorizations

ApiKeystringRequired

Query parameters

yearstringOptional

The build year of the vehicle

makestringOptional

The make of the vehicle

modelstringOptional

The model of the vehicle

badgestringOptional

The badge of the vehicle

seriesstringOptional

The series of the vehicle

transmissionstringOptional

The specific transmission type (e.g. Sports Automatic, Automated Manual, etc...)

transmission_typestringOptional

The basic transmission type (i.e. Automatic, Manual or Reduction Gear)

body_typestringOptional

The body type of the vehicle (e.g. Hatchback, Sedan, etc...)

fuelstringOptional

The fuel type of the vehicle (e.g. Petrol, Diesel, etc...)

drivestringOptional

The specific drive type (e.g. AWD, 4WD, 4x4 Dual Range, etc...)

drive_typestringOptional

The basic drive type of the vehicle (e.g. Front Wheel Drive, Rear Wheel Drive, etc...)

limitnumber · max: 100Optional

The maximum number of results to return per facet query

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

idstringOptional

titlestringOptional

yearnumberOptional

makestringOptional

modelstringOptional

badgestringOptional

seriesstringOptional

model_yearstringOptional

release_monthnumberOptional

release_yearnumberOptional

body_typestringOptional

The generic body shape of the vehicle (e.g. Sedan, SUV, etc...)

body_configstringOptional

The body config/cab type of the vehicle (e.g. Dual Cab, Single Cab, etc...)

transmissionstringOptional

The specific transmission type used in the vehicle

transmission_typestringOptional

The generic transmission type (e.g. Automatic, Manual)

wheelbasestringOptional

The same value as wheelbase_type, provided for backwards compatability

wheelbase_typestringOptional

The generic wheelbase type of the vehicle (e.g. SWB, LWB)

fuelstringOptional

The same value as fuel_type, provided for backwards compatability

fuel_typestringOptional

The generic fuel type of the vehicle (e.g. Petrol, Diesel, Electric, etc...)

enginestringOptional

The same value as engine_type, provided for backwards compatability

engine_typestringOptional

The generic engine type of the vehicle (e.g. Piston, Rotary, etc...)

drivestringOptional

The specific drive type of the vehicle (e.g. 4x4 Dual Range, FWD, AWD, etc...)

drive_typestringOptional

The generic drive type of the vehicle (e.g. Four Wheel Drive, Front Wheel Drive)

num_doorsnumberOptional

num_seatsnumberOptional

num_gearsnumberOptional

num_cylindersnumberOptional

capacity_ccnumberOptional

power_kwnumberOptional

torque_nmnumberOptional

rangenumberOptional

totalnumberOptional

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

get

/v2/vehicles/facets/search

Customer Recapture

The Recapture API allows you to upload, view and delete Customers.

Uploading Customer lists

The main purpose of the Recapture API is to facilitate the automated upload of new Customers.

Customer lists are often very long, so the Recapture API allows you to queue Customer uploads without immediately processing every Customer in the list. There is an endpoint to queue the upload, and separate endpoints to check the status of the upload, and cancel it, if necessary.

Upload a list of Customers

A POST request to https://api.autograb.com.au/v2/recapture/upload?region={REGION} will initiate a new queued Customer list upload.

The request body has the following parameters:

name: A name to assign to the upload, for personal reference
enable_rego_lookups: When rego lookups are enabled, if the registration plate (and state, if in Australia) is provided, but no VIN is provided for a Customer, we will perform a VIN lookup (at additional cost to you) and save the VIN along with the Customer. When a Customer includes a VIN number, we can cross-reference the VIN with new vehicle listings posted in the future, and use this to verify that the car being sold is definitely the same car that you are tracking.

If you try to upload an empty list, you will receive a You must upload at least one customer error.

Example

To perform an example request:

This endpoint returns a 202 Accepted response. An example response payload is:

Check upload status

Once you've queued a Customer upload, you may want to check on the upload progress. Sending a GET request to /v2/recapture/upload/{UPLOAD_ID}?region={REGION} will return information about the upload, including the progress and the number of errors.

The key properties to check the upload progress are total_uploaded_customers and total_processed_customers. Creating a new Customer consists of two steps - uploading and processing - and these two counters reflect the progress made for each of these steps.

Once total_processed_customers is equal to total_uploaded_customers, the upload is complete. If there are any unexpected errors during the upload, total_errors will increase to signify this, but total_processed_customers is inclusive of errors.

Example

To perform an example request:

An example response payload is:

Cancel an upload

If you queue a Customer upload and later change your mind, you can cancel the upload, stopping the creation of any more Customers.

The response payload will include the details of the deleted upload.

Example

To perform an example request:

An example response payload is:

Managing Customers

Once you have uploaded a Customer list, you are able to use the Recapture API to view your newly uploaded Customers, as well as create, edit and delete individual Customer.

Get a list of all Customers

You can use the /v2/recapture/customers?region={REGION} endpoint to retrieve a list of all your Customers.

This list is paginated, and you can move between pages using the offset and limit query parameters. The limit is capped at 500.

If you want to get Customers associated with a specific upload, you can pass the unique Upload ID to the upload_id query parameter.

The response includes a total field with the overall count of Customers matching the query, which is useful for paginating through large lists.

Example

To perform an example request:

An example response payload is:

Create an individual Customer

You can create a single Customer directly using the PUT method on the /v2/recapture/customers?region={REGION} endpoint.

The request body has two parameters:

enable_rego_lookups: When enabled, if a registration plate is provided but no VIN, we will perform a VIN lookup (at additional cost). Defaults to false.
customer: An object with the Customer's details. At least a rego or a vin must be provided.

If neither rego nor vin is provided, you will receive a Missing required properties error.

Example

To perform an example request:

An example response payload is:

Get an individual Customer

You can get individual Customer details using the GET method on /v2/recapture/customers/{CUSTOMER_ID}?region={REGION}.

Trying to lookup an invalid Customer ID returns the Invalid Customer ID error, and trying to look up a Customer that you don't have access to returns a You don't have permission to access that customer error.

Example

To perform an example request:

An example response payload is:

Update an individual Customer

If you need to make changes to an individual Customer's details, you can use the PATCH method on the /v2/recapture/customers/{CUSTOMER_ID}?region={REGION} endpoint.

Only the fields that you specify in the request body will be affected, and providing an empty value ("") or null will clear the field where applicable.

The response payload will include the updated Customer object.

You can update any of the following Customer properties: sale_date, monitor_start_date, monitor_end_date, additional_fields

sale_date, monitor_start_date, and monitor_end_date must be valid date strings if provided.

Example

To perform an example request:

An example response payload is:

Delete an individual Customer

You can delete an individual Customer by using the DELETE method on the /v2/recapture/customers/{CUSTOMER_ID}?region={REGION} endpoint.

The response payload includes the details of the Customer that was deleted.

The same error messages apply as with the Get Customer endpoint.

Example

To perform an example request:

An example response payload is:

Responses

200

Success

application/json

successbooleanOptionalDefault: true

idstringOptional

The unique pricing record ID

vehicle_idstringOptional

The Vehicle ID of the vehicle that was priced

created_atstringOptional

The date when the preidction was made

kmsnumberOptional

The odometer reading that the valuation is based off. This is usually the same as the input provided, but if no odometer reading was specified, the average reading for the vehicle provided will be used instead.

pricenumberOptional

The predicted retail price

scorenumberOptional

The pricing confidence score. This indicates the estimated degree of accuracy for the price prediction.

retail_pricenumberOptional

The predicted retail price

trade_pricenumberOptional

The predicted trade price

vehicle_idstringOptional

typestring · enumOptional

The granularity of the price adjustment. Vehicle price adjustments are applied to the whole vehicle and set using /valuations/adjustments, whereas pricing_record adjustments are set for a specific record using /valuations/history.

Possible values:

enabledbooleanOptional

If the adjustment is enabled, it will be applied to new pricing requests for the vehicle id

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

amountnumberOptional

The value

typestring · enumOptional

Determines if the value is a percentage of a total value or a fixed amount

Possible values:

idstringOptional

A unique ID that identifies the price override

min_kmsnumberOptional

The minimum odometer reading that this override will apply at

max_kmsnumberOptional

The maximum odometer reading that this override will apply at

trade_pricenumberOptional

The trade price override, if applicable

retail_pricenumberOptional

The retail price override, if applicable

lowernumberOptional

The predicted lower retail price bound

uppernumberOptional

The predicted upper retail price bound

lowernumberOptional

The predicted lower trade price bound

uppernumberOptional

The predicted upper trade price bound

reconditioningnumberOptional

profit_marginnumberOptional

lotnumberOptional

transportnumberOptional

adminnumberOptional

pricenumberOptional

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

{
    "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"
}

"additional_upstream_data": {
        "vehicle_details": {
            "vehicle_identification": {
                "ukvd_id": "V-JZTYRS",
                "ukvd_uvc": "M-NPGXL",
                "vehicle_registration_mark": "KW73NKE",
                "vehicle_identification_number": "W1K5J5BB4PN369431",
                "dvla_manufacturer_desc": "MERCEDES-BENZ",
                "dvla_model_desc": "AMG CLA 35 PREMIUM 4MATIC AUTO",
                "dvla_wheelplan": "2 AXLE RIGID BODY",
                "registration_date": "2023-11-20",
                "first_registration_date": "2023-11-20",
                "used_before_first_registration": false,
                "manufactured_year": 2023,
                "v5c_qty": 2,
                "date_v5c_issued": "2023-11-20",
                "engine_number": "26092030493649",
                "prior_ni_vrm": "",
                "dvla_body_desc": "COUPE",
                "dvla_fuel_desc": "PETROL"
            },
            "vehicle_status_details": {
                "is_non_eu_import": false,
                "is_imported": false,
                "certificate_of_destruction_issued": false,
                "is_exported": false,
                "exported_date": null,
                "is_scrapped": false,
                "scrapped_date": null
            },
            "vehicle_excise_duty_details": {
                "co2_gkm": 191,
                "dvla_co2_band": null,
                "12_month_rfl_y1": 1650,
                "6_month_rfl_y2_to_y6_premium": 330,
                "12_month_rfl_y2_to_y6_premium": 600,
                "6_month_rfl_y2_to_y6": 104.5,
                "12_month_rfl_y2_to_y6": 190
            },
            "colour_details": {
                "colour": "WHITE",
                "colour_changes_qty": 0,
                "original_colour": "WHITE",
                "last_colour": null,
                "date_of_last_colour_change": null
            },
            "keeper_change_list": [
                {
                    "number_previous_keepers": 1,
                    "date_of_last_keeper_change": "2024-06-08"
                }
            ],
            "plate_change_list": []
        },
        "model_details": {
            "ukvd_variant_code": 1,
            "model_data": {
                "manufacturer_desc": "Mercedes-AMG",
                "model_range_desc": "CLA",
                "model_desc": "AMG CLA 35 Premium 4Matic Auto",
                "model_variant": null,
                "ukvd_series_desc": "C118",
                "ukvd_mark": null,
                "model_start_date": "2022-07-22",
                "model_end_date": null,
                "emission_class": "6d",
                "country_of_origin": "Germany",
                "ukvd_fuel_type_desc": "Petrol",
                "cab_type_desc": null,
                "type_approval_category": "M1",
                "market_sector_code": null,
                "vehicle_type": "Car",
                "vehicle_taxation_class": "Car"
            },
            "body_details": {
                "ukvd_body_shape": null,
                "ukvd_body_type_desc": "Coupe",
                "fuel_capacity_litres": 51,
                "number_axles": 2,
                "number_doors": 4,
                "number_seats": 5,
                "payload_volume_square_metres": null,
                "wheelbase_type_desc": "Short Wheelbase",
                "platform_desc": null,
                "is_platform_shared": null
            },
            "dimensions": {
                "vehicle_height_mm": 1404,
                "vehicle_length_mm": 4695,
                "vehicle_width_mm": 1834,
                "vehicle_wheelbase_mm": null,
                "load_length_mm": null
            },
            "weights": {
                "min_kerbweight_kg": 1615,
                "gross_trainweight_kg": null,
                "unladen_weight_kg": null,
                "payload_weight_kg": null,
                "gross_vehicleweight_kg": 2115,
                "gross_combined_weight_kg": 2115
            },
            "power_source": {
                "power_source_vehicle_type": "ICE",
                "ice_details": {
                    "engine_family": null,
                    "engine_stroke_mm": 92,
                    "valves_per_cylinder": 4,
                    "aspiration": "Turbocharged",
                    "number_cylinders": 4,
                    "engine_location": "Front",
                    "cylinder_arrangement": "Inline",
                    "valve_gear": "DOHC",
                    "ukvd_engine_desc": "M260 E20DEH LA G AMG",
                    "engine_bore_mm": 83,
                    "engine_manufacturer": "Mercedes Cars",
                    "fuel_delivery": null,
                    "power_delivery": "Normal",
                    "engine_capacity_cc": 1991,
                    "engine_badged_size_litres": 2
                },
                "electric_details": null
            },
            "euro_ncap": {
                "ncap_overall_rating": 5,
                "ncap_child_occupant_protection_percentage": 91,
                "ncap_adult_occupant_protection_percentage": 96,
                "ncap_pedestrian_protection_percentage": 91,
                "ncap_safety_assist_percentage": 75
            },
            "emissions": {
                "is_fuel_catalyst": true,
                "co2_gkm": null
            },
            "performance": {
                "torque": {
                    "torque_nm": 400,
                    "torque_lbft": 295.2,
                    "torque_rpm": 4000,
                    "torque_derived_from": null
                },
                "power": {
                    "power_bhp": 301.7,
                    "power_ps": 305.9,
                    "kilowatt": 225,
                    "power_rpm": 5800
                },
                "statistics": {
                    "0to60_mph": null,
                    "0to100_kmph": null,
                    "max_speed_kmh": 250,
                    "top_speed_mph": 155
                }
            },
            "fuel_economy": {
                "nedc_extra_urban_litres_100km": null,
                "nedc_extra_urban_mpg": null,
                "nedc_extra_urban_cold_litres_100km": null,
                "nedc_extra_urban_cold_mpg": null,
                "combined_litres_100km": 8.4,
                "combined_mpg": 33.6
            },
            "sound_levels": {
                "stationary_soundlevel_db": null,
                "stationary_soundlevel_rpm": null,
                "driveby_soundlevel_db": null
            },
            "transmission": {
                "driving_axle": "All Permanent",
                "number_gears": 7,
                "transmission_type": "Automatic",
                "drive_type_desc": "4x4"
            }
        }
    },

Get a vehicle by its registration number

get

Get a vehicle by its registration number

Authorizations

ApiKeystringRequired

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

successbooleanOptionalDefault: true

idstringOptional

regionstring · enumOptionalPossible values:

titlestringOptional

yearnumberOptional

makestringOptional

modelstringOptional

badgestringOptional

seriesstringOptional

body_typestringOptional

body_configstringOptional

transmissionstringOptional

wheelbasestringOptional

fuelstringOptional

enginestringOptional

drivestringOptional

num_doorsnumberOptional

upstream_vehiclestringOptional

The raw vehicle description. It is recommended that end users manually verify that this value corresponds to the same vehicle type as the "vehicle" object above.

confidencestring · enumOptional

The confidence that the vehicle was matched correctly. If this is 'reduced', it's recommended to manually check or prompt your end user to check if the vehicle is correct.

Possible values:

colourstringOptional

The colour of the vehicle, if known

vinstringOptional

The VIN of the vehicle, if known

idstringOptional

regionstring · enumOptionalPossible values:

titlestringOptional

yearnumberOptional

makestringOptional

modelstringOptional

badgestringOptional

seriesstringOptional

body_typestringOptional

body_configstringOptional

transmissionstringOptional

wheelbasestringOptional

fuelstringOptional

enginestringOptional

drivestringOptional

num_doorsnumberOptional

extended_dataanyOptional

Extended Data vehicle description product which can be selected by providing the appropriate query parameter

expiry_datestringOptional

statusstringOptional

compliance_platestringOptional

year_of_manufacturenumberOptional

writeoff_infoobjectOptional

vinstringOptional

build_datestringOptional

makestringOptional

modelstringOptional

codestringOptional

valuestringOptional

read_datestringOptional

ISO 8601 odometer read date

odometernumberOptional

predictionnumberOptional

days_since_readnumberOptional

avg_yearlynumberOptional

avg_dailynumberOptional

ag_market_avgnumberOptional

star_ratingnumberOptional

consumptionnumberOptional

co2numberOptional

star_ratingnumberOptional

test_regimestringOptional

star_ratingnumberOptional

test_regimestringOptional

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

404

Not Found

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

get

/v2/vehicles/registrations/{plate_number}

"additional_upstream_data": {
        "vehicle_details": {
            "vehicle_identification": {
                "ukvd_id": "V-JZTYRS",
                "ukvd_uvc": "M-NPGXL",
                "vehicle_registration_mark": "KW73NKE",
                "vehicle_identification_number": "W1K5J5BB4PN369431",
                "dvla_manufacturer_desc": "MERCEDES-BENZ",
                "dvla_model_desc": "AMG CLA 35 PREMIUM 4MATIC AUTO",
                "dvla_wheelplan": "2 AXLE RIGID BODY",
                "registration_date": "2023-11-20",
                "first_registration_date": "2023-11-20",
                "used_before_first_registration": false,
                "manufactured_year": 2023,
                "v5c_qty": 2,
                "date_v5c_issued": "2023-11-20",
                "engine_number": "26092030493649",
                "prior_ni_vrm": "",
                "dvla_body_desc": "COUPE",
                "dvla_fuel_desc": "PETROL"
            },
            "vehicle_status_details": {
                "is_non_eu_import": false,
                "is_imported": false,
                "certificate_of_destruction_issued": false,
                "is_exported": false,
                "exported_date": null,
                "is_scrapped": false,
                "scrapped_date": null
            },
            "vehicle_excise_duty_details": {
                "co2_gkm": 191,
                "dvla_co2_band": null,
                "12_month_rfl_y1": 1650,
                "6_month_rfl_y2_to_y6_premium": 330,
                "12_month_rfl_y2_to_y6_premium": 600,
                "6_month_rfl_y2_to_y6": 104.5,
                "12_month_rfl_y2_to_y6": 190
            },
            "colour_details": {
                "colour": "WHITE",
                "colour_changes_qty": 0,
                "original_colour": "WHITE",
                "last_colour": null,
                "date_of_last_colour_change": null
            },
            "keeper_change_list": [
                {
                    "number_previous_keepers": 1,
                    "date_of_last_keeper_change": "2024-06-08"
                }
            ],
            "plate_change_list": []
        },
        "model_details": {
            "ukvd_variant_code": 1,
            "model_data": {
                "manufacturer_desc": "Mercedes-AMG",
                "model_range_desc": "CLA",
                "model_desc": "AMG CLA 35 Premium 4Matic Auto",
                "model_variant": null,
                "ukvd_series_desc": "C118",
                "ukvd_mark": null,
                "model_start_date": "2022-07-22",
                "model_end_date": null,
                "emission_class": "6d",
                "country_of_origin": "Germany",
                "ukvd_fuel_type_desc": "Petrol",
                "cab_type_desc": null,
                "type_approval_category": "M1",
                "market_sector_code": null,
                "vehicle_type": "Car",
                "vehicle_taxation_class": "Car"
            },
            "body_details": {
                "ukvd_body_shape": null,
                "ukvd_body_type_desc": "Coupe",
                "fuel_capacity_litres": 51,
                "number_axles": 2,
                "number_doors": 4,
                "number_seats": 5,
                "payload_volume_square_metres": null,
                "wheelbase_type_desc": "Short Wheelbase",
                "platform_desc": null,
                "is_platform_shared": null
            },
            "dimensions": {
                "vehicle_height_mm": 1404,
                "vehicle_length_mm": 4695,
                "vehicle_width_mm": 1834,
                "vehicle_wheelbase_mm": null,
                "load_length_mm": null
            },
            "weights": {
                "min_kerbweight_kg": 1615,
                "gross_trainweight_kg": null,
                "unladen_weight_kg": null,
                "payload_weight_kg": null,
                "gross_vehicleweight_kg": 2115,
                "gross_combined_weight_kg": 2115
            },
            "power_source": {
                "power_source_vehicle_type": "ICE",
                "ice_details": {
                    "engine_family": null,
                    "engine_stroke_mm": 92,
                    "valves_per_cylinder": 4,
                    "aspiration": "Turbocharged",
                    "number_cylinders": 4,
                    "engine_location": "Front",
                    "cylinder_arrangement": "Inline",
                    "valve_gear": "DOHC",
                    "ukvd_engine_desc": "M260 E20DEH LA G AMG",
                    "engine_bore_mm": 83,
                    "engine_manufacturer": "Mercedes Cars",
                    "fuel_delivery": null,
                    "power_delivery": "Normal",
                    "engine_capacity_cc": 1991,
                    "engine_badged_size_litres": 2
                },
                "electric_details": null
            },
            "euro_ncap": {
                "ncap_overall_rating": 5,
                "ncap_child_occupant_protection_percentage": 91,
                "ncap_adult_occupant_protection_percentage": 96,
                "ncap_pedestrian_protection_percentage": 91,
                "ncap_safety_assist_percentage": 75
            },
            "emissions": {
                "is_fuel_catalyst": true,
                "co2_gkm": null
            },
            "performance": {
                "torque": {
                    "torque_nm": 400,
                    "torque_lbft": 295.2,
                    "torque_rpm": 4000,
                    "torque_derived_from": null
                },
                "power": {
                    "power_bhp": 301.7,
                    "power_ps": 305.9,
                    "kilowatt": 225,
                    "power_rpm": 5800
                },
                "statistics": {
                    "0to60_mph": null,
                    "0to100_kmph": null,
                    "max_speed_kmh": 250,
                    "top_speed_mph": 155
                }
            },
            "fuel_economy": {
                "nedc_extra_urban_litres_100km": null,
                "nedc_extra_urban_mpg": null,
                "nedc_extra_urban_cold_litres_100km": null,
                "nedc_extra_urban_cold_mpg": null,
                "combined_litres_100km": 8.4,
                "combined_mpg": 33.6
            },
            "sound_levels": {
                "stationary_soundlevel_db": null,
                "stationary_soundlevel_rpm": null,
                "driveby_soundlevel_db": null
            },
            "transmission": {
                "driving_axle": "All Permanent",
                "number_gears": 7,
                "transmission_type": "Automatic",
                "drive_type_desc": "4x4"
            }
        }
    },

Get a vehicle by its VIN

get

Get a vehicle by its VIN

Authorizations

ApiKeystringRequired

Path parameters

vinstringRequired

Plate number of the registered vehicle

Query parameters

featuresstringOptional

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

prefer_more_resultsbooleanOptional

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

idstringOptional

regionstring · enumOptionalPossible values:

titlestringOptional

yearnumberOptional

makestringOptional

modelstringOptional

badgestringOptional

seriesstringOptional

body_typestringOptional

body_configstringOptional

transmissionstringOptional

wheelbasestringOptional

fuelstringOptional

enginestringOptional

drivestringOptional

num_doorsnumberOptional

upstream_vehiclestringOptional

The raw vehicle description. It is recommended that end users manually verify that this value corresponds to the same vehicle type as the "vehicle" object above.

confidencestring · enumOptional

The confidence that the vehicle was matched correctly. If this is 'reduced', it's recommended to manually check or prompt your end user to check if the vehicle is correct.

Possible values:

colourstringOptional

The colour of the vehicle, if known

vinstringOptional

The VIN of the vehicle, if known

idstringOptional

regionstring · enumOptionalPossible values:

titlestringOptional

yearnumberOptional

makestringOptional

modelstringOptional

badgestringOptional

seriesstringOptional

body_typestringOptional

body_configstringOptional

transmissionstringOptional

wheelbasestringOptional

fuelstringOptional

enginestringOptional

drivestringOptional

num_doorsnumberOptional

extended_dataanyOptional

Extended Data vehicle description product which can be selected by providing the appropriate query parameter

expiry_datestringOptional

statusstringOptional

compliance_platestringOptional

year_of_manufacturenumberOptional

writeoff_infoobjectOptional

vinstringOptional

build_datestringOptional

makestringOptional

modelstringOptional

codestringOptional

valuestringOptional

read_datestringOptional

ISO 8601 odometer read date

odometernumberOptional

predictionnumberOptional

days_since_readnumberOptional

avg_yearlynumberOptional

avg_dailynumberOptional

ag_market_avgnumberOptional

star_ratingnumberOptional

consumptionnumberOptional

co2numberOptional

star_ratingnumberOptional

test_regimestringOptional

star_ratingnumberOptional

test_regimestringOptional

400

Bad Request

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

401

Unauthorized

application/json

errorbooleanOptionalDefault: true

messagestringOptional

Error message

get

/v2/vehicles/vins/{vin}

🇬🇧 UK AutoGrab API Doc

AutoGrab Basics

AutoGrab Developer Hub

Integration Overview

hashtagOverview

hashtagEnvironments

hashtagRegions

hashtagSupported Regions

hashtagAPI Keys

hashtagQuota Limits

hashtagRate Limiting

FAQ

Authentication

API Key

hashtagKey Types

hashtagSecret API Key

hashtagPublic API Key

hashtagAuthenticating Requests

hashtagOther Authentication Methods

OAuth Authentication

hashtagToken management

hashtagREST api call signing

Vehicle Search

Vehicle Searching Basics

Vehicle ID Search

hashtagExample Response

Marketplace ID Lookup

hashtagOverview

Sourcing

Sourcing Basics

Market Statistics

hashtagOverview

Stock Feeds

hashtagCreating a stock feed

Vehicle Data

Recall Search

hashtagOverview

Factory Build Data

hashtagOverview

hashtagCoverage

Valuation

Valuation Basics

Max Offer Configuration

Embeddable Products

Embeddable Basics

Valuation Widget

hashtagOverview

hashtagExample Implementations

hashtagImplementation

hashtagPosition On Page

hashtagEvent Listeners

Market Overlay Widget

hashtagOverview

hashtag

Reports

Car Analysis

hashtagReport Features

Customer Recapture

Insurance

Pre-Accident Valuation

hashtagWorkflow Overview

Integration Overview

hashtagOverview

hashtagEnvironments

hashtagRegions

hashtagSupported Regions

hashtagAPI Keys

hashtagQuota Limits

hashtagRate Limiting

AutoGrab Developer Hub

Recall Search

hashtagOverview

Vehicle ID Search

hashtagExample Response

Max Offer Configuration

OAuth Authentication

hashtagToken management

hashtagREST api call signing

API Key

hashtagKey Types

Overview

Environments

Regions

Supported Regions

API Keys

Quota Limits

Rate Limiting

Key Types

Secret API Key

Public API Key

Authenticating Requests

Other Authentication Methods

Token management

REST api call signing

Example Response

Overview

Overview

Creating a stock feed

Overview

Overview

Coverage

Overview

Example Implementations

Implementation

Position On Page

Event Listeners

Overview

Report Features

Workflow Overview

Overview

Environments

Regions

Supported Regions

API Keys

Quota Limits

Rate Limiting

Overview

Example Response

Token management

REST api call signing

Key Types

Secret API Key

Public API Key

Authenticating Requests

Other Authentication Methods

Creating a stock feed

Workflow Overview

Overview

Extrapolate Into Your Workflows

Get Market Data

Perform A Valuation

Limitations

Deal Gauge & Indicator

Valuation Widget

Market Insights Snapshot

Overview

Example Implementations

Implementation

Position On Page

Event Listeners

Overview

Report Features

Overview

Example Implementation Inputs

Example Implementation iFrame

Example UI

Position On Page

Event Listeners

Valuation

Price Record ID

Lead ID

Odometer

Brand

Marketplace Specific Fields

Sources

Vehicle Details

Odometer History

Build Data

Fitted Options

Valuation