@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/endpoints/DecodeVin

Module: api/endpoints/DecodeVin ​

Table of contents ​

Type Aliases ​

• DecodeVinResults
• DecodeVinVariable

Functions ​

• DecodeVin

Type Aliases ​

DecodeVinResults ​

Ƭ DecodeVinResults: Object

Objects in the Results array of DecodeVin endpoint response.

Type declaration ​

Defined in ​

api/endpoints/DecodeVin.ts:110

DecodeVinVariable ​

Ƭ DecodeVinVariable: "Suggested VIN" | "Error Code" | "Possible Values" | "Additional Error Text" | "Error Text" | "Vehicle Descriptor" | "Destination Market" | "Make" | "Manufacturer Name" | "Model" | "Model Year" | "Plant City" | "Series" | "Trim" | "Vehicle Type" | "Plant Country" | "Plant Company Name" | "Plant State" | "Trim2" | "Series2" | "Note" | "Base Price ($)" | "Non-Land Use" | "Body Class" | "Doors" | "Windows" | "Wheel Base Type" | "Track Width (inches)" | "Gross Vehicle Weight Rating From" | "Bed Length (inches)" | "Curb Weight (pounds)" | "Wheel Base (inches) From" | "Wheel Base (inches) To" | "Gross Combination Weight Rating From" | "Gross Combination Weight Rating To" | "Gross Vehicle Weight Rating To" | "Bed Type" | "Cab Type" | "Trailer Type Connection" | "Trailer Body Type" | "Trailer Length (feet)" | "Other Trailer Info" | "Number of Wheels" | "Wheel Size Front (inches)" | "Wheel Size Rear (inches)" | "Entertainment System" | "Steering Location" | "Number of Seats" | "Number of Seat Rows" | "Transmission Style" | "Transmission Speeds" | "Drive Type" | "Axles" | "Axle Configuration" | "Brake System Type" | "Brake System Description" | "Other Battery Info" | "Battery Type" | "Number of Battery Cells per Module" | "Battery Current (Amps) From" | "Battery Voltage (Volts) From" | "Battery Energy (kWh) From" | "EV Drive Unit" | "Battery Current (Amps) To" | "Battery Voltage (Volts) To" | "Battery Energy (kWh) To" | "Number of Battery Modules per Pack" | "Number of Battery Packs per Vehicle" | "Charger Level" | "Charger Power (kW)" | "Engine Number of Cylinders" | "Displacement (CC)" | "Displacement (CI)" | "Displacement (L)" | "Engine Stroke Cycles" | "Engine Model" | "Engine Power (kW)" | "Fuel Type - Primary" | "Valve Train Design" | "Engine Configuration" | "Fuel Type - Secondary" | "Fuel Delivery / Fuel Injection Type" | "Engine Brake (hp) From" | "Cooling Type" | "Engine Brake (hp) To" | "Electrification Level" | "Other Engine Info" | "Turbo" | "Top Speed (MPH)" | "Engine Manufacturer" | "Pretensioner" | "Seat Belt Type" | "Other Restraint System Info" | "Curtain Air Bag Locations" | "Seat Cushion Air Bag Locations" | "Front Air Bag Locations" | "Knee Air Bag Locations" | "Side Air Bag Locations" | "Anti-lock Braking System (ABS)" | "Electronic Stability Control (ESC)" | "Traction Control" | "Tire Pressure Monitoring System (TPMS) Type" | "Active Safety System Note" | "Auto-Reverse System for Windows and Sunroofs" | "Automatic Pedestrian Alerting Sound (for Hybrid and EV only)" | "Event Data Recorder (EDR)" | "Keyless Ignition" | "SAE Automation Level From" | "SAE Automation Level To" | "Adaptive Cruise Control (ACC)" | "Crash Imminent Braking (CIB)" | "Blind Spot Warning (BSW)" | "Forward Collision Warning (FCW)" | "Lane Departure Warning (LDW)" | "Lane Keeping Assistance (LKA)" | "Backup Camera" | "Parking Assist" | "Bus Length (feet)" | "Bus Floor Configuration Type" | "Bus Type" | "Other Bus Info" | "Custom Motorcycle Type" | "Motorcycle Suspension Type" | "Motorcycle Chassis Type" | "Other Motorcycle Info" | "Dynamic Brake Support (DBS)" | "Pedestrian Automatic Emergency Braking (PAEB)" | "Automatic Crash Notification (ACN) / Advanced Automatic Crash Notification (AACN)" | "Daytime Running Light (DRL)" | "Headlamp Light Source" | "Semiautomatic Headlamp Beam Switching" | "Adaptive Driving Beam (ADB)" | "Rear Cross Traffic Alert" | "Rear Automatic Emergency Braking" | "Blind Spot Intervention (BSI)" | "Lane Centering Assistance" | string & Record<string, never>

Possible DecodeVinResults.Variable values for DecodeVin endpoint.

This type is here to provide a list of possible values manually extracted from an actual API response. There are some things to note:

• Names are ordered to mirror actual API response order.
• Names have been known to change slightly or be added/removed.
• Some listed here could be missing from the API response.
• There may be more actual values than listed here.

Last Updated: 02/14/2023

Defined in ​

api/endpoints/DecodeVin.ts:129

Functions ​

DecodeVin ​

▸ DecodeVin(vin): Promise<NhtsaResponse<DecodeVinResults>>

DecodeVin decodes a Vehicle Identification Number (VIN) and returns useful information about the vehicle.

Providing params.modelYear allows for the decoding to specifically be done in the current, or older (pre-1980), model year ranges. It is recommended to always provide params.modelYear if the model year is known at the time of decoding, but it is not required.

This endpoint also supports partial VIN decoding (VINs that are less than 17 characters).

• Ex: 5UXWX7C5*BA
• In this case, the VIN will be decoded partially with the available characters
• In case of partial VINs, a * could be used to indicate the unavailable characters
• The 9th digit is not necessary

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinResults>>

• Api Response object -or- url string if doFetch = false

Defined in ​

api/endpoints/DecodeVin.ts:36

▸ DecodeVin(vin, doFetch, _dummy?): Promise<NhtsaResponse<DecodeVinResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinResults>>

Defined in ​

api/endpoints/DecodeVin.ts:38

▸ DecodeVin(vin, doFetch, _dummy?): Promise<string>

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVin.ts:44

▸ DecodeVin(vin, params, doFetch): Promise<string>

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVin.ts:50

▸ DecodeVin(vin, params?, doFetch?): Promise<NhtsaResponse<DecodeVinResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinResults>>

Defined in ​

api/endpoints/DecodeVin.ts:56