API Piézométrie

 

 

Les données de l'API "Piézométrie" sont issues du portail ADES (portail national d'accès aux données sur les eaux souterraines).

Elles portent sur les mesures de piézométrie (niveau d'eau dans les nappes d'eau souterraine), France entière, en provenance de tous les partenaires du système d'information sur l'eau (voir les métadonnées).

Les mises à jour de la banque ADES sont intégrées chaque lundi matin à l'API.

 

Console de l'API Spécification Swagger

 

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

 

 

 

Derniers changements

2018

25/07/2018 : v1.1.1 et v0.2.1

  • Mise à jour technique permettant d'augmenter la fréquence de mise à jour des données

22/05/2018 : v1.1.0

  • ajout d'une limitation sur la profondeur d'accès aux résultats, le calcul de la profondeur = numéro de la page * nombre maximum de résultats dans une page
  • ajout du header "link" pour le format CSV
  • correction code retour pour le format CSV, gère le code 200 et 206

2017

29/11/2017 : mise à jour de la version de l'API : passage de v0 à v1

  • modification de l'URL de l'API : /v0/niveaux_aquiferes par /v1/niveaux_nappes, (pour plus d'informations : http://hubeau.eaufrance.fr/page/api-piezometrie-depreciee)
  • ajout dans la réponse de l'attribut api_version (string) : version de l'API (https://semver.org/)

04/10/2017 : ajout du paramètre "sort" sur l'opération "chroniques", permet de changer l'ordre de tri (asc ou desc) sur la date de mesure piézométrique
04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/

2016

24/11/2016 : ajout de l'attribut "timestamp_mesure" sur l'opération "chroniques" de l'API sur le niveau des aquifères
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 (fonctionnalité expérimentale), par exemple fields=code_station,localisation

 

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 "Piézométrie" est accessible :

 

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

 

Pagination

Les méthodes suivent toutes le même modèle de pagination.

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.

Taille de l'URL

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.

 

Opérations (endpoints)

L'API "Piézométrie" propose différentes opérations :

  • l'opération chroniques permet d'accéder aux chroniques piézométriques (évolution dans le temps du niveau des nappes) par station de mesure
  • l'opération stations permet d'accéder aux stations de mesure des niveaux des nappes d'eau (piézomètres)

 

Exemple

Demande :

Lister les piézomètres présents dans les communes de Calais (code INSEE commune = 62193), Bourbourg (code=59094) et Orléans (code=45234).

 

URL appelée :

http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=62193,59094,45234&size=2&format=json&pretty

 

Résultats :

Voir les résultats

 

Console de l'API

 

Dernière mise à jour le 09.08.2018