Partilhar via


NHTSA vPIC (Independent Publisher)

The NHTSA Product Information Catalog Vehicle Listing (vPIC) Application Programming Interface (API) provides different ways to gather information on Vehicles and their specifications. The vPIC Dataset is populated using the information submitted by the Motor Vehicle manufacturers through the 565 submittals. All the information on how a VIN is assigned by the manufacturer is captured in this catalog and used to decode a VIN and extract vehicle information.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://vpic.nhtsa.dot.gov/api/Home
Privacy policy https://www.nhtsa.gov/about-nhtsa/privacy-policy
Categories Data

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Decode VIN

This action returns the decoded VIN.

Decode WMI

This action returns the decoded World Manufacturer Identifier (WMI). WMIs may be put in as either 3 characters representing VIN position 1-3 or 6 characters representing VIN positions 1-3 & 12-14. Example "JTD", "1T9131".

Get all makes

Retrieves a list of all the makes available in vPIC Dataset.

Get all manufacturers

Retrieves a list of all the Manufacturers available in vPIC Dataset. Parameter "Manufacturer Type" allows to filter the list based on manufacturer type (Incomplete Vehicles, Completed Vehicle Manufacturer, Incomplete Vehicle Manufacturer, Intermediate Manufacturer, Final-Stage Manufacturer, Alterer, Replica Vehicle Manufacturer, or any part of it). Results are provided in pages of 100 items.

Get equipment plant codes

Retrieves assigned equipment plant codes.

Get makes by vehicle type name

Retrieves all the Makes in the vPIC dataset for a specified vehicle type whose name is LIKE the vehicle type name in vPIC Dataset. Vehicle Type name can be a partial name, or a full name for more specificity (e.g., "Vehicle", "Moto", "Low Speed Vehicle", etc.).

Get makes for manufacturer by manufacturer name

Retrieves all the Makes in the vPIC dataset for a specified manufacturer that is requested. If query is a number - method will do exact match on Manufacturer's Id. If query is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches. Manufacturer name can be a partial name, or a full name for more specificity (e.g., "988", "HONDA", "HONDA OF CANADA MFG., INC.", etc.)

Get makes for manufacturer by manufacturer name and year

Retrieves all the Makes in the vPIC dataset for a specified manufacturer and whose Year From and Year To range cover the specified year If supplied parameter is a number - method will do exact match on Manufacturer's Id. If supplied parameter is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches. Manufacturer can be idenfitied by Id, a partial name, or a full name (e.g., "988", "HONDA", "HONDA OF CANADA MFG., INC.", etc.).

Get manufacturer details

Retrieves the details for a specific manufacturer that is requested. If query is a number - method will do exact match on Manufacturer's Id. If query is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches.

Get models for make

Retrieves the models in the vPIC dataset for a specified make whose name is LIKE the make in vPIC Dataset. Make can be a partial, or a full for more specificity (e.g., "Harley", "Harley Davidson", etc.).

Get models for make a combination of year and vehicle type

Retrieves the models in the vPIC dataset for a specified year and make whose name is LIKE the make in vPIC Dataset. Make can be a partial, or a full for more specificity (e.g., "Harley", "Harley Davidson", etc.) Model year is integer (greater than 1995). Vehicle Ttpe name can be a partial name, or a full name for more specificity (e.g., "Vehicle", "Moto", "Low Speed Vehicle", etc.)

Get parts

Get a list of parts with letter date. Up to 1000 results will be returned at a time.

Get vehicle types for make

Retrieves all the Vehicle Types in the vPIC dataset for a specified Make whose name is LIKE the make name in vPIC Dataset. Make can be a ID, partial name, or a full name for more specificity (e.g., "Merc", "Mercedes Benz", etc.).

Get vehicle variable values

Retrieves a list of all the accepted values for a given variable that are stored in vPIC dataset. Search parameter can either be a Variable Name ("battery type" in first example, please use full name, not just part of it), or Variable ID ("2" in second example). This applies to only "Look up" type of variables.

