The R package bonn
provides functions to retrieve data from the INKAR database maintained by the Federal Office for Building and Regional Planning (BBSR) in Bonn. The package uses an undocumented JSON API.
Installation
You can install the package from Github using:
remotes::install_github("sumtxt/bonn", force=TRUE)
Usage
The main data-retrieving function is get_data()
. It requires to specify which variable to retrieve and for which geography. By default this function retrieves the data for all available time points and for all available units of a named geography.
For a list of available geographies (municipalities, disricts etc.), call get_geographies()
. Then use get_themes()
with the appropriate geography identifier to obtain a list of themes for which variables are available. Then call get_variables()
for a list of available variables. Not all variables are available for every geography. Use the variable and geography identifier to call get_data()
. To obtain a detailed description of a variable, call get_metadata
.
List available themes for districts (Kreise):
head( get_themes(geography="KRE") )
#> ID Bereich Unterbereich
#> 1 000 Absolutzahlen Absolutzahlen
#> 2 011 Arbeitslosigkeit Allgemein
#> 3 013 Arbeitslosigkeit Altersgruppen
#> 4 012 Arbeitslosigkeit Struktur
#> 5 021 Bauen und Wohnen Baulandmarkt und Bautätigkeit
#> 6 022 Bauen und Wohnen Gebäude- und Wohnungsbestand
Indicators for theme “unemployment”:
head( get_variables(theme="011", geography="KRE") )
#> KurznamePlus Bereich Gruppe BU EU Zeitreihe
#> 1 Arbeitslosenquote 011 12 KRE 24
#> 2 Arbeitslosenquote Frauen 011 13 KRE 15
#> 3 Arbeitslosenquote Männer 011 14 KRE 15
#> 4 Arbeitslose Frauen 011 15 KRE 28
#> 5 Arbeitslose Männer 011 16 KRE 28
Retrieve data and metadata on the unemployment variable:
head( get_data(variable='12', geography="KRE") )
#> Schlüssel Raumbezug Indikator Wert Zeit
#> 1 01001 KRE 12 14.60 1998
#> 2 12065 KRE 12 17.06 1998
#> 3 09271 KRE 12 7.32 1998
#> 4 03402 KRE 12 14.88 1998
#> 5 11000 KRE 12 16.10 1998
#> 6 07143 KRE 12 7.38 1998
The SSL vertification seems to fail for some Linux systems. To disable SSL verification check for a session, use:
httr::set_config(httr::config(ssl_verifypeer = 0L))
head( get_themes(geography="KRE") )
#> ID Bereich Unterbereich
#> 1 000 Absolutzahlen Absolutzahlen
#> 2 011 Arbeitslosigkeit Allgemein
#> 3 013 Arbeitslosigkeit Altersgruppen
#> 4 012 Arbeitslosigkeit Struktur
#> 5 021 Bauen und Wohnen Baulandmarkt und Bautätigkeit
#> 6 022 Bauen und Wohnen Gebäude- und Wohnungsbestand
httr::reset_config()
Notes
- User reports suggest that some IDs of the database are not necessarily stable over time (see https://github.com/sumtxt/bonn/issues/1).
Complementary Packages
The R package
wiesbaden
github.com/sumtxt/wiesbaden provides functions to directly retrieve data from databases maintained by the Federal Statistical Office of Germany (DESTATIS) in WiesbadenThe R package AGS github.com/sumtxt/ags provides functions to work with the Amtlicher Gemeindeschlüssel (AGS), e.g. construct time series of statistics for Germany’s municipalities and districts.