This Python package manages the communication with the private Renault API used by the official MyRenault application.
The client is able to read various vehicle attributes, such as:
- mileage
- GPS location
- fuel autonomy (for fuel vehicles)
- battery autonomy (for electric vehicles)
- contracts associated to the vehicle (warranty and connected services)
For some vehicles, it is also possible to manage:
- hvac/pre-conditionning of the vehicle
- charge schedule
This package has been developed to be used with Home-Assistant, but it can be used in other contexts
- Python (>= 3.8)
You can install Renault API via pip from PyPI:
$ pip install renault-apiimport aiohttp
import asyncio
from renault_api.renault_client import RenaultClient
async def main():
async with aiohttp.ClientSession() as websession:
client = RenaultClient(websession=websession, locale="fr_FR")
await client.session.login('email', 'password')
print(f"Accounts: {await client.get_person()}") # List available accounts, make a note of kamereon account id
account_id = "Your Kamereon account id"
account = await client.get_api_account(account_id)
print(f"Vehicles: {await account.get_vehicles()}") # List available vehicles, make a note of vehicle VIN
vin = "Your vehicle VIN"
vehicle = await account.get_api_vehicle(vin)
print(f"Cockpit information: {await vehicle.get_cockpit()}")
print(f"Battery status information: {await vehicle.get_battery_status()}")
loop = asyncio.get_event_loop()
loop.run_until_complete(main())The renault-api is also available through a CLI, which requires additional dependencies. For the added dependencies, you can install Renault API via pip from PyPI:
$ pip install renault-api[cli]Once installed, the following command prompts for credentials and settings, displays basic vehicle status information, and generates traces:
$ renault-api --log status- Credentials will automatically be stored in the user home directory (~/.credentials/renault-api.json)
- Logs will automatically be generated in logs subfolder
Please see the Command-line Reference for full details.
Contributions are very welcome. To learn more, see the Contributor Guide.
Distributed under the terms of the MIT license, Renault API is free and open source software.
This project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intended or accidental, as a as a result of interacting with Renault's API using this project.
If you encounter any problems, please file an issue along with a detailed description.
This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template. This project was heavily based on @jamesremuscat's PyZE python client for the Renault ZE API.