bnb-exchange-rate 1.3.0 → 1.3.1

package/README.md

@@ -1,4 +1,4 @@
-# Bulgarian National Bank Exchange Rate API — bnb-exchange-rate
+# Bulgarian National Bank Exchange Rates API — bnb-exchange-rate
 
 [![npm version](https://img.shields.io/npm/v/bnb-exchange-rate.svg)](https://www.npmjs.com/package/bnb-exchange-rate)
 [![license](https://img.shields.io/npm/l/bnb-exchange-rate.svg)](https://github.com/AllRates-Today/bnb-exchange-rate/blob/main/LICENSE)
@@ -18,6 +18,21 @@
 
 > **Official rate, not mid-market:** every value here is a number Bulgarian National Bank 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 Bulgarian National Bank 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/bnb?source=EUR&target=USD"
+```
+
+```js
+const r = await fetch('https://allratestoday.com/api/open/central-bank/bnb').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 bnb-exchange-rate
 pnpm add bnb-exchange-rate
 ```
 
-Also published under the org scope as [`@allratestoday/bnb-exchange-rate`](https://www.npmjs.com/package/@allratestoday/bnb-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/bnb-exchange-rate`](https://www.npmjs.com/package/@allratestoday/bnb-exchange-rate) — same code, same versions.
 
 ## 🏁 Quick start
 
@@ -77,7 +92,7 @@ const pair = await getRate('EUR', 'USD', { apiKey: 'art_live_...' });
   rate_type: 'reference',
   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.'
 }
 ```
 
@@ -174,6 +189,39 @@ Bulgarian National Bank currently publishes rates covering **29 currencies** aga
 
 🇦🇺 `AUD` · 🇧🇷 `BRL` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇨🇿 `CZK` · 🇩🇰 `DKK` · 🇬🇧 `GBP` · 🇭🇰 `HKD` · 🇭🇺 `HUF` · 🇮🇩 `IDR` · 🇮🇱 `ILS` · 🇮🇳 `INR` · 🇮🇸 `ISK` · 🇯🇵 `JPY` · 🇰🇷 `KRW` · 🇲🇽 `MXN` · 🇲🇾 `MYR` · 🇳🇴 `NOK` · 🇳🇿 `NZD` · 🇵🇭 `PHP` · 🇵🇱 `PLN` · 🇷🇴 `RON` · 🇸🇪 `SEK` · 🇸🇬 `SGD` · 🇹🇭 `THB` · 🇹🇷 `TRY` · 🇺🇸 `USD` · 🇿🇦 `ZAR`
 
+## 🏛️ Source
+
+The Bulgarian National Bank, founded in 1879, is one of the world's oldest central banks. Following Bulgaria's adoption of the euro, it publishes euro-denominated reference rates for around 30 currencies each business day.
+
+- Publisher's own page: [Exchange rates of foreign currencies](https://www.bnb.bg/Statistics/StExternalSector/StExchangeRates/StERForeignCurrencies/index.htm) · [www.bnb.bg](https://www.bnb.bg)
+- Publication: every business day; the exact schedule, freshness status and any current delay are on the [Bulgarian National Bank rates page](https://allratestoday.com/central-bank-rates-api/bnb/)
+- 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).
+- Bulgarian National Bank quotes **foreign currency per 1 EUR** (e.g. `base: "EUR", quote: "USD"` means USD per one EUR).
+- 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 (`reference` here); some publishers print buy/sell or several fixings for the same pair.
+
+## 🧩 ERP & accounting systems
+
+Loading the official Bulgarian National Bank 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/bnb/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 Bulgarian National Bank 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
 
 - [Bulgarian National Bank rates page](https://allratestoday.com/central-bank-rates-api/bnb/) — 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/bnb-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/bnb-exchange-rate)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnb-exchange-rate",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Official Bulgarian National Bank (Bulgaria) daily exchange rates — 29 currencies vs EUR, history since 2016. Zero-dependency Node.js/TypeScript client.",
   "keywords": [
     "bnb",