@shaggytools/nhtsa-api-wrapper / Exports / api/endpoints/DecodeWMI
Module: api/endpoints/DecodeWMI
Table of contents
Functions
Type Aliases
Functions
DecodeWMI
▸ DecodeWMI(WMI, doFetch?): Promise<NhtsaResponse<DecodeWMIResults>>
💡 More Information
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
| Name | Type | Description |
|---|---|---|
WMI | string | World Manufacturer Identifier |
doFetch? | true | Whether to fetch the data or just return the URL (default: true) |
Returns
Promise<NhtsaResponse<DecodeWMIResults>>
- Api Response
object-or- urlstringifdoFetch = false(default:true)
Defined in
▸ DecodeWMI(WMI, doFetch): Promise<string>
Parameters
| Name | Type |
|---|---|
WMI | string |
doFetch | false |
Returns
Promise<string>
Defined in
Type Aliases
DecodeWMIResults
Ƭ DecodeWMIResults: Object
Objects found in the Results array of DecodeWMI endpoint response.
Type declaration
| Name | Type |
|---|---|
CommonName | string |
CreatedOn | string |
DateAvailableToPublic | string |
Make | string |
ManufacturerName | string |
ParentCompanyName | string |
URL | string |
UpdatedOn | string | null |
VehicleType | string |