@shaggytools/nhtsa-api-wrapper

---

Javascript Wrapper and Helper Functions for the NHTSA VPIC API

A universal (browser/server) javascript wrapper for the National Highway Traffic
Safety Administration (NHTSA) Vehicle Information API (VPIC).

The VPIC API is primarily used for decoding useful information from a Vehicle Identification Number
(VIN) in the United States and Canada. It can also be used to get all models of a make, to decode
WMIs, get all makes for a certain year, and more.

---

---

Full Documentation

$3

- Introduction
- Install
- Node Quick Start
- Browser Quick Start
- API Reference

Node Install

$3

``sh [npm]
$ npm install @shaggytools/nhtsa-api-wrapper
`

$3

`sh [yarn]
$ yarn add @shaggytools/nhtsa-api-wrapper
`

$3

`sh [pnpm]
$ pnpm add @shaggytools/nhtsa-api-wrapper
`

Node Quick Start

Decoding a VIN is as easy as importing the DecodeVinValues function and calling it
with a VIN.

Make sure to first install via your favorite package manager or use a CDN.

`javascript
import { DecodeVinValues } from '@shaggytools/nhtsa-api-wrapper'

const results = await DecodeVinValues('WA1A4AFY2J2008189')

/*
results = {
Count: 136, - number of Results objects returned
Message: 'Results returned successfully ...',
SearchCriteria: 'VIN:WA1A4AFY2J2008189',
Results: [ {...} ] - an array with single object of type DecodeVinValuesResults
}
*/

/ You can also use destructuring to get the Results object /
const { Results } = await DecodeVinValues('WA1A4AFY2J2008189')

/* This endpoint only returns a single object in the Results array
The first object in the array is the decoded VIN data */
const decodedVehicle = Results[0] // equals an object of type DecodeVinValuesResults
`

For a full example response see: DecodeVinValues

All available endpoints can be found here: VPIC API Endpoints

Browser Install

You can use the package directly in html script tags using a CDN. There are several options for CDN
providers.

For targeting modern browsers, you can use the ESM versions with

`

#### IIFE:

_~ 4kB (auto minified)_

IIFE browser global variable: NHTSA

`html







src="https://cdn.jsdelivr.net/npm/@shaggytools/nhtsa-api-wrapper"
>



>Click to use DecodeVinValues() >


Results:





`

List of Exported Functions

`javascript
import {
// NHTSA API Endpoints
DecodeVin,
DecodeVinExtended,
DecodeVinValues,
DecodeVinValuesBatch,
DecodeVinValuesExtended,
DecodeWMI,
GetAllMakes,
GetAllManufacturers,
GetCanadianVehicleSpecifications,
GetEquipmentPlantCodes,
GetMakeForManufacturer,
GetMakesForManufacturerAndYear,
GetMakesForVehicleType,
GetManufacturerDetails,
GetModelsForMake,
GetModelsForMakeId,
GetModelsForMakeIdYear,
GetModelsForMakeYear,
GetParts,
GetVehicleTypesForMake,
GetVehicleTypesForMakeId,
GetVehicleVariableList,
GetVehicleVariableValuesList,
GetWMIsForManufacturer,
// composable function returning helper functions for NHTSA API
useNHTSA,
// function for offline VIN validation
isValidVin,
} from '@shaggytools/nhtsa-api-wrapper'
``