loading

We are processing data. Please wait!

API Integration Documentation

Welcome to the Car Simulcast API Documentation. This is the place to find official API Endpoint information on how to integrate vehicle history reports and more in your API projects.

Create an account to get your API Keys.

Send requests using a live vin (requires credits) or the free Test VIN: 1C6RD6FT1CS310366

Main Endpoint:

GET API Records Check: https://connect.carsimulcast.com/checkrecords/{VIN}

Optional Endpoints:

GET API Balance: https://connect.carsimulcast.com/balance

GET API License Plate to VIN converter [The state is abbreviated]: https://connect.carsimulcast.com/checkplate/{state}/{plate_no}

POST API Image to VIN converter [Send image file name as 'file']: https://connect.carsimulcast.com/scan

POST Convert Reports to PDF [Send your reports base64 and vin to convert to pdf]: https://connect.carsimulcast.com/pdf

CURL Request Example
<?php
        $api_url = "https://connect.carsimulcast.com/checkrecords/{VIN}"; // Replace this API URL with any of the GET URLs provided above.
        $header = array(
            "API-KEY: {Your API_KEY}",
            "API-SECRET: {Your API_SECRET}",
        );

        $curl = curl_init($api_url);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
        $response = curl_exec($curl);
        curl_close($curl);
        ?>
Image to VIN Convert CURL Request Example
<?php
$header = array(
    "API-KEY: {Your API_KEY}",
    "API-SECRET: {Your API_SECRET}",
);
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://connect.carsimulcast.com/scan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => array("file"=> new CURLFILE("Path to File")),
));
curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
$response = curl_exec($curl);

curl_close($curl);
echo $response;
Base64 to PDF Convert CURL Request Example [Only base64 and vin is required, rest of requests is optional its used to create document name]
<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://connect.carsimulcast.com/pdf/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => array(
    "base64_content" => "send reports base64 here", // required
    "report_type" => "carfax", // optional request not mandatory its used to create the document name [carfax, autocheck, auctions]
    "vehicle_name" => "1999 BMW 3 SERIES 323IS", // optional request not mandatory its used to create the document name
    "vin" => "any vin here" // required
  ),
  CURLOPT_HTTPHEADER => array(
    "API-KEY: {Your API_KEY}",
    "API-SECRET: {Your API_SECRET}"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Get Reports

This process generates the HTML report as a Base64 string. To access the original HTML, decode the Base64 string — it can then be stored or viewed.

Main Endpoint:

GET API carfax: https://connect.carsimulcast.com/getrecord/carfax/{VIN}

Optional Endpoints:

GET API autocheck: https://connect.carsimulcast.com/getrecord/autocheck/{VIN}

GET API auctions: https://connect.carsimulcast.com/getrecord/auctions/{VIN}

GET API Window sticker [PDF Format Needs Headers in Request]: https://connect.carsimulcast.com/getrecord/sticker/{VIN}

Window Sticker example header
<?php
header("Content-type: application/pdf");
header("Content-Disposition: inline; filename=sticker.pdf");
CURL Request GET Report
<?php
    $api_url = "https://connect.carsimulcast.com/getrecord/{report_type}/{VIN}"; // Replace this API URL with any of the URLs provided above.
    $header = array(
        "API-KEY: {Your API_KEY}",
        "API-SECRET: {Your API_SECRET}",
    );
        
    $curl = curl_init($api_url);
    curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
    $response = curl_exec($curl);
    curl_close($curl);
?>