marketcheck-api-sdk

Access the New, Used and Certified cars inventories for all Car Dealers in US.
The data is sourced from online listings by over 44,000 Car dealers in US. At any time, there are about 6.2M searchable listings (about 1.9M unique VINs) for Used & Certified cars and about 6.6M (about 3.9M unique VINs) New Car listings from all over US. We use this API at the back for our website www.marketcheck.com and our Android and iOS mobile apps too.

Few useful links :

• A quick view of the API and the use cases is depicated here
• The Postman collection with various usages of the API is shared here https://www.getpostman.com/collections/2752684ff636cdd7bac2

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.3
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/marketcheck-api-sdk/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new marketcheck\api\sdk\Api\CRMApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$vin = "vin_example"; // string | vin for which CRM check needs to be done
$sale_date = "sale_date_example"; // string | sale date after which listing has appeared or not
$api_key = "api_key_example"; // string | The API Authentication Key. Mandatory with all API calls.

try {
    $result = $apiInstance->crmCheck($vin, $sale_date, $api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CRMApi->crmCheck: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://marketcheck-prod.apigee.net/v1

Class	Method	HTTP request	Description
CRMApi	crmCheck	GET /crm_check/{vin}	CRM check of a particular vin
DealerApi	dealerSearch	GET /dealers	Find car dealers around
DealerApi	getDealer	GET /dealer/{dealer_id}	Dealer by id
HistoryApi	history	GET /history/{vin}	Get a cars online listing history
ListingsApi	getListing	GET /listing/{id}	Listing by id
ListingsApi	getListingExtra	GET /listing/{id}/extra	Long text Listings attributes for Listing with the given id
ListingsApi	getListingMedia	GET /listing/{id}/media	Listing media by id
ListingsApi	search	GET /search	Gets active car listings for the given search criteria
MarketApi	getMDS	GET /mds	Market Days Supply
MarketApi	getSalesCount	GET /sales	Get sales count by make, model, year, trim or taxonomy vin
VINDecoderApi	decode	GET /vin/{vin}/specs	VIN Decoder

Documentation For Models

• Averages
• BaseListing
• Build
• CRMResponse
• ComparisonPoint
• CompetitorsCarDetails
• CompetitorsPoint
• CompetitorsSameCars
• CompetitorsSimilarCars
• Dealer
• DealerLandingPage
• DealerRating
• DealerReview
• DealersResponse
• DepreciationPoint
• DepreciationStats
• Economy
• Error
• FacetItem
• FuelEfficiency
• HistoricalListing
• Listing
• ListingDebugAttributes
• ListingExtraAttributes
• ListingFinance
• ListingLease
• ListingMedia
• ListingNestExtraAttributes
• ListingNestMedia
• ListingVDP
• Location
• MakeModel
• Mds
• NestDealer
• PlotPoint
• PopularityItem
• RatingComponents
• ReviewComponents
• SafetyRating
• Sales
• SalesStats
• SearchResponse
• TrendPoint
• VinReport

Documentation For Authorization

All endpoints do not require authorization.

Author