• Présentation

    Les données de l'API Prélèvements en eau sont issues de la gestion des redevances par les agences et offices de l’eau.

    Cela implique que :

    • les volumes prélevés pour des usages exonérés de redevance ne sont pas connus ;
    • les petits volumes de prélèvement sont peu connus (les volumes inférieurs à 10 000 m3 n'étant pas déclarés au titre de la redevance pour prélèvement) ;

    Concernant le département de Mayotte, en l’absence d’office de l’eau, les données sont fournies par la DEAL.

    Concernant les départements de Guyane et de Mayotte, seules les données pour l’usage AEP sont fournies.

    Référentiel

    Le référentiel sur lequel s'appuient les informations est constitué d'ouvrages et de points de prélèvements :

    • un ouvrage de prélèvement désigne un ensemble de dispositifs techniques de captage, de stockage et de canalisation d'eau, provenant d'une ressource et à destination d'un usage principal. L’ouvrage est connecté à une seule ressource en eau, par l'intermédiaire d'un ou plusieurs points de prélèvement géographiquement individualisés, lorsque ces derniers sont connus et bien identifiés ;
    • un point de prélèvement matérialise un point de connexion physique entre la ressource en eau et un dispositif technique de captage d'eau se rapportant à l'ouvrage de prélèvement en question. Par définition, un point de prélèvement est donc rattaché à un seul et unique ouvrage de prélèvement.
  • Derniers changements

    L'API est actuellement en version beta.

    Les données et fonctionnalités de l'API, ainsi que les textes et définitions de cette page peuvent évoluer à tout moment.


    Une des limitations principales de cette version beta est l'absence de coordonnées géographiques (toutes les coordonnées sont fictives) : les fonctions de recherche géographique par bounding box ou rayon ne fonctionnent donc pas.


    Pendant cette période de test, nous vous invitons à faire remonter toute demande de correction ou tout besoin non satisfait sur le forum de contribution Github.

  • Exposition des données

    Les formats supportés sont : JSON, GeoJSON et CSV.

  • Accessibilité

  • Pagination

    Chaque page renvoie un nombre de résultats égal au paramètre size.

    L'API Prélèvements en eau 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
    • 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.
    Pour en savoir plus
    • Consulter le tutoriel sur l'API Qualité des cours d'eau qui explique, dans la section Taille des pages de réponse, la mise en oeuvre pratique de la pagination à l'aide d'un cas concret.
    • Consulter les exemples de code en Python, R et php proposés dans la section Exemples de la page de contribution GitHub de Hub'Eau.
  • Limitations

    Pagination
    • 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.
    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

    Opération chroniques

    Cette opération (Lister les chroniques annuelles de volumes prélevés) permet de récupérer les volumes annuels d'eau prélevés par ouvrages.

    Opération ouvrages

    Cette opération (Lister les ouvrages de prélèvement en eau) permet de récupérer la description des ouvrages de prélèvement, un ouvrage étant composé d'un ou plusieurs points de prélèvement proches, de même type, captant la même ressource en eau, destinés au même usage principal et placés sous la propriété d'un même maître d'ouvrage. Les données de volumes annuels prélevés sont rattachées aux ouvrages et non aux points de prélèvement.

    Opération points_prelevement

    Cette opération (Lister les points de prélèvement en eau) permet de récupérer la description des points de prélèvement. Un point de prélèvement fait obligatoirement partie d'un ouvrage. Il peut constituer un ouvrage à lui seul, ou bien être accompagné d'autres points de prélèvement.

  • Exemple

    Exemple 1

    Demande

    Trouver tous les points de prélèvements référencés sur la commune de Custines.

    URL appelée

    http://hubeau.eaufrance.fr/api/vbeta/prelevements/referentiel/points_prelevement?format=json&nom_commune=Custines&size=20

    Résultat

    {
      "count" : 4,
      "first" : "http://hubeau.eaufrance.fr/api/vbeta/prelevements/referentiel/points_prelevement?format=json&nom_commune=Custines&pretty&page=1&size=20",
      "last" : null,
      "prev" : null,
      "next" : null,
      "api_version" : "1.0.1",
      "data" : [ {
        "code_point_prelevement" : "PTP000000000165920",
        "nom_point_prelevement" : "SOURCE DE RECHANOIS",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "code_type_milieu" : "SOUT",
        "libelle_type_milieu" : "Souterrain",
        "code_nature" : "P",
        "libelle_nature" : "PHYSIQUE",
        "lieu_dit" : null,
        "code_precision_coord" : 5,
        "libelle_precision_coord" : null,
        "commentaire" : null,
        "code_commune_insee" : "54150",
        "nom_commune" : "Custines",
        "code_departement" : "54",
        "libelle_departement" : "Meurthe-et-Moselle",
        "code_entite_hydro_cours_eau" : null,
        "code_entite_hydro_plan_eau" : null,
        "code_zone_hydro" : null,
        "code_mer_ocean" : null,
        "code_entite_hydrogeo" : null,
        "nappe_accompagnement" : true,
        "uri_bss_point_eau" : "http://services.ades.eaufrance.fr/pointeau/01945X0044/HY",
        "longitude" : 2.415447,
        "latitude" : 46.752976,
        "code_ouvrage" : "OPR0000000076",
        "geometry" : {
          "type" : "Point",
          "crs" : {
            "type" : "name",
            "properties" : {
              "name" : "urn:ogc:def:crs:OGC:1.3:CRS84"
            }
          },
          "coordinates" : [ 2.415447, 46.752976 ]
        },
        "code_bss_point_eau" : "01945X0044/HY"
      }, {
        "code_point_prelevement" : "PTP000000000165921",
        "nom_point_prelevement" : "SOURCE DU TROU DE MINE: CHAMBRE N�1 - 1 DRAIN",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "code_type_milieu" : "SOUT",
        "libelle_type_milieu" : "Souterrain",
        "code_nature" : "P",
        "libelle_nature" : "PHYSIQUE",
        "lieu_dit" : null,
        "code_precision_coord" : 5,
        "libelle_precision_coord" : null,
        "commentaire" : null,
        "code_commune_insee" : "54150",
        "nom_commune" : "Custines",
        "code_departement" : "54",
        "libelle_departement" : "Meurthe-et-Moselle",
        "code_entite_hydro_cours_eau" : null,
        "code_entite_hydro_plan_eau" : null,
        "code_zone_hydro" : null,
        "code_mer_ocean" : null,
        "code_entite_hydrogeo" : null,
        "nappe_accompagnement" : true,
        "uri_bss_point_eau" : "http://services.ades.eaufrance.fr/pointeau/01945X0087/HY",
        "longitude" : 2.415447,
        "latitude" : 46.752976,
        "code_ouvrage" : "OPR0000000077",
        "geometry" : {
          "type" : "Point",
          "crs" : {
            "type" : "name",
            "properties" : {
              "name" : "urn:ogc:def:crs:OGC:1.3:CRS84"
            }
          },
          "coordinates" : [ 2.415447, 46.752976 ]
        },
        "code_bss_point_eau" : "01945X0087/HY"
      }, {
        "code_point_prelevement" : "PTP000000000165922",
        "nom_point_prelevement" : "SOURCE DE FRANCHE LIMONT CHAMBRE A",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "code_type_milieu" : "SOUT",
        "libelle_type_milieu" : "Souterrain",
        "code_nature" : "P",
        "libelle_nature" : "PHYSIQUE",
        "lieu_dit" : null,
        "code_precision_coord" : 5,
        "libelle_precision_coord" : null,
        "commentaire" : null,
        "code_commune_insee" : "54150",
        "nom_commune" : "Custines",
        "code_departement" : "54",
        "libelle_departement" : "Meurthe-et-Moselle",
        "code_entite_hydro_cours_eau" : null,
        "code_entite_hydro_plan_eau" : null,
        "code_zone_hydro" : null,
        "code_mer_ocean" : null,
        "code_entite_hydrogeo" : null,
        "nappe_accompagnement" : true,
        "uri_bss_point_eau" : "http://services.ades.eaufrance.fr/pointeau/01945X0045/HY",
        "longitude" : 2.415447,
        "latitude" : 46.752976,
        "code_ouvrage" : "OPR0000000078",
        "geometry" : {
          "type" : "Point",
          "crs" : {
            "type" : "name",
            "properties" : {
              "name" : "urn:ogc:def:crs:OGC:1.3:CRS84"
            }
          },
          "coordinates" : [ 2.415447, 46.752976 ]
        },
        "code_bss_point_eau" : "01945X0045/HY"
      }, {
        "code_point_prelevement" : "PTP000000000165923",
        "nom_point_prelevement" : "OEN0007123",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "code_type_milieu" : "SOUT",
        "libelle_type_milieu" : "Souterrain",
        "code_nature" : "F",
        "libelle_nature" : "FICTIF",
        "lieu_dit" : null,
        "code_precision_coord" : 5,
        "libelle_precision_coord" : null,
        "commentaire" : null,
        "code_commune_insee" : "54150",
        "nom_commune" : "Custines",
        "code_departement" : "54",
        "libelle_departement" : "Meurthe-et-Moselle",
        "code_entite_hydro_cours_eau" : null,
        "code_entite_hydro_plan_eau" : null,
        "code_zone_hydro" : null,
        "code_mer_ocean" : null,
        "code_entite_hydrogeo" : null,
        "nappe_accompagnement" : true,
        "uri_bss_point_eau" : null,
        "longitude" : 2.415447,
        "latitude" : 46.752976,
        "code_ouvrage" : "OPR0000001939",
        "geometry" : {
          "type" : "Point",
          "crs" : {
            "type" : "name",
            "properties" : {
              "name" : "urn:ogc:def:crs:OGC:1.3:CRS84"
            }
          },
          "coordinates" : [ 2.415447, 46.752976 ]
        },
        "code_bss_point_eau" : null
      } ]
    }

     

    Exemple 2 :

    Demande

    Trouver les points de prélèvements situés à Custines selon différents critères et limites :

    • ressource = souterraine, nature = physique et statut à la date du 1er janvier 2010 = en exploitation
    • limiter les résultats aux champs : code_point_prelevement, nom_point_prelevement, code_ouvrage, libelle_nature, libelle_type_milieu, date_exploitation_debut et date_exploitation_fin

    URL appelée

    http://hubeau.eaufrance.fr/api/vbeta/prelevements/referentiel/points_prelevement?code_nature=P&code_type_milieu=SOUT&date_exploitation=2010-01-01&fields=code_point_prelevement,nom_point_prelevement,code_ouvrage,libelle_nature,libelle_type_milieu,date_exploitation_debut,date_exploitation_fin&format=json&nom_commune=Custines&size=20

    Résultat

    {
      "count" : 3,
      "first" : "http://hubeau.eaufrance.fr/api/vbeta/prelevements/referentiel/points_prelevement?code_nature=P&code_type_milieu=SOUT&date_exploitation=2010-01-01&fields=code_point_prelevement,nom_point_prelevement,code_ouvrage,libelle_nature,libelle_type_milieu,date_exploitation_debut,date_exploitation_fin&format=json&nom_commune=Custines&pretty&page=1&size=20",
      "last" : null,
      "prev" : null,
      "next" : null,
      "api_version" : "1.0.1",
      "data" : [ {
        "code_point_prelevement" : "PTP000000000165920",
        "nom_point_prelevement" : "SOURCE DE RECHANOIS",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "libelle_type_milieu" : "Souterrain",
        "libelle_nature" : "PHYSIQUE",
        "code_ouvrage" : "OPR0000000076"
      }, {
        "code_point_prelevement" : "PTP000000000165921",
        "nom_point_prelevement" : "SOURCE DU TROU DE MINE: CHAMBRE N�1 - 1 DRAIN",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "libelle_type_milieu" : "Souterrain",
        "libelle_nature" : "PHYSIQUE",
        "code_ouvrage" : "OPR0000000077"
      }, {
        "code_point_prelevement" : "PTP000000000165922",
        "nom_point_prelevement" : "SOURCE DE FRANCHE LIMONT CHAMBRE A",
        "date_exploitation_debut" : 1900-01-01T00:00:00Z,
        "date_exploitation_fin" : null,
        "libelle_type_milieu" : "Souterrain",
        "libelle_nature" : "PHYSIQUE",
        "code_ouvrage" : "OPR0000000078"
      } ]
    }

     

    Exemple 3 :

    Demande

    Connaître les caractéristiques de l'ouvrage de prélèvement de code OPR0000000076 qui apparaît dans les résultats précédents.

    URL appelée

    http://hubeau.eaufrance.fr/api/vbeta/prelevements/referentiel/ouvrages?code_ouvrage=OPR0000000076&format=json&size=20

    Résultat

    {
      "count": 1,
      "first": "http://hubeau.eaufrance.fr/api/vbeta/prelevements/referentiel/ouvrages?code_ouvrage=OPR0000000076&format=json&page=1&size=20",
      "last": null,
      "prev": null,
      "next": null,
      "api_version": "1.0.1",
      "data": [
        {
          "geometry": {
            "type": "Point",
            "crs": {
              "type": "name",
              "properties": {
                "name": "urn:ogc:def:crs:OGC:1.3:CRS84"
              }
            },
            "coordinates": [
              2.415447,
              46.752976
            ]
          },
          "code_ouvrage": "OPR0000000076",
          "nom_ouvrage": "CNE DE CUSTINES",
          "date_exploitation_debut": 1900-01-01T00:00:00Z,
          "date_exploitation_fin": null,
          "code_precision_coord": 5,
          "libelle_precision_coord": "Coordonnées du centroïde de la commune",
          "commentaire": null,
          "code_usage_second_niveau": "5",
          "libelle_usage_second_niveau": "AEP",
          "code_commune_insee": "54150",
          "nom_commune": "Custines",
          "code_departement": "54",
          "libelle_departement": "Meurthe-et-Moselle",
          "code_type_milieu": "SOUT",
          "libelle_type_milieu": "Souterrain",
          "code_entite_hydro_cours_eau": null,
          "code_entite_hydro_plan_eau": null,
          "code_mer_ocean": null,
          "code_entite_hydrogeo": [
            "207t"
          ],
          "longitude": 2.415447,
          "latitude": 46.752976,
          "code_point_prelevement": [
            "PTP000000000165920"
          ]
        }
      ]
    }

     

    Exemple 4 :

    Demande

    Obtenir les volumes prélevés annuellement sur l'ouvrage de prélèvement de code OPR0000000076 selon différents critères et limites :

    • qualification des données = correcte,
    • limiter les résultats aux champs : en ne rapatriant que les champs code_ouvrage, annee et volume :

    URL appelée

    http://hubeau.eaufrance.fr/api/vbeta/prelevements/chroniques?code_ouvrage=OPR0000000076&code_qualification_volume=1&fields=code_ouvrage,annee,volume&format=json&size=20

    Résultat

    {
      "count": 4,
      "first": "http://hubeau.eaufrance.fr/api/vbeta/prelevements/chroniques?code_ouvrage=OPR0000000076&code_qualification_volume=1&fields=code_ouvrage,annee,volume&format=json&page=1&size=20",
      "last": null,
      "prev": null,
      "next": null,
      "api_version": "1.0.1",
      "data": [
        {
          "code_ouvrage": "OPR0000000076",
          "annee": 2012,
          "volume": 147947
        },
        {
          "code_ouvrage": "OPR0000000076",
          "annee": 2013,
          "volume": 134065
        },
        {
          "code_ouvrage": "OPR0000000076",
          "annee": 2014,
          "volume": 120080
        },
        {
          "code_ouvrage": "OPR0000000076",
          "annee": 2016,
          "volume": 172655
        }
      ]
    }

     

    Exemple 5 :

    Demande

    Obtenir les volumes prélevés annuellement dans tout le département de Meurthe et Moselle.

    URL appelée

    http://hubeau.eaufrance.fr/api/vbeta/prelevements/chroniques?code_departement=54&format=json&size=2000

    Résultat

    Il y a 1723 données qui répondent à ces critères.