CarsXE Specifications Market Value History Plate Decoder Images What Car Is That? Plate Recognition OBD Codes Decoder

Documentation

Welcome to CarsXE API!

CarsXE API helps you pull all sorts of information on vehicles to help your business and everything in between.

Get familiar with the CarsXE products and explore their features:

Vehicle Specifications

A complete solution for vehicle info.

Vehicle Market Value

Solid specific market data on any car.

Vehicle History

Toolkit for the complete background.

Vehicle Plate Decoder

Know a car from the plate.

Vehicle Images

Retrieve high quality images.

What Car Is That? API

Vehicle Recognition From Image.

Plate Recognition API

Recognition From Image.

OBD Codes Decoder API

Diagnose troubles from codes.

 Vehicle Specifications

The Vehicle Specifications API provides access to a library of vehicle specifications data.

Data covered in the API includes attributes, color options, equipment details, recall information, warranties, and photos. If none of these attributes are added to the include only attributes and selections will be returned.

There is also another component to the API which allows for a "selections" request that can be used to retrieve lists of vehicles based on their year, make, model, trim, style, or ID. Get started today with an active CarsXE API key.

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. 

get http://api.carsxe.com/specs?
Vehicle Parameters (VIN Search)

key
Required

Your CarsXE API key

vin
Required

The 17 character long vehicle identification number

format
Optional

The output format either json or xml

