Skip to contents

List scopes

Source: R/adapt_luftqualitaet.R
luftqualitaet_scopes.Rd

List scopes

Usage

luftqualitaet_scopes(params = list(), safe = TRUE, refresh = FALSE)

Arguments

params

Named list of query parameters. Common keys:

date_from

Start date/time filter (character, ISO-8601/date).

date_to

End date/time filter (character, ISO-8601/date).

component

Pollutant component id/code (character).

scope

Scope id/code (character).

station

Station id/code (character).

network

Network id/code (character).

lang

Language code for labels/descriptions (character).

safe

Logical; if TRUE (default), apply rate-limiting and cache GET responses to tools::R_user_dir("bunddev", "cache").

refresh

Logical; if TRUE, ignore cached responses and re-fetch from the API (default FALSE).

Value

A tibble with one row per scope. Column names are derived from the indices metadata in the API response and typically include a scope id/code key column followed by scope id, scope code, scope time base, scope time scope, scope time is max, and scope name.

Details

Returns scopes used by the Luftqualitaet API. API documentation: https://luftqualitaet.api.bund.dev.

See also

bunddev_parameters() to inspect available query parameters.

Other Luftqualitaet: luftqualitaet_airquality(), luftqualitaet_airquality_limits(), luftqualitaet_annualbalances(), luftqualitaet_components(), luftqualitaet_measures(), luftqualitaet_measures_limits(), luftqualitaet_meta(), luftqualitaet_networks(), luftqualitaet_stationsettings(), luftqualitaet_stationtypes(), luftqualitaet_thresholds(), luftqualitaet_transgressions(), luftqualitaet_transgressiontypes()