bnm-exchange-rate 1.2.2 → 1.3.1

package/README.md

@@ -1,4 +1,4 @@
-# Bank Negara Malaysia Exchange Rate API — bnm-exchange-rate
+# Bank Negara Malaysia Exchange Rates API — bnm-exchange-rate
 
 [![npm version](https://img.shields.io/npm/v/bnm-exchange-rate.svg)](https://www.npmjs.com/package/bnm-exchange-rate)
 [![license](https://img.shields.io/npm/l/bnm-exchange-rate.svg)](https://github.com/AllRates-Today/bnm-exchange-rate/blob/main/LICENSE)
@@ -18,6 +18,21 @@
 
 > **Official rate, not mid-market:** every value here is a number Bank Negara Malaysia itself published, fixed once printed and carrying the central bank's own `rate_date` — what filings and audits require. Need the live interbank midpoint for pricing or display instead? Use the [mid-market API](https://allratestoday.com/docs/) or [`@allratestoday/sdk`](https://www.npmjs.com/package/@allratestoday/sdk). The two can diverge by several percent.
 
+## ⚡ Try it without a key
+
+The latest Bank Negara Malaysia table is also served keyless, CORS-open and edge-cached, for evaluation, embeds and AI agents:
+
+```bash
+curl "https://allratestoday.com/api/open/central-bank/bnm?source=USD&target=MYR"
+```
+
+```js
+const r = await fetch('https://allratestoday.com/api/open/central-bank/bnm').then((x) => x.json());
+console.log(r.rate_date, r.rates.length); // the central bank's latest published table, no key
+```
+
+The open endpoint serves the *latest* table only and asks for a visible attribution link. The client below uses the keyed API, which adds point-in-time tables, history, and CSV/XML/Excel output.
+
 ## 🔑 Get your API key
 
 Get a free API key at [allratestoday.com/register](https://allratestoday.com/register) — no credit card required. Latest rates are on every plan, including free.
@@ -36,7 +51,7 @@ yarn add bnm-exchange-rate
 pnpm add bnm-exchange-rate
 ```
 
-Also published under the org scope as [`@allratestoday/bnm-exchange-rate`](https://www.npmjs.com/package/@allratestoday/bnm-exchange-rate) — same code, same versions.
+Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Also published under the org scope as [`@allratestoday/bnm-exchange-rate`](https://www.npmjs.com/package/@allratestoday/bnm-exchange-rate) — same code, same versions.
 
 ## 🏁 Quick start
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'MYR', { apiKey: 'art_live_...' });
 {
   bank: 'bnm',
   name: 'Bank Negara Malaysia',
-  rate_date: '2026-08-11',   // Bank Negara Malaysia's own publication date
+  rate_date: '2026-09-09',   // Bank Negara Malaysia's own publication date
   source: 'USD',
   target: 'MYR',
-  rate: 4.0925,
+  rate: 4.07,
   rate_type: 'middle',
   derived: false,
   method: 'published',
-  disclaimer: '…'
+  disclaimer: 'Official rates as published by the named central bank. On weekends/holidays the most recent published rate_date is returned.'
 }
 ```
 
@@ -98,9 +113,9 @@ console.log(table.rate_date, table.rates.length);
 {
   bank: 'bnm',
   name: 'Bank Negara Malaysia',
-  rate_date: '2026-08-11',
+  rate_date: '2026-09-09',
   rates: [
-    { "base": "USD", "quote": "MYR", "type": "middle", "value": 4.0925 },
+    { "base": "USD", "quote": "MYR", "type": "middle", "value": 4.07 },
     // … the rest of the published table (27 currencies vs MYR)
   ],
   disclaimer: '…'
@@ -140,7 +155,7 @@ Paid plans. One resolved rate per publication date — ready for charting, reval
 import { getHistory } from 'bnm-exchange-rate';
 
 const series = await getHistory(
-  { source: 'USD', target: 'MYR', from: '2026-01-01', to: '2026-08-11' },
+  { source: 'USD', target: 'MYR', from: '2026-01-01', to: '2026-09-09' },
   { apiKey: 'art_live_...' }
 );
 ```
@@ -153,11 +168,11 @@ const series = await getHistory(
   source: 'USD',
   target: 'MYR',
   from: '2026-01-01',
-  to: '2026-08-11',
+  to: '2026-09-09',
   count: 152,
   rates: [
     // one entry per publication date
-    { date: '2026-08-11', rate: 4.0925, rate_type: 'middle', derived: false, method: 'published' },
+    { date: '2026-09-09', rate: 4.07, rate_type: 'middle', derived: false, method: 'published' },
     // …
   ],
   disclaimer: '…'
@@ -170,9 +185,42 @@ Pass `{ symbol: 'USD' }` instead of `source`/`target` to get the raw published r
 
 ## 🗺️ Currencies covered
 
-Bank Negara Malaysia currently publishes rates covering **28 currencies** (as of the latest table):
+Bank Negara Malaysia currently publishes rates covering **27 currencies** against the MYR (as of the latest table):
+
+🇦🇪 `AED` · 🇦🇺 `AUD` · 🇧🇳 `BND` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇪🇬 `EGP` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇭🇰 `HKD` · 🇮🇩 `IDR` · 🇮🇳 `INR` · 🇯🇵 `JPY` · 🇰🇭 `KHR` · 🇰🇷 `KRW` · 🇲🇲 `MMK` · 🇳🇵 `NPR` · 🇳🇿 `NZD` · 🇵🇭 `PHP` · 🇵🇰 `PKR` · 🇸🇦 `SAR` · 🇸🇬 `SGD` · 🇹🇭 `THB` · 🇹🇼 `TWD` · 🇺🇸 `USD` · 🇻🇳 `VND` · `XDR`
+
+## 🏛️ Source
+
+Bank Negara Malaysia is Malaysia's central bank. It publishes ringgit exchange rates from the Kuala Lumpur interbank market each business day, with the 12:00 noon middle rate serving as the standard official reference in Malaysia.
+
+- Publisher's own page: [Exchange rates](https://www.bnm.gov.my/exchange-rates) · [www.bnm.gov.my](https://www.bnm.gov.my)
+- Publication: every business day; the exact schedule, freshness status and any current delay are on the [Bank Negara Malaysia rates page](https://allratestoday.com/central-bank-rates-api/bnm/)
+- Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-methodology/)
 
-`AED` · `AUD` · `BND` · `CAD` · `CHF` · `CNY` · `EGP` · `EUR` · `GBP` · `HKD` · `IDR` · `INR` · `JPY` · `KHR` · `KRW` · `MMK` · `MYR` · `NPR` · `NZD` · `PHP` · `PKR` · `SAR` · `SGD` · `THB` · `TWD` · `USD` · `VND` · `XDR`
+## 🧭 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).
+- Bank Negara Malaysia quotes **MYR per 1 unit of foreign currency** (e.g. `base: "USD", quote: "MYR"` means MYR 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 (`middle` here); some publishers print buy/sell or several fixings for the same pair.
+
+## 🧩 ERP & accounting systems
+
+Loading the official Bank Negara Malaysia 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](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code
+- [Xero](https://allratestoday.com/docs/integrations/xero/) · [QuickBooks Online](https://allratestoday.com/docs/integrations/quickbooks/) · [SAP S/4HANA and ECC](https://allratestoday.com/docs/integrations/sap/) · [Odoo](https://allratestoday.com/docs/integrations/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:
+
+```bash
+curl "https://allratestoday.com/api/v1/central-bank/bnm/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
+- Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)
 
 ## ⚖️ Published vs derived rates
 
@@ -236,11 +284,20 @@ getRate('USD', 'MYR', { apiKey: 'art_live_...' }).then((pair) => console.log(pai
 | `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 2020 |
 
+## 📥 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: [AllRates/central-bank-exchange-rates](https://huggingface.co/datasets/AllRates/central-bank-exchange-rates) — one CSV per institution (`rates/bnm.csv`)
+- Kaggle: [allratestoday/central-bank-exchange-rates](https://www.kaggle.com/datasets/allratestoday/central-bank-exchange-rates)
+- CDN JSON: `https://cdn.jsdelivr.net/gh/AllRates-Today/central-bank-exchange-rates@main/data/bnm/latest.json`
+
 ## 🔗 Links
 
 - [Bank Negara Malaysia rates page](https://allratestoday.com/central-bank-rates-api/bnm/) — live table, publication cadence, FAQ
 - [All central bank sources](https://allratestoday.com/central-bank-rates-api/)
-- [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/)
+- [Package docs on the site](https://allratestoday.com/docs/sdk/bnm-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)
+- [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)
 - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
 - [GitHub](https://github.com/AllRates-Today/bnm-exchange-rate)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnm-exchange-rate",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "description": "Official Bank Negara Malaysia (Malaysia) daily exchange rates — 27 currencies vs MYR, history since 2020. Zero-dependency Node.js/TypeScript client.",
   "keywords": [
     "bnm",