Retrieve data from API "Piézométrie"

Source: R/get_niveaux_nappes.R

The available endpoints are:

  • get_niveaux_nappes_stations retrieves list of piezometric stations

  • get_nappes_chroniques retrieves piezometric archived time series

  • get_nappes_chroniques_tr retrieves piezometric "real time" data

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

get_niveaux_nappes_stations(...)

get_niveaux_nappes_chroniques(...)

get_niveaux_nappes_chroniques_tr(...)

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 the hydrometric stations in the department of Aube
get_niveaux_nappes_stations(code_departement = "10")
#> # A tibble: 724 × 36
#>    code_bss  urn_bss date_…¹ date_…² code_…³ nom_c…⁴     x     y codes…⁵ urns_…⁶
#>    <chr>     <chr>   <chr>   <chr>   <chr>   <chr>   <dbl> <dbl> <chr>   <chr>  
#>  1 03001X01… http:/… 1986-0… 1986-1… 10411   La Vil…  4.68  48.4 NA      NA     
#>  2 03001X01… http:/… 1986-0… 1986-1… 10411   La Vil…  4.68  48.4 NA      NA     
#>  3 02994X01… http:/… 1985-0… 1986-1… 10372   Soulai…  4.67  48.4 NA      NA     
#>  4 02994X02… http:/… 1986-0… 1986-1… 10139   Épothé…  4.66  48.4 NA      NA     
#>  5 03001X01… http:/… 1986-0… 1986-1… 10372   Soulai…  4.68  48.4 NA      NA     
#>  6 02994X03… http:/… 1986-0… 1986-1… 10372   Soulai…  4.67  48.4 NA      NA     
#>  7 03001X00… http:/… 1985-0… 1986-0… 10372   Soulai…  4.72  48.4 NA      NA     
#>  8 02623X00… http:/… 1977-1… 1991-1… 10354   Saint-…  4.22  48.5 NA      NA     
#>  9 03001X01… http:/… 1985-0… 1986-1… 10411   La Vil…  4.68  48.4 NA      NA     
#> 10 02994X02… http:/… 1986-0… 1986-1… 10372   Soulai…  4.67  48.4 NA      NA     
#> # … with 714 more rows, 26 more variables: geometry.type <chr>,
#> #   geometry.crs.type <chr>, geometry.crs.properties.name <chr>,
#> #   geometry.coordinates1 <dbl>, geometry.coordinates2 <dbl>, bss_id <chr>,
#> #   altitude_station <chr>, nb_mesures_piezo <int>, code_departement <chr>,
#> #   nom_departement <chr>, libelle_pe <chr>, profondeur_investigation <dbl>,
#> #   codes_masse_eau_edl <chr>, noms_masse_eau_edl <chr>,
#> #   urns_masse_eau_edl <chr>, date_maj <chr>, codes_bdlisa1 <chr>, …

# Retrieve the archived observed piezometric level at station '07548X0009/F' (old BSS identifier)
# for the year 2020
df <- get_niveaux_nappes_chroniques(code_bss = "07548X0009/F",
                                      date_debut_mesure = "2020-01-01",
                                      date_fin_mesure = "2020-12-31")

# Plot the water elevation (NGF)
plot(as.POSIXct(df$date_mesure), df$niveau_nappe_eau, type = "l")


# For retrieving the last real time observed piezometric level
# at station 'BSS001VZGZ' (new BSS identifier)
df <- get_niveaux_nappes_chroniques_tr(bss_id = "BSS001VZGZ")

# Plot the water elevation (NGF)
plot(as.POSIXct(df$date_mesure), df$niveau_eau_ngf, type = "l")

# }