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

Module

api/actions/GetCanadianVehicleSpecifications

GetCanadianVehicleSpecifications NHSTA Api Action.

Module Exports:

Types

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

Classes

GetCanadianVehicleSpecifications

Type Definitions

object

# GetCanadianVehicleSpecificationsResponse

Type representing the complete response returned by the GetCanadianVehicleSpecifications 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.<GetCanadianVehicleSpecificationsResults>

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

Fetch API Response properties.

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

object

# GetCanadianVehicleSpecificationsResults

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

Properties:
Name Type Description
Specs Array.<object>
Specs[].Name string
Specs[].Value string

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