@allratestoday/cbbh-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
- # Central Bank of Bosnia and Herzegovina Exchange Rate API — cbbh-exchange-rate
1
+ # Central Bank of Bosnia and Herzegovina Exchange Rates API — cbbh-exchange-rate
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@allratestoday%2Fcbbh-exchange-rate.svg)](https://www.npmjs.com/package/@allratestoday/cbbh-exchange-rate)
4
4
  [![license](https://img.shields.io/npm/l/@allratestoday%2Fcbbh-exchange-rate.svg)](https://github.com/AllRates-Today/cbbh-exchange-rate/blob/main/LICENSE)
@@ -18,6 +18,21 @@
18
18
 
19
19
  > **Official rate, not mid-market:** every value here is a number Central Bank of Bosnia and Herzegovina 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 Central Bank of Bosnia and Herzegovina 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/cbbh?source=EUR&target=BAM"
27
+ ```
28
+
29
+ ```js
30
+ const r = await fetch('https://allratestoday.com/api/open/central-bank/cbbh').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 @allratestoday/cbbh-exchange-rate
36
51
  pnpm add @allratestoday/cbbh-exchange-rate
37
52
  ```
38
53
 
39
- Scoped mirror of [`cbbh-exchange-rate`](https://www.npmjs.com/package/cbbh-exchange-rate) — same code, same versions.
54
+ Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Scoped mirror of [`cbbh-exchange-rate`](https://www.npmjs.com/package/cbbh-exchange-rate) — same code, same versions.
40
55
 
41
56
  ## 🏁 Quick start
42
57
 
@@ -77,7 +92,7 @@ const pair = await getRate('EUR', 'BAM', { apiKey: 'art_live_...' });
77
92
  rate_type: 'middle',
78
93
  derived: false,
79
94
  method: 'published',
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
 
@@ -176,6 +191,39 @@ Central Bank of Bosnia and Herzegovina currently publishes rates covering **17 c
176
191
 
177
192
  🇦🇺 `AUD` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇨🇿 `CZK` · 🇩🇰 `DKK` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇭🇺 `HUF` · 🇯🇵 `JPY` · 🇳🇴 `NOK` · 🇷🇸 `RSD` · 🇷🇺 `RUB` · 🇸🇪 `SEK` · 🇹🇷 `TRY` · 🇺🇸 `USD` · `XDR`
178
193
 
194
+ ## 🏛️ Source
195
+
196
+ The Central Bank of Bosnia and Herzegovina operates a currency board: the convertible mark is fixed at 1.95583 BAM per euro. It publishes an official daily exchange rate list with buy, middle, and sell rates for major currencies.
197
+
198
+ - Publisher's own page: [Currency exchange rate list](https://www.cbbh.ba/CurrencyExchange/) · [www.cbbh.ba](https://www.cbbh.ba)
199
+ - Publication: every business day; the exact schedule, freshness status and any current delay are on the [Central Bank of Bosnia and Herzegovina rates page](https://allratestoday.com/central-bank-rates-api/cbbh/)
200
+ - Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-methodology/)
201
+
202
+ ## 🧭 Reading the numbers
203
+
204
+ - `value` is always **quote currency per 1 unit of base currency** (`base: "EUR", quote: "USD", value: 1.15` means 1 EUR = 1.15 USD).
205
+ - Central Bank of Bosnia and Herzegovina quotes **BAM per 1 unit of foreign currency** (e.g. `base: "USD", quote: "BAM"` means BAM per one US dollar).
206
+ - 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.
207
+ - `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.
208
+
209
+ ## 🧩 ERP & accounting systems
210
+
211
+ Loading the official Central Bank of Bosnia and Herzegovina rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:
212
+
213
+ - [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code
214
+ - [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/)
215
+
216
+ 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:
217
+
218
+ ```bash
219
+ curl "https://allratestoday.com/api/v1/central-bank/cbbh/latest?format=xml&api_key=art_live_..."
220
+ ```
221
+
222
+ ## 🤖 AI agents
223
+
224
+ - 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
225
+ - Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)
226
+
179
227
  ## ⚖️ Published vs derived rates
180
228
 
181
229
  If Central Bank of Bosnia and Herzegovina 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
250
298
 
251
299
  - [Central Bank of Bosnia and Herzegovina rates page](https://allratestoday.com/central-bank-rates-api/cbbh/) — live table, publication cadence, FAQ
252
300
  - [All central bank sources](https://allratestoday.com/central-bank-rates-api/)
253
- - [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/)
301
+ - [Package docs on the site](https://allratestoday.com/docs/sdk/cbbh-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)
302
+ - [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)
254
303
  - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
255
304
  - [GitHub](https://github.com/AllRates-Today/cbbh-exchange-rate)
256
305
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@allratestoday/cbbh-exchange-rate",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "description": "Official Central Bank of Bosnia and Herzegovina (Bosnia and Herzegovina) daily exchange rates — 17 currencies vs BAM, history since 2016. Zero-dependency Node.js/TypeScript client.",
5
5
  "keywords": [
6
6
  "cbbh",