API Température des cours d'eau

 

API Température des cours d'eau

 

L'API "Température des cours d'eau" permet d'interroger les données de températures relevées par des capteurs automatiques posés dans les cours d'eau de France métropolitaine.
Ces capteurs enregistrent la température à des fréquences variant de une minute à quelques heures.

Les données proviennent de la banque de données Naïades. Elles sont mises à jour trimestriellement.

 

Console de l'API Spécification Swagger                                                              

 

Faites-nous part de vos commentaires sur le forum de contribution Github

 

 

Derniers changements

  • 30/07/2018 : publication de la version 1 ;
  • 14/06/2018 : publication de la version bêta-1, correction bug chroniques.csv ;
  • 31/05/2018 : publication de la version bêta-0.

 

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.

 

Accessibilité

L'API Hub'Eau est accessible :

 

Pour gérer le cross-domain, l'API supporte les protocoles :

 

Pagination

Les opérations sont paginées et suivent le même modèle de pagination non séquentiel, permettant 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

  • page : le numéro de page
  • size : la taille de la page

Attributs

  • Les attributs prev et next (définis à null si il n'y a pas de page précédente et/ou suivante) sont disponibles dans l'URL de la réponse pour éviter d'avoir à calculer les pages précédentes et/ou suivantes
  • L'attribut first permet d'accéder à la première page des résultats,
  • L'attribut last permet d'accéder à la dernière page des résultats,
  • L'attribut count permet de compter le nombre total de résultats,
  • L'attribut data permet d'accéder aux résultats sous forme de liste.

Limitations

  • Taille de page : 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 valeur est indiquée dans les commentaires de l'opération. Par exemple : "taille de page par défaut : 5000, taille max de la page : 20000."
  • Profondeur d'accès aux résultats : la profondeur d'accès aux résultats (numéro de la page * nombre maximum de résultats dans une page) est limitée à 20 000 enregistrements. Cette limite peut empêcher la récupération de l'intégralité des résultats d'une requête ; il faut alors découper la requête en plusieurs requêtes à l'aide de critères plus discriminants.
  • Longueur maximale de l'URL : 2 083 caractères. La requête est bloquée si la longueur dépasse cette limite.

 

Opérations (endpoints)

Les différentes opérations possibles (endpoints) sont :

  • stations, permettant de rechercher les stations sur lesquelles sont mesurées les températures en continu dans les cours d'eau ;
  • chroniques, permettant de rechercher les chroniques de températures en continu dans les cours d'eau mesurées aux différentes stations.

 

Exemple

Demande :

Récupérer les stations de mesure de la température en continu dans le département du Loiret.

 

URL appelée :

http://hubeau.eaufrance.fr/api/v1/temperature/station?code_departement=45&size=20&exact_count=true&format=json&pretty

 

Résultats :

Voir les résultats

 

Console de l'API

 

Dernière mise à jour le 09.08.2018