Market Statistics

Get key statistics on any vehicle ID

Overview

The Market Overlay Statistics API delivers statistics we generate on your behalf from the Market Overlay endpoint.

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

get

Get the lead statistics 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

successbooleanOptional

sample_sizenumberOptional

The number of leads in the given market overlay

days_checkednumberOptional

The number of days checked when going back to retrieve relevant leads

avg_days_to_sellnumberOptional

The average number of days to sell for delisted leads in this overlay. If there are no delisted leads in time timespan selected, this will be null.

outlier_countnumberOptional

The count of outliers detected in similar vehicles.

days_supplynumberOptional

The sale rate of vehicles of the sample time period.

avg_pricenumberOptional

The average price of the analysed similar vehicles.

min_pricenumberOptional

The minimum price of the analysed similar vehicles.

max_pricenumberOptional

The maximum price of the analysed similar vehicles.

avg_odometernumberOptional

The average odometer of the analysed similar vehicles.

min_odometernumberOptional

The minimum odometer of the analysed similar vehicles.

max_odometernumberOptional

The maximum odometer of the analysed similar vehicles.

400

Bad Request

application/json

401

Unauthorized

application/json

get

/v2/sourcing/market_overlay/statistics/{vehicle_id}

HTTPcURLJavaScriptPython

GET /v2/sourcing/market_overlay/statistics/{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
}

As this endpoint is part of the market overlay route you can enhance your payload with additional features. Refer to the features on the market overlay to see what's available.