Skip to main content

Asynchronous Python client providing RDW vehicle information.

Project description

Python: Asynchronous Python client providing RDW vehicle information

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage OpenSSF Scorecard Open in Dev Containers

Sponsor Frenck via GitHub Sponsors

Support Frenck on Patreon

Asynchronous Python client providing RDW vehicle information.

About

This package allows you to get information from the RDW (Netherlands Vehicle Authority) about a specific vehicle by its license plate.

It queries three RDW open data datasets:

  • Vehicle information: brand, model, color, dimensions, mass, APK status, and more.
  • Fuel & emissions: fuel type, CO2, consumption, power, emission standard, electric range, and WLTP data.
  • Recalls: open and resolved recall actions.

Installation

pip install vehicle

Usage

import asyncio

from vehicle import RDW, Vehicle


async def main() -> None:
    """Show example of fetching RDW vehicle info from Socrata API."""
    async with RDW() as rdw:
        vehicle: Vehicle = await rdw.vehicle(license_plate="11ZKZ3")
        print(vehicle)

        # Fuel and emission data (can return multiple entries for hybrids)
        fuels = await rdw.fuel(license_plate="11ZKZ3")
        for fuel in fuels:
            print(fuel.fuel_type, fuel.co2_combined, fuel.max_power)

        # Recall status
        recalls = await rdw.recalls(license_plate="11ZKZ3")
        for recall in recalls:
            print(recall.reference_code, recall.status)


if __name__ == "__main__":
    asyncio.run(main())

Command-line interface

This package ships with an optional CLI that is handy for quickly looking up vehicle information. Install it with the cli extra:

pip install "vehicle[cli]"

Look up a vehicle by its license plate:

# Human-readable table output
vehicle 11ZKZ3

# Machine-readable JSON output
vehicle 11ZKZ3 --json

# Dashes and spaces in license plates are automatically normalized
vehicle "11-ZKZ-3"

Run vehicle --help for the full reference.

Behavior & error handling

Each API call is a single HTTP GET to the RDW open data (Socrata) API; the client does not retry on transient failures. If you need retries with backoff, wrap the calls in your own retry loop (or use something like backoff).

Requests are bounded by a per-call timeout, which defaults to 10 seconds and can be overridden via the request_timeout constructor argument:

async with RDW(request_timeout=5) as rdw:
    vehicle = await rdw.vehicle(license_plate="11ZKZ3")

All exceptions inherit from RDWError:

Exception Raised when
RDWConnectionError Request timed out or the network / API was unreachable
RDWUnknownLicensePlateError The license plate was not found in the RDW database
RDWError Any other unexpected response from the API

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

The easiest way to start, is by opening a CodeSpace here on GitHub, or by using the Dev Container feature of Visual Studio Code.

Open in Dev Containers

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • Poetry
  • NodeJS 24+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the prek framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run prek run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2021-2026 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

vehicle-3.0.0.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

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

vehicle-3.0.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file vehicle-3.0.0.tar.gz.

File metadata

  • Download URL: vehicle-3.0.0.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for vehicle-3.0.0.tar.gz
Algorithm Hash digest
SHA256 2537332cf336399ece443e95f22a5d8a608eb9ea34c0b75afbbc9f5f6e9e5e8c
MD5 b1fa37307171b149cfc3d98f0e793c4d
BLAKE2b-256 202407ceb543a157272ac6cbe33167ca648479d519ea89b1ac7327d148edb564

See more details on using hashes here.

Provenance

The following attestation bundles were made for vehicle-3.0.0.tar.gz:

Publisher: release.yaml on frenck/python-vehicle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vehicle-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: vehicle-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for vehicle-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db5b987ce575743ceb765bc8c7c5d1e434f16008bf4b2c992a8fa65e13faa962
MD5 d21c693136636198707de2f0fa94f37c
BLAKE2b-256 46e710bcd4443249e49d2e1d595949273c8a67c15eb17428dcdecc32342cc5f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for vehicle-3.0.0-py3-none-any.whl:

Publisher: release.yaml on frenck/python-vehicle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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