cba-exchange-rate 1.3.0 → 1.3.3

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 +62 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Central Bank of Armenia Exchange Rate API — cba-exchange-rate
1
+ # Central Bank of Armenia Exchange Rates API — cba-exchange-rate
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/cba-exchange-rate.svg)](https://www.npmjs.com/package/cba-exchange-rate)
4
4
  [![license](https://img.shields.io/npm/l/cba-exchange-rate.svg)](https://github.com/AllRates-Today/cba-exchange-rate/blob/main/LICENSE)
@@ -16,7 +16,22 @@
16
16
  - 🔷 **Type-safe** — full TypeScript definitions shipped with the package
17
17
  - 🧾 **Compliance-grade metadata** — `rate_type`, publication date, and source disclaimer on every response
18
18
 
19
- > **Official rate, not mid-market:** every value here is a number Central Bank of Armenia 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.
19
+ > **Official rate, not mid-market:** every value here is a number Central Bank of Armenia 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.
20
+
21
+ ## ⚡ Try it without a key
22
+
23
+ The latest Central Bank of Armenia 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/cba?source=USD&target=AMD"
27
+ ```
28
+
29
+ ```js
30
+ const r = await fetch('https://allratestoday.com/api/open/central-bank/cba').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.
20
35
 
21
36
  ## 🔑 Get your API key
22
37
 
@@ -36,7 +51,7 @@ yarn add cba-exchange-rate
36
51
  pnpm add cba-exchange-rate
37
52
  ```
38
53
 
39
- Also published under the org scope as [`@allratestoday/cba-exchange-rate`](https://www.npmjs.com/package/@allratestoday/cba-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/cba-exchange-rate`](https://www.npmjs.com/package/@allratestoday/cba-exchange-rate) — same code, same versions.
40
55
 
41
56
  ## 🏁 Quick start
42
57
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'AMD', { apiKey: 'art_live_...' });
70
85
  {
71
86
  bank: 'cba',
72
87
  name: 'Central Bank of Armenia',
73
- rate_date: '2026-09-09', // Central Bank of Armenia's own publication date
88
+ rate_date: '2026-09-25', // Central Bank of Armenia's own publication date
74
89
  source: 'USD',
75
90
  target: 'AMD',
76
- rate: 363.58,
91
+ rate: 363.52,
77
92
  rate_type: 'reference',
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
 
@@ -98,9 +113,9 @@ console.log(table.rate_date, table.rates.length);
98
113
  {
99
114
  bank: 'cba',
100
115
  name: 'Central Bank of Armenia',
101
- rate_date: '2026-09-09',
116
+ rate_date: '2026-09-25',
102
117
  rates: [
103
- { "base": "USD", "quote": "AMD", "type": "reference", "value": 363.58 },
118
+ { "base": "USD", "quote": "AMD", "type": "reference", "value": 363.52 },
104
119
  // … the rest of the published table (30 currencies vs AMD)
105
120
  ],
106
121
  disclaimer: '…'
@@ -140,7 +155,7 @@ Paid plans. One resolved rate per publication date — ready for charting, reval
140
155
  import { getHistory } from 'cba-exchange-rate';
141
156
 
142
157
  const series = await getHistory(
143
- { source: 'USD', target: 'AMD', from: '2026-01-01', to: '2026-09-09' },
158
+ { source: 'USD', target: 'AMD', from: '2026-01-01', to: '2026-09-25' },
144
159
  { apiKey: 'art_live_...' }
145
160
  );
146
161
  ```
@@ -153,11 +168,11 @@ const series = await getHistory(
153
168
  source: 'USD',
154
169
  target: 'AMD',
155
170
  from: '2026-01-01',
156
- to: '2026-09-09',
171
+ to: '2026-09-25',
157
172
  count: 152,
158
173
  rates: [
159
174
  // one entry per publication date
160
- { date: '2026-09-09', rate: 363.58, rate_type: 'reference', derived: false, method: 'published' },
175
+ { date: '2026-09-25', rate: 363.52, rate_type: 'reference', derived: false, method: 'published' },
161
176
  // …
162
177
  ],
163
178
  disclaimer: '…'
@@ -174,6 +189,40 @@ Central Bank of Armenia currently publishes rates covering **30 currencies** aga
174
189
 
175
190
  🇦🇪 `AED` · 🇦🇺 `AUD` · 🇧🇷 `BRL` · 🇧🇾 `BYN` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇨🇿 `CZK` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇬🇪 `GEL` · 🇭🇰 `HKD` · 🇮🇳 `INR` · 🇮🇷 `IRR` · 🇯🇵 `JPY` · 🇰🇬 `KGS` · 🇰🇿 `KZT` · 🇳🇴 `NOK` · 🇳🇿 `NZD` · 🇵🇱 `PLN` · 🇷🇺 `RUB` · 🇸🇪 `SEK` · 🇸🇬 `SGD` · 🇹🇯 `TJS` · 🇺🇦 `UAH` · 🇺🇸 `USD` · 🇺🇿 `UZS` · `XAG` · `XAU` · `XDR`
176
191
 
192
+ ## 🏛️ Source
193
+
194
+ The Central Bank of Armenia publishes daily reference dram rates for 30 currencies — including gold and silver — each business afternoon. These are the rates Armenian tax and customs law references, with history back to 2000.
195
+
196
+ - Publisher's own page: [Exchange rate archive](https://old.cba.am/en/SitePages/ExchangeArchive.aspx) · [www.cba.am](https://www.cba.am)
197
+ - Publication: every business day; the exact schedule, freshness status and any current delay are on the [Central Bank of Armenia rates page](https://allratestoday.com/central-bank-rates-api/cba/)
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
+ - Central Bank of Armenia quotes **AMD per 1 unit of foreign currency** (e.g. `base: "USD", quote: "AMD"` means AMD per one US dollar).
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
+ - Precious-metal codes (`XAU`, `XAG`, `XPT`, `XPD`) are quoted **per troy ounce**.
206
+ - `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.
207
+
208
+ ## 🧩 ERP & accounting systems
209
+
210
+ Loading the official Central Bank of Armenia rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:
211
+
212
+ - [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code
213
+ - [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/)
214
+
215
+ 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:
216
+
217
+ ```bash
218
+ curl "https://allratestoday.com/api/v1/central-bank/cba/latest?format=xml&api_key=art_live_..."
219
+ ```
220
+
221
+ ## 🤖 AI agents
222
+
223
+ - 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
224
+ - Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)
225
+
177
226
  ## ⚖️ Published vs derived rates
178
227
 
179
228
  If Central Bank of Armenia 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 +297,8 @@ Need the whole archive rather than an API call? The same published tables are mi
248
297
 
249
298
  - [Central Bank of Armenia rates page](https://allratestoday.com/central-bank-rates-api/cba/) — live table, publication cadence, FAQ
250
299
  - [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/)
300
+ - [Package docs on the site](https://allratestoday.com/docs/sdk/cba-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)
301
+ - [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)
252
302
  - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
253
303
  - [GitHub](https://github.com/AllRates-Today/cba-exchange-rate)
254
304
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cba-exchange-rate",
3
- "version": "1.3.0",
3
+ "version": "1.3.3",
4
4
  "description": "Official Central Bank of Armenia (Armenia) daily exchange rates — 30 currencies vs AMD, history since 2000. Zero-dependency Node.js/TypeScript client.",
5
5
  "keywords": [
6
6
  "cba",