Get vehicle variables

Retrieves a list of all the vehicle related variables that are in vPIC dataset. Information on the name, description and the type of the variable is provided.

Get WMIs for Manufacturer

Provides information on the all World Manufacturer Identifier (WMI) for a specified Manufacturer. Only WMI registered in vPICList are displayed. If Query is a number - method will do exact match on Manufacturer's Id. If Query is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches. If Vehicle Type is a number - method will do exact match on Vehicle Type's Id. If Vehicle Type is a string - it will look for Vehicle Type whose name is LIKE the provided name (it accepts a partial Vehicle Type name as an input). Multiple results are returned in case of multiple matches. Both parameters are optional but at least one must be provided.

Decode VIN

This action returns the decoded VIN.

Parameters

Name Key Required Type Description
VIN
VIN True string

The VIN.

Model Year
modelyear integer

The model year.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
ABS
Results.ABS string

The anti-lock brake system.

Active Safety System Note
Results.ActiveSafetySysNote string

The active safety system note.

Adaptive Cruise Control
Results.AdaptiveCruiseControl string

The adaptive cruise control.

Adaptive Driving Beam
Results.AdaptiveDrivingBeam string

The adaptive driving beam.

Adaptive Headlights
Results.AdaptiveHeadlights string

The adaptive headlights.

Additional Error Text
Results.AdditionalErrorText string

Any additional error text.

Air Bag Location Curtain
Results.AirBagLocCurtain string

The curtain air bag location.

Air Bag Location Front
Results.AirBagLocFront string

The front air bag location.

Air Bag Location Knee
Results.AirBagLocKnee string

The knee air bag location.

Air Bag Location Seat Cushion
Results.AirBagLocSeatCushion string

The seat cushion air bag location.

Air Bag Location Side
Results.AirBagLocSide string

The side air bag location.

Auto Reverse System
Results.AutoReverseSystem string

The auto reverse system.

Automatic Pedestrian Alerting Sound
Results.AutomaticPedestrianAlertingSound string

The automatic pedestrian alerting sound.

Axle Configuration
Results.AxleConfiguration string

The axle configuration.

Axles
Results.Axles string

The axles.

Base Price
Results.BasePrice string

The base price.

BatteryA
Results.BatteryA string

The battery A.

Battery A To
Results.BatteryA_to string

The battery A to.

Battery Cells
Results.BatteryCells string

The battery cells.

Battery Info
Results.BatteryInfo string

The battery information.

Battery KW/h
Results.BatteryKWh string

The battery KW/h.

Battery KWh To
Results.BatteryKWh_to string

The battery KW/h to.

Battery Modules
Results.BatteryModules string

The battery modules.

Battery Packs
Results.BatteryPacks string

The battery packs.

Battery Type
Results.BatteryType string

The battery type.

BatteryV
Results.BatteryV string

The battery V.

Battery V To
Results.BatteryV_to string

The battery V to.

Bed Length Inches
Results.BedLengthIN string

The bed length in inches.

Bed Type
Results.BedType string

The bed type.

Blind Spot Intervention
Results.BlindSpotIntervention string

The blind spot intervention.

Blind Spot Monitor
Results.BlindSpotMon string

The blind spot monitor.

Body Cab Type
Results.BodyCabType string

The body cab type.

Body Class
Results.BodyClass string

The body class.

Brake System Description
Results.BrakeSystemDesc string

The brake system description.

Brake System Type
Results.BrakeSystemType string

The type of brake system.

Bus Floor Config Type
Results.BusFloorConfigType string

The bus floor configuration type.

Bus Length
Results.BusLength string

The bus length.

Bus Type
Results.BusType string

The bus type.

AACN
Results.CAN_AACN string

The advanced automatic collision notification.

CIB
Results.CIB string

The crash imminent braking.

Cash For Clunkers
Results.CashForClunkers string

The Cash for Clunkers.

