boz-exchange-rate 1.3.0 → 1.3.3

package/README.md

@@ -1,4 +1,4 @@
-# Bank of Zambia Exchange Rate API — boz-exchange-rate
+# Bank of Zambia Exchange Rates API — boz-exchange-rate
 
 [![npm version](https://img.shields.io/npm/v/boz-exchange-rate.svg)](https://www.npmjs.com/package/boz-exchange-rate)
 [![license](https://img.shields.io/npm/l/boz-exchange-rate.svg)](https://github.com/AllRates-Today/boz-exchange-rate/blob/main/LICENSE)
@@ -16,7 +16,22 @@
 - 🔷 **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 Bank of Zambia 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.
+> **Official rate, not mid-market:** every value here is a number Bank of Zambia 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](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 of Zambia 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/boz?source=USD&target=ZMW"
+```
+
+```js
+const r = await fetch('https://allratestoday.com/api/open/central-bank/boz').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
 
@@ -36,7 +51,7 @@ yarn add boz-exchange-rate
 pnpm add boz-exchange-rate
 ```
 
-Also published under the org scope as [`@allratestoday/boz-exchange-rate`](https://www.npmjs.com/package/@allratestoday/boz-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/boz-exchange-rate`](https://www.npmjs.com/package/@allratestoday/boz-exchange-rate) — same code, same versions.
 
 ## 🏁 Quick start
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'ZMW', { apiKey: 'art_live_...' });
 {
   bank: 'boz',
   name: 'Bank of Zambia',
-  rate_date: '2026-09-09',   // Bank of Zambia's own publication date
+  rate_date: '2026-09-25',   // Bank of Zambia's own publication date
   source: 'USD',
   target: 'ZMW',
-  rate: 19.2646,
+  rate: 19.5,
   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,11 +113,11 @@ console.log(table.rate_date, table.rates.length);
 {
   bank: 'boz',
   name: 'Bank of Zambia',
-  rate_date: '2026-09-09',
+  rate_date: '2026-09-25',
   rates: [
-    { "base": "USD", "quote": "ZMW", "type": "middle", "value": 19.2646 },
-    { "base": "USD", "quote": "ZMW", "type": "sell", "value": 19.2896 },
-    { "base": "USD", "quote": "ZMW", "type": "buy", "value": 19.2396 },
+    { "base": "USD", "quote": "ZMW", "type": "middle", "value": 19.5 },
+    { "base": "USD", "quote": "ZMW", "type": "sell", "value": 19.525 },
+    { "base": "USD", "quote": "ZMW", "type": "buy", "value": 19.475 },
     // … the rest of the published table (2 currencies vs ZMW)
   ],
   disclaimer: '…'
@@ -142,7 +157,7 @@ Paid plans. One resolved rate per publication date — ready for charting, reval
 import { getHistory } from 'boz-exchange-rate';
 
 const series = await getHistory(
-  { source: 'USD', target: 'ZMW', from: '2026-01-01', to: '2026-09-09' },
+  { source: 'USD', target: 'ZMW', from: '2026-01-01', to: '2026-09-25' },
   { apiKey: 'art_live_...' }
 );
 ```
@@ -155,11 +170,11 @@ const series = await getHistory(
   source: 'USD',
   target: 'ZMW',
   from: '2026-01-01',
-  to: '2026-09-09',
+  to: '2026-09-25',
   count: 152,
   rates: [
     // one entry per publication date
-    { date: '2026-09-09', rate: 19.2646, rate_type: 'middle', derived: false, method: 'published' },
+    { date: '2026-09-25', rate: 19.5, rate_type: 'middle', derived: false, method: 'published' },
     // …
   ],
   disclaimer: '…'
@@ -176,6 +191,39 @@ Bank of Zambia currently publishes rates covering **2 currencies** against the Z
 
 🇨🇳 `CNY` · 🇺🇸 `USD`
 
+## 🏛️ Source
+
+The Bank of Zambia publishes buying, middle and selling rates for the kwacha against the major currencies, updated across trading sessions during each business day; this feed stores the day's final print. As the central bank of one of the world's largest copper exporters, its kwacha reference anchors Zambian banking, mining-revenue conversion and customs valuation.
+
+- Publisher's own page: [Daily FX rates](https://www.boz.zm) · [www.boz.zm](https://www.boz.zm)
+- Publication: every business day; the exact schedule, freshness status and any current delay are on the [Bank of Zambia rates page](https://allratestoday.com/central-bank-rates-api/boz/)
+- Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-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).
+- Bank of Zambia quotes **ZMW per 1 unit of foreign currency** (e.g. `base: "USD", quote: "ZMW"` means ZMW 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 of Zambia 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/boz/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
 
 If Bank of Zambia 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:
@@ -250,7 +298,8 @@ Need the whole archive rather than an API call? The same published tables are mi
 
 - [Bank of Zambia rates page](https://allratestoday.com/central-bank-rates-api/boz/) — 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/boz-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/boz-exchange-rate)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boz-exchange-rate",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "description": "Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.",
   "keywords": [
     "boz",