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

API Test Cases

Test your requests in a safe zero-cost way through our test case set.

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

Test Cases

The test cases relate to each other with all related to the same set of vehicle IDs dependant on region.

Type

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?

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

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

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

{
    "vehicle": {
        "id": "5655899674771456",
        "region": "uk",
        "title": "2017 Toyota Hilux SR5 Auto 4x4 Double Cab",
        "year": "2017",
        "make": "Toyota",
        "model": "Hilux",
        "badge": "SR5",
        "series": "GUN126R",
        "model_year": "MY17",
        "release_month": 7,
        "release_year": 2015,
        "body_type": "Utility",
        "body_config": "Dual Cab",
        "transmission": "Sports Automatic",
        "transmission_type": "Automatic",
        "wheelbase": null,
        "wheelbase_type": null,
        "fuel": "Diesel",
        "fuel_type": "Diesel",
        "engine": "Piston",
        "engine_type": "Piston",
        "drive": "4x4 Dual Range",
        "drive_type": "Four Wheel Drive",
        "num_doors": 4,
        "num_seats": 5,
        "num_gears": 6,
        "num_cylinders": 4,
        "capacity_cc": 2755,
        "power_kw": 130,
        "torque_nm": 450,
        "range": 1127,
        "options": [
        ]
    },
    "success": true
}

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

Vehicle Data Basics

Get the level of detail you need on the vehicle you want.

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

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.

MOT & Tax Search

Search for the MOT and Tax status of a vehicle.

Overview

The MOT & Tax Search API allows you to obtain the current MOT and Tax status of a given vehicle based on its registration.

Vehicle History

Request a vehicles history on marketplaces

Overview

The Vehicle History API allows you to access historical lead listing data from a variety of used car marketplaces. This API requires authentication and an appropriate license attached to it.

The Endpoint operates on a tiered system of queries:

VIN - The first initial call can be made to VIN + Region. However, if VIN does not return any history information, the following data is required as a fallback.

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.

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 and an appropriate license attached to it.

Max Offer Configuration

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

Gauge API

Create your own price indication and benchmarking gauge.

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.

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.

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

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

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.

Vehicle Identification

Where-ever possible it is recommended to provide as much vehicle information as possible. What the data is used for is controlled by the sources array.

VIN
Registration/State - If registration is provided, state is mandatory
Odometer

Valuation

A previous valuation can be included in the report generation by adding the following data. What data is used for the valuation is determined on priority:

Price Record ID

If the pricing record ID is passed in the request, the associated valuation will populate the report. A valuation ID is generated using the endpoint and contained in the response. So, a valuation call needs to be performed before generating the report.

Lead ID

A lead ID is obtained from the endpoint and is the tier 2 valuation source.

Odometer

If no Pricing or Lead ID is provided but an odometer is, the odometer will be used to perform a valuation with the same logic as the endpoint.

Brand

Controls White labeling of the report

Marketplace Specific Fields

When using reports integrated within a marketplace additional fields can be included in the request to allow for data from the marketplace listing to be displayed in the report.

Marketplace Image URL
- URL to a public image from the marketplace listing, will replace the stock photo contained in a standard CarAnalysis Report

The Marketplace Image URL must end in a jpeg/jpg format. Magic links are not currently supported. i.e. www.marketplace.com/listing/vehicleimage.jpg. listing/vehicleimage/ will fail to generate.

Marketplace Price
- The price displayed on the listing on the marketplace.
- Note it is not possible to use the marketplace price and the valuation source in the same report.

Sources

What sources are available with your account are controlled at a feature level. To access particular sources, don't hesitate to get in touch with your AutoGrab representative.

The sources enum determines additional features that are included within the report PDF, the report is modular. However, it is recommended to include Vehicle Details at a minimum

Vehicle Details

Populates the Vehicle Information at the top of the report. It is recommended that vehicle details always be included as it contains the minimum identifiable information into the report.

Odometer History

It will display a table of all recorded odometer listings that AutoGrab has. Based on the odometer from previous listings, it can highlight the possibility of odometer rollback events.

Build Data

It will populate a table with built-data information, which is the same data obtainable from the endpoint in PDF format.

Fitted Options

Not currently available

Valuation

Whether to include an AutoGrab valuation in the report

Report White Labeling

AutoGrab can create custom-branded templates for the Car Analysis report. Please reach out to your AutoGrab representative for more information on building a custom template.

Obtaining Generated Reports

Due to the Car Analysis report reaching out to external endpoints and co-lating data the report is not generated immediately. It is recommended that the ID for the report be stored for future use or that the PDF be obtained again later.

To obtain the requested report, pass the ID from the POST to the get endpoint.

It is highly recommended that you delay the Get by at least 20 seconds before attempting the request to allow sufficient time for the report to be generated.