Charger Level
Results.ChargerLevel string

The charger level.

Charger Power KW
Results.ChargerPowerKW string

The KW charger power.

Cooling Type
Results.CoolingType string

The cooling type.

Curb Weight LB
Results.CurbWeightLB string

The curb weight in pounds.

Custom Motorcycle Type
Results.CustomMotorcycleType string

The custom motorcycle type.

Daytime Running Light
Results.DaytimeRunningLight string

The daytime running light.

Destination Market
Results.DestinationMarket string

The destination market.

Displacement CC
Results.DisplacementCC string

The engine displacement in cubic centimeters.

Displacement CI
Results.DisplacementCI string

The engine displacement in cubic inches.

Displacement L
Results.DisplacementL string

The engine displacement in liters.

Doors
Results.Doors string

The doors.

Drive Type
Results.DriveType string

The drive type.

Driver Assist
Results.DriverAssist string

The driver assist.

Dynamic Brake Support
Results.DynamicBrakeSupport string

The dynamic brake support.

EDR
Results.EDR string

The event data recorder.

ESC
Results.ESC string

The electronic spark control.

EV Drive Unit
Results.EVDriveUnit string

The EV drive unit.

Electrification Level
Results.ElectrificationLevel string

The electrification level.

Engine Configuration
Results.EngineConfiguration string

The engine configuration.

Engine Cycles
Results.EngineCycles string

The engine cycles.

Engine Cylinders
Results.EngineCylinders string

The engine cylinders.

Engine HP
Results.EngineHP string

The engine horsepower.

Engine HP To
Results.EngineHP_to string

The engine horsepower to.

Engine KW
Results.EngineKW string

The engine KW.

Engine Manufacturer
Results.EngineManufacturer string

The engine manufacturer.

Engine Model
Results.EngineModel string

The engine model.

Entertainment System
Results.EntertainmentSystem string

The entertainment system.

Error Code
Results.ErrorCode string

The error code.

Error Text
Results.ErrorText string

The error text.

Forward Collision Warning
Results.ForwardCollisionWarning string

The forward collision warning.

Fuel Injection Type
Results.FuelInjectionType string

The fuel injection type.

Fuel Type Primary
Results.FuelTypePrimary string

The primary fuel type.

Fuel Type Secondary
Results.FuelTypeSecondary string

The secondary fuel type.

GCWR
Results.GCWR string

The gross combined weight rating.

GCWR To
Results.GCWR_to string

The gross combined weight rating to.

GVWR
Results.GVWR string

The gross vehicle weight rating.

GVWR To
Results.GVWR_to string

The gross vehicle weight rating to.

Keyless Ignition
Results.KeylessIgnition string

The keyless ignition.

Lane Centering Assistance
Results.LaneCenteringAssistance string

The lane centering assistance.

Lane Departure Warning
Results.LaneDepartureWarning string

The lane departure warning.

Lane Keep System
Results.LaneKeepSystem string

The lane keep system.

Lower Beam Headlamp Light Source
Results.LowerBeamHeadlampLightSource string

The lower beam headlamp light source.

Make
Results.Make string

The make.

Make ID
Results.MakeID string

The make unique identifier.

Manufacturer
Results.Manufacturer string

The manufacturer.

Manufacturer ID
Results.ManufacturerId string

The manufacturer unique identifier.

Model
Results.Model string

The model.

Model ID
Results.ModelID string

The model unique identifier.

Model Year
Results.ModelYear string

The model year.

Motorcycle Chassis Type
Results.MotorcycleChassisType string

The motorcycle chassis type.

Motorcycle Suspension Type
Results.MotorcycleSuspensionType string

The motorcycle suspension type.

NCSA Body Type
Results.NCSABodyType string

The National Center for Statistics & Analysis body type.

NCSA Make
Results.NCSAMake string

The National Center for Statistics & Analysis make.

NCSA Map Exc Approved By
Results.NCSAMapExcApprovedBy string

