The package gives access to the Bank of Canada data API. Currently there are 15,917 data series available, grouped into 2,530 series groups.
Finding data
We obtain basic information for the series or series groups.
series_list <- list_boc_series()
#> Accessing BOC data from cache...
series_group_list <- list_boc_series_groups()
#> Accessing BOC data from cache...
head(series_list) %>% knitr::kable()| name | label | description | link |
|---|---|---|---|
| A.AGRI | Annual BCPI Agriculture | Annual Bank of Canada commodity price index - Agriculture | https://www.bankofcanada.ca/valet/series/A.AGRI |
| A.BCNE | Annual BCPI Excluding Energy | Annual Bank of Canada commodity price index - Excluding Energy | https://www.bankofcanada.ca/valet/series/A.BCNE |
| A.BCPI | Annual BCPI Total | Annual Bank of Canada commodity price index - Total | https://www.bankofcanada.ca/valet/series/A.BCPI |
| A.ENER | Annual BCPI Energy | Annual Bank of Canada commodity price index - Energy | https://www.bankofcanada.ca/valet/series/A.ENER |
| A.FISH | Annual BCPI Fish | Annual Bank of Canada commodity price index - Fish | https://www.bankofcanada.ca/valet/series/A.FISH |
| A.FOPR | Annual BCPI Forestry | Annual Bank of Canada commodity price index - Forestry | https://www.bankofcanada.ca/valet/series/A.FOPR |
Data discovery is still somewhat cumbersome, we can search for phrases in the labels or description.
| name | label | description |
|---|---|---|
| CES_C10G_NEXT_APPLIANCE_OH | Next six months, appliance, homeowner | Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_NEXT_ELECTRONIC_OH | Next six months, electronic, homeowner | Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_NEXT_EVENT_OH | Next six months, event, homeowner | Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_NEXT_OTHER_OH | Next six months, other, homeowner | Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_NEXT_VACATION_OH | Next six months, vacation, homeowner | Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_NEXT_VEHICLE_OH | Next six months, vehicle, homeowner | Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_PAST_APPLIANCE_OH | Past six months, appliance, homeowner | Past six months: Did you make any major purchases (excluding homes or financial investments) in the past six months? Please indicate which item you purchased. Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_PAST_ELECTRONIC_OH | Past six months, electronic, homeowner | Past six months: Did you make any major purchases (excluding homes or financial investments) in the past six months? Please indicate which item you purchased. Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_PAST_EVENT_OH | Past six months, event, homeowner | Past six months: Did you make any major purchases (excluding homes or financial investments) in the past six months? Please indicate which item you purchased. Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_PAST_OTHER_OH | Past six months, other, homeowner | Past six months: Did you make any major purchases (excluding homes or financial investments) in the past six months? Please indicate which item you purchased. Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_PAST_VACATION_OH | Past six months, vacation, homeowner | Past six months: Did you make any major purchases (excluding homes or financial investments) in the past six months? Please indicate which item you purchased. Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C10G_PAST_VEHICLE_OH | Past six months, vehicle, homeowner | Past six months: Did you make any major purchases (excluding homes or financial investments) in the past six months? Please indicate which item you purchased. Next six months: Do you plan to make any major purchases (excluding homes or financial investments) in the next six months? |
| CES_C11G_MOVING_OH | More than 50% chance of moving in next 12 months, homeowner | Probability of moving: For example, what do you think is the percent chance that over the next 12 months you will move to a different primary residence (that is, the place where you usually live)? Probability of selling: What do you think is the percent chance that, over the next 12 months, you will put your primary residence on the market for sale? Buying intentions: Are you planning or thinking of buying a house or a condo now or have you bought one during the last year? |
| CES_C11G_POTENTIAL_BUYER_OH | Planning to buy or thinking of buying a house or condo, homeowner | Probability of moving: For example, what do you think is the percent chance that over the next 12 months you will move to a different primary residence (that is, the place where you usually live)? Probability of selling: What do you think is the percent chance that, over the next 12 months, you will put your primary residence on the market for sale? Buying intentions: Are you planning or thinking of buying a house or a condo now or have you bought one during the last year? |
| CES_C11G_RENTER_BUYER_OH | Renters planning to buy in next 12 months, homeowner | Probability of moving: For example, what do you think is the percent chance that over the next 12 months you will move to a different primary residence (that is, the place where you usually live)? Probability of selling: What do you think is the percent chance that, over the next 12 months, you will put your primary residence on the market for sale? Buying intentions: Are you planning or thinking of buying a house or a condo now or have you bought one during the last year? |
| CES_C11G_SELLING_OH | More than 50% chance of selling in next 12 months, homeowner | Probability of moving: For example, what do you think is the percent chance that over the next 12 months you will move to a different primary residence (that is, the place where you usually live)? Probability of selling: What do you think is the percent chance that, over the next 12 months, you will put your primary residence on the market for sale? Buying intentions: Are you planning or thinking of buying a house or a condo now or have you bought one during the last year? |
| CES_C12G_BFMP_OH | Bring forward major purchases, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations of inflation (deflation) over the next two years? |
| CES_C12G_CSP_OH | Cut spending or push back major purchases, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations of inflation (deflation) over the next two years? |
| CES_C12G_NA_OH | No action, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations of inflation (deflation) over the next two years? |
| CES_C12G_PIP_OH | Push for increased pay with current employer, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations of inflation (deflation) over the next two years? |
| CES_C12G_SABD_OH | Shop around for better deals, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations of inflation (deflation) over the next two years? |
| CES_C12G_WMH_OH | Work more hours, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations of inflation (deflation) over the next two years? |
| CES_C13G_BFMP_OH | Bring forward major purchases, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations for interest rates? |
| CES_C13G_CSP_OH | Cut spending or postpone major purchase, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations for interest rates? |
| CES_C13G_NA_OH | No action, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations for interest rates? |
| CES_C13G_PDD_OH | Pay down debt, homeowner | Which, if any, of the following actions are you taking, or planning to take, in light of your expectations for interest rates? |
| CES_C14G_MISS_DEBT_OH | Probability of missing a debt payment, homeowner | What do you think is the percent chance that, over the next 3 months, you will NOT be able to make one of your debt payments (that is, the minimum required payments on credit and retail cards, auto loans, student loans, mortgages, or any other debt you may have)? |
| CES_C15G_FUTURE_OH | Financial well-being 12 months from now, homeowner | Previous 12 months: Do you think you (and any family living with you) are financially better or worse off these days than you were 12 months ago? Next 12 months: And looking ahead, do you think you (and any family living with you) will be financially better or worse off 12 months from now than you are these days? |
| CES_C15G_PAST_OH | Financial well-being compared to 12 months ago, homeowner | Previous 12 months: Do you think you (and any family living with you) are financially better or worse off these days than you were 12 months ago? Next 12 months: And looking ahead, do you think you (and any family living with you) will be financially better or worse off 12 months from now than you are these days? |
| CES_C16G_FUTURE_OH | Access to credit 12 months from now, homeowner | Previous 12 months: Compared to 12 months ago, do you think it is generally harder or easier these days for people to obtain credit or loans (including credit and retail cards, auto loans, student loans, and mortgages)? Next 12 months: And looking ahead, do you think that 12 months from now it will generally be harder or easier for people to obtain credit or loans (including credit and retail cards, auto loans, student loans, and mortgages) than it is these days? |
| CES_C16G_PAST_OH | Access to credit compared to 12 months ago, homeowner | Previous 12 months: Compared to 12 months ago, do you think it is generally harder or easier these days for people to obtain credit or loans (including credit and retail cards, auto loans, student loans, and mortgages)? Next 12 months: And looking ahead, do you think that 12 months from now it will generally be harder or easier for people to obtain credit or loans (including credit and retail cards, auto loans, student loans, and mortgages) than it is these days? |
| CES_C1G_LONG_TERM_OH | 5-year-ahead inflation expectations, homeowner | Inflation expectations for each horizon: What do you expect the rate of inflation (deflation) to be? Perceptions about current inflation: What do you think the rate of inflation (deflation) was over the last 12 months? |
| CES_C1G_MID_TERM_OH | 2-year-ahead inflation expectations, homeowner | Inflation expectations for each horizon: What do you expect the rate of inflation (deflation) to be? Perceptions about current inflation: What do you think the rate of inflation (deflation) was over the last 12 months? |
| CES_C1G_PERCEPTIONS_OH | Perceptions about current inflation, homeowner | Inflation expectations for each horizon: What do you expect the rate of inflation (deflation) to be? Perceptions about current inflation: What do you think the rate of inflation (deflation) was over the last 12 months? |
| CES_C1G_SHORT_TERM_OH | 1-year-ahead inflation expectations, homeowner | Inflation expectations for each horizon: What do you expect the rate of inflation (deflation) to be? Perceptions about current inflation: What do you think the rate of inflation (deflation) was over the last 12 months? |
| CES_C2G_CANADA_CARS_OH | Cars, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C2G_CANADA_FOOD_OH | Food, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C2G_CANADA_GAS_OH | Gasoline, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C2G_CANADA_RENT_OH | Rent, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C2G_UNCERTAINTY_LONG_TERM_REG_OH | Uncertainty, 5-year-ahead inflation expectations, homeowner | In your view, what would you say is the percent chance that, over the next 12 months (in 12 to 24 months / five years), the rate of inflation or deflation will be between 0% and 2%, 2% and 4% …? (For example, there is ___ percent chance that the rate of inflation or deflation will be between 0% and 2%, 2% and 4% …) |
| CES_C2G_UNCERTAINTY_MID_TERM_OH | Uncertainty, 2-year-ahead inflation expectations, homeowner | In your view, what would you say is the percent chance that, over the next 12 months (in 12 to 24 months / five years), the rate of inflation or deflation will be between 0% and 2%, 2% and 4% …? (For example, there is ___ percent chance that the rate of inflation or deflation will be between 0% and 2%, 2% and 4% …) |
| CES_C2G_UNCERTAINTY_SHORT_TERM_OH | Uncertainty, 1-year-ahead inflation expectations, homeowner | In your view, what would you say is the percent chance that, over the next 12 months (in 12 to 24 months / five years), the rate of inflation or deflation will be between 0% and 2%, 2% and 4% …? (For example, there is ___ percent chance that the rate of inflation or deflation will be between 0% and 2%, 2% and 4% …) |
| CES_C3G_NEXT_12_OH | Expected wage growth, next 12 months, homeowner | Wage growth expectations: By about what percent do you expect your earnings* to have increased (decreased) over the next 12 months? Wage growth perceptions: By about what percent do you think your earnings have increased (decreased) over the past 12 months? |
| CES_C3G_PAST_12_OH | Perceptions about wage growth, past 12 months, homeowner | Wage growth expectations: By about what percent do you expect your earnings* to have increased (decreased) over the next 12 months? Wage growth perceptions: By about what percent do you think your earnings have increased (decreased) over the past 12 months? |
| CES_C4G_FIND_JOB_OH | Probability of finding job in the next 3 months if lost main job this month, right scale, homeowner | Probability of losing job: What do you think is the percent chance that you will lose your job during the next 12 months? Probability of leaving job voluntarily: What do you think is the percent chance that you will leave your job voluntarily during the next 12 months? Probability of finding job: Suppose you were to lose your job. What do you think is the percent chance that within the following 3 months you would find a job that you would accept? |
| CES_C4G_LEAVE_JOB_OH | Probability of leaving job voluntarily in the next 12 months, left scale, homeowner | Probability of losing job: What do you think is the percent chance that you will lose your job during the next 12 months? Probability of leaving job voluntarily: What do you think is the percent chance that you will leave your job voluntarily during the next 12 months? Probability of finding job: Suppose you were to lose your job. What do you think is the percent chance that within the following 3 months you would find a job that you would accept? |
| CES_C4G_LOSE_JOB_OH | Probability of losing job in the next 12 months, left scale, homeowner | Probability of losing job: What do you think is the percent chance that you will lose your job during the next 12 months? Probability of leaving job voluntarily: What do you think is the percent chance that you will leave your job voluntarily during the next 12 months? Probability of finding job: Suppose you were to lose your job. What do you think is the percent chance that within the following 3 months you would find a job that you would accept? |
| CES_C5G_INCOME_OH | Expected income growth, next 12 months, homeowner | Income growth: Over the next 12 months, by about what percent do you expect your total household income* to increase (decrease)? Spending growth: Over the next 12 months, by about what percent do you expect the total spending of all members of your household to increase (decrease)? |
| CES_C5G_SPENDING_OH | Expected spending growth, next 12 months, homeowner | Income growth: Over the next 12 months, by about what percent do you expect your total household income* to increase (decrease)? Spending growth: Over the next 12 months, by about what percent do you expect the total spending of all members of your household to increase (decrease)? |
| CES_C6G_FIVE_YEAR_OH | 5 years ahead, homeowner | At what level do you think interest rates on things such as mortgages, bank loans and savings will be in one year/two years/five years from now? |
| CES_C6G_ONE_YEAR_OH | 1 year ahead, homeowner | At what level do you think interest rates on things such as mortgages, bank loans and savings will be in one year/two years/five years from now? |
| CES_C6G_TWO_YEAR_OH | 2 years ahead, homeowner | At what level do you think interest rates on things such as mortgages, bank loans and savings will be in one year/two years/five years from now? |
| CES_C8G_CARS_OH | Cars, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C8G_FOOD_OH | Food, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C8G_GAS_OH | Gasoline, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C8G_RENT_OH | Rent, homeowner | Twelve months from now, what do you think will have happened to the price of the following items? |
| CES_C9G_BOO_OH | Economic growth, balance of opinion, homeowner | What do you think is the most likely outlook for the Canadian economy over the next 12 months? |
| CES_C9G_MODGRTH_OH | Some economic growth, homeowner | What do you think is the most likely outlook for the Canadian economy over the next 12 months? |
| CES_C9G_SIGDECL_OH | Significant decline, homeowner | What do you think is the most likely outlook for the Canadian economy over the next 12 months? |
| CES_C9G_SMLDECL_OH | Small decline, homeowner | What do you think is the most likely outlook for the Canadian economy over the next 12 months? |
| CES_C9G_STABLE_OH | Stable or little change, homeowner | What do you think is the most likely outlook for the Canadian economy over the next 12 months? |
| CES_C9G_STRGRTH_OH | Strong economic growth, homeowner | What do you think is the most likely outlook for the Canadian economy over the next 12 months? |
| CSCE_2022Q4_C1_S4 | Durables (e.g., cars and home appliances) | |
| FSHUB_20201105_C3_S2 | Homeowners with a mortgage | |
| FSHUB_20201105_C8B_S2 | Homeowners | |
| FSHUB_20210128_C3B_S1 | Homeowners | |
| FSHUB_20210317_C2_S2 | Multiple Listing Service Home Price Index for Canada, year-over-year percentage change (right scale) | |
| FSHUB_20210317_C4_S1 | Single-family homes | |
| FSHUB_20210317_C8_S1 | Consumer credit, including home equity lines of credit | |
| FSHUB_20210505_C3B_S1 | Homeowners | |
| FSHUB_20210910_C2B_S1 | Homeowners | |
| FSR_2018JUNE_C3S1 | Residential mortgage credit and home equity lines of credit; 3-month seasonally adjusted annualized rate | June 2018 FSR; Chart 3; Residential mortgage credit and home equity lines of credit; 3-month seasonally adjusted annualized rate |
| FSR_2018JUNE_C3S2 | Consumer credit, excluding home equity lines of credit; 3-month seasonally adjusted annualized rate | June 2018 FSR; Chart 3; Consumer credit, excluding home equity lines of credit; 3-month seasonally adjusted annualized rate |
| FSR_2018JUNE_C7S1 | Year-over-year growth in national quality-adjusted benchmark prices; Single-family homes | June 2018 FSR; Chart 7; Year-over-year growth in national quality-adjusted benchmark prices; Single-family homes |
| FSR_2018JUNE_C8AS1 | 3-month seasonally adjusted annualized growth in quality-adjusted benchmark prices in the Greater Toronto Area; Single-family homes | June 2018 FSR; Chart 8a; 3-month seasonally adjusted annualized growth in quality-adjusted benchmark prices in the Greater Toronto Area; Single-family homes |
| FSR_2018JUNE_C8BS1 | 3-month seasonally adjusted annualized growth in quality-adjusted benchmark prices in the Greater Vancouver Area; Single-family homes | June 2018 FSR; Chart 8b; 3-month seasonally adjusted annualized growth in quality-adjusted benchmark prices in the Greater Vancouver Area; Single-family homes |
| FSR_2019_C3_S00 | Residential mortgage credit and home equity lines of credit | |
| FSR_2019_C3_S01 | Consumer credit, excluding home equity lines of credit | |
| FSR_2021_C3_S1 | Consumer debt, including home equity lines of credit | |
| FSR_2022_C2A_S1 | Share of mortgaged home purchases by investors | |
| FVI_LOANS_ARR_HELOC | Home equity lines of credit | Rates of loans in arrears (%), by product type—Home equity lines of credit |
| FVI_MEDIAN_LTI_FTHB | First-time homebuyers, originations dataset, using RESL1 | Median LTI ratio (%), by type of homebuyer-First-time homebuyers, originations dataset, using RESL1 |
| FVI_MEDIAN_LTI_FTHB_RESL2 | First-time homebuyers, enhanced dataset, using RESL2 | Median LTI ratio (%), by type of homebuyer-First-time homebuyers, enhanced dataset, using RESL2 |
| FVI_MEDIAN_LTI_REPEAT | Repeat homebuyers, originations dataset, using RESL1 | Median LTI ratio (%), by type of homebuyer-Repeat homebuyers, originations dataset, using RESL1 |
| FVI_MEDIAN_LTI_REPEAT_RESL2 | Repeat homebuyers, enhanced dataset, using RESL2 | Median LTI ratio (%), by type of homebuyer-Repeat homebuyers, enhanced dataset, using RESL2 |
| FVI_MEDIAN_MDSR_FTHB | First-time homebuyers, originations dataset, using RESL1 | Median mortgage DSR (%), by type of homebuyer-First-time homebuyers, originations dataset, using RESL1 |
| FVI_MEDIAN_MDSR_FTHB_RESL2 | First-time homebuyers, enhanced dataset, using RESL2 | Median mortgage DSR (%), by type of homebuyer-First-time homebuyers, enhanced dataset, using RESL2 |
| FVI_MEDIAN_MDSR_REPEAT | Repeat homebuyers, originations dataset, using RESL1 | Median mortgage DSR (%), by type of homebuyer-Repeat homebuyers, originations dataset, using RESL1 |
| FVI_MEDIAN_MDSR_REPEAT_RESL2 | Repeat homebuyers, enhanced dataset, using RESL2 | Median mortgage DSR (%), by type of homebuyer-Repeat homebuyers, enhanced dataset, using RESL2 |
| FVI_MTG_LTI450_FTHB | First-time homebuyers, originations dataset, using RESL1 | Share of new mortgages (%) with an LTI ratio above 450%, by type of homebuyer-First-time homebuyers, originations dataset, using RESL1 |
| FVI_MTG_LTI450_FTHB_RESL2 | First-time homebuyers, enhanced dataset, using RESL2 | Share of new mortgages (%) with an LTI ratio above 450%, by type of homebuyer-First-time homebuyers, enhanced dataset, using RESL2 |
| FVI_MTG_LTI450_REPEAT | Repeat homebuyers, originations dataset, using RESL1 | Share of new mortgages (%) with an LTI ratio above 450%, by type of homebuyer-Repeat homebuyers, originations dataset, using RESL1 |
| FVI_MTG_LTI450_REPEAT_RESL2 | Repeat homebuyers, enhanced dataset, using RESL2 | Share of new mortgages (%) with an LTI ratio above 450%, by type of homebuyer-Repeat homebuyers, enhanced dataset, using RESL2 |
| FVI_MTG_LTVAVE_FTHB | First-time homebuyers, originations dataset, using RESL1 | Average LTV ratio (%), by type of homebuyer-First-time homebuyers, originations dataset, using RESL1 |
| FVI_MTG_LTVAVE_FTHB_RESL2 | First-time homebuyers, enhanced dataset, using RESL2 | Average LTV ratio (%), by type of homebuyer-First-time homebuyers, enhanced dataset, using RESL2 |
| FVI_MTG_LTVAVE_REPEAT | Repeat homebuyers, originations dataset, using RESL1 | Average LTV ratio (%), by type of homebuyer-Repeat homebuyers, originations dataset, using RESL1 |
| FVI_MTG_LTVAVE_REPEAT_RESL2 | Repeat homebuyers, enhanced dataset, using RESL2 | Average LTV ratio (%), by type of homebuyer-Repeat homebuyers, enhanced dataset, using RESL2 |
| FVI_MTG_MDSR_GT25_FTHB | First-time homebuyers, originations dataset, using RESL1 | Share of new mortgages (%) with a mortgage DSR greater than 25%, by type of homebuyer-First-time homebuyers, originations dataset, using RESL1 |
| FVI_MTG_MDSR_GT25_FTHB_RESL2 | First-time homebuyers, enhanced dataset, using RESL2 | Share of new mortgages (%) with a mortgage DSR greater than 25%, by type of homebuyer-First-time homebuyers, enhanced dataset, using RESL2 |
| FVI_MTG_MDSR_GT25_REPEAT | Repeat homebuyers, originations dataset, using RESL1 | Share of new mortgages (%) with a mortgage DSR greater than 25%, by type of homebuyer-Repeat homebuyers, originations dataset, using RESL1 |
| FVI_MTG_MDSR_GT25_REPEAT_RESL2 | Repeat homebuyers, enhanced dataset, using RESL2 | Share of new mortgages (%) with a mortgage DSR greater than 25%, by type of homebuyer-Repeat homebuyers, enhanced dataset, using RESL2 |
| FVI_VOL_MTG_FTHB | First-time homebuyers | Share of mortgaged home purchases (%), by type of homebuyer-First-time homebuyers, originations dataset, using RESL1 |
| FVI_VOL_MTG_FTHB_RESL2 | First-time homebuyers | Share of mortgaged home purchases (%), by type of homebuyer-First-time homebuyers, enhanced dataset, using RESL2 |
| FVI_VOL_MTG_REPEAT | Repeat homebuyers | Share of mortgaged home purchases (%), by type of homebuyer-Repeat homebuyers, originations dataset, using RESL1 |
| FVI_VOL_MTG_REPEAT_RESL2 | Repeat homebuyers | Share of mortgaged home purchases (%), by type of homebuyer-Repeat homebuyers, enhanced dataset, using RESL2 |
| MPR_2025M10_CHINA_INDICATORS_S4 | Home sales (right scale) | |
| SABA_ZHAO20260206_C2_S2 | Home equity lines of credit | Home equity lines of credit |
| SAN_MIKA20210428_C1_S3 | Percentage of homes sold over asking (right scale) | |
| SAN_MIKA20211206_C3_S1 | First-time homebuyers | |
| SAN_MIKA20211206_C3_S2 | Repeat homebuyers | |
| SAN_MIKA20211206_C4_S1 | First-time homebuyers (left scale) | |
| SAN_MIKA20211206_C4_S2 | Repeat homebuyers (right scale) | |
| SAN_MIKA20211206_C6A_S2 | First-time homebuyers | |
| SAN_MIKA20211206_C6A_S3 | Repeat homebuyers | |
| SAN_MIKA20211206_C6B_S2 | First-time homebuyers | |
| SAN_MIKA20211206_C6B_S3 | Repeat homebuyers | |
| SAN_MIKA20211206_C6C_S2 | First-time homebuyers | |
| SAN_MIKA20211206_C6C_S3 | Repeat homebuyers | |
| SAN_MIKA20211206_C6D_S2 | First-time homebuyers | |
| SAN_MIKA20211206_C6D_S3 | Repeat homebuyers | |
| SAN_MIKA20211206_C6E_S2 | First-time homebuyers | |
| SAN_MIKA20211206_C6E_S3 | Repeat homebuyers | |
| V37756 | Mobile homes | Canadian dollar loans - Loans to Canadian individuals for non-business purposes - To purchase consumer goods and other personal services |
Series groups
Related series are collected into groups, which can be retrieved in one call. If we are interested in the MLS home price index, we might want to inspect the series group FSHUB_20210317_C2.
get_boc_series_group("FSHUB_20210317_C2") %>%
mutate(name=gsub(" \\(.+\\)$","",label)) %>%
ggplot(aes(x=Date,y=Value)) +
geom_line(colour="steelblue",linewidth=1) +
geom_smooth(se=FALSE,method="lm",formula=y~1,colour="brown",linewidth=0.5) +
facet_wrap(~name,scales="free_y",ncol=1) +
labs(title="MLS overview data for Canada with long-run averages",
x=NULL,y=NULL,
caption="Source: Bank of Canada series group FSHUB_20210317_C2")
#> Downloading BOC series group data for FSHUB_20210317_C2
Individual series
Series can also be retrieved on their own, several at a time. For example, we might be interested in mortgage rates.
mortgage_rate_series <- list_boc_series() %>%
filter(grepl("mortgage rate|Conventional mortgage", label, ignore.case = TRUE))
#> Accessing BOC data from cache...
mortgage_rate_series %>%
select(-link) %>%
knitr::kable()| name | label | description |
|---|---|---|
| BROKER_AVERAGE_5YR_VRM | Estimated variable mortgage rate | Estimated variable mortgage rate |
| FSR_2022_C1A_S1 | 5-year fixed mortgage rate | |
| FSR_2022_C1A_S2 | 5-year variable mortgage rate | |
| V80691333 | Conventional mortgage: 1-year | The interest rate for a 1-year conventional mortgage offered by chartered banks in Canada. |
| V80691334 | Conventional mortgage: 3-year | The interest rate for a 3-year conventional mortgage offered by chartered banks in Canada. |
| V80691335 | Conventional mortgage: 5-year | The interest rate for a 5-year conventional mortgage offered by chartered banks in Canada. |
| WM_SAN_BILO20181003_C1_S4 | 5-year mortgage rate (left scale) | Share of new mortgages with a loan-to-income ratio over 450 per cent |
| WM_SAN_FEUN20181109_C1_5Y-MR | 5-year mortgage rate | 5-year mortgage rate |
Not every series that turns up is still being updated. Many are one-off chart series from a particular Financial System Review or staff analytical note and stop when that publication did, so it is worth checking the range before building on one.
mortgage_rate_series$name %>%
get_boc_series() %>%
filter(!is.na(Date)) %>%
group_by(series, label) %>%
summarise(first = min(Date), last = max(Date), n = n(), .groups = "drop") %>%
arrange(desc(last)) %>%
knitr::kable()
#> Downloading BOC series data for BROKER_AVERAGE_5YR_VRM, FSR_2022_C1A_S1, FSR_2022_C1A_S2, V80691333, V80691334, V80691335, WM_SAN_BILO20181003_C1_S4, WM_SAN_FEUN20181109_C1_5Y-MR| series | label | first | last | n |
|---|---|---|---|---|
| BROKER_AVERAGE_5YR_VRM | Estimated variable mortgage rate | 2011-01-06 | 2026-08-20 | 812 |
| V80691333 | Conventional mortgage: 1-year | 1980-01-02 | 2026-08-19 | 2434 |
| V80691334 | Conventional mortgage: 3-year | 1980-01-02 | 2026-08-19 | 2434 |
| V80691335 | Conventional mortgage: 5-year | 1975-01-01 | 2026-08-19 | 2695 |
| FSR_2022_C1A_S1 | 5-year fixed mortgage rate | 2012-01-03 | 2022-06-07 | 545 |
| FSR_2022_C1A_S2 | 5-year variable mortgage rate | 2012-01-03 | 2022-06-07 | 545 |
| WM_SAN_FEUN20181109_C1_5Y-MR | 5-year mortgage rate | 1987-01-01 | 2018-09-01 | 381 |
| WM_SAN_BILO20181003_C1_S4 | 5-year mortgage rate (left scale) | 2014-01-01 | 2018-04-01 | 18 |
Taking a closer look at the two that are still current, the posted 5-year fixed rate and the estimated variable rate. The posted rate is what the chartered banks advertise rather than what borrowers actually pay, which is why it sits so far above the variable rate and moves in steps.
get_boc_series(c("BROKER_AVERAGE_5YR_VRM","V80691335")) %>%
ggplot(aes(x=Date,y=Value/100,colour=label)) +
geom_line() +
scale_y_continuous(labels=scales::percent) +
theme(legend.position = "bottom") +
labs(title="Mortgage rates",
x=NULL,y=NULL, colour=NULL,
caption="Source: Bank of Canada series BROKER_AVERAGE_5YR_VRM, V80691335")
#> Downloading BOC series data for BROKER_AVERAGE_5YR_VRM, V80691335
V80691335 reaches back to 1975, well before the variable
rate series starts in 2011, so restricting it to the shared window makes
the comparison easier to read.
get_boc_series(c("BROKER_AVERAGE_5YR_VRM","V80691335"), start_date="2011-01-01") %>%
ggplot(aes(x=Date,y=Value/100,colour=label)) +
geom_line() +
scale_y_continuous(labels=scales::percent) +
theme(legend.position = "bottom") +
labs(title="Mortgage rates since 2011",
x=NULL,y=NULL, colour=NULL,
caption="Source: Bank of Canada series BROKER_AVERAGE_5YR_VRM, V80691335")
#> Downloading BOC series data for BROKER_AVERAGE_5YR_VRM, V80691335
Dimensions
Not every Bank of Canada series is indexed by date. Each series
declares a dimension, most commonly Date but also
Category, Time or an auction identifier, and a
single series group can mix them. The dimension and
dimension_value columns carry the raw index, and
Date is filled in only where the dimension is a date.
get_boc_series_group("FSR_2024") %>%
count(dimension) %>%
knitr::kable()
#> Downloading BOC series group data for FSR_2024| dimension | n |
|---|---|
| Category | 96 |
| Date | 5314 |
Dates
Dates come from the API as the Bank of Canada reports them. Quarterly series are not dated consistently across the Bank’s holdings — most are dated to the first day of the quarter, some to the last, some to the first day of the quarter’s third month — so it is worth checking what a given series does before comparing it with another.
get_boc_series("INVESTMACHEQUIP", recent_years = 2) %>%
select(dimension_value, Date, Value) %>%
knitr::kable()
#> Downloading BOC series data for INVESTMACHEQUIP| dimension_value | Date | Value |
|---|---|---|
| 2024-10-01 | 2024-10-01 | 32 |
| 2025-01-01 | 2025-01-01 | 3 |
| 2025-04-01 | 2025-04-01 | 7 |
| 2025-07-01 | 2025-07-01 | 7 |
| 2025-10-01 | 2025-10-01 | 14 |
| 2026-01-01 | 2026-01-01 | 29 |
| 2026-04-01 | 2026-04-01 | 30 |
Where an observation arrives as a quarter marker such as
1998Q3 rather than a date it carries no day, and
quarter_convention picks one: "middle" (the
default), "start" or "end". The default can be
changed for a whole session with
options(canbank.quarter_convention = "start").