Skip to content
On this page

@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/endpoints/GetModelsForMakeId

Module: api/endpoints/GetModelsForMakeId

Table of contents

Type Aliases

Functions

Type Aliases

GetModelsForMakeIdResults

Ƭ GetModelsForMakeIdResults: Object

Objects found in the Results array of GetModelsForMakeId endpoint response.

Type declaration

NameType
Make_IDnumber
Make_Namestring
Model_IDnumber
Model_Namestring

Defined in

api/endpoints/GetModelsForMakeId.ts:87

Functions

GetModelsForMakeId

GetModelsForMakeId(makeId, doFetch?): Promise<NhtsaResponse<GetModelsForMakeIdResults>>

💡 More Information

See: GetModelsForMakeId Documentation

GetModelsForMakeId returns the Models in the vPIC dataset for a specified Make whose ID is equal to the makeID in the vPIC Dataset.

You can get makeIDs via MAKE_ID key in Results objects of the following endpoints:

  • GetAllMakes endpoint
  • GetMakeForManufacturer endpoint
  • GetModelsForMake endpoint
  • GetModelsForMakeYear endpoint

You can get makeIDs via MakeID key in Results objects of the following endpoints:

  • DecodeVinValues
  • DecodeVinValuesBatch

You can get makeIDs via ValueId key in Results objects of the following endpoints. One of the objects in the Results array will contain both Variable: "Make" and VariableId: 26. The ValueId key in that same object is the makeID for use in this endpoint.

  • DecodeVin
  • DecodeVinExtended

Parameters

NameTypeDescription
makeIdstring | numberMake ID to search
doFetch?trueWhether to fetch the data or just return the URL (default: true)

Returns

Promise<NhtsaResponse<GetModelsForMakeIdResults>>

  • Api Response object -or- url string if doFetch = false

Defined in

api/endpoints/GetModelsForMakeId.ts:41

GetModelsForMakeId(makeId, doFetch): Promise<string>

Parameters

NameType
makeIdstring | number
doFetchfalse

Returns

Promise<string>

Defined in

api/endpoints/GetModelsForMakeId.ts:46

Released under the MIT License.