Title:	Discover and Call 'Bund.dev' APIs
Version:	0.2.3
Depends:	R (≥ 4.1.0)
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.
License:	MIT + file LICENSE
URL:	https://buecker.ms/bunddev/, https://github.com/mchlbckr/bunddev
BugReports:	https://github.com/mchlbckr/bunddev/issues
Encoding:	UTF-8
RoxygenNote:	7.3.3
Suggests:	ggplot2, knitr, rmarkdown, testthat (≥ 3.0.0), withr
Config/testthat/edition:	3
Imports:	cli, dplyr, httr2, jsonlite, purrr, rlang, stringr, tibble, tidyr, tools, xml2, yaml
VignetteBuilder:	knitr, rmarkdown
NeedsCompilation:	no
Packaged:	2026-04-21 13:02:26 UTC; michael
Author:	Michael Bücker [aut, cre]
Maintainer:	Michael Bücker <michael.buecker@fh-muenster.de>
Repository:	CRAN
Date/Publication:	2026-04-22 07:30:02 UTC

List waste fractions

Description

List waste fractions

Usage

abfallnavi_fraktionen(safe = TRUE, refresh = FALSE)

Arguments

Value

A tibble with one row per waste fraction and columns:

id

Integer. Fraction identifier.

name

Character. Fraction name (e.g. "Restabfall").

iconNr

Integer. Icon number for display.

farbeRgb

Character. RGB colour hex code.

See Also

Other Abfallnavi: abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

List waste fractions for a house number

Description

List waste fractions for a house number

Usage

abfallnavi_fraktionen_hausnummern(hausnummern_id, safe = TRUE, refresh = FALSE)

Arguments

Value

A tibble with one row per waste fraction and columns:

id

Integer. Fraction identifier.

name

Character. Fraction name (e.g. "Restabfall").

iconNr

Integer. Icon number for display.

farbeRgb

Character. RGB colour hex code.

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

List waste fractions for a street

Description

List waste fractions for a street

Usage

abfallnavi_fraktionen_strassen(strassen_id, safe = TRUE, refresh = FALSE)

Arguments

Value

A tibble with one row per waste fraction and columns:

id

Integer. Fraction identifier.

name

Character. Fraction name (e.g. "Restabfall").

iconNr

Integer. Icon number for display.

farbeRgb

Character. RGB colour hex code.

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

List house numbers for a street

Description

List house numbers for a street

Usage

abfallnavi_hausnummern(strassen_id, safe = TRUE, refresh = FALSE)

Arguments

Value

A tibble with one row per house number and columns:

id

Integer. House number identifier.

nr

Character. House number label.

plz

Character. Postal code.

staticId

Character. Static identifier (base64-encoded).

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

Download calendar file

Description

Download calendar file

Usage

