https://github.com/remscodes/renault-api

Resources url and models to use the Renault API
https://github.com/remscodes/renault-api

api docs models renault

Last synced: 8 months ago
JSON representation

Resources url and models to use the Renault API

• Host: GitHub
• URL: https://github.com/remscodes/renault-api
• Owner: remscodes
• License: mit
• Created: 2023-09-11T09:58:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-08-23T10:55:22.000Z (10 months ago)
• Last Synced: 2025-09-23T19:24:35.566Z (9 months ago)
• Topics: api, docs, models, renault
• Language: TypeScript
• Homepage:
• Size: 140 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    
Renault API

    
Resources url and models to use the Renault API

 




[![github ci](https://img.shields.io/github/actions/workflow/status/remscodes/renault-api/npm-ci.yml.svg?logo=github&label=CI&style=for-the-badge)](https://github.com/remscodes/renault-api/actions/workflows/npm-ci.yml)

[![npm version](https://img.shields.io/npm/v/@remscodes/renault-api.svg?style=for-the-badge&logo=npm)](https://www.npmjs.org/package/@remscodes/renault-api)

[![license](https://img.shields.io/github/license/remscodes/renault-api.svg?style=for-the-badge)](LICENSE)



> Get everything you need to use the Renault API into a TypeScript/JavaScript project.

## Installation

```shell

npm install @remscodes/renault-api

```

## Usage

Use `GigyaApi` or `KamereonApi` properties to get the url you want.

Each property has its own __JSDoc__ to describe what the corresponding request needs to work.

Examples :

```ts

import { GigyaApi, LoginInfoResponse } from '@remscodes/renault-api';

const url = new URL(GigyaApi.LOGIN_URL);

url.searchParams.set('apikey', GigyaApi.KEY);

url.searchParams.set('loginID', 'my-renault-login');

url.searchParams.set('password', 'my-renault-password');

const response: LoginInfoResponse = await fetch(url, { method: 'POST' }).then(r => r.json());

const { cookieValue } = response.sessionInfo;

```

```ts

import { BatteryStatusResponse, KamereonApi } from '@remscodes/renault-api';

const accountId = 'a1b2c3d4-xxxxxxxx';

const vin = 'VF1XXXXXXXXXXX';

const url = new URL(KamereonApi.READ_BATTERY_STATUS_URL(accountId, vin));

url.searchParams.set('country', 'FR');

const headers = {

  apikey: KamereonApi.KEY,

  'x-gigya-id_token': 'my-token',

};

const response: BatteryStatusResponse = await fetch(url, { method: 'GET', headers }).then(r => r.json());

const { batteryLevel, batteryTemperature } = response.data.attributes;

```

## Disclaimer

This project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intentional or accidental, resulting from interaction with the Renault's API using this project.

## Credit

Resources API based on [Renault API](https://github.com/hacf-fr/renault-api) (hacf-fr) and [PyZE](https://github.com/jamesremuscat/pyze) (jamesremuscat).

## License

[MIT](LICENSE) © Rémy Abitbol.