{"id":27157130,"url":"https://github.com/remscodes/renault-api","last_synced_at":"2025-10-08T14:24:55.265Z","repository":{"id":194044058,"uuid":"689982219","full_name":"remscodes/renault-api","owner":"remscodes","description":"Resources url and models to use the Renault API","archived":false,"fork":false,"pushed_at":"2025-08-23T10:55:22.000Z","size":143,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-23T19:24:35.566Z","etag":null,"topics":["api","docs","models","renault"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/remscodes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-09-11T09:58:44.000Z","updated_at":"2025-08-23T10:55:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"924255b8-2f3b-4103-b0f5-a82130d4d011","html_url":"https://github.com/remscodes/renault-api","commit_stats":null,"previous_names":["remscodes/renault-api"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/remscodes/renault-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remscodes%2Frenault-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remscodes%2Frenault-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remscodes%2Frenault-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remscodes%2Frenault-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remscodes","download_url":"https://codeload.github.com/remscodes/renault-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remscodes%2Frenault-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278957690,"owners_count":26075506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docs","models","renault"],"created_at":"2025-04-08T20:53:39.181Z","updated_at":"2025-10-08T14:24:55.259Z","avatar_url":"https://github.com/remscodes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ch1\u003eRenault API\u003c/h1\u003e\n    \u003cp\u003eResources url and models to use the Renault API\u003c/p\u003e\n\u003c/div\u003e \n\n\u003cdiv align=\"center\"\u003e\n\n[![github ci](https://img.shields.io/github/actions/workflow/status/remscodes/renault-api/npm-ci.yml.svg?logo=github\u0026label=CI\u0026style=for-the-badge)](https://github.com/remscodes/renault-api/actions/workflows/npm-ci.yml)\n[![npm version](https://img.shields.io/npm/v/@remscodes/renault-api.svg?style=for-the-badge\u0026logo=npm)](https://www.npmjs.org/package/@remscodes/renault-api)\n[![license](https://img.shields.io/github/license/remscodes/renault-api.svg?style=for-the-badge)](LICENSE)\n\n\u003c/div\u003e\n\n\u003e Get everything you need to use the Renault API into a TypeScript/JavaScript project.\n\n## Installation\n\n```shell\nnpm install @remscodes/renault-api\n```\n\n## Usage\n\nUse `GigyaApi` or `KamereonApi` properties to get the url you want.\n\nEach property has its own __JSDoc__ to describe what the corresponding request needs to work.\n\nExamples :\n\n```ts\nimport { GigyaApi, LoginInfoResponse } from '@remscodes/renault-api';\n\nconst url = new URL(GigyaApi.LOGIN_URL);\nurl.searchParams.set('apikey', GigyaApi.KEY);\nurl.searchParams.set('loginID', 'my-renault-login');\nurl.searchParams.set('password', 'my-renault-password');\n\nconst response: LoginInfoResponse = await fetch(url, { method: 'POST' }).then(r =\u003e r.json());\nconst { cookieValue } = response.sessionInfo;\n```\n\n```ts\nimport { BatteryStatusResponse, KamereonApi } from '@remscodes/renault-api';\n\nconst accountId = 'a1b2c3d4-xxxxxxxx';\nconst vin = 'VF1XXXXXXXXXXX';\n\nconst url = new URL(KamereonApi.READ_BATTERY_STATUS_URL(accountId, vin));\nurl.searchParams.set('country', 'FR');\n\nconst headers = {\n  apikey: KamereonApi.KEY,\n  'x-gigya-id_token': 'my-token',\n};\n\nconst response: BatteryStatusResponse = await fetch(url, { method: 'GET', headers }).then(r =\u003e r.json());\n\nconst { batteryLevel, batteryTemperature } = response.data.attributes;\n```\n\n## Disclaimer\n\nThis 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.\n\n## Credit\n\nResources API based on [Renault API](https://github.com/hacf-fr/renault-api) (hacf-fr) and [PyZE](https://github.com/jamesremuscat/pyze) (jamesremuscat).\n\n## License\n\n[MIT](LICENSE) © Rémy Abitbol.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremscodes%2Frenault-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremscodes%2Frenault-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremscodes%2Frenault-api/lists"}