@allratestoday/cbsl-exchange-rate 1.2.7 → 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 +69 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Central Bank of Sri Lanka Exchange Rate API — cbsl-exchange-rate
1
+ # Central Bank of Sri Lanka Exchange Rates API — cbsl-exchange-rate
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@allratestoday%2Fcbsl-exchange-rate.svg)](https://www.npmjs.com/package/@allratestoday/cbsl-exchange-rate)
4
4
  [![license](https://img.shields.io/npm/l/@allratestoday%2Fcbsl-exchange-rate.svg)](https://github.com/AllRates-Today/cbsl-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 Sri Lanka 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 Sri Lanka 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/cbsl?source=USD&target=LKR"
27
+ ```
28
+
29
+ ```js
30
+ const r = await fetch('https://allratestoday.com/api/open/central-bank/cbsl').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/cbsl-exchange-rate
36
51
  pnpm add @allratestoday/cbsl-exchange-rate
37
52
  ```
38
53
 
39
- Scoped mirror of [`cbsl-exchange-rate`](https://www.npmjs.com/package/cbsl-exchange-rate) — same code, same versions.
54
+ Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Scoped mirror of [`cbsl-exchange-rate`](https://www.npmjs.com/package/cbsl-exchange-rate) — same code, same versions.
40
55
 
41
56
  ## 🏁 Quick start
42
57
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'LKR', { apiKey: 'art_live_...' });
70
85
  {
71
86
  bank: 'cbsl',
72
87
  name: 'Central Bank of Sri Lanka',
73
- rate_date: '2026-08-24', // Central Bank of Sri Lanka's own publication date
88
+ rate_date: '2026-09-09', // Central Bank of Sri Lanka's own publication date
74
89
  source: 'USD',
75
90
  target: 'LKR',
76
- rate: 329.4456,
91
+ rate: 328.7701,
77
92
  rate_type: 'indicative',
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: 'cbsl',
100
115
  name: 'Central Bank of Sri Lanka',
101
- rate_date: '2026-08-24',
116
+ rate_date: '2026-09-09',
102
117
  rates: [
103
- { "base": "USD", "quote": "LKR", "type": "indicative", "value": 329.4456 },
118
+ { "base": "USD", "quote": "LKR", "type": "indicative", "value": 328.7701 },
104
119
  // … the rest of the published table (55 currencies vs LKR)
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 '@allratestoday/cbsl-exchange-rate';
141
156
 
142
157
  const series = await getHistory(
143
- { source: 'USD', target: 'LKR', from: '2026-01-01', to: '2026-08-24' },
158
+ { source: 'USD', target: 'LKR', from: '2026-01-01', to: '2026-09-09' },
144
159
  { apiKey: 'art_live_...' }
145
160
  );
146
161
  ```
@@ -153,11 +168,11 @@ const series = await getHistory(
153
168
  source: 'USD',
154
169
  target: 'LKR',
155
170
  from: '2026-01-01',
156
- to: '2026-08-24',
171
+ to: '2026-09-09',
157
172
  count: 152,
158
173
  rates: [
159
174
  // one entry per publication date
160
- { date: '2026-08-24', rate: 329.4456, rate_type: 'indicative', derived: false, method: 'published' },
175
+ { date: '2026-09-09', rate: 328.7701, rate_type: 'indicative', derived: false, method: 'published' },
161
176
  // …
162
177
  ],
163
178
  disclaimer: '…'
@@ -174,6 +189,40 @@ Central Bank of Sri Lanka currently publishes rates covering **55 currencies** a
174
189
 
175
190
  🇦🇪 `AED` · 🇦🇺 `AUD` · 🇧🇩 `BDT` · 🇧🇭 `BHD` · 🇧🇳 `BND` · 🇧🇷 `BRL` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNH` · 🇨🇳 `CNY` · 🇨🇿 `CZK` · 🇩🇰 `DKK` · 🇪🇬 `EGP` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇬🇭 `GHS` · 🇭🇰 `HKD` · 🇭🇺 `HUF` · 🇮🇩 `IDR` · 🇮🇳 `INR` · 🇮🇷 `IRR` · 🇯🇴 `JOD` · 🇯🇵 `JPY` · 🇰🇪 `KES` · 🇰🇷 `KRW` · 🇰🇼 `KWD` · 🇲🇲 `MMK` · 🇲🇴 `MOP` · 🇲🇺 `MUR` · 🇲🇻 `MVR` · 🇲🇾 `MYR` · 🇳🇬 `NGN` · 🇳🇴 `NOK` · 🇳🇵 `NPR` · 🇳🇿 `NZD` · 🇴🇲 `OMR` · 🇵🇬 `PGK` · 🇵🇭 `PHP` · 🇵🇰 `PKR` · 🇵🇱 `PLN` · 🇶🇦 `QAR` · 🇷🇴 `RON` · 🇷🇺 `RUB` · 🇸🇦 `SAR` · 🇸🇧 `SBD` · 🇸🇨 `SCR` · 🇸🇪 `SEK` · 🇸🇬 `SGD` · 🇹🇭 `THB` · 🇹🇼 `TWD` · 🇺🇸 `USD` · 🇻🇳 `VND` · `XAU` · 🇿🇦 `ZAR` · 🇿🇲 `ZMW`
176
191
 
192
+ ## 🏛️ Source
193
+
194
+ The Central Bank of Sri Lanka is Sri Lanka's monetary authority. It publishes daily indicative exchange rates for the rupee across roughly 55 currencies — one of the broadest central-bank tables anywhere, and the standard rupee reference in Sri Lankan banking and reporting.
195
+
196
+ - Publisher's own page: [Daily indicative exchange rates](https://www.cbsl.gov.lk/cbsl_custom/exrates/exrates.php) · [www.cbsl.gov.lk](https://www.cbsl.gov.lk)
197
+ - Publication: every business day; the exact schedule, freshness status and any current delay are on the [Central Bank of Sri Lanka rates page](https://allratestoday.com/central-bank-rates-api/cbsl/)
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 Sri Lanka quotes **LKR per 1 unit of foreign currency** (e.g. `base: "USD", quote: "LKR"` means LKR 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 (`indicative` 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 Sri Lanka 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/cbsl/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 Sri Lanka 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:
@@ -236,11 +285,20 @@ getRate('USD', 'LKR', { apiKey: 'art_live_...' }).then((pair) => console.log(pai
236
285
  | `getRatesForDate(date, { apiKey, source?, target? })` | Paid | The official table (or one pair) for a YYYY-MM-DD date |
237
286
  | `getHistory({ symbol \| source+target, from?, to? }, { apiKey })` | Paid | Daily series since 2010 |
238
287
 
288
+ ## 📥 Bulk data (no key)
289
+
290
+ Need the whole archive rather than an API call? The same published tables are mirrored daily as open data:
291
+
292
+ - Hugging Face: [AllRates/central-bank-exchange-rates](https://huggingface.co/datasets/AllRates/central-bank-exchange-rates) — one CSV per institution (`rates/cbsl.csv`)
293
+ - Kaggle: [allratestoday/central-bank-exchange-rates](https://www.kaggle.com/datasets/allratestoday/central-bank-exchange-rates)
294
+ - CDN JSON: `https://cdn.jsdelivr.net/gh/AllRates-Today/central-bank-exchange-rates@main/data/cbsl/latest.json`
295
+
239
296
  ## 🔗 Links
240
297
 
241
298
  - [Central Bank of Sri Lanka rates page](https://allratestoday.com/central-bank-rates-api/cbsl/) — live table, publication cadence, FAQ
242
299
  - [All central bank sources](https://allratestoday.com/central-bank-rates-api/)
243
- - [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/cbsl-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/)
244
302
  - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
245
303
  - [GitHub](https://github.com/AllRates-Today/cbsl-exchange-rate)
246
304
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@allratestoday/cbsl-exchange-rate",
3
- "version": "1.2.7",
3
+ "version": "1.3.1",
4
4
  "description": "Official Central Bank of Sri Lanka (Sri Lanka) daily exchange rates — 55 currencies vs LKR, history since 2010. Zero-dependency Node.js/TypeScript client.",
5
5
  "keywords": [
6
6
  "cbsl",