Market Overlay

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

Get market overlay data for a vehicle

get

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

Path parameters

vehicle_idstringRequired

ID of the vehicle you are requesting a market overlay on

Query parameters

minimum_daysintegerOptional

The minimum number of days to show listings for (default 60)

Example: 60

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

Default: false

exclude_outliersbooleanOptional

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

Default: false

exclude_all_delistedbooleanOptional

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

Default: false

include_all_activebooleanOptional

If enabled, all listings that are currently on the market will be returned

Default: false

include_trashbooleanOptional

If enabled, leads that are considered trash, written off, damaged, or missing details will be included in the results

Default: false

featuresstringOptional

Comma separated array of additional overlay feature codes

Example: dealer_contact_details,lead_starting_price

odometer_range_minintegerOptional

The minimum range observed against similar vehicles

Example: 50000

odometer_range_maxintegerOptional

The maximum range observed against similar vehicles

Example: 100000

reference_idstringOptional

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

Example: MY_REFERENCE_123

Responses

200

Market Overlay Response

application/json

400

Bad Request / Validation Failed

application/json

404

Resource for id cannot be found

application/json

500

Unknown error on the service side

application/json

get

/v1/vehicles/market-overlay/{vehicle_id}

HTTPcURLJavaScriptPython

GET /v1/vehicles/market-overlay/{vehicle_id} HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "sample_size": 10,
  "days_checked": 60,
  "avg_days_to_sell": 30,
  "outlier_count": 2,
  "days_supply": 45,
  "avg_price": 25000,
  "min_price": 20000,
  "max_price": 30000,
  "avg_odometer": 80000,
  "min_odometer": 50000,
  "max_odometer": 120000,
  "leads": [
    {
      "id": "abc123",
      "color": "red",
      "drive_away_price": 25000,
      "is_outlier": false,
      "kms": 75000,
      "listing_url": "https://example.com/listing/123",
      "listing_sources": [
        "autotrader.com.au"
      ],
      "listed_at": "2023-01-15",
      "price": 23500,
      "release_year": 2018,
      "release_month": 6,
      "removed_at": "2023-02-20",
      "seller_type": "private",
      "state": "NSW",
      "tag_ids": [
        "tag1",
        "tag2"
      ],
      "vehicle_id": "veh123456",
      "year": 2018,
      "all_images": [
        "https://example.com/image1.jpg"
      ],
      "primary_description": "Well maintained vehicle with full service history"
    }
  ]
}