lists: List available Hub'Eau APIs, endpoints and filter parameters
In hubeau: Get Data from the French National Database on Water 'Hub'Eau'

list_apis

R Documentation

List available Hub'Eau APIs, endpoints and filter parameters

Description

list_apis() returns the list of available APIs in the package.

list_endpoints() returns the list of available endpoints for an API.

list_params() returns the list of available parameters for an API endpoint.

Usage

list_apis()

list_endpoints(api)

list_params(api, endpoint)

Arguments

`api`	a character name of the API (e.g.: "indicateurs_services", "prelevements"...), see example for available APIs
`endpoint`	a character name of the endpoint, see example for available endpoints in an API

Details

The listed APIs correspond to the term ⁠[API]⁠ used in the name of the functions ⁠get_[API]_[endpoint]⁠ used for querying the APIs.

Value

character vector of APIs, endpoints or filter parameters

Examples

# To get the available APIs in the package
list_apis()

# To get the available endpoints in an API
list_endpoints("prelevements")

# To get available parameters in endpoint "chroniques" of the API "prelevements"
list_params(api = "prelevements", endpoint = "chroniques")

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