Skip to content
On this page

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

Module: api/endpoints/DecodeVinValuesExtended

Table of contents

Type Aliases

Functions

Type Aliases

DecodeVinValuesExtendedResults

Ƭ DecodeVinValuesExtendedResults: Object

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

Type declaration

NameType
ABSstring
ActiveSafetySysNotestring
AdaptiveCruiseControlstring
AdaptiveDrivingBeamstring
AdaptiveHeadlightsstring
AdditionalErrorTextstring
AirBagLocCurtainstring
AirBagLocFrontstring
AirBagLocKneestring
AirBagLocSeatCushionstring
AirBagLocSidestring
AutoReverseSystemstring
AutomaticPedestrianAlertingSoundstring
AxleConfigurationstring
Axlesstring
BasePricestring
BatteryAstring
BatteryA_tostring
BatteryCellsstring
BatteryInfostring
BatteryKWhstring
BatteryKWh_tostring
BatteryModulesstring
BatteryPacksstring
BatteryTypestring
BatteryVstring
BatteryV_tostring
BedLengthINstring
BedTypestring
BlindSpotInterventionstring
BlindSpotMonstring
BodyCabTypestring
BodyClassstring
BrakeSystemDescstring
BrakeSystemTypestring
BusFloorConfigTypestring
BusLengthstring
BusTypestring
CAN_AACNstring
CIBstring
CashForClunkersstring
ChargerLevelstring
ChargerPowerKWstring
CoolingTypestring
CurbWeightLBstring
CustomMotorcycleTypestring
DaytimeRunningLightstring
DestinationMarketstring
DisplacementCCstring
DisplacementCIstring
DisplacementLstring
Doorsstring
DriveTypestring
DriverAssiststring
DynamicBrakeSupportstring
EDRstring
ESCstring
EVDriveUnitstring
ElectrificationLevelstring
EngineConfigurationstring
EngineCyclesstring
EngineCylindersstring
EngineHPstring
EngineHP_tostring
EngineKWstring
EngineManufacturerstring
EngineModelstring
EntertainmentSystemstring
ErrorCodestring
ErrorTextstring
ForwardCollisionWarningstring
FuelInjectionTypestring
FuelTypePrimarystring
FuelTypeSecondarystring
GCWRstring
GCWR_tostring
GVWRstring
GVWR_tostring
KeylessIgnitionstring
LaneCenteringAssistancestring
LaneDepartureWarningstring
LaneKeepSystemstring
LowerBeamHeadlampLightSourcestring
Makestring
MakeIDstring
Manufacturerstring
ManufacturerIdstring
Modelstring
ModelIDstring
ModelYearstring
MotorcycleChassisTypestring
MotorcycleSuspensionTypestring
NCSABodyTypestring
NCSAMakestring
NCSAMapExcApprovedBystring
NCSAMapExcApprovedOnstring
NCSAMappingExceptionstring
NCSAModelstring
NCSANotestring
NonLandUsestring
Notestring
OtherBusInfostring
OtherEngineInfostring
OtherMotorcycleInfostring
OtherRestraintSystemInfostring
OtherTrailerInfostring
ParkAssiststring
PedestrianAutomaticEmergencyBrakingstring
PlantCitystring
PlantCompanyNamestring
PlantCountrystring
PlantStatestring
PossibleValuesstring
Pretensionerstring
RearAutomaticEmergencyBrakingstring
RearCrossTrafficAlertstring
RearVisibilitySystemstring
SAEAutomationLevelstring
SAEAutomationLevel_tostring
SeatBeltsAllstring
SeatRowsstring
Seatsstring
SemiautomaticHeadlampBeamSwitchingstring
Seriesstring
Series2string
SteeringLocationstring
SuggestedVINstring
TPMSstring
TopSpeedMPHstring
TrackWidthstring
TractionControlstring
TrailerBodyTypestring
TrailerLengthstring
TrailerTypestring
TransmissionSpeedsstring
TransmissionStylestring
Trimstring
Trim2string
Turbostring
VINstring
ValveTrainDesignstring
VehicleDescriptorstring
VehicleTypestring
WheelBaseLongstring
WheelBaseShortstring
WheelBaseTypestring
WheelSizeFrontstring
WheelSizeRearstring
Wheelsstring
Windowsstring

Defined in

api/endpoints/DecodeVinValuesExtended.ts:117

Functions

DecodeVinValuesExtended

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

💡 More Information

See: DecodeVinValuesExtended Documentation

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

NameTypeDescription
vinstringVehicle Identification Number (full or partial)

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

NameType
vinstring
doFetchtrue
_dummy?undefined

Returns

Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

Defined in

api/endpoints/DecodeVinValuesExtended.ts:45

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

Parameters

NameType
vinstring
doFetchfalse
_dummy?undefined

Returns

Promise<string>

Defined in

api/endpoints/DecodeVinValuesExtended.ts:51

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

Parameters

NameType
vinstring
paramsObject
params.modelYear?string | number
doFetchfalse

Returns

Promise<string>

Defined in

api/endpoints/DecodeVinValuesExtended.ts:57

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

Parameters

NameType
vinstring
params?Object
params.modelYear?string | number
doFetch?true

Returns

Promise<NhtsaResponse<DecodeVinValuesExtendedResults>>

Defined in

api/endpoints/DecodeVinValuesExtended.ts:63

Released under the MIT License.