get_indicateurs_services: Retrieve data from API "Indicateurs des services"

In hubeau: Get Data from the French National Database on Water 'Hub'Eau'

Retrieve data from API "Indicateurs des services"

Description

Retrieve performance indicators collected in drinking water and sanitation services in France.

See list_params and the API documentation for available filter parameters: https://hubeau.eaufrance.fr/page/api-indicateurs-services

Usage

get_indicateurs_services_communes(...)

get_indicateurs_services_indicateurs(...)

get_indicateurs_services_services(...)

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

get_indicateurs_services_communes returns a tibble::tibble with one row by commune, by service and by year and the following columns:

• "code_commune_insee": character identifier of the commune

• "nom_commune": character name of the commune

• "codes_service": integer identifier of the drinking water supply and/or sanitation service

• "annee": integer year of the data

• The following columns are the performance indicators flagged by their respective codes. The documentation of these codes can be found at this URL: https://www.services.eaufrance.fr/indicateurs/indicateurs.

get_indicateurs_services_indicateurs returns a tibble::tibble with one row by service and by year and the following columns:

• "code_service": character identifier of the service

• "nom_service": character name of the service

• "numero_siren ": character SIREN identifier of the service

• "type_collectivite": character kind of community

• "mode_gestion": character management mechanism of the service

• "annee": integer year of the data

• "indicateur": value of the indicator

• "uri_indicateur": the link to the indicator documentation

get_indicateurs_services_services returns a tibble::tibble with one row by commune, by service and by year and the following columns:

• "code_service": character identifier of the service

• "nom_service": character name of the service

• "code_commune_insee": character identifier of the commune

• "nom_commune": character name of the commune

• "numero_siren ": character SIREN identifier of the service

• "type_collectivite": character kind of community

• "mode_gestion": character management mechanism of the service

• "annee": integer year of the data

• The following columns are the performance indicators flagged by their respective codes. The documentation of these codes can be found at this URL: https://www.services.eaufrance.fr/indicateurs/indicateurs.

Examples

## Not run: 
# Retrieve performance indicator time series in the commune of Romilly-sur-Seine
get_indicateurs_services_communes(code_commune = "10323")

# Retrieve the drinking water withdrawal indicators of the year 2012 for all services
get_indicateurs_services_indicateurs(code_indicateur = "D102.0", annee = "2012")

# Retrieve performance indicator time series of Romilly-sur-Seine with service details
get_indicateurs_services_services(code_commune = "10323")

## End(Not run)

hubeau documentation built on June 8, 2025, 11:21 a.m.