Hong Kong Monetary Authority Exchange Rates API — hkma-exchange-rate

Official Hong Kong Monetary Authority (Hong Kong) daily exchange rates for Node.js and TypeScript. The published central bank rates behind tax filings, customs valuations, audits, and compliant invoicing — not market estimates, but the numbers Hong Kong Monetary Authority itself prints, every business day.

🚀 Why this client?

• 🏛️ Official published rates — Hong Kong Monetary Authority's own table, with the publisher's own rate_date on every response
• 📅 History back to 1981 — point-in-time tables and daily series for any past date
• 🔀 Published vs derived, always flagged — computed inverse/cross pairs carry derived: true, never mixed with official prints
• ⚡ Zero dependencies — pure ESM + CJS over global fetch; Node 18+, Bun, Deno, and edge runtimes
• 🔷 Type-safe — full TypeScript definitions shipped with the package
• 🧾 Compliance-grade metadata — rate_type, publication date, and source disclaimer on every response

Official rate, not mid-market: every value here is a number Hong Kong Monetary Authority itself published, fixed once printed and carrying the central bank's own rate_date — what filings and audits require. Need the live mid-market rate for pricing or display instead? Use the mid-market API or @allratestoday/sdk. The two can diverge by several percent.

🔑 Get your API key

Get a free API key at allratestoday.com/register — no credit card required. Latest rates are on every plan, including free.

📈 Latest published table

The image is rendered live from the keyless endpoint, so it follows the central bank's publications on npm and on GitHub alike without a new release. The same table as text is folded below for search and copy-paste: on GitHub a daily Action refreshes it whenever the central bank publishes a new table; on npm it is as of the package's publish date.

Base	Quote	Type	Rate
AUD	HKD	reference	5.473
CAD	HKD	reference	5.532
CHF	HKD	reference	9.416
CNY	HKD	reference	1.17025
EUR	HKD	reference	8.907
GBP	HKD	reference	10.4025
IDR	HKD	reference	0.0004391
INR	HKD	reference	0.0815
JPY	HKD	reference	0.05004
KRW	HKD	reference	0.005799
MYR	HKD	reference	1.92245
PHP	HKD	reference	0.1285
SGD	HKD	reference	6.1455
THB	HKD	reference	0.23425
TWD	HKD	reference	0.246
USD	HKD	reference	7.847
ZAR	HKD	reference	0.479

Source: Official rates published by HKMA, served by AllRatesToday. Rates are as printed by the central bank; AllRatesToday is not affiliated with it.

📦 Installation

npm install hkma-exchange-rate

yarn add hkma-exchange-rate

pnpm add hkma-exchange-rate

Requires Node 18+ (global fetch); also runs on Bun, Deno and edge runtimes. Also published under the org scope as @allratestoday/hkma-exchange-rate — same code, same versions.

🏁 Quick start

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

const pair = await getRate('USD', 'HKD', { apiKey: 'art_live_...' });
console.log(pair.rate, pair.rate_date); // the official Hong Kong Monetary Authority rate, on the central bank's own date

📚 API reference

• Latest pair rate — one pair from the latest published table
• Full published table — everything the central bank printed, in one call
• Table for a date — the official table for an invoice or filing date
• Daily time series — one pair across a date range

---

Latest pair rate

Free plan and up. Pairs the central bank does not print directly are resolved from its table and flagged (see Published vs derived rates below).

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

Response:

{
  bank: 'hkma',
  name: 'Hong Kong Monetary Authority',
  rate_date: '2026-08-31',   // Hong Kong Monetary Authority's own publication date
  source: 'USD',
  target: 'HKD',
  rate: 7.839,
  rate_type: 'reference',
  derived: false,
  method: 'published',
  disclaimer: 'Official rates as published by the named central bank. On weekends/holidays the most recent published rate_date is returned.'
}

Full published table

Free plan and up. The complete table for the latest publication date.

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

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

Response:

{
  bank: 'hkma',
  name: 'Hong Kong Monetary Authority',
  rate_date: '2026-08-31',
  rates: [
    { "base": "USD", "quote": "HKD", "type": "reference", "value": 7.839 },
    // … the rest of the published table (17 currencies vs HKD)
  ],
  disclaimer: '…'
}

Table for a date

Paid plans. The official table for any date since 1981 — weekends and holidays return the most recent published date, flagged via published_on_requested_date, which is exactly the in-force rate a filing needs.

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

const day = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...' });
// Optionally narrow to one pair:
const one = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...', source: 'USD', target: 'HKD' });

Response:

{
  bank: 'hkma',
  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: '…'
}

Daily time series

Paid plans. One resolved rate per publication date — ready for charting, revaluation runs, or audit workpapers.

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

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

Response:

{
  bank: 'hkma',
  source: 'USD',
  target: 'HKD',
  from: '2026-01-01',
  to: '2026-08-31',
  count: 152,
  rates: [
    // one entry per publication date
    { date: '2026-08-31', rate: 7.839, rate_type: 'reference', derived: false, method: 'published' },
    // …
  ],
  disclaimer: '…'
}

Pass { symbol: 'USD' } instead of source/target to get the raw published rows for one currency (all rate types, no pair resolution).

---

🗺️ Currencies covered

Hong Kong Monetary Authority currently publishes rates covering 17 currencies against the HKD (as of the latest table):