get http://api.carsxe.com/specs?
Vehicle Specs VIN Search Example
get http://api.carsxe.com/specs?key=<CarsXE_API_Key>&vin=JTDZN3EU0E3298500
Vehicle Specifications Response
Parameters Description Example
input Contains the input parameters specified by the query 
{
  "vin":"JTDZN3EU0E3298500",
  "key":"CarsXE_API_Key"
}
attributes A map of specifications about the VIN (VIN, Year, Make, Model, Trim, Trim Selections, Style, Type, Size, Category, Made In, Made In City, Doors, Fuel Type, Fuel Capacity, CityMileage, Highway Mileage, Engine, Engine Size, Engine Cylinders, Transmission, Transmission Type, Transmission Speeds, Drivetrain, Anti-Brake System, Steering Type, Curb Weight, Gross Weight, Gross Vehicle Weight Rating, Overall Height, Overall Length, Overall Width, Wheelbase Length, Standard Seating, Optional Seating, Invoice Price, Delivery Charges, Manufacturer Suggested Retail Price). 
{
  "year": "2014",
  "make": "Toyota",
  "model": "Prius V",
  "trim": "Three",
  "style": "HATCHBACK 4-DR",
  "type": "Wagon",
  "size": "",
  "category": "",
  "made_in": "JAPAN",
  "made_in_city": "TSUTSUMI",
  "doors": "5",
  "fuel_type": "Gasoline",
  "fuel_capacity": "11.90 gallon",
  "city_mileage": "44 miles/gallon",
  "highway_mileage": "40 miles/gallon",
  "engine": "1.8L L4 DOHC 16V HYBRID",
  "engine_size": "",
  "engine_cylinders": "4",
  "transmission": "Continuously Variable Transmission",
  "transmission_short": "CVT",
  "transmission_type": "",
  "transmission_speeds": "",
  "drivetrain": "FWD",
  "anti_brake_system": "4-Wheel ABS",
  "steering_type": "R&P",
  "curb_weight": "3274 lbs",
  "gross_vehicle_weight_rating": "4321 lbs",
  "overall_height": "62.00 in.",
  "overall_length": "181.70 in.",
  "overall_width": "69.90 in.",
  "wheelbase_length": "109.40 in.",
  "standard_seating": "5",
  "invoice_price": "$25,613 USD",
  "delivery_charges": "$810 USD",
  "manufacturer_suggested_retail_price": "$27,515 USD",
  "production_seq_number": "298500",
  "front_brake_type": "Disc",
  "rear_brake_type": "Drum",
  "turning_diameter": "36.10 in.",
  "front_suspension": "Ind",
  "rear_suspension": "Semi",
  "front_spring_type": "Coil",
  "rear_spring_type": "Coil",
  "tires": "205/60R16",
  "front_headroom": "39.60 in.",
  "rear_headroom": "38.60 in.",
  "front_legroom": "41.30 in.",
  "rear_legroom": "35.90 in.",
  "front_shoulder_room": "55.90 in.",
  "rear_shoulder_room": "55.20 in.",
  "front_hip_room": "53.50 in.",
  "rear_hip_room": "53.50 in.",
  "interior_trim": [
      "Bisque",
      "Dark Gray",
      "Misty Gray"
  ],
  "exterior_color": [
      "Barcelona Red Met",
      "Black",
      "Blizzard Pearl",
      "Blue Ribbon Metallic",
      "Classic Silver Metallic",
      "Clear Sky Metallic",
      "Magnetic Gray Metallic",
      "Sea Glass Pearl"
  ],
  "curb_weight_manual": "",
  "ground_clearance": "5.70 in.",
  "track_front": "60.60 in.",
  "track_rear": "60.80 in.",
  "cargo_length": "",
  "width_at_wheelwell": "",
  "width_at_wall": "",
  "depth": "",
  "optional_seating": "",
  "passenger_volume": "97.20 cu.ft.",
  "cargo_volume": "34.30 cu.ft.",
  "standard_towing": "",
  "maximum_towing": "",
  "standard_payload": "915 lbs",
  "maximum_payload": "915 lbs",
  "maximum_gvwr": "4321 lbs"
}
colors Details about available color options based on the vehicle’s year, make, model 
[
    {
        "category": "Interior",
        "name": "Bisque"
    },
    {
        "category": "Interior",
        "name": "Dark Gray"
    },
    {
        "category": "Interior",
        "name": "Misty Gray"
    },
    {
        "category": "Exterior",
        "name": "Barcelona Red Met"
    },
    {
        "category": "Exterior",
        "name": "Black"
    },
    {
        "category": "Exterior",
        "name": "Blizzard Pearl"
    },
    {
        "category": "Exterior",
        "name": "Blue Ribbon Metallic"
    },
    {
        "category": "Exterior",
        "name": "Classic Silver Metallic"
    },
    {
        "category": "Exterior",
        "name": "Clear Sky Metallic"
    },
    {
        "category": "Exterior",
        "name": "Magnetic Gray Metallic"
    },
    {
        "category": "Exterior",
        "name": "Sea Glass Pearl"
    }
]
equipment Details about a vehicle’s equipment based on the vehicle’s year, make, model 
{
  "4wd_awd": "N/A",
  "abs_brakes": "Std.",
  "adjustable_foot_pedals": "N/A",
  "air_conditioning": "Std.",
  "alloy_wheels": "Std.",
  "am_fm_radio": "N/A",
  "automatic_headlights": "Std.",
  "automatic_load_leveling": "N/A",
  "cargo_area_cover": "Std.",
  "cargo_area_tiedowns": "Std.",
  "cargo_net": "Opt.",
  "cassette_player": "N/A",
  "cd_changer": "N/A",
  "cd_player": "Std.",
  "child_safety_door_locks": "Std.",
  "chrome_wheels": "N/A",
  "cruise_control": "Std.",
  "daytime_running_lights": "Std.",
  "deep_tinted_glass": "N/A",
  "driver_airbag": "Std.",
  "driver_multi_adjustable_power_seat": "N/A",
  "dvd_player": "N/A",
  "electrochromic_exterior_rearview_mirror": "N/A",
  "electrochromic_interior_rearview_mirror": "N/A",
  "electronic_brake_assistance": "Std.",
  "electronic_parking_aid": "N/A",
  "first_aid_kit": "Opt.",
  "fog_lights": "N/A",
  "front_air_dam": "N/A",
  "front_cooled_seat": "N/A",
  "front_heated_seat": "N/A",
  "front_power_lumbar_support": "Std.",
  "front_power_memory_seat": "N/A",
  "front_side_airbag": "Std.",
  "front_side_airbag_with_head_protection": "N/A",
  "front_split_bench_seat": "N/A",
  "full_size_spare_tire": "N/A",
  "genuine_wood_trim": "N/A",
  "glass_rear_window_on_convertible": "N/A",
  "heated_exterior_mirror": "N/A",
  "heated_steering_wheel": "N/A",
  "high_intensity_discharge_headlights": "N/A",
  "interval_wipers": "N/A",
  "keyless_entry": "Std.",
  "leather_seat": "N/A",
  "leather_steering_wheel": "N/A",
  "limited_slip_differential": "N/A",
  "load_bearing_exterior_rack": "N/A",
  "locking_differential": "N/A",
  "locking_pickup_truck_tailgate": "Std.",
  "manual_sunroof": "Opt.",
  "navigation_aid": "Std.",
  "passenger_airbag": "Std.",
  "passenger_multi_adjustable_power_seat": "N/A",
  "pickup_truck_bed_liner": "N/A",
  "pickup_truck_cargo_box_light": "N/A",
  "power_adjustable_exterior_mirror": "N/A",
  "power_door_locks": "Std.",
  "power_sliding_side_van_door": "N/A",
  "power_sunroof": "Opt.",
  "power_trunk_lid": "N/A",
  "power_windows": "Std.",
  "rain_sensing_wipers": "N/A",
  "rear_spoiler": "Std.",
  "rear_window_defogger": "Std.",
  "rear_wiper": "Std.",
  "remote_ignition": "Opt.",
  "removable_top": "N/A",
  "run_flat_tires": "N/A",
  "running_boards": "N/A",
  "second_row_folding_seat": "Std.",
  "second_row_heated_seat": "N/A",
  "second_row_multi_adjustable_power_seat": "N/A",
  "second_row_removable_seat": "N/A",
  "second_row_side_airbag": "N/A",
  "second_row_side_airbag_with_head_protection": "N/A",
  "second_row_sound_controls": "N/A",
  "separate_driver_front_passenger_climate_controls": "N/A",
  "side_head_curtain_airbag": "Std.",
  "skid_plate": "N/A",
  "sliding_rear_pickup_truck_window": "N/A",
  "splash_guards": "Opt.",
  "steel_wheels": "N/A",
  "steering_wheel_mounted_controls": "Std.",
  "subwoofer": "N/A",
  "tachometer": "N/A",
  "telematics_system": "N/A",
  "telescopic_steering_column": "Std.",
  "third_row_removable_seat": "N/A",
  "tilt_steering": "Std.",
  "tilt_steering_column": "Std.",
  "tire_pressure_monitor": "Std.",
  "tow_hitch_receiver": "N/A",
  "towing_preparation_package": "N/A",
  "traction_control": "Std.",
  "trip_computer": "Std.",
  "trunk_anti_trap_device": "N/A",
  "vehicle_anti_theft": "Std.",
  "vehicle_stability_control_system": "Std.",
  "voice_activated_telephone": "N/A",
  "wind_deflector_for_convertibles": "N/A"
}
warranties Details about manufacturer warranties based on the vehicle’s year, make, model, and trim 
[{
  "type":"Basic",
  "miles":"36,000 miles",
  "months":"36 months"
},{
  "type":"Powertrain",
  "miles":"60,000 miles",
  "months":"60 months"
},{
  "type":"Rust",
  "months":"60 months",
  "miles":"Unlimited miles"
}]
deepdata More information on the vehicle from our deep data search 
{
  "Error Code": "0",
  "Error Text": "0 - VIN decoded clean. Check Digit (9th position) is correct",
  "Make": "TOYOTA",
  "Manufacturer Name": "TOYOTA MOTOR NORTH AMERICA, INC",
  "Model": "Prius V",
  "Model Year": "2014",
  "Plant City": "TSUTSUMI",
  "Series": "ZVW41L",
  "Vehicle Type": "PASSENGER CAR",
  "Plant Country": "JAPAN",
  "Plant Company Name": "Toyota Motor Corp.",
  "Manufacturer Id": "962",
  "Body Class": "Wagon",
  "Doors": "5",
  "Bed Type": "Not Applicable",
  "Cab Type": "Not Applicable",
  "Trailer Type Connection": "Not Applicable",
  "Trailer Body Type": "Not Applicable",
  "Drive Type": "4x2",
  "Engine Number of Cylinders": "4",
  "Displacement (CC)": "1800.0",
  "Displacement (CI)": "109.84273937051",
  "Displacement (L)": "1.8",
  "Engine Model": "2ZR-FXE+5JM",
  "Engine Power (KW)": "73.0786",
  "Fuel Type - Primary": "Gasoline",
  "Engine Configuration": "In-Line",
  "Fuel Type - Secondary": "Electric",
  "Fuel Delivery / Fuel Injection Type": "Multipoint Fuel Injection (MPFI)",
  "Engine Brake (hp)": "98",
  "Electrification Level": "Strong HEV (Hybrid Electric Vehicle)",
  "Seat Belts Type": "Manual",
  "Curtain Air Bag Locations": "All Rows",
  "Front Air Bag Locations": "1st Row (Driver & Passenger)",
  "Knee Air Bag Locations": "Driver Seat Only",
  "Side Air Bag Locations": "1st Row (Driver & Passenger)",
  "TPMS": "Direct",
  "NCSA Body Type": "Station Wagon (excluding van and truck based)",
  "NCSA Make": "Toyota",
  "NCSA Model": "Prius *",
  "Bus Floor Configuration Type": "Not Applicable",
  "Bus Type": "Not Applicable",
  "Custom Motorcycle Type": "Not Applicable",
  "Motorcycle Suspension Type": "Not Applicable",
  "Motorcycle Chassis Type": "Not Applicable"
},
success Whether vehicle specifications data exists 
true
error One of the following error codes:
invalid_inputs (missing VIN, ID, or year/make/model/trim)
invalid_vin (not a valid VIN)
no_data (no specifications available)
api_not_enabled (functionality not enabled for API key)
or (blank) if no error 
"invalid_vin"

 Vehicle Market Value

