Vehicle History

Request a vehicles history on marketplaces

Overview

The Vehicle History API allows you to access historical lead listing data from a variety of used car marketplaces. This API requires authentication and an appropriate license attached to it.

The endpoint can be queried using a range of identifiers. VIN is the most readily matched identifier, you can pass in many identifiers to increase the likelihood of matching to a valid listing. See the table below for a list of all supported identifiers.

TitleParameterExample

Year

year

2019

Make

make

Volkswagen

Model

model

Polo

Registration Plate

registration_plate

BMT038

State

state

VIC

Vin

VIN

KL3TA48E9CB053071

Example

For example, if you were to use all available identifiers your request would resemble the request below.

/v2/sourcing/history?region=au&registration_plate=BMT038&state=VIC&year=2019&make=Volkswagen&features=price_changes&model=Polo&vin=KL3TA48E9CB053071

If that vehicle is found, all its relevant events will be included in the response, an example is below.

{
    "success": true,
    "vehicle_history": {
        "id": "24b0cdb5-fae3-4739-a47f-c4122b687acf",
        "events": [
            {
                "type": "listing",
                "odometer": 14646,
                "price": 26890,
                "marketplace": "carsales.com.au",
                "seller_type": "dealer",
                "timestamp": "2021-12-03T00:51:35.801Z"
            },

Vehicle History Events

The Vehicle History endpoint delivers detailed information on events related to a listing. The following events are possible on a given listings.

Listing - the detection of a listing being added to its relevant marketplace.

            {
                "type": "listing",
                "odometer": 27035,
                "price": 24000,
                "marketplace": "gumtree.com.au",
                "seller_type": "private",
                "timestamp": "2022-11-17T01:38:05.000Z"
            },

Delisting - the detection of a listing being removed from its relevant marketplace, this is frequently and reliably related to a sale of the vehicle.

            {
                "type": "delisting",
                "odometer": 14646,
                "price": 26890,
                "marketplace": "carsales.com.au",
                "seller_type": "dealer",
                "timestamp": "2021-12-09T10:53:36.026Z"
            },

Price Change - the detection of a movement in the price, see the features section below for more information.

Example

To perform an example request:

curl '/v2/sourcing/history?region=au&vin=KL3TA48E9CB053071u' \
      -H 'ApiKey: {API_KEY}'

An example payload is included below to illustrate a potential response.

{
  "success": true,
  "id": "dfe4d117-74e1-4545-9e79-a0baac8208a7",
  "events": [
    {
      "type": "listing",
      "odometer": 100000,
      "price": 100000,
      "marketplace": "Gumtree",
      "timestamp": "2022-09-20T10:22:07.072",
      "seller_type": "string"
    }
  ]
}

Features

You can opt to enrich your vehicle history payload by passing in a feature or features separated by commas.

curl '/v2/sourcing/history?region=au&registration_plate=BMT038&state=VIC&year=2019&make=Volkswagen&features=price_changes&model=Polo&vin=KL3TA48E9CB053071'
      -H 'ApiKey: {API_KEY}'

Price Changes

Currently, we support the price_changes feature that will show you fluctuations in the price. Passing this feature will return upward on downward movements in the listings' price.

Include by adding feature=price_changes

            {
                "type": "price_change",
                "odometer": 27051,
                "price": 25888,
                "marketplace": "autotrader.com.au",
                "seller_type": "dealer",
                "timestamp": "2022-11-29T02:45:14.000Z"
            },

Contact your sales rep to understand your commercial rate card for each feature.

Last updated