Retrieve time series data from the Bank of Japan Statistics API.
Arguments
- db
(
character(1))
The database code to query (e.g.,"FM08"for foreign exchange rates). See the API manual for available databases.- code
(
character())
One or more series codes to query (e.g.,"FXERD01"for USD/JPY spot rate). Maximum 250 codes per request. All codes must have the same frequency. Useboj_metadata()to find available codes.- start_date
(
NULL|character(1)|integer(1))
Start date of the data. Format depends on frequency:"YYYYMMDD"orYYYYfor daily,"YYYYMM"for monthly,"YYYYQQ"for quarterly (where QQ is 01-04),"YYYY"for annual. IfNULL, all available data is returned. DefaultNULL.- end_date
(
NULL|character(1)|integer(1))
End date of the data, in the same format as start_date. IfNULL, data up to the latest available date is returned. DefaultNULL.- lang
(
character(1))
Language for series names, either"en"or"jp". Default"en".
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_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
# \donttest{
# fetch USD/JPY exchange rate
boj_data("FM08", "FXERD01", start_date = "202401")
#> date key value freq
#> <Date> <char> <num> <char>
#> 1: 2024-01-04 FXERD01 142.98 daily
#> 2: 2024-01-05 FXERD01 144.77 daily
#> 3: 2024-01-09 FXERD01 144.22 daily
#> 4: 2024-01-10 FXERD01 144.43 daily
#> 5: 2024-01-11 FXERD01 145.73 daily
#> ---
#> 589: 2026-06-04 FXERD01 159.95 daily
#> 590: 2026-06-05 FXERD01 160.00 daily
#> 591: 2026-06-08 FXERD01 160.34 daily
#> 592: 2026-06-09 FXERD01 160.19 daily
#> 593: 2026-06-10 FXERD01 160.39 daily
#> name unit
#> <char> <char>
#> 1: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 2: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 3: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 4: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 5: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> ---
#> 589: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 590: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 591: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 592: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 593: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
# fetch multiple exchange rates
boj_data("FM08", c("FXERD01", "FXERD02"), start_date = "202401")
#> date key value freq
#> <Date> <char> <num> <char>
#> 1: 2024-01-04 FXERD01 142.98 daily
#> 2: 2024-01-05 FXERD01 144.77 daily
#> 3: 2024-01-09 FXERD01 144.22 daily
#> 4: 2024-01-10 FXERD01 144.43 daily
#> 5: 2024-01-11 FXERD01 145.73 daily
#> ---
#> 1182: 2026-06-04 FXERD02 160.05 daily
#> 1183: 2026-06-05 FXERD02 160.01 daily
#> 1184: 2026-06-08 FXERD02 160.39 daily
#> 1185: 2026-06-09 FXERD02 160.29 daily
#> 1186: 2026-06-10 FXERD02 160.43 daily
#> name unit
#> <char> <char>
#> 1: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 2: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 3: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 4: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 5: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> ---
#> 1182: US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1183: US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1184: US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1185: US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1186: US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
# }