get_prelevements.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get_prelevements.R
\name{get_prelevements_points_prelevement}
\alias{get_prelevements_points_prelevement}
\alias{get_prelevements_ouvrages}
\alias{get_prelevements_chroniques}
\title{Retrieve data from API "Prélèvements en eau"}
\usage{
get_prelevements_points_prelevement(
  params,
  cfg = config::get(file = system.file("config.yml", package = "hubeau"))
)

get_prelevements_ouvrages(
  params,
  cfg = config::get(file = system.file("config.yml", package = "hubeau"))
)

get_prelevements_chroniques(
  params,
  cfg = config::get(file = system.file("config.yml", package = "hubeau"))
)
}
\arguments{
\item{params}{a \link{list} the list of parameters of the queries and their values in the format \code{list(ParamName = "Param value", ...)}, use the function \link{get_available_params} for a list of the available filter parameters for a given operation in an API and see the API documentation for their description}

\item{cfg}{a \link{config} object describing the configuration of the APIs. Use the internal package configuration by default
configuration}
}
\value{
a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns.
}
\description{
Available endpoints are:
\itemize{
\item \code{get_prelevements_points_prelevement} retrieves withdrawal points
\item \code{get_prelevements_ouvrages} retrieves withdrawal devices
\item \code{get_prelevements_chroniques} retrieves time series of withdrawals
}

See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
}
\examples{
# Retrieve the withdrawal points located in Romilly-sur-Seine
get_prelevements_points_prelevement(list(code_commune_insee = "10323"))

# Retrieve the withdrawal devices located in Romilly-sur-Seine
get_prelevements_ouvrages(list(code_commune_insee = "10323"))

# Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
get_prelevements_chroniques(list(code_commune_insee = "10323"))

}
\seealso{
\link{doApiQuery} for more details on the API querying process.
}