Description
Les données de l'API "Hydrométrie" de Hub'Eau sont issues de la Plate-forme HYDRO Centrale (PHyC), opérée par le Service Central d’Hydrométéorologie et d’Appui à la Prévision des Inondations (SCHAPI).
Cette Plate-forme stocke les mesures quasi temps-réel provenant d’environ 3000 stations hydrométriques qui constituent le réseau de mesure français, opéré par les Directions Régionales de l’Environnement de l’Aménagement et du Logement (DREAL) ou autres producteurs (collectivités, etc.) ainsi que deux types d'observations élaborées (débits moyens journaliers et débits moyens mensuels.
Exemples d’application
Description fonctionnelle de l'API Hydrométrie
L'API permet d'interroger le référentiel hydrométrique ainsi que les observations en quasi temps réel, mises à jour par leur producteur toutes les 5 à 60 minutes dans la plateforme source (PHyC du SCHAPI). Hub'Eau interroge la source des données toutes les 2 minutes et maintient une profondeur d'historique égale à 1 mois. Depuis le 24 novembre 2021, deux types d'observations "élaborées" (débits moyens journaliers et débits moyens mensuels) sont dorénavant disponibles sur tout l'historique (depuis 1900 pour certaines stations) pour plus de 4200 stations. Les données sont mises à jour quotidiennement.
Les observations sont exprimées en mm pour les hauteurs d'eau et en l/s pour les débits.
Quatre opérations (endpoints) sont disponibles :
- sites : interroge les sites du référentiel hydrométrique ;
- stations : interroge les stations du référentiel hydrométrique constituant les sites ;
- obervations_tr : liste les observations dites "temps réel" portées par le référentiel (sites et stations hydrométriques), à savoir les séries de données de hauteur d'eau (H) et de débit (Q) ;
- obs_elab : liste 2 types d'observations dites "élaborées" : les débits moyens journaliers (QmJ) ainsi que les débits moyens mensuels (QmM) sur l'ensemble de l'historique disponible.
Les données sont exposées sous la forme d'une API REST, les formats supportés sont : JSON, GeoJSON, CSV et XML SANDRE.
Dernières évolutions de l'API Hydrométrie :
- 24/11/2021 : Mise à disposition des opérations Observations élaborées (débits moyens journaliers et mensuels) aux formats JSON et CSV.
- 05/03/2020 : passage sur serveur dédié pour tenir la charge (10 appels/s en moyenne)
- 03/01/2019 : v1.0.1 : correction bug sur l'API observations
- 03/12/2018 : suppression de la version beta, passage en production de la v1
- 29/11/2018 : endpoints observations : ajout du paramètre timestep permettant la récupération de données à un pas de temps déterminé
Connaissez-vous Hub'Eau ?
Simplifier l'accès aux données sur l'eau
Service pérenne de la toile Eau France, Hub'Eau met à disposition des API Rest favorisant l’accès aux données du SIE dans des formats simples d’emploi et propices à la réutilisation (CSV, JSON, GeoJSON). Fondé sur une infrastructure et des méthodes adaptées au traitement et au stockage de données massives, les API Hub'Eau garantissent les meilleures performances de disponibilité (20 téra-octets de données fournies en 455 millions d'appels pour l'année 2020). Hub’Eau est le résultat de la collaboration de l’OFB et du BRGM dans le cadre du pôle de recherche et d'innovation en interopérabilité des systèmes d'information distribués sur l'eau : INSIDE.
Pour découvrir toutes les API disponibles dans Hub'Eau, visitez la page Hub'Eau sur api.gouv ou directement le portail Hub'Eau.
Un service en co-construction
Pour des API toujours plus en phase avec les besoins utilisateurs, Hub'Eau a inauguré en 2018 une politique de bêta testing en organisant une campagne de tests ouverte avant la mise la mise en production de chaque nouvelle API. D'une durée de quelques mois, ces campagnes ont pour objectif de recueillir un maximum de retour d’expérience des utilisateurs sur les points forts et les points faibles des API en construction. Les retours se font sur le forum de contribution GitHub. Pour être informé de la sortie des nouvelles API et les tester en avant-première, inscrivez-vous à la newsletter !
Exemples de réutilisation
- Géorivière, gérez et suivez vos cours d'eau
- La vie de la rivière
- Alerte Inondation
- Visualiseur Hub'Eau des débits et hauteurs en temps réel
- Visualiseur Hub'Eau des observations hydrométriques élaborées
- Soumettez le votre sur la page GitHub des utilisateurs de Hub'Eau
Glossaire
grandeur hydrométrique
Type de donnée restituée par une station hydrométrique (hauteur d'eau, débit ou vitesse). Deux grandeurs hydrométriques sont disponibles via l'opération "observations_tr" de Hub'Eau : la hauteur d'eau et le débit.
référentiel hydrométrique
Le référentiel hydrométrique est constitué de sites, de stations et de capteurs.
SCHAPI
Basé sur la Météopole de Toulouse, le SCHAPI (Service Central d'Hydrométéorologie et d'Appui à la Prévision des Inondations) produit et diffuse une information continue de vigilance sur les crues publiée sur le site Vigicrues. Il anime et pilote le réseau de la prévision des crues et de l’hydrométrie de l’État (Services de Prévision des Crues et Unités d’Hydrométrie rattachés aux services régionaux DREAL ou à la direction inter-régionale Sud-Est de Météo-France).
site hydrométrique
Un site hydrométrique est un tronçon de cours d'eau sur lequel les mesures de débit sont réputées homogènes et comparables entre elles. Un site peut posséder une ou plusieurs stations et il ne peut porter que des données de débit.
station hydrométrique
Un appareillage installé sur un site hydrométrique afin d'observer et de mesurer une grandeur spécifique lié à l'hydrologie (hauteur ou débit) constitue une station hydrométrique. Une station peut porter une hauteur et/ou un débit (directement mesurés ou calculés à partir d'une courbe de tarage). Chaque station possède un ou plusieurs capteurs (appareil mesurant une grandeur : hauteur ou débit). Les méthodes de l'API hydrometrie de Hub'Eau permettent d'interroger les sites et les stations hydrométriques mais ne descendent pas au niveau des capteurs.