Skip to main content

Python client for myVW login, session management, and vehicle data APIs

Project description

python_vw_carnet

This library aims to provide some amount of interaction with the Volkswagen CarNet API specific to the US. This will not work in any other country!

This library has not been battle tested. It works for me on my machine and that's as far as I've gotten.

I am not responsible for any issues resulting in your use of this library, including but not limited to loss of account access, acts of God, or your car gaining sentience and locking you in the car, forcing you to listen to polka music on repeat.

Vehicle Compatibility

This library is intended for Volkswagen vehicles in the United States that use the myVW application and connected services.

Volkswagen's U.S. myVW page says the app is available on most model years 2020 and newer vehicles. The table below is a practical compatibility reference derived from Volkswagen's published U.S. connected-services compatibility charts.

❔ = compatibility is unknown

❌ = no compatibility (mostly because this car doesn't exist in this year)

⚠️ = partial compatibility

✅ = full compatibility

Model 2020 2021 2022 2023 2024 2025 2026
Atlas Cross Sport
Atlas
Arteon
Tiguan
Passat
Jetta
Jetta GLI
Taos
Golf
Golf GTI
Golf R
ID.4 c
ID. Buzz

Accuracy/Completeness

This library is very much a work in progress. As I said it currently suits my needs, but it is not feature complete or accurate in the slightest.

I own a 2023 VW ID.4, so I do not have a complete picture of the data available via VWs various APIs.

I am 100% open to contributions to flesh out the library with more features/information. Open an issue or PR and let's talk :)

Usage

//TODO, kind of...

Information on the response types and exactly what data is available can be found in python_vw_carnet.models

There is a basic CLI for testing at python_vw_carnet.__main__

from python_vw_carnet import VWClient

# Instantiate the python_vw_carnet.VWClient class
client = VWClient(
    email='', # Account email
    password='', # Account password
    spin='', # Account PIN (4 digits)
    session_path='', # Storage path for session persistence (default is $HOME/.vw_client/session.json)
)

# Retrieve Garage
client.get_garage()

# Retrieve Vehicle Information
client.get_vehicle(vehicle_id='')

# Retrieve Vehicle Location
client.get_vehicle_location(vehicle_id='')

# Retrieve EV Status Information
client.get_ev_summary(vehicle_id='', temp_unit='f')

Local Development

This project uses uv and targets Python 3.12+.

Set up the environment

From the repository root:

uv sync

That will create .venv and install both runtime and development dependencies from the project configuration.

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

python_vw_carnet-0.4.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

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

python_vw_carnet-0.4.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file python_vw_carnet-0.4.0.tar.gz.

File metadata

  • Download URL: python_vw_carnet-0.4.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for python_vw_carnet-0.4.0.tar.gz
Algorithm Hash digest
SHA256 90109fcd54dcbb1524f2dafa7ea347c3290685a9d10ffb69d0b5e37f70c99776
MD5 379d2ea9e6f9bb849ddd2cc66a9bbe15
BLAKE2b-256 99665ad56acb606c4509b12bcaf1e64cef20cce20e6a42a39d71140ece3dae45

See more details on using hashes here.

File details

Details for the file python_vw_carnet-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: python_vw_carnet-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for python_vw_carnet-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58217da0c034d2f56ad5eb1e334606f47e75f59ff8f73e4bf9198a0487ceab54
MD5 ede19f21c221294d2e8dbdcf20975be8
BLAKE2b-256 17ecaabe073e55f6c02f353b50329033bffd7f3dc4c92a5d57feb07c79130b1f

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