The Vehicle Market Value API provides access to a library of vehicle market value data.

The Vehicle Market Value API estimates the market value for used and new cars by VIN based on millions of historical vehicle sales stored in CarsXE's sales database.

With the assumption that sale prices are normally distributed, CarsXE's market value model estimates the "below market" and "above market" values within a distribution.

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled. 

GET http://api.carsxe.com/marketvalue?
Vehicle Market Parameters

key
Required

Your CarsXE API key

vin
Required

The vehicle identification number.

format
Optional

The output format either json or xml

GET http://api.carsxe.com/marketvalue?
Vehicle Market Value Search Example
GET http://api.carsxe.com/marketvalue?key=<CarsXE_API_Key>&vin=1FT8X3BT0BEA61538&format=json
Vehicle Market Value Response
Parameters Description Example
vin The vehicle identification number WDDSJ4EB7EN128078
success Whether market value data has been retrieved 
true
retail Retail price of the vehicle 13225
tradeIn The trade in price of the vehicle 
11550
roughTradeIn The rough trade in price of the vehicle. 
8400
averageTradeIn The average trade in of the vehicle 
10125
loanValue Loan value of vehicle 
10400
msrp Manufacturer suggested retail price of vehicle 
29900
tradeInValues A list of trade in values recorded for the vehicle 
[{
    "date": "2019-10-01T00:00:00.000Z",
    "value": "2100"
  },
  {

  "date": "2019-09-01T00:00:00.000Z",
  "value": "2100"
  },
  {
    "date": "2019-08-01T00:00:00.000Z",
    "value": "2175"
  },
  {
    "date": "2019-07-01T00:00:00.000Z",
    "value": "2175"
}]
auctionValues Map of auction value ranges in a given data range. 
{
    "lowAuctionValue": 8900,
    "averageAuctionValue": 10975,
    "highAuctionValue": 13075,
    "dateRange": "06/15/2020 - 06/21/2020"
  }

 Vehicle History (complete)

