Get Reports Information

GET /api/reports/{vin}

Retrieve comprehensive report information for a specific vehicle using its VIN (Vehicle Identification Number). This endpoint provides a summary of available data from both Carfax and Autocheck services, including the number of historical records and vehicle details.

This is a lightweight endpoint that doesn't consume credits - use it to check report availability before requesting the full HTML reports.

Path Parameters

Parameter	Type	Required	Description
vin	string	Yes	The 17-character Vehicle Identification Number

Query Parameters

None.

Headers

Key	Value
x-api-key	Your API Key

Response

Status Code: 200 OK

Response Fields

Field	Type	Description
vehicle	object	Vehicle information
vehicle.make	string	Vehicle manufacturer
vehicle.model	string	Vehicle model name
vehicle.year	number	Vehicle year
carfax_records	number	Number of historical records available in Carfax
autocheck_records	number	Number of historical records available in Autocheck
sticker	string	Whether a window sticker is available ("true" or "false")

Example Response

{
  "vehicle": {
    "make": "ACURA",
    "model": "INTEGRA RS",
    "year": 1995
  },
  "carfax_records": 39,
  "autocheck_records": 41,
  "sticker": "false"
}

Error Responses

401 Unauthorized

Returned when the API key is missing or invalid.

{
  "message": "Unauthorized"
}

400 Bad Request

Returned when the VIN is invalid.

{
  "message": "VIN is required"
}

{
  "message": "VIN must be 17 characters"
}

500 Internal Server Error

Returned when there's an error fetching report information.

{
  "message": "Error fetching reports information"
}

Examples

Python

import requests
response = requests.get('https://panel.cheapcarfax.net/api/reports/{VIN_NUMBER}', headers={'x-api-key': 'YOUR_API_KEY'})
print(response.json())

cURL

curl -X GET 'https://panel.cheapcarfax.net/api/reports/{VIN_NUMBER}' \
    -H 'x-api-key: YOUR_API_KEY'