@shaggytools/nhtsa-api-wrapper / Exports / api/endpoints/DecodeVinValuesExtended

Module: api/endpoints/DecodeVinValuesExtended ​

Table of contents ​

Functions ​

• DecodeVinValuesExtended

Type Aliases ​

• DecodeVinValuesExtendedResults

Functions ​

DecodeVinValuesExtended ​

▸ DecodeVinValuesExtended(vin): Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

DecodeVinValuesExtended 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.

This endpoint is similar to DecodeVinValues but returns additional information on variables related to other NHTSA programs like NCSA, etc.

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

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

Defined in ​

api/endpoints/DecodeVinValuesExtended.ts:41

▸ DecodeVinValuesExtended(vin, doFetch, _dummy?): Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

Defined in ​

api/endpoints/DecodeVinValuesExtended.ts:45

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

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVinValuesExtended.ts:51

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

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVinValuesExtended.ts:57

▸ DecodeVinValuesExtended(vin, params?, doFetch?): Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

Defined in ​

api/endpoints/DecodeVinValuesExtended.ts:63

Type Aliases ​

DecodeVinValuesExtendedResults ​

Ƭ DecodeVinValuesExtendedResults: Object

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

Type declaration ​

Defined in ​

api/endpoints/DecodeVinValuesExtended.ts:117