The Vehicle History API provides access to a library of vehicle history data.

The Vehicle History API returns a comprehensive set of history records for used and new cars by VIN based on millions of historical vehicle sales stored in CarsXE's sales database.

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled. 

GET http://api.carsxe.com/history?
Vehicle History Parameters

key
Required

Your CarsXE API key

vin
Required

The vehicle identification number.

format
Optional

The output format either json or xml

GET http://api.carsxe.com/history?
Vehicle History Search Example
GET http://api.carsxe.com/history?key=<CarsXE_API_Key>&vin=5TDYK3DC8DS290235
Vehicle History Response
"vin": "5TDYK3DC8DS290235"
Parameters Description Example
vin The VIN number of the searched vehicles.
success Whether the history call succeeded 
"success": true
junkAndSalvageInformation A list of dynamic maps of junk and salvage information. 
"specs": [{
  "ReportingEntityAbstract": {
    "ReportingEntityCategoryCode": "J",
    "IdentificationID": "P000001",
    "ReportingEntityCategoryText": "Junk and Salvage",
    "EntityName": "Copart, Inc.",
    "LocationCityName": "Dallas",
    "LocationStateUSPostalServiceCode": "TX",
    "TelephoneNumberFullID": "9723915728",
    "ContactEmailID": ""
  },
  "VehicleObtainedDate": "2017-11-21T00:00:00.000Z",
  "VehicleDispositionText": "TO BE DETERMINED",
  "VehicleIntendedForExportCode": "N"
},
...]
insuranceInformation A list of insurance records 
"insuranceInformation": [{
    "ReportingEntityAbstract": {
        "ReportingEntityCategoryCode": "I",
        "IdentificationID": "I200697",
        "ReportingEntityCategoryText": "Insurers",
        "EntityName": "MERCURY GENERAL GROUP",
        "LocationCityName": "BREA",
        "LocationStateUSPostalServiceCode": "CA",
        "TelephoneNumberFullID": "7146716600",
        "ContactEmailID": "DBALES@MERCURYINSURANCE.COM"
    },
    "VehicleObtainedDate": "2017-09-22T00:00:00.000Z"
},
...]
brandsRecordCount The count of brand records 
"brandsRecordCount": 4,
brandsInformation Description of the different brand codes and their meaning. 
"brandsInformation": [{
  "code": "00",
  "name": "Clear",
  "description": "No brand exists for the vehicle."
},
{
  "code": "01",
  "name": "Flood damage",
  "description": "\"Vehicle damaged by freshwater flood (or...\""
},
...],
vinChanged Boolean of whether VIN changed or not. 
"vinChanged": false,
currentTitleInformation Current Title Information of vehicle. 
"currentTitleInformation": [{
  "VehicleIdentification": {
      "IdentificationID": "5TDYK3DC8DS290235"
  },
  "TitleIssuingAuthorityName": "UT",
  "TitleIssueDate": {
      "Date": "2019-10-21T00:00:00.000Z"
  },
  "VehicleOdometerReadingMeasure": "000036051",
  "VehicleOdometerReadingUnitCode": "M",
  "RecordMatchSequenceID": "01",
  "HistoricTitleAbstract": [
  {
      "VehicleIdentification": {
          "IdentificationID": "5TDYK3DC8DS290235"
      },
      "TitleIssuingAuthorityName": "UT",
      "TitleIssueDate": {
          "Date": "2019-09-10T00:00:00.000Z"
      },
      "VehicleOdometerReadingMeasure": "000036051",
      "VehicleOdometerReadingUnitCode": "M"
  },
  ...],
}]
historyInformation Detailed history information on the vehicle. 
"historyInformation": [{
    "VehicleIdentification": {
        "IdentificationID": "5TDYK3DC8DS290235"
    },
    "TitleIssuingAuthorityName": "UT",
    "TitleIssueDate": {
        "Date": "2019-09-10T00:00:00.000Z"
    },
    "VehicleOdometerReadingMeasure": "000036051",
    "VehicleOdometerReadingUnitCode": "M"
},
...]
Vehicle History Failure Response
Parameters Description Example
status The status of the call 
404
success Whether the report has been generated. 
false
error A dynamic map of the code and message if available. 
"error": {
  "code": "report_not_found",
  "message": null
}

 Vehicle Plate Decoder