The National Center for Statistics & Analysis mapping exception approved.

NCSA Map Exc Approved On
Results.NCSAMapExcApprovedOn string

The National Center for Statistics & Analysis mapping exception approved on.

NCSA Mapping Exception
Results.NCSAMappingException string

The National Center for Statistics & Analysis mapping exception.

NCSA Model
Results.NCSAModel string

The National Center for Statistics & Analysis model.

NCSA Note
Results.NCSANote string

The National Center for Statistics & Analysis note.

Non-Land Use
Results.NonLandUse string

The non-land use.

Note
Results.Note string

The note.

Other Business Info
Results.OtherBusInfo string

The other business info.

Other Engine Info
Results.OtherEngineInfo string

The other engine info.

Other Motorcycle Info
Results.OtherMotorcycleInfo string

The other motorcyle info.

Other Restraint System Info
Results.OtherRestraintSystemInfo string

The other restraint system info.

Other Trailer Info
Results.OtherTrailerInfo string

The other trailer info.

Park Assist
Results.ParkAssist string

The park assist.

Pedestrian Automatic Emergency Braking
Results.PedestrianAutomaticEmergencyBraking string

The pedestrian automatic emergency braking.

Plant City
Results.PlantCity string

The plant city.

Plant Company Name
Results.PlantCompanyName string

The plant company name.

Plant Country
Results.PlantCountry string

The plant country.

Plant State
Results.PlantState string

The plant state.

Possible Values
Results.PossibleValues string

The possible values.

Pretensioner
Results.Pretensioner string

The pretensioner.

Rear Automatic Emergency Braking
Results.RearAutomaticEmergencyBraking string

The rear automatic emergency braking.

Rear Cross Traffic Alert
Results.RearCrossTrafficAlert string

The rear cross traffic alert.

Rear Visibility System
Results.RearVisibilitySystem string

The rear visibility system.

SAE Automation Level
Results.SAEAutomationLevel string

The SAE automation level.

SAE Automation Level To
Results.SAEAutomationLevel_to string

The SAE automation level to.

Seat Belts All
Results.SeatBeltsAll string

The all seat belts.

Seat Rows
Results.SeatRows string

The seat rows.

Seats
Results.Seats string

The seats.

Semiautomatic Headlamp Beam Switching
Results.SemiautomaticHeadlampBeamSwitching string

The semiautomatic headlamp beam switching.

Series
Results.Series string

The series.

Series 2
Results.Series2 string

The second series.

Steering Location
Results.SteeringLocation string

The steering location.

Suggested VIN
Results.SuggestedVIN string

The suggested VIN.

TPMS
Results.TPMS string

The tire pressure monitoring system.

Top Speed MPH
Results.TopSpeedMPH string

The top speed in MPH.

Track Width
Results.TrackWidth string

The track width.

Traction Control
Results.TractionControl string

The traction control.

Trailer Body Type
Results.TrailerBodyType string

The trailer body type.

Trailer Length
Results.TrailerLength string

The trailer length.

Trailer Type
Results.TrailerType string

The trailer type.

Transmission Speeds
Results.TransmissionSpeeds string

The transmission speeds.

Transmission Style
Results.TransmissionStyle string

The transmission style.

Trim
Results.Trim string

The trim.

Trim 2
Results.Trim2 string

The second trim.

Turbo
Results.Turbo string

The turbo.

VIN
Results.VIN string

The VIN.

Valve Train Design
Results.ValveTrainDesign string

The valve train design.

Vehicle Type
Results.VehicleType string

The vehicle type.

Wheel Base Long
Results.WheelBaseLong string

The long wheel base.

Wheel Base Short
Results.WheelBaseShort string

The short wheel base.

Wheel Base Type
Results.WheelBaseType string

The wheel base type.

Wheel Size Front
Results.WheelSizeFront string

The front wheel size.

Wheel Size Rear
Results.WheelSizeRear string

The rear wheel size.

Wheels
Results.Wheels string

