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

include
Optional

Type of data to be included in the response. selections, attributes, equipment, colors, recalls, warranties, photos

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=1FT8X3BT0BEA61538&include=selections,attributes,colors
Vehicle Parameters (YMMT Search)

key
Required

Your CarsXE API key

year
Required

The selected vehicle year.
Example: 2004

make
Required

The selected vehicle make.
Example: toyota

model
Required

The selected vehicle model.
Example: corolla

trim
Optional

The selected vehicle trim.
Example: ce

include
Optional

Type of data to be included in the response. selections, attributes, equipment, colors, recalls, warranties, photos

format
Optional

The output format either json or xml

Get http://api.carsxe.com/specs?
Vehicle Specs YMMT Search Example
Get http://api.carsxe.com/specs?key=<CarsXE_API_Key>&year=2004&make=toyota&model=camry
Vehicle Parameters (ID Search)

key
Required

Your CarsXE API key

id
Required

Unique identifier associated with each of the following attribute combinations:
year_make_model_trim
year_make_model_trim_style

include
Optional

Type of data to be included in the response. selections, attributes, equipment, colors, recalls, warranties, photos

format
Optional

The output format either json or xml

Get http://api.carsxe.com/specs?
Vehicle Specs ID Search Example
Get http://api.carsxe.com/specs?key=<CarsXE_API_Key>&id=2012_toyota_camry_xle&format=json
Vehicle Specifications Response
Parameters Description Example
input Contains the input parameters specified by the query
{
  "vin":"1NXBR32E85Z505904",
  "format":"json",
  "include":"selections,attributes"
}
selections Contains the trim IDs, trim names, style IDs, and style names
{
  "trims": [{
    "id":"2013_bmw_3series_328i",
    "name":"328i",
    "selected":1,
    "styles": [{
      "id":"2013_bmw_3series_328i_sedan",
      "name":"Sedan",
      "selected":1
    }]
  }]
}
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":"2004",
  "make":"Toyota",
  "model":"Corolla",
  "trim":"S",
  "style":"",
  "type":"Car",
  "size":"Compact",
  "category":"Compact Cars",
  "made_in":"America",
  "made_in_city":"Cambridge",
  "doors":"4",
  "fuel_type":"Regular Unleaded",
  "fuel_capacity":"13.20 gallons",
  "city_mileage":"30 – 32 miles\/gallon",
  "highway_mileage":"38 – 41 miles\/gallon",
  "engine":"1.8-L L-4 DOHC 16V",
  "engine_size":"1.8-L",
  "engine_cylinders":"L-4",
  "transmission":"4-Speed Automatic 5-Speed Manual",
  "transmission_type":"Manual",
  "transmission_speeds":"5-Speed"
}
colors Details about available color options based on the vehicle’s year, make, model
[{
  "category":"Exterior",
  "name":"Super White"
},{
  "category":"Exterior",
  "name":"Silver Streak Mica"
},{
  "category":"Exterior",
  "name":"Impulse RED"
},{
  "category":"Exterior",
  "name":"Black Sand Pearl"
},{
  "category":"Exterior",
  "name":"Indigo INK Pearl"
},{
  "category":"Exterior",
  "name":"Phantom Gray Pearl"
}]

equipment Details about a vehicle’s equipment based on the vehicle’s year, make, model
[{
  "group":"Anti-Theft & Locks",
  "name":"Child Safety Door Locks",
  "availability":"Standard"
},{
  "group":"Anti-Theft & Locks",
  "name":"Power Door Locks",
  "availability":"Standard"
},{
  "group":"Safety",
  "name":"Front Side Airbag",
  "availability":"Optional"
},
{
  "group":"Entertainment, Communication & Navigation",
  "name":"CD Player",
  "availability":"Standard"
},
...
]
recalls Details about recall information based on the vehicle’s year, make, model, and trim
[{
  "source":"NHTSA",
  "campaign":"15V285000″,
  "date":"20150513″,
  "components":"AIR BAGS",
  "summary":"(Toyota) notified the agency of recall…"
}]
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"
}]
photos Photos based on the vehicle’s year, make, model, and trim
[{
  "url":"https://imgset.info/a/1NXBR38E74Z195377_20190205_0-43001?size=medium"
},{
  "url":"https://imgset.info/a/1NXBR32E04Z192720_20190205_0-46560?size=medium"
},{
  "url":"https://imgset.info/a/JTDBR32E042024060_20190205_0-44966?size=medium"
}]
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 Selections API

The Vehicle Selections API provides access to a library of millions of vehicle data.

