{"_id":"@allratestoday/boz-exchange-rate","_rev":"5-95650282b7c81db9d2843e860acd91cd","name":"@allratestoday/boz-exchange-rate","dist-tags":{"latest":"1.3.4"},"versions":{"1.2.7":{"name":"@allratestoday/boz-exchange-rate","version":"1.2.7","keywords":["boz","bank","of","zambia","exchange-rate","exchange-rates","currency","forex","fx","zmw","central-bank","official-rates","zambia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/boz-exchange-rate@1.2.7","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/boz/","bugs":{"url":"https://github.com/AllRates-Today/boz-exchange-rate/issues"},"dist":{"shasum":"6dc582cedc8132be89a717b1c1dfea4949eeadf5","tarball":"https://registry.npmjs.org/@allratestoday/boz-exchange-rate/-/boz-exchange-rate-1.2.7.tgz","fileCount":6,"integrity":"sha512-8Y6UAz06M2NK10+h1Cllr1lPcShB6e9mDsQbcKd5BS8aQH4WaNRJd5yg+jcrLTkkbu+b+SB0zWbJtbPwEWTlaw==","signatures":[{"sig":"MEYCIQD1uG6thaYIaoZrfvHl2H7pWW6KLWgZtm2ZxstvP4Js0QIhAOOEY8+ZkxJzNCZFGUQjZDw8CJrn9azAsgcFVdg70F0H","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":16854},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"10e5433a83cacf2d646ef1ed69e2d59fe9eb0787","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/boz-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/boz-exchange-rate_1.2.7_1787599797537_0.6495255890901195","host":"s3://npm-registry-packages-npm-production"}},"1.3.0":{"name":"@allratestoday/boz-exchange-rate","version":"1.3.0","keywords":["boz","bank","of","zambia","exchange-rate","exchange-rates","currency","forex","fx","zmw","central-bank","official-rates","zambia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/boz-exchange-rate@1.3.0","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/boz/","bugs":{"url":"https://github.com/AllRates-Today/boz-exchange-rate/issues"},"dist":{"shasum":"6fdcb028c763fa4efaff841a1ccf5a42c894e06f","tarball":"https://registry.npmjs.org/@allratestoday/boz-exchange-rate/-/boz-exchange-rate-1.3.0.tgz","fileCount":6,"integrity":"sha512-t+hAPLQhcLja1oOWIRX3g1C0x49e/XvnUJey4QfsFwJbPSdUYB8XMjgSeLdmYcvm/HHwfqh+UtI1dDTqR+0rZA==","signatures":[{"sig":"MEUCIFE+1XTFdj/yM1T3WjU+rGiPZgQzmejC6Ii1weDyhAHuAiEAwI/+jlD5cvN/bH5vCgrcg5ZEsl3yiE6LFZXGs4DaIkc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEUCIDglq4ymuBP/+nsv4iaRk1wwIGTBGVRolp3g0yHBpjKgAiEAslTwFx5JUtWs/NmvEqbkUCUL4YK0nX6xrWPQSi6TcmE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17402},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"ec4d6bcf08cf485c7ab237f12d27e3d5a0f97e14","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/boz-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/boz-exchange-rate_1.3.0_1788977013343_0.496893102845847","host":"s3://npm-registry-packages-npm-production"}},"1.3.1":{"name":"@allratestoday/boz-exchange-rate","version":"1.3.1","keywords":["boz","bank","of","zambia","exchange-rate","exchange-rates","currency","forex","fx","zmw","central-bank","official-rates","zambia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/boz-exchange-rate@1.3.1","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/boz/","bugs":{"url":"https://github.com/AllRates-Today/boz-exchange-rate/issues"},"dist":{"shasum":"3f71f35178d761c6d5ab897d0321c3029a85e57c","tarball":"https://registry.npmjs.org/@allratestoday/boz-exchange-rate/-/boz-exchange-rate-1.3.1.tgz","fileCount":6,"integrity":"sha512-lbraqanOfCskprEcZ/vp+eu+geLxUO1vpdSM/idVmCk/Uxfgjqn6JoXE9rMBhxjewY/T8+CA9pPApDSSiDzFtg==","signatures":[{"sig":"MEQCIFNvuQdYULGDwUKDZQLTBJZaoixFa9Fga1cQGzP2lpQAAiBQiJyG2ve8ouYjRmQgAiXhusKfcdr+WwCxolIyKnZLZg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEQCIE6iy+5794xTAM1PmTxbpH6qY/5JX8buJOr6xbnzT+4mAiAEBMVmu4thus7ycmftqpris63m7hEqnh5vth/THCrzmQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21230},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"fc26fa33ba7dd14ed15e95764a0cdb2b1355358f","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/boz-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/boz-exchange-rate_1.3.1_1789650098832_0.710160865413922","host":"s3://npm-registry-packages-npm-production"}},"1.3.3":{"name":"@allratestoday/boz-exchange-rate","version":"1.3.3","keywords":["boz","bank","of","zambia","exchange-rate","exchange-rates","currency","forex","fx","zmw","central-bank","official-rates","zambia","api","typescript"],"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","_id":"@allratestoday/boz-exchange-rate@1.3.3","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"homepage":"https://allratestoday.com/central-bank-rates-api/boz/","bugs":{"url":"https://github.com/AllRates-Today/boz-exchange-rate/issues"},"dist":{"shasum":"05b5e6d362234fa85ae5edf37952bd5d1a3f6322","tarball":"https://registry.npmjs.org/@allratestoday/boz-exchange-rate/-/boz-exchange-rate-1.3.3.tgz","fileCount":6,"integrity":"sha512-lvACWxnJnHniBncyAK2KnD/yf/tQJJpv0gguEIAZNwEgjr1HE5B1zOkbVNJuimcoJMRYXyYROXtX9b08uFo/kw==","signatures":[{"sig":"MEYCIQCyW58LwDJYj3iddEjM19UYS2ULNVkMQWg3c/+xRze3qAIhALLZ7JLdPh+jjOF9gIyUk9lKeJaV2kXjx1ByLixu0UG/","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"sig":"MEQCIF9Wr7GG2FmCba9f8Ncz9SYBWu1CKnnpU76kb6yyC9VwAiB/A4D44/VEfr95NKHLIGORD26LrXQ/ITWeje0R6Frq5Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21216},"main":"./index.cjs","type":"module","types":"./index.d.ts","module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"ca0b6b268a0b3c562dedb06b2ec12ac8815a6a05","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"repository":{"url":"git+https://github.com/AllRates-Today/boz-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/boz-exchange-rate_1.3.3_1790770280374_0.14807915110136105","host":"s3://npm-registry-packages-npm-production"}},"1.3.4":{"_id":"@allratestoday/boz-exchange-rate@1.3.4","bugs":{"url":"https://github.com/AllRates-Today/boz-exchange-rate/issues"},"dist":{"shasum":"3f635668e49a698194158b197cecb12d1512dcd1","tarball":"https://registry.npmjs.org/@allratestoday/boz-exchange-rate/-/boz-exchange-rate-1.3.4.tgz","fileCount":6,"integrity":"sha512-B2A2vXty+C6EJO+vB9wyAwFIrmGrZbxxbKVo216RorB4LyNRP6Ffa3KPq6UzalZuy36Xjrd+sbgRUDP5+1zHQQ==","signatures":[{"sig":"MEQCICIdkMIc4UGkMtR65vxVpLlOErzXTYkNdyeKafM1iHCGAiB946lQiq1JU3TL+MMMS4FEIwIicJYJVKlb2d89FLzkYw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHOevBgca6qlrzhoinnxgb3eIvgRyAnW0e/TkdlKlx4+AiBpxR3DsfpwYJK+9tbyILQ24RQBJVBnu5ccD4X56xtoUA=="}],"unpackedSize":21615},"main":"./index.cjs","name":"@allratestoday/boz-exchange-rate","type":"module","types":"./index.d.ts","author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"module":"./index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./index.d.ts","import":"./index.mjs","require":"./index.cjs"}},"gitHead":"79b405ca4251d0e8c85b00c9f6c63206e5e3dab3","license":"MIT","version":"1.3.4","_npmUser":{"name":"chathurangac8","email":"basnayakac8@gmail.com"},"homepage":"https://allratestoday.com/central-bank-rates-api/boz/","keywords":["boz","bank","of","zambia","exchange-rate","exchange-rates","currency","forex","fx","zmw","central-bank","official-rates","zambia","api","typescript"],"repository":{"url":"git+https://github.com/AllRates-Today/boz-exchange-rate.git","type":"git"},"_npmVersion":"9.2.0","description":"Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.","directories":{},"maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"sideEffects":false,"_nodeVersion":"22.22.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/boz-exchange-rate_1.3.4_1790851323178_0.26908341693950755"}}},"time":{"created":"2026-08-24T19:29:57.304Z","modified":"2026-10-01T10:42:03.458Z","1.2.7":"2026-08-24T19:29:57.698Z","1.3.0":"2026-09-09T18:03:33.446Z","1.3.1":"2026-09-17T13:01:38.915Z","1.3.3":"2026-09-30T12:11:20.468Z","1.3.4":"2026-10-01T10:42:03.294Z"},"bugs":{"url":"https://github.com/AllRates-Today/boz-exchange-rate/issues"},"author":{"url":"https://allratestoday.com","name":"AllRatesToday","email":"hello@allratestoday.com"},"license":"MIT","homepage":"https://allratestoday.com/central-bank-rates-api/boz/","keywords":["boz","bank","of","zambia","exchange-rate","exchange-rates","currency","forex","fx","zmw","central-bank","official-rates","zambia","api","typescript"],"repository":{"url":"git+https://github.com/AllRates-Today/boz-exchange-rate.git","type":"git"},"description":"Official Bank of Zambia (Zambia) daily exchange rates — 2 currencies vs ZMW, history since 2026. Zero-dependency Node.js/TypeScript client.","maintainers":[{"name":"chathurangac8","email":"basnayakac8@gmail.com"}],"readme":"# Bank of Zambia Exchange Rates API — boz-exchange-rate\n\n[![npm version](https://img.shields.io/npm/v/@allratestoday%2Fboz-exchange-rate.svg)](https://www.npmjs.com/package/@allratestoday/boz-exchange-rate)\n[![license](https://img.shields.io/npm/l/@allratestoday%2Fboz-exchange-rate.svg)](https://github.com/AllRates-Today/boz-exchange-rate/blob/main/LICENSE)\n[![zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen.svg)](https://www.npmjs.com/package/@allratestoday/boz-exchange-rate)\n[![TypeScript](https://img.shields.io/badge/TypeScript-types%20included-3178C6.svg)](https://www.typescriptlang.org/)\n\n**Official Bank of Zambia (Zambia) 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 Bank of Zambia itself prints, every business day.**\n\n## 🚀 Why this client?\n\n- 🏛️ **Official published rates** — Bank of Zambia's own table, with the publisher's own `rate_date` on every response\n- 📅 **History back to 2026** — point-in-time tables and daily series for any past date\n- 🔀 **Published vs derived, always flagged** — computed inverse/cross pairs carry `derived: true`, never mixed with official prints\n- ⚡ **Zero dependencies** — pure ESM + CJS over global `fetch`; Node 18+, Bun, Deno, and edge runtimes\n- 🔷 **Type-safe** — full TypeScript definitions shipped with the package\n- 🧾 **Compliance-grade metadata** — `rate_type`, publication date, and source disclaimer on every response\n\n> **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.\n\n## ⚡ Try it without a key\n\nThe latest Bank of Zambia table is also served keyless, CORS-open and edge-cached, for evaluation, embeds and AI agents:\n\n```bash\ncurl \"https://allratestoday.com/api/open/central-bank/boz?source=USD&target=ZMW\"\n```\n\n```js\nconst r = await fetch('https://allratestoday.com/api/open/central-bank/boz').then((x) => x.json());\nconsole.log(r.rate_date, r.rates.length); // the central bank's latest published table, no key\n```\n\nThe 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.\n\n## 🔑 Get your API key\n\nGet a free API key at [allratestoday.com/register](https://allratestoday.com/register) — no credit card required. Latest rates are on every plan, including free.\n\n## 📦 Installation\n\n```bash\nnpm install @allratestoday/boz-exchange-rate\n```\n\n```bash\nyarn add @allratestoday/boz-exchange-rate\n```\n\n```bash\npnpm add @allratestoday/boz-exchange-rate\n```\n\nRequires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Scoped mirror of [`boz-exchange-rate`](https://www.npmjs.com/package/boz-exchange-rate) — same code, same versions.\n\n## 🏁 Quick start\n\n```js\nimport { getRate } from '@allratestoday/boz-exchange-rate';\n\nconst pair = await getRate('USD', 'ZMW', { apiKey: 'art_live_...' });\nconsole.log(pair.rate, pair.rate_date); // the official Bank of Zambia rate, on the central bank's own date\n```\n\n## 📚 API reference\n\n- [Latest pair rate](#latest-pair-rate) — one pair from the latest published table\n- [Full published table](#full-published-table) — everything the central bank printed, in one call\n- [Table for a date](#table-for-a-date) — the official table for an invoice or filing date\n- [Daily time series](#daily-time-series) — one pair across a date range\n\n---\n\n### Latest pair rate\n\nFree plan and up. Pairs the central bank does not print directly are resolved from its table and flagged (see *Published vs derived rates* below).\n\n```js\nconst pair = await getRate('USD', 'ZMW', { apiKey: 'art_live_...' });\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'boz',\n  name: 'Bank of Zambia',\n  rate_date: '2026-09-25',   // Bank of Zambia's own publication date\n  source: 'USD',\n  target: 'ZMW',\n  rate: 19.5,\n  rate_type: 'middle',\n  derived: false,\n  method: 'published',\n  disclaimer: 'Official rates as published by the named central bank. On weekends/holidays the most recent published rate_date is returned.'\n}\n```\n\n### Full published table\n\nFree plan and up. The complete table for the latest publication date.\n\n```js\nimport { getLatestRates } from '@allratestoday/boz-exchange-rate';\n\nconst table = await getLatestRates({ apiKey: 'art_live_...' });\nconsole.log(table.rate_date, table.rates.length);\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'boz',\n  name: 'Bank of Zambia',\n  rate_date: '2026-09-25',\n  rates: [\n    { \"base\": \"USD\", \"quote\": \"ZMW\", \"type\": \"middle\", \"value\": 19.5 },\n    { \"base\": \"USD\", \"quote\": \"ZMW\", \"type\": \"sell\", \"value\": 19.525 },\n    { \"base\": \"USD\", \"quote\": \"ZMW\", \"type\": \"buy\", \"value\": 19.475 },\n    // … the rest of the published table (2 currencies vs ZMW)\n  ],\n  disclaimer: '…'\n}\n```\n\n### Table for a date\n\nPaid plans. The official table for any date since 2026 — 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.\n\n```js\nimport { getRatesForDate } from '@allratestoday/boz-exchange-rate';\n\nconst day = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...' });\n// Optionally narrow to one pair:\nconst one = await getRatesForDate('2026-06-30', { apiKey: 'art_live_...', source: 'USD', target: 'ZMW' });\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'boz',\n  requested_date: '2026-06-30',\n  rate_date: '2026-06-30',                // the date actually published\n  published_on_requested_date: true,      // false when a weekend/holiday fell back\n  rates: [ /* the full table for that date */ ],\n  disclaimer: '…'\n}\n```\n\n### Daily time series\n\nPaid plans. One resolved rate per publication date — ready for charting, revaluation runs, or audit workpapers.\n\n```js\nimport { getHistory } from '@allratestoday/boz-exchange-rate';\n\nconst series = await getHistory(\n  { source: 'USD', target: 'ZMW', from: '2026-01-01', to: '2026-09-25' },\n  { apiKey: 'art_live_...' }\n);\n```\n\n**Response:**\n\n```javascript\n{\n  bank: 'boz',\n  source: 'USD',\n  target: 'ZMW',\n  from: '2026-01-01',\n  to: '2026-09-25',\n  count: 152,\n  rates: [\n    // one entry per publication date\n    { date: '2026-09-25', rate: 19.5, rate_type: 'middle', derived: false, method: 'published' },\n    // …\n  ],\n  disclaimer: '…'\n}\n```\n\nPass `{ symbol: 'USD' }` instead of `source`/`target` to get the raw published rows for one currency (all rate types, no pair resolution).\n\n---\n\n## 🗺️ Currencies covered\n\nBank of Zambia currently publishes rates covering **2 currencies** against the ZMW (as of the latest table):\n\n🇨🇳 `CNY` · 🇺🇸 `USD`\n\n## 🏛️ Source\n\nThe 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.\n\n- Publisher's own page: [Daily FX rates](https://www.boz.zm) · [www.boz.zm](https://www.boz.zm)\n- 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/)\n- Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-methodology/)\n\n## 🧭 Reading the numbers\n\n- `value` is always **quote currency per 1 unit of base currency** (`base: \"EUR\", quote: \"USD\", value: 1.15` means 1 EUR = 1.15 USD).\n- Bank of Zambia quotes **ZMW per 1 unit of foreign currency** (e.g. `base: \"USD\", quote: \"ZMW\"` means ZMW per one US dollar).\n- 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.\n- `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.\n\n## 🧩 ERP & accounting systems\n\nLoading 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:\n\n- [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code\n- [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/)\n\nThe 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:\n\n```bash\ncurl \"https://allratestoday.com/api/v1/central-bank/boz/latest?format=xml&api_key=art_live_...\"\n```\n\n## 🤖 AI agents\n\n- 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\n- Already using the general SDK or MCP server? Since 2026-10-01 [`@allratestoday/sdk`](https://www.npmjs.com/package/@allratestoday/sdk) 1.4+ has `officialRates('boz')` and [`@allratestoday/mcp-server`](https://www.npmjs.com/package/@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\n- Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)\n\n## ⚖️ Published vs derived rates\n\nIf 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:\n\n| `method` | `derived` | Meaning |\n| --- | --- | --- |\n| `published` | `false` | The central bank printed this pair directly |\n| `inverse` | `true` | Computed as 1 ÷ the published opposite direction |\n| `cross` | `true` | Computed via ZMW from two published rates |\n\n## 🛡️ Error handling\n\nErrors are thrown as `Error` with `status` (HTTP code) and `body` (the API's JSON error) attached:\n\n```js\ntry {\n  const pair = await getRate('USD', 'XXX', { apiKey: 'art_live_...' });\n} catch (err) {\n  console.log(err.message); // human-readable reason\n  console.log(err.status);  // e.g. 404\n}\n```\n\n| Status | Meaning |\n| ------ | ------- |\n| — | Missing `apiKey` (thrown before any request) |\n| `400` | Malformed date or parameters |\n| `401` | Invalid API key |\n| `403` | Endpoint needs a [paid plan](https://allratestoday.com/pricing/) (historical dates & series) |\n| `404` | Pair or date range not covered by Bank of Zambia |\n| `429` | Monthly quota exceeded |\n\n## 🔷 TypeScript\n\nFull definitions ship with the package — no `@types` install:\n\n```ts\nimport type { LatestRates, PairRate, DatedRates, RateEntry, HistoryQuery, RequestOptions } from '@allratestoday/boz-exchange-rate';\n```\n\n## 📦 CommonJS\n\n```javascript\nconst { getRate } = require('@allratestoday/boz-exchange-rate');\n\ngetRate('USD', 'ZMW', { apiKey: 'art_live_...' }).then((pair) => console.log(pair.rate));\n```\n\n## 💡 Quota tips\n\n- Rates change once per business day — cache the published table locally and a small monthly quota goes a long way.\n- Every request counts toward your AllRatesToday quota, shared across all AllRatesToday endpoints on your key.\n\n## 📖 Methods reference\n\n| Method | Plan | Description |\n| ------ | ---- | ----------- |\n| `getRate(source, target, { apiKey })` | Free | Latest rate for one pair, resolved from the published table |\n| `getLatestRates({ apiKey })` | Free | The central bank's full latest published table |\n| `getRatesForDate(date, { apiKey, source?, target? })` | Paid | The official table (or one pair) for a YYYY-MM-DD date |\n| `getHistory({ symbol \\| source+target, from?, to? }, { apiKey })` | Paid | Daily series since 2026 |\n\n## 📥 Bulk data (no key)\n\nNeed the whole archive rather than an API call? The same published tables are mirrored daily as open data:\n\n- Hugging Face: [AllRates/central-bank-exchange-rates](https://huggingface.co/datasets/AllRates/central-bank-exchange-rates) — one CSV per institution (`rates/boz.csv`)\n- Kaggle: [allratestoday/central-bank-exchange-rates](https://www.kaggle.com/datasets/allratestoday/central-bank-exchange-rates)\n- CDN JSON: `https://cdn.jsdelivr.net/gh/AllRates-Today/central-bank-exchange-rates@main/data/boz/latest.json`\n\n## 🔗 Links\n\n- [Bank of Zambia rates page](https://allratestoday.com/central-bank-rates-api/boz/) — live table, publication cadence, FAQ\n- [All central bank sources](https://allratestoday.com/central-bank-rates-api/)\n- [Package docs on the site](https://allratestoday.com/docs/sdk/boz-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)\n- [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)\n- [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)\n- [GitHub](https://github.com/AllRates-Today/boz-exchange-rate)\n\n## 📜 License\n\nMIT\n","readmeFilename":"README.md"}