The Vehicle Plate Decoder API provides access to a library of vehicle's data based on the vehicle's registration/license plate number and state.

The Vehicle Plate Decoder API looks up the vehicle through the database for matches and returns the VIN, make, model and year among other attributes. It can be coupled with other APIs to become even more powerful. The state is a two letter abbreviation of one of the 50 states, or DC (District of Columbia), GU (Guam), PR (Puerto Rico) or VI (Virgin Islands).

International support includes the following countries: Australia, Brazil, United Kingdom, Ireland, Italy, Spain, India, Mexico and New Zealand. Use the state codes: BR, UK, IR, IT, ES, IND, MX or NZ respectively.

For Australia use country=AU&state=NSW. The list of possible Australian states are:

  • NSW (New South Wales),
  • VIC (Victoria),
  • QLD (Queensland incl. North Queensland),
  • SA (South Australia),
  • ACT (Canberra),
  • NT (Northern Territory),
  • TAS (Tasmania),
  • WA (Western Australia)

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled.

GET http://api.carsxe.com/platedecoder?
Vehicle Plate Decoder Parameters

key
Required

Your CarsXE API key

plate
Required

The vehicle registration number or license plate number.

state
Required

The two letter state code (US) such as CA or NY

format
Optional

The output format either json or xml

GET http://api.carsxe.com/platedecoder?
Vehicle Plate Decoder Search Example
GET http://api.carsxe.com/platedecoder?key=<CarsXE_API_Key>&plate=36619HT&state=MD&format=json
Vehicle Plate Decoder Response
Parameters Description Example
vin The vehicle identification number 4T1BF22K5WU057633
success Whether market value data has been retrieved 
true
imageUrl A stock photo of that general vehicle. (Use Images API for more control) 
"https://api.carsxe.com/pic?image=@VG95b3RhIENhbXJ5IENFIC8gTEUgLyBYTEU="
assembly Where the vehicle was assembled. 
"United States"
Description Vehicle description of make, model and trim 
"Toyota Camry CE / LE / XLE"
RegistrationYear Year the vehicle's registration. 
"1998"
CarMake The vehicle make. 
"Toyota"
CarModel The model of the vehicle. 
"Camry CE / LE / XLE"
BodyStyle The specific vehicle body style 
"Sedan 4D"
EngineSize The vehicle's engine size. 
"3.0L V6 EFI"