The Vehicle Selections API allows for a “selections” request that can be used to retrieve lists of vehicles based on their year, make, model, trim, style, or ID.

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/selections?
Vehicle Selections Parameters
Parameter Description Required Example
key Your CarsXE API Key Yes <CarsXE_API_Key>
year The vehicle year. No 2016
make The vehicle make. No toyota
model The vehicle model. No camry
trim The vehicle trim. No xle
style The vehicle sub trim. No v6
format

The output format either json or xml

No json
list

Dictates the attributes to be included in the response, each separated by the (+) sign

No

list=year
list=year+make
list=year+make+model
list=year+make+model+trim
list=year+make+model+trim+style
list=make
list=make+model
list=make+model+trim
list=make+model+trim+style

Vehicle Selections Search Example
Get http://api.carsxe.com/selections?key=<CarsXE_API_Key>&make=toyota&format=json
Vehicle Selections Value Response
Parameters Description Example
selections Contains the output elements (such as years, makes, model, trims) described below.
{"selections": {"years": [...]}}
years Contains a list (array) of “year” elements, each of which contain a name, id, and list of makes (see “makes” below)
{
  "years": [{
    "name": 2016, 
    "id": "2016", 
    "makes": [...]
  }]
}
makes Contains a list (array) of “make” elements, each of which contain a name, id, and list of models (see “models” below)
{
  "makes": [{
    "name": "Toyota", 
    "id": "2016_toyota", 
    "models": [...]
  }]
}
models Contains the vehicle model name, id, and the element “trims”
{
  "models": [{
    "name": "Camry", 
    "id": "2016_toyota_camry", 
    "trims": [...]
  }]
}
trims Contains the vehicle trim name, id, and element “styles”
{
  "trims": [{
    "name": "XLE", 
    "id": "2016_toyota_camry_xle", 
    "styles": [...]
  }]
}
styles Contains the vehicle style name and id
{
  "styles": [{
    "name": "V-6", 
    "id": "2016_toyota_camry_xle_v6"
  }]
}
success Whether selections data has been retrieved
{
  "selections": {...},
  "success": true
}
error String detailing error if any.
{
  "selections": {...},
  "success": false,
  "error": "please provide valid list"
}

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.

mileage
Optional

The current mileage of the vehicle (if not specified, average mileage is used)

interval
Optional

Number of days to look back for sales data (max: 365)

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&mileage=120000&interval=180&format=json
Vehicle Market Value Response
Parameters Description Example
vin The vehicle identification number 1FT8X3BT0BEA61538
success Whether market value data has been retrieved
true
vehicle The vehicle title (Year, Make, Model, Trim) 2012 Toyota Camry XLE
mileage The mileage used to compute the market value
75248
count The number of data points used for estimate
120
mean The estimate average market price
7044
stdev Standard deviation of prices
1276
certainty The statistical confidence in the market value
99
period The date range of the historical sales data used
["2015-06-27","2015-07-16"]
prices The estimated average market, below market, and above market prices
{"average":7044,"below":5768,"above":8320}

Vehicle Ownership Cost

The Vehicle Ownership Cost API provides access to a library of vehicle ownership cost estimate data.

The Vehicle Ownership Cost API can estimate the cost of ownership over the next 5 years based on a vehicle’s VIN. Support by millions of records in CarsXE's historical vehicle database, the API supports estimating depreciation, insurance, fuel, maintenance, repairs, and state taxes & fees.

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/ownershipcost?
Vehicle Ownership Cost Parameters

key
Required

Your CarsXE API key

vin
Required

The vehicle identification number.

state
Required

The two letter state code (US & Canada) such as CA or BC

format
Optional

The output format either json or xml

Get http://api.carsxe.com/ownershipcost?
Vehicle Ownership Cost Search Example
Get http://api.carsxe.com/ownershipcost?key=<CarsXE_API_Key>&vin=1FT8X3BT0BEA61538&state=CA&format=json
Vehicle Ownership Cost Response
Parameters Description Example
vin The vehicle identification number 1FT8X3BT0BEA61538
mileage_start The current mileage of the vehicle (default value: -1) 10000
mileage_year The estimated yearly mileage of the vehicle (default value: 15000) 15000
vehicle The vehicle title (Year, Make, Model, Trim) 2012 Toyota Camry XLE
depreciation_cost The estimated yearly depreciation cost
[1682, 807, 706, 639, 572]
insurance_cost The estimated yearly insurance cost
[1487, 1539, 1592, 1648, 1706]
fuel_cost The estimated yearly fuel cost
[2722, 2803, 2887, 2974, 3063]
maintenance_cost The estimated yearly maintenance cost
[2763, 1748, 845, 545, 2291]
repairs_cost The estimated yearly repairs cost
[977, 1138, 1298, 1417, 1627]
fees_cost The estimated yearly state fees & taxes cost
[459, 52, 67, 43, 59]
total_cost The estimated yearly total cost
[10089, 8088, 7396, 7266, 9319]
total_cost_sum The estimated overall total cost over the next 5 years
42158

