https://github.com/carsxe/carsxe-java-package
The CarsXE Java Package is a lightweight client for accessing the CarsXE API, offering methods for VIN decoding, market value estimation, vehicle history, and more. It integrates seamlessly into Java applications, returning responses as `Map<String, Object>` for easy handling and development.
https://github.com/carsxe/carsxe-java-package
java-sdk
Last synced: 2 months ago
JSON representation
The CarsXE Java Package is a lightweight client for accessing the CarsXE API, offering methods for VIN decoding, market value estimation, vehicle history, and more. It integrates seamlessly into Java applications, returning responses as `Map<String, Object>` for easy handling and development.
- Host: GitHub
- URL: https://github.com/carsxe/carsxe-java-package
- Owner: carsxe
- License: mit
- Created: 2025-08-18T13:08:07.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-12-19T18:33:52.000Z (3 months ago)
- Last Synced: 2025-12-22T07:46:54.995Z (3 months ago)
- Topics: java-sdk
- Language: Java
- Homepage: https://central.sonatype.com/artifact/io.github.carsxe/carsxe
- Size: 22.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚗 CarsXE Java API Library
The **CarsXE Java API Library** is a powerful and developer-friendly library that enables seamless integration with the CarsXE API. Access a wide range of vehicle data, including VIN decoding, market value estimation, license plate recognition, vehicle history, lien & theft checks, and more.
**Java Version:** Java 21 LTS
🌐 **Website:** [https://api.carsxe.com](https://api.carsxe.com)
📄 **Docs:** [https://api.carsxe.com/docs](https://api.carsxe.com/docs)
📦 **All Products:** [https://api.carsxe.com/all-products](https://api.carsxe.com/all-products)
---
## 🚀 Installation
### Using Maven
Add the following dependency to your `pom.xml` file:
```xml
io.github.carsxe
carsxe
1.0.4
```
---
## 🛠️ Configuration
To use the library, you need to create an instance of the `CarsXE` class with your API key:
```java
import io.github.carsxe.CarsXE;
CarsXE carsxe = new CarsXE("YOUR_API_KEY");
```
Replace `YOUR_API_KEY` with your own CarsXE API key. You can get your API key by signing up at [CarsXE](https://api.carsxe.com).
---
## 📖 Usage
The CarsXE Java library provides methods corresponding to multiple endpoints. Below are examples for **all available products**:
### VIN Specifications
```java
Map params = new HashMap<>();
params.put("vin", "WBAFR7C57CC811956");
Map specs = carsxe.specs(params);
System.out.println(specs);
```
### Market Value
```java
Map params = new HashMap<>();
params.put("vin", "WBAFR7C57CC811956");
Map marketValue = carsxe.marketvalue(params);
System.out.println(marketValue);
```
### Vehicle History
```java
Map params = new HashMap<>();
params.put("vin", "WBAFR7C57CC811956");
Map history = carsxe.history(params);
System.out.println(history);
```
### License Plate Decoder
```java
Map params = new HashMap<>();
params.put("plate", "7XER187");
params.put("state", "CA");
params.put("country", "US");
Map plateInfo = carsxe.platedecoder(params);
System.out.println(plateInfo);
```
### License Plate Image Recognition
```java
String imageUrl = "https://api.carsxe.com/img/apis/plate_recognition.JPG";
Map plateRecognition = carsxe.plateImageRecognition(imageUrl);
System.out.println(plateRecognition);
```
### VIN OCR from Image
```java
String imageUrl = "https://user-images.githubusercontent.com/5663423/30922082-64edb4fa-a3a8-11e7-873e-3fbcdce8ea3a.png";
Map vinOcr = carsxe.vinOcr(imageUrl);
System.out.println(vinOcr);
```
### Year, Make, and Model Search
```java
Map params = new HashMap<>();
params.put("year", "2023");
params.put("make", "Toyota");
params.put("model", "Camry");
Map ymm = carsxe.yearMakeModel(params);
System.out.println(ymm);
```
### Vehicle Images
```java
Map params = new HashMap<>();
params.put("make", "BMW");
params.put("model", "X5");
params.put("year", "2019");
Map images = carsxe.images(params);
System.out.println(images);
```
### Vehicle Recalls
```java
Map params = new HashMap<>();
params.put("vin", "1C4JJXR64PW696340");
Map recalls = carsxe.recalls(params);
System.out.println(recalls);
```
### International VIN Decoder
```java
Map params = new HashMap<>();
params.put("vin", "WF0MXXGBWM8R43240");
Map internationalVin = carsxe.internationalVinDecoder(params);
System.out.println(internationalVin);
```
### OBD Codes Decoder
```java
Map params = new HashMap<>();
params.put("code", "P0115");
Map obdCodes = carsxe.obdcodesdecoder(params);
System.out.println(obdCodes);
```
### Lien & Theft Check
```java
Map params = new HashMap<>();
params.put("vin", "2C3CDXFG1FH762860");
Map lienTheft = carsxe.LienAndTheft(params);
System.out.println(lienTheft);
```
---
## 📋 Endpoints
Here is the list of supported endpoints:
- `specs` – Decode VIN & get full vehicle specifications
- `internationalVinDecoder` – Decode VIN with worldwide support
- `platedecoder` – Decode license plate info (plate, state, country)
- `marketvalue` – Estimate vehicle market value based on VIN
- `history` – Retrieve vehicle history (ownership, accidents, etc.)
- `images` – Fetch images by make, model, year, trim
- `recalls` – Get safety recall data for a VIN
- `plateImageRecognition` – Read & decode plates from images
- `vinOcr` – Extract VINs from images using OCR
- `yearMakeModel` – Query vehicle by year, make, model, and trim (optional)
- `obdcodesdecoder` – Decode OBD error/diagnostic codes
- `LienAndTheft` – Check for lien and theft records on a vehicle
Refer to the [CarsXE API Documentation](https://api.carsxe.com/docs) for more details about parameters and response formats.