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

Module: api/endpoints/DecodeVinValues ​

Table of contents ​

Type Aliases ​

• DecodeVinValuesParams
• DecodeVinValuesResults

Functions ​

• DecodeVinValues

Type Aliases ​

DecodeVinValuesParams ​

Ƭ DecodeVinValuesParams: Object

Query String Parameters for this endpoint

Type declaration ​

Defined in ​

api/endpoints/DecodeVinValues.ts:111

DecodeVinValuesResults ​

Ƭ DecodeVinValuesResults: Object

Single object found in the Results array of DecodeVinValues endpoint response.

Type declaration ​

Defined in ​

api/endpoints/DecodeVinValues.ts:118

Functions ​

DecodeVinValues ​

▸ DecodeVinValues(vin): Promise<NhtsaResponse<DecodeVinValuesResults>>

DecodeVinValues decodes a Vehicle Identification Number (VIN) and returns useful information about the vehicle in in a flat format. This means the endpoint will return an array with a single object of results. Each key in the object is the name of a variable.

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<DecodeVinValuesResults>>

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

Defined in ​

api/endpoints/DecodeVinValues.ts:37

▸ DecodeVinValues(vin, doFetch, _dummy?): Promise<NhtsaResponse<DecodeVinValuesResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinValuesResults>>

Defined in ​

api/endpoints/DecodeVinValues.ts:41

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

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVinValues.ts:47

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

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVinValues.ts:53

▸ DecodeVinValues(vin, params?, doFetch?): Promise<NhtsaResponse<DecodeVinValuesResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinValuesResults>>

Defined in ​

api/endpoints/DecodeVinValues.ts:59