GetCanadianVehicleSpecifications
typescript
async function GetCanadianVehicleSpecifications(
params: {
year: string | number
make?: string
model?: string
units?: string
},
doFetch?: boolean
): Promise<NhtsaResponse<GetCanadianVehicleSpecificationsResults> | string>💡 More In Depth
See: Package Reference
Description
GetCanadianVehicleSpecifications returns data from the Canadian Vehicle Specifications (CVS). The CVS consists of a database of original vehicle dimensions, used primarily in collision investigation and reconstruction, combined with a search engine.
The CVS database is compiled annually by the Collision Investigation and Research Division of Transport Canada. Visit official Canadian Vehicle Specifications page for more details.
params.year is the only required query parameter, all others are optional but will still be included in the query string as blank values even if not provided by the user. See below Note for more details.
NOTE: This endpoint does not like missing query keys and will return a 404 error if any of them are omitted from the query string. Therefore, we must set default values to empty strings for any query keys that are not provided by the user. This means keys not provided by user will always show up as "something=" in the query string. year is the only key user must provide, no default value is set for it so that an error will be thrown if not provided by user.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
params | Object | undefined | Object of Query Search names and values to append to the URL as a query string |
params.year | string | number | undefined | Model year of the vehicle - year >= 1971 |
params.make? | string | undefined | Vehicle's make, like "Honda", "Toyota", etc... |
params.model? | string | undefined | Vehicle's model, like "Pilot", "Focus". Can also include some other elements like Body Type, Engine Model/size, etc... |
params.units? | string | undefined | "Metric" (default), or "US" for standard units |
doFetch? | boolean | true | Whether to fetch the data or just return the URL (default: true) |
📝 NOTE
Any params that are not listed in the table above will be ignored.
Set doFetch to false if you want to fetch the data yourself.
- See BYOF - Bring Your Own Fetch for more info.
Returns
Returns a Promise that resolves to a NhtsaResponse object containing an array of GetCanadianVehicleSpecificationsResults objects in the Results key.
typescript
=> Promise<NhtsaResponse<GetCanadianVehicleSpecificationsResults>>typescript
type NhtsaResponse<GetCanadianVehicleSpecificationsResults> = {
Count: number
Message: string
Results: Array<GetCanadianVehicleSpecificationsResults>
SearchCriteria: string
}🔍 Click to Show Full Example Response
ts
// Using GetCanadianVehicleSpecifications({ year: 2011, make: Acura })
const exampleResponse = {
Count: 9,
Message: 'Results returned successfully',
Results: [
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'CSX 4DR SEDAN FWD /TECH PACKAGE',
},
{
Name: 'MYR',
Value: '6',
},
{
Name: 'OL',
Value: '454',
},
{
Name: 'OW',
Value: '175',
},
{
Name: 'OH',
Value: '144',
},
{
Name: 'WB',
Value: '270',
},
{
Name: 'CW',
Value: '1300',
},
{
Name: 'A',
Value: '94',
},
{
Name: 'B',
Value: '45',
},
{
Name: 'C',
Value: '36',
},
{
Name: 'D',
Value: '76',
},
{
Name: 'E',
Value: '110',
},
{
Name: 'F',
Value: '92',
},
{
Name: 'G',
Value: '93',
},
{
Name: 'TWF',
Value: '150',
},
{
Name: 'TWR',
Value: '151',
},
{
Name: 'WD',
Value: '61/39',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'MDX 4DR SUV AWD /TECH/ELITE',
},
{
Name: 'MYR',
Value: '10',
},
{
Name: 'OL',
Value: '485',
},
{
Name: 'OW',
Value: '199',
},
{
Name: 'OH',
Value: '173',
},
{
Name: 'WB',
Value: '275',
},
{
Name: 'CW',
Value: '2064',
},
{
Name: 'A',
Value: '117',
},
{
Name: 'B',
Value: '183',
},
{
Name: 'C',
Value: '42',
},
{
Name: 'D',
Value: '85',
},
{
Name: 'E',
Value: '126',
},
{
Name: 'F',
Value: '100',
},
{
Name: 'G',
Value: '110',
},
{
Name: 'TWF',
Value: '172',
},
{
Name: 'TWR',
Value: '172',
},
{
Name: 'WD',
Value: '56/44',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'RDX 4DR SUV AWD /TECH PACKAGE',
},
{
Name: 'MYR',
Value: '10',
},
{
Name: 'OL',
Value: '462',
},
{
Name: 'OW',
Value: '187',
},
{
Name: 'OH',
Value: '166',
},
{
Name: 'WB',
Value: '265',
},
{
Name: 'CW',
Value: '1790',
},
{
Name: 'A',
Value: '125',
},
{
Name: 'B',
Value: '152',
},
{
Name: 'C',
Value: '38',
},
{
Name: 'D',
Value: '84',
},
{
Name: 'E',
Value: '124',
},
{
Name: 'F',
Value: '98',
},
{
Name: 'G',
Value: '99',
},
{
Name: 'TWF',
Value: '158',
},
{
Name: 'TWR',
Value: '159',
},
{
Name: 'WD',
Value: '57/43',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'RL 4DR SEDAN AWD /ELITE',
},
{
Name: 'MYR',
Value: '9',
},
{
Name: 'OL',
Value: '497',
},
{
Name: 'OW',
Value: '185',
},
{
Name: 'OH',
Value: '146',
},
{
Name: 'WB',
Value: '280',
},
{
Name: 'CW',
Value: '1864',
},
{
Name: 'A',
Value: '125',
},
{
Name: 'B',
Value: '73',
},
{
Name: 'C',
Value: '37',
},
{
Name: 'D',
Value: '80',
},
{
Name: 'E',
Value: '116',
},
{
Name: 'F',
Value: '104',
},
{
Name: 'G',
Value: '111',
},
{
Name: 'TWF',
Value: '157',
},
{
Name: 'TWR',
Value: '157',
},
{
Name: 'WD',
Value: '58/42',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'TL 4 DR SEDAN FWD/TECHNOLOGY',
},
{
Name: 'MYR',
Value: '9',
},
{
Name: 'OL',
Value: '497',
},
{
Name: 'OW',
Value: '188',
},
{
Name: 'OH',
Value: '145',
},
{
Name: 'WB',
Value: '278',
},
{
Name: 'CW',
Value: '1682',
},
{
Name: 'A',
Value: '134',
},
{
Name: 'B',
Value: '62',
},
{
Name: 'C',
Value: '34',
},
{
Name: 'D',
Value: '81',
},
{
Name: 'E',
Value: '117',
},
{
Name: 'F',
Value: '105',
},
{
Name: 'G',
Value: '115',
},
{
Name: 'TWF',
Value: '160',
},
{
Name: 'TWR',
Value: '161',
},
{
Name: 'WD',
Value: '61/39',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'TL 4 DR SEDAN SH-AWD/SH-AWD TECHNOLOGY',
},
{
Name: 'MYR',
Value: '9',
},
{
Name: 'OL',
Value: '497',
},
{
Name: 'OW',
Value: '188',
},
{
Name: 'OH',
Value: '145',
},
{
Name: 'WB',
Value: '278',
},
{
Name: 'CW',
Value: '1801',
},
{
Name: 'A',
Value: '134',
},
{
Name: 'B',
Value: '62',
},
{
Name: 'C',
Value: '34',
},
{
Name: 'D',
Value: '81',
},
{
Name: 'E',
Value: '117',
},
{
Name: 'F',
Value: '105',
},
{
Name: 'G',
Value: '115',
},
{
Name: 'TWF',
Value: '160',
},
{
Name: 'TWR',
Value: '161',
},
{
Name: 'WD',
Value: '59/41',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'TSX 4DR SEDAN FWD TECH PACKAGE/PREMIUM',
},
{
Name: 'MYR',
Value: '9',
},
{
Name: 'OL',
Value: '473',
},
{
Name: 'OW',
Value: '184',
},
{
Name: 'OH',
Value: '144',
},
{
Name: 'WB',
Value: '271',
},
{
Name: 'CW',
Value: '1545',
},
{
Name: 'A',
Value: '121',
},
{
Name: 'B',
Value: '44',
},
{
Name: 'C',
Value: '35',
},
{
Name: 'D',
Value: '79',
},
{
Name: 'E',
Value: '115',
},
{
Name: 'F',
Value: '97',
},
{
Name: 'G',
Value: '104',
},
{
Name: 'TWF',
Value: '158',
},
{
Name: 'TWR',
Value: '158',
},
{
Name: 'WD',
Value: '60/40',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'TSX 4DR SEDAN FWD V6',
},
{
Name: 'MYR',
Value: '9',
},
{
Name: 'OL',
Value: '473',
},
{
Name: 'OW',
Value: '184',
},
{
Name: 'OH',
Value: '144',
},
{
Name: 'WB',
Value: '271',
},
{
Name: 'CW',
Value: '1672',
},
{
Name: 'A',
Value: '121',
},
{
Name: 'B',
Value: '44',
},
{
Name: 'C',
Value: '35',
},
{
Name: 'D',
Value: '79',
},
{
Name: 'E',
Value: '115',
},
{
Name: 'F',
Value: '97',
},
{
Name: 'G',
Value: '104',
},
{
Name: 'TWF',
Value: '158',
},
{
Name: 'TWR',
Value: '158',
},
{
Name: 'WD',
Value: '60/40',
},
],
},
{
Specs: [
{
Name: 'Make',
Value: 'ACURA',
},
{
Name: 'Model',
Value: 'ZDX 4DR SUV AWD / TECH ELITE',
},
{
Name: 'MYR',
Value: '10',
},
{
Name: 'OL',
Value: '488',
},
{
Name: 'OW',
Value: '199',
},
{
Name: 'OH',
Value: '160',
},
{
Name: 'WB',
Value: '275',
},
{
Name: 'CW',
Value: '2064',
},
{
Name: 'A',
Value: '133',
},
{
Name: 'B',
Value: '109',
},
{
Name: 'C',
Value: '33',
},
{
Name: 'D',
Value: '88',
},
{
Name: 'E',
Value: '120',
},
{
Name: 'F',
Value: '109',
},
{
Name: 'G',
Value: '104',
},
{
Name: 'TWF',
Value: '172',
},
{
Name: 'TWR',
Value: '171',
},
{
Name: 'WD',
Value: '58/42',
},
],
},
],
SearchCriteria: 'Year: 2011; Make: Acura; Units: Metric',
}If doFetch is set to false
Returns a URL string that can be used to fetch the data, does not fetch the data internally.
typescript
=> Promise<string>
// ex: => 'https://vpic.nhtsa.dot.gov/api/vehicles/GetCanadianVehicleSpecifications/?Year=2011&Make=Acura&Model=&units=&format=json'💡 See: BYOF - Bring Your Own Fetch
Type - GetCanadianVehicleSpecificationsResults
ts
type GetCanadianVehicleSpecificationsResults = {
Specs: Array<{
Name:
| 'Make'
| 'Model'
| 'MYR'
| 'OL'
| 'OW'
| 'OH'
| 'WB'
| 'CW'
| 'A'
| 'B'
| 'C'
| 'D'
| 'E'
| 'F'
| 'G'
| 'TWF'
| 'TWR'
| 'WD'
Value: string
}>
}Ƭ GetCanadianVehicleSpecificationsResults: Object
Objects returned in the Results array of GetCanadianVehicleSpecifications endpoint response.
Examples
Examples 1-2:
Fetches data from VPIC API
Returns:
typescript
=> Promise<NhtsaResponse<GetCanadianVehicleSpecificationsResults>>Example 1: Get Results With Only year
ts
import { GetCanadianVehicleSpecifications } from '@shaggytools/nhtsa-api-wrapper'
const response = await GetCanadianVehicleSpecifications({ year: 2015 })Example 2: Get Results With All params
ts
import { GetCanadianVehicleSpecifications } from '@shaggytools/nhtsa-api-wrapper'
const response = await GetCanadianVehicleSpecifications({
year: 2015,
make: 'Audi',
model: 'RS7',
units: 'Metric',
})Examples 3-4:
Does NOT fetch data from VPIC API
Returns:
typescript
=> Promise<string>Example 3: Get Results and doFetch = false
ts
import { GetCanadianVehicleSpecifications } from '@shaggytools/nhtsa-api-wrapper'
const url = await GetCanadianVehicleSpecifications({ year: 2015 }, false)
// url = 'https://vpic.nhtsa.dot.gov/api/vehicles/GetCanadianVehicleSpecifications/?make=&model=&units=&year=2011&format=json'Example 4: Get Results With All params and doFetch = false
ts
import { GetCanadianVehicleSpecifications } from '@shaggytools/nhtsa-api-wrapper'
const url = await GetCanadianVehicleSpecifications(
{ year: 2015, make: 'Audi', model: 'RS7', units: 'US' },
false
)
// url = 'https://vpic.nhtsa.dot.gov/api/vehicles/GetCanadianVehicleSpecifications/?make=Audi&model=RS7&units=US&year=2015&format=json'