loading

We are processing data. Please wait!

API Integration Documentation

We now officially offer API integration

Hi and welcome to the Car Simulcast API service.

You will need to login to your https://connect.carsimulcast.com account to view your API key to be able to make requests. If you haven't already, please create an account.

To generate records and reports with the API call you will need to have credits available in your https://connect.carsimulcast.com account.

For testing use the VIN 1C6RD6FT1CS310366 you don't need credits to test the API, using this VIN will not deduct any credits from your account

In case of no report retrieval activity for a few days on your API account , the records check and license plate to vin converter feature will be temporary disabled. We implement this to prevent abuse of the system and to ensure that the system is being used responsibly and fairly by all users.

Check Records

Get the number of carfax, autocheck, auctions records available for a VIN. This call will not deduct any credits from your balance.

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 Report

This will generate and return back the HTML/PDF report as a base64 string. You will need to decode the base64 string to get the original HTML/PDF that can then be stored and viewed.
*PDF is only for sticker

Followin are report types

  • carfax
  • autocheck
  • auctions
  • sticker: This populates as true or false via records check. If true the sticker is available.

You need credits in your https://connect.carsimulcast.com account to execute this API call. You can use the test VIN to execute this call, it will not deduct any credits from your balance. To purchase credits login to https://connect.carsimulcast.com

Note You need to set headers for pdf to view 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 Balance

Get the credit balance available in your account

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 using License Plate

Convert a plate number into a VIN number. The states have to be abbreviated. This is a courtesy service which we offer our valued clients at no extra cost.

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);
?>