The Documentation Page Moved!
We've moved our documentation to a new location. Please visit docs.VisionaryApis.com for the new and improved documentation page.
Documentation
Welcome to VisionaryApis!
VisionaryApis helps you pull all sorts of information on vehicles to help your business and everything in between.
Get familiar with the VisionaryApis products and explore their features:
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 VisionaryApis key.
HTTPS calls are made to (api.VisionaryApis.com) see below for the complete documentation details.
get http://api.VisionaryApis.com/specs?
Vehicle Parameters (VIN Search)
key
Required
Your VisionaryApis key
vin
Required
The 17 character long vehicle identification number
format
Optional
The output format either
json
or
xml
get http://api.VisionaryApis.com/specs?
Vehicle Specs VIN Search Example
get http://api.VisionaryApis.com/specs?key=<VisionaryApis_API_Key>&vin=JTDZN3EU0E3298500
Vehicle Specifications Response
Parameters | Description | Example |
---|---|---|
input | Contains the input parameters specified by the query |
|
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). |
|
colors | Details about available color options based on the vehicle’s year, make, model |
|
equipment | Details about a vehicle’s equipment based on the vehicle’s year, make, model |
|
warranties | Details about manufacturer warranties based on the vehicle’s year, make, model, and trim |
|
deepdata | More information on the vehicle from our deep data search |
|
success | Whether vehicle specifications data exists |
|
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 |
|
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 VisionaryApis's sales database.
With the assumption that sale prices are normally distributed, VisionaryApis's market value model estimates the "below market" and "above market" values within a distribution.
HTTPS calls are made to (api.VisionaryApis.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.VisionaryApis.com/marketvalue?
Vehicle Market Parameters
key
Required
Your VisionaryApis key
vin
Required
The vehicle identification number.
format
Optional
The output format either
json
or
xml
GET http://api.VisionaryApis.com/marketvalue?
Vehicle Market Value Search Example
GET http://api.VisionaryApis.com/marketvalue?key=<VisionaryApis_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 |
|
retail | Retail price of the vehicle | 13225 |
tradeIn | The trade in price of the vehicle |
|
roughTradeIn | The rough trade in price of the vehicle. |
|
averageTradeIn | The average trade in of the vehicle |
|
loanValue | Loan value of vehicle |
|
msrp | Manufacturer suggested retail price of vehicle |
|
tradeInValues | A list of trade in values recorded for the vehicle |
|
auctionValues | Map of auction value ranges in a given data range. |
|
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 VisionaryApis's sales database.
HTTPS calls are made to (api.VisionaryApis.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.VisionaryApis.com/history?
Vehicle History Parameters
key
Required
Your VisionaryApis key
vin
Required
The vehicle identification number.
format
Optional
The output format either
json
or
xml
GET http://api.VisionaryApis.com/history?
Vehicle History Search Example
GET http://api.VisionaryApis.com/history?key=<VisionaryApis_API_Key>&vin=5TDYK3DC8DS290235
Vehicle History Response
Parameters | Description | Example |
---|---|---|
vin | The VIN number of the searched vehicles. | |
success | Whether the history call succeeded |
|
junkAndSalvageInformation | A list of dynamic maps of junk and salvage information. |
|
insuranceInformation | A list of insurance records |
|
brandsRecordCount | The count of brand records |
|
brandsInformation | Description of the different brand codes and their meaning. |
|
vinChanged | Boolean of whether VIN changed or not. |
|
currentTitleInformation | Current Title Information of vehicle. |
|
historyInformation | Detailed history information on the vehicle. |
|
Vehicle History Failure Response
Parameters | Description | Example |
---|---|---|
status | The status of the call |
|
success | Whether the report has been generated. |
|
error | A dynamic map of the code and message if available. |
|
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.VisionaryApis.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.VisionaryApis.com/platedecoder?
Vehicle Plate Decoder Parameters
key
Required
Your VisionaryApis 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.VisionaryApis.com/platedecoder?
Vehicle Plate Decoder Search Example
GET http://api.VisionaryApis.com/platedecoder?key=<VisionaryApis_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 |
|
imageUrl | A stock photo of that general vehicle. (Use Images API for more control) |
|
assembly | Where the vehicle was assembled. |
|
Description | Vehicle description of make, model and trim |
|
RegistrationYear | Year the vehicle's registration. |
|
CarMake | The vehicle make. |
|
CarModel | The model of the vehicle. |
|
BodyStyle | The specific vehicle body style |
|
EngineSize | The vehicle's engine size. |
|
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.VisionaryApis.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.VisionaryApis.com/images?
Vehicle Image Parameters
key
Required
Your VisionaryApis 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.VisionaryApis.com/images?
Vehicle Images Search Example
GET http://api.VisionaryApis.com/images?key=<VisionaryApis_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. |
|
success | Whether images have been retrieved. |
|
error | String detailing error if any. |
|
query | Object detailing the query you made. |
|
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.VisionaryApis.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.VisionaryApis.com/whatcaristhat?
What Car Is That? API Parameters
key
Required
Your VisionaryApis key
body
Required
POST body that's a URL to an image or the base64 string of the image.
POST http://api.VisionaryApis.com/whatcaristhat?
What Car Is That? API Search Example
POST /whatcaristhat?key=<VisionaryApis_API_Key> HTTP/1.1
Host: http://api.VisionaryApis.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. |
|
success | Whether the algorithm has been able to successfully analyze the image. |
|
message | String detailing error if any. |
|
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.VisionaryApis.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.VisionaryApis.com/platerecognition
What Car Is That? API Parameters
key
Required
Your VisionaryApis 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.VisionaryApis.com/img/apis/plate_recognition.JPG)
POST http://api.VisionaryApis.com/platerecognition
Plate Recognition API Example
POST curl --location --request POST \
'https://api.VisionaryApis.com/platerecognition?key=<VisionaryApis_API_Key>' \
--form 'upload_url="https://api.VisionaryApis.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. |
|
success | Whether the algorithm has been able to successfully analyze the image. |
|
message | String detailing error if any. |
|
processing_time | How much time it took to proces the image. |
|
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.VisionaryApis.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.VisionaryApis.com/obdcodesdecoder?
OBD Codes Decoder Parameters
key
Required
Your VisionaryApis key
code
Required
The OBD code.
GET http://api.VisionaryApis.com/obdcodesdecoder?
OBD Codes Decoder Search Example
GET http://api.VisionaryApis.com/obdcodesdecoder?key=<VisionaryApis_API_Key>&code=P0115
OBD Codes Decoder Response
Parameters | Description | Example |
---|---|---|
code | The OBD Code |
|
success | Whether market value data has been retrieved |
|
diagnosis | The diagnosis of the OBD code. |
|
date | The date of the search |
|