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 operates on a tiered system of queries:

VIN - The first initial call can be made to VIN + Region. However, if VIN does not return any history information, the following data is required as a fallback.

• Year

• Make

• Model

• Registration

It is recommended to provide all available data points when doing a Vehicle History call, only use VIN if no other data is available.

Title	Parameter	Example
Year	year	2019
Make	make	Volkswagen
Model	model	Polo
Registration Plate	registration_plate	BMT038
State	state	VIC
Vin	VIN	KL3TA48E9CB053071

The Make, Model fields are format-sensitive and rely on AutoGrabs Vehicle Search or ID lookup formatting. If using unsupported make and model descriptions, the vehicle history will not be returned when otherwise it could have been using the correct formatting.

Get a listing of vehicle history events

get

Get a listing of vehicle history events

Authorizations

ApiKeyAuth

ApiKeystringRequired

Query parameters

vinstringOptional

The vehicle VIN

registration_platestringOptional

The vehicle registration plate

yearnumberOptional

The vehicle year

makestringOptional

The vehicle make

modelstringOptional

The vehicle model

vehicle_history_idstringOptional

The vehicle history id

marketplacestringOptional

The vehicle marketplace

marketplace_idstringOptional

The vehicle marketplace id

start_datestringOptional

Vehicle history events start date filter as UTC or Unix timestamp string in seconds

end_datestringOptional

Vehicle history events end date filter as UTC or Unix timestamp string in seconds

featuresstringOptional

Comma separated array of additional vehicle history feature codes as specified in your contract

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

/v2/sourcing/history

HTTPcURLJavaScriptPython

GET /v2/sourcing/history HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "text",
  "vehicle_history": {
    "id": "text",
    "events": [
      {
        "type": "listing",
        "odometer": 1,
        "price": 1,
        "marketplace": "text",
        "timestamp": "text",
        "seller_type": "text"
      }
    ]
  }
}

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.

Listing Sources

The listing_sources feature will return a unique array of listing sources where the vehicle has been posted, URLs for each historical listing and the primary description of the vehicle from the lead listing.

Note that the URLs may not always be active if the vehicle has already been delisted from the marketplace.

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

    "listing_sources": [
        "carsales.com.au",
        "gumtree.com.au",
        "autotrader.com.au"
    ],
    "listing_urls": [
        {
            "source": "carsales.com.au",
            "url": "https://www.carsales.com.au/cars/details/2019-volkswagen-polo-85tsi-comfortline-aw-auto-my19/OAG-AD-20356677"
        },
        {
            "source": "gumtree.com.au",
            "url": "https://www.gumtree.com.au/s-ad/1304228374/"
        },
        {
            "source": "carsales.com.au",
            "url": "https://www.carsales.com.au/cars/details/2019-volkswagen-polo-85tsi-comfortline-aw-auto-my19/OAG-AD-21315043"
        },
        {
            "source": "autotrader.com.au",
            "url": "https://www.autotrader.com.au/car/12848266/volkswagen/polo/vic/fairfield/hatchback/"
        }
    ],
    "primary_description": "2019 Volkswagen Polo 85TSI Comfortline AW Auto MY20"
}

Listing Images

The listing_images feature will return an array of URLs to the 5 primary listing images the AutoGrab platform has associated with the vehicle. If there is not images available an empty array will be returned

It is expected that the external system download and store the images as part of the initial call. AutoGrab cannot guarantee the availability of these images for long term URL storage.

/v2/sourcing/history?region=au&features=all_images&vin=KNAPH81BSG5198595

    "all_images": [
        "https://dataingeststack-1-lambdastack-photosbucket00a3918c-cdea2gpcgyrk.s3.ap-southeast-2.amazonaws.com/1729471421803/98713041fa27428a9e8ba456d673123b",
        "https://dataingeststack-1-lambdastack-photosbucket00a3918c-cdea2gpcgyrk.s3.ap-southeast-2.amazonaws.com/1729471421803/60d46f85a530407bb3d33d388e498aa5",
        "https://dataingeststack-1-lambdastack-photosbucket00a3918c-cdea2gpcgyrk.s3.ap-southeast-2.amazonaws.com/1729471421803/e7d0275f11304e7eb5a341bc77c716b2",
        "https://dataingeststack-1-lambdastack-photosbucket00a3918c-cdea2gpcgyrk.s3.ap-southeast-2.amazonaws.com/1729471421803/ba0c6362db544ad6bf2e3f2de12917c8",
        "https://dataingeststack-1-lambdastack-photosbucket00a3918c-cdea2gpcgyrk.s3.ap-southeast-2.amazonaws.com/1729471421803/679a7a6533674b908bae9af174d5b3a5"
    ]