Market Overlay

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

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

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

Market Overlay API

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

To access a Market Overlay, you will need to specify a Vehicle ID to search for relevant listings. To retrieve a Vehicle ID, use any of the 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 time 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.

Example

To perform an example request:

curl 'https://api.autograb.com.au/v2/sourcing/market_overlay/{VEHICLE_ID}?region=nz' \
      -H 'ApiKey: {API_KEY}'

An example payload is included below, although only the first lead is shown to save space:

{
    "success": true,
    "sample_size": 9,
    "days_checked": 100,
    "outlier_count": 0,
    "avg_days_to_sell": 9.771373972800927,
    "leads": [
        {
            "id": "20266890-4091-4353-b5ba-ca335ce76b2d",
            "vehicle_id": "5233518187642880",
            "year": 2010,
            "release_year": 2010,
            "release_month": 1,
            "listed_at": "2024-05-06T14:42:45.646Z",
            "removed_at": "2024-05-12T01:06:15.367Z",
            "seller_type": "dealer",
            "color": "Black",
            "state": "AUK",
            "tag_ids": [
                "nz_new"
            ],
            "price": 11880,
            "drive_away_price": null,
            "price_before_govt_charges": 11880,
            "price_includes_govt_charges": false,
            "kms": 30933,
            "listing_sources": [
                "autotrader.co.nz"
            ],
            "listing_url": "https://www.autotrader.co.nz/used-cars-for-sale/volkswagen/polo/781308",
            "is_outlier": false
        },

Request Parameters

Name

Description

PreviousSourcing Basics NextFeatures