API Documentation

Use our API to access the full collection of logos for your projects.

Overview

The Nigerian Bank Logos (NBL) API provides RESTful access to a comprehensive collection of brand logos from the Nigerian financial sector, including banks, fintech, and other financial institutions.

Usage Guidelines

The API is public and does not require authentication. To ensure fair usage and prevent abuse, we have implemented rate limiting on requests.

Please do not use this API to replicate the core functionality of this project. It is intended for building extensions, plugins, and other creative tools for the community.

TypeScript Definitions

The following interfaces describe the structure of logo and category objects returned by the API:

interface ILogo {
  id?: string;
  order?: number;  
  title: string;
  categories: TCategory[];
  route: string;
  url: string;
  ticker?: string;
}

export interface ICategory {
  category: string;
  slug: string;
  total: number;
}

// TCategory is a union of all possible category strings

Base URL

All API routes are prefixed with the following base URL:

https://api.nigerianbanklogos.xyz

Endpoints

GET

Get all logos

Retrieve a list of all logos in the collection.

Example Request:

https://api.nigerianbanklogos.xyz

Example Response:

[
  {
    "id": "e9865d2f-bbc6-4058-a70d-b233385892e4",
    "order": 1,
    "title": "Access Bank",
    "categories": ["Bank"],
    "route": "https://nbl.xyz/library/access-bank.svg",
    "url": "https://www.accessbankplc.com/",
    "ticker": "ACCESS"
  },
  // ...
]

GET

Get limited number of logos

Limit the number of logos returned from the collection. The query starts from the first logo.

Example Request:

https://api.nigerianbanklogos.xyz?limit=10

Example Response:

[
  {
    "id": "e9865d2f-bbc6-4058-a70d-b233385892e4",
    "order": 1,
    "title": "Access Bank",
    "categories": ["Bank"],
    "route": "https://nbl.xyz/library/access-bank.svg",
    "url": "https://www.accessbankplc.com/",
    "ticker": "ACCESS"
  },
  // ... 9 more logos
]

GET

Filter logos by category

Retrieve all logos belonging to a specific category (e.g., `fintech`, `ngx-listed`).

Example Request:

https://api.nigerianbanklogos.xyz/category/fintech

Example Response:

[
  {
    "id": "e9865d2f-bbc6-4058-a70d-b233385892e4",
    "order": 99,
    "title": "Paystack",
    "categories": ["Fintech", "Payment Gateway"],
    "route": "https://nbl.xyz/library/paystack.svg",
    "url": "https://paystack.com/"
  }
]

GET

Get only categories

Returns all available categories with the number of logos in each category.

Example Request:

https://api.nigerianbanklogos.xyz/categories

Example Response:

[
  {
    "category": "Bank",
    "slug": "bank",
    "total": 25
  },
  {
    "category": "Fintech",
    "slug": "fintech",
    "total": 12
  }
]

GET

Search logos by query

Search for logos based on a name, ticker, or other keywords.

Example Request:

https://api.nigerianbanklogos.xyz/search?q=gtco

Example Response:

[
  {
    "title": "GTCO",
    "categories": ["Bank", "NGX-Listed"],
    "route": "https://nbl.xyz/library/gtco.svg",
    "url": "https://www.gtcoplc.com/"
  }
]