Vehicle Simple History

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

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

The difference between the simple history and the Vehicle History API is that the simple history API provides an array of records of previous sales, and is much cheaper but it does NOT provide as much rich history such as salvage status, liens or other pertinent information unless it is in the sale records.

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/simplehistory?
Vehicle Simple History Parameters

key
Required

Your CarsXE API key

vin
Required

The vehicle identification number.

Get http://api.carsxe.com/simplehistory?
Vehicle Simple History Search Example
Get http://api.carsxe.com/simplehistory?key=<CarsXE_API_Key>&vin=1FT8X3BT0BEA61538
Vehicle Simple History Response
Parameters Description Example
success Response of success of API call
true
results Array of objects, each object is a historical record sorted by most to least recent (max. 50)
[{ "id": "a","price": 1000, ...}]
results[n].id Sale record identification
[{ "id": "a","price": 1000, ...}]
results[n].id Sale record identification
"id":"1FT8X3BT0BEA61538-327f0b1d-89aa-4465-b5b7-c991cccd0aef"
results[n][x] ... ...

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.

The Vehicle History API is different from the simple history API in that it provides more comprehensive information from multiple sources on the title status, salvage, liens, JSI's, vehicle sales and much more. However, it is more expensive than the vehicle simple history API.

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 Simple 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=1ZVHT84N555233717
Vehicle History Response
"status": 200
Parameters Description Example
status The success status of the call.
success Whether the history call succeeded
"success": true
data A dynamic map of the data under which you can access more info on the vehicle.
data: {
    "vin": "1ZVHT84N555233717",
    "has_accident": false,
    "title_brand": [...],
    "title_damage_brand": [...],
    "title_vehicle_use_brand": [...],
    "detailed_history": [...],
    "vehicle_usage": "Personal",
    "accident_info": [...],
    "odometer_info": [...]
}
vin The vehicle identification number.
"vin": "1ZVHT84N555233717"
has_accident A true or false Boolean of whether or not the vehicle has been in an accident.
"has_accident": true
accident_info List of accident info if any. Array could be empty. You can search detailed_history for more details on the accident at that date.
[{
  "date": "07/15/2013",
  "location": "KY"
}]
vehicle_usage How has the vehicle been used.
"vehicle_usage": "Personal"
title_brand A list of title brands that may have affected the vehicle. The list includes but is not limited to:
  • Fire brand
  • Hail brand
  • Flood brand
  • Junk or scrapped brand
  • Manufacturer buyback
  • Lemon brand
  • Salvage brand
  • Rebuilt or rebuildable brand
  • Odometer brand (EML or NAM)
[{
    "label": "Fire brand",
    "value": false
  },
  {
    "label": "Hail brand",
    "value": false
  },
  {
    "label": "Flood brand",
    "value": false
  },
  {
    "label": "Junk or scrapped brand",
    "value": false
  },
  {
    "label": "Manufacturer buyback",
    "value": false
  },
  {
    "label": "Lemon brand",
    "value": false
  },
  {
    "label": "Salvage brand",
    "value": false
  },
  {
    "label": "Rebuilt or rebuildable brand",
    "value": false
  },
  {
    "label": "Odometer brand (EML or NAM)",
    "value": false
}]
title_damage_brand A list of title damage brands that may have affected the vehicle. The list includes but is not limited to:
  • Non-title fire damaged record
  • Non-title hail damaged record
  • Non-title flood damaged record
  • Auction junk or scrapped record
  • Auction rebuilt or rebuildable record
  • Salvage auction record
  • Damaged or major damage incident record
  • Structural damage or structural alteration record
  • Recycling facility record
  • Crash test record
[{
    "label": "Non-title fire damaged record",
    "value": false
  },
  {
    "label": "Non-title hail damaged record",
    "value": false
  },
  {
    "label": "Non-title flood damaged record",
    "value": false
  },
  {
    "label": "Auction junk or scrapped record",
    "value": false
  },
  {
    "label": "Auction rebuilt or rebuildable record",
    "value": false
  },
  {
    "label": "Salvage auction record",
    "value": false
  },
  {
    "label": "Damaged or major damage incident record",
    "value": false
  },
  {
    "label": "Structural damage or structural alteration record",
    "value": false
  },
  {
    "label": "Recycling facility record",
    "value": false
  },
  {
    "label": "Crash test record",
    "value": false
}]
title_vehicle_use_brand A list of vehicle use brands that may have affected the vehicle. The list includes but is not limited to:
  • Insurance Loss record
  • Titled to an insurance company record
  • Auction Lemon/Manufacturer Buyback record
  • Abandoned title record
  • Grey market title record
  • Loan/lien record(s)
  • Repossessed record
  • Corrected title record
  • Duplicate title record
  • Theft record(s)