Example Report

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.

Facet Search

Use smart drop downs to find a vehicle.

Search for Vehicles by facets

The Vehicle Facets API allows you to narrow down the matching vehicle based on the vehicle's parameters. The facets available are: year, make, model, badge, series, transmission, body, body_style, fuel, engine and wheelbase.

If you would like to return aggregations of factes, use a comma-separated list in the facets field: eg. facets=badge,series,transmission.

Facets User Interface Example

This function is useful when supplying data to drop-downs for display on a form. A good example of using the Facets API is .

For a preview of how facets in implemented inside the AutoGrab web app see the video below.

Facet Integration Worked Example

Let's work backwards from the end result which is one or a few results for your user to pick from driven by previous drop-down. There are a few ways to make facets work for you, we'll go through the most common integration method.

Form your GET request for Makes

Ask your user to choose a make from the list then call all available models based on that selection. Let's say your user chose Toyota.

Form your request for a list of Models.

Ask your user to choose a Model from the list then call all available models based on that selection. Let's say your user chose Corolla.

Form your request for a list of Badges

Select A Badge A Load Vehicles From A Search

Ask your user to choose a badge from the list. Let's say your user chose Sprint. You can see the count is 3, meaning there are only 2 badges. You could send that directly to them or repeat the process with the year (&facet=year) to refine it further.

Let's say you'd like to present the three options to the user.

If you do not pay attention to the counts under each facet, there may be too many vehicles to search for. You will know you have triggered this limitation if you see the error below

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

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?

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:

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

{ "success": true, "vehicles": [ { "id": "5364630897557504", "region": "nz", "title": "1997 Toyota Corolla Sprint Manual", "year": "1997", "make": "Toyota", "model": "Corolla", "badge": "Sprint", "series": null, "model_year": null, "release_month": 9, "release_year": 1995, "body_type": "Hatchback", "body_config": null, "transmission": "Manual", "transmission_type": "Manual", "wheelbase": null, "wheelbase_type": null, "fuel": "Petrol", "fuel_type": "Petrol", "engine": "Piston", "engine_type": "Piston", "drive": "FWD", "drive_type": "Front Wheel Drive", "num_doors": 5, "num_seats": 5, "num_gears": 5, "num_cylinders": 4, "capacity_cc": 1587, "power_kw": null, "torque_nm": null, "range": null, "options": [] }, { "id": "6033133967245312", "region": "nz", "title": "1999 Toyota Corolla Sprint Manual", "year": "1999", "make": "Toyota", "model": "Corolla", "badge": "Sprint", "series": null, "model_year": null, "release_month": 9, "release_year": 1995, "body_type": "Hatchback", "body_config": null, "transmission": "Manual", "transmission_type": "Manual", "wheelbase": null, "wheelbase_type": null, "fuel": "Petrol", "fuel_type": "Petrol", "engine": "Piston", "engine_type": "Piston", "drive": "FWD", "drive_type": "Front Wheel Drive", "num_doors": 5, "num_seats": 5, "num_gears": 5, "num_cylinders": 4, "capacity_cc": 1587, "power_kw": null, "torque_nm": null, "range": null, "options": [] }, { "id": "6563011892346880", "region": "nz", "title": "1998 Toyota Corolla Sprint Manual", "year": "1998", "make": "Toyota", "model": "Corolla", "badge": "Sprint", "series": null, "model_year": null, "release_month": 9, "release_year": 1995, "body_type": "Hatchback", "body_config": null, "transmission": "Manual", "transmission_type": "Manual", "wheelbase": null, "wheelbase_type": null, "fuel": "Petrol", "fuel_type": "Petrol", "engine": "Piston", "engine_type": "Piston", "drive": "FWD", "drive_type": "Front Wheel Drive", "num_doors": 5, "num_seats": 5, "num_gears": 5, "num_cylinders": 4, "capacity_cc": 1587, "power_kw": null, "torque_nm": null, "range": null, "options": [] } ], "total": 3 }

