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

Module: api/endpoints/DecodeVinValuesBatch ​

Table of contents ​

Type Aliases ​

• DecodeVinValuesBatchResults

Functions ​

• DecodeVinValuesBatch

Type Aliases ​

DecodeVinValuesBatchResults ​

Ƭ DecodeVinValuesBatchResults: Object

Objects found in the Results array of DecodeVinValuesBatch endpoint response.

Type declaration ​

Defined in ​

api/endpoints/DecodeVinValuesBatch.ts:90

Functions ​

DecodeVinValuesBatch ​

▸ DecodeVinValuesBatch(inputString, doFetch?): Promise<NhtsaResponse<DecodeVinValuesBatchResults>>

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.

Parameters ​

Returns ​

Promise<NhtsaResponse<DecodeVinValuesBatchResults>>

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

Defined in ​

api/endpoints/DecodeVinValuesBatch.ts:43

▸ DecodeVinValuesBatch(inputString, doFetch): Promise<string>

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeVinValuesBatch.ts:48