Vehicle Images

The Vehicle Images API provides access to a library of vehicle's images.

The Vehicle Images API looks up beautiful photos of vehicles from their year, make and model. You can even specify the color you're looking for and if you want the background to be transparent.

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled. 

GET http://api.carsxe.com/images?
Vehicle Image Parameters

key
Required

Your CarsXE API key

make
Required

The vehicle make.

model
Required

The vehicle model.

year
Optional

The vehicle year.

trim
Optional

The vehicle trim.

color
Optional

The vehicle color.

transparent
Optional

The boolean request of transparent background. Could be true or false. Defaults to true.

angle
Optional

The angle to show the car in. Could be front, side or back.

photoType
Optional

Optionally request images of either the interior, exterior or engine. Can only be used in conjunction with year, make, model and trim query params.

size
Optional

Optionally request images of size: Small, Medium, Large, Wallpaper or All. By defualt it returns all sizes.

license
Optional

Filter images by the following license types: Public, Share, ShareCommercially, Modify or ModifyCommercially. You may leave this field blank to return all images.

format
Optional

The output format either json or xml

GET http://api.carsxe.com/images?
Vehicle Images Search Example
GET http://api.carsxe.com/images?key=<CarsXE_API_Key>&year=2018&make=toyota&model=tacoma&color=blue&format=json
Vehicle Image Response
Parameters Description Example
images

A list (array) of “image” elements or objects, each of which contain a mime, link, dimensions and more!

Accent color is the hexidecimal overwhelming color of the image which you can use to replace the image while it loads. 

{
    "images": [{
        "mime": "image/png",
        "link": "https://bit.ly/34tpueu",
        "contextLink": "https://www.mariettatoyota.com/toyota-tacoma/",
        "height": 272,
        "width": 1000,
        "byteSize": 56662,
        "thumbnailLink": "https://bit.ly/34xewVr",
        "thumbnailHeight": 41,
        "thumbnailWidth": 149,
        "hostPageDomainFriendlyName": "Automobile",
        "accentColor": "B51617",
        "datePublished": "2018-06-29T22:24:00.0000000Z"
    },{...}]
}
success Whether images have been retrieved. 
{
  "images": [{...}],
  "success": true,
  "error": ""
}
error String detailing error if any. 
{
  "images": [{...}],
  "success": false,
  "error": "Please provide a make and model"
}
query Object detailing the query you made. 
{
  "images": [{...}],
  "success": true,
  "error": "",
  "query": {
    "year": "2018",
    "make": "chevy",
    "model": "equinox",
    "transparent": "true",
    "size": "Large",
    "format": "json"
  }
}

What Car Is That? API

Have you ever looked at a car or a picture of a car and wondered what's the make, model and year of that vehicle?

The What Car Is That? API given an image (link or base64 string) uses machine learning to identify the particular make, model, year, and body style of the car in the image. The API is able to identify over 3000 vehicles and the dataset is growing everyday!

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled. 

POST http://api.carsxe.com/whatcaristhat?
What Car Is That? API Parameters

key
Required

Your CarsXE API key

body
Required

POST body that's a URL to an image or the base64 string of the image. 

POST http://api.carsxe.com/whatcaristhat?
What Car Is That? API Search Example
POST /whatcaristhat?key=<CarsXE_API_Key>  HTTP/1.1
Host: http://api.carsxe.com
Content-Type: text/plain
https://upload.wikimedia.org/wikipedia/commons/4/44/2019_Acura_RDX_A-Spec_front_red_4.2.18.jpg
What Car Is That? API Response
Parameters Description Example
results