{ "success": true, "fitted_options": [ { "build_sheet_lines": [ "4 alloy wheels \"Ventura\" 7.5J x 17", "Tires 225/45 R17 91W", "\"Ventura\" 7.5J x 17, tires 225/45 R17" ], "option_id": "1245", "option_code": "PJ3", "option_title": "Alloy wheels 17\" 'Ventura'", "option_details": [ "Front and rear wheels: 17 inch two-tone alloy rims ; width: 7.5 inches", "Front and rear tyres: 17 inch diameter, 225mm wide, 45% profile (official data)" ], "match_score": 0.9, "match_category": "Matched", "msrp": 675 }, { "build_sheet_lines": [ "\"drive select\"" ], "option_id": "1248", "option_code": "PDD", "option_title": "Dynamic Chassis Control (DCC)", "option_details": [ "Driver selectable electronic responsive suspension", "Selectable driving modes that affect suspension" ], "match_score": 0.7, "match_category": "Matched", "msrp": 1045 }, { "build_sheet_lines": [ "Side windows in heat-insulating glass, from B-pillar and rear window dark tinted" ], "option_id": "1249", "option_code": "4KF", "option_title": "Rear tinted glass", "option_details": [ "Privacy glass on the rear window and on the rear side windows" ], "match_score": 0.7, "match_category": "Matched", "msrp": 275 }, { "build_sheet_lines": [ "Automatic headlight control with LED separate daytime running light and entry and exit lighting" ], "option_id": "1271", "option_code": "PXD", "option_title": "IQ.Light - LED Matrix headlights inc dynamic cornering", "option_details": [ "LED low beam LED high beam headlights", "LED dipped headlights, rear lights and main beam headlights", "Headlight control systems: steering sensor, speed sensor, active high beam, automatic height adjustment, internal height adjustment and matrix" ], "match_score": 0.7, "match_category": "Matched", "msrp": 1940 }, { "build_sheet_lines": [ "voice control" ], "option_id": "1256", "option_code": "QH1", "option_title": "Voice Control", "option_details": [ "Voice activating system includes audio player, phone, sat nav and air-con" ], "match_score": 0.7, "match_category": "Matched", "msrp": 225 }, { "build_sheet_lines": [ "multifunction camera" ], "option_id": "1265", "option_code": "KA2", "option_title": "Rear view camera", "option_details": [ "Rear sensor & camera-type parking distance system", "Rear/reverse parking guidance display" ], "match_score": 0.7, "match_category": "Matched", "msrp": 330 } ] }

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

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

