Important: This documentation applies to v2 of this package.
For v3 docs see vpic.shaggytech.com
API Documentation

Module

api/actions/GetMakesForManufacturerAndYear

GetMakesForManufacturerAndYear NHSTA Api Action.

Module Exports:

Types

View Source api/actions/GetMakesForManufacturerAndYear.ts, line 2

Classes

GetMakesForManufacturerAndYear

Type Definitions

object

# GetMakesForManufacturerAndYearResponse

Type representing the complete response returned by the GetMakesForManufacturerAndYear API Action.

Properties:
Name Type Description
Count number

A count of the items returned in the Results array.
Message string

A message describing the Results array.
SearchCriteria string

Search terms (VIN, WMI, manufacturer, etc.) used in the request URL.
Results Array.<GetMakesForManufacturerAndYearResults>

The search results returned by the NHSTA API request.
FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/GetMakesForManufacturerAndYear.ts, line 91

object

# GetMakesForManufacturerAndYearResults

Type representing the structure of objects found in the 'GetMakesForManufacturerAndYearResponse.Results' array.

Properties:
Name Type Description
MakeId number
MakeName string
MfrId number
MfrName string

View Source api/actions/GetMakesForManufacturerAndYear.ts, line 80