Custom Connector
National Highway Traffic Safety Administration Vehicle Data Connector
US
The NHTSA Vehicle Data Connector provides access to the NHTSA vPIC Vehicle API — vehicle information, VIN decoding, manufacturer details, makes, models, parts, and specifications, primarily for U.S. vehicles. It acts as a proxy supporting VIN decoding, manufacturer queries, and vehicle types/models, with JSON, XML, and CSV responses.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the NHTSA vPIC Connector.
- decodeVin. Decode a VIN to extract vehicle information.
- decodeVinValues. Decode a VIN in flat format.
- decodeVinExtended. Decode a VIN with extended information.
- decodeVinValuesExtended. Decode a VIN in flat format with extended info.
- decodeWmi. Decode a World Manufacturer Identifier (WMI).
- getWmisForManufacturer. Get WMIs for a manufacturer.
- getAllMakes. Get all vehicle makes.
- getParts. Get parts information.
- getAllManufacturers. Get all manufacturers.
- getManufacturerDetails. Get details for a manufacturer.
- getVehicleTypesForMake. Get vehicle types for a make.
- getVehicleTypesForMakeId. Get vehicle types for a make ID.
- getEquipmentPlantCodes. Get equipment plant codes.
- getMakesForManufacturer. Get makes for a manufacturer.
- getMakesForManufacturerAndYear. Get makes for a manufacturer and year.
- getMakesForVehicleType. Get makes for a vehicle type.
- getModelsForMake. Get models for a make.
- getModelsForMakeId. Get models for a make ID.
- getModelsForMakeYearMakeModelYear. Get models for a make and model year.
- getModelsForMakeYearMakeVehicleType. Get models for a make and vehicle type.
- getModelsForMakeYearModelYearVehicleType. Get models for a model year and vehicle type.
- getModelsForMakeIdYearMakeIdModelYear. Get models for a make ID and model year.
- getModelsForMakeIdYearMakeIdVehicleType. Get models for a make ID and vehicle type.
- getModelsForMakeIdYearModelYearVehicleType. Get models for a model year and vehicle type.
- getVehicleVariableList. Get list of vehicle variables.
- getVehicleVariableValuesList. Get values for a vehicle variable.
- decodeVinValuesBatch. Decode multiple VINs in batch.
- getCanadianVehicleSpecifications. Get Canadian vehicle specifications.
Documentation
Detailed Integration Documentation
Decode VIN
| Action | decodeVin |
|---|---|
| Purpose | Decodes a VIN to extract vehicle information like make, model, and specifications. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: vin – the VIN to decode. Optional: format (xml, json, csv). modelyear (integer). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute decodeVin with vin=5UXWX7C5*BA and format=json to display vehicle details. |
Decode VIN Values
| Action | decodeVinValues |
|---|---|
| Purpose | Decodes a VIN in flat format for concise vehicle information retrieval. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: vin – the VIN to decode. Optional: format (xml, json, csv). modelyear (integer). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute decodeVinValues with vin=5UXWX7C5*BA for quick lookups. |
Decode VIN Extended
| Action | decodeVinExtended |
|---|---|
| Purpose | Decodes a VIN with extended vehicle information for detailed analysis. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: vin – the VIN to decode. Optional: format (xml, json, csv). modelyear (integer). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute decodeVinExtended with vin=5UXWX7C5*BA and integrate into reporting tools. |
Decode VIN Values Extended
| Action | decodeVinValuesExtended |
|---|---|
| Purpose | Decodes a VIN in flat format with extended information. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: vin – the VIN to decode. Optional: format (xml, json, csv). modelyear (integer). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute decodeVinValuesExtended with vin=5UXWX7C5*BA for data processing. |
Decode WMI
| Action | decodeWmi |
|---|---|
| Purpose | Decodes a World Manufacturer Identifier (WMI) to get manufacturer and country details. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: wmi. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute decodeWmi with wmi=1G1 for supply-chain analysis. |
Get WMIs for Manufacturer
| Action | getWmisForManufacturer |
|---|---|
| Purpose | Retrieves WMIs associated with a manufacturer, optionally filtered by vehicle type. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: manufacturer. Optional: vehicleType, format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getWmisForManufacturer with manufacturer=honda for manufacturer verification. |
Get All Makes
| Action | getAllMakes |
|---|---|
| Purpose | Retrieves a list of all vehicle makes. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getAllMakes with format=json to populate a make dropdown. |
Get Parts
| Action | getParts |
|---|---|
| Purpose | Retrieves parts information filtered by type, date range, and manufacturer. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Optional: type, fromDate, toDate, page, manufacturer, format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getParts with type=565 and fromDate=1/1/2015 for safety recalls. |
Get All Manufacturers
| Action | getAllManufacturers |
|---|---|
| Purpose | Retrieves a list of all manufacturers, optionally filtered by type and paginated. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Optional: ManufacturerType, page, format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getAllManufacturers with ManufacturerType=Intermediate for industry overviews. |
Get Manufacturer Details
| Action | getManufacturerDetails |
|---|---|
| Purpose | Retrieves detailed information for a specific manufacturer. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: manufacturer. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getManufacturerDetails with manufacturer=honda for compliance checks. |
Get Vehicle Types for Make
| Action | getVehicleTypesForMake |
|---|---|
| Purpose | Retrieves vehicle types for a specific make. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: make. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getVehicleTypesForMake with make=honda for categorization. |
Get Vehicle Types for Make ID
| Action | getVehicleTypesForMakeId |
|---|---|
| Purpose | Retrieves vehicle types for a specific make ID. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: makeId. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getVehicleTypesForMakeId with makeId=474 for search filters. |
Get Equipment Plant Codes
| Action | getEquipmentPlantCodes |
|---|---|
| Purpose | Retrieves equipment plant codes for a given year, type, and report type. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: year, equipmentType, reportType. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getEquipmentPlantCodes with year=2015, equipmentType=1, reportType=all. |
Get Makes for Manufacturer
| Action | getMakesForManufacturer |
|---|---|
| Purpose | Retrieves makes associated with a manufacturer. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: manufacturer. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getMakesForManufacturer with manufacturer=honda for brand analysis. |
Get Makes for Manufacturer and Year
| Action | getMakesForManufacturerAndYear |
|---|---|
| Purpose | Retrieves makes for a manufacturer and specific year. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: manufacturer. Optional: year, vehicleType, format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getMakesForManufacturerAndYear with manufacturer=honda and year=2015. |
Get Makes for Vehicle Type
| Action | getMakesForVehicleType |
|---|---|
| Purpose | Retrieves makes for a specific vehicle type. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: vehicleType. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getMakesForVehicleType with vehicleType=car for type-specific searches. |
Get Models for Make
| Action | getModelsForMake |
|---|---|
| Purpose | Retrieves models for a specific make. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: make. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getModelsForMake with make=honda for model selection. |
Get Models for Make ID
| Action | getModelsForMakeId |
|---|---|
| Purpose | Retrieves models for a specific make ID. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: makeId. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getModelsForMakeId with makeId=474. |
Get Models for Make + Model Year
| Action | getModelsForMakeYearMakeModelYear |
|---|---|
| Purpose | Retrieves models for a make and model year. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: make, year. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute with make=honda and year=2015 for year-specific queries. |
Get Models for Make + Vehicle Type
| Action | getModelsForMakeYearMakeVehicleType |
|---|---|
| Purpose | Retrieves models for a make and vehicle type. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: make, vehicleType. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute with make=honda and vehicleType=car for type filtering. |
Get Models for Model Year + Vehicle Type
| Action | getModelsForMakeYearModelYearVehicleType |
|---|---|
| Purpose | Retrieves models for a model year and vehicle type. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: year, vehicleType. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute with year=2015 and vehicleType=car. |
Get Models for Make ID + Model Year
| Action | getModelsForMakeIdYearMakeIdModelYear |
|---|---|
| Purpose | Retrieves models for a make ID and model year. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: makeId, year. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute with makeId=474 and year=2015. |
Get Models for Make ID + Vehicle Type
| Action | getModelsForMakeIdYearMakeIdVehicleType |
|---|---|
| Purpose | Retrieves models for a make ID and vehicle type. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: makeId, vehicleType. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute with makeId=474 and vehicleType=car. |
Get Models for Make ID + Model Year + Vehicle Type
| Action | getModelsForMakeIdYearModelYearVehicleType |
|---|---|
| Purpose | Retrieves models for a model year and vehicle type (by make ID). |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: year, vehicleType. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute with year=2015 and vehicleType=car. |
Get Vehicle Variable List
| Action | getVehicleVariableList |
|---|---|
| Purpose | Retrieves a list of vehicle variables. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getVehicleVariableList for data mapping. |
Get Vehicle Variable Values List
| Action | getVehicleVariableValuesList |
|---|---|
| Purpose | Retrieves values for a specific vehicle variable. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: variable. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getVehicleVariableValuesList with variable=BodyClass. |
Decode VIN Values Batch
| Action | decodeVinValuesBatch |
|---|---|
| Purpose | Decodes multiple VINs in batch for efficient processing. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Required: POST body with VINs. Optional: format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute decodeVinValuesBatch with batch VIN data for bulk operations. |
Get Canadian Vehicle Specifications
| Action | getCanadianVehicleSpecifications |
|---|---|
| Purpose | Retrieves Canadian vehicle specifications filtered by year, make, model, and units. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL. |
| Parameters | Optional: year, make, model, units, format (xml, json, csv). |
| Output | Successful: JSON/XML/CSV with Count, Message, SearchCriteria, and a Results array. Failure: error details. |
| Workflow example | Execute getCanadianVehicleSpecifications with year=2015 and make=honda for Canadian market analysis. |
Example Workflow: Vehicle Data Lookup
| Retrieve makes and models | Use getAllMakes, then getModelsForMake with a selected make. |
|---|---|
| Decode VIN | Execute decodeVin with a VIN; use decodeVinExtended for more information. |
| Query manufacturer & parts | Use getManufacturerDetails and getParts (by date range). |
| Batch processing | Use decodeVinValuesBatch for multiple VINs and integrate into a vehicle database. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.