Package 'bbk'

Description

Retrieve time series data from the Banco de México Sistema de Información Económica (SIE) API.

Usage

banxico_data(
  series,
  start_date = NULL,
  end_date = NULL,
  api_key = banxico_key()
)

Arguments

Details

The SIE API requires a free access token. Request one at https://www.banxico.org.mx/SieAPIRest/service/v1/token and supply it via the api_key argument or the BANXICO_KEY environment variable.

Supply both start_date and end_date to restrict the period, or neither to return the complete history of each series. Supplying only one is an error.

Value

A data.table::data.table() with columns date, key, and value.

Source

https://www.banxico.org.mx/SieAPIRest/service/v1/

See Also

Other data: bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch the FIX peso/US dollar exchange rate
banxico_data("SF43718", start_date = "2024-01-01", end_date = "2024-01-31")

# fetch multiple series at once
banxico_data(c("SF43718", "SF60653"), start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve series metadata from the Banco de México Sistema de Información Económica (SIE) API.

Usage

banxico_metadata(series, api_key = banxico_key())

Arguments

Value

A data.table::data.table() with columns id, title, freq, unit, start, and end.

Source

https://www.banxico.org.mx/SieAPIRest/service/v1/

See Also

Other metadata: bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

banxico_metadata("SF43718")

Description

Retrieve time series data from the Bundesbank SDMX Web Service.

Usage

bbk_data(
  flow,
  key = NULL,
  start_period = NULL,
  end_period = NULL,
  first_n = NULL,
  last_n = NULL,
  updated_after = NULL
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-data

See Also

Other data: banxico_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch all data for a given flow and key
data = bbk_data("BBSIS", "D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A")
head(data)

# fetch data for multiple keys
data = bbk_data("BBEX3", c("M.ISK.EUR", "USD.CA.AC.A01"))
head(data)

# specified period (start date-end date) for daily data
data = bbk_data(
  "BBSIS", "D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A",
  start_period = "2020-01-01",
  end_period = "2020-08-01"
)
head(data)

# or only specify the start date
data = bbk_data(
  "BBSIS", "D.I.ZAR.ZI.EUR.S1311.B.A604.R10XX.R.A.A._Z._Z.A",
  start_period = "2024-04-01"
)
head(data)

Description

Retrieve the dimension structure for a given dataflow from the Bundesbank SDMX Web Service.

Usage

bbk_dimension(id)

Arguments

Value

A data.table::data.table() with columns:

Source

https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata

See Also

Other metadata: banxico_metadata(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bbk_dimension("BBK_ERX")

Description

Retrieve metadata from the Bundesbank time series database via the SDMX Web Service.

Usage

bbk_metadata(type, id = NULL, lang = "en")

Arguments

Value

A data.table::data.table() with the requested metadata. The columns are:

Source

https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-metadata

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bbk_metadata("datastructure")
bbk_metadata("dataflow", "BBSIS")
bbk_metadata("codelist", "CL_BBK_ACIP_ASSET_LIABILITY")
bbk_metadata("concept", "CS_BBK_BSPL")

Description

Retrieve a single series by its key via the Bundesbank SDMX Web Service.

Usage

bbk_series(key)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.bundesbank.de/en/statistics/time-series-databases/help-for-sdmx-web-service/web-service-interface-data

See Also

bbk_data() for an endpoint with more options.

Other data: banxico_data(), bbk_data(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

bbk_series("BBEX3.M.DKK.EUR.BB.AC.A01")
bbk_series("BBAF3.Q.F41.S121.DE.S1.W0.LE.N._X.B")
bbk_series("BBBK11.D.TTA000")

Description

Retrieve the list of currencies available from the Banco Central do Brasil PTAX API.

Usage

bcb_currencies()

Value

A data.table::data.table() with columns code, name, and type.

Source

https://dadosabertos.bcb.gov.br/

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bcb_currencies()

Description

Retrieve time series data from the Banco Central do Brasil SGS (Sistema Gerenciador de Séries Temporais) API.

Usage

bcb_data(series, start_date = NULL, end_date = NULL)

Arguments

Details

Daily series require a date range and the API limits the query window to at most 10 years; supply start_date (and optionally end_date) when querying such series.

Value

A data.table::data.table() with the requested data.

Source

https://dadosabertos.bcb.gov.br/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch USD/BRL exchange rate
bcb_data(1, start_date = "2024-01-01", end_date = "2024-01-31")

# fetch the Selic target rate
bcb_data(432, start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve market expectations from the Banco Central do Brasil Focus survey (Relatório Focus) via the Olinda API. Each row is the summary of survey responses collected on a given date for a future reference period.

Usage

bcb_expectations(
  type = "annual",
  indicator = NULL,
  start_date = NULL,
  end_date = NULL
)

Arguments

Details

Querying without a filter returns the full history, which is large; supplying indicator and/or a date range is recommended.

Value

A data.table::data.table() with columns date, indicator, detail, reference, mean, median, sd, min, max, respondents, and base.

Source

https://dadosabertos.bcb.gov.br/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# annual IPCA inflation expectations
bcb_expectations("annual", "IPCA", start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve PTAX foreign exchange reference rates from the Banco Central do Brasil Olinda API. The rates are the closing (Fechamento) bid and ask quotations expressed in Brazilian real (BRL) per unit of the foreign currency.

Usage

bcb_fx_rates(currency, start_date, end_date = NULL)

Arguments

Details

Rates are published only on business days, so weekends and holidays return no rows.

Value

A data.table::data.table() with columns date, currency, bid, and ask.

Source

https://dadosabertos.bcb.gov.br/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch USD/BRL closing rates
bcb_fx_rates("USD", start_date = "2024-01-01", end_date = "2024-01-31")

# fetch multiple currencies
bcb_fx_rates(c("USD", "EUR"), start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve the rolling 12- or 24-month inflation expectations from the Banco Central do Brasil Focus survey (Relatório Focus) via the Olinda API.

Usage

bcb_inflation(
  horizon = "12m",
  indicator = NULL,
  start_date = NULL,
  end_date = NULL
)

Arguments

Value

A data.table::data.table() with columns date, indicator, smoothed, mean, median, sd, min, max, respondents, and base. The smoothed column indicates whether the forecast is the smoothed (suavizada) series.

Source

https://dadosabertos.bcb.gov.br/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# next-12-months IPCA inflation expectations
bcb_inflation("12m", "IPCA", start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve market expectations for the Selic target rate from the Banco Central do Brasil Focus survey (Relatório Focus) via the Olinda API. Each row summarises the forecasts collected on a given survey date for a future COPOM meeting.

Usage

bcb_selic(start_date = NULL, end_date = NULL)

Arguments

Value

A data.table::data.table() with columns date, meeting, mean, median, sd, min, max, respondents, and base. The meeting column identifies the COPOM meeting the forecast refers to (e.g. "R3/2028").

Source

https://dadosabertos.bcb.gov.br/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

bcb_selic(start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve the Top-5 market expectations from the Banco Central do Brasil Focus survey (Relatório Focus) via the Olinda API. The Top-5 ranking summarises the forecasts of the institutions with the most accurate projections for a given indicator.

Usage

bcb_top5(type = "annual", indicator = NULL, start_date = NULL, end_date = NULL)

Arguments

Value

A data.table::data.table() with columns date, indicator, type_calc, reference, mean, median, sd, min, and max. The type_calc column holds the ranking horizon ("C" short, "M" medium, or "L" long term). For type = "selic" the reference column holds the COPOM meeting (e.g. "R4/2026").

Source

https://dadosabertos.bcb.gov.br/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# annual Top-5 IPCA inflation expectations
bcb_top5("annual", "IPCA", start_date = "2024-01-01", end_date = "2024-01-31")

# Top-5 Selic target rate expectations
bcb_top5("selic", start_date = "2024-01-01", end_date = "2024-01-31")

Description

Retrieve time series data from the BdE statistics API.

Usage

bde_data(key, time_range = NULL, lang = "en")

Arguments

Details

You can search for the series codes in the BIEST application or in the tables published by the Banco de España.

Value

A data.table::data.table() with the requested data.

Source

https://www.bde.es/webbe/en/estadisticas/recursos/api-estadisticas-bde.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

bde_data("D_1NBAF472", time_range = "30M")
bde_data(c("DTNPDE2010_P0000P_PS_APU", "DTNSEC2010_S0000P_APU_SUMAMOVIL"), time_range = "MAX")
bde_data("DEEQ.N.ES.W1.S1.S1.T.B.G._Z._Z._Z.EUR._T._X.N.ALL", time_range = 2024)

Description

Retrieve the most recently published value for one or more series from the BdE statistics API.

Usage

bde_latest(key, lang = "en")

Arguments

Value

A data.table::data.table() with the latest observation per series.

Source

https://www.bde.es/webbe/en/estadisticas/recursos/api-estadisticas-bde.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

bde_latest("D_1NBAF472")
bde_latest(c("D_1NBAF472", "DTNPDE2010_P0000P_PS_APU"))

Description

Fetch Banque de France (BdF) codelists

Usage

bdf_codelist(..., lang = "en")

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://webstat.banque-france.fr/en/pages/guide-migration-api/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

## Not run: 
bdf_codelist()

# filter for a specific codelist
bdf_codelist(where = "codelist_id = 'CL_FREQ'")

## End(Not run)

Description

Retrieve time series data from the BdF Webstat API.

Usage

bdf_data(
  ...,
  key = NULL,
  start_date = NULL,
  end_date = NULL,
  lang = "en",
  api_key = bdf_key()
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://webstat.banque-france.fr/en/pages/guide-migration-api/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

## Not run: 
bdf_data(key = "CONJ2.M.R24.T.SM.0RG24.EFTPM100.10")

# inflation rate
bdf_data(key = "ICP.M.FR.N.000000.4.ANR")

# or with a date filter
bdf_data(key = "ICP.M.FR.N.000000.4.ANR", start_date = "2025-01-01", end_date = "2025-06-30")

# advanced filter with where clause
bdf_data(key = "ICP.M.FR.N.000000.4.ANR", where = "time_period_start >= date'2025-01-01'")

## End(Not run)

Description

Fetch Banque de France (BdF) datasets

Usage

bdf_dataset(..., lang = "en")

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://webstat.banque-france.fr/en/pages/guide-migration-api/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

## Not run: 
bdf_dataset()

# structure of a dataset
bdf_dataset(where = "dataset_id = 'CONJ2'")

## End(Not run)

Description

Retrieve the dimension structure for a given dataset from the BdF Webstat API.

Usage

bdf_dimension(dataset_id, lang = "en", api_key = bdf_key())

Arguments

Value

A data.table::data.table() with columns:

Source

https://webstat.banque-france.fr/en/pages/guide-migration-api/

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

## Not run: 
bdf_dimension("CONJ2")

## End(Not run)

Description

Retrieve time series data from the BPstat API.

Usage

bdp_data(
  domain_id,
  dataset_id,
  series_ids = NULL,
  start_date = NULL,
  end_date = NULL,
  last_n = NULL,
  updated_after = NULL,
  lang = "en"
)

Arguments

Details

The BPstat API uses a two-step workflow: first look up the series metadata with bdp_series() to find the domain_id and dataset_id, then use those to fetch the actual observations.

You can browse available series at the BPstat portal.

Value

A data.table::data.table() with the requested data.

Source

https://bpstat.bportugal.pt/data/docs

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# Portuguese GDP (annual, current prices)
bdp_data(54L, "ce3e4e50cda325537eff729ef64037cd", series_ids = 12518356L)

Description

Retrieve the list of datasets for a given domain from the BPstat API.

Usage

bdp_dataset(domain_id, lang = "en")

Arguments

Value

A data.table::data.table() with available datasets.

Source

https://bpstat.bportugal.pt/data/docs

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bdp_dataset(54L)

Description

Retrieve the list of dimensions for a given domain, or the categories within a single dimension.

Usage

bdp_dimension(domain_id, dimension_id = NULL, lang = "en")

Arguments

Value

A data.table::data.table() with dimensions or categories.

Source

https://bpstat.bportugal.pt/data/docs

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bdp_dimension(54L)

Description

Retrieve the list of available statistical domains from the BPstat API, or details for a single domain.

Usage

bdp_domain(domain_id = NULL, lang = "en")

Arguments

Value

A data.table::data.table() with available domains.

Source

https://bpstat.bportugal.pt/data/docs

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bdp_domain()

Description

Retrieve metadata for one or more series from the BPstat API. This is useful to discover the domain_id and dataset_id needed for bdp_data().

Usage

bdp_series(series_ids, lang = "en")

Arguments

Value

A data.table::data.table() with series metadata including domain_id and dataset_id.

Source

https://bpstat.bportugal.pt/data/docs

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bdp_series(12518356L)

Description

Retrieve time series data from the BIS SDMX Web Service.

Usage

bis_data(
  flow,
  key = NULL,
  start_period = NULL,
  end_period = NULL,
  first_n = NULL,
  last_n = NULL,
  updated_after = NULL
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://stats.bis.org/api-doc/v1/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch Swiss central bank policy rate
bis_data("WS_CBPOL", "M.CH", last_n = 5L)

# fetch effective exchange rates
bis_data("WS_EER", "M.N.B.CH", start_period = "2020-01")

Description

Retrieve the dimension structure for a given dataflow from the BIS SDMX Web Service.

Usage

bis_dimension(id)

Arguments

Value

A data.table::data.table() with columns:

Source

https://stats.bis.org/api-doc/v1/

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bis_dimension("BIS_CBPOL")

Description

Retrieve metadata from the BIS SDMX Web Service.

Usage

bis_metadata(type, id = NULL)

Arguments

Value

A data.table::data.table() with the requested metadata.

Source

https://stats.bis.org/api-doc/v1/

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

bis_metadata("dataflow")
bis_metadata("datastructure", "BIS_CBPOL")
bis_metadata("codelist", "CL_FREQ")

Description

Access all available series or groups from the Bank of Canada Valet API.

Usage

boc_catalog(type = "groups")

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.bankofcanada.ca/valet/docs

Examples

## Not run: 
catalog = boc_catalog()
head(catalog)

# filter for effective exchange rate series
dt = catalog[grepl("CEER", label)]
head(dt)

## End(Not run)

Description

Retrieve time series data from the Bank of Canada Valet API.

Usage

boc_data(
  group_name = NULL,
  series_name = NULL,
  start_date = NULL,
  end_date = NULL
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.bankofcanada.ca/valet/docs

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

## Not run: 
# fetch all data for a single group
dt = boc_data(group_name = "FX_RATES_DAILY")
head(dt)

# or for multiple series ids
dt = boc_data(
  series_name = c("FXUSDCAD", "FXEURCAD"),
  start_date = "2023-01-23",
  end_date = "2023-07-19"
)
head(dt)

## End(Not run)

Description

Fetch the latest or historical foreign exchange reference rates from the Bank of Canada (BoC).

Usage

boc_fx_rates(start_date = NULL, end_date = NULL, limit = NULL, skip = NULL)

Arguments

Details

The recorded rates indicate the number of Canadian dollars required to buy a single unit of the foreign currency. New rates are released by the Bank of Canada (BoC) daily at 4:30 pm. The Canada Border Services (CBSA) retrieves these updates between 4:30 pm and 5 pm ET.

BoC provides 23 foreign exchange rates. All other rates are maintained by the CBSA.

Exchange rates from the BoC are updated daily in the system while other exchange rates are updated by the CBSA at set intervals. The updated rates are available for retrieval between 7 pm and 11:59 pm ET.

As BoC publishes exchange rates every business day, it is recommended that exchange rate data be retrieved on a daily basis. This retrieval should occur after 7 pm ET to ensure retrieval of the latest updates.

Value

A data.table::data.table() with the exchange rates.

Source

https://www.cbsa-asfc.gc.ca/eservices/api/er-tc-api-eng.html

Examples

# fetch latest exchange rates
boc_fx_rates()

# fetch historical exchange rates
boc_fx_rates(start_date = "2021-10-22", end_date = "2021-10-23", limit = 10, skip = 2)

Description

Fetch Bank of Canada (BoC) metadata (details)

Usage

boc_metadata(group_name = NULL, series_name = NULL)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.bankofcanada.ca/valet/docs

Examples

## Not run: 
boc_metadata(group_name = "FX_RATES_DAILY")
boc_metadata(series_name = "FXUSDCAD")

## End(Not run)

Description

Retrieve time series data from the BoE database.

Usage

boe_data(key, start_date, end_date = Sys.Date())

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.bankofengland.co.uk/boeapps/database

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# Bank Rate
boe_data("IUDBEDR", "2015-01-01")

# SONIA daily rate
boe_data("IUDSOIA", "2015-01-01")

# 10-year nominal par yield
boe_data("IUDMNPY", "2015-01-01")

# multiple series
boe_data(c("IUMABEDR", "IUALBEDR"), "2015-01-01")

Description

Retrieve time series data from the Bank of Japan Statistics API.

Usage

boj_data(db, code, start_date = NULL, end_date = NULL, lang = "en")

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.stat-search.boj.or.jp/index_en.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch USD/JPY exchange rate
boj_data("FM08", "FXERD01", start_date = "202401")

# fetch multiple exchange rates
boj_data("FM08", c("FXERD01", "FXERD02"), start_date = "202401")

Description

Retrieve series metadata from the Bank of Japan Statistics API.

Usage

boj_metadata(db, lang = "en")

Arguments

Value

A data.table::data.table() with the requested metadata.

Source

https://www.stat-search.boj.or.jp/index_en.html

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

boj_metadata("FM08")

Description

bbk_cache_dir() returns the path where cached API responses are stored. bbk_cache_clear() clears all cached responses.

Usage

bbk_cache_dir()

bbk_cache_clear()

Details

The cache is only used when enabled with options(bbk.cache = TRUE). Cached responses are stored for 1 day by default, but this can be customized with options(bbk.cache_max_age = seconds).

Value

bbk_cache_dir() returns a string with the path to the cache directory.

bbk_cache_clear() is called for its side effect of clearing the cached responses and returns NULL invisibly.

Examples

## Not run: 
# enable caching
options(bbk.cache = TRUE)

# view cache location
bbk_cache_dir()

# clear the cache
bbk_cache_clear()

## End(Not run)

Description

Retrieve the Czech Overnight Index Average (CZEONIA) reference rate from the CNB API.

Usage

cnb_czeonia(date = NULL, year = NULL)

Arguments

Value

A data.table::data.table() with the requested rates. The czeonia column holds the rate in percent and volume the trading volume in millions of Czech koruna.

Source

https://api.cnb.cz/cnbapi/swagger-ui.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# latest rate
cnb_czeonia()

# all rates for a given year
cnb_czeonia(year = 2024L)

Description

Retrieve time series observations from the CNB ARAD database. ARAD is the CNB's full statistical database, covering monetary, financial-market, balance-of-payments, and government finance statistics. Access requires an API key, which can be generated from a free account at https://www.cnb.cz/arad/.

Usage

cnb_data(
  indicator_id = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  start_period = NULL,
  end_period = NULL,
  snapshot_id = NULL,
  api_key = cnb_arad_key()
)

Arguments

Value

A data.table::data.table() with columns:

Source

https://www.cnb.cz/docs/arad20/dokumentace/arad_rest_api_cs.pdf

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

## Not run: 
# a single indicator over 24 months
cnb_data("SMV5M603", start_period = "2023-01-01")

# every indicator in a set
cnb_data(set_id = "1058")

## End(Not run)

Description

Retrieve the dimension structure of indicators from the CNB ARAD database, returning one row per indicator dimension.

Usage

cnb_dimension(
  indicator_id = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  lang = "en",
  api_key = cnb_arad_key()
)

Arguments

Value

A data.table::data.table() with columns including indicator_id, base_code, base_name, dim_code, dim_name, dim_value_code, dim_value_name, and dim_rank.

Source

https://www.cnb.cz/docs/arad20/dokumentace/arad_rest_api_cs.pdf

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

## Not run: 
cnb_dimension(indicator_id = "MIRFMDF12ERATPECD")

## End(Not run)

Description

Retrieve the monthly exchange rate fixing for less commonly traded ("other") currencies from the CNB API. These currencies are not part of the daily fixing returned by cnb_fx_rates().

Usage

cnb_fx_other_rates(year_month = NULL, year = NULL, lang = "EN")

Arguments

Value

A data.table::data.table() with the requested exchange rates. The rate is the amount of Czech koruna per amount units of the foreign currency.

Source

https://api.cnb.cz/cnbapi/swagger-ui.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# latest month for all other currencies
cnb_fx_other_rates()

# a specific month
cnb_fx_other_rates(year_month = "2024-01")

# all months of a given year
cnb_fx_other_rates(year = 2024L)

Description

Retrieve the central bank exchange rate fixing (Czech koruna against foreign currencies) from the CNB API.

Usage

cnb_fx_rates(date = NULL, year = NULL, lang = "EN")

Arguments

Value

A data.table::data.table() with the requested exchange rates. The rate is the amount of Czech koruna per amount units of the foreign currency.

Source

https://api.cnb.cz/cnbapi/swagger-ui.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# latest fixing for all currencies
cnb_fx_rates()

# all fixings for a given year
cnb_fx_rates(year = 2024L)

Description

Retrieve the available indicators and their attributes from the CNB ARAD database. Use this to discover indicator identifiers for cnb_data().

Usage

cnb_indicators(
  indicator_id = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  lang = "en",
  api_key = cnb_arad_key()
)

Arguments

Value

A data.table::data.table() with one row per indicator and columns including indicator_id, indicator_name, frequency_code, frequency_name, unit_mult_code, unit_mult_name, and unit.

Source

https://www.cnb.cz/docs/arad20/dokumentace/arad_rest_api_cs.pdf

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

## Not run: 
cnb_indicators(set_id = "1058")

## End(Not run)

Description

Retrieve the Prague Interbank Offered Rate (PRIBOR) reference rates for all maturities from the CNB API.

Usage

cnb_pribor(date = NULL, year = NULL)

Arguments

Value

A data.table::data.table() with the requested rates. The period column holds the maturity (e.g. "ONE_DAY", "THREE_MONTH") and pribor the rate in percent.

Source

https://api.cnb.cz/cnbapi/swagger-ui.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# latest rates for all maturities
cnb_pribor()

# all rates for a given year
cnb_pribor(year = 2024L)

Description

Retrieve the list of available snapshots (data vintages) from the CNB ARAD database. Snapshot ids can be passed to the snapshot_id argument of cnb_data().

Usage

cnb_snapshots(lang = "en", api_key = cnb_arad_key())

Arguments

Value

A data.table::data.table() with columns snapshot_id and snapshot_name.

Source

https://www.cnb.cz/docs/arad20/dokumentace/arad_rest_api_cs.pdf

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

## Not run: 
cnb_snapshots()

## End(Not run)

Description

Retrieve the placement of indicators within the ARAD topic tree.

Usage

cnb_tree(
  indicator_id = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  lang = "en",
  api_key = cnb_arad_key()
)

Arguments

Value

A data.table::data.table() with columns indicator_id and path, where path is the slash-separated location of the indicator in the ARAD tree.

Source

https://www.cnb.cz/docs/arad20/dokumentace/arad_rest_api_cs.pdf

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

## Not run: 
cnb_tree(indicator_id = "MIRFMDF12ERATPECD")

## End(Not run)

Description

Retrieve time series data from the ECB SDMX Web Service.

Usage

ecb_data(
  flow,
  key = NULL,
  start_period = NULL,
  end_period = NULL,
  first_n = NULL,
  last_n = NULL,
  updated_after = NULL
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://data.ecb.europa.eu/help/api/data

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), nbp_fx_rates(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch US dollar/Euro exchange rate
ecb_data("EXR", "D.USD.EUR.SP00.A")

# fetch data for multiple keys
ecb_data("EXR", c("D.USD", "JPY.EUR.SP00.A"))

Description

Retrieve the dimension structure for a given dataflow from the ECB SDMX Web Service.

Usage

ecb_dimension(id)

Arguments

Value

A data.table::data.table() with columns:

Source

https://data.ecb.europa.eu/help/api/metadata

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

ecb_dimension("ECB_EXR1")

Description

Fetch the latest or historical Euro foreign exchange reference rates from the European Central Bank (ECB).

Usage

ecb_fx_rates(x = "latest")

ecb_euro_rates(x = "latest")

Arguments

Details

Note you can achieve the same by calling the ecb_data() function with the right parameters for each currency.

The reference rates are usually updated at around 16:00 CET every working day, except on TARGET closing days.

They are based on the daily concertation procedure between central banks across Europe, which normally takes place around 14:10 CET. The reference rates are published for information purposes only. Using the rates for transaction purposes is strongly discouraged.

Value

A data.table::data.table() with the exchange rates.

Source

https://www.ecb.europa.eu/stats/policy_and_exchange_rates/euro_reference_exchange_rates/html/index.en.html

Examples

ecb_fx_rates()

Description

Retrieve metadata from the ECB time series database via the SDMX Web Service.

Usage

ecb_metadata(type, agency = NULL, id = NULL)

Arguments

Value

A data.table::data.table() with the requested metadata. The columns are:

Source

https://data.ecb.europa.eu/help/api/metadata

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

ecb_metadata("datastructure")
ecb_metadata("datastructure", "ECB")
ecb_metadata("datastructure", "ECB", "ECB_EXR1")
ecb_metadata("datastructure", id = "ECB_EXR1")

Description

Retrieve foreign currency exchange rates from the NBP Web API.

Usage

nbp_fx_rates(
  table,
  code = NULL,
  start_date = NULL,
  end_date = NULL,
  last_n = NULL
)

Arguments

Value

A data.table::data.table() with exchange rates.

Source

https://api.nbp.pl/en.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_gold(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

nbp_fx_rates("a", "eur")

Description

Retrieve the price of gold from the NBP Web API.

Usage

nbp_gold(start_date = NULL, end_date = NULL, last_n = NULL)

Arguments

Value

A data.table::data.table() with gold prices.

Source

https://api.nbp.pl/en.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nob_data(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

nbp_gold(last_n = 10L)

Description

Retrieve time series data from the Norges Bank SDMX Web Service.

Usage

nob_data(
  flow,
  key = NULL,
  start_period = NULL,
  end_period = NULL,
  first_n = NULL,
  last_n = NULL
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.norges-bank.no/en/topics/Statistics/open-data/

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), onb_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

# fetch USD/NOK exchange rate
nob_data("EXR", "B.USD.NOK.SP", last_n = 5L)

# fetch multiple exchange rates
nob_data("EXR", "B.USD+EUR+GBP.NOK.SP", start_period = "2024-01-01")

# fetch policy rate
nob_data("IR", last_n = 5L)

Description

Retrieve the dimension structure for a given dataflow from the Norges Bank SDMX Web Service.

Usage

nob_dimension(id)

Arguments

Value

A data.table::data.table() with columns:

Source

https://www.norges-bank.no/en/topics/Statistics/open-data/

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

nob_dimension("DSD_EXR")

Description

Retrieve metadata from the Norges Bank SDMX Web Service.

Usage

nob_metadata(type, id = NULL, lang = "en")

Arguments

Value

A data.table::data.table() with the requested metadata.

Source

https://www.norges-bank.no/en/topics/Statistics/open-data/

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

nob_metadata("dataflow")
nob_metadata("datastructure")
nob_metadata("codelist", "CL_CURRENCY")

Description

Retrieve time series data from the OeNB Web Service.

Usage

onb_data(
  hier_id,
  key,
  ...,
  start_period = NULL,
  end_period = NULL,
  freq = NULL,
  lang = "en"
)

Arguments

Value

A data.table::data.table() with the requested data.

Source

https://www.oenb.at/en/Statistics/User-Defined-Tables/webservice.html

See Also

Other data: banxico_data(), bbk_data(), bbk_series(), bcb_data(), bcb_expectations(), bcb_fx_rates(), bcb_inflation(), bcb_selic(), bcb_top5(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), boj_data(), cnb_czeonia(), cnb_data(), cnb_fx_other_rates(), cnb_fx_rates(), cnb_pribor(), ecb_data(), nbp_fx_rates(), nbp_gold(), nob_data(), snb_data(), srb_cross_rates(), srb_data()

Examples

onb_data(hier_id = 11, key = "VDBFKBSC217000")

# Loans to euro area residents, since 2000:
onb_data(hier_id = 11, key = "VDBFKBSC217000", start_period = "2000-01-01")

# Austrian imports and exports of goods from/to Germany, 2002–2012, annual frequency:
onb_data(hier_id = 901, key = "VDBQZA1000", start_period = 2002, end_period = 2012, freq = "A")

# Number of Austrian banks' subsidiaries abroad and in the EU, from 2005, semiannual:
onb_data(
  hier_id = 321,
  key = c("VDBKISDANZTAU", "VDBKISDANZTEU"),
  start_period = 200501,
  freq = "H"
)

Description

Fetch Österreichische Nationalbank (OeNB) dimension

Usage

onb_dimension(hier_id, key, lang = "en")

Arguments

Value

A data.table::data.table() with the requested data.

See Also

Other metadata: banxico_metadata(), bbk_dimension(), bbk_metadata(), bcb_currencies(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_dimension(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()