| Title: | Discover and Call 'Bund.dev' APIs |
|---|---|
| Description: | Provides a registry of APIs listed on <https://bund.dev> and a core 'OpenAPI' client layer to explore specs and perform requests. Adapter helpers return tidy data frames for supported APIs, with optional response caching and rate limiting guidance. |
| Authors: | Michael Bücker [aut, cre] (ORCID: <https://orcid.org/0000-0003-0045-8460>) |
| Maintainer: | Michael Bücker <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.2.3 |
| Built: | 2026-05-22 18:56:24 UTC |
| Source: | https://github.com/mchlbckr/bunddev |
Get training offer details
ausbildungssuche_details(offer_id, safe = TRUE, refresh = FALSE)ausbildungssuche_details(offer_id, safe = TRUE, refresh = FALSE)
offer_id |
Offer id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns detailed information for a single offer.
A one-row tibble with:
Requested offer id.
Raw detail payload for the offer (list-column).
ausbildungssuche_search() to find offer ids.
Other Ausbildungssuche:
ausbildungssuche_search()
## Not run: Sys.setenv(AUSBILDUNGSSUCHE_API_KEY = "infosysbub-absuche") bunddev_auth_set("ausbildungssuche", type = "api_key", env_var = "AUSBILDUNGSSUCHE_API_KEY") ausbildungssuche_details(12345) ## End(Not run)## Not run: Sys.setenv(AUSBILDUNGSSUCHE_API_KEY = "infosysbub-absuche") bunddev_auth_set("ausbildungssuche", type = "api_key", env_var = "AUSBILDUNGSSUCHE_API_KEY") ausbildungssuche_details(12345) ## End(Not run)
Search training offers
ausbildungssuche_search( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )ausbildungssuche_search( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Ausbildungssuche API provides training offer data from the
Bundesagentur fuer Arbeit. Authentication is required via X-API-Key
(clientId infosysbub-absuche, discoverable from
https://web.arbeitsagentur.de/weiterbildungssuche/suche). API documentation: https://ausbildungssuche.api.bund.dev/.
This adapter uses the X-API-Key header. Set it via bunddev_auth_set() and
AUSBILDUNGSSUCHE_API_KEY.
A tibble with one row per training offer:
Offer id (integer).
Teaching format metadata (list-column).
Duration metadata (list-column).
Provider rating text (character).
Offer metadata (list-column).
Address metadata (list-column).
Class schedule text (character).
Cost value (character).
Cost currency (character).
Cost note (character).
Funding flag (TRUE/FALSE).
Offer link (character).
Additional note text (character).
Start date text (character).
End date text (character).
Flexible start flag (TRUE/FALSE).
Registration deadline text (character).
Timing note (character).
Examining body (character).
Provider's own offer id (character).
Minimum participants (integer).
Maximum participants (integer).
Update timestamp in milliseconds (numeric).
Update timestamp as POSIXct in Europe/Berlin.
Top-level links object (list-column).
Aggregation metadata (list-column).
Paging metadata (list-column).
bunddev_parameters() to inspect available query parameters.
ausbildungssuche_details() for a single offer and bunddev_auth_set() for
authentication.
Other Ausbildungssuche:
ausbildungssuche_details()
## Not run: Sys.setenv(AUSBILDUNGSSUCHE_API_KEY = "infosysbub-absuche") bunddev_auth_set("ausbildungssuche", type = "api_key", env_var = "AUSBILDUNGSSUCHE_API_KEY") ausbildungssuche_search(params = list(size = 5)) ## End(Not run)## Not run: Sys.setenv(AUSBILDUNGSSUCHE_API_KEY = "infosysbub-absuche") bunddev_auth_set("ausbildungssuche", type = "api_key", env_var = "AUSBILDUNGSSUCHE_API_KEY") ausbildungssuche_search(params = list(size = 5)) ## End(Not run)
Get Autobahn charging station details
autobahn_charging_station_details( station_id, flatten = FALSE, flatten_mode = "json" )autobahn_charging_station_details( station_id, flatten = FALSE, flatten_mode = "json" )
station_id |
Charging station identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns full details for a single charging station entry. API documentation: https://autobahn.api.bund.dev.
A one-row tibble for the selected charging station with the same
columns as autobahn_charging_stations(). road_id is typically NA for
detail calls.
autobahn_charging_stations() to list stations.
Other Autobahn:
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() stations <- autobahn_charging_stations(roads$road_id[[1]]) autobahn_charging_station_details(stations$identifier[[1]]) ## End(Not run)## Not run: roads <- autobahn_roads() stations <- autobahn_charging_stations(roads$road_id[[1]]) autobahn_charging_station_details(stations$identifier[[1]]) ## End(Not run)
List Autobahn charging stations
autobahn_charging_stations(road_id, flatten = FALSE, flatten_mode = "json")autobahn_charging_stations(road_id, flatten = FALSE, flatten_mode = "json")
road_id |
Road identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns charging stations for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.
A tibble with one row per charging-station entry:
Road identifier (character).
Entry identifier (character).
Title (character).
Subtitle (character).
Display type (character).
Icon identifier (character).
Whether the road is blocked (logical).
Whether the entry is future-dated (logical).
Start timestamp string (character).
Parsed start time (POSIXct).
Point coordinate string (character).
Extent coordinate string (character).
Latitude (character).
Longitude (character).
Description text (character).
Footer text (character).
Route recommendations (list-column).
Lorry parking feature icons (list-column).
With flatten = TRUE, the two list-columns are transformed according to
flatten_mode.
autobahn_roads() and autobahn_charging_station_details().
Other Autobahn:
autobahn_charging_station_details(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() autobahn_charging_stations(roads$road_id[[1]], flatten = TRUE) ## End(Not run)## Not run: roads <- autobahn_roads() autobahn_charging_stations(roads$road_id[[1]], flatten = TRUE) ## End(Not run)
Get Autobahn closure details
autobahn_closure_details(closure_id, flatten = FALSE, flatten_mode = "json")autobahn_closure_details(closure_id, flatten = FALSE, flatten_mode = "json")
closure_id |
Closure identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns full details for a single closure entry. API documentation: https://autobahn.api.bund.dev.
A one-row tibble for the selected closure with the same columns as
autobahn_closures(). road_id is typically NA for detail calls.
autobahn_closures() to list closures.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() closures <- autobahn_closures(roads$road_id[[1]]) autobahn_closure_details(closures$identifier[[1]]) ## End(Not run)## Not run: roads <- autobahn_roads() closures <- autobahn_closures(roads$road_id[[1]]) autobahn_closure_details(closures$identifier[[1]]) ## End(Not run)
List Autobahn closures
autobahn_closures(road_id, flatten = FALSE, flatten_mode = "json")autobahn_closures(road_id, flatten = FALSE, flatten_mode = "json")
road_id |
Road identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns current closures for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.
A tibble with one row per closure entry:
Road identifier (character).
Entry identifier (character).
Title (character).
Subtitle (character).
Display type (character).
Icon identifier (character).
Whether the road is blocked (logical).
Whether the entry is future-dated (logical).
Start timestamp string (character).
Parsed start time (POSIXct).
Point coordinate string (character).
Extent coordinate string (character).
Latitude (character).
Longitude (character).
Description text (character).
Footer text (character).
Route recommendations (list-column).
Lorry parking feature icons (list-column).
With flatten = TRUE, the two list-columns are transformed according to
flatten_mode.
autobahn_roads() and autobahn_closure_details().
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() autobahn_closures(roads$road_id[[1]], flatten = TRUE) ## End(Not run)## Not run: roads <- autobahn_roads() autobahn_closures(roads$road_id[[1]], flatten = TRUE) ## End(Not run)
List Autobahn lorry parking areas
autobahn_parking_lorries(road_id, flatten = FALSE, flatten_mode = "json")autobahn_parking_lorries(road_id, flatten = FALSE, flatten_mode = "json")
road_id |
Road identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns lorry parking areas for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.
A tibble with one row per lorry-parking entry:
Road identifier (character).
Entry identifier (character).
Title (character).
Subtitle (character).
Display type (character).
Icon identifier (character).
Whether the road is blocked (logical).
Whether the entry is future-dated (logical).
Start timestamp string (character).
Parsed start time (POSIXct).
Point coordinate string (character).
Extent coordinate string (character).
Latitude (character).
Longitude (character).
Description text (character).
Footer text (character).
Route recommendations (list-column).
Lorry parking feature icons (list-column).
With flatten = TRUE, the two list-columns are transformed according to
flatten_mode.
autobahn_roads() and autobahn_parking_lorry_details().
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() autobahn_parking_lorries(roads$road_id[[1]], flatten = TRUE) ## End(Not run)## Not run: roads <- autobahn_roads() autobahn_parking_lorries(roads$road_id[[1]], flatten = TRUE) ## End(Not run)
Get Autobahn lorry parking details
autobahn_parking_lorry_details( lorry_id, flatten = FALSE, flatten_mode = "json" )autobahn_parking_lorry_details( lorry_id, flatten = FALSE, flatten_mode = "json" )
lorry_id |
Lorry parking identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns full details for a single lorry parking entry. API documentation: https://autobahn.api.bund.dev.
A one-row tibble for the selected lorry-parking entry with the same
columns as autobahn_parking_lorries(). road_id is typically NA for
detail calls.
autobahn_parking_lorries() to list parking areas.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() parking <- autobahn_parking_lorries(roads$road_id[[1]]) autobahn_parking_lorry_details(parking$identifier[[1]]) ## End(Not run)## Not run: roads <- autobahn_roads() parking <- autobahn_parking_lorries(roads$road_id[[1]]) autobahn_parking_lorry_details(parking$identifier[[1]]) ## End(Not run)
List Autobahn road ids
autobahn_roads()autobahn_roads()
Lists Autobahn road ids from the Autobahn App API (Autobahn GmbH). API documentation: https://autobahn.api.bund.dev.
A tibble with one row per Autobahn id:
Autobahn identifier (character).
autobahn_roadworks() and autobahn_warnings() for road-specific data.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: autobahn_roads() ## End(Not run)## Not run: autobahn_roads() ## End(Not run)
Get Autobahn roadwork details
autobahn_roadwork_details(roadwork_id, flatten = FALSE, flatten_mode = "json")autobahn_roadwork_details(roadwork_id, flatten = FALSE, flatten_mode = "json")
roadwork_id |
Roadwork identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns full details for a single roadwork entry. API documentation: https://autobahn.api.bund.dev.
A one-row tibble for the selected roadwork with the same columns as
autobahn_roadworks(). road_id is typically NA for detail calls.
autobahn_roadworks() to list roadworks.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() roadworks <- autobahn_roadworks(roads$road_id[[1]]) autobahn_roadwork_details(roadworks$identifier[[1]]) ## End(Not run)## Not run: roads <- autobahn_roads() roadworks <- autobahn_roadworks(roads$road_id[[1]]) autobahn_roadwork_details(roadworks$identifier[[1]]) ## End(Not run)
List Autobahn roadworks
autobahn_roadworks(road_id, flatten = FALSE, flatten_mode = "json")autobahn_roadworks(road_id, flatten = FALSE, flatten_mode = "json")
road_id |
Road identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns current roadworks for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.
A tibble with one row per roadwork entry:
Road identifier (character).
Entry identifier (character).
Title (character).
Subtitle (character).
Display type (character).
Icon identifier (character).
Whether the road is blocked (logical).
Whether the entry is future-dated (logical).
Start timestamp string (character).
Parsed start time (POSIXct).
Point coordinate string (character).
Extent coordinate string (character).
Latitude (character).
Longitude (character).
Description text (character).
Footer text (character).
Route recommendations (list-column).
Lorry parking feature icons (list-column).
With flatten = TRUE, the two list-columns are transformed according to
flatten_mode.
autobahn_roads() to list available roads, and autobahn_roadwork_details()
for detail records.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() autobahn_roadworks(roads$road_id[[1]], flatten = TRUE) ## End(Not run)## Not run: roads <- autobahn_roads() autobahn_roadworks(roads$road_id[[1]], flatten = TRUE) ## End(Not run)
Get Autobahn warning details
autobahn_warning_details(warning_id, flatten = FALSE, flatten_mode = "json")autobahn_warning_details(warning_id, flatten = FALSE, flatten_mode = "json")
warning_id |
Warning identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns full details for a single warning entry. API documentation: https://autobahn.api.bund.dev.
A one-row tibble for the selected warning with the same columns as
autobahn_warnings(). road_id is typically NA for detail calls.
autobahn_warnings() to list warnings.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warnings(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() warnings <- autobahn_warnings(roads$road_id[[1]]) autobahn_warning_details(warnings$identifier[[1]]) ## End(Not run)## Not run: roads <- autobahn_roads() warnings <- autobahn_warnings(roads$road_id[[1]]) autobahn_warning_details(warnings$identifier[[1]]) ## End(Not run)
List Autobahn warnings
autobahn_warnings(road_id, flatten = FALSE, flatten_mode = "json")autobahn_warnings(road_id, flatten = FALSE, flatten_mode = "json")
road_id |
Road identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns current warnings for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.
A tibble with one row per warning entry:
Road identifier (character).
Entry identifier (character).
Title (character).
Subtitle (character).
Display type (character).
Icon identifier (character).
Whether the road is blocked (logical).
Whether the entry is future-dated (logical).
Start timestamp string (character).
Parsed start time (POSIXct).
Point coordinate string (character).
Extent coordinate string (character).
Latitude (character).
Longitude (character).
Description text (character).
Footer text (character).
Route recommendations (list-column).
Lorry parking feature icons (list-column).
With flatten = TRUE, the two list-columns are transformed according to
flatten_mode.
autobahn_roads() to list roads and autobahn_warning_details() for details.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_webcam_details(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() autobahn_warnings(roads$road_id[[1]], flatten = TRUE) ## End(Not run)## Not run: roads <- autobahn_roads() autobahn_warnings(roads$road_id[[1]], flatten = TRUE) ## End(Not run)
Get Autobahn webcam details
autobahn_webcam_details(webcam_id, flatten = FALSE, flatten_mode = "json")autobahn_webcam_details(webcam_id, flatten = FALSE, flatten_mode = "json")
webcam_id |
Webcam identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns full details for a single webcam entry. API documentation: https://autobahn.api.bund.dev.
A one-row tibble for the selected webcam with the same columns as
autobahn_webcams(). road_id is typically NA for detail calls.
autobahn_webcams() to list webcams.
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcams()
## Not run: roads <- autobahn_roads() webcams <- autobahn_webcams(roads$road_id[[1]]) autobahn_webcam_details(webcams$identifier[[1]]) ## End(Not run)## Not run: roads <- autobahn_roads() webcams <- autobahn_webcams(roads$road_id[[1]]) autobahn_webcam_details(webcams$identifier[[1]]) ## End(Not run)
List Autobahn webcams
autobahn_webcams(road_id, flatten = FALSE, flatten_mode = "json")autobahn_webcams(road_id, flatten = FALSE, flatten_mode = "json")
road_id |
Road identifier. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns webcam entries for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.
A tibble with one row per webcam entry:
Road identifier (character).
Entry identifier (character).
Title (character).
Subtitle (character).
Display type (character).
Icon identifier (character).
Whether the road is blocked (logical).
Whether the entry is future-dated (logical).
Start timestamp string (character).
Parsed start time (POSIXct).
Point coordinate string (character).
Extent coordinate string (character).
Latitude (character).
Longitude (character).
Description text (character).
Footer text (character).
Route recommendations (list-column).
Lorry parking feature icons (list-column).
With flatten = TRUE, the two list-columns are transformed according to
flatten_mode.
autobahn_roads() and autobahn_webcam_details().
Other Autobahn:
autobahn_charging_station_details(),
autobahn_charging_stations(),
autobahn_closure_details(),
autobahn_closures(),
autobahn_parking_lorries(),
autobahn_parking_lorry_details(),
autobahn_roads(),
autobahn_roadwork_details(),
autobahn_roadworks(),
autobahn_warning_details(),
autobahn_warnings(),
autobahn_webcam_details()
## Not run: roads <- autobahn_roads() autobahn_webcams(roads$road_id[[1]], flatten = TRUE) ## End(Not run)## Not run: roads <- autobahn_roads() autobahn_webcams(roads$road_id[[1]], flatten = TRUE) ## End(Not run)
Retrieve Bewerberboerse candidate details
bewerberboerse_details(referenznummer, flatten = FALSE, flatten_mode = "json")bewerberboerse_details(referenznummer, flatten = FALSE, flatten_mode = "json")
referenznummer |
Bewerber referenznummer. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Fetches details for a single candidate. The referenznummer typically comes
from bewerberboerse_search(). See https://bundesapi.github.io/bewerberboerse-api/.
A tibble with the same columns as bewerberboerse_search(), filtered
to the requested referenznummer.
Candidate reference number (character).
Availability date text (character).
Last update date text (character).
Publication date text (character).
Position type (character).
Work-time models, collapsed string (character).
Occupations, collapsed string (character).
Year of most recent activity (character).
Label of most recent activity (character).
Whether latest activity is current (logical).
Email contact available (logical).
Phone contact available (logical).
Postal address available (logical).
City/locality (character).
Postal code (character).
Radius text returned by API (character).
Region/state (character).
Country (character).
Multiple work locations flag (logical).
Education entries (list-column).
Experience entries (list-column).
Operation identifier (character).
Returned page index (integer).
Returned page size (integer).
Total matching result count (integer).
bewerberboerse_search() to find candidates and bunddev_auth_set() for auth.
Other Bewerberboerse:
bewerberboerse_search()
## Not run: Sys.setenv(BEWERBERBOERSE_API_KEY = "jobboerse-bewerbersuche-ui") bunddev_auth_set("bewerberboerse", type = "api_key", env_var = "BEWERBERBOERSE_API_KEY") bewerberboerse_details("12345", flatten = TRUE) ## End(Not run)## Not run: Sys.setenv(BEWERBERBOERSE_API_KEY = "jobboerse-bewerbersuche-ui") bunddev_auth_set("bewerberboerse", type = "api_key", env_var = "BEWERBERBOERSE_API_KEY") bewerberboerse_details("12345", flatten = TRUE) ## End(Not run)
Search the Bewerberboerse API
bewerberboerse_search(params = list(), flatten = FALSE, flatten_mode = "json")bewerberboerse_search(params = list(), flatten = FALSE, flatten_mode = "json")
params |
Named list of query parameters:
|
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Bewerberboerse API provides access to candidate listings. Authentication
uses an API key passed as X-API-Key (clientId jobboerse-bewerbersuche-ui).
See https://bundesapi.github.io/bewerberboerse-api/ for official docs.
Use bunddev_auth_set() to configure the key and bunddev_parameters() to
inspect available query parameters.
A tibble with one row per candidate profile:
Candidate reference number (character).
Availability date text (character).
Last update date text (character).
Publication date text (character).
Position type (character).
Work-time models, collapsed string (character).
Occupations, collapsed string (character).
Year of most recent activity (character).
Label of most recent activity (character).
Whether latest activity is current (TRUE/FALSE).
Email contact available (TRUE/FALSE).
Phone contact available (TRUE/FALSE).
Postal address available (TRUE/FALSE).
City/locality (character).
Postal code (character).
Radius text returned by API (character).
Region/state (character).
Country (character).
Multiple work locations flag (TRUE/FALSE).
Education entries (list-column).
Experience entries (list-column).
Operation identifier used by the tidier (character).
Returned page index (integer).
Returned page size (integer).
Total matching result count (integer).
bewerberboerse_details() for detailed entries and bunddev_auth_set() for
authentication setup.
Other Bewerberboerse:
bewerberboerse_details()
## Not run: Sys.setenv(BEWERBERBOERSE_API_KEY = "jobboerse-bewerbersuche-ui") bunddev_auth_set("bewerberboerse", type = "api_key", env_var = "BEWERBERBOERSE_API_KEY") bewerberboerse_search(params = list(was = "data", size = 10), flatten = TRUE) ## End(Not run)## Not run: Sys.setenv(BEWERBERBOERSE_API_KEY = "jobboerse-bewerbersuche-ui") bunddev_auth_set("bewerberboerse", type = "api_key", env_var = "BEWERBERBOERSE_API_KEY") bewerberboerse_search(params = list(was = "data", size = 10), flatten = TRUE) ## End(Not run)
Get authentication configuration for an API
bunddev_auth_get(api)bunddev_auth_get(api)
api |
Registry id. |
Returns the stored auth configuration for the API or a default none entry
if no auth has been configured.
A named list with auth settings for api. If no configuration was
set, returns defaults with type = "none".
bunddev_auth_set() to configure credentials.
Other Authentication:
bunddev_auth_set()
bunddev_auth_get("jobsuche")bunddev_auth_get("jobsuche")
Set authentication configuration for an API
bunddev_auth_set( api, type = "api_key", env_var, scheme = NULL, oauth_url = NULL, oauth_secret_env = NULL, oauth_default_id = NULL, oauth_token_header = "OAuthAccessToken", oauth_fallback_header = "X-API-Key" )bunddev_auth_set( api, type = "api_key", env_var, scheme = NULL, oauth_url = NULL, oauth_secret_env = NULL, oauth_default_id = NULL, oauth_token_header = "OAuthAccessToken", oauth_fallback_header = "X-API-Key" )
api |
Registry id. |
type |
Authentication type ("none", "api_key", or "oauth2"). |
env_var |
Environment variable containing credentials (for api_key) or client ID (for oauth2). |
scheme |
Authentication scheme used in the Authorization header (e.g., "Bearer", "ApiKey", "OAuth"). |
oauth_url |
OAuth2 token endpoint URL (for oauth2 type). |
oauth_secret_env |
OAuth2 client secret environment variable (for oauth2 type). |
oauth_default_id |
Default OAuth2 client ID if env_var is not set (for oauth2 type). |
oauth_token_header |
Header name for OAuth token (default "OAuthAccessToken"). |
oauth_fallback_header |
Header name when no secret available (default "X-API-Key"). |
Store auth configuration used by bunddev_call() and adapter helpers.
For API key auth: set env_var to the name of an environment variable containing
the key. The key is sent as Authorization: {scheme} <key>.
For OAuth2 client credentials: set oauth_url to the token endpoint,
env_var to the client ID env var, and oauth_secret_env to the client secret
env var. If the secret is available, fetches an OAuth token; otherwise falls
back to sending the client ID as an API key.
A named list with stored authentication settings:
Authentication type ("none", "api_key", "oauth2").
Environment variable name for credential lookup.
Header scheme/template used for auth header construction.
OAuth token endpoint URL (oauth2 only).
Environment variable name for OAuth client secret.
Fallback OAuth client ID when env_var is unset.
Header name used for OAuth access tokens.
Header name used for fallback API key mode.
bunddev_auth_get() to inspect the stored configuration, and
bunddev_call() to make authenticated requests.
Other Authentication:
bunddev_auth_get()
# API key authentication Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY", scheme = "X-API-Key") # OAuth2 client credentials bunddev_auth_set("berufssprachkurssuche", type = "oauth2", oauth_url = "https://rest.arbeitsagentur.de/oauth/gettoken_cc", env_var = "BERUFSSPRACHKURSSUCHE_API_KEY", oauth_secret_env = "BERUFSSPRACHKURSSUCHE_CLIENT_SECRET", oauth_default_id = "bd24f42e-ad0b-4005-b834-23bb6800dc6c")# API key authentication Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY", scheme = "X-API-Key") # OAuth2 client credentials bunddev_auth_set("berufssprachkurssuche", type = "oauth2", oauth_url = "https://rest.arbeitsagentur.de/oauth/gettoken_cc", env_var = "BERUFSSPRACHKURSSUCHE_API_KEY", oauth_secret_env = "BERUFSSPRACHKURSSUCHE_CLIENT_SECRET", oauth_default_id = "bd24f42e-ad0b-4005-b834-23bb6800dc6c")
Locate the bunddev cache directory
bunddev_cache_dir()bunddev_cache_dir()
The cache directory is used to store downloaded OpenAPI specs and cached
API responses. During R CMD check, bunddev uses a temporary cache
directory to avoid leaving persistent files behind. Use this to inspect or
clean cached files.
Path to the bunddev cache directory (character scalar).
bunddev_spec() to download specs, and bunddev_spec_path() to locate
a specific spec file.
Other OpenAPI:
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: bunddev_cache_dir() ## End(Not run)## Not run: bunddev_cache_dir() ## End(Not run)
Call an API operation
bunddev_call( api, operation_id = NULL, params = list(), path = NULL, method = NULL, parse = c("json", "text", "raw", "xml"), base_url = NULL, body = NULL, body_type = c("json", "form"), headers = NULL, safe = TRUE, refresh = FALSE )bunddev_call( api, operation_id = NULL, params = list(), path = NULL, method = NULL, parse = c("json", "text", "raw", "xml"), base_url = NULL, body = NULL, body_type = c("json", "form"), headers = NULL, safe = TRUE, refresh = FALSE )
api |
Registry id. |
operation_id |
OpenAPI operationId (use this OR path+method). |
params |
Named list of query and path parameters passed to the selected operation. |
path |
API path (use with method instead of operation_id). |
method |
HTTP method (use with path instead of operation_id). |
parse |
Response parsing mode. |
base_url |
Optional base URL override. |
body |
Optional request body (for POST/PUT requests). |
body_type |
Body encoding type ("json" or "form"). |
headers |
Optional named list of custom HTTP headers. |
safe |
Logical; if |
refresh |
Logical; if |
This is the low-level OpenAPI caller. It supports two modes:
Use operation_id to lookup endpoints by their OpenAPI operationId
Use path + method for APIs without operationIds
The function fills path parameters from params, applies auth (if
configured), and optionally caches GET responses when safe = TRUE.
Use bunddev_parameters() and bunddev_parameter_values() to discover valid
parameters before calling.
Parsed response according to parse:
parse = "json"Parsed JSON as an R list.
parse = "text"Character scalar with response body text.
parse = "raw"Raw vector with response bytes.
parse = "xml"xml2 document object.
bunddev_call_tidy() for adapter-specific tidy outputs, and
bunddev_auth_set() to configure API keys.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: # Retrieve Autobahn road ids (raw response) bunddev_call("autobahn", "list-autobahnen") ## End(Not run)## Not run: # Retrieve Autobahn road ids (raw response) bunddev_call("autobahn", "list-autobahnen") ## End(Not run)
Call an API operation and return tidy data
bunddev_call_tidy(api, operation_id, params = list(), ...)bunddev_call_tidy(api, operation_id, params = list(), ...)
api |
Registry id. |
operation_id |
OpenAPI operationId. |
params |
Named list of parameters forwarded to |
... |
Additional arguments passed to the tidier. |
This helper calls bunddev_call() and then applies the adapter-specific
tidier for the API. If no tidier is registered, a tibble containing the raw
response is returned.
A tibble with tidied endpoint data when a tidier is registered for
api. Otherwise a one-row tibble with a single list-column raw containing
the parsed response object.
bunddev_call() for raw responses, and bunddev_parameters() to discover
available parameters.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: # Tidy Autobahn roadworks bunddev_call_tidy("autobahn", "list-roadworks", params = list(roadId = "A1")) ## End(Not run)## Not run: # Tidy Autobahn roadworks bunddev_call_tidy("autobahn", "list-roadworks", params = list(roadId = "A1")) ## End(Not run)
Retrieve endpoints for a given API
List OpenAPI endpoints for an API
bunddev_endpoints(id) bunddev_endpoints(id)bunddev_endpoints(id) bunddev_endpoints(id)
id |
Registry id. |
Parses the cached OpenAPI spec and returns every available path + method with its operationId and summary, if provided.
A tibble with columns method, path, operation_id, summary
A tibble with one row per OpenAPI operation:
HTTP method in lower-case, e.g. "get" (character).
OpenAPI path template, e.g. "/v1/items/{id}" (character).
OpenAPI operationId (character or NA).
Operation summary from the spec (character or NA).
bunddev_parameters() to inspect parameters and bunddev_spec() to access
the full spec.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: bunddev_endpoints("autobahn") ## End(Not run)## Not run: bunddev_endpoints("autobahn") ## End(Not run)
Get a registry entry by id
bunddev_info(id)bunddev_info(id)
id |
Registry id. |
Use this to access the spec URL, documentation URL, and authentication requirements for a single API.
A one-row tibble with the same columns as bunddev_registry().
bunddev_list() for discovery and bunddev_registry() for the full table.
Other Registry:
bunddev_list(),
bunddev_registry(),
bunddev_search()
bunddev_info("smard")bunddev_info("smard")
List registry entries
bunddev_list(tag = NULL, auth = NULL)bunddev_list(tag = NULL, auth = NULL)
tag |
Optional tag to filter on. |
auth |
Optional auth type to filter on. |
Use this to quickly narrow down APIs by topic or authentication type. Tags correspond to the taxonomy in the bundled registry.
A tibble with the same columns as bunddev_registry(), filtered by
tag and/or auth when provided.
bunddev_registry() for the full table and bunddev_info() for one entry.
Other Registry:
bunddev_info(),
bunddev_registry(),
bunddev_search()
bunddev_list(tag = "jobs") bunddev_list(auth = "api_key")bunddev_list(tag = "jobs") bunddev_list(auth = "api_key")
Convert milliseconds to POSIXct
bunddev_ms_to_posix(value, tz = "Europe/Berlin")bunddev_ms_to_posix(value, tz = "Europe/Berlin")
value |
Timestamp in milliseconds. |
tz |
Timezone for conversion. |
Converts epoch milliseconds to POSIXct in the requested timezone.
POSIXct timestamp.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
bunddev_ms_to_posix(1704067200000, tz = "Europe/Berlin")bunddev_ms_to_posix(1704067200000, tz = "Europe/Berlin")
Extract parameter enum values
bunddev_parameter_values(endpoint, name)bunddev_parameter_values(endpoint, name)
endpoint |
Adapter function or its name. |
name |
Parameter name. |
Returns unique enum values for a parameter defined on the adapter endpoint.
A character vector of unique enum values. Returns character(0) if
no enum is declared for the selected parameter.
bunddev_parameters_for() to inspect all parameters for an adapter.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: bunddev_parameter_values(smard_timeseries, "resolution") ## End(Not run)## Not run: bunddev_parameter_values(smard_timeseries, "resolution") ## End(Not run)
List OpenAPI parameters for an API
bunddev_parameters(id, name = NULL, path = NULL, method = NULL)bunddev_parameters(id, name = NULL, path = NULL, method = NULL)
id |
Registry id. |
name |
Optional parameter name to filter. |
path |
Optional endpoint path to filter. |
method |
Optional HTTP method to filter. |
Returns one row per parameter defined in the OpenAPI spec. Enumerations are
stored in a list-column (enum). Use the filter arguments to narrow down
results to a specific endpoint or parameter name.
A tibble with one row per parameter definition:
HTTP method in lower-case (character).
OpenAPI path template where the parameter applies (character).
Parameter name (character).
Parameter location such as "query" or "path" (character).
Whether the parameter is required (TRUE/FALSE).
Parameter description from the spec (character or NA).
OpenAPI schema type, e.g. "string" (character or NA).
List-column of allowed values (list of character vectors).
bunddev_parameters_for() for adapter-specific parameters and
bunddev_parameter_values() for enum values.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: bunddev_parameters("smard", name = "resolution") ## End(Not run)## Not run: bunddev_parameters("smard", name = "resolution") ## End(Not run)
List OpenAPI parameters for a specific adapter
bunddev_parameters_for(endpoint)bunddev_parameters_for(endpoint)
endpoint |
Adapter function or its name. |
Resolves the adapter to an OpenAPI path/method mapping and filters parameters accordingly.
A tibble with the same columns as bunddev_parameters(), filtered to
the OpenAPI path/method associated with endpoint.
bunddev_parameters() for the full API parameter table.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_spec(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: bunddev_parameters_for(smard_timeseries) ## End(Not run)## Not run: bunddev_parameters_for(smard_timeseries) ## End(Not run)
Get API rate limit configuration
bunddev_rate_limit_get(api)bunddev_rate_limit_get(api)
api |
Registry id. |
If no explicit limit was set, the function tries to infer one from the
registry entry. The result is used by adapter helpers when safe = TRUE.
A named list with:
Configured/inferred calls-per-hour limit (integer or NA).
Numeric Unix timestamps of tracked requests.
bunddev_rate_limit_set() to override the default.
Other Throttling:
bunddev_rate_limit_set()
bunddev_rate_limit_get("smard")bunddev_rate_limit_get("smard")
Set API rate limit configuration
bunddev_rate_limit_set(api, max_per_hour)bunddev_rate_limit_set(api, max_per_hour)
api |
Registry id. |
max_per_hour |
Maximum number of calls per hour. |
Use this to override or enforce a per-hour rate limit for a given API. The default is inferred from the registry entry when available.
A named list with:
Maximum allowed calls per hour (integer).
Numeric Unix timestamps of tracked requests.
bunddev_rate_limit_get() to inspect the current setting.
Other Throttling:
bunddev_rate_limit_get()
bunddev_rate_limit_set("smard", max_per_hour = 60)bunddev_rate_limit_set("smard", max_per_hour = 60)
Read the bundled API registry
bunddev_registry()bunddev_registry()
The registry is bundled with the package and contains metadata such as the API title, provider, documentation URL, OpenAPI spec URL, authentication type, and any declared rate limits. The data originates from bund.dev and the bundesAPI registry.
A tibble with one row per API registry entry:
Stable API identifier used throughout bunddev (character).
Human-readable API title (character).
API provider or owning institution (character).
OpenAPI specification URL (character).
Upstream API documentation URL (character).
Authentication type ("none", "api_key", "oauth2").
Declared upstream rate limit text (character or NA).
List-column of taxonomy tags (list of character vectors).
bunddev_list() for filtered listings, bunddev_search() for keyword
searches, and bunddev_info() for a single entry.
Other Registry:
bunddev_info(),
bunddev_list(),
bunddev_search()
registry <- bunddev_registry() head(registry, 3)registry <- bunddev_registry() head(registry, 3)
Search registry entries
bunddev_search(q)bunddev_search(q)
q |
Search query. |
Searches across registry ids, titles, providers, and tags using a simple substring match.
A tibble with the same columns as bunddev_registry(), containing
entries that match q.
bunddev_list() to filter by tag or auth, and bunddev_info() for details
on a single API.
Other Registry:
bunddev_info(),
bunddev_list(),
bunddev_registry()
bunddev_search("weather")bunddev_search("weather")
Retrieve a cached API spec
bunddev_spec(id, refresh = FALSE)bunddev_spec(id, refresh = FALSE)
id |
Registry id. |
refresh |
Logical; if |
Downloads the OpenAPI spec from the registry if it is missing or when
refresh = TRUE. Parsed specs are returned as lists.
Parsed OpenAPI specification as a nested list.
bunddev_endpoints() to list operations and bunddev_parameters() to
inspect parameters.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec_path(),
bunddev_timestamp_to_ms()
## Not run: bunddev_spec("smard") ## End(Not run)## Not run: bunddev_spec("smard") ## End(Not run)
Build a cache path for an API spec
bunddev_spec_path(id)bunddev_spec_path(id)
id |
Registry id. |
Determines the cache file name based on the spec URL extension (.yaml/.json).
File path where the API specification is cached (character scalar).
bunddev_spec() to download and parse specs.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_timestamp_to_ms()
## Not run: bunddev_spec_path("smard") ## End(Not run)## Not run: bunddev_spec_path("smard") ## End(Not run)
Convert timestamps to milliseconds
bunddev_timestamp_to_ms(value, tz = "Europe/Berlin")bunddev_timestamp_to_ms(value, tz = "Europe/Berlin")
value |
Timestamp as numeric (ms), Date, or POSIXct. |
tz |
Timezone for Date/POSIXct conversion. |
This helper standardizes timestamps for APIs that expect epoch milliseconds. Dates are interpreted in the supplied timezone.
Numeric timestamp in milliseconds.
Other OpenAPI:
bunddev_cache_dir(),
bunddev_call(),
bunddev_call_tidy(),
bunddev_endpoints(),
bunddev_ms_to_posix(),
bunddev_parameter_values(),
bunddev_parameters(),
bunddev_parameters_for(),
bunddev_spec(),
bunddev_spec_path()
bunddev_timestamp_to_ms(as.POSIXct("2024-01-01 00:00:00", tz = "Europe/Berlin"))bunddev_timestamp_to_ms(as.POSIXct("2024-01-01 00:00:00", tz = "Europe/Berlin"))
Query Bundeshaushalt budget data
bundeshaushalt_budget_data( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )bundeshaushalt_budget_data( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Bundeshaushalt API provides budget data for federal income and expenses.
Required query parameters are year and account. API documentation: https://github.com/bundesAPI/bundeshaushalt-api.
A one-row tibble with budget metadata and nested payloads:
Requested account type (character).
Entity label from the API response (character).
Current hierarchy level (integer).
Maximum hierarchy level (integer).
Upstream modification date (character).
Quota/target mode (character).
Response timestamp in milliseconds (numeric).
Response timestamp as POSIXct in Europe/Berlin.
Selected unit/granularity (character).
Budget year (integer).
Detailed budget rows (list-column).
Child nodes in the budget hierarchy (list-column).
Parent nodes in the hierarchy (list-column).
Related nodes from the API response (list-column).
bunddev_parameters() to inspect parameter metadata from the OpenAPI spec.
## Not run: bundeshaushalt_budget_data(params = list(year = 2021, account = "expenses")) ## End(Not run)## Not run: bundeshaushalt_budget_data(params = list(year = 2021, account = "expenses")) ## End(Not run)
List current Bundesrat news
bundesrat_aktuelles(view = "renderXml", safe = TRUE, refresh = FALSE)bundesrat_aktuelles(view = "renderXml", safe = TRUE, refresh = FALSE)
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns current news items from the Bundesrat app feed. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the current news feed.
Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_aktuelles() ## End(Not run)## Not run: bundesrat_aktuelles() ## End(Not run)
List Bundesrat members
bundesrat_mitglieder(view = "renderXml", safe = TRUE, refresh = FALSE)bundesrat_mitglieder(view = "renderXml", safe = TRUE, refresh = FALSE)
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns Bundesrat member entries from the mobile feed. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the member feed. Column
names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_mitglieder() ## End(Not run)## Not run: bundesrat_mitglieder() ## End(Not run)
List Bundesrat current plenum session entries
bundesrat_plenum_aktuelle_sitzung( view = "renderXml", safe = TRUE, refresh = FALSE )bundesrat_plenum_aktuelle_sitzung( view = "renderXml", safe = TRUE, refresh = FALSE )
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns entries for the current plenum session. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> for the current session feed.
Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_plenum_aktuelle_sitzung() ## End(Not run)## Not run: bundesrat_plenum_aktuelle_sitzung() ## End(Not run)
List Bundesrat plenum entries in chronological order
bundesrat_plenum_chronologisch( view = "renderXml", safe = TRUE, refresh = FALSE )bundesrat_plenum_chronologisch( view = "renderXml", safe = TRUE, refresh = FALSE )
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns plenum entries ordered chronologically. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in chronological order.
Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_plenum_chronologisch() ## End(Not run)## Not run: bundesrat_plenum_chronologisch() ## End(Not run)
List Bundesrat plenum compact entries
bundesrat_plenum_kompakt(view = "renderXml", safe = TRUE, refresh = FALSE)bundesrat_plenum_kompakt(view = "renderXml", safe = TRUE, refresh = FALSE)
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns plenum compact entries for Bundesrat sessions. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the plenum compact feed.
Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_plenum_kompakt() ## End(Not run)## Not run: bundesrat_plenum_kompakt() ## End(Not run)
Get Bundesrat upcoming plenum sessions
bundesrat_plenum_naechste_sitzungen( view = "render[iOSDetailsWithoutInnerDate]", safe = TRUE, refresh = FALSE )bundesrat_plenum_naechste_sitzungen( view = "render[iOSDetailsWithoutInnerDate]", safe = TRUE, refresh = FALSE )
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns upcoming Bundesrat sessions. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the upcoming sessions feed.
Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_plenum_naechste_sitzungen() ## End(Not run)## Not run: bundesrat_plenum_naechste_sitzungen() ## End(Not run)
List Bundesrat presidium entries
bundesrat_praesidium(view = "renderXml", safe = TRUE, refresh = FALSE)bundesrat_praesidium(view = "renderXml", safe = TRUE, refresh = FALSE)
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns Bundesrat presidium entries. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the presidium feed. Column
names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_startlist(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_praesidium() ## End(Not run)## Not run: bundesrat_praesidium() ## End(Not run)
List Bundesrat API endpoints
bundesrat_startlist(view = "renderXml", safe = TRUE, refresh = FALSE)bundesrat_startlist(view = "renderXml", safe = TRUE, refresh = FALSE)
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns the start list for the Bundesrat mobile API, including the URLs for other available resources. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the start list feed. Column
names correspond to the XML child element names within each <item>.
<tag>One column per unique scalar child element (character). Exact names depend on the XML feed structure.
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field (date, dateOfIssue, imageDate, layoutDate, startdate,
stopdate) is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_stimmverteilung(),
bundesrat_termine()
## Not run: bundesrat_startlist() ## End(Not run)## Not run: bundesrat_startlist() ## End(Not run)
Get Bundesrat voting distribution
bundesrat_stimmverteilung( view = "render[iOSDetailsWithoutInnerDate]", safe = TRUE, refresh = FALSE )bundesrat_stimmverteilung( view = "render[iOSDetailsWithoutInnerDate]", safe = TRUE, refresh = FALSE )
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns the Bundesrat voting distribution. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the voting distribution
feed. Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_termine()
## Not run: bundesrat_stimmverteilung() ## End(Not run)## Not run: bundesrat_stimmverteilung() ## End(Not run)
List Bundesrat dates and events
bundesrat_termine(view = "renderXml", safe = TRUE, refresh = FALSE)bundesrat_termine(view = "renderXml", safe = TRUE, refresh = FALSE)
view |
Rendering mode for the XML output. |
safe |
Logical; if |
refresh |
Logical; if |
Returns scheduled Bundesrat dates and events. API documentation: https://bundesrat.api.bund.dev.
A tibble with one row per XML <item> in the dates/events feed.
Column names correspond to the XML child element names.
<tag>One column per unique scalar child element (character).
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Parsed POSIXct (Europe/Berlin) added when the corresponding source
field is present.
Other Bundesrat:
bundesrat_aktuelles(),
bundesrat_mitglieder(),
bundesrat_plenum_aktuelle_sitzung(),
bundesrat_plenum_chronologisch(),
bundesrat_plenum_kompakt(),
bundesrat_plenum_naechste_sitzungen(),
bundesrat_praesidium(),
bundesrat_startlist(),
bundesrat_stimmverteilung()
## Not run: bundesrat_termine() ## End(Not run)## Not run: bundesrat_termine() ## End(Not run)
Get a Bundestag news article
bundestag_article(article_id, safe = TRUE, refresh = FALSE)bundestag_article(article_id, safe = TRUE, refresh = FALSE)
article_id |
Article id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns a single Bundestag news article in XML format. API documentation: https://bundestag.api.bund.dev/.
A one-row tibble with fields extracted from the XML document. Column names correspond to XML element names.
<tag>One column per unique scalar child element of the XML root (character). Exact names depend on the XML document structure.
<repeated_tag>List-column when a child element name appears more than once.
Other Bundestag:
bundestag_ausschuesse(),
bundestag_ausschuss(),
bundestag_conferences(),
bundestag_mdb_bio(),
bundestag_mdb_index(),
bundestag_speaker(),
bundestag_video_feed()
## Not run: bundestag_article(849630) ## End(Not run)## Not run: bundestag_article(849630) ## End(Not run)
List Bundestag committees
bundestag_ausschuesse(safe = TRUE, refresh = FALSE)bundestag_ausschuesse(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns the committee index from Bundestag XML feeds. API documentation: https://bundestag.api.bund.dev/.
A tibble with one row per committee <item> from the index feed.
Column names correspond to XML child element names within each <item>.
<tag>One column per unique scalar child element in each
<item> (character). Exact names depend on the feed structure.
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Other Bundestag:
bundestag_article(),
bundestag_ausschuss(),
bundestag_conferences(),
bundestag_mdb_bio(),
bundestag_mdb_index(),
bundestag_speaker(),
bundestag_video_feed()
## Not run: bundestag_ausschuesse() ## End(Not run)## Not run: bundestag_ausschuesse() ## End(Not run)
Get Bundestag committee details
bundestag_ausschuss(ausschuss_id, safe = TRUE, refresh = FALSE)bundestag_ausschuss(ausschuss_id, safe = TRUE, refresh = FALSE)
ausschuss_id |
Committee id (e.g. "a11"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns details for a single committee. API documentation: https://bundestag.api.bund.dev/.
A one-row tibble with committee detail fields extracted from XML. Column names correspond to XML element names.
<tag>One column per unique scalar child element of the XML root (character). Exact names depend on the XML document structure.
<repeated_tag>List-column when a child element name appears more than once.
Other Bundestag:
bundestag_article(),
bundestag_ausschuesse(),
bundestag_conferences(),
bundestag_mdb_bio(),
bundestag_mdb_index(),
bundestag_speaker(),
bundestag_video_feed()
## Not run: bundestag_ausschuss("a11") ## End(Not run)## Not run: bundestag_ausschuss("a11") ## End(Not run)
Get Bundestag conferences overview
bundestag_conferences(safe = TRUE, refresh = FALSE)bundestag_conferences(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns conference overview data from the plenum feed. API documentation: https://bundestag.api.bund.dev/.
A tibble with one row per <item> entry from the conferences feed.
Column names correspond to XML child element names within each <item>.
<tag>One column per unique scalar child element in each
<item> (character). Exact names depend on the feed structure.
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Other Bundestag:
bundestag_article(),
bundestag_ausschuesse(),
bundestag_ausschuss(),
bundestag_mdb_bio(),
bundestag_mdb_index(),
bundestag_speaker(),
bundestag_video_feed()
## Not run: bundestag_conferences() ## End(Not run)## Not run: bundestag_conferences() ## End(Not run)
Search the Bundestag lobbyregister
bundestag_lobbyregister_search( q = NULL, sort = NULL, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )bundestag_lobbyregister_search( q = NULL, sort = NULL, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
q |
Optional search string. |
sort |
Optional sorting order. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns search results from the Bundestag lobbyregister. API documentation: https://bundesapi.github.io/bundestag-lobbyregister-api/.
A one-row tibble with search metadata:
Source label from the API payload (character).
Source URL (character).
URL of the executed search (character).
Search timestamp/date string (character).
Effective search parameter object (list-column).
Total result count (integer).
Search result entries (list-column).
## Not run: bundestag_lobbyregister_search(q = "energie") ## End(Not run)## Not run: bundestag_lobbyregister_search(q = "energie") ## End(Not run)
Get a Bundestag biography
bundestag_mdb_bio(mdb_id, safe = TRUE, refresh = FALSE)bundestag_mdb_bio(mdb_id, safe = TRUE, refresh = FALSE)
mdb_id |
Member id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns details for a single member of parliament. API documentation: https://bundestag.api.bund.dev/.
A one-row tibble with biography fields extracted from XML. Column names correspond to XML element names.
<tag>One column per unique scalar child element of the XML root (character). Exact names depend on the XML document structure.
<repeated_tag>List-column when a child element name appears more than once.
Other Bundestag:
bundestag_article(),
bundestag_ausschuesse(),
bundestag_ausschuss(),
bundestag_conferences(),
bundestag_mdb_index(),
bundestag_speaker(),
bundestag_video_feed()
## Not run: bundestag_mdb_bio(1769) ## End(Not run)## Not run: bundestag_mdb_bio(1769) ## End(Not run)
List Bundestag members of parliament
bundestag_mdb_index(safe = TRUE, refresh = FALSE)bundestag_mdb_index(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns the index of members of parliament. API documentation: https://bundestag.api.bund.dev/.
A tibble with one row per member <item> from the index feed.
Column names correspond to XML child element names within each <item>.
<tag>One column per unique scalar child element in each
<item> (character). Exact names depend on the feed structure.
<repeated_tag>List-column when a child element name appears more
than once in a single <item>.
Other Bundestag:
bundestag_article(),
bundestag_ausschuesse(),
bundestag_ausschuss(),
bundestag_conferences(),
bundestag_mdb_bio(),
bundestag_speaker(),
bundestag_video_feed()
## Not run: bundestag_mdb_index() ## End(Not run)## Not run: bundestag_mdb_index() ## End(Not run)
Get the current Bundestag speaker
bundestag_speaker(safe = TRUE, refresh = FALSE)bundestag_speaker(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns the current speaker from the plenum feed. API documentation: https://bundestag.api.bund.dev/.
A one-row tibble with fields extracted from the XML document (same
structure rules as bundestag_article()).
<tag>One column per unique scalar child element of the XML root (character). Exact names depend on the XML document structure.
<repeated_tag>List-column when a child element name appears more than once.
Other Bundestag:
bundestag_article(),
bundestag_ausschuesse(),
bundestag_ausschuss(),
bundestag_conferences(),
bundestag_mdb_bio(),
bundestag_mdb_index(),
bundestag_video_feed()
## Not run: bundestag_speaker() ## End(Not run)## Not run: bundestag_speaker() ## End(Not run)
Get a Bundestag video feed entry
bundestag_video_feed(content_id, safe = TRUE, refresh = FALSE)bundestag_video_feed(content_id, safe = TRUE, refresh = FALSE)
content_id |
Video content id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns a video feed entry from the Bundestag webtv service. API documentation: https://bundestag.api.bund.dev/.
A one-row tibble with video feed fields extracted from XML. Column names correspond to XML element names.
<tag>One column per unique scalar child element of the XML root (character). Exact names depend on the XML document structure.
<repeated_tag>List-column when a child element name appears more than once.
Other Bundestag:
bundestag_article(),
bundestag_ausschuesse(),
bundestag_ausschuss(),
bundestag_conferences(),
bundestag_mdb_bio(),
bundestag_mdb_index(),
bundestag_speaker()
## Not run: bundestag_video_feed(7529016) ## End(Not run)## Not run: bundestag_video_feed(7529016) ## End(Not run)
Get Dashboard Deutschland GeoJSON
dashboard_deutschland_geo( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dashboard_deutschland_geo( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns GeoJSON data for Germany and the federal states. API documentation: https://dashboard.deutschland.api.bund.dev/.
A one-row tibble with GeoJSON container metadata:
GeoJSON object type (character).
Dataset name (character).
Dataset title (character).
Version identifier (character).
Short copyright label (character).
Copyright URL (character).
Coordinate reference system metadata (list-column).
GeoJSON feature collection entries (list-column).
Other Dashboard Deutschland:
dashboard_deutschland_get(),
dashboard_deutschland_indicators()
## Not run: dashboard_deutschland_geo(flatten = TRUE) ## End(Not run)## Not run: dashboard_deutschland_geo(flatten = TRUE) ## End(Not run)
List Dashboard Deutschland entries
dashboard_deutschland_get( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dashboard_deutschland_get( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns the full list of dashboard entries and metadata for each item. API documentation: https://dashboard.deutschland.api.bund.dev/.
A tibble with one row per dashboard tile:
Tile identifier (character).
Title in German (character).
Title in English (character).
Description in German (character).
Description in English (character).
Teaser text in German (character).
Teaser text in English (character).
Conclusion text in German (character).
Conclusion text in English (character).
Category metadata (list-column).
Tag metadata (list-column).
Image path/url (character).
Click counter (integer).
Ordering index (integer).
Whether tile is marked as trending (TRUE/FALSE).
Whether tile is marked as top (TRUE/FALSE).
Layout tile metadata (list-column).
Layout mode identifier (character).
Other Dashboard Deutschland:
dashboard_deutschland_geo(),
dashboard_deutschland_indicators()
## Not run: dashboard_deutschland_get() ## End(Not run)## Not run: dashboard_deutschland_get() ## End(Not run)
Query Dashboard Deutschland indicators
dashboard_deutschland_indicators(ids = NULL, safe = TRUE, refresh = FALSE)dashboard_deutschland_indicators(ids = NULL, safe = TRUE, refresh = FALSE)
ids |
Indicator ids, semicolon-separated or as a character vector. |
safe |
Logical; if |
refresh |
Logical; if |
Returns indicator data for the specified ids. API documentation: https://dashboard.deutschland.api.bund.dev/.
A tibble with one row per indicator entry:
Indicator id (character).
Timestamp in milliseconds since epoch (numeric).
Timestamp as POSIXct in Europe/Berlin.
Indicator payload as JSON string (character).
Indicator title (character).
Other Dashboard Deutschland:
dashboard_deutschland_geo(),
dashboard_deutschland_get()
## Not run: dashboard_deutschland_indicators("tile_1667811574092") ## End(Not run)## Not run: dashboard_deutschland_indicators("tile_1667811574092") ## End(Not run)
List DDB institution sectors
ddb_institution_sectors(safe = TRUE, refresh = FALSE)ddb_institution_sectors(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns institution sector metadata. Requires the DDB API key.
A tibble with one row per sector and columns:
Character. Sector name.
Integer. Number of institutions in sector.
Falls back to a one-row tibble with list-column response when the
API returns a non-homogeneous payload.
Other DDB:
ddb_institutions(),
ddb_search()
## Not run: ddb_institution_sectors() ## End(Not run)## Not run: ddb_institution_sectors() ## End(Not run)
List DDB institutions
ddb_institutions( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )ddb_institutions( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of institution query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns institutions registered in the DDB. Requires the DDB API key.
A tibble with one row per institution and columns:
Character. Institution identifier.
Character. Display name.
Numeric. Geographic latitude.
Numeric. Geographic longitude.
Character. Cultural sector code.
List. Nested child institutions.
Falls back to a one-row tibble with list-column response when the
API returns a non-homogeneous payload.
bunddev_parameters() to inspect available query parameters.
Other DDB:
ddb_institution_sectors(),
ddb_search()
## Not run: ddb_institutions(params = list(hasItems = TRUE)) ## End(Not run)## Not run: ddb_institutions(params = list(hasItems = TRUE)) ## End(Not run)
Search Deutsche Digitale Bibliothek
ddb_search( query, params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )ddb_search( query, params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
query |
Search query string. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns search results from the Deutsche Digitale Bibliothek API. You need an
API key from https://www.deutsche-digitale-bibliothek.de/user/apikey. The key
is sent in the Authorization header as OAuth oauth_consumer_key="<key>".
Configure authentication via bunddev_auth_set() using a template-style
scheme, or set the DDB_API_KEY environment variable directly.
A one-row tibble with one list-column:
Full parsed DDB search payload (list-column).
bunddev_parameters() to inspect available query parameters.
bunddev_auth_set() to configure authentication.
Other DDB:
ddb_institution_sectors(),
ddb_institutions()
## Not run: # Recommended: use bunddev_auth_set with template scheme Sys.setenv(DDB_API_KEY = "<api-key>") bunddev_auth_set("ddb", type = "api_key", env_var = "DDB_API_KEY", scheme = "OAuth oauth_consumer_key=\"%s\"") ddb_search(query = "berlin", params = list(rows = 5)) ## End(Not run)## Not run: # Recommended: use bunddev_auth_set with template scheme Sys.setenv(DDB_API_KEY = "<api-key>") bunddev_auth_set("ddb", type = "api_key", env_var = "DDB_API_KEY", scheme = "OAuth oauth_consumer_key=\"%s\"") ddb_search(query = "berlin", params = list(rows = 5)) ## End(Not run)
List Destatis cubes
destatis_catalogue_cubes( params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )destatis_catalogue_cubes( params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )
params |
Named list of Genesis API query parameters. Common keys:
|
username |
Genesis username (default "GAST"). |
password |
Genesis password (default "GAST"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns the cube catalogue from the Destatis Genesis API. API documentation: https://github.com/bundesAPI/destatis-api.
A one-row tibble with one list-column response containing the
parsed catalogue payload.
Catalogue endpoints: full API payload as list-column.
Data endpoints: requested table/cube name (character).
Data endpoints: full payload as list-column.
bunddev_parameters() to inspect available query parameters.
Other Destatis:
destatis_catalogue_tables(),
destatis_data_cube(),
destatis_data_table()
## Not run: destatis_catalogue_cubes() ## End(Not run)## Not run: destatis_catalogue_cubes() ## End(Not run)
List Destatis tables
destatis_catalogue_tables( params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )destatis_catalogue_tables( params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )
params |
Named list of Genesis API query parameters. Common keys:
|
username |
Genesis username (default "GAST"). |
password |
Genesis password (default "GAST"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns the table catalogue from the Destatis Genesis API. API documentation: https://github.com/bundesAPI/destatis-api.
A one-row tibble with one list-column response containing the
parsed catalogue payload.
Catalogue endpoints: full API payload as list-column.
Data endpoints: requested table/cube name (character).
Data endpoints: full payload as list-column.
bunddev_parameters() to inspect available query parameters.
Other Destatis:
destatis_catalogue_cubes(),
destatis_data_cube(),
destatis_data_table()
## Not run: destatis_catalogue_tables() ## End(Not run)## Not run: destatis_catalogue_tables() ## End(Not run)
Retrieve Destatis cube data
destatis_data_cube( name, params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )destatis_data_cube( name, params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )
name |
Cube id. |
params |
Named list of Genesis API query parameters. Common keys:
|
username |
Genesis username (default "GAST"). |
password |
Genesis password (default "GAST"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns cube data as text (csv by default). API documentation: https://github.com/bundesAPI/destatis-api.
A one-row tibble with:
Requested cube id (character).
Raw response body (typically CSV/text) (character).
bunddev_parameters() to inspect available query parameters.
Other Destatis:
destatis_catalogue_cubes(),
destatis_catalogue_tables(),
destatis_data_table()
## Not run: destatis_data_cube("21231BJ001") ## End(Not run)## Not run: destatis_data_cube("21231BJ001") ## End(Not run)
Retrieve Destatis table data
destatis_data_table( name, params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )destatis_data_table( name, params = list(), username = "GAST", password = "GAST", safe = TRUE, refresh = FALSE )
name |
Table id. |
params |
Named list of Genesis API query parameters. Common keys:
|
username |
Genesis username (default "GAST"). |
password |
Genesis password (default "GAST"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns table data as text (csv by default). API documentation: https://github.com/bundesAPI/destatis-api.
A one-row tibble with:
Requested table id (character).
Raw response body (typically CSV/text) (character).
bunddev_parameters() to inspect available query parameters.
Other Destatis:
destatis_catalogue_cubes(),
destatis_catalogue_tables(),
destatis_data_cube()
## Not run: destatis_data_table("12411-0001") ## End(Not run)## Not run: destatis_data_table("12411-0001") ## End(Not run)
Query Deutschlandatlas indicators
deutschlandatlas_query( table = "p_apo_f_ZA2022", params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )deutschlandatlas_query( table = "p_apo_f_ZA2022", params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
table |
Table id (default "p_apo_f_ZA2022"). |
params |
Named list of ArcGIS query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Deutschlandatlas API is backed by an ArcGIS feature service. You must
supply a where filter and output format f (usually "json"). API documentation: https://github.com/AndreasFischer1985/deutschlandatlas-api.
A tibble with one row per ArcGIS feature. Attribute names are
normalized to lower snake_case. Includes a geometry list-column.
One column per ArcGIS attributes field (sanitized to snake_case).
Geometry object as list-column when requested/available.
bunddev_parameters() to inspect available query parameters.
## Not run: deutschlandatlas_query( table = "p_apo_f_ZA2022", params = list( where = "1=1", outFields = "*", f = "json", returnGeometry = "false", resultRecordCount = 5 ) ) ## End(Not run)## Not run: deutschlandatlas_query( table = "p_apo_f_ZA2022", params = list( where = "1=1", outFields = "*", f = "json", returnGeometry = "false", resultRecordCount = 5 ) ) ## End(Not run)
List DiGA catalog entries
diga_catalog_entries( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )diga_catalog_entries( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of FHIR search parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per catalog entry and columns:
Character. FHIR resource type, always "CatalogEntry".
Character. FHIR resource identifier.
Character. Entry status.
Logical. Whether the entry is orderable.
List. Resource metadata (profile, timestamps).
List. Business identifiers.
List. Catalog entry type coding.
List. Referenced device definition.
List. FHIR profile extensions.
List. Additional characteristics.
bunddev_parameters() to inspect available query parameters.
Other DiGA:
diga_charge_item_definitions(),
diga_device_definitions(),
diga_organizations(),
diga_questionnaire_responses(),
diga_questionnaires()
List DiGA prescription units
diga_charge_item_definitions( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )diga_charge_item_definitions( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of FHIR search parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per charge item definition and columns:
Character. FHIR resource type, always "ChargeItemDefinition".
Character. FHIR resource identifier.
Character. Canonical URL of the resource.
Character. Publication status.
Character. Description text.
List. Resource metadata (profile, timestamps).
List. Business identifiers.
List. Charge item code.
List. Referenced device definitions.
List. Applicability conditions.
List. Pricing properties.
List. FHIR profile extensions.
bunddev_parameters() to inspect available query parameters.
Other DiGA:
diga_catalog_entries(),
diga_device_definitions(),
diga_organizations(),
diga_questionnaire_responses(),
diga_questionnaires()
List DiGA device definitions
diga_device_definitions( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )diga_device_definitions( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of FHIR search parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per device definition and columns:
Character. FHIR resource type, always "DeviceDefinition".
Character. FHIR resource identifier.
Character. Canonical URL of the resource.
Character. Publication status.
Character. Device description text.
List. Resource metadata (profile, timestamps).
List. Business identifiers.
List. Device type coding.
List. Device name entries.
List. Device properties.
List. FHIR profile extensions.
Other DiGA:
diga_catalog_entries(),
diga_charge_item_definitions(),
diga_organizations(),
diga_questionnaire_responses(),
diga_questionnaires()
## Not run: dig_device_definitions()## Not run: dig_device_definitions()
List DiGA manufacturers
diga_organizations( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )diga_organizations( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of FHIR search parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per organization and columns:
Character. FHIR resource type, always "Organization".
Character. FHIR resource identifier.
Character. Organization display name.
Logical. Whether the organization is active.
List. Resource metadata (profile, timestamps).
List. Business identifiers.
List. Organization type coding.
List. Contact details.
List. Postal addresses.
List. FHIR profile extensions.
bunddev_parameters() to inspect available query parameters.
Other DiGA:
diga_catalog_entries(),
diga_charge_item_definitions(),
diga_device_definitions(),
diga_questionnaire_responses(),
diga_questionnaires()
List DiGA questionnaire responses
diga_questionnaire_responses( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )diga_questionnaire_responses( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of FHIR search parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per questionnaire response and columns:
Character. FHIR resource type, always "QuestionnaireResponse".
Character. FHIR resource identifier.
Character. Response completion status.
Character. When the response was authored.
List. Resource metadata (profile, timestamps).
List. Business identifiers.
Character. Reference to source questionnaire.
List. Response items and answers.
List. FHIR profile extensions.
bunddev_parameters() to inspect available query parameters.
Other DiGA:
diga_catalog_entries(),
diga_charge_item_definitions(),
diga_device_definitions(),
diga_organizations(),
diga_questionnaires()
List DiGA questionnaires
diga_questionnaires( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )diga_questionnaires( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of FHIR search parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per questionnaire and columns:
Character. FHIR resource type, always "Questionnaire".
Character. FHIR resource identifier.
Character. Canonical URL of the resource.
Character. Publication status.
Character. Computer-friendly name.
Character. Human-readable title.
List. Resource metadata (profile, timestamps).
List. Business identifiers.
List. Questionnaire items and groups.
List. FHIR profile extensions.
bunddev_parameters() to inspect available query parameters.
Other DiGA:
diga_catalog_entries(),
diga_charge_item_definitions(),
diga_device_definitions(),
diga_organizations(),
diga_questionnaire_responses()
Get a DIP Aktivität
dip_bundestag_aktivitaet( aktivitaet_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_aktivitaet( aktivitaet_id, params = list(), safe = TRUE, refresh = FALSE )
aktivitaet_id |
Aktivität id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected Aktivitaet:
Aktivitaet identifier (character).
Activity type, e.g. "Rede" (character).
Entity type, always "Aktivität" (character).
Document type: "Drucksache" or "Plenarprotokoll" (character).
Legislative period (integer).
Date of associated document (character, ISO date).
Last update timestamp (character, ISO datetime).
Title (character).
Document reference details (list-column).
Up to 4 related Vorgänge (list-column).
Total number of related Vorgänge (integer).
Thesaurus descriptors (list-column).
Summary text (character or NA).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_aktivitaet(1493545) ## End(Not run)## Not run: dip_bundestag_aktivitaet(1493545) ## End(Not run)
List DIP Aktivitäten
dip_bundestag_aktivitaet_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_aktivitaet_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per Aktivitaet and columns:
Character. Unique Aktivitaet identifier.
Character. Activity type.
Character. Entity type, always "Aktivitaet".
Character. Document type.
Integer. Legislative period.
Character. Date of associated document.
Character. Last update timestamp.
Character. Title text.
Integer. Total related Vorgaenge.
Character. Summary text.
List. Document reference details.
List. Related Vorgaenge.
List. Thesaurus descriptor entries.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_aktivitaet_list() ## End(Not run)## Not run: dip_bundestag_aktivitaet_list() ## End(Not run)
Get a DIP Drucksache
dip_bundestag_drucksache( drucksache_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_drucksache( drucksache_id, params = list(), safe = TRUE, refresh = FALSE )
drucksache_id |
Drucksache id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected Drucksache:
Drucksache identifier (character).
Entity type, always "Dokument" (character).
Document type, always "Drucksache" (character).
Drucksache subtype, e.g. "Antrag" (character).
Document number, e.g. "19/1" (character).
Legislative period (integer).
Publisher: "BT" or "BR" (character).
Publication date (character, ISO date).
Last update timestamp (character, ISO datetime).
Title (character).
Up to 4 authors for display (list-column).
Total author count (integer).
Document reference details (list-column).
MD5 checksum of the PDF file (character or NA).
Authoring bodies (list-column).
Up to 4 related Vorgänge (list-column).
Total number of related Vorgänge (integer).
Government departments involved (list-column).
Appendix description (character or NA).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_drucksache(68852) ## End(Not run)## Not run: dip_bundestag_drucksache(68852) ## End(Not run)
List DIP Drucksachen
dip_bundestag_drucksache_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_drucksache_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per Drucksache and columns:
Character. Unique Drucksache identifier.
Character. Entity type, always "Dokument".
Character. Document type, always "Drucksache".
Character. Drucksache subtype.
Character. Document number.
Integer. Legislative period.
Character. Publisher: "BT" or "BR".
Character. Publication date.
Character. Last update timestamp.
Character. Title text.
Integer. Total author count.
Character. MD5 checksum of PDF file.
Integer. Total related Vorgaenge.
Character. Appendix description.
List. Up to 4 display authors.
List. Document reference details.
List. Authoring bodies.
List. Related Vorgaenge.
List. Government departments involved.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_drucksache_list() ## End(Not run)## Not run: dip_bundestag_drucksache_list() ## End(Not run)
Get a DIP Drucksache text
dip_bundestag_drucksache_text( drucksache_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_drucksache_text( drucksache_id, params = list(), safe = TRUE, refresh = FALSE )
drucksache_id |
Drucksache id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected Drucksache text record.
Contains all columns from dip_bundestag_drucksache() plus:
Full document text (character).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_drucksache_text(68852) ## End(Not run)## Not run: dip_bundestag_drucksache_text(68852) ## End(Not run)
List DIP Drucksache texts
dip_bundestag_drucksache_text_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_drucksache_text_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per Drucksache text and columns:
Character. Unique Drucksache identifier.
Character. Entity type, always "Dokument".
Character. Document type, always "Drucksache".
Character. Drucksache subtype.
Character. Document number.
Integer. Legislative period.
Character. Publisher: "BT" or "BR".
Character. Publication date.
Character. Last update timestamp.
Character. Title text.
Integer. Total author count.
Character. MD5 checksum of PDF file.
Integer. Total related Vorgaenge.
Character. Appendix description.
Character. Full document text.
List. Up to 4 display authors.
List. Document reference details.
List. Authoring bodies.
List. Related Vorgaenge.
List. Government departments involved.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_drucksache_text_list() ## End(Not run)## Not run: dip_bundestag_drucksache_text_list() ## End(Not run)
Get a DIP Person
dip_bundestag_person(person_id, params = list(), safe = TRUE, refresh = FALSE)dip_bundestag_person(person_id, params = list(), safe = TRUE, refresh = FALSE)
person_id |
Person id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected person:
Person identifier (character).
Last name (character).
First name (character).
Name affix, e.g. "von der" (character or NA).
Entity type, always "Person" (character).
Legislative period of first associated document (integer or NA).
Date of first associated document (character or NA).
Date of most recent associated document (character or NA).
Last update timestamp (character, ISO datetime).
Display title with role (character).
Roles and alternative names (list-column).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_person(1728) ## End(Not run)## Not run: dip_bundestag_person(1728) ## End(Not run)
List DIP Personen
dip_bundestag_person_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_person_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per Person and columns:
Character. Unique person identifier.
Character. Last name.
Character. First name.
Character. Name affix.
Character. Entity type, always "Person".
Integer. Legislative period of first document.
Character. Date of first associated document.
Character. Date of most recent document.
Character. Last update timestamp.
Character. Display title with role.
List. Roles and alternative names.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_person_list() ## End(Not run)## Not run: dip_bundestag_person_list() ## End(Not run)
Get a DIP Plenarprotokoll
dip_bundestag_plenarprotokoll( plenarprotokoll_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_plenarprotokoll( plenarprotokoll_id, params = list(), safe = TRUE, refresh = FALSE )
plenarprotokoll_id |
Plenarprotokoll id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected Plenarprotokoll:
Plenarprotokoll identifier (character).
Document type, always "Plenarprotokoll" (character).
Entity type, always "Dokument" (character).
Document number, e.g. "19/1" (character).
Legislative period (integer).
Publisher assignment (character).
Session date (character, ISO date).
Last update timestamp (character, ISO datetime).
Title (character).
Document reference details (list-column).
MD5 checksum of the PDF file (character or NA).
Up to 4 related Vorgänge (list-column).
Total number of related Vorgänge (integer).
Session remark, e.g. "Sondersitzung" (character or NA).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_plenarprotokoll(908) ## End(Not run)## Not run: dip_bundestag_plenarprotokoll(908) ## End(Not run)
List DIP Plenarprotokolle
dip_bundestag_plenarprotokoll_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_plenarprotokoll_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per Plenarprotokoll and columns:
Character. Unique Plenarprotokoll identifier.
Character. Document type, always "Plenarprotokoll".
Character. Entity type, always "Dokument".
Character. Document number.
Integer. Legislative period.
Character. Session date.
Character. Last update timestamp.
Character. Title text.
Character. MD5 checksum of PDF file.
Integer. Total related Vorgaenge.
Character. Session remark.
List. Publisher assignment.
List. Document reference details.
List. Related Vorgaenge.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_plenarprotokoll_list() ## End(Not run)## Not run: dip_bundestag_plenarprotokoll_list() ## End(Not run)
Get a DIP Plenarprotokoll text
dip_bundestag_plenarprotokoll_text( plenarprotokoll_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_plenarprotokoll_text( plenarprotokoll_id, params = list(), safe = TRUE, refresh = FALSE )
plenarprotokoll_id |
Plenarprotokoll id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected Plenarprotokoll text record.
Contains all columns from dip_bundestag_plenarprotokoll() plus:
Full document text (character).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_plenarprotokoll_text(908) ## End(Not run)## Not run: dip_bundestag_plenarprotokoll_text(908) ## End(Not run)
List DIP Plenarprotokoll texts
dip_bundestag_plenarprotokoll_text_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_plenarprotokoll_text_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
A tibble with one row per Plenarprotokoll text and columns:
Character. Unique Plenarprotokoll identifier.
Character. Document type, always "Plenarprotokoll".
Character. Entity type, always "Dokument".
Character. Document number.
Integer. Legislative period.
Character. Session date.
Character. Last update timestamp.
Character. Title text.
Character. MD5 checksum of PDF file.
Integer. Total related Vorgaenge.
Character. Session remark.
Character. Full document text.
List. Publisher assignment.
List. Document reference details.
List. Related Vorgaenge.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_plenarprotokoll_text_list() ## End(Not run)## Not run: dip_bundestag_plenarprotokoll_text_list() ## End(Not run)
Get a DIP Vorgang
dip_bundestag_vorgang( vorgang_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_vorgang( vorgang_id, params = list(), safe = TRUE, refresh = FALSE )
vorgang_id |
Vorgang id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns metadata for a single Vorgang.
A one-row tibble for the selected Vorgang:
Vorgang identifier (character).
Entity type, always "Vorgang" (character).
Consultation status, e.g. "Abgeschlossen" (character).
Vorgang type, e.g. "Geschäftsordnung" (character).
Legislative period (integer).
Initiating factions/bodies (list-column).
Date of most recent associated document (character, ISO date).
Last update timestamp (character, ISO datetime).
Title (character).
Summary text (character or NA).
Subject areas (list-column).
Thesaurus descriptors (list-column of named lists).
GESTA reference number (character or NA).
Consent requirements (list-column).
EU COM reference number (character or NA).
EU Council document number (character or NA).
Promulgation details (list-column).
Entry-into-force details (list-column).
Archive reference (character or NA).
Supplementary note (character or NA).
Linked Vorgänge (list-column).
EU SEC reference number (character or NA).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_vorgang(84343) ## End(Not run)## Not run: dip_bundestag_vorgang(84343) ## End(Not run)
List DIP Vorgang entries
dip_bundestag_vorgang_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_vorgang_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns metadata for DIP Vorgang entries. Requires an API key. Obtain a key from https://dip.bundestag.de/über-dip/hilfe/api.
Configure authentication via bunddev_auth_set() or set the
DIP_BUNDESTAG_API_KEY environment variable directly.
A tibble with one row per Vorgang and columns:
Character. Unique Vorgang identifier.
Character. Entity type, always "Vorgang".
Character. Consultation status.
Character. Vorgang type.
Integer. Legislative period.
Character. Date of last associated document.
Character. Last update timestamp.
Character. Title text.
Character. Summary text.
Character. GESTA reference number.
Character. EU COM reference number.
Character. EU Council document number.
Character. Archive reference.
Character. Supplementary note.
Character. EU SEC reference number.
List. Initiating factions or bodies.
List. Subject areas.
List. Thesaurus descriptor entries.
List. Consent requirements.
List. Promulgation details.
List. Entry-into-force details.
List. Linked Vorgaenge.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
bunddev_auth_set() to configure authentication.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgangsposition(),
dip_bundestag_vorgangsposition_list()
## Not run: # Recommended: use bunddev_auth_set Sys.setenv(DIP_BUNDESTAG_API_KEY = "<api-key>") bunddev_auth_set( "dip_bundestag", type = "api_key", env_var = "DIP_BUNDESTAG_API_KEY", scheme = "ApiKey" ) dip_bundestag_vorgang_list() ## End(Not run)## Not run: # Recommended: use bunddev_auth_set Sys.setenv(DIP_BUNDESTAG_API_KEY = "<api-key>") bunddev_auth_set( "dip_bundestag", type = "api_key", env_var = "DIP_BUNDESTAG_API_KEY", scheme = "ApiKey" ) dip_bundestag_vorgang_list() ## End(Not run)
Get a DIP Vorgangsposition
dip_bundestag_vorgangsposition( vorgangsposition_id, params = list(), safe = TRUE, refresh = FALSE )dip_bundestag_vorgangsposition( vorgangsposition_id, params = list(), safe = TRUE, refresh = FALSE )
vorgangsposition_id |
Vorgangsposition id. |
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble for the selected Vorgangsposition:
Vorgangsposition identifier (character).
Step description (character).
Assignment: "BT", "BR", "BV", or "EK" (character).
Key step in the legislative process (logical).
Continuation of a previous debate (logical).
Addendum entry (logical).
Parent Vorgang type (character).
Entity type, always "Vorgangsposition" (character).
Title of the parent Vorgang (character).
Document type: "Drucksache" or "Plenarprotokoll" (character).
Parent Vorgang id (character).
Date of associated document (character, ISO date).
Last update timestamp (character, ISO datetime).
Document reference details (list-column).
Authoring bodies (list-column).
Committee referrals (list-column).
Up to 4 associated activities for display (list-column).
Total number of associated activities (integer).
Government departments involved (list-column).
Voting decisions (list-column).
EU Council document number (character or NA).
EU COM reference number (character or NA).
EU SEC reference number (character or NA).
Co-deliberated Vorgangspositionen (list-column).
Summary text (character or NA).
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition_list()
## Not run: dip_bundestag_vorgangsposition(173376) ## End(Not run)## Not run: dip_bundestag_vorgangsposition(173376) ## End(Not run)
List DIP Vorgangsposition entries
dip_bundestag_vorgangsposition_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dip_bundestag_vorgangsposition_list( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns metadata for Vorgangsposition entries.
A tibble with one row per Vorgangsposition and columns:
Character. Unique Vorgangsposition identifier.
Character. Step description.
Logical. Key step in legislative process.
Logical. Continuation of prior debate.
Logical. Addendum entry.
Character. Parent Vorgang type.
Character. Entity type, always "Vorgangsposition".
Character. Title of the parent Vorgang.
Character. Document type.
Character. Parent Vorgang identifier.
Character. Date of associated document.
Character. Last update timestamp.
Integer. Total associated activities.
Character. EU Council document number.
Character. EU COM reference number.
Character. EU SEC reference number.
Character. Summary text.
List. Assignment to BT/BR/BV/EK.
List. Document reference details.
List. Authoring bodies.
List. Committee referrals.
List. Up to 4 display activities.
List. Government departments involved.
List. Voting decisions.
List. Co-deliberated Vorgangspositionen.
Wrapped in a one-row tibble with num_found (integer), cursor
(character), and documents (list-column) when not yet unpacked.
bunddev_parameters() to inspect available query parameters.
Other DIP Bundestag:
dip_bundestag_aktivitaet(),
dip_bundestag_aktivitaet_list(),
dip_bundestag_drucksache(),
dip_bundestag_drucksache_list(),
dip_bundestag_drucksache_text(),
dip_bundestag_drucksache_text_list(),
dip_bundestag_person(),
dip_bundestag_person_list(),
dip_bundestag_plenarprotokoll(),
dip_bundestag_plenarprotokoll_list(),
dip_bundestag_plenarprotokoll_text(),
dip_bundestag_plenarprotokoll_text_list(),
dip_bundestag_vorgang(),
dip_bundestag_vorgang_list(),
dip_bundestag_vorgangsposition()
## Not run: dip_bundestag_vorgangsposition_list() ## End(Not run)## Not run: dip_bundestag_vorgangsposition_list() ## End(Not run)
Fetch DWD alpine forecast text
dwd_alpine_forecast_text(safe = TRUE, refresh = FALSE)dwd_alpine_forecast_text(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Retrieves alpine forecast text from the DWD App API. API documentation: https://dwd.api.bund.dev.
A one-row tibble:
Alpine forecast text (character).
dwd_sea_warning_text() and dwd_avalanche_warnings().
Other DWD:
dwd_avalanche_warnings(),
dwd_coast_warnings(),
dwd_crowd_reports(),
dwd_municipality_warnings(),
dwd_sea_warning_text(),
dwd_station_overview(),
dwd_warnings_nowcast()
## Not run: dwd_alpine_forecast_text() ## End(Not run)## Not run: dwd_alpine_forecast_text() ## End(Not run)
Fetch DWD avalanche warnings
dwd_avalanche_warnings(safe = TRUE, refresh = FALSE)dwd_avalanche_warnings(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Retrieves avalanche warnings from the DWD App API. API documentation: https://dwd.api.bund.dev.
A one-row tibble:
Full parsed avalanche warning payload (list-column).
dwd_alpine_forecast_text() and dwd_sea_warning_text().
Other DWD:
dwd_alpine_forecast_text(),
dwd_coast_warnings(),
dwd_crowd_reports(),
dwd_municipality_warnings(),
dwd_sea_warning_text(),
dwd_station_overview(),
dwd_warnings_nowcast()
## Not run: dwd_avalanche_warnings() ## End(Not run)## Not run: dwd_avalanche_warnings() ## End(Not run)
Fetch DWD coastal warnings
dwd_coast_warnings( language = c("de", "en"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dwd_coast_warnings( language = c("de", "en"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
language |
Language code ("de" or "en"). |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Retrieves coastal warnings from the DWD App API. API documentation: https://dwd.api.bund.dev.
A tibble with one row per coastal warning:
Warning region identifier (character).
Warning type code (numeric).
Warning severity level (numeric).
Warning description HTML (character).
Warning description plain text (character).
Event name (character).
Warning headline (character).
dwd_warnings_nowcast() and dwd_municipality_warnings().
Other DWD:
dwd_alpine_forecast_text(),
dwd_avalanche_warnings(),
dwd_crowd_reports(),
dwd_municipality_warnings(),
dwd_sea_warning_text(),
dwd_station_overview(),
dwd_warnings_nowcast()
## Not run: dwd_coast_warnings(language = "de", flatten = TRUE) ## End(Not run)## Not run: dwd_coast_warnings(language = "de", flatten = TRUE) ## End(Not run)
Fetch DWD crowd reports
dwd_crowd_reports( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dwd_crowd_reports( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Retrieves crowd-sourced weather reports from the DWD App API. API documentation: https://dwd.api.bund.dev.
A tibble with one row per crowd report:
Report identifier (numeric).
Report timestamp in milliseconds (numeric).
Parsed report time (POSIXct).
Latitude (character).
Longitude (character).
Place name (character).
Weather category (character).
Severity/manifestation (character).
Additional attributes (list-column).
dwd_station_overview() and dwd_warnings_nowcast().
Other DWD:
dwd_alpine_forecast_text(),
dwd_avalanche_warnings(),
dwd_coast_warnings(),
dwd_municipality_warnings(),
dwd_sea_warning_text(),
dwd_station_overview(),
dwd_warnings_nowcast()
## Not run: dwd_crowd_reports(flatten = TRUE) ## End(Not run)## Not run: dwd_crowd_reports(flatten = TRUE) ## End(Not run)
Fetch DWD municipality warnings
dwd_municipality_warnings( language = c("de", "en"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dwd_municipality_warnings( language = c("de", "en"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
language |
Language code ("de" or "en"). |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Retrieves municipality warnings from the DWD App API. API documentation: https://dwd.api.bund.dev.
A tibble with the same columns as dwd_warnings_nowcast().
dwd_warnings_nowcast() and dwd_coast_warnings().
Other DWD:
dwd_alpine_forecast_text(),
dwd_avalanche_warnings(),
dwd_coast_warnings(),
dwd_crowd_reports(),
dwd_sea_warning_text(),
dwd_station_overview(),
dwd_warnings_nowcast()
## Not run: dwd_municipality_warnings(language = "de", flatten = TRUE) ## End(Not run)## Not run: dwd_municipality_warnings(language = "de", flatten = TRUE) ## End(Not run)
Fetch DWD sea warning text
dwd_sea_warning_text(safe = TRUE, refresh = FALSE)dwd_sea_warning_text(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Retrieves sea warning text from the DWD App API. API documentation: https://dwd.api.bund.dev.
A one-row tibble:
Sea warning text (character).
dwd_alpine_forecast_text() and dwd_avalanche_warnings().
Other DWD:
dwd_alpine_forecast_text(),
dwd_avalanche_warnings(),
dwd_coast_warnings(),
dwd_crowd_reports(),
dwd_municipality_warnings(),
dwd_station_overview(),
dwd_warnings_nowcast()
## Not run: dwd_sea_warning_text() ## End(Not run)## Not run: dwd_sea_warning_text() ## End(Not run)
Fetch DWD station overview data
dwd_station_overview( station_ids, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dwd_station_overview( station_ids, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
station_ids |
Station identifiers. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Retrieves station overview data from the DWD App API. API documentation: https://dwd.api.bund.dev. resources or the API documentation.
A tibble with one row per station id:
Station id (character).
Forecast block 1 (list-column).
Forecast block 2 (list-column).
Forecast start timestamp (character).
Forecast start as POSIXct in Europe/Berlin.
Daily forecast summaries (list-column).
Warning entries (list-column).
Three-hour summaries (list-column).
forecast1 start as POSIXct.
forecast2 start as POSIXct.
dwd_crowd_reports() and dwd_warnings_nowcast().
Other DWD:
dwd_alpine_forecast_text(),
dwd_avalanche_warnings(),
dwd_coast_warnings(),
dwd_crowd_reports(),
dwd_municipality_warnings(),
dwd_sea_warning_text(),
dwd_warnings_nowcast()
## Not run: dwd_station_overview(c("10865", "G005"), flatten = TRUE) ## End(Not run)## Not run: dwd_station_overview(c("10865", "G005"), flatten = TRUE) ## End(Not run)
Fetch DWD nowcast warnings
dwd_warnings_nowcast( language = c("de", "en"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )dwd_warnings_nowcast( language = c("de", "en"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
language |
Language code ("de" or "en"). |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Retrieves nowcast weather warnings from the DWD App API. API documentation: https://dwd.api.bund.dev.
A tibble with one row per warning:
Warning type code (numeric).
Warning severity level (numeric).
Start timestamp in milliseconds (numeric).
Parsed start time (POSIXct).
End timestamp in milliseconds (numeric).
Parsed end time (POSIXct).
Warning description HTML (character).
Warning description plain text (character).
Event name (character).
Warning headline (character).
Affected regions (list-column).
Related URLs (list-column).
Whether this is a preliminary warning (logical).
With flatten = TRUE, the list-columns are transformed according to
flatten_mode.
dwd_municipality_warnings() and dwd_coast_warnings().
Other DWD:
dwd_alpine_forecast_text(),
dwd_avalanche_warnings(),
dwd_coast_warnings(),
dwd_crowd_reports(),
dwd_municipality_warnings(),
dwd_sea_warning_text(),
dwd_station_overview()
## Not run: dwd_warnings_nowcast(language = "de", flatten = TRUE) ## End(Not run)## Not run: dwd_warnings_nowcast(language = "de", flatten = TRUE) ## End(Not run)
List Eco-Visio counters for an organization
eco_visio_counters(id_organisme, safe = TRUE, refresh = FALSE)eco_visio_counters(id_organisme, safe = TRUE, refresh = FALSE)
id_organisme |
Organization ID (e.g., 4586 for Bike Count Display). |
safe |
Logical; if |
refresh |
Logical; if |
The Eco-Visio API provides access to bicycle and pedestrian counter data. This function returns all counters registered for a specific organization. API documentation: https://github.com/bundesAPI/eco-visio-api.
A tibble with one row per counter. Common columns:
Counter identifier (character).
Counter name/label (character).
Latitude (numeric).
Longitude (numeric).
Flow/practice identifiers (list-column).
Original counter object (list-column).
eco_visio_data() to retrieve measurement data for a counter.
Other Eco Visio:
eco_visio_data()
## Not run: eco_visio_counters(4586) ## End(Not run)## Not run: eco_visio_counters(4586) ## End(Not run)
Get Eco-Visio counter measurement data
eco_visio_data( id_organisme, id_pdc, interval, flow_ids, begin = NULL, end = NULL, safe = TRUE, refresh = FALSE )eco_visio_data( id_organisme, id_pdc, interval, flow_ids, begin = NULL, end = NULL, safe = TRUE, refresh = FALSE )
id_organisme |
Organization ID. |
id_pdc |
Counter ID. |
interval |
Aggregation interval (1-6: 1=15min, 2=hours, 3=days, 4=weeks, 5=months, 6=years). |
flow_ids |
Practice IDs (semicolon-separated string or character vector). |
begin |
Optional start date (Date or "YYYY-MM-DD" string). |
end |
Optional end date (Date or "YYYY-MM-DD" string). |
safe |
Logical; if |
refresh |
Logical; if |
Returns measurement data for a specific counter. The flow_ids parameter
specifies which traffic types to include (e.g., pedestrians, cyclists).
Use eco_visio_counters() to discover available counters and their flow IDs.
A tibble with one row per measurement interval:
Interval timestamp/date label from the API (character).
Count value for the selected flow(s) (integer).
date converted to POSIXct in Europe/Berlin.
eco_visio_counters() to list available counters.
Other Eco Visio:
eco_visio_counters()
## Not run: # Get daily data for a counter eco_visio_data( id_organisme = 4586, id_pdc = 100125331, interval = 4, flow_ids = "101125331" ) ## End(Not run)## Not run: # Get daily data for a counter eco_visio_data( id_organisme = 4586, id_pdc = 100125331, interval = 4, flow_ids = "101125331" ) ## End(Not run)
List German public holidays
feiertage_list( jahr = NULL, nur_land = NULL, nur_daten = NULL, safe = TRUE, refresh = FALSE )feiertage_list( jahr = NULL, nur_land = NULL, nur_daten = NULL, safe = TRUE, refresh = FALSE )
jahr |
Year to query (defaults to current year on the API). |
nur_land |
Optional Bundesland code to filter. |
nur_daten |
Logical; return only date values (1) or include names (0). |
safe |
Logical; if |
refresh |
Logical; if |
The Feiertage API returns German public holidays from a Wikipedia-based dataset. The endpoint supports filtering by year and Bundesland. Official docs: https://github.com/bundesAPI/feiertage-api.
A tibble with one row per holiday:
Bundesland code (character, NA for nationwide results).
Holiday name (character).
Date in YYYY-MM-DD format (character).
Optional holiday note from the API (character or NA).
Date as POSIXct in Europe/Berlin.
bunddev_parameters() for available query parameters.
## Not run: feiertage_list(jahr = 2024) feiertage_list(jahr = 2024, nur_land = "BY") ## End(Not run)## Not run: feiertage_list(jahr = 2024) feiertage_list(jahr = 2024, nur_land = "BY") ## End(Not run)
This adapter scrapes the public Handelsregister search form because no official OpenAPI specification is available for this service.
handelsregister_search( schlagwoerter, schlagwort_optionen = c("all", "min", "exact"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )handelsregister_search( schlagwoerter, schlagwort_optionen = c("all", "min", "exact"), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
schlagwoerter |
Search terms. |
schlagwort_optionen |
Keyword options. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Handelsregister search is provided via a public web form. This helper automates the form flow and parses the result table into a tidy tibble. API documentation: https://github.com/bundesAPI/handelsregister.
The registry notes that more than 60 requests per hour may violate the terms
of use. Use safe = TRUE to respect the built-in rate limiting.
A tibble with one row per register entry:
Company/entity name (character).
Register court and register label (character).
Extracted register number (character).
Federal state (character).
Status text from the listing (character).
Uppercase status code derived from status (character).
Document summary text (character).
Number of linked documents (integer).
Document URLs (list-column of character vectors).
Additional parsed history tokens (list-column).
bunddev_rate_limit_get() to inspect the configured limit.
## Not run: handelsregister_search("Deutsche Bahn", schlagwort_optionen = "all") ## End(Not run)## Not run: handelsregister_search("Deutsche Bahn", schlagwort_optionen = "all") ## End(Not run)
Get Hilfsmittel verification schema details
hilfsmittel_nachweisschema( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hilfsmittel_nachweisschema( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
id |
Nachweisschema id. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns detail information for a Nachweisschema. API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row for the requested verification schema and columns:
Character. Schema identifier.
Character. Schema name.
Logical. Whether a product sample is required.
List. Category assignments (nested objects).
List. Section requirements (nested objects).
Other Hilfsmittel:
hilfsmittel_produkt(),
hilfsmittel_produktart(),
hilfsmittel_produkte(),
hilfsmittel_produktgruppe(),
hilfsmittel_tree(),
hilfsmittel_untergruppe()
## Not run: hilfsmittel_nachweisschema("a3d37017-2c91-4d6d-bbbe-4002d2868044") ## End(Not run)## Not run: hilfsmittel_nachweisschema("a3d37017-2c91-4d6d-bbbe-4002d2868044") ## End(Not run)
Get Hilfsmittel product details
hilfsmittel_produkt( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hilfsmittel_produkt( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
id |
Produkt id. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns detail information for a single product. API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row for the requested product and columns:
Character. Organisation identifier.
Character. Product-type identifier.
Integer. Sequential product number.
Character. Product name.
List. Article numbers (character vector).
List. Type/model variants (character vector).
Character. Admission date (ISO-8601).
Character. Last-modified date (ISO-8601).
Character. Ten-digit product code.
Character. Manufacturer name.
Logical. Whether product is withdrawn.
Logical. Whether product is a billing item.
Character. Product identifier.
Character. Combined display label.
Integer. Product-group number.
Integer. Application-site number.
Integer. Subgroup number.
Integer. Product-type number.
Character. Product-type name.
List. Construction features (nested objects).
POSIXct. Parsed admission date (Europe/Berlin).
POSIXct. Parsed last-modified date (Europe/Berlin).
Other Hilfsmittel:
hilfsmittel_nachweisschema(),
hilfsmittel_produktart(),
hilfsmittel_produkte(),
hilfsmittel_produktgruppe(),
hilfsmittel_tree(),
hilfsmittel_untergruppe()
## Not run: hilfsmittel_produkt("f41f52a6-5d2d-4dd3-9d0e-39675ceca7f3") ## End(Not run)## Not run: hilfsmittel_produkt("f41f52a6-5d2d-4dd3-9d0e-39675ceca7f3") ## End(Not run)
Get Hilfsmittel product type details
hilfsmittel_produktart( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hilfsmittel_produktart( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
id |
Produktart id. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns details for a product type (Produktart). API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row for the requested product type and columns:
Character. Product-type identifier.
Character. Internal version identifier.
Integer. Product-type number.
Character. Description text.
Character. Product-type name.
Character. Parent subgroup identifier.
Character. Indication text.
Character. Seven-digit code.
Logical. Internal flag (usage unclear).
Character. Construction-feature schema id.
Integer. Always NA.
Character. Admission date (ISO-8601).
Character. Last-modified date (ISO-8601).
POSIXct. Parsed admission date (Europe/Berlin).
POSIXct. Parsed last-modified date (Europe/Berlin).
Other Hilfsmittel:
hilfsmittel_nachweisschema(),
hilfsmittel_produkt(),
hilfsmittel_produkte(),
hilfsmittel_produktgruppe(),
hilfsmittel_tree(),
hilfsmittel_untergruppe()
## Not run: hilfsmittel_produktart("e6b913ef-cf21-4c5f-826d-f866516c3c65") ## End(Not run)## Not run: hilfsmittel_produktart("e6b913ef-cf21-4c5f-826d-f866516c3c65") ## End(Not run)
List Hilfsmittel products
hilfsmittel_produkte( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hilfsmittel_produkte( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns the full product list (large payload). API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row per product and columns:
Character. Organisation identifier.
Character. Product-type identifier.
Integer. Sequential product number.
Character. Product name.
List. Article numbers (character vector).
List. Type/model variants (character vector).
Character. Admission date (ISO-8601).
Character. Last-modified date (ISO-8601).
Character. Ten-digit product code.
Character. Manufacturer name.
Logical. Whether product is withdrawn.
Logical. Whether product is a billing item.
Character. Product identifier.
Character. Combined display label.
POSIXct. Parsed admission date (Europe/Berlin).
POSIXct. Parsed last-modified date (Europe/Berlin).
Other Hilfsmittel:
hilfsmittel_nachweisschema(),
hilfsmittel_produkt(),
hilfsmittel_produktart(),
hilfsmittel_produktgruppe(),
hilfsmittel_tree(),
hilfsmittel_untergruppe()
## Not run: hilfsmittel_produkte() ## End(Not run)## Not run: hilfsmittel_produkte() ## End(Not run)
Get Hilfsmittel product group details
hilfsmittel_produktgruppe( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hilfsmittel_produktgruppe( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
id |
Produktgruppe id. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns details for a product group (Produktgruppe). API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row for the requested product group and columns:
Character. Product group identifier.
Character. Internal version identifier.
Character. Product group name.
Integer. Product group number.
Character. Description text.
Character. Indication text.
Character. Cross-reference to other groups.
Logical. Internal flag (usage unclear).
Character. GKV case-worker identifier.
Character. Always NA.
Character. MDS case-worker identifier.
Character. Always NA.
Character. Admission date (ISO-8601).
Character. Last-modified date (ISO-8601).
Character. Publication document id.
Character. Always NA.
Logical. Internal flag (usage unclear).
POSIXct. Parsed admission date (Europe/Berlin).
POSIXct. Parsed last-modified date (Europe/Berlin).
Other Hilfsmittel:
hilfsmittel_nachweisschema(),
hilfsmittel_produkt(),
hilfsmittel_produktart(),
hilfsmittel_produkte(),
hilfsmittel_tree(),
hilfsmittel_untergruppe()
## Not run: tree <- hilfsmittel_tree(level = 1) hilfsmittel_produktgruppe(tree$id[[1]]) ## End(Not run)## Not run: tree <- hilfsmittel_tree(level = 1) hilfsmittel_produktgruppe(tree$id[[1]]) ## End(Not run)
List Hilfsmittel tree nodes
hilfsmittel_tree(level, safe = TRUE, refresh = FALSE)hilfsmittel_tree(level, safe = TRUE, refresh = FALSE)
level |
Tree level to retrieve (1-4). |
safe |
Logical; if |
refresh |
Logical; if |
Returns nodes from the Hilfsmittel product tree up to the selected level. API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row per tree node and columns:
Character. Node identifier.
Character. Parent node identifier (NA for roots).
Character. Node display label.
Character. xSteller with label.
Character. Position code of the node.
Integer. Tree depth level.
Other Hilfsmittel:
hilfsmittel_nachweisschema(),
hilfsmittel_produkt(),
hilfsmittel_produktart(),
hilfsmittel_produkte(),
hilfsmittel_produktgruppe(),
hilfsmittel_untergruppe()
## Not run: hilfsmittel_tree(level = 1) ## End(Not run)## Not run: hilfsmittel_tree(level = 1) ## End(Not run)
Get Hilfsmittel subgroup details
hilfsmittel_untergruppe( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hilfsmittel_untergruppe( id, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
id |
Untergruppe id. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns details for a subgroup (Untergruppe). API documentation: https://github.com/bundesAPI/hilfsmittel-api.
A tibble with one row for the requested subgroup and columns:
Character. Subgroup identifier.
Character. Internal version identifier.
Integer. Subgroup number.
Character. Application-site identifier.
Character. Subgroup name.
Character. Parent product-group identifier.
Character. Verification-schema identifier.
Character. Six-digit code.
Logical. Internal flag (usage unclear).
Numeric. Always NA.
Numeric. Always NA.
Character. Admission date (ISO-8601).
Character. Last-modified date (ISO-8601).
POSIXct. Parsed admission date (Europe/Berlin).
POSIXct. Parsed last-modified date (Europe/Berlin).
Other Hilfsmittel:
hilfsmittel_nachweisschema(),
hilfsmittel_produkt(),
hilfsmittel_produktart(),
hilfsmittel_produkte(),
hilfsmittel_produktgruppe(),
hilfsmittel_tree()
## Not run: hilfsmittel_untergruppe("c92d1976-d3cb-4b9f-bcdf-805272a9ea86") ## End(Not run)## Not run: hilfsmittel_untergruppe("c92d1976-d3cb-4b9f-bcdf-805272a9ea86") ## End(Not run)
List flood portal states and connected regions
hochwasserzentralen_bundeslaender(safe = TRUE, refresh = FALSE)hochwasserzentralen_bundeslaender(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns metadata for all Bundeslaender and connected regions in the hochwasserzentralen.de portal. API documentation: https://hochwasserzentralen.api.bund.dev/.
A tibble with one row per Bundesland/region entry. Columns are created
dynamically from the upstream service response fields. If the response
contains GeoJSON features, each feature's properties are used as columns;
otherwise each top-level field becomes a column. Scalar values become atomic
columns and nested structures become list-columns.
Other Hochwasserzentralen:
hochwasserzentralen_bundesland_geojson(),
hochwasserzentralen_bundesland_info(),
hochwasserzentralen_lagepegel(),
hochwasserzentralen_pegel_info()
## Not run: hochwasserzentralen_bundeslaender() ## End(Not run)## Not run: hochwasserzentralen_bundeslaender() ## End(Not run)
Get Bundesland GeoJSON boundaries
hochwasserzentralen_bundesland_geojson( version, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )hochwasserzentralen_bundesland_geojson( version, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
version |
GeoJSON version identifier (e.g., "20211130"). |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns GeoJSON boundaries for Bundeslaender and connected regions from the hochwasserzentralen.de portal. API documentation: https://hochwasserzentralen.api.bund.dev/.
A one-row tibble with:
GeoJSON object type (character).
GeoJSON dataset name (character).
GeoJSON feature list (list-column).
Other Hochwasserzentralen:
hochwasserzentralen_bundeslaender(),
hochwasserzentralen_bundesland_info(),
hochwasserzentralen_lagepegel(),
hochwasserzentralen_pegel_info()
## Not run: hochwasserzentralen_bundesland_geojson("20211130", flatten = TRUE) ## End(Not run)## Not run: hochwasserzentralen_bundesland_geojson("20211130", flatten = TRUE) ## End(Not run)
Get flood portal metadata for a Bundesland
hochwasserzentralen_bundesland_info( bundesland_id, safe = TRUE, refresh = FALSE )hochwasserzentralen_bundesland_info( bundesland_id, safe = TRUE, refresh = FALSE )
bundesland_id |
Bundesland id (e.g., "HE"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns metadata for a single Bundesland or region in the hochwasserzentralen.de portal. API documentation: https://hochwasserzentralen.api.bund.dev/.
A one-row tibble of metadata for the selected Bundesland id. Columns
are created dynamically from the upstream service response fields. If the
response contains GeoJSON features, each feature's properties are used as
columns; otherwise each top-level field becomes a column. Scalar values
become atomic columns and nested structures become list-columns.
Other Hochwasserzentralen:
hochwasserzentralen_bundeslaender(),
hochwasserzentralen_bundesland_geojson(),
hochwasserzentralen_lagepegel(),
hochwasserzentralen_pegel_info()
## Not run: hochwasserzentralen_bundesland_info("HE") ## End(Not run)## Not run: hochwasserzentralen_bundesland_info("HE") ## End(Not run)
List flood gauge locations
hochwasserzentralen_lagepegel(safe = TRUE, refresh = FALSE)hochwasserzentralen_lagepegel(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns latitude/longitude coordinates for all pegel identifiers available in the hochwasserzentralen.de portal. API documentation: https://hochwasserzentralen.api.bund.dev/.
A tibble with one row per gauge location. Columns are created
dynamically from the upstream service response fields. If the response
contains GeoJSON features, each feature's properties are used as columns;
otherwise each top-level field becomes a column. Scalar values become atomic
columns and nested structures become list-columns.
Other Hochwasserzentralen:
hochwasserzentralen_bundeslaender(),
hochwasserzentralen_bundesland_geojson(),
hochwasserzentralen_bundesland_info(),
hochwasserzentralen_pegel_info()
## Not run: hochwasserzentralen_lagepegel() ## End(Not run)## Not run: hochwasserzentralen_lagepegel() ## End(Not run)
Get flood gauge information
hochwasserzentralen_pegel_info(pegelnummer, safe = TRUE, refresh = FALSE)hochwasserzentralen_pegel_info(pegelnummer, safe = TRUE, refresh = FALSE)
pegelnummer |
Pegelnummer identifier (e.g., "HE_24820206"). |
safe |
Logical; if |
refresh |
Logical; if |
Returns metadata for a single flood gauge (pegel) from hochwasserzentralen.de. API documentation: https://hochwasserzentralen.api.bund.dev/.
A one-row tibble of gauge metadata for the selected pegelnummer.
Columns are created dynamically from the upstream service response fields.
If the response contains GeoJSON features, each feature's properties are
used as columns; otherwise each top-level field becomes a column. Scalar
values become atomic columns and nested structures become list-columns.
Other Hochwasserzentralen:
hochwasserzentralen_bundeslaender(),
hochwasserzentralen_bundesland_geojson(),
hochwasserzentralen_bundesland_info(),
hochwasserzentralen_lagepegel()
## Not run: hochwasserzentralen_pegel_info("HE_24820206") ## End(Not run)## Not run: hochwasserzentralen_pegel_info("HE_24820206") ## End(Not run)
Fetch Jobsuche employer logo
jobsuche_logo(hash_id, safe = TRUE, refresh = FALSE)jobsuche_logo(hash_id, safe = TRUE, refresh = FALSE)
hash_id |
Logo hash id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns the raw logo bytes for a given employer hash id. Use this together
with listings returned by jobsuche_search() or jobsuche_search_app().
See https://jobsuche.api.bund.dev for API documentation.
A one-row tibble with:
Requested logo hash id (character).
Raw logo bytes (list-column with raw vector).
jobsuche_search() for listings and bunddev_auth_set() for auth setup.
Other Jobsuche:
jobsuche_search(),
jobsuche_search_app()
## Not run: Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY") logo <- jobsuche_logo("abc123") ## End(Not run)## Not run: Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY") logo <- jobsuche_logo("abc123") ## End(Not run)
Search Jobsuche listings
jobsuche_search( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )jobsuche_search( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Jobsuche API provides access to job listings from the Bundesagentur fuer
Arbeit. Authentication is required via an API key passed as X-API-Key.
See https://jobsuche.api.bund.dev for the official API documentation.
Use bunddev_auth_set() to configure the key and bunddev_parameters() to
discover supported query parameters.
A tibble with one row per job listing:
Posting hash id (character).
Job title/occupation (character).
Reference number (character).
Employer name (character).
Published date/time text (character).
Published timestamp as POSIXct in Europe/Berlin.
Start date text (character).
Start timestamp as POSIXct in Europe/Berlin.
Postal code (character).
City/locality (character).
Street (character).
Region/state (character).
Country code/name (character).
Latitude (numeric).
Longitude (numeric).
Modification timestamp text (character).
Modification timestamp as POSIXct in Europe/Berlin.
Returned page number (character).
Returned page size (character).
Total result count (character).
Facet metadata (list-column).
jobsuche_search_app() for the app endpoint, jobsuche_logo() to fetch
employer logos, and bunddev_auth_set() for authentication.
Other Jobsuche:
jobsuche_logo(),
jobsuche_search_app()
## Not run: Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY") jobsuche_search(params = list(was = "data", size = 5), flatten = TRUE) ## End(Not run)## Not run: Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY") jobsuche_search(params = list(was = "data", size = 5), flatten = TRUE) ## End(Not run)
Search Jobsuche listings (app endpoint)
jobsuche_search_app( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )jobsuche_search_app( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
This uses the mobile app endpoint of the Jobsuche API. It shares the same
authentication mechanism and parameters as jobsuche_search().
See https://jobsuche.api.bund.dev for API documentation.
A tibble with the same columns as jobsuche_search().
Posting hash id (character).
Job title/occupation (character).
Reference number (character).
Employer name (character).
Published date/time text (character).
Published timestamp as POSIXct (Europe/Berlin).
Start date text (character).
Start timestamp as POSIXct (Europe/Berlin).
Postal code (character).
City/locality (character).
Street (character).
Region/state (character).
Country code/name (character).
Latitude (numeric).
Longitude (numeric).
Modification timestamp text (character).
Modification timestamp as POSIXct (Europe/Berlin).
Returned page number (character).
Returned page size (character).
Total result count (character).
Facet metadata (list-column).
jobsuche_search() for the standard endpoint and bunddev_parameters() for
parameter discovery.
Other Jobsuche:
jobsuche_logo(),
jobsuche_search()
## Not run: Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY") jobsuche_search_app(params = list(was = "data", size = 5), flatten = TRUE) ## End(Not run)## Not run: Sys.setenv(JOBBOERSE_API_KEY = "jobboerse-jobsuche") bunddev_auth_set("jobsuche", type = "api_key", env_var = "JOBBOERSE_API_KEY") jobsuche_search_app(params = list(was = "data", size = 5), flatten = TRUE) ## End(Not run)
List German places from Bundes-Klinik-Atlas
klinikatlas_german_places(safe = TRUE, refresh = FALSE)klinikatlas_german_places(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns place metadata used by the Bundes-Klinik-Atlas search UI. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per place entry.
Other Klinik Atlas:
klinikatlas_german_states(),
klinikatlas_hospital_detail(),
klinikatlas_icd_codes(),
klinikatlas_locations(),
klinikatlas_ops_codes(),
klinikatlas_search(),
klinikatlas_states()
## Not run: klinikatlas_german_places() ## End(Not run)## Not run: klinikatlas_german_places() ## End(Not run)
List German states with coordinates from Bundes-Klinik-Atlas
klinikatlas_german_states(safe = TRUE, refresh = FALSE)klinikatlas_german_states(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns federal states with map coordinates used by the Bundes-Klinik-Atlas. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per federal state.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_hospital_detail(),
klinikatlas_icd_codes(),
klinikatlas_locations(),
klinikatlas_ops_codes(),
klinikatlas_search(),
klinikatlas_states()
## Not run: klinikatlas_german_states() ## End(Not run)## Not run: klinikatlas_german_states() ## End(Not run)
Fetch raw hospital detail HTML from Bundes-Klinik-Atlas
klinikatlas_hospital_detail( id, params = list(), safe = TRUE, refresh = FALSE, raw = FALSE )klinikatlas_hospital_detail( id, params = list(), safe = TRUE, refresh = FALSE, raw = FALSE )
id |
Integer hospital identifier from |
params |
Optional named list of upstream query parameters such as
|
safe |
Logical; if |
refresh |
Logical; if |
raw |
Logical; if |
The public Klinik-Atlas detail endpoint currently serves HTML. By default
this helper extracts a one-row summary tibble with contact details and a few
headline metrics from the page. Set raw = TRUE to retrieve the original
HTML response instead. API documentation:
https://github.com/bundesAPI/klinikatlas-api.
A one-row tibble with extracted hospital detail
fields, or a character scalar containing the raw HTML response when
raw = TRUE.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_german_states(),
klinikatlas_icd_codes(),
klinikatlas_locations(),
klinikatlas_ops_codes(),
klinikatlas_search(),
klinikatlas_states()
## Not run: klinikatlas_hospital_detail(2610) ## End(Not run)## Not run: klinikatlas_hospital_detail(2610) ## End(Not run)
List ICD codes from Bundes-Klinik-Atlas
klinikatlas_icd_codes(safe = TRUE, refresh = FALSE)klinikatlas_icd_codes(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns ICD code metadata used by the Bundes-Klinik-Atlas search UI. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per ICD code.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_german_states(),
klinikatlas_hospital_detail(),
klinikatlas_locations(),
klinikatlas_ops_codes(),
klinikatlas_search(),
klinikatlas_states()
## Not run: klinikatlas_icd_codes() ## End(Not run)## Not run: klinikatlas_icd_codes() ## End(Not run)
List Bundes-Klinik-Atlas hospital locations
klinikatlas_locations(safe = TRUE, refresh = FALSE)klinikatlas_locations(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns the location directory for hospitals listed in the Bundes-Klinik-Atlas. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per hospital location.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_german_states(),
klinikatlas_hospital_detail(),
klinikatlas_icd_codes(),
klinikatlas_ops_codes(),
klinikatlas_search(),
klinikatlas_states()
## Not run: klinikatlas_locations() ## End(Not run)## Not run: klinikatlas_locations() ## End(Not run)
List OPS codes from Bundes-Klinik-Atlas
klinikatlas_ops_codes(safe = TRUE, refresh = FALSE)klinikatlas_ops_codes(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns OPS code metadata used by the Bundes-Klinik-Atlas search UI. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per OPS code.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_german_states(),
klinikatlas_hospital_detail(),
klinikatlas_icd_codes(),
klinikatlas_locations(),
klinikatlas_search(),
klinikatlas_states()
## Not run: klinikatlas_ops_codes() ## End(Not run)## Not run: klinikatlas_ops_codes() ## End(Not run)
Search Bundes-Klinik-Atlas hospitals
klinikatlas_search( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )klinikatlas_search( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of upstream query parameters. Parameter names are
forwarded unchanged and should match the OpenAPI spec, for example
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Searches hospitals using the documented Bundes-Klinik-Atlas search endpoint. Parameter names are intentionally left in the upstream bracketed form so they can be passed through unchanged. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per search result and the nested API payload retained in list-columns.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_german_states(),
klinikatlas_hospital_detail(),
klinikatlas_icd_codes(),
klinikatlas_locations(),
klinikatlas_ops_codes(),
klinikatlas_states()
## Not run: klinikatlas_search(params = list( "tx_solr[rows]" = 5, "tx_solr[start]" = 0, "tx_solr[searchlabel]" = "Berlin" )) ## End(Not run)## Not run: klinikatlas_search(params = list( "tx_solr[rows]" = 5, "tx_solr[start]" = 0, "tx_solr[searchlabel]" = "Berlin" )) ## End(Not run)
List Bundes-Klinik-Atlas state summaries
klinikatlas_states(safe = TRUE, refresh = FALSE)klinikatlas_states(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns aggregate Klinik-Atlas metrics by federal state. API documentation: https://github.com/bundesAPI/klinikatlas-api.
A tibble with one row per federal state.
Other Klinik Atlas:
klinikatlas_german_places(),
klinikatlas_german_states(),
klinikatlas_hospital_detail(),
klinikatlas_icd_codes(),
klinikatlas_locations(),
klinikatlas_ops_codes(),
klinikatlas_search()
## Not run: klinikatlas_states() ## End(Not run)## Not run: klinikatlas_states() ## End(Not run)
Query charging stations
ladestationen_query( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )ladestationen_query( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of ArcGIS query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Ladesaeulenregister API is backed by an ArcGIS feature service. You must
supply a geometry filter and outFields. The ArcGIS service may require a
token query parameter even though the API docs describe the service as
public. API documentation: https://ladestationen.api.bund.dev.
A tibble with one row per ArcGIS feature. Attribute names are
normalized to lower snake_case. Includes a geometry list-column with the
feature geometry object.
One column per ArcGIS attributes field (normalized to snake_case).
Feature geometry object as list-column.
bunddev_parameters() to inspect available query parameters.
## Not run: geometry <- jsonlite::toJSON( list( xmin = 13.3, ymin = 52.4, xmax = 13.5, ymax = 52.6, spatialReference = list(wkid = 4326) ), auto_unbox = TRUE ) ladestationen_query(params = list( geometry = geometry, geometryType = "esriGeometryEnvelope", where = "1=1", outFields = "*", outSR = 4326, f = "json", returnGeometry = "false", resultRecordCount = 5 )) ## End(Not run)## Not run: geometry <- jsonlite::toJSON( list( xmin = 13.3, ymin = 52.4, xmax = 13.5, ymax = 52.6, spatialReference = list(wkid = 4326) ), auto_unbox = TRUE ) ladestationen_query(params = list( geometry = geometry, geometryType = "esriGeometryEnvelope", where = "1=1", outFields = "*", outSR = 4326, f = "json", returnGeometry = "false", resultRecordCount = 5 )) ## End(Not run)
List food and product warnings
lebensmittelwarnung_warnings( food = list(), products = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )lebensmittelwarnung_warnings( food = list(), products = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
food |
Optional request options for food warnings (rows, start, sort, fq). |
products |
Optional request options for product warnings (rows, start, sort, fq). |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Lebensmittelwarnungen API returns German food and product safety warnings.
Requests are sent as JSON to the warnings/merged endpoint. API documentation: https://lebensmittelwarnung.api.bund.dev.
https://github.com/bundesAPI/lebensmittelwarnung-api.
The API expects an Authorization header. By default the adapter uses the
public key documented in the OpenAPI spec. Override it with
bunddev_auth_set() if needed.
A tibble with one row per warning:
Warning type from the source index (character).
Whether the warning is archived (TRUE/FALSE).
Warning identifier (integer).
Link to the warning details page (character).
Warning title (character).
Warning text/summary (character).
Affected German states (list-column).
Structured product details (list-column).
RAPEX metadata when present (list-column).
Additional safety metadata (list-column).
Published timestamp in milliseconds since epoch (numeric).
Published timestamp as POSIXct in Europe/Berlin.
Total number of matching warnings in the response (integer).
bunddev_auth_set() to configure the authorization header.
## Not run: lebensmittelwarnung_warnings(food = list(rows = 10), products = list(rows = 0)) ## End(Not run)## Not run: lebensmittelwarnung_warnings(food = list(rows = 10), products = list(rows = 0)) ## End(Not run)
List air quality measurements
luftqualitaet_airquality(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_airquality(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
The Luftqualitaet API provides air quality data and metadata from the Umweltbundesamt. Use query parameters to filter by date/time and station. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per station/time observation.
Column names are derived from the indices metadata in the API
response and typically include a station id key column followed by
date end (CET), an overall air-quality index, an incompleteness
flag, and per-component sub-arrays (component id, value, index, percent).
Exact column names and count vary by query parameters.
bunddev_parameters() to inspect available query parameters.
luftqualitaet_measures() for measurement metadata and
luftqualitaet_components() for pollutant components.
Other Luftqualitaet:
luftqualitaet_airquality_limits(),
luftqualitaet_annualbalances(),
luftqualitaet_components(),
luftqualitaet_measures(),
luftqualitaet_measures_limits(),
luftqualitaet_meta(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
## Not run: luftqualitaet_airquality(params = list( date_from = "2024-01-01", date_to = "2024-01-02" )) ## End(Not run)## Not run: luftqualitaet_airquality(params = list( date_from = "2024-01-01", date_to = "2024-01-02" )) ## End(Not run)
Get air quality date limits
luftqualitaet_airquality_limits(safe = TRUE, refresh = FALSE)luftqualitaet_airquality_limits(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns date limits for air quality measurements. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per station. Column names
are derived from the indices metadata in the API response and
typically include a station_id key column followed by
limit date start min (CET) and limit date start max (CET).
Other Luftqualitaet:
luftqualitaet_airquality(),
luftqualitaet_annualbalances(),
luftqualitaet_components(),
luftqualitaet_measures(),
luftqualitaet_measures_limits(),
luftqualitaet_meta(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List annual balances
luftqualitaet_annualbalances(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_annualbalances(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns annual balance data for a component and year. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per annual-balance record.
Column names are derived from the indices metadata in the API
response and typically include station id, component id,
year, value, and transgression type.
bunddev_parameters() to inspect available query parameters.
Other Luftqualitaet:
luftqualitaet_airquality(),
luftqualitaet_airquality_limits(),
luftqualitaet_components(),
luftqualitaet_measures(),
luftqualitaet_measures_limits(),
luftqualitaet_meta(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List components
luftqualitaet_components(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_components(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns available pollutant components. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per component. Column names
are derived from the indices metadata in the API response and
typically include a component id/code key column followed by
component id, component code, component symbol,
component unit, and component name.
bunddev_parameters() to inspect available query parameters.
Other Luftqualitaet:
luftqualitaet_airquality(),
luftqualitaet_airquality_limits(),
luftqualitaet_annualbalances(),
luftqualitaet_measures(),
luftqualitaet_measures_limits(),
luftqualitaet_meta(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List measurements metadata
luftqualitaet_measures(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_measures(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns measurement metadata for stations, components, and scopes. Official docs: https://luftqualitaet.api.bund.dev.
A tibble with one row per station/time
measurement. Column names are derived from the indices metadata in
the API response and typically include a station id key column and
per-observation arrays containing component id, scope id,
value, date end, and index. Exact column names and
count vary by query parameters.
bunddev_parameters() to inspect available query parameters.
Other Luftqualitaet:
luftqualitaet_airquality(),
luftqualitaet_airquality_limits(),
luftqualitaet_annualbalances(),
luftqualitaet_components(),
luftqualitaet_measures_limits(),
luftqualitaet_meta(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
Get measurement date limits
luftqualitaet_measures_limits(safe = TRUE, refresh = FALSE)luftqualitaet_measures_limits(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns date limits for measurement metadata. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per scope/component/station
combination. Column names are derived from the indices metadata in
the API response and typically include scope id,
component id, station id,
limit date start min (CET), and
limit date start max (CET).
Other Luftqualitaet:
luftqualitaet_airquality(),
luftqualitaet_airquality_limits(),
luftqualitaet_annualbalances(),
luftqualitaet_components(),
luftqualitaet_measures(),
luftqualitaet_meta(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List combined metadata
luftqualitaet_meta(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_meta(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns combined metadata for a given use case. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with combined metadata. The structure
depends on the use parameter and may include sections for
components, scopes, networks, stations, limits, and cross-references.
Column names are derived from the indices metadata in the API
response and vary by use value.
bunddev_parameters() to inspect available query parameters.
Other Luftqualitaet:
luftqualitaet_airquality(),
luftqualitaet_airquality_limits(),
luftqualitaet_annualbalances(),
luftqualitaet_components(),
luftqualitaet_measures(),
luftqualitaet_measures_limits(),
luftqualitaet_networks(),
luftqualitaet_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List networks
luftqualitaet_networks(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_networks(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns networks used by the Luftqualitaet API. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per monitoring network.
Column names are derived from the indices metadata in the API
response and typically include a network id/code key column followed by
network id, network code, and network name.
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_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List scopes
luftqualitaet_scopes(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_scopes(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns scopes used by the Luftqualitaet API. API documentation: https://luftqualitaet.api.bund.dev.
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.
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()
List station settings
luftqualitaet_stationsettings(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_stationsettings(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns station settings metadata. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per station setting. Column
names are derived from the indices metadata in the API response and
typically include station setting id, station setting name,
and station setting short name.
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_scopes(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List station types
luftqualitaet_stationtypes(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_stationtypes(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns station types metadata. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per station type. Column
names are derived from the indices metadata in the API response and
typically include station type id and station type name.
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_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List thresholds
luftqualitaet_thresholds(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_thresholds(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns threshold metadata for components and scopes. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per threshold entry. Column
names are derived from the indices metadata in the API response and
typically include threshold id, component id,
scope id, threshold min, threshold max, and
threshold index.
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_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_transgressions(),
luftqualitaet_transgressiontypes()
List transgressions
luftqualitaet_transgressions(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_transgressions(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns exceedances (transgressions) data. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per station transgression
record. Column names are derived from the indices metadata in the
API response and typically include station id, day_first,
day_recent, value of year, and monthly values for January
through December.
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_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressiontypes()
List transgression types
luftqualitaet_transgressiontypes(params = list(), safe = TRUE, refresh = FALSE)luftqualitaet_transgressiontypes(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns available transgression types. API documentation: https://luftqualitaet.api.bund.dev.
A tibble with one row per transgression type.
Column names are derived from the indices metadata in the API
response and typically include exceedance type id and
exceedance type name.
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_scopes(),
luftqualitaet_stationsettings(),
luftqualitaet_stationtypes(),
luftqualitaet_thresholds(),
luftqualitaet_transgressions()
List MaStR filter options for gas generation
marktstammdaten_filters_gaserzeugung( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_filters_gaserzeugung( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns filter definitions for public gas generation data. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per available filter and columns:
Character. Machine-readable filter field name.
List. Selectable options (named with Name/Value).
Character. Filter data type ("text", "number",
"multidropdown", "date", or "boolean").
Other Marktstammdaten:
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gaserzeugung(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromerzeugung(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_filters_gaserzeugung() ## End(Not run)## Not run: marktstammdaten_filters_gaserzeugung() ## End(Not run)
List MaStR filter options for gas consumption
marktstammdaten_filters_gasverbrauch( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_filters_gasverbrauch( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns filter definitions for public gas consumption data. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per available filter and columns:
Character. Machine-readable filter field name.
List. Selectable options (named with Name/Value).
Character. Filter data type ("text", "number",
"multidropdown", "date", or "boolean").
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gaserzeugung(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromerzeugung(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_filters_gasverbrauch() ## End(Not run)## Not run: marktstammdaten_filters_gasverbrauch() ## End(Not run)
List MaStR filter options for electricity generation
marktstammdaten_filters_stromerzeugung( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_filters_stromerzeugung( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns filter definitions for public electricity generation data. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per available filter and columns:
Character. Machine-readable filter field name.
List. Selectable options (named with Name/Value).
Character. Filter data type ("text", "number",
"multidropdown", "date", or "boolean").
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gaserzeugung(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromerzeugung(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_filters_stromerzeugung() ## End(Not run)## Not run: marktstammdaten_filters_stromerzeugung() ## End(Not run)
List MaStR filter options for electricity consumption
marktstammdaten_filters_stromverbrauch( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_filters_stromverbrauch( safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns filter definitions for public electricity consumption data. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per available filter and columns:
Character. Machine-readable filter field name.
List. Selectable options (named with Name/Value).
Character. Filter data type ("text", "number",
"multidropdown", "date", or "boolean").
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_gaserzeugung(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromerzeugung(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_filters_stromverbrauch() ## End(Not run)## Not run: marktstammdaten_filters_stromverbrauch() ## End(Not run)
List MaStR gas generation data
marktstammdaten_gaserzeugung( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_gaserzeugung( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns public gas generation data from the MaStR. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per gas generation unit
and columns determined by the MaStR API response. Common columns include
MaStRNummer, EinheitName, Bundesland, Ort,
Plz, BetriebsStatusName, InbetriebnahmeDatum, and
EinheitRegistrierungsdatum (see
marktstammdaten_filters_gaserzeugung() for available filter fields).
Additionally:
Numeric. Total number of matching records upstream.
POSIXct. Parsed date column (Europe/Berlin) added
for every source column whose name contains Datum.
bunddev_parameters() to inspect available query parameters.
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromerzeugung(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_gaserzeugung(params = list(page = 1, pageSize = 5)) ## End(Not run)## Not run: marktstammdaten_gaserzeugung(params = list(page = 1, pageSize = 5)) ## End(Not run)
List MaStR gas consumption data
marktstammdaten_gasverbrauch( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_gasverbrauch( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns public gas consumption data from the MaStR. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per gas consumption unit
and columns determined by the MaStR API response. Common columns include
MaStRNummer, EinheitName, Bundesland, Ort,
Plz, BetriebsStatusName, and
EinheitRegistrierungsdatum (see
marktstammdaten_filters_gasverbrauch() for available filter fields).
Additionally:
Numeric. Total number of matching records upstream.
POSIXct. Parsed date column (Europe/Berlin) added
for every source column whose name contains Datum.
bunddev_parameters() to inspect available query parameters.
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gaserzeugung(),
marktstammdaten_stromerzeugung(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_gasverbrauch(params = list(page = 1, pageSize = 5)) ## End(Not run)## Not run: marktstammdaten_gasverbrauch(params = list(page = 1, pageSize = 5)) ## End(Not run)
List MaStR electricity generation data
marktstammdaten_stromerzeugung( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_stromerzeugung( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns public electricity generation data from the MaStR. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per electricity generation
unit and columns determined by the MaStR API response. Common columns
include MaStRNummer, EinheitName, Bundesland,
Ort, Plz, Bruttoleistung, Nettonennleistung,
EnergietraegerName, BetriebsStatusName,
InbetriebnahmeDatum, and EinheitRegistrierungsdatum
(see marktstammdaten_filters_stromerzeugung() for available filter
fields). Additionally:
Numeric. Total number of matching records upstream.
POSIXct. Parsed date column (Europe/Berlin) added
for every source column whose name contains Datum.
bunddev_parameters() to inspect available query parameters.
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gaserzeugung(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromverbrauch()
## Not run: marktstammdaten_stromerzeugung(params = list(page = 1, pageSize = 5)) ## End(Not run)## Not run: marktstammdaten_stromerzeugung(params = list(page = 1, pageSize = 5)) ## End(Not run)
List MaStR electricity consumption data
marktstammdaten_stromverbrauch( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )marktstammdaten_stromverbrauch( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns public electricity consumption data from the MaStR. API documentation: https://github.com/bundesAPI/marktstammdaten-api.
A tibble with one row per electricity consumption
unit and columns determined by the MaStR API response. Common columns
include MaStRNummer, EinheitName, Bundesland,
Ort, Plz, BetriebsStatusName, and
EinheitRegistrierungsdatum (see
marktstammdaten_filters_stromverbrauch() for available filter fields).
Additionally:
Numeric. Total number of matching records upstream.
POSIXct. Parsed date column (Europe/Berlin) added
for every source column whose name contains Datum.
bunddev_parameters() to inspect available query parameters.
Other Marktstammdaten:
marktstammdaten_filters_gaserzeugung(),
marktstammdaten_filters_gasverbrauch(),
marktstammdaten_filters_stromerzeugung(),
marktstammdaten_filters_stromverbrauch(),
marktstammdaten_gaserzeugung(),
marktstammdaten_gasverbrauch(),
marktstammdaten_stromerzeugung()
## Not run: marktstammdaten_stromverbrauch(params = list(page = 1, pageSize = 5)) ## End(Not run)## Not run: marktstammdaten_stromverbrauch(params = list(page = 1, pageSize = 5)) ## End(Not run)
List MUDAB parameter values
mudab_parameter_values( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_parameter_values( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns measurement values for parameters from the MUDAB database. API documentation: https://mudab.api.bund.dev.
A tibble with one row per measurement value and columns:
Integer. Metadata identifier.
Character. Station name.
Character. Composite station-date-time string.
Character. Parameter identifier.
Character. Parameter code name.
Character. Measurement date (YYYYMMDD).
Character. Measurement time (HHMM).
Character. Measured value.
POSIXct. Parsed date-time (Europe/Berlin).
Other MUDAB:
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_parameter_values(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_parameter_values(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB parameters
mudab_parameters( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_parameters( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns measurement parameters from the MUDAB database. API documentation: https://mudab.api.bund.dev.
A tibble with one row per parameter and columns:
Integer. Metadata identifier.
Character. Compartment code (BL, CW, CS, or CF).
Character. Parameter abbreviation.
Character. Parameter group code.
Character. Parameter name.
Character. Parameter group code (alternate).
Character. Parameter group name.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_parameters(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_parameters(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB parameters (Biologie)
mudab_parameters_biologie( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_parameters_biologie( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns parameter entries for the Biologie compartment. API documentation: https://mudab.api.bund.dev.
A tibble with one row per parameter and columns:
Integer. Metadata identifier.
Character. Compartment code (BL, CW, CS, or CF).
Character. Parameter abbreviation.
Character. Parameter group code.
Character. Parameter name.
Character. Parameter group code (alternate).
Character. Parameter group name.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_parameters_biologie(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_parameters_biologie(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB parameters (Biota)
mudab_parameters_biota( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_parameters_biota( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns parameter entries for the Biota compartment. API documentation: https://mudab.api.bund.dev.
A tibble with one row per parameter and columns:
Integer. Metadata identifier.
Character. Compartment code (BL, CW, CS, or CF).
Character. Parameter abbreviation.
Character. Parameter group code.
Character. Parameter name.
Character. Parameter group code (alternate).
Character. Parameter group name.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_parameters_biota(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_parameters_biota(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB parameters (Sediment)
mudab_parameters_sediment( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_parameters_sediment( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns parameter entries for the Sediment compartment. API documentation: https://mudab.api.bund.dev.
A tibble with one row per parameter and columns:
Integer. Metadata identifier.
Character. Compartment code (BL, CW, CS, or CF).
Character. Parameter abbreviation.
Character. Parameter group code.
Character. Parameter name.
Character. Parameter group code (alternate).
Character. Parameter group name.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_parameters_sediment(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_parameters_sediment(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB parameters (Wasser)
mudab_parameters_wasser( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_parameters_wasser( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns parameter entries for the Wasser compartment. API documentation: https://mudab.api.bund.dev.
A tibble with one row per parameter and columns:
Integer. Metadata identifier.
Character. Compartment code (BL, CW, CS, or CF).
Character. Parameter abbreviation.
Character. Parameter group code.
Character. Parameter name.
Character. Parameter group code (alternate).
Character. Parameter group name.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_parameters_wasser(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_parameters_wasser(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB PLC measurement values
mudab_plc_measurements( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_plc_measurements( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns PLC station measurement values. API documentation: https://mudab.api.bund.dev.
A tibble with one row per PLC measurement and columns:
Integer. Metadata identifier.
Integer. Running row number.
Integer. Measurement name code.
Character. Station code.
Character. Station name.
Numeric. Measured value.
Character. Aggregation type ("TOT" or "AVE").
Character. Numeric code for NAME.
Character. Measurement period (year).
Character. Aggregation duration ("A").
Character. Federal state code.
Numeric. Latitude.
Numeric. Longitude.
Character. Sub-compartment code.
Character. Sub-compartment name.
Character. Monitoring type.
Character. Measurement unit.
Numeric. Area value.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_plc_measurements(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_plc_measurements(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB PLC parameters
mudab_plc_parameters( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_plc_parameters( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns parameters measured at PLC stations. API documentation: https://mudab.api.bund.dev.
A tibble with one row per PLC parameter and columns:
Integer. Metadata identifier.
Character. Parameter abbreviation.
Character. Parameter group code.
Character. Station code.
Character. Year of last measurement.
Character. Unique key (station + parameter).
Character. Station name.
Integer. Number of measured values.
Character. Sub-compartment code.
Character. Sub-compartment name.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_stations(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_plc_parameters(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_plc_parameters(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB PLC stations
mudab_plc_stations( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_plc_stations( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns HELCOM PLC stations. API documentation: https://mudab.api.bund.dev.
A tibble with one row per PLC station and columns:
Character. Station name.
Character. Station code.
Character. Federal state code.
Numeric. Latitude.
Numeric. Longitude.
Character. Sub-compartment code.
Character. Sub-compartment name.
Character. Monitoring type.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_project_stations(),
mudab_stations()
## Not run: mudab_plc_stations(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_plc_stations(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB project stations
mudab_project_stations( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )mudab_project_stations( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns project stations from the MUDAB database. API documentation: https://mudab.api.bund.dev.
A tibble with one row per project station and columns:
Integer. Metadata identifier.
Integer. Project station identifier.
Character. Project station name.
Character. Region of the station.
Character. Responsible institute.
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_stations()
## Not run: mudab_project_stations(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_project_stations(range = list(from = 0, count = 5)) ## End(Not run)
List MUDAB stations
mudab_stations( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )mudab_stations( filter = NULL, range = NULL, orderby = NULL, safe = TRUE, refresh = FALSE )
filter |
Optional filter definition. |
range |
Optional range specification. |
orderby |
Optional ordering specification. |
safe |
Logical; if |
refresh |
Logical; if |
Returns measurement stations from the MUDAB database. API documentation: https://mudab.api.bund.dev.
A tibble with one row per measurement station and columns:
Integer. Metadata identifier.
Character. Station name.
Character. Project station name.
Character. Station type.
Character. Compartment code (BL, CW, CS, or CF).
Other MUDAB:
mudab_parameter_values(),
mudab_parameters(),
mudab_parameters_biologie(),
mudab_parameters_biota(),
mudab_parameters_sediment(),
mudab_parameters_wasser(),
mudab_plc_measurements(),
mudab_plc_parameters(),
mudab_plc_stations(),
mudab_project_stations()
## Not run: mudab_stations(range = list(from = 0, count = 5)) ## End(Not run)## Not run: mudab_stations(range = list(from = 0, count = 5)) ## End(Not run)
Get MOWAS archive entry
nina_archive_mowas(identifier, safe = TRUE, refresh = FALSE)nina_archive_mowas(identifier, safe = TRUE, refresh = FALSE)
identifier |
Warning identifier. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
Warning identifier (character).
Archive entry response payload (list).
Other NINA:
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get MOWAS archive mapping
nina_archive_mowas_mapping(identifier, safe = TRUE, refresh = FALSE)nina_archive_mowas_mapping(identifier, safe = TRUE, refresh = FALSE)
identifier |
Warning identifier. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
Warning identifier (character).
Archive mapping response payload (list).
Other NINA:
nina_archive_mowas(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get COVID info data
nina_covid_infos(safe = TRUE, refresh = FALSE)nina_covid_infos(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
COVID info response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get COVID map data
nina_covid_map(safe = TRUE, refresh = FALSE)nina_covid_map(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
COVID map response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get COVID rules for an ARS
nina_covid_rules(ars, safe = TRUE, refresh = FALSE)nina_covid_rules(ars, safe = TRUE, refresh = FALSE)
ars |
ARS code. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
The ARS code used in the request (character).
COVID rules response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get COVID ticker
nina_covid_ticker(safe = TRUE, refresh = FALSE)nina_covid_ticker(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
COVID ticker response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get COVID ticker message
nina_covid_ticker_message(id, safe = TRUE, refresh = FALSE)nina_covid_ticker_message(id, safe = TRUE, refresh = FALSE)
id |
Ticker message id. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
Ticker message identifier (character).
Ticker message response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get NINA dashboard data
nina_dashboard(ars, safe = TRUE, refresh = FALSE)nina_dashboard(ars, safe = TRUE, refresh = FALSE)
ars |
ARS code. |
safe |
Logical; if |
refresh |
Logical; if |
Returns dashboard data for the given ARS code. API documentation: https://nina.api.bund.dev.
A one-row tibble.
The ARS code used in the request (character).
Dashboard response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get an event code file
nina_event_code(filename, safe = TRUE, refresh = FALSE)nina_event_code(filename, safe = TRUE, refresh = FALSE)
filename |
Event code filename. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
Event code file name (character).
Raw file content (list of raw vectors).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
List NINA event codes
nina_event_codes(safe = TRUE, refresh = FALSE)nina_event_codes(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A tibble with one row per event code entry. Columns are bound from
the upstream eventCodes array, plus:
Feed-level modification timestamp in milliseconds (numeric).
Parsed modification timestamp (POSIXct, Europe/Berlin).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
List FAQs
nina_faqs(safe = TRUE, refresh = FALSE)nina_faqs(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A tibble with one row per FAQ entry.
FAQ question text (character).
FAQ answer text (character).
Modification timestamp in milliseconds (numeric).
Parsed modification timestamp (POSIXct, Europe/Berlin).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get a logo file
nina_logo(filename, safe = TRUE, refresh = FALSE)nina_logo(filename, safe = TRUE, refresh = FALSE)
filename |
Logo file name. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
Logo file name (character).
Raw file content (list of raw vectors).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
List NINA logos
nina_logos(safe = TRUE, refresh = FALSE)nina_logos(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A tibble with one row per logo metadata entry. Columns are bound from
the upstream logos array, plus:
Feed-level modification timestamp in milliseconds (numeric).
Parsed modification timestamp (POSIXct, Europe/Berlin).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
List map data
nina_mapdata( source = c("katwarn", "biwapp", "mowas", "dwd", "lhp", "police"), safe = TRUE, refresh = FALSE )nina_mapdata( source = c("katwarn", "biwapp", "mowas", "dwd", "lhp", "police"), safe = TRUE, refresh = FALSE )
source |
Map data source. |
safe |
Logical; if |
refresh |
Logical; if |
Valid sources are: katwarn, biwapp, mowas, dwd, lhp, police.
A tibble with one row per map-data warning entry.
Warning identifier (character).
Warning version (integer).
Start date string from the API (character).
Warning severity level (character).
Warning urgency level (character).
Warning type (character).
Internationalised title entries (list).
Translation key entries (list).
Parsed start date (POSIXct, Europe/Berlin).
Map data source used in the request (character).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get MOWAS RSS feed
nina_mowas_rss(ars, safe = TRUE, refresh = FALSE)nina_mowas_rss(ars, safe = TRUE, refresh = FALSE)
ars |
ARS code. |
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
The ARS code used in the request (character).
RSS XML text returned by the API (character).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
List emergency tips
nina_notfalltipps(safe = TRUE, refresh = FALSE)nina_notfalltipps(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A tibble with one row per emergency-tip category.
Category title (character).
Tips for this category (list).
Modification timestamp in milliseconds (numeric).
Parsed modification timestamp (POSIXct, Europe/Berlin).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get data version info
nina_version(safe = TRUE, refresh = FALSE)nina_version(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
A one-row tibble.
Version/data-version response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
Get a NINA travel warning by content id
nina_warning(content_id, safe = TRUE, refresh = FALSE)nina_warning(content_id, safe = TRUE, refresh = FALSE)
content_id |
Travel warning content id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns full travel warning content, including HTML blocks.
A tibble with detailed warning content rows. Same column structure as
nina_warnings(): entry scalar fields (snake_case), plus content_id,
response_country, response_last_modified, last_modified_time, and
effective_time (POSIXct, Europe/Berlin).
nina_warnings() for ids.
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning_geojson(),
nina_warning_json(),
nina_warnings()
## Not run: warnings <- nina_warnings() nina_warning(warnings$content_id[[1]]) ## End(Not run)## Not run: warnings <- nina_warnings() nina_warning(warnings$content_id[[1]]) ## End(Not run)
Get a NINA warning (GeoJSON)
nina_warning_geojson(identifier, safe = TRUE, refresh = FALSE)nina_warning_geojson(identifier, safe = TRUE, refresh = FALSE)
identifier |
Warning identifier. |
safe |
Logical; if |
refresh |
Logical; if |
Returns a warning in GeoJSON format.
A one-row tibble.
Warning identifier (character).
Full GeoJSON response payload (list).
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_json(),
nina_warnings()
Get a NINA warning (JSON)
nina_warning_json(identifier, safe = TRUE, refresh = FALSE)nina_warning_json(identifier, safe = TRUE, refresh = FALSE)
identifier |
Warning identifier. |
safe |
Logical; if |
refresh |
Logical; if |
Returns a warning in JSON format.
A one-row tibble with CAP warning fields.
Warning identifier (character).
Sender identifier (character).
Sent timestamp string (character).
Alert status (character).
Message type (character).
Alert scope (character).
Alert code entries (list).
Alert info blocks (list).
Parsed sent timestamp (POSIXct, Europe/Berlin).
nina_mapdata() to discover identifiers.
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warnings()
## Not run: map <- nina_mapdata("mowas") nina_warning_json(map$id[[1]]) ## End(Not run)## Not run: map <- nina_mapdata("mowas") nina_warning_json(map$id[[1]]) ## End(Not run)
List NINA travel warnings
nina_warnings(safe = TRUE, refresh = FALSE)nina_warnings(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
The NINA API provides warnings and app data from the Bundesamt fuer Bevoelkerungsschutz. This endpoint returns a list of travel warnings with metadata. API documentation: https://nina.api.bund.dev.
A tibble with one row per warning entry. Columns include scalar fields from each entry (names converted to snake_case) plus the following added metadata:
Content identifier from the NINA feed (character).
Feed-level country code (character).
Feed-level modification timestamp in milliseconds (numeric).
Entry-level last-modified timestamp (POSIXct, Europe/Berlin).
Entry-level effective timestamp (POSIXct, Europe/Berlin).
nina_warning() for a single warning and nina_mapdata() for
map-based alerts.
Other NINA:
nina_archive_mowas(),
nina_archive_mowas_mapping(),
nina_covid_infos(),
nina_covid_map(),
nina_covid_rules(),
nina_covid_ticker(),
nina_covid_ticker_message(),
nina_dashboard(),
nina_event_code(),
nina_event_codes(),
nina_faqs(),
nina_logo(),
nina_logos(),
nina_mapdata(),
nina_mowas_rss(),
nina_notfalltipps(),
nina_version(),
nina_warning(),
nina_warning_geojson(),
nina_warning_json()
## Not run: nina_warnings() ## End(Not run)## Not run: nina_warnings() ## End(Not run)
Get Pegel-Online measurements
pegel_online_measurements( station, timeseries, start = NULL, end = NULL, safe = TRUE, refresh = FALSE )pegel_online_measurements( station, timeseries, start = NULL, end = NULL, safe = TRUE, refresh = FALSE )
station |
Station UUID, name, or number. |
timeseries |
Timeseries shortname. |
start |
Start timestamp in ISO 8601. |
end |
End timestamp in ISO 8601. |
safe |
Logical; if |
refresh |
Logical; if |
Returns measurement values for a station timeseries. Timestamps must be ISO 8601 strings. API documentation: https://pegel-online.api.bund.dev.
A tibble with one row per measurement:
Measurement timestamp string (character).
Measured value (numeric).
Measurement timestamp as POSIXct in Europe/Berlin.
pegel_online_timeseries() for metadata and
pegel_online_measurements_plot() for PNG plots.
Other Pegel Online:
pegel_online_measurements_plot(),
pegel_online_station(),
pegel_online_stations(),
pegel_online_timeseries(),
pegel_online_waters()
## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_measurements(stations$uuid[[1]], "W", start = "2024-01-01T00:00:00Z", end = "2024-01-02T00:00:00Z" ) ## End(Not run)## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_measurements(stations$uuid[[1]], "W", start = "2024-01-01T00:00:00Z", end = "2024-01-02T00:00:00Z" ) ## End(Not run)
Get Pegel-Online measurements plot
pegel_online_measurements_plot( station, timeseries, start = NULL, end = NULL, safe = TRUE, refresh = FALSE )pegel_online_measurements_plot( station, timeseries, start = NULL, end = NULL, safe = TRUE, refresh = FALSE )
station |
Station UUID, name, or number. |
timeseries |
Timeseries shortname. |
start |
Start timestamp in ISO 8601. |
end |
End timestamp in ISO 8601. |
safe |
Logical; if |
refresh |
Logical; if |
Returns a PNG plot for the measurements endpoint. API documentation: https://pegel-online.api.bund.dev.
A one-row tibble with:
Requested station id (character).
Requested timeseries shortname (character).
Raw PNG bytes (list-column with raw vector).
pegel_online_measurements() for numeric values.
Other Pegel Online:
pegel_online_measurements(),
pegel_online_station(),
pegel_online_stations(),
pegel_online_timeseries(),
pegel_online_waters()
## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_measurements_plot(stations$uuid[[1]], "W", start = "2024-01-01T00:00:00Z", end = "2024-01-02T00:00:00Z" ) ## End(Not run)## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_measurements_plot(stations$uuid[[1]], "W", start = "2024-01-01T00:00:00Z", end = "2024-01-02T00:00:00Z" ) ## End(Not run)
Get a Pegel-Online station
pegel_online_station( station, params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )pegel_online_station( station, params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
station |
Station UUID, name, or number. |
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Fetches a single station record. API documentation: https://pegel-online.api.bund.dev.
A one-row tibble with the same columns as pegel_online_stations().
bunddev_parameters() to inspect available query parameters.
pegel_online_stations() and pegel_online_timeseries().
Other Pegel Online:
pegel_online_measurements(),
pegel_online_measurements_plot(),
pegel_online_stations(),
pegel_online_timeseries(),
pegel_online_waters()
## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_station(stations$uuid[[1]]) ## End(Not run)## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_station(stations$uuid[[1]]) ## End(Not run)
List Pegel-Online stations
pegel_online_stations( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )pegel_online_stations( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
The Pegel-Online API provides water level station metadata. Use query parameters to filter stations by water, ids, or location. API documentation: https://pegel-online.api.bund.dev.
A tibble with one row per station:
Station UUID (character).
Station number/code (character).
Short station name (character).
Long station name (character).
River kilometer (numeric).
Responsible agency (character).
Longitude (numeric).
Latitude (numeric).
Water metadata (list-column).
Timeseries metadata (list-column).
bunddev_parameters() to inspect available query parameters.
pegel_online_station() for a single station and
pegel_online_measurements() for time series values.
Other Pegel Online:
pegel_online_measurements(),
pegel_online_measurements_plot(),
pegel_online_station(),
pegel_online_timeseries(),
pegel_online_waters()
## Not run: pegel_online_stations(params = list(limit = 5)) ## End(Not run)## Not run: pegel_online_stations(params = list(limit = 5)) ## End(Not run)
Get Pegel-Online timeseries metadata
pegel_online_timeseries( station, timeseries, params = list(), safe = TRUE, refresh = FALSE )pegel_online_timeseries( station, timeseries, params = list(), safe = TRUE, refresh = FALSE )
station |
Station UUID, name, or number. |
timeseries |
Timeseries shortname. |
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns metadata for a timeseries, including unit and gauge zero. Official docs: https://pegel-online.api.bund.dev.
A one-row tibble with timeseries metadata:
Timeseries shortname (character).
Timeseries long name (character).
Measurement unit (character).
Sampling interval/equidistance (numeric).
Gauge zero metadata (list-column).
Characteristic values (list-column).
Current measured value (numeric).
Current timestamp as string (character).
Current timestamp as POSIXct in Europe/Berlin.
bunddev_parameters() to inspect available query parameters.
pegel_online_measurements() for measurement values.
Other Pegel Online:
pegel_online_measurements(),
pegel_online_measurements_plot(),
pegel_online_station(),
pegel_online_stations(),
pegel_online_waters()
## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_timeseries(stations$uuid[[1]], "W") ## End(Not run)## Not run: stations <- pegel_online_stations(params = list(limit = 1)) pegel_online_timeseries(stations$uuid[[1]], "W") ## End(Not run)
List Pegel-Online waters
pegel_online_waters( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )pegel_online_waters( params = list(), safe = TRUE, refresh = FALSE, flatten = FALSE, flatten_mode = "json" )
params |
Named list of query parameters:
|
safe |
Logical; if |
refresh |
Logical; if |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Lists waters available in Pegel-Online. API documentation: https://pegel-online.api.bund.dev.
A tibble with one row per water:
Water shortname (character).
Water long name (character).
Associated stations (list-column).
Associated timeseries metadata (list-column).
bunddev_parameters() to inspect available query parameters.
pegel_online_stations() for station metadata.
Other Pegel Online:
pegel_online_measurements(),
pegel_online_measurements_plot(),
pegel_online_station(),
pegel_online_stations(),
pegel_online_timeseries()
## Not run: pegel_online_waters(params = list(limit = 5)) ## End(Not run)## Not run: pegel_online_waters(params = list(limit = 5)) ## End(Not run)
List approved applications
psm_anwendungen( kennr = NULL, awg_id = NULL, params = list(), safe = TRUE, refresh = FALSE )psm_anwendungen( kennr = NULL, awg_id = NULL, params = list(), safe = TRUE, refresh = FALSE )
kennr |
Optional product identification number. |
awg_id |
Optional application identifier (16 characters). |
params |
Named list of query parameters. Frequently used keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns approved applications (Anwendungsgebiete) which define the combinations of products, crops, and pests for which use is permitted.
A tibble with one row per approved application and columns:
Character. Application request number.
Numeric. Applications per infestation.
Numeric. Max applications per crop.
Numeric. Max applications per vegetation period.
Character. Area of use code.
Character. Application technique.
Character. Application group number.
Character. Application identifier (16 chars).
Numeric. Application interval upper bound.
Character. Interval unit.
Numeric. Application interval lower bound.
Character. Field of use code.
Character. Approval flag.
Character. Home-and-garden flag.
Character. Product identification number.
Character. Crop clarification text.
Character. Pest clarification text.
Character. Crop growth-stage note.
Character. Crop growth-stage upper bound.
Numeric. Crop growth-stage code list.
Character. Crop growth-stage lower bound.
Character. Pest growth-stage note.
Character. Pest growth-stage upper bound.
Numeric. Pest growth-stage code list.
Character. Pest growth-stage lower bound.
Character. Efficacy area code.
bunddev_parameters() to inspect available query parameters.
psm_mittel() to list products.
Other Pflanzenschutzmittelzulassung:
psm_kultur_gruppen(),
psm_mittel(),
psm_schadorg_gruppen(),
psm_stand(),
psm_wirkstoffe()
## Not run: psm_anwendungen(kennr = "024780-00") ## End(Not run)## Not run: psm_anwendungen(kennr = "024780-00") ## End(Not run)
List crop groups
psm_kultur_gruppen(params = list(), safe = TRUE, refresh = FALSE)psm_kultur_gruppen(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Frequently used keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns hierarchical crop group classifications.
A tibble with one row per crop-to-group mapping and columns:
Character. Crop code (child).
Character. Crop group code (parent).
bunddev_parameters() to inspect available query parameters.
Other Pflanzenschutzmittelzulassung:
psm_anwendungen(),
psm_mittel(),
psm_schadorg_gruppen(),
psm_stand(),
psm_wirkstoffe()
## Not run: psm_kultur_gruppen() ## End(Not run)## Not run: psm_kultur_gruppen() ## End(Not run)
List approved plant protection products
psm_mittel(kennr = NULL, params = list(), safe = TRUE, refresh = FALSE)psm_mittel(kennr = NULL, params = list(), safe = TRUE, refresh = FALSE)
kennr |
Optional product identification number (9 characters). |
params |
Named list of query parameters. Frequently used keys:
|
safe |
Logical; if |
refresh |
Logical; if |
The Pflanzenschutzmittelzulassung API provides access to Germany's plant protection product database from the Bundesamt fuer Verbraucherschutz und Lebensmittelsicherheit (BVL). This function returns approved pesticides. API documentation: https://github.com/bundesAPI/pflanzenschutzmittelzulassung-api.
A tibble with one row per plant protection product and columns:
Character. Formulation type code.
Character. Product identification number.
Character. Product trade name.
Character. Approval end date.
Character. Initial approval date.
bunddev_parameters() to inspect available query parameters.
psm_wirkstoffe() to list active ingredients,
psm_stand() for data version.
Other Pflanzenschutzmittelzulassung:
psm_anwendungen(),
psm_kultur_gruppen(),
psm_schadorg_gruppen(),
psm_stand(),
psm_wirkstoffe()
## Not run: psm_mittel() psm_mittel(kennr = "024780-00") ## End(Not run)## Not run: psm_mittel() psm_mittel(kennr = "024780-00") ## End(Not run)
List pest groups
psm_schadorg_gruppen(params = list(), safe = TRUE, refresh = FALSE)psm_schadorg_gruppen(params = list(), safe = TRUE, refresh = FALSE)
params |
Named list of query parameters. Frequently used keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns hierarchical pest/pathogen group classifications.
A tibble with one row per pest-to-group mapping and columns:
Character. Pest organism code (child).
Character. Pest group code (parent).
bunddev_parameters() to inspect available query parameters.
Other Pflanzenschutzmittelzulassung:
psm_anwendungen(),
psm_kultur_gruppen(),
psm_mittel(),
psm_stand(),
psm_wirkstoffe()
## Not run: psm_schadorg_gruppen() ## End(Not run)## Not run: psm_schadorg_gruppen() ## End(Not run)
Get data version
psm_stand(safe = TRUE, refresh = FALSE)psm_stand(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns the release date/version of the plant protection product database.
A tibble with one row and columns:
Character. Release date of the current data set.
Other Pflanzenschutzmittelzulassung:
psm_anwendungen(),
psm_kultur_gruppen(),
psm_mittel(),
psm_schadorg_gruppen(),
psm_wirkstoffe()
## Not run: psm_stand() ## End(Not run)## Not run: psm_stand() ## End(Not run)
List active ingredients
psm_wirkstoffe( wirkstoffId = NULL, params = list(), safe = TRUE, refresh = FALSE )psm_wirkstoffe( wirkstoffId = NULL, params = list(), safe = TRUE, refresh = FALSE )
wirkstoffId |
Optional active ingredient ID. |
params |
Named list of query parameters. Frequently used keys:
|
safe |
Logical; if |
refresh |
Logical; if |
Returns active ingredients (Wirkstoffe) from the plant protection product database.
A tibble with one row per active ingredient and columns:
Character. Approval flag.
Character. Ingredient category.
Character. Active ingredient number.
Character. Active ingredient name (German).
Character. Active ingredient name (English).
bunddev_parameters() to inspect available query parameters.
psm_mittel() to list products.
Other Pflanzenschutzmittelzulassung:
psm_anwendungen(),
psm_kultur_gruppen(),
psm_mittel(),
psm_schadorg_gruppen(),
psm_stand()
## Not run: psm_wirkstoffe() ## End(Not run)## Not run: psm_wirkstoffe() ## End(Not run)
Query Regionalatlas data
regionalatlas_query( table, where = "1=1", out_fields = "*", return_geometry = FALSE, params = list(), safe = TRUE, refresh = FALSE )regionalatlas_query( table, where = "1=1", out_fields = "*", return_geometry = FALSE, params = list(), safe = TRUE, refresh = FALSE )
table |
Table name containing indicators (e.g., "ai002_1_5" for population density). See Details for common tables. |
where |
Optional SQL WHERE clause for filtering. |
out_fields |
Fields to return (default "*" for all). |
return_geometry |
Logical; include geometry in response. |
params |
Additional ArcGIS query parameters merged with adapter defaults. Common keys:
|
safe |
Logical; if |
refresh |
Logical; if |
The Regionalatlas API provides access to over 160 regional indicators from the German statistical offices. Data is available at various administrative levels (Bundeslaender, Regierungsbezirke, Kreise, Gemeinden). API documentation: https://github.com/bundesAPI/regionalatlas-api.
Common tables and their indicators:
ai002_1_5: Population (ai0201=density, ai0202=change, ai0208=foreigners %)
ai002_4_5: Age (ai0218=average age, ai0219=mother age at 1st child)
ai008_1_5: Employment (ai0801=unemployment rate)
ai_s_01: Disposable income per capita
ai_s_04: SGB-II quota
ai017_1: GDP per employee
ai005: Federal election results
Regional levels in data: typ 1=Bundeslaender, 2=Regierungsbezirke, 3=Kreise,
5=Gemeinden. Filter using WHERE clause, e.g., where = "typ = 1".
A tibble with one row per geographic feature and columns:
Character. Official municipality key (Amtlicher Gemeindeschluessel).
Character. Join key for indicator tables.
Character. Region name.
Integer. Administrative level (1=Bundeslaender, 2=Regierungsbezirke, 3=Kreise, 5=Gemeinden).
Integer. Reference year.
Integer. Indicator reference year.
Numeric. Indicator values whose names depend on the selected table (e.g. ai0201 for population density).
bunddev_parameters() for available query parameters.
## Not run: # Population density indicators regionalatlas_query("ai002_1_5") # Filter for Bundeslaender only regionalatlas_query("ai002_1_5", where = "typ = 1") # Age data for Kreise regionalatlas_query("ai002_4_5", where = "typ = 3") ## End(Not run)## Not run: # Population density indicators regionalatlas_query("ai002_1_5") # Filter for Bundeslaender only regionalatlas_query("ai002_1_5", where = "typ = 1") # Age data for Kreise regionalatlas_query("ai002_4_5", where = "typ = 3") ## End(Not run)
List available SMARD timestamps
smard_indices( filter, region = "DE", resolution = "hour", safe = TRUE, refresh = FALSE )smard_indices( filter, region = "DE", resolution = "hour", safe = TRUE, refresh = FALSE )
filter |
Filter id. |
region |
Region code. |
resolution |
Data resolution. |
safe |
Logical; if |
refresh |
Logical; if |
The SMARD API provides power market data published by the Bundesnetzagentur. Use this helper to retrieve available timestamps for a given filter/region and resolution. API documentation: https://smard.api.bund.dev.
Note: The registry rate limit states that more than 60 requests per hour are
not permitted. Use safe = TRUE to respect the limit.
A tibble with one column:
Available SMARD timestamp in milliseconds since epoch (numeric).
smard_timeseries() and smard_table() for data retrieval, and
bunddev_parameters() for parameter discovery.
Other SMARD:
smard_table(),
smard_timeseries()
## Not run: smard_indices(410, region = "DE", resolution = "hour") ## End(Not run)## Not run: smard_indices(410, region = "DE", resolution = "hour") ## End(Not run)
Fetch SMARD table data
smard_table(filter, region = "DE", timestamp, safe = TRUE, refresh = FALSE)smard_table(filter, region = "DE", timestamp, safe = TRUE, refresh = FALSE)
filter |
Filter id. |
region |
Region code. |
timestamp |
Timestamp from indices (ms), POSIXct, or Date. Timestamps are interpreted in the Europe/Berlin timezone. |
safe |
Logical; if |
refresh |
Logical; if |
Returns table-style SMARD data for a single timestamp. Use
smard_indices() to obtain a valid timestamp. API documentation: https://smard.api.bund.dev.
A tibble with one row per returned value/version:
Timestamp in milliseconds since epoch (numeric).
Timestamp as POSIXct in Europe/Berlin.
Reported value (numeric).
Version/series label when provided by the API (character).
smard_indices() for timestamps and smard_timeseries() for time series.
Other SMARD:
smard_indices(),
smard_timeseries()
## Not run: indices <- smard_indices(410, region = "DE", resolution = "hour") smard_table(410, region = "DE", timestamp = indices$timestamp[[1]]) ## End(Not run)## Not run: indices <- smard_indices(410, region = "DE", resolution = "hour") smard_table(410, region = "DE", timestamp = indices$timestamp[[1]]) ## End(Not run)
Fetch SMARD timeseries data
smard_timeseries( filter, region = "DE", resolution = "hour", timestamp, safe = TRUE, refresh = FALSE )smard_timeseries( filter, region = "DE", resolution = "hour", timestamp, safe = TRUE, refresh = FALSE )
filter |
Filter id. |
region |
Region code. |
resolution |
Data resolution. |
timestamp |
Timestamp from indices (ms), POSIXct, or Date. Timestamps are interpreted in the Europe/Berlin timezone. |
safe |
Logical; if |
refresh |
Logical; if |
Returns a tidy time series for a single filter/region. Use
smard_indices() to obtain a valid timestamp. API documentation: https://smard.api.bund.dev.
A tibble with one row per time point:
Timestamp in milliseconds since epoch (numeric).
Timestamp as POSIXct in Europe/Berlin.
Series value for the selected filter/region (numeric).
smard_indices() for timestamps and smard_table() for table output.
Other SMARD:
smard_indices(),
smard_table()
## Not run: indices <- smard_indices(410, region = "DE", resolution = "hour") smard_timeseries(410, region = "DE", resolution = "hour", timestamp = indices$timestamp[[1]]) ## End(Not run)## Not run: indices <- smard_indices(410, region = "DE", resolution = "hour") smard_timeseries(410, region = "DE", resolution = "hour", timestamp = indices$timestamp[[1]]) ## End(Not run)
Fetch Tagesschau channels
tagesschau_channels(flatten = FALSE, flatten_mode = "json")tagesschau_channels(flatten = FALSE, flatten_mode = "json")
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Lists the Tagesschau channels endpoint. API documentation: https://tagesschau.api.bund.dev/.
A tibble with the same columns as tagesschau_homepage(), restricted
to channel entries.
tagesschau_news() and tagesschau_homepage().
Other Tagesschau:
tagesschau_homepage(),
tagesschau_news(),
tagesschau_search()
## Not run: tagesschau_channels(flatten = TRUE) ## End(Not run)## Not run: tagesschau_channels(flatten = TRUE) ## End(Not run)
Fetch Tagesschau homepage items
tagesschau_homepage(flatten = FALSE, flatten_mode = "json")tagesschau_homepage(flatten = FALSE, flatten_mode = "json")
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Fetches the Tagesschau homepage feed as provided by the ARD Tagesschau API. API documentation: https://tagesschau.api.bund.dev/.
Note: The registry rate limit allows up to 60 requests per hour. Usage of content is restricted to private, non-commercial use unless otherwise stated by the source (see Tagesschau CC license notes).
A tibble with one row per item:
Feed section, e.g. "news" or "regional" (character).
Sophora CMS identifier (character).
External identifier (character).
Article title (character).
Publication date string (character).
Parsed publication date (POSIXct).
Topline/kicker text (character).
First sentence of the article (character).
API details URL (character).
Web details URL (character).
Share URL (character).
Update-check URL (character).
Region identifier (character).
Editorial section/ressort (character).
Content type (character).
Whether the item is breaking news (logical).
Copyright notice (character).
Image alt text (character).
Teaser image metadata (list-column).
Tracking metadata (list-column).
Associated tags (list-column).
Image collection (list-column).
Media streams (list-column).
Geographic tags (list-column).
Branding image metadata (list-column).
First video frame metadata (list-column).
With flatten = TRUE, the list-columns are transformed according to
flatten_mode.
tagesschau_news(), tagesschau_search(), and tagesschau_channels().
Other Tagesschau:
tagesschau_channels(),
tagesschau_news(),
tagesschau_search()
## Not run: tagesschau_homepage(flatten = TRUE) ## End(Not run)## Not run: tagesschau_homepage(flatten = TRUE) ## End(Not run)
Fetch Tagesschau news items
tagesschau_news( regions = NULL, ressort = NULL, flatten = FALSE, flatten_mode = "json" )tagesschau_news( regions = NULL, ressort = NULL, flatten = FALSE, flatten_mode = "json" )
regions |
Optional region ids. |
ressort |
Optional ressort filter. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Returns current news items with optional filters for region or ressort. API documentation: https://tagesschau.api.bund.dev/.
A tibble with the same columns as tagesschau_homepage(), filtered
by optional region/ressort parameters.
tagesschau_homepage() and tagesschau_search().
Other Tagesschau:
tagesschau_channels(),
tagesschau_homepage(),
tagesschau_search()
## Not run: tagesschau_news(ressort = "inland", flatten = TRUE) ## End(Not run)## Not run: tagesschau_news(ressort = "inland", flatten = TRUE) ## End(Not run)
Search Tagesschau content
tagesschau_search( search_text = NULL, page_size = NULL, result_page = NULL, flatten = FALSE, flatten_mode = "json" )tagesschau_search( search_text = NULL, page_size = NULL, result_page = NULL, flatten = FALSE, flatten_mode = "json" )
search_text |
Query string. |
page_size |
Results per page. |
result_page |
Result page index. |
flatten |
Logical; if |
flatten_mode |
How to handle list columns when
|
Searches Tagesschau content by free-text query. API documentation: https://tagesschau.api.bund.dev/.
A tibble with the same columns as tagesschau_homepage(), restricted
to search results.
tagesschau_news() and tagesschau_homepage().
Other Tagesschau:
tagesschau_channels(),
tagesschau_homepage(),
tagesschau_news()
## Not run: tagesschau_search(search_text = "energie", page_size = 10, flatten = TRUE) ## End(Not run)## Not run: tagesschau_search(search_text = "energie", page_size = 10, flatten = TRUE) ## End(Not run)
List healthcare documents
travelwarning_healthcare(safe = TRUE, refresh = FALSE)travelwarning_healthcare(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns healthcare documents provided by the Auswaertiges Amt. API documentation: https://travelwarning.api.bund.dev.
A tibble with one row per healthcare document:
Character. Entry/content identifier.
Character. Parent identifier for nested records.
Character. Country code from response metadata.
Numeric. Feed-level modification timestamp.
POSIXct. Parsed feed-level timestamp.
POSIXct. Entry-level modification timestamp.
POSIXct. Entry effective timestamp.
Numeric. Raw entry modification timestamp in ms.
Character. Document name.
Character. Download URL.
Other Travelwarning:
travelwarning_representatives_country(),
travelwarning_representatives_germany(),
travelwarning_state_names(),
travelwarning_warning(),
travelwarning_warnings()
## Not run: travelwarning_healthcare() ## End(Not run)## Not run: travelwarning_healthcare() ## End(Not run)
List German representatives in foreign countries
travelwarning_representatives_country(safe = TRUE, refresh = FALSE)travelwarning_representatives_country(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns a list of German representatives in foreign countries. API documentation: https://travelwarning.api.bund.dev.
A tibble with one row per German representative abroad:
Character. Entry/content identifier.
Character. Parent identifier for nested records.
Character. Country code from response metadata.
Numeric. Feed-level modification timestamp.
POSIXct. Parsed feed-level timestamp.
POSIXct. Entry-level modification timestamp.
POSIXct. Entry effective timestamp.
Numeric. Raw entry modification timestamp in ms.
Character. Representation title.
Character. Head of mission.
Character. Languages spoken.
Character. Country.
Character. Postal code.
Character. City.
Character. Region.
Character. Street.
Character. House number.
Character. Department details.
Character. Fax number.
Character. Phone number.
Character. Email address.
Character. Miscellaneous notes.
Character. External link.
Character. Postal address.
Character. Address type (e.g. Botschaft).
Character. Remark.
Character. Opening hours.
Other Travelwarning:
travelwarning_healthcare(),
travelwarning_representatives_germany(),
travelwarning_state_names(),
travelwarning_warning(),
travelwarning_warnings()
## Not run: travelwarning_representatives_country() ## End(Not run)## Not run: travelwarning_representatives_country() ## End(Not run)
List foreign representatives in Germany
travelwarning_representatives_germany(safe = TRUE, refresh = FALSE)travelwarning_representatives_germany(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns a list of foreign representatives in Germany. API documentation: https://travelwarning.api.bund.dev.
A tibble with one row per foreign representative in Germany:
Character. Entry/content identifier.
Character. Parent identifier for nested records.
Character. Country code from response metadata.
Numeric. Feed-level modification timestamp.
POSIXct. Parsed feed-level timestamp.
POSIXct. Entry-level modification timestamp.
POSIXct. Entry effective timestamp.
Numeric. Raw entry modification timestamp in ms.
Character. Representation title.
Character. Head of mission.
Character. Languages spoken.
Character. Country.
Character. Postal code.
Character. City.
Character. Region.
Character. Street.
Character. House number.
Character. Department details.
Character. Fax number.
Character. Phone number.
Character. Email address.
Character. Miscellaneous notes.
Character. External link.
Character. Postal address.
Character. Address type (e.g. Botschaft).
Character. Remark.
Character. Opening hours.
Other Travelwarning:
travelwarning_healthcare(),
travelwarning_representatives_country(),
travelwarning_state_names(),
travelwarning_warning(),
travelwarning_warnings()
## Not run: travelwarning_representatives_germany() ## End(Not run)## Not run: travelwarning_representatives_germany() ## End(Not run)
List state names documents
travelwarning_state_names(safe = TRUE, refresh = FALSE)travelwarning_state_names(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
Returns documents with state name information. API documentation: https://travelwarning.api.bund.dev.
A tibble with one row per state-name document:
Character. Entry/content identifier.
Character. Parent identifier for nested records.
Character. Country code from response metadata.
Numeric. Feed-level modification timestamp.
POSIXct. Parsed feed-level timestamp.
POSIXct. Entry-level modification timestamp.
POSIXct. Entry effective timestamp.
Numeric. Raw entry modification timestamp in ms.
Character. Document name.
Character. Download URL.
Other Travelwarning:
travelwarning_healthcare(),
travelwarning_representatives_country(),
travelwarning_representatives_germany(),
travelwarning_warning(),
travelwarning_warnings()
## Not run: travelwarning_state_names() ## End(Not run)## Not run: travelwarning_state_names() ## End(Not run)
Get a travel warning by content id
travelwarning_warning(content_id, safe = TRUE, refresh = FALSE)travelwarning_warning(content_id, safe = TRUE, refresh = FALSE)
content_id |
Travel warning content id. |
safe |
Logical; if |
refresh |
Logical; if |
Returns the full travel warning content, including HTML blocks. API documentation: https://travelwarning.api.bund.dev.
A tibble with one row per warning content block. Same metadata
columns as travelwarning_warnings(), plus the full warning detail fields:
Character. Entry/content identifier.
Character. Parent identifier for nested records.
Character. Country code from response metadata.
Numeric. Feed-level modification timestamp in milliseconds.
POSIXct. Parsed feed-level timestamp (Europe/Berlin).
POSIXct. Entry-level modification timestamp (Europe/Berlin).
POSIXct. Entry effective timestamp (Europe/Berlin).
Numeric. Raw entry modification timestamp in ms.
Numeric. Raw entry effective timestamp in ms.
Character. Country travel warning title.
Character. Two-letter country code.
Character. Three-letter ISO country code.
Character. Country name (German).
Logical. Full travel warning issued.
Logical. Partial travel warning issued.
Logical. Situation-based travel warning.
Logical. Situation-based partial warning.
Character. HTML content of the warning.
travelwarning_warnings() to list available ids.
Other Travelwarning:
travelwarning_healthcare(),
travelwarning_representatives_country(),
travelwarning_representatives_germany(),
travelwarning_state_names(),
travelwarning_warnings()
## Not run: warnings <- travelwarning_warnings() travelwarning_warning(warnings$content_id[[1]]) ## End(Not run)## Not run: warnings <- travelwarning_warnings() travelwarning_warning(warnings$content_id[[1]]) ## End(Not run)
List travel warnings
travelwarning_warnings(safe = TRUE, refresh = FALSE)travelwarning_warnings(safe = TRUE, refresh = FALSE)
safe |
Logical; if |
refresh |
Logical; if |
The travelwarning API provides travel and safety information from the Auswaertiges Amt. This endpoint returns a list of all travel warnings with metadata. API documentation: https://travelwarning.api.bund.dev.
A tibble with one row per warning entry.
Character. Entry/content identifier.
Character. Parent identifier for nested records.
Character. Country code from response metadata.
Numeric. Feed-level modification timestamp in milliseconds.
POSIXct. Parsed feed-level timestamp (Europe/Berlin).
POSIXct. Entry-level modification timestamp (Europe/Berlin).
POSIXct. Entry effective timestamp (Europe/Berlin).
Numeric. Raw entry modification timestamp in ms.
Numeric. Raw entry effective timestamp in ms.
Character. Country travel warning title.
Character. Two-letter country code.
Character. Country name (German).
Logical. Full travel warning issued.
Logical. Partial travel warning issued.
Logical. Situation-based travel warning.
Logical. Situation-based partial warning.
travelwarning_warning() for full details of a single warning.
Other Travelwarning:
travelwarning_healthcare(),
travelwarning_representatives_country(),
travelwarning_representatives_germany(),
travelwarning_state_names(),
travelwarning_warning()
## Not run: travelwarning_warnings() ## End(Not run)## Not run: travelwarning_warnings() ## End(Not run)