Documentation

Cette page décrit l'ensemble des services web permettant d'accéder aux données sur la qualité des rivières.

Origine des données

Depuis la V1 de fin février 2018, l'ensemble des données sur la France entière (y compris les DROM) est disponible, en provenance de Naïades.


Plus de 125 millions d'analyses réparties sur 18 000 stations sont disponibles.

Exposition des données

Les données sont exposées sous la forme d'une API REST, les formats supportés sont : JSON, GeoJSON et CSV.

Pour plus d'informations sur les conditions d'utilisations, vous pouvez consulter la FAQ et les conditions générales d'utilisations.

Pour vos questions et remarques, utilisez notre forum.

Derniers changements

26/02/2018 : mise à jour de la version de l'API, passage de v0 à v1, modification de l'URL de l'API : /v0/qualite_rivieres par /v1/qualite_rivieres, pour plus d'information cf http://hubeau.eaufrance.fr/page/api-qualite-cours-deau-depreciee
29/11/2017 : ajout de dans la réponse de l'attribut api_version (string) : version de l'API (https://semver.org/)
04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/
25/10/2016 : ajout des données qualité des rivières de l'agence de l'eau Loire Bretagne
21/09/2016 : ajout des libellés SANDRE à côté des codes SANDRE dans la réponse
08/08/2016 : ajout du paramètre fields, la valeur est une liste des champs souhaités dans la réponse, par exemple fields=code_station,localisation

Accès

L'API Hub'Eau est accessible en http et https :

http:/hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&pretty

https://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&pretty

 

Pour gérer le cross-domain, l'API Hub'Eau supporte le protocole Cross Origin Resource Sharing (CORS) et pour les anciens navigateurs le JSONP avec le paramètre callback :

https://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&pretty&callback=jquery12

Pagination

Les méthodes sont paginées et suivent le même modèle de pagination.
Les paramètres de pagination sont :
- page : le numéro de page
- size : la taille de la page

Vous n'avez pas à calculer vous-même les pages précédentes et suivantes puisque les URL sont disponible dans la réponse dans les attributs prev et next. Ils seront définis à null si il n'y a pas de page précédente et/ou suivante.
L'attribut first permet d'accéder à la 1er page des résultats, l'attribut last permet d'accéder à la dernière page des résultats et l'attribut count le nombre total de résultat.
Les résultats sous forme de liste sont dans l'attribut data.

Limitations

Les résultats sont paginés avec une valeur par défaut et une valeur maximum de taille de page pour chaque opération.
Cette information est indiqué dans les commentaires de l'opération, exemple :
"La taille de page par défaut : 5000, taille max de la page : 20000."

La longueur maximale d'une URL est de 2 083 caractères, la requête est bloquée si la longueur dépasse cette limite.

Exemple

https://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&size=3&pretty

{ "count" : 7, "first" : "http://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commu...", "last" : "http://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commu...", "prev" : null, "next" : "http://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commu...", "api_version" : "1.0.0", "data" : [ { "code_station" : "04782000", "libelle_station" : "CANAL DE MARANS LA ROCHELLE À LA ROCHELLE", "uri_station" : "http://id.eaufrance.fr/STQ/04782000", "durete" : null, "coordonnee_x" : 380106.0, "coordonnee_y" : 6570510.0, "code_projection" : "26", "libelle_projection" : "RGF93 / Lambert 93", "longitude" : -1.147241678, "latitude" : 46.158788107, "code_commune" : "17300", "libelle_commune" : "LA ROCHELLE", "code_departement" : "17", "libelle_departement" : "CHARENTE-MARITIME", "code_region" : "75", "libelle_region" : "NOUVELLE-AQUITAINE", "code_cours_eau" : "N8--300G", "nom_cours_eau" : null, "uri_cours_eau" : "http://id.eaufrance.fr/CEA/N8--300G", "code_masse_deau" : "GR0925", "code_eu_masse_deau" : "FRGR0925", "nom_masse_deau" : "CANAUX DE MARANS", "uri_masse_deau" : "http://id.eaufrance.fr/MDO/GR0925", "code_eu_sous_bassin" : "FRG_LACV", "nom_sous_bassin" : "Loire aval et côtiers vendéens", "code_bassin" : "G", "code_eu_bassin" : "FRG", "nom_bassin" : "La Loire, les cours d'eau côtiers vendéens et bretons", "uri_bassin" : "http://id.eaufrance.fr/SEH/G", "type_entite_hydro" : "2", "commentaire" : null, "date_creation" : "1900-01-01", "date_arret" : null, "date_maj_information" : "2011-03-31", "finalite" : "Inconnue", "localisation_precise" : "AMONT ECLUSE VIEUX PORT", "nature" : "M", "altitude_point_caracteristique" : 0.0, "point_kilometrique" : 999654.0, "premier_mois_annee_etiage" : null, "superficie_bassin_versant_reel" : null, "superficie_bassin_versant_topo" : null, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.14724167760006, 46.1587881072281 ] } }, { "code_station" : "04782008", "libelle_station" : "CANAL DE MARANS A LA ROCHELLE A LA ROCHELLE", "uri_station" : "http://id.eaufrance.fr/STQ/04782008", "durete" : null, "coordonnee_x" : 379854.3, "coordonnee_y" : 6570462.0, "code_projection" : "26", "libelle_projection" : "RGF93 / Lambert 93", "longitude" : -1.150466139, "latitude" : 46.158237437, "code_commune" : "17300", "libelle_commune" : "LA ROCHELLE", "code_departement" : "17", "libelle_departement" : "CHARENTE-MARITIME", "code_region" : "75", "libelle_region" : "NOUVELLE-AQUITAINE", "code_cours_eau" : "N8--300G", "nom_cours_eau" : null, "uri_cours_eau" : "http://id.eaufrance.fr/CEA/N8--300G", "code_masse_deau" : "GR0925", "code_eu_masse_deau" : "FRGR0925", "nom_masse_deau" : "CANAUX DE MARANS", "uri_masse_deau" : "http://id.eaufrance.fr/MDO/GR0925", "code_eu_sous_bassin" : "FRG_LACV", "nom_sous_bassin" : "Loire aval et côtiers vendéens", "code_bassin" : "G", "code_eu_bassin" : "FRG", "nom_bassin" : "La Loire, les cours d'eau côtiers vendéens et bretons", "uri_bassin" : "http://id.eaufrance.fr/SEH/G", "type_entite_hydro" : "2", "commentaire" : null, "date_creation" : "1900-01-01", "date_arret" : null, "date_maj_information" : "2012-06-21", "finalite" : "Inconnue", "localisation_precise" : "AMONT PORTE MAUBEC", "nature" : "M", "altitude_point_caracteristique" : 0.0, "point_kilometrique" : 999917.0, "premier_mois_annee_etiage" : null, "superficie_bassin_versant_reel" : null, "superficie_bassin_versant_topo" : null, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.1504661394648, 46.158237437234 ] } }, { "code_station" : "04782009", "libelle_station" : "CANAL DE LA MOULINETTE A LA ROCHELLE", "uri_station" : "http://id.eaufrance.fr/STQ/04782009", "durete" : null, "coordonnee_x" : 380618.9, "coordonnee_y" : 6569977.0, "code_projection" : "26", "libelle_projection" : "RGF93 / Lambert 93", "longitude" : -1.140242433, "latitude" : 46.154237383, "code_commune" : "17300", "libelle_commune" : "LA ROCHELLE", "code_departement" : "17", "libelle_departement" : "CHARENTE-MARITIME", "code_region" : "75", "libelle_region" : "NOUVELLE-AQUITAINE", "code_cours_eau" : "N8205000", "nom_cours_eau" : null, "uri_cours_eau" : "http://id.eaufrance.fr/CEA/N8205000", "code_masse_deau" : null, "code_eu_masse_deau" : null, "nom_masse_deau" : null, "uri_masse_deau" : null, "code_eu_sous_bassin" : null, "nom_sous_bassin" : null, "code_bassin" : null, "code_eu_bassin" : null, "nom_bassin" : null, "uri_bassin" : null, "type_entite_hydro" : "2", "commentaire" : null, "date_creation" : "1900-01-01", "date_arret" : null, "date_maj_information" : "2012-06-21", "finalite" : "Inconnue", "localisation_precise" : "AMONT BARRAGE", "nature" : "M", "altitude_point_caracteristique" : 0.0, "point_kilometrique" : 999701.0, "premier_mois_annee_etiage" : null, "superficie_bassin_versant_reel" : null, "superficie_bassin_versant_topo" : null, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.14024243310643, 46.1542373829939 ] } } ] }