🇦🇺 AUD · 🇨🇦 CAD · 🇨🇭 CHF · 🇨🇳 CNY · 🇪🇺 EUR · 🇬🇧 GBP · 🇮🇩 IDR · 🇮🇳 INR · 🇯🇵 JPY · 🇰🇷 KRW · 🇲🇾 MYR · 🇵🇭 PHP · 🇸🇬 SGD · 🇹🇭 THB · 🇹🇼 TWD · 🇺🇸 USD · 🇿🇦 ZAR

🏛️ Source

The Hong Kong Monetary Authority is Hong Kong's central banking institution and operator of the Linked Exchange Rate System that pegs the Hong Kong dollar to the US dollar. Its open data API publishes daily Hong Kong dollar exchange rates for around 19 currencies.

• Publisher's own page: Monthly Statistical Bulletin — daily exchange rates · www.hkma.gov.hk
• Publication: every business day; the exact schedule, freshness status and any current delay are on the Hong Kong Monetary Authority rates page
• Values are stored unmodified, with the publisher's own rate_date on every row — see the methodology

🧭 Reading the numbers

• value is always quote currency per 1 unit of base currency (base: "EUR", quote: "USD", value: 1.15 means 1 EUR = 1.15 USD).
• Hong Kong Monetary Authority quotes HKD per 1 unit of foreign currency (e.g. base: "USD", quote: "HKD" means HKD per one US dollar).
• Need the other way round? Ask getRate(target, source) and the API inverts or crosses for you, flagged derived: true — never divide a published rate yourself in a compliance workflow.
• rate_type tells you which of the central bank's series a row belongs to (reference here); some publishers print buy/sell or several fixings for the same pair.

🧩 ERP & accounting systems

Loading the official Hong Kong Monetary Authority rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:

• Dynamics 365 Business Central — built-in Currency Exchange Rate Service, no code
• Xero · QuickBooks Online · SAP S/4HANA and ECC · Odoo

The same keyed endpoints return ?format=csv, ?format=xml and ?format=xlsx, and accept the key as ?api_key= on the URL for importers that cannot send headers:

curl "https://allratestoday.com/api/v1/central-bank/hkma/latest?format=xml&api_key=art_live_..."

🤖 AI agents

• MCP server: npx -y @allratestoday/central-bank-mcp (stdio) or the hosted endpoint https://allratestoday.com/api/mcp — tools for official rates, history, cross-bank comparison and publication calendars
• Already using the general SDK or MCP server? Since 2026-10-01 @allratestoday/sdk 1.4+ has officialRates('hkma') and @allratestoday/mcp-server 0.6+ has a get_official_rates tool — both return this source's latest table with no key, so you can add it without a second dependency
• Claude Code plugin (no key): /plugin marketplace add AllRates-Today/claude-code-plugin then /plugin install allratestoday@allratestoday — bundles both MCP servers plus an /official-rate hkma ... command
• Evaluating? Agents can self-issue a trial key with no signup: POST https://allratestoday.com/api/agent/keys (send Content-Type: application/json) returns a 100-call key valid 7 days that covers the free-plan methods (latest table, pairs); dated tables and history need a paid plan. The MCP servers expose it as request_trial_key
• Machine-readable site guide: llms.txt · for-ai-agents

⚖️ Published vs derived rates

If Hong Kong Monetary Authority 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 confused:

method	derived	Meaning
published	false	The central bank printed this pair directly
inverse	true	Computed as 1 ÷ the published opposite direction
cross	true	Computed via HKD from two published rates

🛡️ 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
}

Status	Meaning
—	Missing apiKey (thrown before any request)
400	Malformed date or parameters
401	Invalid API key
403	Endpoint needs a paid plan (historical dates & series)
404	Pair or date range not covered by Hong Kong Monetary Authority
429	Monthly quota exceeded

🔷 TypeScript

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

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

📦 CommonJS

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

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

💡 Quota tips

• Rates change once per business day — cache the published table locally and a small monthly quota goes a long way.
• Every request counts toward your AllRatesToday quota, shared across all AllRatesToday endpoints on your key.

📖 Methods reference

Method	Plan	Description
getRate(source, target, { apiKey })	Free	Latest rate for one pair, resolved from the published table
getLatestRates({ apiKey })	Free	The central bank's full latest published table
getRatesForDate(date, { apiKey, source?, target? })	Paid	The official table (or one pair) for a YYYY-MM-DD date
getHistory({ symbol | source+target, from?, to? }, { apiKey })	Paid	Daily series since 1981

📥 Bulk data (no key)

Need the whole archive rather than an API call? The same published tables are mirrored daily as open data:

• Hugging Face: AllRatesToday/central-bank-exchange-rates — one CSV per institution (rates/hkma.csv)
• Kaggle: allratestoday/central-bank-exchange-rates
• Raw JSON on GitHub: https://raw.githubusercontent.com/AllRates-Today/central-bank-exchange-rates/main/data/hkma/latest.json

🔗 Links

• Website: allratestoday.com
• Hong Kong Monetary Authority rates page — live table, publication cadence, FAQ
• All central bank sources
• Download central bank rates — every bank's latest table and history as Excel, CSV or JSON
• Package docs on the site · ERP integration guides
• API documentation · Interactive reference · Methodology
• Register (Free) · Dashboard · Pricing
• Status
• Postman collection
• ChatGPT app — ask ChatGPT for live and official central bank rates
• GitHub

📜 License

MIT