
<!-- README.md is generated from README.Rmd. Please edit that file -->

# bbk

<!-- badges: start -->

[![R-CMD-check](https://github.com/m-muecke/bbk/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/m-muecke/bbk/actions/workflows/R-CMD-check.yaml)
[![CRAN
status](https://www.r-pkg.org/badges/version/bbk)](https://CRAN.R-project.org/package=bbk)
[![R-universe
version](https://m-muecke.r-universe.dev/bbk/badges/version)](https://m-muecke.r-universe.dev/bbk)
<!-- badges: end -->

bbk is minimal R client for the following APIs:

- [Banco de España
  (BdE)](https://www.bde.es/webbe/en/estadisticas/recursos/api-estadisticas-bde.html)
- [Banco de Portugal (BdP)](https://bpstat.bportugal.pt/data/docs)
- [Bank for International Settlements
  (BIS)](https://stats.bis.org/api-doc/v1/)
- [Bank of Canada
  (BoC)](https://www.bankofcanada.ca/valet-api-how-to/#about)
- [Bank of England
  (BoE)](https://www.bankofengland.co.uk/boeapps/database)
- [Bank of Japan
  (BoJ)](https://www.stat-search.boj.or.jp/index_en.html)
- [Banque de France
  (BdF)](https://webstat.banque-france.fr/en/pages/guide-migration-api/)
- [Deutsche Bundesbank
  (BBk)](https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service)
- [European Central Bank
  (ECB)](https://data.ecb.europa.eu/help/api/overview)
- [National Bank of Poland (NBP)](https://api.nbp.pl/en.html)
- [Norges Bank
  (NoB)](https://www.norges-bank.no/en/topics/Statistics/open-data/)
- [Sveriges Riksbank (SRb)](https://developer.api.riksbank.se/)
- [Swiss National Bank (SNB)](https://data.snb.ch/en)
- [Österreichische Nationalbank
  (OeNB)](https://www.oenb.at/en/Statistics/User-Defined-Tables/webservice.html)

> In the future, it may be extended to other central banks and financial
> institutions. Feel free to open an issue if you have a specific
> request.

## Installation

You can install the released version of bbk from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("bbk")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("m-muecke/bbk")
```

## Usage

bbk functions are prefixed according to the central bank they access
(`bbk_`, `ecb_`, `snb_`, `bdp_`, `bis_`, `boe_`, `boj_`, `bde_`, `bdf_`,
`nbp_`, `onb_`, `boc_`, `nob_`, `srb_`) and follow the naming
conventions of their respective APIs.

The typical workflow involves:

1.  Finding the time series identifier on the relevant central bank’s
    website
2.  Using the appropriate bbk function to retrieve the data

``` r
library(bbk)

# Deutsche Bundesbank - fetch 10 year daily yield curve
yield_curve <- bbk_data(
  flow = "BBSIS",
  key = "D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A",
  start_period = "2020-01-01"
)
```

<img src="man/figures/README-plotting-1.png" alt="" width="100%" />

## Related work

- [BIS](https://github.com/stefanangrick/BIS): R package for downloading
  data from the Bank for International Settlements (BIS).
- [BISdata](https://github.com/enricoschumann/BISdata): R package for
  downloading data from the Bank for International Settlements (BIS).
- [boe](https://github.com/charlescoverdale/boe): R package for
  downloading data from the Bank of England (BoE).
- [BOJ](https://github.com/stefanangrick/BOJ): R package for downloading
  data from the Bank of Japan (BoJ).
- [SNBdata](https://github.com/enricoschumann/SNBdata): R package for
  downloading data from the Swiss National Bank (SNB).
- [bundesbank](https://github.com/enricoschumann/bundesbank): R scripts
  for downloading time-series data from the Bundesbank.
- [ecb](https://github.com/expersso/ecb): R interface to the European
  Central Bank’s Statistical Data Warehouse (SDW) API.
- [oenb](https://github.com/franzmohr/oenb): R package for accessing the
  OeNB’s API.
- [pdfetch](https://github.com/abielr/pdfetch): R package for
  downloading economic and financial time series from public sources.
- [rnbp](https://github.com/szymanskir/rnbp): R package for accessing
  the National Bank of Poland (NBP) API.
- [readsdmx](https://github.com/mdequeljoe/readsdmx): R package for
  reading SDMX data and metadata.
- [rsdmx](https://github.com/eblondel/rsdmx): R package for reading SDMX
  data and metadata.
- [rwebstat](https://github.com/cran/rwebstat): R package for accessing
  the Banque de France’s Webstat API.
- [tidyBdE](https://github.com/rOpenSpain/tidyBdE): R package for
  accessing the Banco de España’s API.
- [valet](https://github.com/runkelcorey/valet): R client to the Bank of
  Canada Valet API.
