Skip to main content

Python SDK for DVLA Vehicle Enquiry Service API

Project description

DVLA Vehicle Enquiry Service Python SDK

GitHub Actions Workflow Status PyPI - Python Versions PyPI - Version

dvla_vehicle_enquiry_service is a Python SDK providing a simple interface for interacting with the DVLA (Driver and Vehicle Licensing Agency) Vehicle Enquiry Service API. It allows retrieval of detailed vehicle information based on the registration number, including tax status, MOT status, and more.

Installation

Install the package using pip:

pip install dvla_vehicle_enquiry_service

Usage

Initialisation

To use the VehicleEnquiryAPI class, you'll need an API key provided by the DVLA service. You can also specify the environment as either production or test (default is production).

from dvla_vehicle_enquiry_service import VehicleEnquiryAPI

api_key = "your_api_key"

# Initialise client using the default ('production') API
client = VehicleEnquiryAPI(api_key)

# Or initialise client using the test API
client = VehicleEnquiryAPI(api_key, environment="test")

Fetch Vehicle Details by Registration

To fetch vehicle details using its registration number:

import asyncio
from dvla_vehicle_enquiry_service import VehicleResponse, VehicleEnquiryError

async def get_vehicle_details():
    response = await api.get_vehicle("AA19MOT")
    mot_status = response.motStatus.value if response.motStatus else "Unknown"
    print(f"Vehicle Make: {response.make}, MOT Status: {mot_status}")

asyncio.run(get_vehicle_details())

If the request is successful, this example will print something such as: Vehicle Make: AUDI, MOT Status: Valid.

Error Handling

Errors are raised as VehicleEnquiryError exceptions. You can catch and handle these exceptions to access detailed error information.

try:
    response = await client.get_vehicle("ER19NFD")
except VehicleEnquiryError as e:
    print(f"Error {e.status}: {e.title} - {e.detail}")

Classes and Data Structures

Vehicle Class

  • VehicleResponse: Represents detailed information about a vehicle, including tax status, MOT status, make, model, and various other attributes.

Error Handling Classes

  • VehicleEnquiryError: Exception class that encapsulates error information, including status codes and error details.

Enum Classes

  • TaxStatus: Enumerates possible tax statuses of a vehicle (TAXED, UNTAXED, SORN, etc.).
  • MotStatus: Enumerates possible MOT statuses of a vehicle (VALID, NOT_VALID, NO_DETAILS_HELD, etc.).

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please feel free to submit a pull request.

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

dvla_vehicle_enquiry_service-1.0.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dvla_vehicle_enquiry_service-1.0.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file dvla_vehicle_enquiry_service-1.0.0.tar.gz.

File metadata

File hashes

Hashes for dvla_vehicle_enquiry_service-1.0.0.tar.gz
Algorithm Hash digest
SHA256 5bc1a882ecda9cb0729138fc36a84484dc38562e5f103c14e2469c734d8e26e4
MD5 2bbd6cd4c910cb4266e4555294d8fe78
BLAKE2b-256 3fc48bc2e1782011915b2d62878937d103afac658e5abfac99948bd2e79d5de3

See more details on using hashes here.

File details

Details for the file dvla_vehicle_enquiry_service-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dvla_vehicle_enquiry_service-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a6cb060cae42e542e129aa4bef3bc64567ae9851a8653d9f6ef7ed2c5e1efc9
MD5 b07b81b13c35e5fe33fc90a78c524396
BLAKE2b-256 5cade54e6bc8f1326a8568e7b725970356b2957fca026c3f4b78357c24870428

See more details on using hashes here.

Supported by

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