L'API "Hydrobiologie" diffuse les données de peuplement des cours d'eau bancarisées par le portail NAIADES.
Les données hydrobiologiques concernent :
N'hésitez pas à faire remonter toute demande sur le forum de contribution Github.
Le tableau de bord de la santé des API permet de connaitre en temps réel l'état de l'ensemble des endpoints.
Les formats supportés sont : JSON, GeoJSON et CSV.
L'API "Hydrobiologie" est accessible :
Pour gérer le cross-domain, l'API supporte les protocoles :
Chaque page renvoie un nombre de résultats égal au paramètre size.
L'API Hydrobiologie utilise un type de pagination non séquentiel qui permet de sauter d'une page à l'autre de résultats dans n'importe quel ordre. En contre-partie, la profondeur d'accès aux résultats est limitée.
Paramètres
Attributs
Un tutoriel sur l'API Qualité des cours d'eau explique, dans la partie Taille des pages de réponse, la mise en oeuvre pratique de la pagination à l'aide d'un cas concret.
Enfin, des exemples de code en Python, R et php sont disponibles dans la partie Exemples de la page de contribution GitHub de Hub'Eau.
La longueur maximale d'une URL est de 2 083 caractères, la requête est bloquée si la limite de longueur est dépassée.
L'API "Hydrobiologie" propose actuellement 3 opérations :
Recherche de toutes les stations hydrobiologiques du Loiret :
https://hubeau.eaufrance.fr/api/v1/hydrobio/stations_hydrobio?code_departement=45
Recherche de toutes les stations en service au 1er janvier 2018 où a été identifié le taxon Rhabdiopteryx (code SANDRE de cette appellation de taxon = 10) :
https://hubeau.eaufrance.fr/api/v1/hydrobio/stations_hydrobio?codes_appel_taxons=10&size=10&date_service=2018-01-01
Recherche des indices biologiques par rayon autour d'un point (10 km de distance autour du point de latitude 45° et de longitude 6°) :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?distance=10&format=json&latitude=45&longitude=6&size=20
Recherche de tous les indices biologiques concernant les diatomées (dont le code SANDRE support = 10) :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?size=10&code_support=10
Recherche de tous les Indices Biologiques Diatomées (IBD, code SANDRE=5856) dont la valeur est comprise entre 12 et 13 :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?code_indice=5856&format=json&resultat_indice_min=12&resultat_indice_max=13&size=50
Recherche de tous les indices IBMR :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?libelle_indice=IBMR
Limitation aux résultats dont la qualification est correcte :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?libelle_indice=IBMR&code_qualification=1
Recherche de tous les résultats d'indices biologiques concernant la station 03000070 :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?code_station_hydrobio=03000070
Limitation des résultats à quelques champs (paramètre fields) :
https://hubeau.eaufrance.fr/api/v1/hydrobio/indices?code_station_hydrobio=03000070&fields=code_indice,libelle_indice,date_prelevement,resultat_indice
Recherche de tous les taxons identifiés lors de l'année 2015 :
https://hubeau.eaufrance.fr/api/v1/hydrobio/taxons?date_debut_prelevement=2015-01-01&date_fin_prelevement=2016-01-01
Recherche de tous les taxons Anguille (code SANDRE appellation de taxon = 2038) :
https://hubeau.eaufrance.fr/api/v1/hydrobio/taxons?code_appel_taxon=2038