Market Overlay

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

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

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

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

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

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

get

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

Authorizations

ApiKeyAuth

ApiKeystringRequired

Path parameters

vehicle_idstringRequired

Query parameters

minimum_daysnumberOptional

The minimum number of days to show listings for

include_adjacent_yearsbooleanOptional

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

exclude_outliersbooleanOptional

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

exclude_all_delistedbooleanOptional

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

include_all_activebooleanOptional

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

include_trashbooleanOptional

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

featuresstringOptional

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

odometer_range_minnumberOptional

The minimum range observed against similar vehicles

odometer_range_maxnumberOptional

The maximum range observed against similar vehicles

regionstring · enumOptional

The region to perform this request in

Possible values:

reference_idstringOptional

An optional reference id which will be stored against usage records if supplied

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

/v2/sourcing/market_overlay/{vehicle_id}

HTTPcURLJavaScriptPython

GET /v2/sourcing/market_overlay/{vehicle_id} HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "sample_size": 1,
  "days_checked": 1,
  "avg_days_to_sell": 1,
  "outlier_count": 1,
  "days_supply": 1,
  "avg_price": 1,
  "min_price": 1,
  "max_price": 1,
  "avg_odometer": 1,
  "min_odometer": 1,
  "max_odometer": 1,
  "leads": [
    {
      "id": "text",
      "color": "text",
      "drive_away_price": 1,
      "is_outlier": true,
      "kms": 1,
      "listing_url": "text",
      "listing_sources": [
        "text"
      ],
      "listed_at": "text",
      "price": true,
      "price_before_govt_charges": [
        1
      ],
      "price_includes_govt_charges": [
        true
      ],
      "release_year": 1,
      "release_month": 1,
      "removed_at": "text",
      "seller_type": "private",
      "state": "text",
      "tag_ids": [
        "text"
      ],
      "vehicle_id": "text",
      "year": 1,
      "all_images": [
        "text"
      ],
      "primary_description": "text"
    }
  ]
}

Request Parameters

Name	Description
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 See available features here.
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

Features

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

Dealer Contact Details

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

"contact_name": "Example Motors",
"contact_number": "[phone]",

Lead Starting Price

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

"starting_price": 73990,

Lead Price Drops

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

"price_drop_count": 2,

Vehicle RRP

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

"price_when_new": 46990,

All Listing URLs

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

"listing_details": [
                {
                    "source": "gumtree.com.au",
                    "url": "https://www.gumtree.com.au/s-ad/1319103332/"
                },
                {
                    "source": "autotrader.com.au",
                    "url": "https://www.autotrader.com.au/car/13462144/toyota/hilux/sa/cheltenham/dual-cab/"
                }
            ]

Primary Cover Image

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

"cover_image_url": "https://storage.googleapis.com/download/storage/v1/b/ag-img/o/1700380596629%2F402495842_660380.jpg?generation=1700380597213918&alt=media"

All Images

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

"all_images": [
                "https://storage.googleapis.com/download/storage/v1/b/ag-img/o/1713129285535%2Fd7ec39ad-671b-4b.jpg?generation=1713129287041771&alt=media",
                "https://storage.googleapis.com/download/storage/v1/b/ag-img/o/1713129291498%2Fd3c1928d-a0f4-4f.jpg?generation=1713129292538543&alt=media",
                "https://storage.googleapis.com/download/storage/v1/b/ag-img/o/1713129296398%2Ff982ef2b-a25f-47.jpg?generation=1713129297432084&alt=media",
                "https://storage.googleapis.com/download/storage/v1/b/ag-img/o/1713129300707%2Fb4350079-4f04-4c.jpg?generation=1713129302187962&alt=media",
                "https://storage.googleapis.com/download/storage/v1/b/ag-img/o/1713129306170%2F2a88d686-c4b7-4a.jpg?generation=1713129307655700&alt=media"
            ]

Primary Listing Description

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

 "primary_description": "Near new condition 2022 Jeep Grand Cherokee Limited 4x4 <br> <br> <br> * Panormaic roof <br> * All Wheel Drive <br> * 20-inch Alloy Wheels <br> * 10.1-inch Touchscreen Display <br> * Wireless Apple CarPlay and Android Auto <br> * Leather Seats <br> * Heated & Ventillated front seats <br> * Heated steering wheel <br> * 9 Speaker Premium Audio System <br> * Power liftgate with adjustable height settings <br> * Automatic LED headlamps with Automatic highbeam <br> * Automatic Windscreen Wipers <br> * 10.25\" Multiview Display cluster <br> * 360 ParkView Rear Back-up Camera <br> * Front and Rear Park Assist with Stop <br> * Tyre Pressure Monitoring <br> * Keyless Entry with Push Button Start <br> * Blind Spot Monitoring with Rear Cross-Path Detection <br> * Adaptive Cruise Control with Stop and Go <br> * Active Lane Management <br> * Pedestrian Automatic Emergency Braking (with cyclist detection) <br> <br> We also accept trade ins, So bring down your pride and joy and we can price it on the spot! <br> <br> With easy onsite finance pre approvals available you can be in your new car in no time. <br> <br> WE ARE A PRIVATE OWNED DEALERSHIP JUST 20 MINUTES NORTH OF PERTH CITY,<br/><strong>Motor Mall WA</strong><br/>41 Buckingham Drive Wangara, WA 6065<br/>License number: 29875"

Registration Plate

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

"rego": "FDT46H",

VIN

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

"vin": "MR0BA3CD900173054",

Stock Number

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

"stock_no": 123ABC,

Average Kms

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

"avg_odo": 123000,
"avg_kms":2300,

Average Price

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

"avg_price": 67664,