loading

We are processing data. Please wait!

API Integration Documentation

We now officially offer API integration.

Hi and welcome to the Carsimulcast.com API

You will need to login to your app.carsimulcast.com account to view your API key to be able to make requests.

To generate records with the Check_Report API call you will need to have credits available in your app.carsimulcast.com account.

For testing use the VIN 1FM5K7F81GGD09771 using this VIN will not deduct any credits from your account

Check Records

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

PHP CURL Integration Example
<?php
    $api_url = "https://app.carsimulcast.com/api/check_report/{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 report as a base64 string. You will need to decode the base64 string to get the original HTML that can then be stored and viewed.

You need credits in your app.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 app.carsimulcast.com

PHP CURL Integration Example
<?php
    $api_url = "https://app.carsimulcast.com/api/generate_report/{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://app.carsimulcast.com/api/check_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://app.carsimulcast.com/api/convert_plate_to_vin/{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);
?>