---
canonical_url: "https://docs.composio.dev/toolkits/carsxe"
markdown_url: "https://docs.composio.dev/toolkits/carsxe.md"
product: "platform"
version: null
last_updated: null
---

# CarsXE

CarsXE provides vehicle data APIs for VIN specifications, recalls, license plate decoding, market values, history, images, recognition, and related automotive lookups.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `CARSXE`
- **Version:** 20261015_01
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### Check Lien and Theft Records

**Slug:** `CARSXE_CHECK_LIEN_AND_THEFT`

Retrieve reportable US lien and theft events for a VIN. A no-data response means CarsXE has no reportable record and is not proof that the vehicle is clear.

**Instant:** Supported on the latest version.

**Instant pricing:** $1.00 per successful lien and theft lookup

**Discount:** 60

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | Yes | The exact 17-character vehicle identification number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decode License Plate

**Slug:** `CARSXE_DECODE_LICENSE_PLATE`

Look up vehicle identity from a license plate using CarsXE's current global v2 decoder.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.50 per successful license plate decode; $1.00 when Spain require_vin is enabled; discount applies only to standard one-unit lookups

**Discount:** 60

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plate` | string | Yes | License plate text exactly as displayed, without adding separators. |
| `state` | string | No | State or regional code; required for US, AU, CA, and PK lookups. |
| `country` | string | No | ISO 3166-1 alpha-2 country code. |
| `district` | string | No | District required for Pakistan Khyber-Pakhtunkhwa registrations. This regional variant is officially documented but not live-verified. |
| `require_vin` | boolean | No | For Spain only, require a VIN in the result. This consumes two CarsXE units instead of one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decode OBD Code

**Slug:** `CARSXE_DECODE_OBD_CODE`

Translate an OBD-II diagnostic trouble code into a readable diagnosis.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.15 per successful OBD code decode

**Discount:** 100

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | OBD-II diagnostic trouble code to decode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract VIN from Image

**Slug:** `CARSXE_EXTRACT_VIN_FROM_IMAGE`

Extract a vehicle identification number from an image supplied as an HTTP(S) URL or raw base64 image data, returning the best match, its bounding box and confidence, and alternative candidates.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.15 per successful VIN extraction from an image

**Discount:** 86

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_url` | string | Yes | Image containing a VIN, provided as an HTTP(S) URL or a raw base64-encoded image string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Market Value

**Slug:** `CARSXE_GET_MARKET_VALUE`

Estimate wholesale, retail, and trade-in values for a VIN using CarsXE's current v2 valuation, optionally adjusted for state, mileage, and condition.

**Instant:** Supported on the latest version.

**Instant pricing:** $1.50 per successful vehicle valuation

**Discount:** 16

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | Yes | The exact 17-character vehicle identification number. |
| `state` | string | No | US state abbreviation for regional adjustment. |
| `mileage` | number | No | Current non-negative odometer mileage used for adjustment. |
| `condition` | string ("excellent" | "clean" | "average" | "rough") | No | Vehicle condition used to select the relevant valuation bucket. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recall Batch

**Slug:** `CARSXE_GET_RECALL_BATCH`

Make exactly one read request for a CarsXE recall batch. The default status view returns current progress. The results view is available only when the batch is completed or partial and returns a bounded local page (100 rows by default, at most 1,000) from CarsXE's complete array; use result_offset to continue. CarsXE returns 409 while results are not ready. This tool makes one provider request and never polls internally.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("status" | "results") | No | Select status for current progress or results for completed/partial JSON results. The provider array can contain up to 10,000 VIN rows; this tool returns a bounded local page and CarsXE returns 409 while the batch is not ready. |
| `batch_id` | string | Yes | Opaque CarsXE batch ID returned by Submit Recall Batch, typically beginning with brb_. |
| `result_limit` | integer | No | Maximum result rows to return with view=results. Defaults to 100 and is capped at 1,000; pagination is local and does not issue another provider request. |
| `result_offset` | integer | No | Zero-based offset into the provider's complete result array. Used only with view=results; pagination is applied locally after one provider request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle History

**Slug:** `CARSXE_GET_VEHICLE_HISTORY`

Retrieve title, brand, junk/salvage, insurance, VIN-change, and historical title records for a VIN.

