Skip to main content
CarsXE logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: CARSXE
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: CARSXE_CHECK_LIEN_AND_THEFTRetrieve 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 lookupDiscount: 60

Input Parameters

string
required
The exact 17-character vehicle identification number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_DECODE_LICENSE_PLATELook 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 plate decode; $1.00 with Spain require_vinDiscount: 60

Input Parameters

string
required
License plate text exactly as displayed, without adding separators.
string
State or regional code; required for US, AU, CA, and PK lookups.
string
ISO 3166-1 alpha-2 country code.
string
District required for Pakistan Khyber-Pakhtunkhwa registrations. This regional variant is officially documented but not live-verified.
boolean
For Spain only, require a VIN in the result. This doubles the price.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_DECODE_OBD_CODETranslate an OBD-II diagnostic trouble code into a readable diagnosis.Instant: Supported on the latest version.Instant pricing: $0.15 per successful OBD code decodeDiscount: 100

Input Parameters

string
required
OBD-II diagnostic trouble code to decode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_EXTRACT_VIN_FROM_IMAGEExtract 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 imageDiscount: 86

Input Parameters

string
required
Image containing a VIN, provided as an HTTP(S) URL or a raw base64-encoded image string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_MARKET_VALUEEstimate 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 valuationDiscount: 16

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_RECALL_BATCHMake 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

string ("status" | "results")
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.
string
required
Opaque CarsXE batch ID returned by Submit Recall Batch, typically beginning with brb_.
integer
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.
integer
Zero-based offset into the provider’s complete result array. Used only with view=results; pagination is applied locally after one provider request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_VEHICLE_HISTORYRetrieve 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 lookupDiscount: 70

Input Parameters

string
required
The exact 17-character vehicle identification number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_VEHICLE_IMAGESFind 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 lookupDiscount: 86

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_VEHICLE_RECALLSFind 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 lookupDiscount: 40

Input Parameters

string
Exact 17-character VIN. Do not combine with year, make, or model.
string
Vehicle manufacturer; required with year and model when VIN is omitted.
string
Four-digit model year; required with make and model when VIN is omitted.
string
Vehicle model; required with year and make when VIN is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_VEHICLE_SPECSDecode a 17-character VIN into vehicle identity, specifications, equipment, colors, and warranty data. International fallback is used when needed unless disabled; managed lookups require it disabled and extended data off.Instant: Supported on the latest version.Instant pricing: $0.15 per successful vehicle specification lookupDiscount: 93

Input Parameters

string
required
The exact 17-character vehicle identification number.
boolean
Fetch slower extended-source data; this may consume additional time or quota.
boolean
Disable CarsXE’s automatic international VIN-decoding fallback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_GET_YEAR_MAKE_MODEL_DATALook 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

string
required
Vehicle manufacturer.
string
Optional fuzzy-matched trim hint.
integer
required
Model year from 1900 through the current model year plus one.
string
required
Vehicle model.
boolean
Return concise summaries of every matching trim instead of only the best match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_RECOGNIZE_LICENSE_PLATEAnalyze a publicly accessible vehicle image at an HTTPS URL 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 recognitionDiscount: 86

Input Parameters

string
required
Publicly accessible HTTPS URL of an image containing a vehicle or license plate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARSXE_SUBMIT_RECALL_BATCHCreate one asynchronous CarsXE recall-check batch for 1 to 10,000 VIN entries. Charged 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

array
required
VINs to check. Each item must contain exactly 17 characters. CarsXE normalizes and deduplicates duplicates, and charges once per unique valid VIN.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not