BULK ACCESS: Extended API Documentation

Bulk Access

Affiliates and Resellers

API Subscribers

Data APIs

Vehicle History API

Vehicle Specifications API

Vehicle Market Value API

Vehicle Ownership Cost API

Data Widgets

VIN Check Widget

Market Value Widget

Ownership Cost Widget

This page provides an extended list of services available in the main API:

Retrieve raw data for a VIN Report
Retrieve a PDF for a VIN Report

Please note that most of this functionality is already encapsulated in the main API, so we recommend reviewing the extended API only if the main API does not suit your purpose.

Retrieve raw data for a VIN Report

Documentation

To query whether data for a VIN exists, request:

https://api.vinaudit.com/v2/report.php?

With GET or POST parameters:

Parameter	Description	Required	Example
id	The report id	Yes	182896361699
key	YourVinAudit.com API key	Yes	VA_DEMO_KEY
format	Response format(json, pdf, or xml)	Yes	json
type	Set to (USA or CAN); requires format=pdf	(optional)	CAN
brand	Set to 0 to produce unbranded PDF; requires format=pdf	(optional)	1
lang	Set to language code (en, es) for translated PDF; requires format=pdf	(optional)	en
skipspec	Set “1” if specs aren’t needed	(optional)	1
mode	Set to “test” for development	(optional)	test
callback	Javascript callback method	(optional)

Response attributes:

Parameter	Description	Example
id	The report identifier
vin	The vehicle identification number	1NXBR32E85Z505904
specs	A dynamic map of available vehicle specifications
jsi	An list of Junk/Salvage/Insurance records, each with attributes: date: The brand date recordType: The type of record. branderName: The brander’s name. branderCity: The brander’s city. branderState: The brander’s state. branderEmail: The brander’s email. branderPhone: The brander’s phone. vehicleDisposition: The vehicle’s reported disposition. intendedForExport: Whether the vehicle is intended for export.
checks	An list of brand records with the format: date: The title brand date. brandCode: The brand code branderType: The brander’s type branderName: The brander’s namedisposition: The vehicle’s reported disposition
titles	An list of title records with the format: date: The title record datestate: The 2-letter code for the issuing vin: The recorded VIN (may be old VIN) meter: The odometer reading meterUnit: ‘M’ for miles, ‘K’ for kilometers current: Whether the title record is current, not historical
success	Whether the report has been generated	true
error	One of: expired report missing_report or blank if no error	expired report
error_message	One of: Report not initialized. Please request a new one. Report expired. Please request a new one. or blank if no error	Report expired. Please request a new one.

Examples

Example #1. (successful request)

Request:

https://api.vinaudit.com/v2/report.php?id=94132583912&format=json

Response:

{"success":true,"error":"","id":"31919508431","vin":"1VXBR12EXCP901213","date":"2011-12-21 21:12:15 PST","specs":{"Vin":"1VXBR12EXCP901213","Year":"2005","Make":"Toyota","Model":"Corolla","Trim":"CE","Engine":"1.8L L4 DOHC 16V","Style":"SEDAN 4-DR","Made In":"UNITED STATES","Steering Type":"R&P","Anti-Brake System":"4-Wheel ABS","Tank Size":"13.20 gallon","Overall Height":"58.50 in.","Overall Length":"178.30 in.","Overall Width":"66.90 in.","Standard Seating":"5","Optional Seating":"No data","Highway Mileage":"38 - 41 miles\/gallon","City Mileage":"30 - 32 miles\/gallon"},"jsi":[{'date': '10/25/2007','recordType':'Junk And Salvage','branderName':'Insurance Salvage, Inc.','branderCity':'Milwalkee','branderState':'WI','branderEmail':'','branderPhone': '5556478921','vehicleDisposition':'Sold','intendedForExport':'No'}],"checks":[ {'brandCode': '11', 'branderType': 'State', 'branderName': 'Ohio', 'disposition': 'Salvage', 'date': '08/02/2005' }, {'brandCode': '09', 'branderType': 'State', 'branderCode': '', 'branderName': 'Ohio', 'disposition': 'Rebuilt', 'date': '08/19/2005' } ],"titles": [ {'date': '08/31/2011', 'state':'WA', 'vin':'', 'meter':'59,396', 'meterUnit':'M', 'current': true}, {'date': '02/23/2008', 'state':'WI', 'vin':'1VXBR12EXCP901213', 'meter':'37,398', 'meterUnit':'M', 'current': false}, {'date': '11/04/2007', 'state':'WI', 'vin':'1VXBR12EXCP901213', 'meter':'12,269', 'meterUnit':'M', 'current': false}, {'date': '08/19/2005', 'state':'OH', 'vin':'1VXBR12EXCP153842', 'meter':'3,220', 'meterUnit':'M', 'current': false}, {'date': '06/22/2005', 'state':'OH', 'vin':'1VXBR12EXCP153842', 'meter':'', 'meterUnit':'M', 'current': false} ]}

Example #1. (unsuccessful request)

Request:

https://api.vinaudit.com/v2/report.php?id=194132583912&format=json

Response:

{"success":false,"error":"not_initialized"}

Source Code

BULK ACCESS: Extended API Documentation

Retrieve raw data for a VIN Report

Example #1. (successful request)

Example #1. (unsuccessful request)

The most comprehensive Automotive Data & Analytics

SERVICES

RESOURCES

CUSTOMERS

ABOUT US

, Inc.

Testing page

BULK ACCESS: Extended API Documentation

Retrieve raw data for a VIN Report

The most comprehensive Automotive Data & Analytics

SERVICES

RESOURCES

CUSTOMERS

ABOUT US

, Inc.