{ // The Webhook Event type (required) "event": "recapture_new", // The Webhook Event payload (required) "data": { // The Recapture record which has been seen online "customer": { // The internal ID of the Recapture client (required) "id": "05df2f33-1d03-404c-b0c2-dfbecaa65fff", // Required // The ISO timestamp when the event took place (required) "last_updated": "2022-09-03T00:37:57.095Z", // The registration plate that you were tracking (nullable) "rego": "BMT038", // The VIN uploaded for the Recapture customer (nullable) "vin": null, // The name uploaded for the Recapture Customer (nullable) "client_name": "Raph", // The mobiule number uploaded for the Recapture Customer (nullable) "mobile_number": "+61 123 456 789", // The ISO formatted sale date uploaded alongside the customer record, if applicable (nullable) "sale_date": "2022-03-02T00:00:00.000Z", // The ISO formatted expiry date for the Recapture customer record, if applicable (nullable) "expiry_date": "2022-11-20T00:00:00.000Z", // The vehicle title, determined by a registration or listing lookup (nullable) "vehicle_title": "2019 Volkswagen Polo 85TSI Comfortline", // Any additional data that was uploaded alongside the customer record (required) "additional_fields": { "notes": "Three free services included in package" }, // An array including details for each time one of the customer's vehicles was spotted online (required) "sightings": [ { // The date when the vehicle was spotted online (required) "at": "2022-09-03T00:37:57.095Z", // The AutoGrab Lead ID that includes the listing where the vehicle was spotted online (required) "lead_id": "au_volkswagen_bmt038", // The URL where the vehicle was listed online (required) "listing_url": "https://www.carsales.com.au/cars/details/2019-volkswagen-polo-85tsi-comfortline-aw-auto-my19/OAG-AD-20356677", // The title of the listing (required) "listing_title": "2019 Volkswagen Polo 85TSI Comfortline AW Auto MY19", // The price that the vehicle was listed for at the time of capture (nullable) "listing_price": 26890, } ] } } }

{ // The Webhook Event type (required) "event": "valuation_change", // The webhook event payload (required) "data": { // The pricing record which has changed in value "pricing_record": { // The unique Pricing Record ID (required) "id": "a9fb47f6-3d1d-4945-9f4d-f45b12a63797", // The AutoGrab Vehicle ID associated with the pricing record (required) "vehicle_id": "5478860653068288", // The ISO timestamp when the pricing record was first created (required) "created_at": "2022-08-20T07:20:32.412Z", // The registration plate associated with the pricing record (nullable) "rego": "ZXX678", // The VIN associated with the pricing record (nullable) "vin": null, // The odometer input for the pricing record (required) "kms": 32000, // The current price prediction for the given vehicle at the kilometers entered (required) "price": 36782, // The current predicted retail price (required) "retail_price": 36782, // The current predicted trade price (required) "trade_price": 32100, // The adjustments and overrides that are currently applied to the pricing record (nullable) // Matches the adjustment schema from the `/v2/valuations/predict` endpoint "adjustment": null, // An array of all the recorded valuation changes that this pricing record has had (required) "changes": [ { // The unique change ID (required) "id": "ba4b3912-ae25-44c1-8a66-36ca68fac859", // The change type (valuation or configuration) (required) // A valuation change implies that the market has shifted, // whereas a configuration change is simply a result of your // adjustments/overrides configuration changing "type": "valuation", // The ISO timestamp when the change occurred (required) "at": "2022-09-03T01:03:55.382Z", // The new price (required) "new_price": 36782, // The new retail price (required) "new_retail_price": 36782, // The new trade price (required) "new_trade_price": 32100, // The old price (required) "old_price": 38520, // The old retail price (required) "old_retail_price": 38520, // The old trade price (required) "old_trade_price": 34200 }, { // Any previous changes to the pricing record will also be // included here, following the same schema as above "id": "46610b56-f3c7-4744-8adf-021c0aba1cc4", "type": "configuration", "at": "2022-09-01T03:12:32.524Z", "new_price": 38520, "new_retail_price": 38520, "new_trade_price": 34200, "old_price": 38520, "old_retail_price": 37520, "old_trade_price": 33900 } ] }, // This is a copy of the specific valuation change that caused the webhook to trigger (required) // in case many changes occur in a short timespan, this is the source of truth for the // exact change that triggered the event. "change": { "id": "ba4b3912-ae25-44c1-8a66-36ca68fac859", "type": "valuation", "at": "2022-09-03T01:03:55.382Z", "new_price": 36782, "new_retail_price": 36782, "new_trade_price": 32100, "old_price": 38520, "old_retail_price": 38520, "old_trade_price": 34200 } } }

🇬🇧 UK AutoGrab API Doc

AutoGrab Basics

AutoGrab Developer Hub

Integration Overview

hashtagOverview

hashtagEnvironments

hashtagRegions

hashtagSupported Regions

hashtagAPI Keys

hashtagQuota Limits

hashtagRate Limiting

API Test Cases

hashtagTest Cases

FAQ

Authentication

API Key

hashtagKey Types

OAuth Authentication

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

Vehicle Data Basics

Recall Search

hashtagOverview

MOT & Tax Search

hashtagOverview

Vehicle History

hashtagOverview

Factory Build Data

hashtagOverview

hashtagCoverage

Valuation

Valuation Basics

Max Offer Configuration

Gauge API

hashtagExample Post Body

Embeddable Products

Embeddable Basics

Valuation Widget

hashtagOverview

hashtagExample Implementations

hashtagImplementation

hashtagPosition On Page

hashtagEvent Listeners

Market Overlay Widget

hashtagOverview

hashtag

Reports

Customer Recapture

Insurance

Pre-Accident Valuation

hashtagWorkflow Overview

Integration Overview

hashtagOverview

hashtagEnvironments

hashtagRegions

hashtagSupported Regions

hashtagAPI Keys

hashtagQuota Limits

hashtagRate Limiting

AutoGrab Developer Hub

Sourcing Basics

Recall Search

hashtagOverview

OAuth Authentication

Marketplace ID Lookup

hashtagOverview

MOT & Tax Search

hashtagOverview

Market Statistics

Overview

Environments

Regions

Supported Regions

API Keys

Quota Limits

Rate Limiting

Test Cases

Key Types

Example Response

Overview

Overview

Creating a stock feed

Overview

Overview

Overview

Overview

Coverage

Example Post Body

Overview

Example Implementations

Implementation

Position On Page

Event Listeners

Overview

Workflow Overview

Overview

Environments

Regions

Supported Regions

API Keys

Quota Limits

Rate Limiting

Overview

Overview

Overview

Overview

Creating a stock feed

REST api call signing

Limitations

Market Overlay

Market Statistics

Example Response

Overview

Example Implementations

Implementation

Position On Page

Event Listeners

Test Cases

Key Types

Workflow Overview

Example Post Body

Public API Key

Authenticating Requests

Other Authentication Methods

Supported Endpoints

Implementation Guide

Extrapolate Into Your Workflows

Get Market Data

Perform A Valuation

Use Case Driven Implementation Examples

Marketplace Implementation

Dealer Website Implementation (AutoGrab Customer)

Dealer Website Implementation (Non-Direct Customer)

Text Search

Vehicle Registration Mark Search

Facet Search

Vehicle ID Search

Marketplace ID

Recall Search

MOT & Tax Search

Vehicle History

Factory Build Data

Factory Fitted Options

Current Valuation

Residual Valuation

VIN & Rego Valuation

Max Offer Configuration

AutoGauge

Deal Gauge & Indicator