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

Class

GetModelsForMakeYear

api/actions/GetModelsForMakeYear.GetModelsForMakeYear(userConfigopt)

Implemented by NHTSA.

Extends api/Fetch.Fetch.

Constructor

# new GetModelsForMakeYear(userConfigopt)

Parameters:
Name Type Attributes Description
userConfig FetchConfig <optional>

User configuration options to construct the class with.

View Source api/actions/GetModelsForMakeYear.ts, line 27

Methods

# async GetModelsForMakeYear(params) → {Promise.<GetModelsForMakeYearResponse>}

This returns the Models in the vPIC dataset for a specified Model Year and Make whose name is LIKE the Make in the vPIC Dataset.

  • params.make is required. It can be a partial, or a full name for more specificity (e.g., "Harley", "Harley Davidson", etc.).

A minimum of one of the following are required (or a combination of both):

  • params.modelYear is a number (greater than 1995)
  • params.vehicleType can be a partial name, or a full name for more specificity (e.g., "Vehicle", "Moto", "Low Speed Vehicle", etc.).
Parameters:
Name Type Attributes Description
params object

Query Search Parameters to append to the URL.

make string

Make name to search.

modelYear number <optional>

A number representing the model year to search (greater than 1995).

vehicleType string <optional>

String representing the vehicle type to search.

View Source api/actions/GetModelsForMakeYear.ts, line 51

Api Response object.