LogoLogo
API StatusSupportPostmanContact Us
๐Ÿ‡ฌ๐Ÿ‡ง UK AutoGrab API Doc
๐Ÿ‡ฌ๐Ÿ‡ง UK AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • API Test Cases
    • FAQ
  • Authentication
    • API Key
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • VRM Search
    • VIN Search
    • Facet Search
    • Vehicle ID Search
    • Marketplace ID Lookup
  • Sourcing
    • Sourcing Basics
    • Market Overlay
    • Market Statistics
    • Stock Feeds
  • Vehicle Data
    • Vehicle Data Basics
    • Recall Search
    • MOT & Tax Search
    • Vehicle History
    • Factory Build Data
    • Factory Fitted Options
  • Valuation
    • Valuation Basics
    • Valuation Predictions
    • Residual Valuations
    • Max Offer Configuration
    • Gauge API
  • Embeddable Products
    • Embeddable Basics
    • Gauge Widget
    • Valuation Widget
    • Market Overlay Widget
  • Customer Recapture
    • Customer Recapture
    • Webhooks Integration
  • Insurance
    • Pre-Accident Valuation
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 ยฉ AutoGrab Pty Ltd. ABN 79 638 468 569

On this page

Was this helpful?

Export as PDF
  1. Sourcing

Market Statistics

Get key statistics on any vehicle ID

PreviousMarket OverlayNextStock Feeds

Last updated 3 months ago

Was this helpful?

Overview

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.

the features on the market overlay
Market Overlay

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
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
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
}
  • Overview
  • GETGet the lead statistics used to justify pricing for a given AutoGrab Vehicle ID.