PHPackages carsxe/carsxe - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. carsxe/carsxe ActiveLibrary[API Development](/categories/api) carsxe/carsxe ============= A powerful, easy-to-use API for vehicle data including specs, market value, license plate decoding, and more. 1.2.0(4mo ago)062MITPHPPHP ^7.4 Since Aug 14Pushed 4mo agoCompare [ Source](https://github.com/carsxe/carsxe-php-package)[ Packagist](https://packagist.org/packages/carsxe/carsxe)[ RSS](/packages/carsxe-carsxe/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependenciesVersions (7)Used By (0) 🚗 CarsXE API (PHP Library) ========================== [](#-carsxe-api-php-library) **CarsXE** is a powerful and developer-friendly API that gives you instant access to a wide range of vehicle data. From VIN decoding and market value estimation to vehicle history, images, OBD code explanations, and plate recognition, CarsXE provides everything you need to build automotive applications at scale. 🌐 **Website:** 📄 **Docs:** 📦 **All Products:** --- Installation ------------ [](#installation) Install the CarsXE PHP library using Composer: ``` composer require carsxe/carsxe ``` This will automatically download the library and its dependencies into your project. --- Usage ----- [](#usage) ### Initialize the CarsXE Library [](#initialize-the-carsxe-library) To start using the CarsXE API, include Composer's autoloader and create an instance of the `Carsxe` class with your API key: ``` require_once __DIR__ . '/vendor/autoload.php'; use CarsxeDeveloper\Carsxe\Carsxe; $API_KEY = 'YOUR_API_KEY'; $carsxe = new Carsxe($API_KEY); ``` ### Example: Decode Vehicle Specifications (`specs` Endpoint) [](#example-decode-vehicle-specifications-specs-endpoint) ``` try { $vehicle = $carsxe->specs(['vin' => 'WBAFR7C57CC811956']); print_r($vehicle); } catch (Exception $e) { echo "Error: " . $e->getMessage(); } ``` --- Endpoints --------- [](#endpoints) ### `specs` – Decode VIN & get full vehicle specifications [](#specs--decode-vin--get-full-vehicle-specifications) **Required:** - `vin` **Optional:** - `deepdata` - `disableIntVINDecoding` **Example:** ``` $vehicle = $carsxe->specs(['vin' => 'WBAFR7C57CC811956']); ``` --- ### `intVinDecoder` – Decode VIN with worldwide support [](#intvindecoder--decode-vin-with-worldwide-support) **Required:** - `vin` **Optional:** - None **Example:** ``` $intVin = $carsxe->intVinDecoder(['vin' => 'WF0MXXGBWM8R43240']); ``` --- ### `plateDecoder` – Decode license plate info (plate, country) [](#platedecoder--decode-license-plate-info-plate-country) **Required:** - `plate` - `country` (always required except for US, where it is optional and defaults to 'US') **Optional:** - `state` (required for some countries, e.g. US, AU, CA) - `district` (required for Pakistan) **Example:** ``` $decodedPlate = $carsxe->plateDecoder(['plate' => '7XER187', 'state' => 'CA', 'country' => 'US']); ``` --- ### `marketValue` – Estimate vehicle market value based on VIN [](#marketvalue--estimate-vehicle-market-value-based-on-vin) **Required:** - `vin` **Optional:** - `state` - `mileage` - `condition` **Example:** ``` $marketValue = $carsxe->marketValue(['vin' => 'WBAFR7C57CC811956', 'state' => 'CA', 'mileage' => 50000, 'condition' => 'clean']); ``` --- ### `history` – Retrieve vehicle history [](#history--retrieve-vehicle-history) **Required:** - `vin` **Optional:** - None **Example:** ``` $history = $carsxe->history(['vin' => 'WBAFR7C57CC811956']); ``` --- ### `images` – Fetch images by make, model, year, trim [](#images--fetch-images-by-make-model-year-trim) **Required:** - `make` - `model` **Optional:** - `year` - `trim` - `color` - `transparent` - `angle` - `photoType` - `size` - `license` **Example:** ``` $images = $carsxe->images(['make' => 'BMW', 'model' => 'X5', 'year' => '2019']); ``` --- ### `recalls` – Get safety recall data for a VIN [](#recalls--get-safety-recall-data-for-a-vin) **Required:** - `vin` **Optional:** - None **Example:** ``` $recalls = $carsxe->recalls(['vin' => '1C4JJXR64PW696340']); ``` --- ### `plateImageRecognition` – Read & decode plates from images [](#plateimagerecognition--read--decode-plates-from-images) **Required:** - `upload_url` **Optional:** - None **Example:** ``` $plateImage = $carsxe->plateImageRecognition(['upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG']); ``` --- ### `vinOcr` – Extract VINs from images using OCR [](#vinocr--extract-vins-from-images-using-ocr) **Required:** - `upload_url` **Optional:** - None **Example:** ``` $vinOcr = $carsxe->vinOcr(['upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG']); ``` --- ### `yearMakeModel` – Query vehicle by year, make, model and trim (optional) [](#yearmakemodel--query-vehicle-by-year-make-model-and-trim-optional) **Required:** - `year` - `make` - `model` **Optional:** - `trim` **Example:** ``` $ymm = $carsxe->yearMakeModel(['year' => '2023', 'make' => 'Toyota', 'model' => 'Camry']); ``` --- ### `obdCodesDecoder` – Decode OBD error/diagnostic codes [](#obdcodesdecoder--decode-obd-errordiagnostic-codes) **Required:** - `code` **Optional:** - None **Example:** ``` $obdCode = $carsxe->obdCodesDecoder(['code' => 'P0115']); ``` ### `lienAndTheft` – Check lien and theft status by VIN [](#lienandtheft--check-lien-and-theft-status-by-vin) **Required:** - `vin` **Optional:** - None **Example:** ``` $lienTheft = $carsxe->lienAndTheft(['vin' => '2C3CDXFG1FH762860']); ``` --- ### Notes [](#notes) - **Parameter Names**: Use parameter names exactly as shown in this README to avoid errors. - **Autoloader**: Add `require_once __DIR__ . '/vendor/autoload.php';` at the top of your script if not already included by your framework or tool. - **Response Format**: All API responses are PHP arrays for easy access and manipulation. --- License ------- [](#license) This library is licensed under the MIT License. See the LICENSE file for details. ### Health Score 35 — LowBetter than 77% of packages Maintenance75 Regular maintenance activity Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~46 days Recently: every ~58 days Total 6 Last Release 138d ago Major Versions 0.1.3 → 1.1.02025-12-22 ### Community Maintainers ![](https://www.gravatar.com/avatar/b89a34716a4b9d72b519b9fe676195abae9365923bf7a934e1b20af9c89f3b5b?d=identicon)[CarsXE Developer](/maintainers/CarsXE%20Developer) ![](https://www.gravatar.com/avatar/76bad1cd9b3359926753302eea519eddf5c21de49751799ce13d96bec048abd2?d=identicon)[omar walied](/maintainers/omar%20walied) --- Top Contributors [![0marwalied](https://avatars.githubusercontent.com/u/96862135?v=4)](https://github.com/0marwalied "0marwalied (6 commits)") --- Tags php-sdk ### Embed Badge ![Health badge](/badges/carsxe-carsxe/health.svg) ``` [![Health](https://phpackages.com/badges/carsxe-carsxe/health.svg)](https://phpackages.com/packages/carsxe-carsxe) ``` ### Alternatives [exsyst/swagger A php library to manipulate Swagger specifications 35816.5M7](/packages/exsyst-swagger)[lucasdotvin/laravel-soulbscription A straightforward interface to handle subscriptions and features consumption. 709209.3k](/packages/lucasdotvin-laravel-soulbscription)[pimax/fb-messenger-php Facebook Messenger Bot PHP API 313188.5k2](/packages/pimax-fb-messenger-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)