sbp-exchange-rate — State Bank of Pakistan exchange rates for Node.js

Official State Bank of Pakistan (Pakistan) exchange rates in Node.js and TypeScript with the sbp-exchange-rate npm package: latest published table, any historical date, daily series. Zero dependencies, types included.

State Bank of Pakistan · Pakistan · home currency PKR · published every business day

Installation

npm install sbp-exchange-rate
# or
yarn add sbp-exchange-rate
pnpm add sbp-exchange-rate

The same code is also published under the org scope as @allratestoday/sbp-exchange-rate — identical versions, pick whichever naming fits your dependency policy. Zero runtime dependencies; ESM and CommonJS builds; TypeScript definitions included.

Quick start

You need a free API key from allratestoday.com/register — no credit card, and the latest State Bank of Pakistan table is on every plan.

import { getRate } from 'sbp-exchange-rate';

const pair = await getRate('USD', 'PKR', { apiKey: 'art_live_...' });
console.log(pair.rate, pair.rate_date);
// the official State Bank of Pakistan rate, on the central bank's own publication date

API reference

Four functions, all returning promises. Every function takes an options object with your apiKey; the package throws before making a request if it is missing.

getRate(source, target, options)

Free plan and up. One pair from the latest published table. Pairs State Bank of Pakistan does not print directly are resolved from its own table and flagged (see published vs derived).

const pair = await getRate('USD', 'PKR', { apiKey: 'art_live_...' });

// →
{
  bank: 'sbp',
  name: 'State Bank of Pakistan',
  rate_date: '2026-08-21',   // State Bank of Pakistan's own publication date
  source: 'USD',
  target: 'PKR',
  rate: 0.854774,
  rate_type: 'reference',
  derived: false,
  method: 'published',       // 'published' | 'inverse' | 'cross'
  disclaimer: '…'
}

getLatestRates(options)

Free plan and up. The complete table for the latest publication date — one call, every currency State Bank of Pakistan prints.

import { getLatestRates } from 'sbp-exchange-rate';

const table = await getLatestRates({ apiKey: 'art_live_...' });
console.log(table.rate_date, table.rates.length);

// →
{
  bank: 'sbp',
  name: 'State Bank of Pakistan',
  rate_date: '2026-08-21',
  rates: [
    { base: 'PKR', quote: 'USD', type: 'reference', value: 1.1699 },
    // … the rest of the published table
  ],
  disclaimer: '…'
}

getRatesForDate(date, options)

Paid plans. The official table for any past date. Weekends and holidays return the most recent published table, flagged via published_on_requested_date — exactly the in-force rate a filing or invoice needs. Pass source/target in the options to narrow to one pair.

import { getRatesForDate } from 'sbp-exchange-rate';

const day = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...' });
const one = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...', source: 'USD', target: 'PKR' });

// →
{
  bank: 'sbp',
  requested_date: '2026-06-30',
  rate_date: '2026-06-30',              // the date actually published
  published_on_requested_date: true,    // false when a weekend/holiday fell back
  rates: [ /* the full table for that date */ ],
  disclaimer: '…'
}

getHistory(query, options)

Paid plans. One resolved rate per publication date across a range — for charts, revaluation runs or audit workpapers. Pass { symbol: 'USD' } instead of source/target to get the raw published rows for one currency.

import { getHistory } from 'sbp-exchange-rate';

const series = await getHistory(
  { source: 'USD', target: 'PKR', from: '2026-01-01', to: '2026-08-21' },
  { apiKey: 'art_live_...' }
);

// →
{
  bank: 'sbp',
  source: 'USD',
  target: 'PKR',
  from: '2026-01-01',
  to: '2026-08-21',
  count: 152,
  rates: [
    { date: '2026-08-21', rate: 0.854774, rate_type: 'reference', derived: false, method: 'published' },
    // … one entry per publication date
  ],
  disclaimer: '…'
}

Published vs derived rates

If State Bank of Pakistan does not print a pair directly, the API resolves it from the central bank's own table and says so — official and computed values are never mixed:

Error handling

Errors are thrown as Error with status (HTTP code) and body (the API's JSON error) attached:

try {
  const pair = await getRate('USD', 'XXX', { apiKey: 'art_live_...' });
} catch (err) {
  console.log(err.message); // human-readable reason
  console.log(err.status);  // e.g. 404
}

TypeScript and CommonJS

Full definitions ship with the package — no @types install:

import type { LatestRates, PairRate, DatedRates, RateEntry, HistoryQuery, RequestOptions } from 'sbp-exchange-rate';

CommonJS works too:

const { getRate } = require('sbp-exchange-rate');

getRate('USD', 'PKR', { apiKey: 'art_live_...' }).then((pair) => console.log(pair.rate));

Quota tips

• State Bank of Pakistan publishes every business day — cache the table locally and a small monthly quota goes a long way.
• Every request counts toward your AllRatesToday quota, shared across all endpoints on your key.
• Prefer getLatestRates (one call, whole table) over many getRate calls when you need several pairs.

Under the hood

The package is a thin, dependency-free wrapper over the REST endpoints documented on the State Bank of Pakistan rates page:

GET /api/v1/central-bank/sbp/latest?source=USD&target=PKR
GET /api/v1/central-bank/sbp/latest
GET /api/v1/central-bank/sbp/2026-06-30
GET /api/v1/central-bank/sbp/history?source=USD&target=PKR&from=2026-01-01&to=2026-08-21

Same data is available as CSV/XLSX downloads on the no-code download page, and to AI agents via the MCP server.

FAQ

Related