The wheels.

Windows
Results.Windows string

The windows.

Decode WMI

This action returns the decoded World Manufacturer Identifier (WMI). WMIs may be put in as either 3 characters representing VIN position 1-3 or 6 characters representing VIN positions 1-3 & 12-14. Example "JTD", "1T9131".

Parameters

Name Key Required Type Description
WMI
WMI True string

The world manufacturer identifier.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Common Name
Results.CommonName string

The common name.

Created On
Results.CreatedOn string

When created on.

Date Available To Public
Results.DateAvailableToPublic string

The date available to public.

Make
Results.Make string

The make.

Manufacturer
Results.ManufacturerName string

The manufacturer.

Parent Company
Results.ParentCompanyName string

The parent company.

URL
Results.URL string

The URL address.

Updated On
Results.UpdatedOn string

When updated on.

Vehicle Type
Results.VehicleType string

The vehicle type.

Get all makes

Retrieves a list of all the makes available in vPIC Dataset.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.Make_ID integer

The make unique identifier.

Make
Results.Make_Name string

The make.

Get all manufacturers

Retrieves a list of all the Manufacturers available in vPIC Dataset. Parameter "Manufacturer Type" allows to filter the list based on manufacturer type (Incomplete Vehicles, Completed Vehicle Manufacturer, Incomplete Vehicle Manufacturer, Intermediate Manufacturer, Final-Stage Manufacturer, Alterer, Replica Vehicle Manufacturer, or any part of it). Results are provided in pages of 100 items.

Parameters

Name Key Required Type Description
Manufacturer Type
ManufacturerType string

The manufacturer type.

Page
page integer

The page.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Country
Results.Country string

The country.

Manufacturer Common Name
Results.Mfr_CommonName string

The manufacturer common name.

Manufacturer ID
Results.Mfr_ID integer

The manufacturer unique identifier.

Manufacturer
Results.Mfr_Name string

The manufacturer.

Vehicle Types
Results.VehicleTypes array of object
Is Primary
Results.VehicleTypes.IsPrimary boolean

Whether is primary.

Name
Results.VehicleTypes.Name string

The name.

Get equipment plant codes

Retrieves assigned equipment plant codes.

Parameters

Name Key Required Type Description
Filter
filter True string

Filter can be year, equipment type or report type.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Address
Results.Address string

The address.

City
Results.City string

The city.

Country
Results.Country string

The country.

DOT Code
Results.DOTCode string

The DOT code.

Name
Results.Name string

The name.

Old DOT Code
Results.OldDotCode string

The old DOT code.

Postal Code
Results.PostalCode string

The postal code.

State Province
Results.StateProvince string

The state or province.

Status
Results.Status string

The status.

Get makes by vehicle type name

Retrieves all the Makes in the vPIC dataset for a specified vehicle type whose name is LIKE the vehicle type name in vPIC Dataset. Vehicle Type name can be a partial name, or a full name for more specificity (e.g., "Vehicle", "Moto", "Low Speed Vehicle", etc.).

Parameters

Name Key Required Type Description
Vehicle Type
VehicleType True string

The vehicle type.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.MakeId integer

The make unique identifier.

Make
Results.MakeName string

The make.

Vehicle Type ID
Results.VehicleTypeId integer

The vehicle type unique identifier.

Vehicle Type
Results.VehicleTypeName string

The vehicle type.

Get makes for manufacturer by manufacturer name

Retrieves all the Makes in the vPIC dataset for a specified manufacturer that is requested. If query is a number - method will do exact match on Manufacturer's Id. If query is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches. Manufacturer name can be a partial name, or a full name for more specificity (e.g., "988", "HONDA", "HONDA OF CANADA MFG., INC.", etc.)

Parameters

Name Key Required Type Description
Query
query True string

The query.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.Make_ID integer

The make unique identifier.

Make
Results.Make_Name string

The make.

Manufacturer
Results.Mfr_Name string

The manufacturer.

