Skip to contents

Fetch Bank of Japan (BoJ) data

Source: R/boj.R
boj_data.Rd

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

Usage

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

Source

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

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. Use boj_metadata() to find available codes.

start_date

(NULL | character(1) | integer(1))
Start date of the data. Format depends on frequency: "YYYYMMDD" or YYYY for daily, "YYYYMM" for monthly, "YYYYQQ" for quarterly (where QQ is 01-04), "YYYY" for annual. If NULL, all available data is returned. Default NULL.

end_date

(NULL | character(1) | integer(1))
End date of the data, in the same format as start_date. If NULL, data up to the latest available date is returned. Default NULL.

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(), bde_data(), bde_latest(), bdf_codelist(), bdf_data(), bdf_dataset(), bdp_data(), bis_data(), boc_data(), boe_data(), 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
#>  ---                                 
#> 553: 2026-04-09 FXERD01 158.65  daily
#> 554: 2026-04-10 FXERD01 159.10  daily
#> 555: 2026-04-13 FXERD01 159.68  daily
#> 556: 2026-04-14 FXERD01 159.23  daily
#> 557: 2026-04-15 FXERD01 158.81  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
#>  ---                                                                         
#> 553: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 554: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 555: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 556: US.Dollar/Yen Spot Rate at 9:00 in JST, Tokyo Market Yen per U.S. Dollar
#> 557: 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
#>   ---                                 
#> 1110: 2026-04-09 FXERD02 159.00  daily
#> 1111: 2026-04-10 FXERD02 159.36  daily
#> 1112: 2026-04-13 FXERD02 159.85  daily
#> 1113: 2026-04-14 FXERD02 159.39  daily
#> 1114: 2026-04-15 FXERD02 159.06  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
#>   ---                                                                         
#> 1110:                  US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1111:                  US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1112:                  US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1113:                  US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
#> 1114:                  US.Dollar/Yen Highest, Tokyo Market Yen per U.S. Dollar
# }