bob-exchange-rate 1.3.0 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +53 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Bank of Botswana Exchange Rate API — bob-exchange-rate
1
+ # Bank of Botswana Exchange Rates API — bob-exchange-rate
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/bob-exchange-rate.svg)](https://www.npmjs.com/package/bob-exchange-rate)
4
4
  [![license](https://img.shields.io/npm/l/bob-exchange-rate.svg)](https://github.com/AllRates-Today/bob-exchange-rate/blob/main/LICENSE)
@@ -18,6 +18,21 @@
18
18
 
19
19
  > **Official rate, not mid-market:** every value here is a number Bank of Botswana 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.
20
20
 
21
+ ## ⚡ Try it without a key
22
+
23
+ The latest Bank of Botswana table is also served keyless, CORS-open and edge-cached, for evaluation, embeds and AI agents:
24
+
25
+ ```bash
26
+ curl "https://allratestoday.com/api/open/central-bank/bob?source=USD&target=BWP"
27
+ ```
28
+
29
+ ```js
30
+ const r = await fetch('https://allratestoday.com/api/open/central-bank/bob').then((x) => x.json());
31
+ console.log(r.rate_date, r.rates.length); // the central bank's latest published table, no key
32
+ ```
33
+
34
+ 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.
35
+
21
36
  ## 🔑 Get your API key
22
37
 
23
38
  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 bob-exchange-rate
36
51
  pnpm add bob-exchange-rate
37
52
  ```
38
53
 
39
- Also published under the org scope as [`@allratestoday/bob-exchange-rate`](https://www.npmjs.com/package/@allratestoday/bob-exchange-rate) — same code, same versions.
54
+ Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Also published under the org scope as [`@allratestoday/bob-exchange-rate`](https://www.npmjs.com/package/@allratestoday/bob-exchange-rate) — same code, same versions.
40
55
 
41
56
  ## 🏁 Quick start
42
57
 
@@ -77,7 +92,7 @@ const pair = await getRate('USD', 'BWP', { apiKey: 'art_live_...' });
77
92
  rate_type: 'reference',
78
93
  derived: true,
79
94
  method: 'inverse', // computed from the published BWP/USD print
80
- disclaimer: '…'
95
+ disclaimer: 'Official rates as published by the named central bank. On weekends/holidays the most recent published rate_date is returned.'
81
96
  }
82
97
  ```
83
98
 
@@ -174,6 +189,39 @@ Bank of Botswana currently publishes rates covering **7 currencies** against the
174
189
 
175
190
  🇨🇳 `CNH` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇯🇵 `JPY` · 🇺🇸 `USD` · `XDR` · 🇿🇦 `ZAR`
176
191
 
192
+ ## 🏛️ Source
193
+
194
+ The Bank of Botswana publishes daily reference rates for the pula against seven currencies, with the pula managed under a crawling-band peg to a basket of the South African rand and the IMF's SDR. The bank quotes foreign currency per pula — this feed serves both directions — and its daily table is the official reference for Botswana's banks and diamond-led trade.
195
+
196
+ - Publisher's own page: [Exchange rates](https://www.bankofbotswana.bw) · [www.bankofbotswana.bw](https://www.bankofbotswana.bw)
197
+ - Publication: every business day; the exact schedule, freshness status and any current delay are on the [Bank of Botswana rates page](https://allratestoday.com/central-bank-rates-api/bob/)
198
+ - Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-methodology/)
199
+
200
+ ## 🧭 Reading the numbers
201
+
202
+ - `value` is always **quote currency per 1 unit of base currency** (`base: "EUR", quote: "USD", value: 1.15` means 1 EUR = 1.15 USD).
203
+ - Bank of Botswana quotes **foreign currency per 1 BWP** (e.g. `base: "BWP", quote: "USD"` means USD per one BWP).
204
+ - 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.
205
+ - `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.
206
+
207
+ ## 🧩 ERP & accounting systems
208
+
209
+ Loading the official Bank of Botswana rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:
210
+
211
+ - [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code
212
+ - [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/)
213
+
214
+ 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:
215
+
216
+ ```bash
217
+ curl "https://allratestoday.com/api/v1/central-bank/bob/latest?format=xml&api_key=art_live_..."
218
+ ```
219
+
220
+ ## 🤖 AI agents
221
+
222
+ - 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
223
+ - Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)
224
+
177
225
  ## ⚖️ Published vs derived rates
178
226
 
179
227
  If Bank of Botswana 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:
@@ -248,7 +296,8 @@ Need the whole archive rather than an API call? The same published tables are mi
248
296
 
249
297
  - [Bank of Botswana rates page](https://allratestoday.com/central-bank-rates-api/bob/) — live table, publication cadence, FAQ
250
298
  - [All central bank sources](https://allratestoday.com/central-bank-rates-api/)
251
- - [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/)
299
+ - [Package docs on the site](https://allratestoday.com/docs/sdk/bob-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)
300
+ - [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)
252
301
  - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
253
302
  - [GitHub](https://github.com/AllRates-Today/bob-exchange-rate)
254
303
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bob-exchange-rate",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "description": "Official Bank of Botswana (Botswana) daily exchange rates — 7 currencies vs BWP, current table, archive from 2026. Zero-dependency Node.js/TypeScript client.",
5
5
  "keywords": [
6
6
  "bob",