Skip to contents

Retrieve time series data from the BoE database.

Usage

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

Arguments

key

(character())
The series keys to query.

start_date

(character(1) | Date(1))
Start date of the data.

end_date

(character(1) | Date(1))
End date of the data. Default is today's date.

Value

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

Examples

# \donttest{
# Bank Rate
boe_data("IUDBEDR", "2015-01-01")
#>             date     key value        description   freq        instruments
#>           <Date>  <char> <num>             <char> <char>             <char>
#>    1: 2015-01-02 IUDBEDR  0.50 Official Bank Rate  daily Official Bank Rate
#>    2: 2015-01-05 IUDBEDR  0.50 Official Bank Rate  daily Official Bank Rate
#>    3: 2015-01-06 IUDBEDR  0.50 Official Bank Rate  daily Official Bank Rate
#>    4: 2015-01-07 IUDBEDR  0.50 Official Bank Rate  daily Official Bank Rate
#>    5: 2015-01-08 IUDBEDR  0.50 Official Bank Rate  daily Official Bank Rate
#>   ---                                                                      
#> 2970: 2026-10-02 IUDBEDR  3.75 Official Bank Rate  daily Official Bank Rate
#> 2971: 2026-10-05 IUDBEDR  3.75 Official Bank Rate  daily Official Bank Rate
#> 2972: 2026-10-06 IUDBEDR  3.75 Official Bank Rate  daily Official Bank Rate
#> 2973: 2026-10-07 IUDBEDR  3.75 Official Bank Rate  daily Official Bank Rate
#> 2974: 2026-10-08 IUDBEDR  3.75 Official Bank Rate  daily Official Bank Rate

# SONIA daily rate
boe_data("IUDSOIA", "2015-01-01")
#>             date     key  value
#>           <Date>  <char>  <num>
#>    1: 2015-01-02 IUDSOIA 0.4316
#>    2: 2015-01-05 IUDSOIA 0.4335
#>    3: 2015-01-06 IUDSOIA 0.4300
#>    4: 2015-01-07 IUDSOIA 0.4292
#>    5: 2015-01-08 IUDSOIA 0.4339
#>   ---                          
#> 2969: 2026-10-01 IUDSOIA 3.7331
#> 2970: 2026-10-02 IUDSOIA 3.7317
#> 2971: 2026-10-05 IUDSOIA 3.7323
#> 2972: 2026-10-06 IUDSOIA 3.7324
#> 2973: 2026-10-07 IUDSOIA 3.7326
#>                                               description   freq
#>                                                    <char> <char>
#>    1: Daily Sterling overnight index average (SONIA) rate  daily
#>    2: Daily Sterling overnight index average (SONIA) rate  daily
#>    3: Daily Sterling overnight index average (SONIA) rate  daily
#>    4: Daily Sterling overnight index average (SONIA) rate  daily
#>    5: Daily Sterling overnight index average (SONIA) rate  daily
#>   ---                                                           
#> 2969: Daily Sterling overnight index average (SONIA) rate  daily
#> 2970: Daily Sterling overnight index average (SONIA) rate  daily
#> 2971: Daily Sterling overnight index average (SONIA) rate  daily
#> 2972: Daily Sterling overnight index average (SONIA) rate  daily
#> 2973: Daily Sterling overnight index average (SONIA) rate  daily

