![](reference/figures/logo.png)

The goal of **bnmr** is to provide a set of convenient wrapper functions
for the Central Bank of Malaysia’s API.

## Installation

To install **bnmr**, run the following code (requires remotes):

``` r

# install.packages("remotes")
remotes::install_github("philip-khor/bnmr")
```

## Example

This is a basic example which shows you how to solve a common problem:

``` r

library(bnmr)
get_base_rate()
#> # A tibble: 35 × 6
#>    bank_code   bank_name                         base_…¹ base_…² indic…³ base_…⁴
#>    <chr>       <chr>                               <dbl>   <dbl>   <dbl>   <dbl>
#>  1 "AFFINBANK" Affin Bank                           2.7     5.56    3.3       NA
#>  2 "ALLIANCEB" Alliance Bank                        2.57    5.42    3.11      NA
#>  3 "AMBANK"    AmBank                               2.6     5.45    3.25      NA
#>  4 "BANGKOK"   Bangkok Bank Berhad                  3.22    5.87    4.42      NA
#>  5 "BANKCHINA" Bank of China (Malaysia) Berhad      2.55    5.35    3.55      NA
#>  6 "CIMB BANK" CIMB Bank Berhad                     2.75    5.6     3.5       NA
#>  7 "CITIBANK"  Citibank Berhad                      2.4     5.55    3.2       NA
#>  8 ""          Hong Leong Bank Malaysia Berhad      2.63    5.64    3.5       NA
#>  9 ""          HSBC Bank Malaysia Berhad            2.39    5.49    3.5       NA
#> 10 ""          Industrial and Commercial Bank o…    2.52    5.45    3.47      NA
#> # … with 25 more rows, and abbreviated variable names ¹​base_rate,
#> #   ²​base_lending_rate, ³​indicative_eff_lending_rate, ⁴​base_financing_rate
```

## License

This project is licensed under the terms of the MIT license.

# Package index

## Rates and Volumes