**Instant:** Supported on the latest version.

**Instant pricing:** $4.99 per successful vehicle history lookup

**Discount:** 70

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | Yes | The exact 17-character vehicle identification number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Images

**Slug:** `CARSXE_GET_VEHICLE_IMAGES`

Find up to 10 vehicle photos by make and model, with optional year, trim, angle, image type, size, color, quality, transparency, and license filters.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.15 per successful vehicle image lookup

**Discount:** 86

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `make` | string | Yes | Vehicle manufacturer. |
| `size` | string ("Small" | "Medium" | "Large" | "Wallpaper" | "All") | No | Requested image size; values are case-sensitive. |
| `trim` | string | No | Trim filter. |
| `year` | string | No | Model year filter. |
| `angle` | string ("front" | "front three-quarter" | "side" | "rear" | "rear three-quarter") | No | Preferred viewing angle; values are case-sensitive. |
| `color` | string | No | Preferred vehicle color. |
| `model` | string | Yes | Vehicle model. |
| `license` | string ("Public" | "Share" | "ShareCommercially" | "Modify" | "ModifyCommercially") | No | Required usage license; values are case-sensitive. |
| `photo_type` | string ("interior" | "exterior" | "engine") | No | Photo category; requires year and trim in addition to make and model. |
| `transparent` | boolean | No | Prefer images with transparent backgrounds. |
| `validate_images` | boolean | No | Apply CarsXE quality validation to returned images. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Recalls

**Slug:** `CARSXE_GET_VEHICLE_RECALLS`

Find safety recall campaigns either for one VIN or for a year, make, and model. Supply exactly one lookup method.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.25 per successful vehicle recall lookup

**Discount:** 40

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | No | Exact 17-character VIN. Do not combine with year, make, or model. |
| `make` | string | No | Vehicle manufacturer; required with year and model when VIN is omitted. |
| `year` | string | No | Four-digit model year; required with make and model when VIN is omitted. |
| `model` | string | No | Vehicle model; required with year and make when VIN is omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Specifications

**Slug:** `CARSXE_GET_VEHICLE_SPECS`

Decode a 17-character VIN into vehicle identity, specifications, equipment, colors, and warranty data. International decoding is used automatically when CarsXE needs it unless explicitly disabled.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.15 per successful vehicle specification lookup

**Discount:** 93

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | Yes | The exact 17-character vehicle identification number. |
| `include_extended_data` | boolean | No | Fetch slower extended-source data; this may consume additional time or quota. |
| `disable_international_fallback` | boolean | No | Disable CarsXE's automatic international VIN-decoding fallback. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Year Make Model Data

**Slug:** `CARSXE_GET_YEAR_MAKE_MODEL_DATA`

Look up detailed vehicle and trim information by year, make, and model without a VIN. Returns bounded trim summaries rather than large feature and color payloads.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.20 per successful year, make, and model lookup

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `make` | string | Yes | Vehicle manufacturer. |
| `trim` | string | No | Optional fuzzy-matched trim hint. |
| `year` | integer | Yes | Model year from 1900 through the current model year plus one. |
| `model` | string | Yes | Vehicle model. |
| `include_all_trim_options` | boolean | No | Return concise summaries of every matching trim instead of only the best match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Recognize License Plate

**Slug:** `CARSXE_RECOGNIZE_LICENSE_PLATE`

Analyze a publicly accessible vehicle image and return license-plate candidates, regions, confidence, bounding boxes, and detected vehicle details.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.15 per successful license plate recognition

**Discount:** 86

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_url` | string | Yes | Publicly accessible HTTPS URL of an image containing a vehicle or license plate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Recall Batch

**Slug:** `CARSXE_SUBMIT_RECALL_BATCH`

Create one asynchronous CarsXE recall-check batch for 1 to 10,000 VIN entries. Submission charges one Recalls Batch unit per unique valid VIN after CarsXE normalizes and deduplicates the list. The action makes one submission request and does not poll or resubmit an ambiguous failure; use the returned batch ID to check progress or retrieve results later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vins` | array | Yes | VINs to check. Each item must contain exactly 17 characters. CarsXE normalizes and deduplicates duplicates, and charges once per unique valid VIN. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |