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
- ...
(
any)
Extra arguments appended to the API request. Combined with the default arguments withmodifyList().- key
(
NULL|character(1))
The series key to query. DefaultNULL.- start_date
(
NULL|character(1)|Date(1))
Start date of the data. DefaultNULL.- end_date
(
NULL|character(1)|Date(1))
End date of the data. DefaultNULL.- lang
(
character(1))
Language to query. Default"en".- api_key
(
character(1))
API key to use for the request. Defaults to the value returned bybdf_key(), which reads from theBANQUEDEFRANCE_KEYenvironment variable.
Value
A data.table::data.table() with the requested data.
See also
Other data:
bbk_data(),
bbk_series(),
bcb_data(),
bcb_expectations(),
bcb_fx_rates(),
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
if (FALSE) { # \dontrun{
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'")
} # }