Bnmapi

Ruby wrapper for Bank Negara Malaysia Open API. Details and API disclaimer can be found here BNM Open API

Note: This gem is still in early development stages and not ready for use.

Installation

Add this line to your application's Gemfile:

gem 'bnmapi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bnmapi

Usage

Getting Started

(/welcome)

https://api.bnm.gov.my/portal#operation/Welcome

Getting started API which returns information and descriptions for BNM Open APi.

welcome = BnmAPI::Welcome.get

puts welcome.name
# BNM.API

puts welcome.api
# ['v1']

puts welcome.description
# displays API discription

puts welcome.disclaimer
# https://api.bnm.gov.my/disclaimer

puts welcome.contact_name
# BNM.API

puts welcome.contact_email
# oapi@bnm.gov.my

Base Rate/BLR/Effective LR

Current Base Rates and Base Lending Rates for retail loans or financing facilities and Indicative Effective Lending Rates for a standard housing loan/home financing offered by financial institutions.

(latest)

https://api.bnm.gov.my/portal#operation/BRLatest

Creates a list of bank information with base rate and base lending rates details.

collection = BnmAPI::BaseRate.latest

collection.size
# 35 (number of banks that the response return)

puts collection[0].bank_code
# BKKBMYKL

puts collection[0].bank_name
# Bangkok Bank Berhad

puts collection[0].base_rate
# 4.72

puts collection[0].base_financing_rate
# 7.37

puts collection[0].base_lending_rate
# 5.92

puts collection[0].last_updated.class
# DateTime

puts collection[0].last_updated.iso8601
# 2019-01-18T19:25:02+00:00

puts collection[0].effective_date.class
# Date

puts collection[0].effective_date.iso8601
# 2019-04-05

(by bank code)

https://api.bnm.gov.my/portal#operation/BRBankCode

bank = BnmAPI::BaseRate.by_bank_code('BKKBMYKL')

puts bank.bank_code
# BKKBMYKL

puts bank.bank_name
# Bangkok Bank Berhad

puts bank.base_rate
# 4.72

puts bank.base_lending_rate
# 7.37

puts bank.indicative_eff_lending_rate
# 5.92

puts bank.last_updated.class
# DateTime

puts bank.last_updated.iso8601
# 2019-01-18T19:25:02+00:00
# it returns and DateTime object

puts bank.effective_date.class
# Date

puts bank.effective_date.iso8601
# 2019-04-05
# it returns and Date object

Daily FX Turnover

Daily foreign exchange turnover for all currencies including interbank and customer deals

(latest)

https://api.bnm.gov.my/portal#operation/DFXTLatest

Get the latest FX turnover.

fx_turn_over = BnmAPI::DailyFXTurnover.latest

puts fx_turn_over.date.iso8601
# 2019-04-05
# it returns and Date object

puts fx_turn_over.total_sum
# 11.95

puts fx_turn_over.last_updated
# 2019-01-18T19:25:02+00:00
# it returns and DateTime object

(by date)

https://api.bnm.gov.my/portal#operation/DFXTDate

Get daily FX turnover for the date.

# by an initialize Date object
date = Date.parse('10-4-2019')
fx_turn_over = BnmAPI::DailyFXTurnover.by_date(date)

# from a string that can be parse to a date
fx_turn_over = BnmAPI::DailyFXTurnover.by_date('10-4-2019')

puts fx_turn_over.date.iso8601
# 2019-04-05
# it returns and Date object

puts fx_turn_over.total_sum
# 11.95

puts fx_turn_over.last_updated
# 2019-01-18T19:25:02+00:00
# it returns and DateTime object

(by year and month)

https://api.bnm.gov.my/portal#operation/DFXTMonth

Get the list of daily FX turnover for the month

fx_collection = BnmAPI::DailyFXTurnover.by_month(year: 2019, month: 4)

puts fx_collection[0].date.iso8601
# 2019-04-05
# it returns and Date object

puts fx_collection[0].total_sum
# 11.95

puts fx_collection[0].last_updated
# 2019-01-18T19:25:02+00:00
# it returns and DateTime object

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jibone/bnmapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Bnmapi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.