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

Class

GetCanadianVehicleSpecifications

api/actions/GetCanadianVehicleSpecifications.GetCanadianVehicleSpecifications(userConfigopt)

Implemented by NHTSA.

Extends api/Fetch.Fetch.

Constructor

# new GetCanadianVehicleSpecifications(userConfigopt)

Parameters:
Name Type Attributes Description
userConfig FetchConfig <optional>

User configuration options to construct the class with.

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

Methods

# async GetCanadianVehicleSpecifications(params) → {Promise.<GetCanadianVehicleSpecificationsResponse>}

The Canadian Vehicle Specifications (CVS) consists of a database of original vehicle dimensions, used primarily in collision investigation and reconstruction, combined with a search engine.

The database is compiled annually by the Collision Investigation and Research Division of Transport Canada. Visit official Canadian Vehicle Specifications page for more details.

This API action will return a 404 html error if any of the query parameters in params are missing from the query string. This is the only API action with this behaviour. Therefore, parameters are inserted into the query string as empty strings if not provided by the user.

Parameters:
Name Type Attributes Description
params object

Query Search Parameters to append to the URL.

year number

Model year of the vehicle (required) - Number, >= 1971.

make string <optional>

Vehicle's make, like "Honda", "Toyota", etc...

model string <optional>

Vehicle's model, like "Pilot", "Focus". Can also include some other elements like Body Type, Engine Model/size, etc...

units string <optional>

"Metric" (default), or "US" for United States customary units.

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

Api Response object.