From 718e6b82cad5e826438a3b86da429535064bb617 Mon Sep 17 00:00:00 2001 From: Frank Villaro-Dixon Date: Tue, 29 Oct 2024 23:11:51 +0100 Subject: [PATCH] add basic readme Signed-off-by: Frank Villaro-Dixon --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2732e28 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Rust RTE France + +This is an api around the French TSO [RTE](https://rte-france.com). + +The main endpoints [live here](https://data.rte-france.com). + + +## Provided APIs + + +### Generation forecast API + +### Consumption forecast API + +## Authentication + +To use the API, you need to register an account in RTE's system (free). + +Then you need to create an application. To do that, + +- Go to [this application](https://data.rte-france.com/catalog/-/api/consumption/Consumption/v1.2) +- Click on "Abonnez vous à l'API" +- Fill the "Créer une application" form +- Then go to you application [here](https://data.rte-france.com/group/guest/apps) +- And copy the Client ID and Client Secret + +These two variables need to be set as environment values: + +- `CLIENT_ID` +- `CLIENT_SECRET` +