Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
Vehicle Search
Find vehicles in our comprehensive, regional databases using plain text search, aggregate field lookup & state vehicle registration.
Vehicle Valuation
Value new & used vehicles from our database, and calculate trade-in price & future value using our highly accurate pricing model.
Vehicle Data
Find descriptive data on vehicles to enrich your user experiences or power your backend workflows.
Vehicle History
View a vehicle's history as it moves through marketplaces over time.
Sourcing
The Sourcing API allows you to access lead and listing data from a variety of used car marketplaces.
Customer Recapture
Track your past customers and get notified when they list vehicles for sale online.
Embeddable Products
Explore products like Valuation Widget, Deal Gauge and more.
Certificates
Generate PDF certificates to show valuations or vehicle details in your own workflows.
Webhooks
The Webhooks API allows you to configure endpoints that will receive PUSH events from the platform.
We support API Key based authentication, recommended if you build applications to integrate with our platform.
A secret API key is for the server side and should not be shared with the front end.
Example Key: sec_23hcfb8374bfhc833i4uhx
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
When making requests to the APIs, include the key in your request.
We also support , you can read more about this authentication mechanism here.
Key things to know before you start.
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.
Production V2
https://api.autograb.com.au/v2/
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.com.au/v2/vehicle/239c8928fnc934fc?region=uk
United Kingdom
uk
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.
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.
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.
Rate-Limit-Remaining
60
Number of remaining requests until the limit is reset.
Rate-Limit-Total
60
Number of total requests that can be made until the limit is reset.
Rate-Limit-Reset
1609459200
The timestamp of when the limit will reset.
Monthly-Base-Request-Quota
100
Number of requests included in your contract.
Monthly-Max-Request-Quota
100000
Maximum number of requests allowed in your contract.
Monthly-Request-Total
100
Monthly requests performed for this request type.
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
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.
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.
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.
The test cases relate to each other with all related to the same set of vehicle IDs dependant on region.
Registration Plate
United Kingdom
REG4SUCCESS
Returns a successful lookup response with a high-quality vehicle match
Registration Plate
United Kingdom
REG4WARNING
Returns a successful lookup response with a low-match quality warning
Registration Plate
United Kingdom
REG4NOMATCH
Returns the VIN and vehicle description but no matching vehicle
Registration Plate
United Kingdom
REG4VINONLY
Only returns the VIN and no other vehicle details
VIN
Australia
00000000000000000
Returns a valid VIN match in Australia
VIN
Malaysia
00000000000000001
Returns a valid VIN match in Malaysia
VIN
New Zealand
00000000000000002
Returns a valid VIN match in New Zealand
Vehicle ID
Australia
1111111111111111
Can be used for /Predict or /Sourcing to return outcomes.
Vehicle ID
Malaysia
2222222222222222
Can be used for /Predict or /Sourcing to return outcomes.
Vehicle ID
New Zealand
3333333333333333
Can be used for /Predict or
/Sourcing to return outcomes.
Test cases are supported across a range of API endpoints listed below. If the endpoint you are testing with is not listed get in touch to request test data.
/valuations/predict
/valuations/vins
/valuations/registrations
/valuations/residual
/valuations/predict/conditions
/sourcing/market_overlay
/sourcing/market_overlay/statistics
An example implementation could run a test as part of an integration test or development process. For example, you could test a valuation flow by first using a registration plate to get the ID (which is also test data) and send that to a /predict to get a valuation and a market overlay.
These are frequently asked questions about AutoGrab and our products.
Get vehicle details from a VIN.
The Vehicle VIN API allows you to search for vehicles by VIN. The request requires only a region, VIN, and API key. It will either return a matching vehicle with possible option packs or a null.
You can request more data than the standard payload by leveraging the features described below.
This feature will return structured descriptive data from the registration authority. Use features=additional_upstream_data to receive this payload.
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 and an appropriate license attached to it.
Use smart drop downs to find a vehicle.
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.
For a preview of how facets in implemented inside the AutoGrab web app see the video below.
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.
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.
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.
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
A special use case endpoint for our marketplace customers to find their own leads on AutoGrab systems.
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.
Be approved to access this special use case endpoint, contact your account manager.
Be aware of your listing ID and use that for the marketplace_id parameter.
Be aware of your marketplace identifier, it is your public domain name, e.g drive.com.au
You are only able to search for a vehicle once it is present on our service. If you receive the error below this means we are not yet aware of the listing due to its recency.
This function is useful when supplying data to drop-downs for display on a form. A good example of using the Facets API is .
In this scenario, we recommend falling back to a test lookup using the title in its most descriptive format. E.g 2024 Nissan X-TRAIL Ti Wagon Ti 2.5L SUV 4WD.
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.
Find vehicle information from a vehicle registration mark.
The Vehicle Registration API allows you to search for a vehicle by supplying its number plate. The request requires a region, the state (dependent on the region), the number plate, and the API key. It will return either a matching vehicle or a null.
You can request more data than the standard payload by leveraging the features described below.
This feature will return structured descriptive data from the registration authority. Use features=additional_upstream_data to receive this payload.
If a matching vehicle cannot be identified in all cases, we will return the upstream_vehicle field, allowing you to identify how the relevant road transport authority describes the car. Depending on your use case, you may wish to allow front-end users to manually classify the vehicle using the guide to fill out a Facet-style.
Refer to reference material for more information on supported OEMs.
Get results with a text string search
The Vehicle Search API allows you to search for matching vehicles by plain-text input. The API will return an array of vehicles and the confidence score in a match for that given vehicle.
The request requires a region, search string & API key. The default page length is 10, however, you can adjust this based on your requirements.
Example Payload
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 and an appropriate license attached to it.
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.
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.
vehicle_id
The ID of the vehicle you are requesting a market overlay on.
minimum_days
The minimum number of days to show listings for
Default value : 60
include_adjacent_years
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.
Default value : false
--true / false
exclude_outliers
If enabled, leads that are considered outliers will be excluded from the results.
Default value : false
--true / false
exclude_all_delisted
If enabled, leads that are not currently on the market will be excluded from the results.
Default value : false
--true / false
include_all_active
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.
Default value : false
--true / false
include_trash
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.
Default value : false
--true / false
features
Comma-separated array of additional overlay feature codes as specified in your contract
odometer_range_min
The minimum range observed against similar vehicles
Example : 50000
odometer_range_max
The maximum range observed against similar vehicles
Example : 100000
region
--au
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.
This feature will deliver the contact details of the advertising dealership as per the listing. Use features=dealer_contact_details
This feature will deliver the initial price the lead was advertised at. Use features=lead_starting_price
This feature will deliver the listing URLs related to the lead across all sites it is listed on. Use features=listing_urls
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
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
This feature will deliver the primary listing description for each record where available. Use features=primary_description
This feature will deliver the vehicle's registration plate in the market overlay payload. Use features=rego
This feature will deliver the vehicle's VIN in the market overlay payload. Use features=VIN
This feature will deliver the vehicle's stock number in the market overlay payload. Use features=stock_no
This feature will deliver the average kms and average odometer of the overlay calculated for you in the response. Use features=avg_kms
This feature will deliver the average price of the overlay calculated for you in the response. Use features=avg_price
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 .
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
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
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.
Generate market accurate predictions for vehicles.
The Valuation API can be used to determine the present retail & trade values, as well as the residual values of new vehicles.
To use the API, a Vehicle ID returned from the Vehicle Search API or Vehicle Facet API is required.
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
Request
Starting with a vehicle ID post it to /v2/valuations/predict
Response
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.
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.
Poor
1
Fair
2
Average
3
Good
4
Excellent
5
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
If you require the upper and lower bounds used to calculate a prediction, you can use features=bounds.
Copy
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.
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
To adjust the stored Recommended Retail Price you can supply a rrp_adjustment value in the payload which accepts a number — positive or negative.
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
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
This API requires and an appropriate license attached to it.
To retrieve a Vehicle ID, use the .
The is optional and can be used to further refine your pricing prediction.
The Valuation API set allows you to predict current and future prices on vehicles. This API requires and an appropriate license attached to it.
Predict the future value of a vehicle.
The Residual Value prediction API uses current market trends to influence the depreciation curve of newer vehicles. The API allows you to influence the outcome of the prediction by either mutating stored Recommended Retail Price, or by providing your own Retail Value for the car.
Request a vehicles history on marketplaces
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.
Year
Make
Model
Registration
Year
year
2019
Make
make
Volkswagen
Model
model
Polo
Registration Plate
registration_plate
BMT038
Vin
VIN
KL3TA48E9CB053071
The Make, Model fields are format-sensitive and rely on AutoGrabs Vehicle Search or ID lookup formatting. If using unsupported make and model descriptions, the vehicle history will not be returned when otherwise it could have been using the correct formatting.
The Vehicle History endpoint delivers detailed information on events related to a listing. The following events are possible on a given listings.
Listing - the detection of a listing being added to its relevant marketplace.
Delisting - the detection of a listing being removed from its relevant marketplace, this is frequently and reliably related to a sale of the vehicle.
Price Change - the detection of a movement in the price, see the features section below for more information.
To perform an example request:
An example payload is included below to illustrate a potential response.
You can opt to enrich your vehicle history payload by passing in a feature or features separated by commas.
Price Changes
Currently we support the price_changes feature that will show you fluctuations in the price. Passing this feature will return upward on downward movements in the listings price.
Contact your sales rep to understand your commercial rate card for each feature.
Request data the vehicle was fitted with at the factory
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.
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
Bentley
BMW
Buick
Cadillac
Chevrolet
Chrysler
Citroën
Dacia
Daewoo
Dodge
DS
Fiat
Ford
GMC
Hummer
Hyundai
Isuzu
Jaguar
Jeep
KIA
Lancia
Land Rover
Lincoln
Maybach
Mercedes-Benz
MINI
Opel
Porsche
Peugeot
Renault
Rolls-Royce
Saab
SEAT
Skoda
smart
Vauxhall
Volkswagen
Volvo
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.
For basic fittable options, that is the options packs available on the vehicle refer to the or endpoints.
Set and update your max offer config to refine your price predictions.
Get the options fitted to a given vehicle by VIN.
The Factory Fitted Options (FFO) API provides a record of the optional features (as opposed to standard features) that a vehicle had when it left the factory. It achieves this by:
Using advanced machine learning models to distinguish between standard and optional features.
Scoring and structuring the data into an API response for downstream use.
The final output is a list of fitted options, including a confidence score and other relevant details.
The response provides a fitted option report and can be interpreted using the following table.
build_sheet_lines
"LEVER FINISHing - METAL PAINT", "FUEL FILLER Door FINISHing - BODY COLOR
These are the lines in the build sheet, received from the OEM, that the FFO system has determined to be correlated to an optional extra.
option_id
1037
This is the option_ID as available in the JATO dataset.
option_code
JATOMET
This is the option_code as available in the JATO dataset.
option_title
Metallic paint
This is the option_title as available in the JATO dataset.
option_details
Metallic paint, two-tone metallic paint
This gives a detailed description of the option specified in the option_title
match_score
0.7
This is the confidence score of the match.
The match_score categories are given below. Refer to the “Understanding The Option Match Score” section below for more information.
match_category
Matched
The various values for match_category are explained below.
msrp
600
This is the MSRP (the price of the option) as available in the JATO dataset. Expressed in local currency.
Matched
The option was included on the build sheet. The confidence is based on the similarity of the build sheet description(s) to the JATO option title and details.
Included directly by <option>
Because <option> is fitted, this option is included free of charge. This option may or may not have also been matched from the build sheet. If this option was also matched from the build sheet, the confidence may be increased.
Required directly by <option>
Because <option> is fitted, this option must be included at an additional cost. This option may or may not have also been matched from the build sheet - if so the confidence may be increased.
Price changed directly by <option>
Because <option> is fitted, this option is charged at an adjusted price. The MSRP will be updated to reflect this. This option may or may not also be matched on the build sheet, and if so the confidence may be increased.
Included recursively by <option>
This option is included free of charge due to a chain of dependencies that involves <option>. This option was not matched directly, and the confidence will be lowered to indicate this.
Required recursively by <option>
Because of an existing chain of option dependencies, this option must be included. However, this option was not matched directly, so the confidence will be lowered.
Prerequisites Met
All of the included options in this option pack were already matched, so this pack has been added as well, because it causes the overall price to be lower than if the options were individually included.
The “Technical Description” is for integration partners who need to understand what's at play behind the scenes. The “Public Facing Description” is a simplification of the technical description that boils it down to a basic likelihood scale.
The match score runs from 0.6 to 1 with no other responses supported outside this range.
Due to the multiple external and internal API calls and the nature of LLM model responses below covers expected average response times for the fitted options API based on AutoGrabs internal benchmarking.
certain OEM build sheet providers have widely varying response times
some DVLA responses are slower
Couples with the compute time for the model to generate the fitted options, this can extend the processing time before a successful response is returned by the API.
Excluding VRM Lookup below is our average benchmark across our internal test set of 100 VINs:
Average
2.75
Min
1.00
Max
19.8
Our DVLA VRM connection benchmarks at the following speeds across our test set:
Average
0.44
Min
0.21
Max
0.76
Obtaining a vehicle ID using
Requesting a from OEM partners to determine the original factory specifications.
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.
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.
If you are a marketplace you will store your own marketplace IDs against each listing. You can submit those via the request body to produce an AutoGauge response.
As a customer with an existing AutoGrab API integration, you will likely have stored the AutoGrab IDs from vehicle search steps you've previously taken. In this case supply your known vehicle_id as part of the request. This is the lowest-cost implementation as it does not require a VIN or Registration search.
As an app or new customer, you may only have the VIN and registration information for your vehicles. You can pass them into the request body as below.
Receive notifications from AutoGrab system on events to power your own experiences.
The Webhooks API allows you to configure endpoints which will receive PUSH events from AutoGrab.
There are several types of events that you can listen to using the Webhooks API. The names and descriptions of each of these events are included below.
You can find example payloads for each of these events at the bottom of this page.
ping
If you use the POST /v2/webhooks/{WEBHOOK_ID}/ping endpoint, your webhook will be called with the ping event to test the connection.
recapture_new
One of your Recapture customers was spotted on a used car listing website.
recapture_price_change
The listing price on one of your active Recapture customers changed.
recapture_delist
One of your Recapture customers removed their vehicle listing - either to cancel the sale or because it has been sold.
valuation_change
One of your previous price predictions has changed by (at least) the threshold defined in your valuation changes config (/valuations/changes)
Currently, only the ping, recapture_new and price_change events are in use. You can still configure your webhooks to listen to the other events to enable these events once they are supported.
If you need immediate access to Recapture price change and delist events for your use case, please reach out to us at info@autograb.com.au
To set up a webhook event subscriber, you'll first need to create the webhook using the webhook API.
You must provide a few options in the request body:
name: A name for the webhook. This is used for reference only.
region: The region that you want to subscribe to events in (uk)
format: The format that you want the PUSH events to be sent in (Currently, only json is supported)
endpoint: The HTTP endpoint that you want the webhook to push to. You can include URL parameters in this to facilitate token-based auth.
To perform an example request:
An example response payload is:
A GET request to /v2/webhooks?region=uk will return a list of all your configured webhooks in the given region.
To perform an example request:
An example response payload is:
A GET request to /v2/webhooks/{WEBHOOK_ID}?region={REGION} will return the configuration of the webhook with the corresponding ID.
The payloads are the same as the /v2/webhooks route but only a single webhook is returned instead of an array.
If you try to access a webhook in a different region to the one specified in the request, you will receive an Invalid Region error. Additionally, accessing a webhook that your account does not have permission to view will return a You don't have permission to access that webhook error.
If you attempt to view a webhook that doesn't exist, you will receive an Invalid Webhook ID error.
Example
To perform an example request:
An example response payload is:
A PATCH request to /v2/webhooks/{WEBHOOK_ID}?region={REGION} allows you to modify any of the properties of the corresponding Webhook.
Only the fields specified in the request body will be modified, and passing a blank ("") value will remove the property from the webhook where applicable.
The response includes the updated webhook, as well as a map of every property that changed.
The same errors as the above (GET /v2/webhooks/${WEBHOOK_ID}) request apply, and a Request validation failed error may also be thrown if you provide any invalid Webhook Event names. Refer to the top of this page for a list of Webhook Events and their descriptions.
Example
To perform an example request:
An example response payload is:
A DELETE request to /v2/webhooks/{WEBHOOK_ID}?region={REGION} will permenantly delete the webhook.
The response payload includes the configuration of the deleted webhook, as seen in the examples below.
You may receive a small number of additional messages on your webhook's endpoint after deleting the webhook due to queued messages being sent through, but no new messages will be sent to your webhook after it has been deleted, and there is no way to recover the webhook without re-creating it.
Example
To perform an example request:
An example response payload is:
A POST request to /v2/webhooks/{WEBHOOK_ID}/ping?region={REGION} will send a ping event to your webhook with an example payload.
You can't explicitly subscribe to ping events, as it is a special event type that is only sent when requested using this endpoint.
Example
To perform an example request:
An example response payload is:
Example payloads for the webhook events that are currently in use are included below.
pingrecapture_newvaluation_change
This API requires and an appropriate license attached to it.
You can explore this request further in the .
You can explore this request further in the .
You can explore this request further in the .
You can explore this request further in the .
You can explore this request further in the .
You can explore this request further in the .
The Valuation Widget offers an easy-to-configure and install instant cash offer journey for your website.
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.
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.
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.
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.
The Market Overlay widget system provides insights into the marketability of a given car in a marketplace.
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.
Speak to your sales rep about your desired implementation pattern. We will supply you with staging and production iFrame url code as part of your deployment process.
Implementation of the trigger to present this iframe is the responsibility of the site owner.
There are two options for the implementation of the overlay:
Auto-Search
By providing a stringified vehicle description, AutoGrab will automatically match the vehicle based on the description and value based on the odometer provided when triggering the overlay widget. If the vehicle is incorrect, the user can override it.
Manual Selection
If no vehicle description and odo are provided, the overlay will prompt the user to select a vehicle manually from a set of dropdowns.
You must implement you own trigger button to launch the iframe and load in all required inputs as below.
To load the iframe you need to share the following input variables.
Region
The country you would like to load insights for.
UK
Required
Odometer
The odometer of the vehicle used in the valuation process
1000
Optional
Vehicle_Description
The most descriptive title of the vehicle you can provide so we can match it to our catalogue.
2014 Tesla MODEL S Model S Electric Sedan
Required
API_Key
Your API key used to securely load the iframe and load your brand configuration.
123ABC
Required
You have two options to embed the iframe inside your website. In both these options, it is critical that you set the iframe width to 650px and centered.
Popup - holding the iframe in a popup container and ensuring you conform to the AUTOGRAB_INSIGHTS_HIDE to event listening to close the popup container and AUTOGRAB_INSIGHTS_DIMENSIONS resize the height dynamically.
On Page - holding the iframe on a page ensuring you let us know so we can remove the close button. Since the page can still extend vertically you need to respond to the AUTOGRAB_INSIGHTS_DIMENSIONS alert.
The valuation widget will send messages you need to pay attention to via the iframe postMessage function. The messages are as follows.
AUTOGRAB_INSIGHTS_SUCCESS
The widget loaded successfully, no intervention is needed.
AUTOGRAB_INSIGHTS_ERROR
There was an exception or error delivering the iframe contents.
AUTOGRAB_INSIGHTS_HIDE
The close button at the end of the workflow or close X in the interface has been pressed.
AUTOGRAB_INSIGHTS_DIMENSIONS
The iframe has resized due to changed in the contents. Please respond by resizing the iframe container to hold the new contents without cropping.
The Customer Recapture API allows you to upload, view and delete Customer Recapture customers.
The main purpose of the Customer Recapture API is to facilitate the automated upload of new Recapture customers.
Customer lists are often very long, so the Customer 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.
A POST request to https://api.autograb.com.au/v2/recapture/upload?region=uk will initiate a new queued customer list upload.
The request body has three key parameters:
name: A name to assign to the upload, for personal reference
enable_rego_lookups: When rego lookups are enabled, if the registration plate 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 record 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.
customers: An array of the customers that you want to upload. Customers can have any of the following properties, but everything is optional (however, at least a rego OR a vin is necessary for tracking purposes):
rego: The registration plate of the customer's vehicle
vin: The Vehicle Identification Number corresponding to the customer's vehicle
client_name: The name of the customer/client, for reference purposes
mobile_number: The customer's phone number. This is used for reference purposes, as well as to find other listings that the same customer has posted online.
sale_date: The date that the vehicle was sold to the customer, if applicable. For reference only.
expiry_date: If provided, the customer will be automatically deleted from our system on this date. This may be useful for insurance clients where the customer is no longer of interest after a policy ends, for instance.
additional_fields: A map of any other properties that should be saved along with the customer record.
If you try to upload an empty list, you will receive a You must upload at least one customer record error.
Example
To perform an example request:
An example response payload is:
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=uk 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 Recapture 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:
If you queue a customer upload and later change your mind, you can cancel the upload, stopping the creation of any more customer records.
The response payload will include the details of the deleted upload.
Example
To perform an example request:
An example response payload is:
Once you have uploaded a customer list, you are able to use the Customer Recapture API to view your newly uploaded customers, as well as edit and delete individual customer records.
You can use the /v2/recapture/customers?region=uk endpoint to retrieve a list of all your Recapture customers.
This list is paginated, and you can move between pages using the offset and limit query parameters.
If you want to get customer records associated with a specific upload, you can pass the unique Upload ID to the upload_id query parameter.
Example
To perform an example request:
An example response payload is:
You can get individual customer details using the GET method on /v2/recapture/customers/${CUSTOMER_ID}?region=uk.
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 an You don't have permission to access that customer error. If you try to lookup a customer that exists in a different region than the one specified in the request, you will receive an Incorrect Region error.
Example
To perform an example request:
An example response payload is:
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=uk endpoint.
Only the fields that you specify in the request body will be affected, and providing an empty value ("") will set the field to null where applicable.
The response payload will include the updated customer object.
You can update any of the following customer properties: - client_name - mobile_number - sale_date - expiry_date
Example
To perform an example request:
An example response payload is:
You can delete an individual customer by using the DELETE method on the /v2/recapture/customers/{CUSTOMER_ID}?region=uk endpoint.
The response payload includes the details of the customer that was deleted, and there is no way to retrieve the customer other than manually re-creating it.
The same error messages apply as with the Get Customer endpoint.
Example
To perform an example request:
An example response payload is:
You can find an example of the valuation widget operating on the. For a more brand / corporate imagery-compliant implementation refer to
This API requires and an appropriate license attached to it.
You can explore this request further in the .
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.
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.
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’.
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’)
With VIN
With Rego & State
With Marketplace/Marketplace ID
With Vehicle Description
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.
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.
You can access this over API if you would like to make your own implementation over the iFrame,.
Get a vehicle by its VIN
Plate number of the registered vehicle
Comma separated list of additional registration lookup data codes, if using (e.g. additional_upstream_data)
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.
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Allows caller to retrieve specific counts of available vehicles according to specific facet filters
The maximum number of results to return per facet query
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Search for vehicles by facets - minimum of year, make and model are required to return results and additional facets
The build year of the vehicle
The make of the vehicle
The model of the vehicle
The badge of the vehicle
The series of the vehicle
The specific transmission type (e.g. Sports Automatic, Automated Manual, etc...)
The basic transmission type (i.e. Automatic, Manual or Reduction Gear)
The body type of the vehicle (e.g. Hatchback, Sedan, etc...)
The fuel type of the vehicle (e.g. Petrol, Diesel, etc...)
The specific drive type (e.g. AWD, 4WD, 4x4 Dual Range, etc...)
The basic drive type of the vehicle (e.g. Front Wheel Drive, Rear Wheel Drive, etc...)
The maximum number of results to return per facet query
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Create a stock feed.
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Get a vehicle by its marketplace
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Get the lead statistics used to justify pricing for a given AutoGrab Vehicle ID.
The minimum number of days to show listings for
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.
If enabled, leads that are considered outliers will be excluded from the results.
If enabled, leads that are not currently on the market will be excluded from the results.
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.
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.
Comma separated array of additional overlay feature codes as specified in your contract
The minimum range observed against similar vehicles
The maximum range observed against similar vehicles
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Get a vehicle by its registration number
Plate number of the registered vehicle
State is used in the AU region to narrow down a numberplate
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.
Comma separated list of additional registration lookup data codes, if using (e.g. additional_upstream_data)
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Perform a recall check on a vehicle's registration
Plate number of the vehicle
Search for a vehicle with a query string
The query by which to search the cars
The number of vehicles to be returned
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.
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Get the leads used to justify pricing for a given AutoGrab Vehicle ID.
The minimum number of days to show listings for
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.
If enabled, leads that are considered outliers will be excluded from the results.
If enabled, leads that are not currently on the market will be excluded from the results.
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.
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.
Comma separated array of additional overlay feature codes as specified in your contract
The minimum range observed against similar vehicles
The maximum range observed against similar vehicles
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Get a listing of vehicle history events
The vehicle VIN
The vehicle registration plate
The vehicle year
The vehicle make
The vehicle model
The vehicle history id
The vehicle marketplace
The vehicle marketplace id
Vehicle history events start date filter as UTC or Unix timestamp string in seconds
Vehicle history events end date filter as UTC or Unix timestamp string in seconds
Comma separated array of additional vehicle history feature codes as specified in your contract
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
The VIN number that is used to look up the vehicle build data
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
Post or update a stock item.
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
The stock item region
ISO 8601 created at utc date and time string
ISO 8601 updated at utc date and time string
ISO 8601 checked at utc date and time string
ISO 8601 stocked at utc date and time string
ISO 8601 removed at utc date and time string, only to be supplied for items that have been removed
The stock condition
The stock number
The registration plate
ISO 8601 rego_expiry utc date and time string
The Vehicle Identification Number
The vehicle year
The vehicle odometer reading
The vehicle body colour
The vehicle description
The vehicle make
The vehicle model
The vehicle series
The vehicle badge
The vehicle tranmission
The vehicle location
The vehicle suburb
The vehicle postcode
The vehicle latitude
The vehicle longtitude
The vehicle price excluding government charges
The vehicle drive away price
The vehicle purchase price
The vehicle video url
Value a vehicle using an AutoGrab ID
The AutoGrab Vehicle ID which corresponds to the vehicle that should be valued
The odometer reading of the vehicle. If no reading is provided, the average value will be subsituted
The registration plate of the vehicle, for reference purposes only
The registration state of the vehicle, if applicable
The VIN of the vehicle, for reference purposes only
Calculate future values for a vehicle using an AutoGrab ID
010000Upsert a max offer configuration
The region to perform this request in
Either a percentage of a total or a fixed value
Either a percentage of a total or a fixed value
Either a percentage of a total or a fixed value
Either a percentage of a total or a fixed value
Either a percentage of a total or a fixed value
Get fitted options for a vehicle
The Vehicle ID to get fitted options for, using the specified catalogue
829630320230801The vehicle catalogue that you are using (autograb or jato)
jatoPlate number of the registered vehicle
WVWZZZCD3RW836864Produce the inputs to make a gauge UI based on vehicle or listing-driven inputs
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
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.
To begin the journey you will need to convert a real-world identifier into a vehicle ID to progress through the wider set of data. You can do this in four common ways;
For example, the response from a Registration search is below. Importantly you want to identify the ID, "id": "5932950835167232" for use in future steps.
To enrich your Overlay information we suggest employing additional features. For this use case, those are
- the most common identifier consumers and agents are familiar with.
- for unregistered or for scenarios where a plate is not known
- for scenarios where a standard identifier is not known or where the data delivered from upstream (Road Authority) is not reliable.
Explore
We offer a range of data enrichment packs to deliver more information in your registration or VIN lookups, . Consider the usage of the compliance information or vehicle age products.
To understand the position of that vehicle in the market you would call on the y service. This would deliver you a large payload of information on the competitive set of the vehicle.
- to get all the images attached to the lead inside AutoGrab.
- to get the primary detailed description of each listing for UI display purposes.
To understand the value of the vehicle you will want to run a Valuation using the endpoint. That will give you the current retail and trade values for the vehicle. Consider employing the to understand the valuation upper and lower thresholds as part of this calculation.
Get a vehicle by its ID
ID of the vehicle returned from a search
The region to perform this request in
An optional reference id which will be stored against usage records if supplied
