The data originate from the "ONDE" river low waters monitoring network. Available endpoints are:

  • get_ecoulement_stations retrieves site data and locations

  • get_ecoulement_observations retrieves flow information

  • get_ecoulement_campagnes retrieves annual surveys

See the API documentation for available filter parameters: https://hubeau.eaufrance.fr/page/api-ecoulement

get_ecoulement_stations(...)

get_ecoulement_observations(...)

get_ecoulement_campagnes(...)

Arguments

...

parameters of the queries and their values in the format Param1_Name = "Param1 value", Param2_Name = "Param2 value", use the function list_params for a list of the available filter parameters for a given API endpoint and see the API documentation for their description

Value

A tibble::tibble with one row by record and one column by field.

Examples

# \dontrun{
# Retrieve 2022 observation campaigns in the Jura French department
get_ecoulement_campagnes(
  list(code_departement = "39",
       date_campagne_min = "2022-01-01",
       date_campagne_max = "2022-12-31")
)
#> # A tibble: 8 × 10
#>   code_campagne date_campagne nombre_modalite_ecoulement code_type_campagne
#>           <int> <chr>                              <int>              <int>
#> 1         96881 2022-10-24                             5                  2
#> 2         96802 2022-09-26                             5                  1
#> 3         96730 2022-09-12                             5                  2
#> 4         96655 2022-08-24                             5                  1
#> 5         96594 2022-08-11                             5                  2
#> 6         96509 2022-07-25                             5                  1
#> 7         96335 2022-06-23                             5                  1
#> 8         96137 2022-05-23                             5                  1
#> # ℹ 6 more variables: libelle_type_campagne <chr>, code_reseau <chr>,
#> #   libelle_reseau <chr>, uri_reseau <chr>, code_departement <chr>,
#> #   libelle_departement <chr>

# Retrieve river stations
stations_39 <- get_ecoulement_stations(
  list(code_departement = "39",
       fields = "code_station,libelle_cours_eau,libelle_commune")
)
stations_39
#> # A tibble: 43 × 3
#>    code_station libelle_commune libelle_cours_eau    
#>    <chr>        <chr>           <chr>                
#>  1 U1084011     OFFLANGES       Ruisseau de la Vèze  
#>  2 U1084012     SALIGNEY        NA                   
#>  3 U1120011     MENOTEY         Ruisseau de Borne    
#>  4 U2530001     EVANS           La Grabusse          
#>  5 U2530002     FRAISANS        La Morte             
#>  6 U2542011     AMANGE          Ruisseau Vèze        
#>  7 U2542012     CHATENOIS       Ruisseau des Vaux    
#>  8 U2542013     LOUVATANGE      L'Arne               
#>  9 U2639011     CHAMBLAY        La Larine            
#> 10 U2640002     CHAMBLAY        Ruisseau de Clairvent
#> # ℹ 33 more rows

# Get the query parameters for the requested API/endpoint
list_params(api = "ecoulement",
                     endpoint = "observations")
#>  [1] "format"               "code_station"         "libelle_station"     
#>  [4] "code_departement"     "libelle_departement"  "code_commune"        
#>  [7] "libelle_commune"      "code_region"          "libelle_region"      
#> [10] "code_bassin"          "libelle_bassin"       "code_cours_eau"      
#> [13] "libelle_cours_eau"    "code_campagne"        "code_reseau"         
#> [16] "libelle_reseau"       "date_observation_min" "date_observation_max"
#> [19] "code_ecoulement"      "libelle_ecoulement"   "longitude"           
#> [22] "latitude"             "distance"             "bbox"                
#> [25] "sort"                 "page"                 "size"                
#> [28] "fields"               "Accept"              

# Retrieve the river flow data in the Jura departement in 2022 with
# a selection of the fields
onde_39 <- get_ecoulement_observations(
  list(code_departement = "39",
       date_observation_min = "2022-01-01",
       date_observation_max = "2022-12-31",
       fields = "code_station,libelle_station,date_observation,libelle_ecoulement")
)
onde_39
#> # A tibble: 336 × 4
#>    code_station libelle_station              date_observation libelle_ecoulement
#>    <chr>        <chr>                        <chr>            <chr>             
#>  1 U2640003     Pont D7 à GERMIGNEY          2022-10-24       Ecoulement non vi…
#>  2 U2655034     ruisseau de la verine à Vau… 2022-10-24       Ecoulement visibl…
#>  3 U2640002     ruisseau de clairvent à Cha… 2022-10-24       Ecoulement visibl…
#>  4 U1084012     Ruisseau de la Serre à Sali… 2022-10-24       Ecoulement visibl…
#>  5 U1120011     ruisseau de la foret à Meno… 2022-10-24       Ecoulement visibl…
#>  6 U2722011     Rivière la Sablonne à Bouss… 2022-10-24       Ecoulement visibl…
#>  7 U2530001     La grabusse à Dampierre      2022-10-24       Ecoulement visibl…
#>  8 U2542013     Ruisseau l'Arne à Louvatange 2022-10-24       Ecoulement visibl…
#>  9 U2542012     Ruisseau des Vaux à Chateno… 2022-10-24       Ecoulement visibl…
#> 10 U2542011     Ruisseau Du Moulinot à Aman… 2022-10-24       Ecoulement visibl…
#> # ℹ 326 more rows
# }