Important: This documentation applies to v2 of this package.
For v3 docs see vpic.shaggytech.com

Class

DecodeVinValuesExtended

api/actions/DecodeVinValuesExtended.DecodeVinValuesExtended(userConfigopt)

Implemented by NHTSA.

Extends api/Fetch.Fetch.

Constructor

# new DecodeVinValuesExtended(userConfigopt)

Parameters:
Name Type Attributes Description
userConfig FetchConfig <optional>

User configuration options to construct the class with.

View Source api/actions/DecodeVinValuesExtended.ts, line 27

Methods

# async DecodeVinValuesExtended(vin, paramsopt) → {Promise.<DecodeVinValuesExtendedResponse>}

This is exactly like the DecodeVinValues (flat format Results) method but provides additional information on variables related to other NHTSA programs like NCSA, etc.

  • The Results will be made available in a flat file format of a single object containing 'key: value' results.
  • 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.
  • This Action also supports partial VIN decoding (VINs that are less than 17 characters).
    • 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.
Parameters:
Name Type Attributes Default Description
vin string

Vehicle Identification Number (full or partial).

params object <optional>
{}

Query Search Parameters to append to the URL.

modelYear string | number <optional>

Optional Model Year search parameter.

View Source api/actions/DecodeVinValuesExtended.ts, line 51

Api Response object.