abfallnavi_kalender_download(
  region,
  format,
  jahr,
  ort,
  strasse,
  hnr,
  fraktion,
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Downloads a calendar file for the requested address and fraction.

Value

A one-row tibble with columns:

region

Character. Region code passed to the request.

format

Character. File format ("pdf" or "ics").

jahr

Integer. Year passed to the request.

bytes

List. Raw file bytes (raw vector).

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

Get a place by id

Description

Get a place by id

Usage

abfallnavi_ort(ort_id, safe = TRUE, refresh = FALSE)

Arguments

Value

A one-row tibble with columns:

id

Integer. Place identifier.

name

Character. Place name.

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

List available places

Description

List available places

Usage

abfallnavi_orte(safe = TRUE, refresh = FALSE)

Arguments

Details

The Abfallnavi API provides waste collection data for supported regions. Start by listing places (Orte) to obtain an ortId. API documentation: https://abfallnavi.api.bund.dev/.

Value

A tibble with one row per place and columns:

id

Integer. Place identifier.

name

Character. Place name.

See Also

abfallnavi_strassen() for streets in a place.

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_strassen(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

Examples

## Not run: 
abfallnavi_orte()

## End(Not run)

List streets for a place

Description

List streets for a place

Usage

abfallnavi_strassen(ort_id, safe = TRUE, refresh = FALSE)

Arguments

Value

A tibble with one row per street and columns:

id

Integer. Street identifier.

name

Character. Street name.

staticId

Character. Static identifier (base64-encoded).

hausNrList

List. House numbers for this street.

plz

Character. Postal code (may be NA).

ortsteilName

Character. District name.

ort

List. Nested place object.

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_termine_hausnummern(), abfallnavi_termine_strassen()

List collection dates for a house number

Description

List collection dates for a house number

Usage

abfallnavi_termine_hausnummern(
  hausnummern_id,
  fraktion,
  safe = TRUE,
  refresh = FALSE
)

Arguments

Value

A tibble with one row per collection date and columns:

id

Integer. Collection event identifier.

bezirk

List. District information for this collection.

datum

Character. Collection date (YYYY-MM-DD).

date_time

POSIXct. Parsed collection date (Europe/Berlin).

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_strassen()

List collection dates for a street

Description

List collection dates for a street

Usage

abfallnavi_termine_strassen(
  strassen_id,
  fraktion,
  safe = TRUE,
  refresh = FALSE
)

Arguments

Value

A tibble with one row per collection date and columns:

id

Integer. Collection event identifier.

bezirk

List. District information for this collection.

datum

Character. Collection date (YYYY-MM-DD).

date_time

POSIXct. Parsed collection date (Europe/Berlin).

See Also

Other Abfallnavi: abfallnavi_fraktionen(), abfallnavi_fraktionen_hausnummern(), abfallnavi_fraktionen_strassen(), abfallnavi_hausnummern(), abfallnavi_kalender_download(), abfallnavi_ort(), abfallnavi_orte(), abfallnavi_strassen(), abfallnavi_termine_hausnummern()

DiGA API adapters

Description

Functions to call the DiGA API endpoints.

Bundes-Klinik-Atlas API adapters

Description

Functions to call the Bundes-Klinik-Atlas API endpoints.

Get training offer details

Description

Get training offer details

Usage

ausbildungssuche_details(offer_id, safe = TRUE, refresh = FALSE)

Arguments

Details

Returns detailed information for a single offer.

Value

A one-row tibble with:

offer_id

Requested offer id.

data

Raw detail payload for the offer (list-column).

See Also

ausbildungssuche_search() to find offer ids.

Other Ausbildungssuche: ausbildungssuche_search()

Examples

## 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

Description

Search training offers

Usage

ausbildungssuche_search(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

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.

Value

A tibble with one row per training offer:

id

Offer id (integer).

unterrichtsform

Teaching format metadata (list-column).

dauer

Duration metadata (list-column).

anbieterbewertung

Provider rating text (character).

angebot

Offer metadata (list-column).

adresse

Address metadata (list-column).

unterrichtszeiten

Class schedule text (character).

kosten_wert

Cost value (character).

kosten_waehrung

Cost currency (character).

kosten_bemerkung

Cost note (character).

foerderung

Funding flag (TRUE/FALSE).

link

Offer link (character).

bemerkung

Additional note text (character).

beginn

Start date text (character).

ende

End date text (character).

individueller_einstieg

Flexible start flag (TRUE/FALSE).

anmeldeschluss

Registration deadline text (character).

bemerkung_zeit

Timing note (character).

pruefende_stelle

Examining body (character).

eigene_angebotsnummer

Provider's own offer id (character).

teilnehmer_min

Minimum participants (integer).

teilnehmer_max

Maximum participants (integer).

aktualisierungsdatum

Update timestamp in milliseconds (numeric).

aktualisierungsdatum_time

Update timestamp as POSIXct in Europe/Berlin.

links

Top-level links object (list-column).

aggregations

Aggregation metadata (list-column).

page

Paging metadata (list-column).

See Also

bunddev_parameters() to inspect available query parameters. ausbildungssuche_details() for a single offer and bunddev_auth_set() for authentication.

Other Ausbildungssuche: ausbildungssuche_details()

Examples

## 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

Description

Get Autobahn charging station details

Usage

autobahn_charging_station_details(
  station_id,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

Returns full details for a single charging station entry. API documentation: https://autobahn.api.bund.dev.

Value

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.

See Also

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()

Examples

## 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

Description

List Autobahn charging stations

Usage

autobahn_charging_stations(road_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns charging stations for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per charging-station entry:

road_id

Road identifier (character).

identifier

Entry identifier (character).

title

Title (character).

subtitle

Subtitle (character).

display_type

Display type (character).

icon

Icon identifier (character).

is_blocked

Whether the road is blocked (logical).

future

Whether the entry is future-dated (logical).

start_timestamp

Start timestamp string (character).

start_time

Parsed start time (POSIXct).

point

Point coordinate string (character).

extent

Extent coordinate string (character).

coordinate_lat

Latitude (character).

coordinate_long

Longitude (character).

description

Description text (character).

footer

Footer text (character).

route_recommendation

Route recommendations (list-column).

lorry_parking_feature_icons

Lorry parking feature icons (list-column).

With flatten = TRUE, the two list-columns are transformed according to flatten_mode.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
autobahn_charging_stations(roads$road_id[[1]], flatten = TRUE)

## End(Not run)

Get Autobahn closure details

Description

Get Autobahn closure details

Usage

autobahn_closure_details(closure_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns full details for a single closure entry. API documentation: https://autobahn.api.bund.dev.

Value

A one-row tibble for the selected closure with the same columns as autobahn_closures(). road_id is typically NA for detail calls.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
closures <- autobahn_closures(roads$road_id[[1]])
autobahn_closure_details(closures$identifier[[1]])

## End(Not run)

List Autobahn closures

Description

List Autobahn closures

Usage

autobahn_closures(road_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns current closures for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per closure entry:

road_id

Road identifier (character).

identifier

Entry identifier (character).

title

Title (character).

subtitle

Subtitle (character).

display_type

Display type (character).

icon

Icon identifier (character).

is_blocked

Whether the road is blocked (logical).

future

Whether the entry is future-dated (logical).

start_timestamp

Start timestamp string (character).

start_time

Parsed start time (POSIXct).

point

Point coordinate string (character).

extent

Extent coordinate string (character).

coordinate_lat

Latitude (character).

coordinate_long

Longitude (character).

description

Description text (character).

footer

Footer text (character).

route_recommendation

Route recommendations (list-column).

lorry_parking_feature_icons

Lorry parking feature icons (list-column).

With flatten = TRUE, the two list-columns are transformed according to flatten_mode.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
autobahn_closures(roads$road_id[[1]], flatten = TRUE)

## End(Not run)

List Autobahn lorry parking areas

Description

List Autobahn lorry parking areas

Usage

autobahn_parking_lorries(road_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns lorry parking areas for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per lorry-parking entry:

road_id

Road identifier (character).

identifier

Entry identifier (character).

title

Title (character).

subtitle

Subtitle (character).

display_type

Display type (character).

icon

Icon identifier (character).

is_blocked

Whether the road is blocked (logical).

future

Whether the entry is future-dated (logical).

start_timestamp

Start timestamp string (character).

start_time

Parsed start time (POSIXct).

point

Point coordinate string (character).

extent

Extent coordinate string (character).

coordinate_lat

Latitude (character).

coordinate_long

Longitude (character).

description

Description text (character).

footer

Footer text (character).

route_recommendation

Route recommendations (list-column).

lorry_parking_feature_icons

Lorry parking feature icons (list-column).

With flatten = TRUE, the two list-columns are transformed according to flatten_mode.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
autobahn_parking_lorries(roads$road_id[[1]], flatten = TRUE)

## End(Not run)

Get Autobahn lorry parking details

Description

Get Autobahn lorry parking details

Usage

autobahn_parking_lorry_details(
  lorry_id,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

Returns full details for a single lorry parking entry. API documentation: https://autobahn.api.bund.dev.

Value

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.

See Also

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()

Examples

## 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

Description

List Autobahn road ids

Usage

autobahn_roads()

Details

Lists Autobahn road ids from the Autobahn App API (Autobahn GmbH). API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per Autobahn id:

road_id

Autobahn identifier (character).

See Also

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()

Examples

## Not run: 
autobahn_roads()

## End(Not run)

Get Autobahn roadwork details

Description

Get Autobahn roadwork details

Usage

autobahn_roadwork_details(roadwork_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns full details for a single roadwork entry. API documentation: https://autobahn.api.bund.dev.

Value

A one-row tibble for the selected roadwork with the same columns as autobahn_roadworks(). road_id is typically NA for detail calls.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
roadworks <- autobahn_roadworks(roads$road_id[[1]])
autobahn_roadwork_details(roadworks$identifier[[1]])

## End(Not run)

List Autobahn roadworks

Description

List Autobahn roadworks

Usage

autobahn_roadworks(road_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns current roadworks for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per roadwork entry:

road_id

Road identifier (character).

identifier

Entry identifier (character).

title

Title (character).

subtitle

Subtitle (character).

display_type

Display type (character).

icon

Icon identifier (character).

is_blocked

Whether the road is blocked (logical).

future

Whether the entry is future-dated (logical).

start_timestamp

Start timestamp string (character).

start_time

Parsed start time (POSIXct).

point

Point coordinate string (character).

extent

Extent coordinate string (character).

coordinate_lat

Latitude (character).

coordinate_long

Longitude (character).

description

Description text (character).

footer

Footer text (character).

route_recommendation

Route recommendations (list-column).

lorry_parking_feature_icons

Lorry parking feature icons (list-column).

With flatten = TRUE, the two list-columns are transformed according to flatten_mode.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
autobahn_roadworks(roads$road_id[[1]], flatten = TRUE)

## End(Not run)

Get Autobahn warning details

Description

Get Autobahn warning details

Usage

autobahn_warning_details(warning_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns full details for a single warning entry. API documentation: https://autobahn.api.bund.dev.

Value

A one-row tibble for the selected warning with the same columns as autobahn_warnings(). road_id is typically NA for detail calls.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
warnings <- autobahn_warnings(roads$road_id[[1]])
autobahn_warning_details(warnings$identifier[[1]])

## End(Not run)

List Autobahn warnings

Description

List Autobahn warnings

Usage

autobahn_warnings(road_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns current warnings for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per warning entry:

road_id

Road identifier (character).

identifier

Entry identifier (character).

title

Title (character).

subtitle

Subtitle (character).

display_type

Display type (character).

icon

Icon identifier (character).

is_blocked

Whether the road is blocked (logical).

future

Whether the entry is future-dated (logical).

start_timestamp

Start timestamp string (character).

start_time

Parsed start time (POSIXct).

point

Point coordinate string (character).

extent

Extent coordinate string (character).

coordinate_lat

Latitude (character).

coordinate_long

Longitude (character).

description

Description text (character).

footer

Footer text (character).

route_recommendation

Route recommendations (list-column).

lorry_parking_feature_icons

Lorry parking feature icons (list-column).

With flatten = TRUE, the two list-columns are transformed according to flatten_mode.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
autobahn_warnings(roads$road_id[[1]], flatten = TRUE)

## End(Not run)

Get Autobahn webcam details

Description

Get Autobahn webcam details

Usage

autobahn_webcam_details(webcam_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns full details for a single webcam entry. API documentation: https://autobahn.api.bund.dev.

Value

A one-row tibble for the selected webcam with the same columns as autobahn_webcams(). road_id is typically NA for detail calls.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
webcams <- autobahn_webcams(roads$road_id[[1]])
autobahn_webcam_details(webcams$identifier[[1]])

## End(Not run)

List Autobahn webcams

Description

List Autobahn webcams

Usage

autobahn_webcams(road_id, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Returns webcam entries for a specific Autobahn road id. API documentation: https://autobahn.api.bund.dev.

Value

A tibble with one row per webcam entry:

road_id

Road identifier (character).

identifier

Entry identifier (character).

title

Title (character).

subtitle

Subtitle (character).

display_type

Display type (character).

icon

Icon identifier (character).

is_blocked

Whether the road is blocked (logical).

future

Whether the entry is future-dated (logical).

start_timestamp

Start timestamp string (character).

start_time

Parsed start time (POSIXct).

point

Point coordinate string (character).

extent

Extent coordinate string (character).

coordinate_lat

Latitude (character).

coordinate_long

Longitude (character).

description

Description text (character).

footer

Footer text (character).

route_recommendation

Route recommendations (list-column).

lorry_parking_feature_icons

Lorry parking feature icons (list-column).

With flatten = TRUE, the two list-columns are transformed according to flatten_mode.

See Also

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()

Examples

## Not run: 
roads <- autobahn_roads()
autobahn_webcams(roads$road_id[[1]], flatten = TRUE)

## End(Not run)

Retrieve Bewerberboerse candidate details

Description

Retrieve Bewerberboerse candidate details

Usage

bewerberboerse_details(referenznummer, flatten = FALSE, flatten_mode = "json")

Arguments

Details

Fetches details for a single candidate. The referenznummer typically comes from bewerberboerse_search(). See https://bundesapi.github.io/bewerberboerse-api/.

Value

A tibble with the same columns as bewerberboerse_search(), filtered to the requested referenznummer.

refnr

Candidate reference number (character).

verfuegbarkeit_von

Availability date text (character).

aktualisierungsdatum

Last update date text (character).

veroeffentlichungsdatum

Publication date text (character).

stellenart

Position type (character).

arbeitszeit_modelle

Work-time models, collapsed string (character).

berufe

Occupations, collapsed string (character).

letzte_taetigkeit_jahr

Year of most recent activity (character).

letzte_taetigkeit_bezeichnung

Label of most recent activity (character).

letzte_taetigkeit_aktuell

Whether latest activity is current (logical).

hat_email

Email contact available (logical).

hat_telefon

Phone contact available (logical).

hat_adresse

Postal address available (logical).

ort

City/locality (character).

plz

Postal code (character).

umkreis

Radius text returned by API (character).

region

Region/state (character).

land

Country (character).

mehrere_arbeitsorte

Multiple work locations flag (logical).

ausbildungen

Education entries (list-column).

erfahrung

Experience entries (list-column).

operation_id

Operation identifier (character).

page

Returned page index (integer).

size

Returned page size (integer).

max_ergebnisse

Total matching result count (integer).

See Also

bewerberboerse_search() to find candidates and bunddev_auth_set() for auth.

Other Bewerberboerse: bewerberboerse_search()

Examples

## 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

Description

Search the Bewerberboerse API

Usage

bewerberboerse_search(params = list(), flatten = FALSE, flatten_mode = "json")

Arguments

Details

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.

Value

A tibble with one row per candidate profile:

refnr

Candidate reference number (character).

verfuegbarkeit_von

Availability date text (character).

aktualisierungsdatum

Last update date text (character).

veroeffentlichungsdatum

Publication date text (character).

stellenart

Position type (character).

arbeitszeit_modelle

Work-time models, collapsed string (character).

berufe

Occupations, collapsed string (character).

letzte_taetigkeit_jahr

Year of most recent activity (character).

letzte_taetigkeit_bezeichnung

Label of most recent activity (character).

letzte_taetigkeit_aktuell

Whether latest activity is current (TRUE/FALSE).

hat_email

Email contact available (TRUE/FALSE).

hat_telefon

Phone contact available (TRUE/FALSE).

hat_adresse

Postal address available (TRUE/FALSE).

ort

City/locality (character).

plz

Postal code (character).

umkreis

Radius text returned by API (character).

region

Region/state (character).

land

Country (character).

mehrere_arbeitsorte

Multiple work locations flag (TRUE/FALSE).

ausbildungen

Education entries (list-column).

erfahrung

Experience entries (list-column).

operation_id

Operation identifier used by the tidier (character).

page

Returned page index (integer).

size

Returned page size (integer).

max_ergebnisse

Total matching result count (integer).

See Also

bewerberboerse_details() for detailed entries and bunddev_auth_set() for authentication setup.

Other Bewerberboerse: bewerberboerse_details()

Examples

## 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

Description

Get authentication configuration for an API

Usage

bunddev_auth_get(api)

Arguments

Details

Returns the stored auth configuration for the API or a default none entry if no auth has been configured.

Value

A named list with auth settings for api. If no configuration was set, returns defaults with type = "none".

See Also

bunddev_auth_set() to configure credentials.

Other Authentication: bunddev_auth_set()

Examples

bunddev_auth_get("jobsuche")

Build Authorization header value

Description

Build Authorization header value

Usage

bunddev_auth_header(api, token = NULL)

Arguments

Details

Constructs the Authorization header value based on the configured scheme. Supports template-style schemes containing ⁠%s⁠ for the key/token.

Value

A character string for the Authorization header, or NULL if no auth.

Set authentication configuration for an API

Description

Set authentication configuration for an API

Usage

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"
)

Arguments

Details

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.

Value

A named list with stored authentication settings:

type

Authentication type ("none", "api_key", "oauth2").

env_var

Environment variable name for credential lookup.

scheme

Header scheme/template used for auth header construction.

oauth_url

OAuth token endpoint URL (oauth2 only).

oauth_secret_env

Environment variable name for OAuth client secret.

oauth_default_id

Fallback OAuth client ID when env_var is unset.

oauth_token_header

Header name used for OAuth access tokens.

oauth_fallback_header

Header name used for fallback API key mode.

See Also

bunddev_auth_get() to inspect the stored configuration, and bunddev_call() to make authenticated requests.

Other Authentication: bunddev_auth_get()

Examples

# 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")

Get raw auth token for an API

Description

Get raw auth token for an API

Usage

bunddev_auth_token(api)

Arguments

Value

The raw token value, or NULL if no auth configured.

Locate the bunddev cache directory

Description

Locate the bunddev cache directory

Usage

bunddev_cache_dir()

Details

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.

Value

Path to the bunddev cache directory (character scalar).

See Also

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()

Examples

## Not run: 
bunddev_cache_dir()

## End(Not run)

Call an API operation

Description

Call an API operation

Usage

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
)

Arguments

Details

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.

Value

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.

See Also

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()

Examples

## Not run: 
# Retrieve Autobahn road ids (raw response)
bunddev_call("autobahn", "list-autobahnen")

## End(Not run)

Call an API operation and return tidy data

Description

Call an API operation and return tidy data

Usage

bunddev_call_tidy(api, operation_id, params = list(), ...)

Arguments

Details

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.

Value

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.

See Also

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()

Examples

## Not run: 
# Tidy Autobahn roadworks
bunddev_call_tidy("autobahn", "list-roadworks", params = list(roadId = "A1"))

## End(Not run)

Retrieve endpoints for a given API

Description

Retrieve endpoints for a given API

List OpenAPI endpoints for an API

Usage

bunddev_endpoints(id)

bunddev_endpoints(id)

Arguments

Details

Parses the cached OpenAPI spec and returns every available path + method with its operationId and summary, if provided.

Value

A tibble with columns method, path, operation_id, summary

A tibble with one row per OpenAPI operation:

method

HTTP method in lower-case, e.g. "get" (character).

path

OpenAPI path template, e.g. "/v1/items/{id}" (character).

operation_id

OpenAPI operationId (character or NA).

summary

Operation summary from the spec (character or NA).

See Also

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()

Examples

## Not run: 
bunddev_endpoints("autobahn")

## End(Not run)

Get a registry entry by id

Description

Get a registry entry by id

Usage

bunddev_info(id)

Arguments

Details

Use this to access the spec URL, documentation URL, and authentication requirements for a single API.

Value

A one-row tibble with the same columns as bunddev_registry().

See Also

bunddev_list() for discovery and bunddev_registry() for the full table.

Other Registry: bunddev_list(), bunddev_registry(), bunddev_search()

Examples

bunddev_info("smard")

List registry entries

Description

List registry entries

Usage

bunddev_list(tag = NULL, auth = NULL)

Arguments

Details

Use this to quickly narrow down APIs by topic or authentication type. Tags correspond to the taxonomy in the bundled registry.

Value

A tibble with the same columns as bunddev_registry(), filtered by tag and/or auth when provided.

See Also

bunddev_registry() for the full table and bunddev_info() for one entry.

Other Registry: bunddev_info(), bunddev_registry(), bunddev_search()

Examples

bunddev_list(tag = "jobs")
bunddev_list(auth = "api_key")

Convert milliseconds to POSIXct

Description

Convert milliseconds to POSIXct

Usage

bunddev_ms_to_posix(value, tz = "Europe/Berlin")

Arguments

Details

Converts epoch milliseconds to POSIXct in the requested timezone.

Value

POSIXct timestamp.

See Also

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()

Examples

bunddev_ms_to_posix(1704067200000, tz = "Europe/Berlin")

Get OAuth2 client ID for an API

Description

Get OAuth2 client ID for an API

Usage

bunddev_oauth_client_id(api)

Arguments

Details

Returns the OAuth2 client ID from env var or default config.

Value

Client ID string.

Fetch OAuth2 token for an API

Description

Fetch OAuth2 token for an API

Usage

bunddev_oauth_token(api)

Arguments

Details

Fetches an OAuth2 access token using the client credentials flow. Returns NULL if no client secret is available (will fall back to API key auth).

Value

OAuth token string, or NULL if unavailable.

Extract parameter enum values

Description

Extract parameter enum values

Usage

bunddev_parameter_values(endpoint, name)

Arguments

Details

Returns unique enum values for a parameter defined on the adapter endpoint.

Value

A character vector of unique enum values. Returns character(0) if no enum is declared for the selected parameter.

See Also

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()

Examples

## Not run: 
bunddev_parameter_values(smard_timeseries, "resolution")

## End(Not run)

List OpenAPI parameters for an API

Description

List OpenAPI parameters for an API

Usage

bunddev_parameters(id, name = NULL, path = NULL, method = NULL)

Arguments

Details

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.

Value

A tibble with one row per parameter definition:

method

HTTP method in lower-case (character).

path

OpenAPI path template where the parameter applies (character).

name

Parameter name (character).

location

Parameter location such as "query" or "path" (character).

required

Whether the parameter is required (TRUE/FALSE).

description

Parameter description from the spec (character or NA).

schema_type

OpenAPI schema type, e.g. "string" (character or NA).

enum

List-column of allowed values (list of character vectors).

See Also

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()

Examples

## Not run: 
bunddev_parameters("smard", name = "resolution")

## End(Not run)

List OpenAPI parameters for a specific adapter

Description

List OpenAPI parameters for a specific adapter

Usage

bunddev_parameters_for(endpoint)

Arguments

Details

Resolves the adapter to an OpenAPI path/method mapping and filters parameters accordingly.

Value

A tibble with the same columns as bunddev_parameters(), filtered to the OpenAPI path/method associated with endpoint.

See Also

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()

Examples

## Not run: 
bunddev_parameters_for(smard_timeseries)

## End(Not run)

Get API rate limit configuration

Description

Get API rate limit configuration

Usage

bunddev_rate_limit_get(api)

Arguments

Details

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.

Value

A named list with:

max_per_hour

Configured/inferred calls-per-hour limit (integer or NA).

timestamps

Numeric Unix timestamps of tracked requests.

See Also

bunddev_rate_limit_set() to override the default.

Other Throttling: bunddev_rate_limit_set()

Examples

bunddev_rate_limit_get("smard")

Set API rate limit configuration

Description

Set API rate limit configuration

Usage

bunddev_rate_limit_set(api, max_per_hour)

Arguments

Details

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.

Value

A named list with:

max_per_hour

Maximum allowed calls per hour (integer).

timestamps

Numeric Unix timestamps of tracked requests.

See Also

bunddev_rate_limit_get() to inspect the current setting.

Other Throttling: bunddev_rate_limit_get()

Examples

bunddev_rate_limit_set("smard", max_per_hour = 60)

Read the bundled API registry

Description

Read the bundled API registry

Usage

bunddev_registry()

Details

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.

Value

A tibble with one row per API registry entry:

id

Stable API identifier used throughout bunddev (character).

title

Human-readable API title (character).

provider

API provider or owning institution (character).

spec_url

OpenAPI specification URL (character).

docs_url

Upstream API documentation URL (character).

auth

Authentication type ("none", "api_key", "oauth2").

rate_limit

Declared upstream rate limit text (character or NA).

tags

List-column of taxonomy tags (list of character vectors).

See Also

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()

Examples

registry <- bunddev_registry()
head(registry, 3)

Search registry entries

Description

Search registry entries

Usage

bunddev_search(q)

Arguments

Details

Searches across registry ids, titles, providers, and tags using a simple substring match.

Value

A tibble with the same columns as bunddev_registry(), containing entries that match q.

See Also

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()

Examples

bunddev_search("weather")

Retrieve a cached API spec

Description

Retrieve a cached API spec

Usage

bunddev_spec(id, refresh = FALSE)

Arguments

Details

Downloads the OpenAPI spec from the registry if it is missing or when refresh = TRUE. Parsed specs are returned as lists.

Value

Parsed OpenAPI specification as a nested list.

See Also

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()

Examples

## Not run: 
bunddev_spec("smard")

## End(Not run)

Build a cache path for an API spec

Description

Build a cache path for an API spec

Usage

bunddev_spec_path(id)

Arguments

Details

Determines the cache file name based on the spec URL extension (.yaml/.json).

Value

File path where the API specification is cached (character scalar).

See Also

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()

Examples

## Not run: 
bunddev_spec_path("smard")

## End(Not run)

Convert timestamps to milliseconds

Description

Convert timestamps to milliseconds

Usage

bunddev_timestamp_to_ms(value, tz = "Europe/Berlin")

Arguments

Details

This helper standardizes timestamps for APIs that expect epoch milliseconds. Dates are interpreted in the supplied timezone.

Value

Numeric timestamp in milliseconds.

See Also

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()

Examples

bunddev_timestamp_to_ms(as.POSIXct("2024-01-01 00:00:00", tz = "Europe/Berlin"))

Query Bundeshaushalt budget data

Description

Query Bundeshaushalt budget data

Usage

bundeshaushalt_budget_data(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

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.

Value

A one-row tibble with budget metadata and nested payloads:

account

Requested account type (character).

entity

Entity label from the API response (character).

level_cur

Current hierarchy level (integer).

level_max

Maximum hierarchy level (integer).

modify_date

Upstream modification date (character).

quota

Quota/target mode (character).

timestamp

Response timestamp in milliseconds (numeric).

timestamp_time

Response timestamp as POSIXct in Europe/Berlin.

unit

Selected unit/granularity (character).

year

Budget year (integer).

details

Detailed budget rows (list-column).

children

Child nodes in the budget hierarchy (list-column).

parents

Parent nodes in the hierarchy (list-column).

related

Related nodes from the API response (list-column).

See Also

bunddev_parameters() to inspect parameter metadata from the OpenAPI spec.

Examples

## Not run: 
bundeshaushalt_budget_data(params = list(year = 2021, account = "expenses"))

## End(Not run)

List current Bundesrat news

Description

List current Bundesrat news

Usage

bundesrat_aktuelles(view = "renderXml", safe = TRUE, refresh = FALSE)

Arguments

Details

Returns current news items from the Bundesrat app feed. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_aktuelles()

## End(Not run)

List Bundesrat members

Description

List Bundesrat members

Usage

bundesrat_mitglieder(view = "renderXml", safe = TRUE, refresh = FALSE)

Arguments

Details

Returns Bundesrat member entries from the mobile feed. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_mitglieder()

## End(Not run)

List Bundesrat current plenum session entries

Description

List Bundesrat current plenum session entries

Usage

bundesrat_plenum_aktuelle_sitzung(
  view = "renderXml",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns entries for the current plenum session. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

Other Bundesrat: bundesrat_aktuelles(), bundesrat_mitglieder(), bundesrat_plenum_chronologisch(), bundesrat_plenum_kompakt(), bundesrat_plenum_naechste_sitzungen(), bundesrat_praesidium(), bundesrat_startlist(), bundesrat_stimmverteilung(), bundesrat_termine()

Examples

## Not run: 
bundesrat_plenum_aktuelle_sitzung()

## End(Not run)

List Bundesrat plenum entries in chronological order

Description

List Bundesrat plenum entries in chronological order

Usage

bundesrat_plenum_chronologisch(
  view = "renderXml",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns plenum entries ordered chronologically. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_plenum_chronologisch()

## End(Not run)

List Bundesrat plenum compact entries

Description

List Bundesrat plenum compact entries

Usage

bundesrat_plenum_kompakt(view = "renderXml", safe = TRUE, refresh = FALSE)

Arguments

Details

Returns plenum compact entries for Bundesrat sessions. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_plenum_kompakt()

## End(Not run)

Get Bundesrat upcoming plenum sessions

Description

Get Bundesrat upcoming plenum sessions

Usage

bundesrat_plenum_naechste_sitzungen(
  view = "render[iOSDetailsWithoutInnerDate]",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns upcoming Bundesrat sessions. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

Other Bundesrat: bundesrat_aktuelles(), bundesrat_mitglieder(), bundesrat_plenum_aktuelle_sitzung(), bundesrat_plenum_chronologisch(), bundesrat_plenum_kompakt(), bundesrat_praesidium(), bundesrat_startlist(), bundesrat_stimmverteilung(), bundesrat_termine()

Examples

## Not run: 
bundesrat_plenum_naechste_sitzungen()

## End(Not run)

List Bundesrat presidium entries

Description

List Bundesrat presidium entries

Usage

bundesrat_praesidium(view = "renderXml", safe = TRUE, refresh = FALSE)

Arguments

Details

Returns Bundesrat presidium entries. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_praesidium()

## End(Not run)

List Bundesrat API endpoints

Description

List Bundesrat API endpoints

Usage

bundesrat_startlist(view = "renderXml", safe = TRUE, refresh = FALSE)

Arguments

Details

Returns the start list for the Bundesrat mobile API, including the URLs for other available resources. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field (date, dateOfIssue, imageDate, layoutDate, startdate, stopdate) is present.

See Also

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()

Examples

## Not run: 
bundesrat_startlist()

## End(Not run)

Get Bundesrat voting distribution

Description

Get Bundesrat voting distribution

Usage

bundesrat_stimmverteilung(
  view = "render[iOSDetailsWithoutInnerDate]",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns the Bundesrat voting distribution. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_stimmverteilung()

## End(Not run)

List Bundesrat dates and events

Description

List Bundesrat dates and events

Usage

bundesrat_termine(view = "renderXml", safe = TRUE, refresh = FALSE)

Arguments

Details

Returns scheduled Bundesrat dates and events. API documentation: https://bundesrat.api.bund.dev.

Value

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>⁠.

date_time, dateOfIssue_time, imageDate_time, layoutDate_time, startdate_time, stopdate_time

Parsed POSIXct (Europe/Berlin) added when the corresponding source field is present.

See Also

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()

Examples

## Not run: 
bundesrat_termine()

## End(Not run)

Get a Bundestag news article

Description

Get a Bundestag news article

Usage

bundestag_article(article_id, safe = TRUE, refresh = FALSE)

Arguments

Details

Returns a single Bundestag news article in XML format. API documentation: https://bundestag.api.bund.dev/.

Value

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.

See Also

Other Bundestag: bundestag_ausschuesse(), bundestag_ausschuss(), bundestag_conferences(), bundestag_mdb_bio(), bundestag_mdb_index(), bundestag_speaker(), bundestag_video_feed()

Examples

## Not run: 
bundestag_article(849630)

## End(Not run)

List Bundestag committees

Description

List Bundestag committees

Usage

bundestag_ausschuesse(safe = TRUE, refresh = FALSE)

Arguments

Details

Returns the committee index from Bundestag XML feeds. API documentation: https://bundestag.api.bund.dev/.

Value

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>⁠.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuss(), bundestag_conferences(), bundestag_mdb_bio(), bundestag_mdb_index(), bundestag_speaker(), bundestag_video_feed()

Examples

## Not run: 
bundestag_ausschuesse()

## End(Not run)

Get Bundestag committee details

Description

Get Bundestag committee details

Usage

bundestag_ausschuss(ausschuss_id, safe = TRUE, refresh = FALSE)

Arguments

Details

Returns details for a single committee. API documentation: https://bundestag.api.bund.dev/.

Value

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.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuesse(), bundestag_conferences(), bundestag_mdb_bio(), bundestag_mdb_index(), bundestag_speaker(), bundestag_video_feed()

Examples

## Not run: 
bundestag_ausschuss("a11")

## End(Not run)

Get Bundestag conferences overview

Description

Get Bundestag conferences overview

Usage

bundestag_conferences(safe = TRUE, refresh = FALSE)

Arguments

Details

Returns conference overview data from the plenum feed. API documentation: https://bundestag.api.bund.dev/.

Value

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>⁠.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuesse(), bundestag_ausschuss(), bundestag_mdb_bio(), bundestag_mdb_index(), bundestag_speaker(), bundestag_video_feed()

Examples

## Not run: 
bundestag_conferences()

## End(Not run)

Search the Bundestag lobbyregister

Description

Search the Bundestag lobbyregister

Usage

bundestag_lobbyregister_search(
  q = NULL,
  sort = NULL,
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

Returns search results from the Bundestag lobbyregister. API documentation: https://bundesapi.github.io/bundestag-lobbyregister-api/.

Value

A one-row tibble with search metadata:

source

Source label from the API payload (character).

source_url

Source URL (character).

search_url

URL of the executed search (character).

search_date

Search timestamp/date string (character).

search_parameters

Effective search parameter object (list-column).

result_count

Total result count (integer).

results

Search result entries (list-column).

Examples

## Not run: 
bundestag_lobbyregister_search(q = "energie")

## End(Not run)

Get a Bundestag biography

Description

Get a Bundestag biography

Usage

bundestag_mdb_bio(mdb_id, safe = TRUE, refresh = FALSE)

Arguments

Details

Returns details for a single member of parliament. API documentation: https://bundestag.api.bund.dev/.

Value

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.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuesse(), bundestag_ausschuss(), bundestag_conferences(), bundestag_mdb_index(), bundestag_speaker(), bundestag_video_feed()

Examples

## Not run: 
bundestag_mdb_bio(1769)

## End(Not run)

List Bundestag members of parliament

Description

List Bundestag members of parliament

Usage

bundestag_mdb_index(safe = TRUE, refresh = FALSE)

Arguments

Details

Returns the index of members of parliament. API documentation: https://bundestag.api.bund.dev/.

Value

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>⁠.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuesse(), bundestag_ausschuss(), bundestag_conferences(), bundestag_mdb_bio(), bundestag_speaker(), bundestag_video_feed()

Examples

## Not run: 
bundestag_mdb_index()

## End(Not run)

Get the current Bundestag speaker

Description

Get the current Bundestag speaker

Usage

bundestag_speaker(safe = TRUE, refresh = FALSE)

Arguments

Details

Returns the current speaker from the plenum feed. API documentation: https://bundestag.api.bund.dev/.

Value

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.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuesse(), bundestag_ausschuss(), bundestag_conferences(), bundestag_mdb_bio(), bundestag_mdb_index(), bundestag_video_feed()

Examples

## Not run: 
bundestag_speaker()

## End(Not run)

Get a Bundestag video feed entry

Description

Get a Bundestag video feed entry

Usage

bundestag_video_feed(content_id, safe = TRUE, refresh = FALSE)

Arguments

Details

Returns a video feed entry from the Bundestag webtv service. API documentation: https://bundestag.api.bund.dev/.

Value

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.

See Also

Other Bundestag: bundestag_article(), bundestag_ausschuesse(), bundestag_ausschuss(), bundestag_conferences(), bundestag_mdb_bio(), bundestag_mdb_index(), bundestag_speaker()

Examples

## Not run: 
bundestag_video_feed(7529016)

## End(Not run)

Get Dashboard Deutschland GeoJSON

Description

Get Dashboard Deutschland GeoJSON

Usage

dashboard_deutschland_geo(
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

Returns GeoJSON data for Germany and the federal states. API documentation: https://dashboard.deutschland.api.bund.dev/.

Value

A one-row tibble with GeoJSON container metadata:

type

GeoJSON object type (character).

name

Dataset name (character).

title

Dataset title (character).

version

Version identifier (character).

copyright_short

Short copyright label (character).

copyright_url

Copyright URL (character).

crs

Coordinate reference system metadata (list-column).

features

GeoJSON feature collection entries (list-column).

See Also

Other Dashboard Deutschland: dashboard_deutschland_get(), dashboard_deutschland_indicators()

Examples

## Not run: 
dashboard_deutschland_geo(flatten = TRUE)

## End(Not run)

List Dashboard Deutschland entries

Description

List Dashboard Deutschland entries

Usage

dashboard_deutschland_get(
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

Returns the full list of dashboard entries and metadata for each item. API documentation: https://dashboard.deutschland.api.bund.dev/.

Value

A tibble with one row per dashboard tile:

id

Tile identifier (character).

name

Title in German (character).

name_en

Title in English (character).

description

Description in German (character).

description_en

Description in English (character).

teaser

Teaser text in German (character).

teaser_en

Teaser text in English (character).

conclusion

Conclusion text in German (character).

conclusion_en

Conclusion text in English (character).

category

Category metadata (list-column).

tags

Tag metadata (list-column).

image

Image path/url (character).

clicks

Click counter (integer).

order_id

Ordering index (integer).

trending

Whether tile is marked as trending (TRUE/FALSE).

top

Whether tile is marked as top (TRUE/FALSE).

layout_tiles

Layout tile metadata (list-column).

layout_mode

Layout mode identifier (character).

See Also

Other Dashboard Deutschland: dashboard_deutschland_geo(), dashboard_deutschland_indicators()

Examples

## Not run: 
dashboard_deutschland_get()

## End(Not run)

Query Dashboard Deutschland indicators

Description

Query Dashboard Deutschland indicators

Usage

dashboard_deutschland_indicators(ids = NULL, safe = TRUE, refresh = FALSE)

Arguments

Details

Returns indicator data for the specified ids. API documentation: https://dashboard.deutschland.api.bund.dev/.

Value

A tibble with one row per indicator entry:

id

Indicator id (character).

date

Timestamp in milliseconds since epoch (numeric).

date_time

Timestamp as POSIXct in Europe/Berlin.

json

Indicator payload as JSON string (character).

title

Indicator title (character).

See Also

Other Dashboard Deutschland: dashboard_deutschland_geo(), dashboard_deutschland_get()

Examples

## Not run: 
dashboard_deutschland_indicators("tile_1667811574092")

## End(Not run)

List DDB institution sectors

Description

List DDB institution sectors

Usage

ddb_institution_sectors(safe = TRUE, refresh = FALSE)

Arguments

Details

Returns institution sector metadata. Requires the DDB API key.

Value

A tibble with one row per sector and columns:

value

Character. Sector name.

count

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.

See Also

Other DDB: ddb_institutions(), ddb_search()

Examples

## Not run: 
ddb_institution_sectors()

## End(Not run)

List DDB institutions

Description

List DDB institutions

Usage

ddb_institutions(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

Returns institutions registered in the DDB. Requires the DDB API key.

Value

A tibble with one row per institution and columns:

id

Character. Institution identifier.

label

Character. Display name.

latitude

Numeric. Geographic latitude.

longitude

Numeric. Geographic longitude.

sector

Character. Cultural sector code.

children

List. Nested child institutions.

Falls back to a one-row tibble with list-column response when the API returns a non-homogeneous payload.

See Also

bunddev_parameters() to inspect available query parameters.

Other DDB: ddb_institution_sectors(), ddb_search()

Examples

## Not run: 
ddb_institutions(params = list(hasItems = TRUE))

## End(Not run)

Search Deutsche Digitale Bibliothek

Description

Search Deutsche Digitale Bibliothek

Usage

ddb_search(
  query,
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

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.

Value

A one-row tibble with one list-column:

response

Full parsed DDB search payload (list-column).

See Also

bunddev_parameters() to inspect available query parameters. bunddev_auth_set() to configure authentication.

Other DDB: ddb_institution_sectors(), ddb_institutions()

Examples

## 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

Description

List Destatis cubes

Usage

destatis_catalogue_cubes(
  params = list(),
  username = "GAST",
  password = "GAST",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns the cube catalogue from the Destatis Genesis API. API documentation: https://github.com/bundesAPI/destatis-api.

Value

A one-row tibble with one list-column response containing the parsed catalogue payload.

response

Catalogue endpoints: full API payload as list-column.

name

Data endpoints: requested table/cube name (character).

data

Data endpoints: full payload as list-column.

See Also

bunddev_parameters() to inspect available query parameters.

Other Destatis: destatis_catalogue_tables(), destatis_data_cube(), destatis_data_table()

Examples

## Not run: 
destatis_catalogue_cubes()

## End(Not run)

List Destatis tables

Description

List Destatis tables

Usage

destatis_catalogue_tables(
  params = list(),
  username = "GAST",
  password = "GAST",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns the table catalogue from the Destatis Genesis API. API documentation: https://github.com/bundesAPI/destatis-api.

Value

A one-row tibble with one list-column response containing the parsed catalogue payload.

response

Catalogue endpoints: full API payload as list-column.

name

Data endpoints: requested table/cube name (character).

data

Data endpoints: full payload as list-column.

See Also

bunddev_parameters() to inspect available query parameters.

Other Destatis: destatis_catalogue_cubes(), destatis_data_cube(), destatis_data_table()

Examples

## Not run: 
destatis_catalogue_tables()

## End(Not run)

Retrieve Destatis cube data

Description

Retrieve Destatis cube data

Usage

destatis_data_cube(
  name,
  params = list(),
  username = "GAST",
  password = "GAST",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns cube data as text (csv by default). API documentation: https://github.com/bundesAPI/destatis-api.

Value

A one-row tibble with:

name

Requested cube id (character).

data

Raw response body (typically CSV/text) (character).

See Also

bunddev_parameters() to inspect available query parameters.

Other Destatis: destatis_catalogue_cubes(), destatis_catalogue_tables(), destatis_data_table()

Examples

## Not run: 
destatis_data_cube("21231BJ001")

## End(Not run)

Retrieve Destatis table data

Description

Retrieve Destatis table data

Usage

destatis_data_table(
  name,
  params = list(),
  username = "GAST",
  password = "GAST",
  safe = TRUE,
  refresh = FALSE
)

Arguments

Details

Returns table data as text (csv by default). API documentation: https://github.com/bundesAPI/destatis-api.

Value

A one-row tibble with:

name

Requested table id (character).

data

Raw response body (typically CSV/text) (character).

See Also

bunddev_parameters() to inspect available query parameters.

Other Destatis: destatis_catalogue_cubes(), destatis_catalogue_tables(), destatis_data_cube()

Examples

## Not run: 
destatis_data_table("12411-0001")

## End(Not run)

Query Deutschlandatlas indicators

Description

Query Deutschlandatlas indicators

Usage

deutschlandatlas_query(
  table = "p_apo_f_ZA2022",
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Details

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.

Value

A tibble with one row per ArcGIS feature. Attribute names are normalized to lower snake_case. Includes a geometry list-column.

Attribute columns

One column per ArcGIS attributes field (sanitized to snake_case).

geometry

Geometry object as list-column when requested/available.

See Also

bunddev_parameters() to inspect available query parameters.

Examples

## 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

Description

List DiGA catalog entries

Usage

diga_catalog_entries(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per catalog entry and columns:

resourceType

Character. FHIR resource type, always "CatalogEntry".

id

Character. FHIR resource identifier.

status

Character. Entry status.

orderable

Logical. Whether the entry is orderable.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

type

List. Catalog entry type coding.

referencedItem

List. Referenced device definition.

extension

List. FHIR profile extensions.

additionalCharacteristic

List. Additional characteristics.

See Also

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

Description

List DiGA prescription units

Usage

diga_charge_item_definitions(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per charge item definition and columns:

resourceType

Character. FHIR resource type, always "ChargeItemDefinition".

id

Character. FHIR resource identifier.

url

Character. Canonical URL of the resource.

status

Character. Publication status.

description

Character. Description text.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

code

List. Charge item code.

instance

List. Referenced device definitions.

applicability

List. Applicability conditions.

propertyGroup

List. Pricing properties.

extension

List. FHIR profile extensions.

See Also

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

Description

List DiGA device definitions

Usage

diga_device_definitions(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per device definition and columns:

resourceType

Character. FHIR resource type, always "DeviceDefinition".

id

Character. FHIR resource identifier.

url

Character. Canonical URL of the resource.

status

Character. Publication status.

description

Character. Device description text.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

type

List. Device type coding.

deviceName

List. Device name entries.

property

List. Device properties.

extension

List. FHIR profile extensions.

See Also

Other DiGA: diga_catalog_entries(), diga_charge_item_definitions(), diga_organizations(), diga_questionnaire_responses(), diga_questionnaires()

Examples

## Not run: dig_device_definitions()

List DiGA manufacturers

Description

List DiGA manufacturers

Usage

diga_organizations(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per organization and columns:

resourceType

Character. FHIR resource type, always "Organization".

id

Character. FHIR resource identifier.

name

Character. Organization display name.

active

Logical. Whether the organization is active.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

type

List. Organization type coding.

telecom

List. Contact details.

address

List. Postal addresses.

extension

List. FHIR profile extensions.

See Also

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

Description

List DiGA questionnaire responses

Usage

diga_questionnaire_responses(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per questionnaire response and columns:

resourceType

Character. FHIR resource type, always "QuestionnaireResponse".

id

Character. FHIR resource identifier.

status

Character. Response completion status.

authored

Character. When the response was authored.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

questionnaire

Character. Reference to source questionnaire.

item

List. Response items and answers.

extension

List. FHIR profile extensions.

See Also

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

Description

List DiGA questionnaires

Usage

diga_questionnaires(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per questionnaire and columns:

resourceType

Character. FHIR resource type, always "Questionnaire".

id

Character. FHIR resource identifier.

url

Character. Canonical URL of the resource.

status

Character. Publication status.

name

Character. Computer-friendly name.

title

Character. Human-readable title.

meta

List. Resource metadata (profile, timestamps).

identifier

List. Business identifiers.

item

List. Questionnaire items and groups.

extension

List. FHIR profile extensions.

See Also

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

Description

Get a DIP Aktivität

Usage

dip_bundestag_aktivitaet(
  aktivitaet_id,
  params = list(),
  safe = TRUE,
  refresh = FALSE
)

Arguments

Value

A one-row tibble for the selected Aktivitaet:

id

Aktivitaet identifier (character).

aktivitaetsart

Activity type, e.g. "Rede" (character).

typ

Entity type, always "Aktivität" (character).

dokumentart

Document type: "Drucksache" or "Plenarprotokoll" (character).

wahlperiode

Legislative period (integer).

datum

Date of associated document (character, ISO date).

aktualisiert

Last update timestamp (character, ISO datetime).

titel

Title (character).

fundstelle

Document reference details (list-column).

vorgangsbezug

Up to 4 related Vorgänge (list-column).

vorgangsbezug_anzahl

Total number of related Vorgänge (integer).

deskriptor

Thesaurus descriptors (list-column).

abstract

Summary text (character or NA).

See Also

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()

Examples

## Not run: 
dip_bundestag_aktivitaet(1493545)

## End(Not run)

List DIP Aktivitäten

Description

List DIP Aktivitäten

Usage

dip_bundestag_aktivitaet_list(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

Value

A tibble with one row per Aktivitaet and columns:

id

Character. Unique Aktivitaet identifier.

aktivitaetsart

Character. Activity type.

typ

Character. Entity type, always "Aktivitaet".

dokumentart

Character. Document type.

wahlperiode

Integer. Legislative period.

datum

Character. Date of associated document.

aktualisiert

Character. Last update timestamp.

titel

Character. Title text.

vorgangsbezug_anzahl

Integer. Total related Vorgaenge.

abstract

Character. Summary text.

fundstelle

List. Document reference details.

vorgangsbezug

List. Related Vorgaenge.

deskriptor

List. Thesaurus descriptor entries.

Wrapped in a one-row tibble with num_found (integer), cursor (character), and documents (list-column) when not yet unpacked.

See Also

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()

Examples

## Not run: 
dip_bundestag_aktivitaet_list()

## End(Not run)

Get a DIP Drucksache

Description

Get a DIP Drucksache

Usage

dip_bundestag_drucksache(
  drucksache_id,
  params = list(),
  safe = TRUE,
  refresh = FALSE
)

Arguments

Value

A one-row tibble for the selected Drucksache:

id

Drucksache identifier (character).

typ

Entity type, always "Dokument" (character).

dokumentart

Document type, always "Drucksache" (character).

drucksachetyp

Drucksache subtype, e.g. "Antrag" (character).

dokumentnummer

Document number, e.g. "19/1" (character).

wahlperiode

Legislative period (integer).

herausgeber

Publisher: "BT" or "BR" (character).

datum

Publication date (character, ISO date).

aktualisiert

Last update timestamp (character, ISO datetime).

titel

Title (character).

autoren_anzeige

Up to 4 authors for display (list-column).

autoren_anzahl

Total author count (integer).

fundstelle

Document reference details (list-column).

pdf_hash

MD5 checksum of the PDF file (character or NA).

urheber

Authoring bodies (list-column).

vorgangsbezug

Up to 4 related Vorgänge (list-column).

vorgangsbezug_anzahl

Total number of related Vorgänge (integer).

ressort

Government departments involved (list-column).

anlagen

Appendix description (character or NA).

See Also

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()

Examples

## Not run: 
dip_bundestag_drucksache(68852)

## End(Not run)

List DIP Drucksachen

Description

List DIP Drucksachen

Usage

dip_bundestag_drucksache_list(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments