@shaggytools/nhtsa-api-wrapper
Version:
Universal javascript wrapper for the NHTSA.dot.gov VPIC 'vehicles' API, useful for VIN decoding, etc.
197 lines • 6.52 kB
TypeScript
/**
* @module api/endpoints/DecodeVinValuesBatch
* @category API Endpoints
*/
import type { NhtsaResponse } from '../../types';
/**
* ::: tip :bulb: More Information
* See: [DecodeVinValuesBatch Documentation](/api/endpoints/decode-vin-values-batch)
* :::
*
* `DecodeVinValuesBatch` decodes a batch of Vehicle Identification Numbers (VINs) and returns
* useful information about the vehicles in in a _flat format_. This means the endpoint will return
* an array with multiple objects of results. Each object represents a VIN from the `inputString`
* and the key:value pairs in the objects are variables and their values for each particular VIN.
*
* For this particular API you just have to provide a string of VINs, `inputString`, that are
* separated by a `;`. You can also indicate the model year after the vin, preceded by a `,`.
*
* The `inputString` parameter should be in the following format:
* - ex: `5UXWX7C5*BA, 2011; 5YJSA3DS*EF`
* - no modelYear: `vin; vin; vin`
* - with modelYear: `vin, modelYear; vin, modelYear; vin, modelYear`
* - mix of with/without modelYear: `vin; vin, modelYear`
* - _vin_ and _modelYear_ are placeholders for real values in these examples
* - all spaces between `;` and `,` are used in these examples for readability and are optional
* - _Max 50 VINs per batch_
*
* Providing the modelYear in the input string allows for the decoding to specifically be done in
* the current, or older (pre-1980), model year ranges. It is recommended to always provide
* the model year if it is known at the time of decoding, but it is not required.
*
* @param {string} inputString - A string of Vehicle Identification Numbers (full or partial)
* following the format listed in the description
* @param {boolean} [doFetch=true] - Whether to fetch the data or just return the URL
* (default: `true`)
* @returns {(Promise<NhtsaResponse<DecodeVinValuesBatchResults> | string>)} - Api Response `object`
* -or- url `string` if `doFetch = false`
*/
declare function DecodeVinValuesBatch(inputString: string, doFetch?: true): Promise<NhtsaResponse<DecodeVinValuesBatchResults>>;
declare function DecodeVinValuesBatch(inputString: string, doFetch: false): Promise<string>;
export { DecodeVinValuesBatch };
/**
* Objects found in the `Results` array of `DecodeVinValuesBatch` endpoint response.
*/
export type DecodeVinValuesBatchResults = {
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;
BlindSpotIntervention: 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;
LaneCenteringAssistance: string;
LaneDepartureWarning: string;
LaneKeepSystem: string;
LowerBeamHeadlampLightSource: string;
Make: string;
MakeID: string;
Manufacturer: string;
ManufacturerId: string;
Model: string;
ModelID: string;
ModelYear: string;
MotorcycleChassisType: string;
MotorcycleSuspensionType: string;
NCSABodyType: string;
NCSAMake: string;
NCSAMapExcApprovedBy: string;
NCSAMapExcApprovedOn: string;
NCSAMappingException: string;
NCSAModel: string;
NCSANote: string;
NonLandUse: 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;
RearAutomaticEmergencyBraking: 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;
VehicleDescriptor: string;
VehicleType: string;
WheelBaseLong: string;
WheelBaseShort: string;
WheelBaseType: string;
WheelSizeFront: string;
WheelSizeRear: string;
Wheels: string;
Windows: string;
};
//# sourceMappingURL=DecodeVinValuesBatch.d.ts.map