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

Module

api/actions/DecodeVINValuesBatch

DecodeVINValuesBatch NHSTA Api Action.

Module Exports:

Types

View Source api/actions/DecodeVINValuesBatch.ts, line 2

Classes

DecodeVINValuesBatch

Type Definitions

object

# DecodeVINValuesBatchResponse

Type representing the complete response returned by the DecodeVINValuesBatch API Action.

Properties:
Name Type Description
Count number

A count of the items returned in the Results array.
Message string

A message describing the Results array.
SearchCriteria string

Search terms (VIN, WMI, manufacturer, etc.) used in the request URL.
Results Array.<DecodeVINValuesBatchResults>

The search results returned by the NHSTA API request.
FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/DecodeVINValuesBatch.ts, line 219

object

# DecodeVINValuesBatchResults

Type representing the structure of objects found in the 'DecodeVINValuesBatchResponse.Results' array.

Properties:
Name Type Description
ABS string
ActiveSafetySysNote string
AdaptiveCruiseControl string
AdaptiveDrivingBeam string
AdaptiveHeadlights string
AdditionalErrorText string
AirBagLocCurtain string
AirBagLocFront string
AirBagLocKnee string
AirBagLocSeatCushion string
AirBagLocSide string
AutoReverseSystem string
AutomaticPedestrianAlertingSound string
AxleConfiguration string
Axles string
BasePrice string
BatteryA string
BatteryA_to string
BatteryCells string
BatteryInfo string
BatteryKWh string
BatteryKWh_to string
BatteryModules string
BatteryPacks string
BatteryType string
BatteryV string
BatteryV_to string
BedLengthIN string
BedType string
BlindSpotMon string
BodyCabType string
BodyClass string
BrakeSystemDesc string
BrakeSystemType string
BusFloorConfigType string
BusLength string
BusType string
CAN_AACN string
CIB string
CashForClunkers string
ChargerLevel string
ChargerPowerKW string
CoolingType string
CurbWeightLB string
CustomMotorcycleType string
DaytimeRunningLight string
DestinationMarket string
DisplacementCC string
DisplacementCI string
DisplacementL string
Doors string
DriveType string
DriverAssist string
DynamicBrakeSupport string
EDR string
ESC string
EVDriveUnit string
ElectrificationLevel string
EngineConfiguration string
EngineCycles string
EngineCylinders string
EngineHP string
EngineHP_to string
EngineKW string
EngineManufacturer string
EngineModel string
EntertainmentSystem string
ErrorCode string
ErrorText string
ForwardCollisionWarning string
FuelInjectionType string
FuelTypePrimary string
FuelTypeSecondary string
GCWR string
GCWR_to string
GVWR string
GVWR_to string
KeylessIgnition string
LaneDepartureWarning string
LaneKeepSystem string
LowerBeamHeadlampLightSource string
Make string
Manufacturer string
ManufacturerId string
Model string
ModelYear string
MotorcycleChassisType string
MotorcycleSuspensionType string
NCSABodyType string
NCSAMake string
NCSAMapExcApprovedBy string
NCSAMapExcApprovedOn string
NCSAMappingException string
NCSAModel string
NCSANote string
Note string
OtherBusInfo string
OtherEngineInfo string
OtherMotorcycleInfo string
OtherRestraintSystemInfo string
OtherTrailerInfo string
ParkAssist string
PedestrianAutomaticEmergencyBraking string
PlantCity string
PlantCompanyName string
PlantCountry string
PlantState string
PossibleValues string
Pretensioner string
RearCrossTrafficAlert string
RearVisibilitySystem string
SAEAutomationLevel string
SAEAutomationLevel_to string
SeatBeltsAll string
SeatRows string
Seats string
SemiautomaticHeadlampBeamSwitching string
Series string
Series2 string
SteeringLocation string
SuggestedVIN string
TPMS string
TopSpeedMPH string
TrackWidth string
TractionControl string
TrailerBodyType string
TrailerLength string
TrailerType string
TransmissionSpeeds string
TransmissionStyle string
Trim string
Trim2 string
Turbo string
VIN string
ValveTrainDesign string
VehicleType string
WheelBaseLong string
WheelBaseShort string
WheelBaseType string
WheelSizeFront string
WheelSizeRear string
Wheels string
Windows string

View Source api/actions/DecodeVINValuesBatch.ts, line 69