Package 'oenb'

Title: Tools for the OeNB Data Web Service
Description: Tools to access data from the data web service of the Oesterreichische Nationalbank (OeNB), <https://www.oenb.at/en/Statistics/User-Defined-Tables/webservice.html>.
Authors: Franz X. Mohr [aut, cre] (ORCID: <https://orcid.org/0009-0003-8890-7781>)
Maintainer: Franz X. Mohr <[email protected]>
License: GPL (>= 2)
Version: 0.1.1
Built: 2026-10-03 21:39:56 UTC
Source: https://github.com/franzmohr/oenb

Help Index

Get Attributes

Description

Get potential attributes of individual series from the OeNB's data web service.

Usage

oenb_attributes(id, pos, lang = "EN")

Arguments

id

character specifying the ID of the dataset of interest. See oenb_toc to obtain the required ID.
pos

character specifying the position ID of the indicator of interest. See oenb_dataset to obtain the required ID.
lang

Preferred language of the output. Possible values are "DE" for German and "EN" for English (default).

Value

A data frame with one row per available value of an attribute and the columns

attribute_code

the code of the attribute, such as "dval1". It is a name of the attr argument of oenb_data.

attribute

the description of the attribute.

value_code

the code of the value, such as "AT". It is a value of the attr argument of oenb_data.

value

the description of the value.

Each value of an attribute is listed once. A data frame without rows is returned if no attributes are found. NULL is returned if the web service is not available. See oenb for the workflow and the conditions that are signalled.

Examples

series_attr <- oenb_attributes(id = "11", pos = "VDBFKBSC217000")
series_attr

Download OeNB Data

Description

Download data sets from the OeNB's data web service https://www.oenb.at/en/Statistics/User-Defined-Tables/webservice.html.

Usage

oenb_data(
  id,
  pos,
  freq = NULL,
  attr = NULL,
  starttime = NULL,
  endtime = NULL,
  lang = "EN"
)

Arguments

id

character specifying the ID of the dataset of interest. See oenb_toc to obtain the required ID.
pos

character vector specifying the position IDs of the indicators of interest. See oenb_dataset to obtain the required ID.
freq

Frequency of the data. Where available, possible values are "D", "M", "Q", "H", "A" for daily, monthly, quarterly, semi-annual and annual data. See oenb_frequency to obtain possible choices.
attr

A named vector of further attributes. See oenb_attributes to obtain possible choices.
starttime

character specifying the start of the series. See 'Details'.
endtime

character specifying the end of the series. See 'Details'.
lang

Preferred language of the output. Possible values are "DE" for German and "EN" for English (default).

Details

The arguments 'starttime' and 'endtime' can have the format 'YYYY-MM-DD' or 'YYYYMMDD' for daily data, 'YYYY-MM' or 'YYYYMM' for monthly data, and 'YYYY' for annual data. For semiannual data 'YYYY-06' refers to the first half of year 'YYYY' and 'YYYY-12' to the second. Similarly, for quarterly data 'YYYY-03', 'YYYY-06', 'YYYY-09' and 'YYYY-12' refer to the first, second, third and forth quarter of year 'YYYY', respectively.

Value

A data frame with one row per observation. The columns are those that the web service reports, typically

period

the period of the observation, such as "2019-11".

pos, postitle

the position code and the title of the series.

attr1, attr1dim, attr2, ...

the value of each attribute and the name of that attribute. attrN corresponds to the attribute dvalN of oenb_attributes. Series with several values of an attribute have one row per value and period.

freq

the frequency of the observation.

unitmult, unittext

the unit of the values, for example "6" and "in millions Euro".

value

the numeric value, in the unit reported in unittext. It is not rescaled.

period is always the first column and value the last. NULL is returned if the query does not return any data or if the web service is not available. See oenb for the workflow and the conditions that are signalled.

Examples

series <- oenb_data(id = "11", pos = "VDBFKBSC217000", freq = "M", attr = c("dval1" = "AT"),
                    starttime = "2019-11", endtime = "2019-12")
series

Content of OeNB Data Sets

Description

Downloads a description of the contents of a specific dataset from the OeNB's data web service.

Usage

oenb_dataset(id, lang = "EN")

Arguments

id

character specifying the ID of the dataset of interest. See oenb_toc to obtain the required ID.
lang

Preferred language of the output. Possible values are "DE" for German and "EN" for English (default).

Value

A data frame with one row per series of the data set and the columns

position_code

the position code of the series, which is the pos argument of the other functions.

description

the title of the series.

A data frame without rows is returned if the data set contains no series. NULL is returned if the web service is not available. See oenb for the workflow and the conditions that are signalled.

Examples

content <- oenb_dataset(id = "11")
content

Get Frequency

Description

Get available frequencies and periods of individual series from the OeNB's data web service.

Usage

oenb_frequency(id, pos, lang = "EN")

Arguments

id

character specifying the ID of the dataset of interest. See oenb_toc to obtain the required ID.
pos

character specifying the position ID of the indicator of interest. See oenb_dataset to obtain the required ID.
lang

Preferred language of the output. Possible values are "DE" for German and "EN" for English (default).

Value

A data frame with the columns

frequency

the code of a frequency, such as "M". It is a value of the freq argument of oenb_data.

available_period

the period for which data are available, as the web service describes it, for example "1998 - 2025".

Each combination of a frequency and a period is listed once. A data frame without rows is returned if no frequencies are found. NULL is returned if the web service is not available. See oenb for the workflow and the conditions that are signalled.

Examples

series_freq <- oenb_frequency(id = "11", pos = "VDBFKBSC217000")
series_freq

Get Metadata

Description

Get metadata on individual series from the OeNB's data web service.

Usage

oenb_metadata(id, pos, lang = "EN")

Arguments

id

character specifying the ID of the dataset of interest. See oenb_toc to obtain the required ID.
pos

character specifying the position ID of the indicator of interest. See oenb_dataset to obtain the required ID.
lang

Preferred language of the output. Possible values are "DE" for German and "EN" for English (default).

Value

A data frame with one row per field of the metadata and the columns

attribute

the name of the field, for example "title", "unit", "source" or "last_update".

description

the content of the field.

The fields are those that the web service reports for the series. Fields that contain further fields are not included. A data frame without rows is returned if no metadata are found. NULL is returned if the web service is not available. See oenb for the workflow and the conditions that are signalled.

Examples

meta <- oenb_metadata(id = "11", pos = "VDBFKBSC217000")
meta

Table of Contents

Description

Downloads the table of contents of the OeNB's statistical data web service.

Usage

oenb_toc(lang = "EN")

Arguments

lang

Preferred language of the output. Possible values are "DE" for German and "EN" for English (default).

Value

A data frame with one row per data set and the columns

dataset_id

the ID of the data set, which is the id argument of the other functions.

description

the title of the data set.

NULL is returned if the web service is not available. See oenb for the workflow and the conditions that are signalled.

Examples

toc <- oenb_toc()
toc