Skip to content
On this page

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

Module: api/endpoints/DecodeWMI ​

Table of contents ​

Type Aliases ​

Functions ​

Type Aliases ​

DecodeWMIResults ​

Ƭ DecodeWMIResults: Object

Objects found in the Results array of DecodeWMI endpoint response.

Type declaration ​

NameType
CommonNamestring
CreatedOnstring
DateAvailableToPublicstring
Makestring
ManufacturerNamestring
ParentCompanyNamestring
URLstring
UpdatedOnstring | null
VehicleTypestring

Defined in ​

api/endpoints/DecodeWMI.ts:76

Functions ​

DecodeWMI ​

▸ DecodeWMI(WMI, doFetch?): Promise<NhtsaResponse<DecodeWMIResults>>

💡 More Information

See: DecodeWMI Documentation

DecodeWMI provides information on the World Manufacturer Identifier for a specific WMI code.

WMI may be provided as either 3 characters representing VIN position 1-3 or 6 characters representing VIN positions 1-3 & 12-14.

  • Examples: "JTD" "1T9131"

A list of WMI codes can be found here, but keep in mind that not all of the listed WMIs are registered with NHTSA and therefore may not be available in VPIC data sets.

Parameters ​

NameTypeDescription
WMIstringWorld Manufacturer Identifier
doFetch?trueWhether to fetch the data or just return the URL (default: true)

Returns ​

Promise<NhtsaResponse<DecodeWMIResults>>

  • Api Response object -or- url string if doFetch = false (default: true)

Defined in ​

api/endpoints/DecodeWMI.ts:32

▸ DecodeWMI(WMI, doFetch): Promise<string>

Parameters ​

NameType
WMIstring
doFetchfalse

Returns ​

Promise<string>

Defined in ​

api/endpoints/DecodeWMI.ts:37

Released under the MIT License.