A list (array) of "vehicle" elements or objects, each of which contain the body style, year, make, model and confidence score (between 0 and 1).

The confidence score is a probability that the vehicle in the image matches the values returned. 

{
    "results": [{
        "body_style": "SUV",
        "confidence": "0.99",
        "make": "Acura",
        "model": "RDX",
        "model_year": "2018"
    },
    {
        "body_style": "SUV",
        "confidence": "0.00",
        "make": "Acura",
        "model": "RDX",
        "model_year": "2015"
    },{...}]
}
success Whether the algorithm has been able to successfully analyze the image. 
{
  "results": [{...}],
  "success": true,
  "message": ""
}
message String detailing error if any. 
{
  "results": [{...}],
  "success": true,
  "message": "Could not make out the vehicle in the image."
}

 License Plate Recognition API

Our plate recognition API provides accurate recognition of license plates from images. The API is trained on license plates from over 100 countries and states.

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled. 

POST http://api.carsxe.com/platerecognition
What Car Is That? API Parameters

key
Required

Your CarsXE API key

body
Required

POST body that's a URL to an image of a vehicle's license plate.

IMG_URL
Required

Vehicle image URL. The image must be a direct link to the image of the vehicle including a license plate. (Ex.: https://api.carsxe.com/img/apis/plate_recognition.JPG) 

POST http://api.carsxe.com/platerecognition
Plate Recognition API Example
POST curl --location --request POST \
'https://api.carsxe.com/platerecognition?key=<CarsXE_API_Key>' \
--form 'upload_url="https://api.carsxe.com/img/apis/plate_recognition.JPG"'
License Plate Recognition API Response
Parameters Description Example
results

A list (array) of "plate" elements or objects, each of which contain the box of where the plate is in the image, a list of candidates with the relative confidence scores, the region and more info.

The confidence score is a probability that the plate in the image matches the values returned. 

{
    "results": [{
        "box": {
            "xmax": 324,
            "xmin": 168,
            "ymax": 707,
            "ymin": 624
        },
        "candidates": [
            {
                "plate": "fd1307",
                "score": 0.906
            },
            {
                "plate": "fd13o7",
                "score": 0.904
            },
            {
                "plate": "fdi307",
                "score": 0.767
            },
            {
                "plate": "fdi3o7",
                "score": 0.765
            }
        ],
        "dscore": 0.697,
        "plate": "fd1307",
        "region": {
            "code": "us",
            "score": 0.436
        },
        "score": 0.906,
        "vehicle": {
            "score": 0.858,
            "type": "Car"
        }
    },{...}]
}
success Whether the algorithm has been able to successfully analyze the image. 
{
    "results": [{...}],
    "success": true,
    "message": "",
    "camera_id": null,
    "filename": "04_40_btmpUZGp0s.jpg",
    "processing_time": 226.906,
}
message String detailing error if any. 
{
    "results": [{...}],
    "success": true,
    "message": "",
    "camera_id": null,
    "filename": "04_40_btmpUZGp0s.jpg",
    "processing_time": 226.906,
}
processing_time How much time it took to proces the image. 
{
    "results": [{...}],
    "success": true,
    "message": "",
    "camera_id": null,
    "filename": "04_40_btmpUZGp0s.jpg",
    "processing_time": 226.906,
}

 OBD Codes Decoder

The OBD Codes Decoder API provides access to a library of over 3000 OBD codes and their matching vehicle diagnosis.

The OBD Codes Decoder API matches the code to the vehicle trouble or diagnosis.

HTTPS calls are made to (api.carsxe.com) see below for the complete documentation details. Access to the vehicle market value API requires an API account with market value access enabled. 

GET http://api.carsxe.com/obdcodesdecoder?
OBD Codes Decoder Parameters

key
Required

Your CarsXE API key

code
Required

The OBD code.

GET http://api.carsxe.com/obdcodesdecoder?
OBD Codes Decoder Search Example
GET http://api.carsxe.com/obdcodesdecoder?key=<CarsXE_API_Key>&code=P0115
OBD Codes Decoder Response
Parameters Description Example
code The OBD Code 
"P0115"
success Whether market value data has been retrieved 
true
diagnosis The diagnosis of the OBD code. 
"Engine Coolant Temperature Circuit Malfunction"
date The date of the search 
"2020-07-04T21:44:39.767Z"