Introduction

Getting Started

Finmarks ships as a zero-dependency npm package. The entire dataset is bundled inline — no runtime fetch, no env vars, no loader config. Install and import.

Installation

Install with your package manager of choice:

The package ships ESM and CJS builds with TypeScript declarations.

Your first query

Look up an entity and get its logo URL:

import { getEntity, getLogoUrl } from 'Finmarks';

const hdfc = getEntity('hdfc-bank');

hdfc?.name;          // 'HDFC Bank'
hdfc?.brand_color;   // '#004C8F'
hdfc?.ifsc_prefix;   // 'HDFC'
hdfc?.upi_handles;   // ['@hdfcbank', '@okhdfcbank']

getLogoUrl('hdfc-bank');          // full logo CDN URL
getLogoUrl('hdfc-bank', 'icon');   // icon variant

Resolve identifiers you have at runtime

If you have an IFSC code or UPI VPA from a payment flow, you can go straight to the brand without any lookup table of your own:

import { getByIfscPrefix, getByUpiHandle } from 'Finmarks';

// First 4 characters of any IFSC code → Bank
getByIfscPrefix('HDFC0000123'.slice(0, 4));  // → HDFC Bank

// Full VPA, @-prefixed, or bare handle
getByUpiHandle('someone@ybl');   // → PhonePe (YBL = Yes Bank for PhonePe)
getByUpiHandle('@okaxis');       // → Google Pay

Without npm

You can hotlink logos directly from jsDelivr — no account, no API key, no rate limit. Assets are served from the same repository as the npm package, so they are always in sync.

<img src="https://cdn.jsdelivr.net/gh/Finmarks/Finmarks@main/entities/hdfc-bank/icon.svg" width="32" />

The generated index is also fetchable:

curl https://cdn.jsdelivr.net/gh/Finmarks/Finmarks@main/dist/index.json

Requirements

• Node.js 18+ (for the npm package)
• TypeScript 5+ (optional, but types are included)
• Any modern browser (for CDN hotlinks)