Get makes for manufacturer by manufacturer name and year

Retrieves all the Makes in the vPIC dataset for a specified manufacturer and whose Year From and Year To range cover the specified year If supplied parameter is a number - method will do exact match on Manufacturer's Id. If supplied parameter is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches. Manufacturer can be idenfitied by Id, a partial name, or a full name (e.g., "988", "HONDA", "HONDA OF CANADA MFG., INC.", etc.).

Parameters

Name Key Required Type Description
Query
query True string

The query.

Year
year True integer

The year.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.MakeId integer

The make unique identifier.

Make
Results.MakeName string

The make.

Manufacturer ID
Results.MfrId integer

The manufacturer unique identifier.

Manufacturer
Results.MfrName string

The manufacturer.

Get manufacturer details

Retrieves the details for a specific manufacturer that is requested. If query is a number - method will do exact match on Manufacturer's Id. If query is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches.

Parameters

Name Key Required Type Description
Query
query True string

The query.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Address
Results.Address string

The address.

Address 2
Results.Address2 string

The address line 2.

City
Results.City string

The city.

Contact Email
Results.ContactEmail string

The contact email address.

Contact Fax
Results.ContactFax string

The contact fax.

Contact Phone
Results.ContactPhone string

The contact phone number.

Country
Results.Country string

The country.

DBAs
Results.DBAs string

The DBAs.

Equipment Items
Results.EquipmentItems array of

The equipment items.

Last Updated
Results.LastUpdated string

When last updated.

Manufacturer Types
Results.ManufacturerTypes array of object
Name
Results.ManufacturerTypes.Name string

The name.

Manufacturer Common Name
Results.Mfr_CommonName string

The manufacturer common name.

Manufacturer ID
Results.Mfr_ID integer

The manufacturer unique identifier.

Manufacturer
Results.Mfr_Name string

The manufacturer.

Other Manufacturer Details
Results.OtherManufacturerDetails string

The other manufacturer details.

Postal Code
Results.PostalCode string

The postal code.

Primary Product
Results.PrimaryProduct string

The primary product.

Principal First Name
Results.PrincipalFirstName string

The principal's first name.

Principal Last Name
Results.PrincipalLastName string

The principal's last name.

Principal Position
Results.PrincipalPosition string

The principal's position.

State Province
Results.StateProvince string

The state or province.

Submitted Name
Results.SubmittedName string

The submitted name.

Submitted On
Results.SubmittedOn string

When submitted on.

Submitted Position
Results.SubmittedPosition string

The submitted position.

Vehicle Types
Results.VehicleTypes array of object
GVWR From
Results.VehicleTypes.GVWRFrom string

The gross vehicle weight rating from.

GVWR To
Results.VehicleTypes.GVWRTo string

The gross vehicle weight rating to.

Is Primary
Results.VehicleTypes.IsPrimary boolean

Whether is primary.

Name
Results.VehicleTypes.Name string

The name.

Get models for make

Retrieves the models in the vPIC dataset for a specified make whose name is LIKE the make in vPIC Dataset. Make can be a partial, or a full for more specificity (e.g., "Harley", "Harley Davidson", etc.).

Parameters

Name Key Required Type Description
Make
make True string

The make.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.Make_ID integer

The make unique identifier.

Make
Results.Make_Name string

The make.

Model ID
Results.Model_ID integer

The model unique identifier.

Model
Results.Model_Name string

The model.

Get models for make a combination of year and vehicle type

Retrieves the models in the vPIC dataset for a specified year and make whose name is LIKE the make in vPIC Dataset. Make can be a partial, or a full for more specificity (e.g., "Harley", "Harley Davidson", etc.) Model year is integer (greater than 1995). Vehicle Ttpe name can be a partial name, or a full name for more specificity (e.g., "Vehicle", "Moto", "Low Speed Vehicle", etc.)

Parameters

Name Key Required Type Description
Make
make True string

The make.

Year or Vehicle Type
yearOrVehicleType True string

