loading

We are processing data. Please wait!

API Integration Documentation

We now officially offer API integration

Welcome to the Car Simulcast API service. You'll need your own website to integrate the API.

Do you need a website to set up the API? We offer a clone of our main website (carsimulcast.com) fully white-labeled to match your company brand. We handle maintenance, so you focus on sales. You have the choice to host it on your own server or we can offer you hosting service with unlimited resources for $9.99 / month.

Contact Us to Build Your Site

Get Records

Test VIN: 1C6RD6FT1CS310366 (Free for testing and report generation.)

API [carfax + autocheck]: https://connect.carsimulcast.com/checkrecords/{VIN}

API [auctions]: https://connect.carsimulcast.com/checkrecords/{VIN}/auctions

API [window sticker]: https://connect.carsimulcast.com/checkrecords/{VIN}/sticker

Our system charges one credit for every 15 checks that DO NOT generate a report. This policy is in place to accommodate users who wish to only use our record checks without utilizing the report generation API. You can avoid this fee by generating at least one report for every 15 checks.

PHP CURL Integration Example
<?php
    $api_url = "https://connect.carsimulcast.com/checkrecords/{VIN}";
    $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);
?>

Get Reports

This will generate and return the HTML report as a base64 string. You will need to decode the base64 string to retrieve the original HTML, which can then be stored and viewed. Note that the window stickers output is in PDF Format.

Available report types: carfax / autocheck / auctions / sticker

**Note:** You need to set headers for PDF to view the Window Sticker Report. Below is an example of setting headers in PHP:
<?php
header("Content-type: application/pdf");
header("Content-Disposition: inline; filename=sticker.pdf");

PHP CURL Integration Example
<?php
    $api_url = "https://connect.carsimulcast.com/getrecord/{report_type}/{VIN}";
    $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);
?>

Get API Balance

PHP CURL Integration Example
<?php
    $api_url = "https://connect.carsimulcast.com/balance";
    $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);
?>

Get VIN From License Plate

PHP CURL Integration Example
<?php
    $api_url = "https://connect.carsimulcast.com/checkplate/{state}/{plate_no}";
    $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);
?>

Get VIN From Images

Send the image file with the name 'file' in the POST request to retrieve the VIN. The system will generate and return the corresponding JSON record.

PHP CURL Integration 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;