[{
    "label": "Insurance Loss record",
    "value": false
  },
  {
    "label": "Titled to an insurance company record",
    "value": false
  },
  {
    "label": "Auction Lemon/Manufacturer Buyback record",
    "value": false
  },
  {
    "label": "Abandoned title record",
    "value": false
  },
  {
    "label": "Grey market title record",
    "value": false
  },
  {
    "label": "Loan/lien record(s)",
    "value": false
  },
  {
    "label": "Repossessed record",
    "value": false
  },
  {
    "label": "Corrected title record",
    "value": false
  },
  {
    "label": "Duplicate title record",
    "value": false
  },
  {
    "label": "Theft record(s)",
    "value": false            
}]
detailed_history A list of history records (which can include dealer reports, accident history detail, DMV records and more):
date: The date of the record.
location: The location of the record.
odometer: The odometer value of the record.
source: Source of the record.
detail: Detail of the record
[{
  "date":"06/09/2005",
  "location":"FL",
  "odometer":"",
  "source":"Independent Source",
  "detail":"VEHICLE MANUFACTURED AND SHIPPED TO DEALER"
},{
  "date":"07/15/2005",
  "location":"FL",
  "odometer":9,
  "source":"Local Motor Dept.",
  "detail":"ODOMETER READING FROM DMV"
},{
  "date":"07/15/2005",
  "location":"DAYTONA BEACH, FL",
  "odometer":"",
  "source":"Local Motor Dept.",
  "detail":"REGISTRATION RENEWAL"
},{
  "date":"07/31/2005",
  "location":"DAYTONA BEACH, FL",
  "odometer":"",
  "source":"Local Motor Dept.",
  "detail":"TITLE(Title #:0093681627)"
},{
  "date":"06/25/2010",
  "location":"DELAND, FL",
  "odometer":16915,
  "source":"Dealer Record",
  "detail":
    "VEHICLE IN DEALER INVENTORY(COLOR REPORTED AS BLACK)
     VEHICLE REPORTED TO BE UNDER WARRANTY"
},{
  "date":"08/06/2010",
  "location":"SANFORD, FL",
  "odometer":16951,
  "source":"Dealer Record",
  "detail":
    "VEHICLE IN DEALER INVENTORY
     (COLOR REPORTED AS BLACK)"
},{
  "date":"08/11/2010",
  "location":"PALM COAST, FL",
  "odometer":16915,
  "source":"Local Motor Dept.",
  "detail":"TITLE(Title #:0093681627) (Lien Reported)"
},{
  "date":"07/15/2013",
  "location":"KY",
  "odometer":"",
  "source":"State Agency",
  "detail":
    "REAR IMPACT WITH ANOTHER VEHICLE MINOR TO MODERATE DAMAGE REPORTED"
},{
  "date":"07/12/2016",
  "location":"WASHINGTON, DC",
  "odometer":98000,
  "source":"Local Motor Dept.",
  "detail":"TITLE(Title #:K2073334)"
},{
  "date":"06/22/2018",
  "location":"DC",
  "odometer":"",
  "source":"Local Motor Dept.",
  "detail":"PASSED EMISSION INSPECTION"
}]
odometer_info List of known odometer recording. Date and odometer values recorded.
[{
  "date": "07/15/2005",
  "mileage": 9
},{
  "date": "07/12/2016",
  "mileage": 98000
},{
  "date": "09/25/2019",
  "mileage": 123014
}]
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: The United Kingdom, Ireland, and Italy. Use the state codes: UK, IR or IT respectively.

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 or the base64 string of the image.

POST http://api.carsxe.com/platerecognition?
What Car Is That? API Search Example
POST /platerecognition?key=<CarsXE_API_Key>  HTTP/1.1
Host: http://api.carsxe.com
Content-Type: text/plain
https://upload.wikimedia.org/wikipedia/commons/thumb/6/6d/2006-2009_Honda_Civic_VTi_sedan_%282018-10-19%29_01.jpg/800px-2006-2009_Honda_Civic_VTi_sedan_%282018-10-19%29_01.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,
}