https://github.com/imadarchid/bkam-wrapper
A Node.js wrapper for Bank Al-Maghrib's API
https://github.com/imadarchid/bkam-wrapper
bank-al-maghrib nodejs wrapper-api
Last synced: 2 months ago
JSON representation
A Node.js wrapper for Bank Al-Maghrib's API
- Host: GitHub
- URL: https://github.com/imadarchid/bkam-wrapper
- Owner: imadarchid
- Created: 2020-03-30T16:52:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T01:09:52.000Z (about 2 years ago)
- Last Synced: 2025-10-01T02:31:10.101Z (6 months ago)
- Topics: bank-al-maghrib, nodejs, wrapper-api
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bkam-wrapper
> A Node.js wrapper for Bank Al-Maghrib's API
This might help you get data from BKAM's API in your node.js apps easily. Make sure to register on the [Developer's portal](https://apihelpdesk.centralbankofmorocco.ma/) to get access to your API keys & take a look at the documentation.
For now only two products are offered: Currency Exchange Rates & Treasury Bonds reference interest rates
## Install
[npm][]:
```sh
npm install bkam-wrapper
```
## Usage
```js
const bkamWrapper = require('bkam-wrapper');
// Include your API keys from BKAM developer account
const getData = new bkamWrapper({
currency_key: YOUR_CURRENCY_KEY,
bonds_key: YOUR_BONDS_KEY
})
```
### Methods
- **Getting currency exchange rates - Banknotes**
```js
getData.getCoursBBE(options)
```
options: libDevise: _String_, optional | date: _String_, optional
- **Getting currency exchange rates - Transfers**
```js
getData.getCoursVIR(options)
```
options: libDevise: _String_, optional | date: _String_, optional
- **Getting reference interest rate of TBs data**
```js
getData.getCourbeBDT(options)
```
options: dateCourbe: _String_, optional
## Contribute & Future Work
You're welcome to contribute or open issues to improve the code! It should be easy to adapt this project if new products are offered by Bank Al Maghrib's API.
_P.S: I am still learning, feel free to contact me if something needs to be improved in the project!_