API Documentation

This is the API documentation for the Carfax and Autocheck reports.

Authorization

Every request to the API must include the x-api-key header with your API key. You can get your API key in your profile

Limits

By default your account comes with a limit of 20 requests per day. You can contact us to increase the limit. The x-api-limit header on the response indicates the number of requests you have left for the day. Each report will count towards your credit balance. You can purchase more Here

Endpoints

The base URL for the API is https://panel.cheapcarfax.net/api

Get User Information
Get User Limits Information
Get Carfax from VIN (Deprecated)
Get Autocheck from VIN (Deprecated)
Get Carfax HTML from VIN
Get Autocheck HTML from VIN

Get User Information

GET /api/user

Get the user information

Headers

Key	Value
x-api-key	Your API Key

Example Response

          {
            "_id": "6603fcf18adc9203718db05b",
            "email": "[email protected]",
            "role": "USER"
          }

Python Example

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

cURL Example

          curl -X GET 'https://panel.cheapcarfax.net/api/user'\ 
          -H 'x-api-key: YOUR_API_KEY'

Get User Limits Information

GET /api/user/limits

Get the user's current limit information

Headers

Key	Value
x-api-key	Your API Key

Example Response

                {
                "daily_limit": 20,
                "carfax_reports_left_today": 15,
                "autocheck_reports_left_today": 19,
                "credits": 5
                }

Python Example

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

cURL Example

                curl -X GET 'https://panel.cheapcarfax.net/api/user/limits'\ 
                -H 'x-api-key: YOUR_API_KEY'

Get Carfax from VIN

GET /api/carfax/vin/:vin

This route is deprecated and will be removed soon.

Get the Carfax report as a PDF for a VIN

Headers

Key	Value
x-api-key	Your API Key

Parameters

Key	Value
vin	The VIN of the vehicle

Example Response

PDF File is returned

Python Example

                import requests
                response = requests.get('https://panel.cheapcarfax.net/api/carfax/vin/YOUR_VIN', headers={'x-api-key': 'YOUR_API_KEY'})
                with open('report.pdf', 'wb') as f:
                    f.write(response.content)

cURL Example

                curl -X GET 'https://panel.cheapcarfax.net/api/carfax/vin/YOUR_VIN'\
                -H 'x-api-key: YOUR_API_KEY'\
                -o report.pdf

Get Autocheck from VIN

GET /api/autocheck/vin/:vin

This route is deprecated and will be removed soon.

Get the Autocheck report as a PDF for a VIN

Headers

Key	Value
x-api-key	Your API Key

Parameters

Key	Value
vin	The VIN of the vehicle

Example Response

PDF File is returned

Python Example

                import requests
                response = requests.get('https://panel.cheapcarfax.net/api/autocheck/vin/YOUR_VIN', headers={'x-api-key': 'YOUR_API_KEY'})
                with open('report.pdf', 'wb') as f:
                    f.write(response.content)

cURL Example

                curl -X GET 'https://panel.cheapcarfax.net/api/autocheck/vin/YOUR_VIN'\
                -H 'x-api-key: YOUR_API_KEY'\
                -o report.pdf

Get Carfax HTML from VIN

GET /api/carfax/vin/:vin/html

Get the Carfax report as a HTML for a VIN

Headers

Key	Value
x-api-key	Your API Key

Parameters

Key	Value
vin	The VIN of the vehicle

Example Response

          {
            "yearMakeModel": "2017 TOYOTA CAMRY",
            "id": "UAJNNC235345",
            "html": "..."
          }

Python Example

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

cURL Example

                      curl -X GET 'https://panel.cheapcarfax.net/api/carfax/vin/YOUR_VIN/html'\
                      -H 'x-api-key: YOUR_API_KEY'

Get Autocheck HTML from VIN

GET /api/autocheck/vin/:vin/html

Get the Autocheck report as HTML for a VIN

Headers

Key	Value
x-api-key	Your API Key

Parameters

Key	Value
vin	The VIN of the vehicle

Example Response

          {
            "yearMakeModel": "2017 TOYOTA CAMRY",
            "id": "UAJNNC235345",
            "html": "..."
          }

Python Example

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

cURL Example

                      curl -X GET 'https://panel.cheapcarfax.net/api/autocheck/vin/{YOUR_VIN}/html'\
                      -H 'x-api-key: YOUR_API_KEY'