Documentation

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

Origine des données

Les données sont issues du site image.eaufrance.fr ; il s'agit des données de taille et de poids des poissons pêchés avec des pêches électriques. Elles proviennent essentiellement de l'AFB (anciennement Onema, anciennement CSP).

les métadonnées sont accessibles à :

http://www.data.eaufrance.fr/jdd/9790c56c-eb4a-452b-bf15-a76757d514de

et http://www.data.eaufrance.fr/jdd/139f04ba-e58e-4cfd-8b6d-388ef6f91672

Ces données ne sont plus mises à jour sur le site Image depuis 2013.

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.

Les différentes opérations possibles sont :

  • code_espece_poisson : obtenir les correspondances des codes des espèces de poissons entre le référentiel AFB (3 lettres) et le référentiel SANDRE (code numérique). Cette API permet également d'obtenir les noms commun et latin des espèces à partir des codes AFB ou SANDRE ;
  • lieux_peche : connaître les lieux où ont été effectuées des pêches électriques. A partir d'une ou plusieurs espèces de poissons, l'API fournit les stations et cours d'eau où ont été pêchés ces poissons. Il est possible de limiter la recherche en entrant un rectangle d'emprise géographique, un département, une commune, un sous-secteur hydrographique et une période d'opération ;
  • poissons : connaître les poissons décomptés par pêche électrique dans une rivière. A partir cette fois des codes des différentes stations, on récupère d'abord des informations sur la station (localisation, cours d'eau) puis sur les différentes opérations de pêche électrique qui y ont eu lieu : date, espèces de poissons pêchées, effectifs de chaque espèce, classes de taille de chaque espèce. Il est possible de limiter la recherche à une période précise.

 

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

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/
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

Accès

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

http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&size=5&pretty

https://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&size=5&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 :

http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&callback=jquery12&size=5&pretty

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

http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece_poisson=ABL&size=3&pretty

{ "count" : 2082,
"first" : "http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece...",
"last" : "http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v0/etat_piscicole/lieux_peche?code_espece...",
"data" : [
{ "x" : 3.16705654252052, "y" : 49.7574754697042, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ 3.167056543, 49.75747547 ] }, "localisation" : "Canal de St-Quentin vers la Somme canalisée à Tugny-et-pont", "code_station" : "01020102", "code_cours_eau" : "E60-0392", "nom_cours_eau" : "Canal de St-Quentin Vers la Somme Canalisée", "nombre_operations" : 5 },
{ "x" : 3.18776604716077, "y" : 49.7690960835756, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ 3.187766047, 49.769096084 ] }, "localisation" : "La Somme à Artemps", "code_station" : "01020112", "code_cours_eau" : "", "nom_cours_eau" : "", "nombre_operations" : 1 },
{ "x" : 3.31713614597393, "y" : 49.880030909984, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ 3.317136146, 49.88003091 ] }, "localisation" : "LA SOMME RIVIÈRE À MORCOURT (02)", "code_station" : "01020117", "code_cours_eau" : "", "nom_cours_eau" : "", "nombre_operations" : 3 }
] }