The year or vehicle type.

Query
query True string

The query.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.Make_ID integer

The make unique identifier.

Make
Results.Make_Name string

The make.

Model ID
Results.Model_ID integer

The model unique identifier.

Model
Results.Model_Name string

The model.

Get parts

Get a list of parts with letter date. Up to 1000 results will be returned at a time.

Parameters

Name Key Required Type Description
Type
type integer

The type.

From Date
fromDate string

The from date.

To Date
toDate string

The to date.

Page
page integer

The page.

Manufacturer
manufacturer string

The manufacturer.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Cover Letter URL
Results.CoverLetterURL string

The URL address of the cover letter.

Letter Date
Results.LetterDate string

The letter date.

Manufacturer ID
Results.ManufacturerId integer

The manufacturer unique identifier.

Manufacturer
Results.ManufacturerName string

The manufacturer.

Model Year From
Results.ModelYearFrom string

The model year from.

Model Year To
Results.ModelYearTo string

The model year to.

Name
Results.Name string

The name.

Type
Results.Type string

The type.

URL
Results.URL string

The URL address.

Get vehicle types for make

Retrieves all the Vehicle Types in the vPIC dataset for a specified Make whose name is LIKE the make name in vPIC Dataset. Make can be a ID, partial name, or a full name for more specificity (e.g., "Merc", "Mercedes Benz", etc.).

Parameters

Name Key Required Type Description
Make
make True string

The make.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Make ID
Results.MakeId integer

The make unique identifier.

Make
Results.MakeName string

The make.

Vehicle Type ID
Results.VehicleTypeId integer

The vehicle type unique identifier.

Vehicle Type
Results.VehicleTypeName string

The vehicle type.

Get vehicle variable values

Retrieves a list of all the accepted values for a given variable that are stored in vPIC dataset. Search parameter can either be a Variable Name ("battery type" in first example, please use full name, not just part of it), or Variable ID ("2" in second example). This applies to only "Look up" type of variables.

Parameters

Name Key Required Type Description
Variable
variable True string

The variable.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Element
Results.ElementName string

The element.

ID
Results.Id integer

The unique identifier.

Name
Results.Name string

The name.

Get vehicle variables

Retrieves a list of all the vehicle related variables that are in vPIC dataset. Information on the name, description and the type of the variable is provided.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Data Type
Results.DataType string

The data type.

Description
Results.Description string

The description.

Group
Results.GroupName string

The group.

ID
Results.ID integer

The unique identifier.

Name
Results.Name string

The name.

Get WMIs for Manufacturer

Provides information on the all World Manufacturer Identifier (WMI) for a specified Manufacturer. Only WMI registered in vPICList are displayed. If Query is a number - method will do exact match on Manufacturer's Id. If Query is a string - it will look for manufacturers whose name is LIKE the provided name (it accepts a partial manufacturer name as an input). Multiple results are returned in case of multiple matches. If Vehicle Type is a number - method will do exact match on Vehicle Type's Id. If Vehicle Type is a string - it will look for Vehicle Type whose name is LIKE the provided name (it accepts a partial Vehicle Type name as an input). Multiple results are returned in case of multiple matches. Both parameters are optional but at least one must be provided.

Parameters

Name Key Required Type Description
Query
query True string

The query.

Vehicle Type
vehicleType string

The vehicle type.

Returns

Name Path Type Description
Count
Count integer

The count.

Message
Message string

The response message.

Search Criteria
SearchCriteria string

The search criteria.

Results
Results array of object
Country
Results.Country string

The country.

Created On
Results.CreatedOn string

When created on.

Date Available To Public
Results.DateAvailableToPublic string

The date available to public.

ID
Results.Id integer

The unique identifier.

Name
Results.Name string

The name.

Updated On
Results.UpdatedOn string

When updated on.

Vehicle Type
Results.VehicleType string

The vehicle type.

WMI
Results.WMI string

The world manufacturer identifier.