Overview - About
Stellantis B2B web API for Citroën, DS, Peugeot, Opel and Vauxhall #
This REST API implements various endpoints to retrieve resources from your vehicle. Under certain circumstances you will also be able to remote control some features of your vehicles, like opening the doors or turning AC on!
Stellantis API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) are based on open standards: OpenAPIv3, JSON, GeoJson & HAL. Using this You will be able to access a lot of your vehicle data like geolocation, fuel consumption, mileage before maintenance or even remaining time of charge.
How does it works? #
Vehicles are using various sensors which aim to improve security and driving experience.
Those sensors provide data that are available in the vehicle infotainment system. If you are interested in embedded application development, you can have a look at this section of this documentation website.
Furthermore, our web API grants you access to this data even outside the car:
Sensors are collecting data inside the vehicle and send them to Stellantis via mobile network. Our servers will then process these raw data into unified and understandable info. Furthermore, cloud storage allow you to access your data at any time even though the vehicle is turned-off.
Everything is processed on our side (Stellantis) in order to provide you (Partner) the same standard data, whatever the type of vehicles (brand new or older, regular fuel or electric consumption).
By requesting this api you will have access to various features:
|History: trips, telemetrics, notifications and collisions are useful data, maybe you will need to retrieve it, that’s why we choose to store those data and allow you to access history.|
|General info||Get a user or car general info, like brand, model, fuel type.|
|Maintenance||Stay tuned on car maintenance, time and mileage before maintenance.|
|Collision||Be notified of collisions and where it happened.|
|Trips||Browse into cars trips, departure point, arrival.|
|Alerts||Get history of in-car alerts (oil, engine, breaks etc).|
|Telemetrics||Retrieve and track vehicles telemetrics (speed*, location, fuel level, blinking lights etc).|
|Remote control||Send remote actions to your vehicle (preconditionning, honk, lights, doors…)|
|Monitor||Configure car monitoring like notification for car leaving defined area. Click here to learn more about monitors.|
|Status||Retrieve car status like last position, autonomy, open doors.|
*speed: according to country’s legislation.
Browsing and Alerts #
Our API allow you two ways to access vehicles data. You can either browse history or monitor data and receive alerts.
Request & Browse: this the way API usually operates. Request/response system allow you to retrieve various data of your fleet vehicles (example: model, fuel consumption history).
Monitoring: create your own dedicated monitors using our API. You will get notified every time a parameter changed as you specified (example: vehicle leaving a defined area). Find out more about how to use and configure monitors on this page.
We think that accessing easily and efficiently to vehicle’s data is important, that’s why we choose to design our API with up-to-date open standards.
Stellantis API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) are based on REST principles, data resources are accessed via standard HTTPS requests in UTF-8 format. We use OpenAPI v3 for specification, JSON in order to exchange data between you and your cars and HAL for naviguation.
Click here and find out more about technicals standards!
Data Refreshment #
Sensors are gathering all types of interesting data inside cars. First, these data are collected in a dedicated embedded hardware in the vehicle. Then data are sent to Stellantis’s cloud via mobile network:
- Regular refreshment: data are refreshed on a regular basis depending on sensor class and vehicle manufacturing date.
- Event refreshment: internal events happening in the vehicle could lead to a refreshment of some data, for example turn on the car.
Refreshment rates improves with vehicles bought since 2019.
See Also #
Want to see what it’s look like? Browse our Standards.
Retrieve all reference of this API, go to the API List.