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.
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.
To perform an example request:
An example payload is included below, although only the first lead is shown to save space:
| 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
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
uk
Enrich your market overlay payloads with additional data.
The market overlay can be enhanced by passing option feature parameters. You can request a single feature or combine them to enrich your responses. You must have a unique permission enabled by your sales representative for each feature.
This feature will deliver the contact details of the advertising dealership as per the listing. Use features=dealer_contact_details
This feature will deliver the initial price the lead was advertised at. Use features=lead_starting_price
This 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
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
This feature will deliver the listing URLs related to the lead across all sites it is listed on. Use features=listing_urls
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
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
This feature will deliver the primary listing description for each record where available. Use features=primary_description
This feature will deliver the vehicle's registration plate in the market overlay payload. Use features=rego
This feature will deliver the vehicle's VIN in the market overlay payload. Use features=VIN
This feature will deliver the vehicle's stock number in the market overlay payload. Use features=stock_no