nigeria-banks
v1.0.2
Published
A comprehensive list of Nigerian banks, including commercial, microfinance, digital banks, and payment service providers.
Downloads
26
Maintainers
Readme
🇳🇬 Nigeria Banks List
A comprehensive list of Nigerian banks, including commercial banks, microfinance banks, digital banks, and payment service providers — with utility functions for easy integration into your applications.
✨ Features
- 🏦 Full list of banks with standardized names and codes
- 🔍 Utility functions: get all banks, search by code, or search by name
- 🌐 Includes traditional, digital, and fintech banks (Kuda, OPay, PalmPay, and more)
- 💼 Ideal for developers building applications in the Nigerian financial ecosystem
📦 Installation
Install the package from NPM:
npm install nigeria-banks
Or install from a local folder (during development):
npm install /path/to/nigeria-banks
🚀 Usage
1. Import the Package
import { getBanks, findBankByCode, findBankByName } from 'nigeria-banks';
2. Get All Banks
const allBanks = getBanks();
console.log(allBanks);
Returns an array of all Nigerian banks:
[
{ name: "Access Bank", code: "044" },
{ name: "Zenith Bank", code: "057" },
{ name: "Kuda Bank", code: "900" },
// ...
]
3. Find a Bank by Code
const bank = findBankByCode("044");
console.log(bank);
Returns:
{ name: "Access Bank", code: "044" }
4. Find a Bank by Name
const bank = findBankByName("Access Bank");
console.log(bank);
Returns:
{ name: "Access Bank", code: "044" }
🛠 Development
1. Clone the Repository
git clone https://github.com/kennyendowed/nigeria_banks.git
cd nigeria_banks
2. Install Dependencies
npm install
3. Build the Project
npm run build
This compiles the TypeScript source into the dist/ directory for publishing or use.
🧾 License
This project is licensed under the MIT License.
🤝 Contribution
Contributions are welcome! Please follow these steps:
Fork the repository
Create a new branch
Make your changes
Submit a pull request (PR)
📬 Contact
Maintained by @kennyendowed
---
Let me know if you'd like badges added to the top (e.g., `npm version`, `license`, or GitHub stars).