- [`get_usd_interbank_intraday_rate()`](https://bnmr.philipscurve.com/reference/forex_rates.md)
  [`get_kl_usd_reference_rate()`](https://bnmr.philipscurve.com/reference/forex_rates.md)
  : Interbank forex rates
- [`get_base_rate()`](https://bnmr.philipscurve.com/reference/get_base_rate.md)
  : Base Rates/BLR/Effective LR
- [`get_consumer_alert()`](https://bnmr.philipscurve.com/reference/get_consumer_alert.md)
  : Financial Consumer Alert
- [`get_daily_fx_turnover()`](https://bnmr.philipscurve.com/reference/get_daily_fx_turnover.md)
  : Daily Foreign Exchange Turnover
- [`get_exchange_rate()`](https://bnmr.philipscurve.com/reference/get_exchange_rate.md)
  : Exchange Rates: KL Interbank Foreign Exchange Market
- [`get_islamic_interbank_rate()`](https://bnmr.philipscurve.com/reference/get_interbank_rates.md)
  [`get_interest_volume()`](https://bnmr.philipscurve.com/reference/get_interbank_rates.md)
  [`get_interest_rate()`](https://bnmr.philipscurve.com/reference/get_interbank_rates.md)
  : Interbank money market/deposit rates and volume
- [`get_interbank_swap()`](https://bnmr.philipscurve.com/reference/get_interbank_swap.md)
  : Interbank Swap
- [`get_kijang_emas()`](https://bnmr.philipscurve.com/reference/get_kijang_emas.md)
  : Kijang Emas
- [`get_opr()`](https://bnmr.philipscurve.com/reference/get_opr.md) :
  Overnight Policy Rate (OPR)
- [`get_overnight_rate()`](https://bnmr.philipscurve.com/reference/get_overnight_rate.md)
  : Malaysia Overnight Rate - I
- [`get_renminbi()`](https://bnmr.philipscurve.com/reference/get_renminbi.md)
  : Renminbi

## Monthly Statistical Bulletin (MSB)

The following functions refer to statistics published in the Monthly
Statistical Bulletin.

### 

Monetary and banking system

- [`get_reserve_money()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_curr_in_circ_by_denom()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_monetary_agg()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_m3()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_m3_factors()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_bnm_stmt_assets()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_bnm_stmt_cap_lbl()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_bnm_special_funds()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_sys_stmt_assets()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_stmt_assets()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_sys_stmt_cap_lbl()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_stmt_cap_lbl()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_stry_lqa_req()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_liq_cov_rt()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_sys_const_cap()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_const_cap()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_cc_mas()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_sys_lf_ratio()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_inv()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_stmt_assets_inv()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_fin_inv_type()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_fin_inv_concept()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_fin_inv_purpose_sectors()`](https://bnmr.philipscurve.com/reference/msb1.md)
  [`get_islm_inv_maturity()`](https://bnmr.philipscurve.com/reference/msb1.md)
  : Monetary and banking system
- [`get_sys_deps_type()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_islm_deps_type_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_deps_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_dd_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_sav_fd_deps_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_repo_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_nid_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_fc_deps_holder()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  [`get_sys_fd_maturity()`](https://bnmr.philipscurve.com/reference/msb1_deposits.md)
  : Monetary and banking system: deposits
- [`get_sys_loans_appl_purpose()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_appl_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_apprv_purpose()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_apprv_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_disb_purpose()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_disb_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_repay_purpose()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_repay_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_class_type()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_islm_fin_class_type()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_islm_fin_class_concept()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_class_purpose()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_islm_fin_purpose_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_loans_class_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_npl_provisions()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_imp_fin_provisions()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_islm_imp_fin_provisions()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_npl_purpose()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  [`get_sys_npl_sector()`](https://bnmr.philipscurve.com/reference/msb1_loans.md)
  : Monetary and banking system: conventional loans and Islamic
  financing

### 

Financial and capital markets

- [`get_rates_banking()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_rates_islm_banking()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_rates_interbank_mm()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_rates_tbills()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_tbills_tender()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_rates_mgs()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_rates_myr()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_rates_myr_daily()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_volume_interbank_mm()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_volume_interbank_forex()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_cap_funds_public()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_cap_funds_private()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_bond_issues()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_bursa_indicators()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_futures_indicators()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_mm_turnover()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_deriv_turnover()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_debt_turnover()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_forex_turnover()`](https://bnmr.philipscurve.com/reference/msb2.md)
  [`get_net_financing()`](https://bnmr.philipscurve.com/reference/msb2.md)
  : Financial and capital markets

### 

External sector and macroeconomic indicators

- [`get_federal_finance()`](https://bnmr.philipscurve.com/reference/msb3.md)
  [`get_federal_revenue()`](https://bnmr.philipscurve.com/reference/msb3.md)
  [`get_federal_opex()`](https://bnmr.philipscurve.com/reference/msb3.md)
  [`get_federal_devex()`](https://bnmr.philipscurve.com/reference/msb3.md)
  [`get_federal_debt()`](https://bnmr.philipscurve.com/reference/msb3.md)
  [`get_rentas_foreign_debt_holdings()`](https://bnmr.philipscurve.com/reference/msb3.md)
  [`get_economic_indicators()`](https://bnmr.philipscurve.com/reference/msb3.md)
  : External sector and macroeconomic indicators
- [`get_aggregate_output()`](https://bnmr.philipscurve.com/reference/msb3_output.md)
  : External sector and macroeconomic indicators: aggregate output

### 

Insurance and takaful

### 

Other indicators

## Financial Inclusion

- [`get_financing_applied()`](https://bnmr.philipscurve.com/reference/financial_inclusion.md)
  [`get_financing_approved()`](https://bnmr.philipscurve.com/reference/financial_inclusion.md)
  : Financial Inclusion

## Payment statistics

- [`get_basic_payments()`](https://bnmr.philipscurve.com/reference/payments.md)
  [`get_epayment()`](https://bnmr.philipscurve.com/reference/payments.md)
  [`get_cards()`](https://bnmr.philipscurve.com/reference/payments.md)
  [`get_internet_banking()`](https://bnmr.philipscurve.com/reference/payments.md)
  [`get_eftpos()`](https://bnmr.philipscurve.com/reference/payments.md)
  : Payments

## Government Securities

## Islamic Interbank Money Market (IIMM)

## Bond Info Hub (BIH)

- [`get_market_highlights()`](https://bnmr.philipscurve.com/reference/get_market_highlights.md)
  : Market highlights

## Fully Automated System for Issuing/Tendering (FAST)

# Articles

### All vignettes

- [Using bnmr](https://bnmr.philipscurve.com/articles/using-bnmr.md):