# 10-year nominal par yield
boe_data("IUDMNPY", "2015-01-01")
#>             date     key  value
#>           <Date>  <char>  <num>
#>    1: 2015-01-02 IUDMNPY 1.7846
#>    2: 2015-01-05 IUDMNPY 1.7162
#>    3: 2015-01-06 IUDMNPY 1.6465
#>    4: 2015-01-07 IUDMNPY 1.6584
#>    5: 2015-01-08 IUDMNPY 1.6970
#>   ---                          
#> 2969: 2026-10-01 IUDMNPY 5.3665
#> 2970: 2026-10-02 IUDMNPY 5.3341
#> 2971: 2026-10-05 IUDMNPY 5.3634
#> 2972: 2026-10-06 IUDMNPY 5.3368
#> 2973: 2026-10-07 IUDMNPY 5.3852
#>                                                               description
#>                                                                    <char>
#>    1: Yield from British Government Securities, 10 year Nominal Par Yield
#>    2: Yield from British Government Securities, 10 year Nominal Par Yield
#>    3: Yield from British Government Securities, 10 year Nominal Par Yield
#>    4: Yield from British Government Securities, 10 year Nominal Par Yield
#>    5: Yield from British Government Securities, 10 year Nominal Par Yield
#>   ---                                                                    
#> 2969: Yield from British Government Securities, 10 year Nominal Par Yield
#> 2970: Yield from British Government Securities, 10 year Nominal Par Yield
#> 2971: Yield from British Government Securities, 10 year Nominal Par Yield
#> 2972: Yield from British Government Securities, 10 year Nominal Par Yield
#> 2973: Yield from British Government Securities, 10 year Nominal Par Yield
#>         freq     seasonal_adjustment   type output_in instrument_currency
#>       <char>                  <char> <char>    <char>              <char>
#>    1:  daily Not seasonally adjusted  Yield   Percent            Sterling
#>    2:  daily Not seasonally adjusted  Yield   Percent            Sterling
#>    3:  daily Not seasonally adjusted  Yield   Percent            Sterling
#>    4:  daily Not seasonally adjusted  Yield   Percent            Sterling
#>    5:  daily Not seasonally adjusted  Yield   Percent            Sterling
#>   ---                                                                    
#> 2969:  daily Not seasonally adjusted  Yield   Percent            Sterling
#> 2970:  daily Not seasonally adjusted  Yield   Percent            Sterling
#> 2971:  daily Not seasonally adjusted  Yield   Percent            Sterling
#> 2972:  daily Not seasonally adjusted  Yield   Percent            Sterling
#> 2973:  daily Not seasonally adjusted  Yield   Percent            Sterling
#>                      instruments
#>                           <char>
#>    1: Nominal par yield, 10 year
#>    2: Nominal par yield, 10 year
#>    3: Nominal par yield, 10 year
#>    4: Nominal par yield, 10 year
#>    5: Nominal par yield, 10 year
#>   ---                           
#> 2969: Nominal par yield, 10 year
#> 2970: Nominal par yield, 10 year
#> 2971: Nominal par yield, 10 year
#> 2972: Nominal par yield, 10 year
#> 2973: Nominal par yield, 10 year

# multiple series
boe_data(c("IUMABEDR", "IUALBEDR"), "2015-01-01")
#>            date      key value                           description    freq
#>          <Date>   <char> <num>                                <char>  <char>
#>   1: 2015-01-31 IUMABEDR  0.50 Monthly average of official Bank Rate monthly
#>   2: 2015-02-28 IUMABEDR  0.50 Monthly average of official Bank Rate monthly
#>   3: 2015-03-31 IUMABEDR  0.50 Monthly average of official Bank Rate monthly
#>   4: 2015-04-30 IUMABEDR  0.50 Monthly average of official Bank Rate monthly
#>   5: 2015-05-31 IUMABEDR  0.50 Monthly average of official Bank Rate monthly
#>  ---                                                                        
#> 148: 2021-12-31 IUALBEDR  0.25           End year official Bank Rate  annual
#> 149: 2022-12-31 IUALBEDR  3.50           End year official Bank Rate  annual
#> 150: 2023-12-31 IUALBEDR  5.25           End year official Bank Rate  annual
#> 151: 2024-12-31 IUALBEDR  4.75           End year official Bank Rate  annual
#> 152: 2025-12-31 IUALBEDR  3.75           End year official Bank Rate  annual
#>          seasonal_adjustment          type output_in instrument_currency
#>                       <char>        <char>    <char>              <char>
#>   1: Not seasonally adjusted Interest rate   Percent            Sterling
#>   2: Not seasonally adjusted Interest rate   Percent            Sterling
#>   3: Not seasonally adjusted Interest rate   Percent            Sterling
#>   4: Not seasonally adjusted Interest rate   Percent            Sterling
#>   5: Not seasonally adjusted Interest rate   Percent            Sterling
#>  ---                                                                    
#> 148:                    <NA> Interest rate   Percent            Sterling
#> 149:                    <NA> Interest rate   Percent            Sterling
#> 150:                    <NA> Interest rate   Percent            Sterling
#> 151:                    <NA> Interest rate   Percent            Sterling
#> 152:                    <NA> Interest rate   Percent            Sterling
#>             instruments
#>                  <char>
#>   1: Official Bank Rate
#>   2: Official Bank Rate
#>   3: Official Bank Rate
#>   4: Official Bank Rate
#>   5: Official Bank Rate
#>  ---                   
#> 148: Official Bank Rate
#> 149: Official Bank Rate
#> 150: Official Bank Rate
#> 151: Official Bank Rate
#> 152: Official Bank Rate
# }