Skip to main content

A client library for the United States National Highway Traffic Safety Administration (NHTSA) Vehicle Product Information Catalog (vPIC) API

Project description

vPIC API Client Library

PyPI PyPI - Python Version PyPI - Implementation PyPI - Wheel MIT License Tests

A Python client library for decoding VINs and querying the United States National Highway Traffic Safety Administration (NHTSA) Vehicle Product Information Catalog Vehicle Listing (vPIC) API.

NHTSA vPIC API

The Vehicle Production Information Catalog (vPIC) API is hosted by the U.S. National Highway Transportation Safety Administration (NHTSA). vPIC data is provided by manufacturers who make vehicles for sale in the United States. The vPIC API is available 24/7, is free to use, and does not require registration. See https://vpic.nhtsa.dot.gov/api/home/index/faq for more on the vPIC API.

Features

  • Decode 17-digit Vehicle Identification Numbers (VIN)
  • Decode a partial VIN
  • Discover manufacturers, makes, and models
  • Supports cars, MPVs, trucks, motorcycles, buses, trailers, low speed vehicles and incomplete vehicles sold the U.S.A.
  • Find manufacturer model year VIN guides
  • Supports vehicles made since 1981
  • Comprehensive support for the vPIC API
  • Get results as Python objects (see vpic.TypedClient)
  • Get results as JSON (see vpic.Client)

Author

Installation

  poetry add vpic-api

vpic.TypedClient Examples

vpic.TypedClient returns results as Python objects.

Decode a VIN

Get the characteristics of a vehicle by it's 17-digit Vehicle Identification Number (VIN):

from vpic import TypedClient

c = TypedClient()

result = c.decode_vin("1FTMW1T88MFA00001")

Vehicle(
    abs="",
    ...
    body_cab_type="Crew/ Super Crew/ Crew Max",
    body_class="Pickup",
    brake_system_desc="",
    brake_system_type="Hydraulic",
    ...
    displacement_cc="3500.0",
    displacement_ci="213.58310433156",
    displacement_l="3.5",
    ...
    drive_type="4WD/4-Wheel Drive/4x4",
    ...
    engine_configuration="V-Shaped",
    engine_cycles="",
    engine_cylinders="6",
    engine_hp="375",
    engine_hp_to="",
    engine_kw="279.6375",
    engine_manufacturer="Ford",
    engine_model="GTDI",
    entertainment_system="",
    error_code="0",
    error_text="0 - VIN decoded clean. Check Digit (9th position) is correct",
    ...
    make="FORD",
    make_id="460",
    manufacturer="FORD MOTOR COMPANY, USA",
    manufacturer_id="976",
    model="F-150",
    model_id="1801",
    model_year="2021",
    motorcycle_chassis_type="Not Applicable",
    motorcycle_suspension_type="Not Applicable",
    ...
    plant_city="DEARBORN",
    plant_company_name="",
    plant_country="UNITED STATES (USA)",
    plant_state="MICHIGAN",
    ...
    series="F-Series",
    series2="",
    ...
    trim="SuperCrew-SSV",
    ...
    vin="1FTMW1T88MFA00001",
    ...
    vehicle_type="TRUCK ",
    ...
)

Get the Models for a Make and Model Year

get_models_for_make("TESLA", model_year=2020)

[
    Model(
        model_id=1685,
        model="Model S",
        make_id=441,
        make="TESLA",
        vehicle_type_id=None
    ),
    Model(
        model_id=10199,
        model="Model X",
        make_id=441,
        make="TESLA",
        vehicle_type_id=None
    ),
    Model(
        model_id=17834,
        model="Model 3",
        make_id=441,
        make="TESLA",
        vehicle_type_id=None
    ),
    Model(
        model_id=27027,
        model="Model Y",
        make_id=441,
        make="TESLA",
        vehicle_type_id=None
        )
]

vpic.Client Examples

vpic.Client returns JSON results from the vPIC API.

This client automatically standardizes variable names where vPIC uses inconsistent naming. Disable this to see the unaltered JSON responses:

from vpic import Client

c = Client(standardize_names=False)

Decode a VIN

Get the characteristics of a vehicle by it's 17-digit Vehicle Identification Number (VIN):

from vpic import Client

c = Client()

result = c.decode_vin("1FA6P8TD5M5100001", 2021)

Here are a few of the 130+ attributes vPIC returns for the VIN:

{
    "Doors": "2",
    "ErrorCode": "0",
    "ErrorText": "0 - VIN decoded clean. Check Digit (9th position) is correct",
    "Make": "FORD",
    "MakeId": "460",
    "Manufacturer": "FORD MOTOR COMPANY, USA",
    "ManufacturerId": "976",
    "Model": "Mustang",
    "ModelId": "1781",
    "ModelYear": "2021",
    "PlantCity": "FLATROCK",
    "PlantCountry": "UNITED STATES (USA)",
    "PlantState": "MICHIGAN",
    "Series": "I4 Coupe",
    "VIN": "1FA6P8TD5M5100001",
    "VehicleType": "PASSENGER CAR",
}

Get the Models for a Make and Model Year

result = c.get_models_for_make("TESLA", 2021)
[
    {
        "MakeId": 441,
        "Make": "TESLA",
        "ModelId": 1685,
        "Model": "Model S"
    },
    {
        "MakeId": 441,
        "Make": "TESLA",
        "ModelId": 10199,
        "Model": "Model X"
    },
    {
        "MakeId": 441,
        "Make": "TESLA",
        "ModelId": 17834,
        "Model": "Model 3"
    },
    {
        "MakeId": 441,
        "Make": "TESLA",
        "ModelId": 27027,
        "Model": "Model Y"
    }
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vpic-api-0.7.4.tar.gz (462.5 kB view details)

Uploaded Source

Built Distribution

vpic_api-0.7.4-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file vpic-api-0.7.4.tar.gz.

File metadata

  • Download URL: vpic-api-0.7.4.tar.gz
  • Upload date:
  • Size: 462.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.4 Darwin/20.5.0

File hashes

Hashes for vpic-api-0.7.4.tar.gz
Algorithm Hash digest
SHA256 a3cf8d3f2115d870094883c2e84dafa872de3337b6fe50a3f597d63f5a6ebe75
MD5 a6a9822cc8554db113952887d8a21a7f
BLAKE2b-256 b1786e7abd960eb9b6ecaebd2a56f95d441780f594e19468f6e06070a0c066fa

See more details on using hashes here.

File details

Details for the file vpic_api-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: vpic_api-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.4 Darwin/20.5.0

File hashes

Hashes for vpic_api-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e87ffa3347dd8714e1008dc508c1a87f34a51ca373a3c913aa0eaaf12be2032e
MD5 f41e20dd4a7222ec2e559419efa76b39
BLAKE2b-256 475f99b8f7fb6d1ca1e7c626d7694b23b82a79e9d5d16b1a46eb261b08f2d8e4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page