banks-fx-scraper
v1.0.14
Published
Scrape exchange rates from Banks banks
Downloads
2
Maintainers
Readme
Banks Scraper
Scrape exchange rates from Egypt's banks and Asia Banks
Installation
npm install --save banks-fx-scraper
Getting Started
Require the package
var EGBScraper = require('banks-fx-scraper');
getExchangeRates
takes 3 arguments:
- banks array: list of banks codes to get its exchange rates
- currencies array: list of currencies iso code to get from the banks
- callback function: called when finished with the signature (err, data)
To get all banks with all currencies
EGBScraper.getExchangeRates([], [], (err, data) => {
// data
});
To get All banks with certain currencies
// Get only USD and EUR exchange rates from all banks
EGBScraper.getExchangeRates([], ['USD', 'EUR'], (err, data) => {
// data
});
To get All exchange rates in certain banks
EGBScraper.getExchangeRates(['NBG', 'CIB'], [], (err, data) => {
// data
});
To get the exchange rates for some currencies and some banks
EGBScraper.getExchangeRates(['NBG', 'CIB'], ['USD', 'EUR'], (err, data) => {
// data
});
Banks
Supported banks
| Code | Bank Name | | ---- | -------------------------------------- | | NBG | National Bank of Greece | | CAE | Credit Agricole | | CBE | Central Bank of Egypt | | NBE | National Bank of Egypt | | CIB | Commercial International Bank | | AAIB | Arab African International bank | | BDC | Banque Du Caire | | BM | Banque Misr | | SCB | Suez Canal Bank | | ABB | Al Baraka Bank | | ABK | Al Ahli bank of kuwait | | SAIB | Société Arabe Internationale de Banque | | MIDB | Misr Iran Development Bank | | UBE | The United Bank of Egypt | | EDBE | Export Development Bank of Egypt | | AB | Alex Bank | | EGB | Egyptian Gulf Bank | | ADIB | Abu Dhabi Islamic Bank | | FIBE | Faisal Islamic Bank Of Egypt | | BBE | Blom Bank Egypt | | HSBC | The Hongkong and Shanghai Banking Corporation Limited |
To support soon
- Mashreq bank
- Ahli United bank
- AIBK
- Housing and development bank
- Emirated NBD
- Arab Bank
- QNB AlAhli
- Bank Audi
- PBDAC
Development
available predefined NPM scripts.
Run them by typing this in your terminal: npm run [script]
| Name | Description |
| ---------- | ----------------------------------------------------- |
| lint
| Runs ESlint
on all files from ./src
and ./tests
|
| lint:fix
| Runs ESlint
and fixes all the inconsistencies |
| test
| Runs the tests with Mocha |
| test:dev
| Re-runs the tests whenever a change occurs |
| build
| Compiles all ES2015 files to ES5 (legacy code) |
| clean
| Removes the compiled files |
| start
| Run src/index.js using babel-node
NOTE: There is another script prepublish
that runs before you publish the package to NPM. All it does is to run clean
and build
.
Contributing
Before you submit a pull request, please take the following actions.
- Open an issue describing the contribution you would like to make
- Discuss until we all agree that your idea is useful for the project
- Create a pull request but make sure you follow the style guide and the tests pass
- Voila! You've done an amazing job.
Credits
- Andrei Canta for the work he has put into his npm-starter project
- Airbnb for the work they've put into the javascript style guide and into the ESlint package.
License
MIT @ Mohamed Mayla