boe-exchange-rate 1.2.0 → 1.3.0
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.
- package/README.md +19 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,6 +16,8 @@
|
|
|
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 Bank of England 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
|
+
|
|
19
21
|
## 🔑 Get your API key
|
|
20
22
|
|
|
21
23
|
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.
|
|
@@ -68,10 +70,10 @@ const pair = await getRate('GBP', 'USD', { apiKey: 'art_live_...' });
|
|
|
68
70
|
{
|
|
69
71
|
bank: 'boe',
|
|
70
72
|
name: 'Bank of England',
|
|
71
|
-
rate_date: '2026-08
|
|
73
|
+
rate_date: '2026-09-08', // Bank of England's own publication date
|
|
72
74
|
source: 'GBP',
|
|
73
75
|
target: 'USD',
|
|
74
|
-
rate: 1.
|
|
76
|
+
rate: 1.3553,
|
|
75
77
|
rate_type: 'reference',
|
|
76
78
|
derived: false,
|
|
77
79
|
method: 'published',
|
|
@@ -96,9 +98,9 @@ console.log(table.rate_date, table.rates.length);
|
|
|
96
98
|
{
|
|
97
99
|
bank: 'boe',
|
|
98
100
|
name: 'Bank of England',
|
|
99
|
-
rate_date: '2026-08
|
|
101
|
+
rate_date: '2026-09-08',
|
|
100
102
|
rates: [
|
|
101
|
-
{ "base": "GBP", "quote": "USD", "type": "reference", "value": 1.
|
|
103
|
+
{ "base": "GBP", "quote": "USD", "type": "reference", "value": 1.3553 },
|
|
102
104
|
// … the rest of the published table (23 currencies vs GBP)
|
|
103
105
|
],
|
|
104
106
|
disclaimer: '…'
|
|
@@ -138,7 +140,7 @@ Paid plans. One resolved rate per publication date — ready for charting, reval
|
|
|
138
140
|
import { getHistory } from 'boe-exchange-rate';
|
|
139
141
|
|
|
140
142
|
const series = await getHistory(
|
|
141
|
-
{ source: 'GBP', target: 'USD', from: '2026-01-01', to: '2026-08
|
|
143
|
+
{ source: 'GBP', target: 'USD', from: '2026-01-01', to: '2026-09-08' },
|
|
142
144
|
{ apiKey: 'art_live_...' }
|
|
143
145
|
);
|
|
144
146
|
```
|
|
@@ -151,11 +153,11 @@ const series = await getHistory(
|
|
|
151
153
|
source: 'GBP',
|
|
152
154
|
target: 'USD',
|
|
153
155
|
from: '2026-01-01',
|
|
154
|
-
to: '2026-08
|
|
156
|
+
to: '2026-09-08',
|
|
155
157
|
count: 152,
|
|
156
158
|
rates: [
|
|
157
159
|
// one entry per publication date
|
|
158
|
-
{ date: '2026-08
|
|
160
|
+
{ date: '2026-09-08', rate: 1.3553, rate_type: 'reference', derived: false, method: 'published' },
|
|
159
161
|
// …
|
|
160
162
|
],
|
|
161
163
|
disclaimer: '…'
|
|
@@ -168,9 +170,9 @@ Pass `{ symbol: 'USD' }` instead of `source`/`target` to get the raw published r
|
|
|
168
170
|
|
|
169
171
|
## 🗺️ Currencies covered
|
|
170
172
|
|
|
171
|
-
Bank of England currently publishes rates covering **
|
|
173
|
+
Bank of England currently publishes rates covering **23 currencies** against the GBP (as of the latest table):
|
|
172
174
|
|
|
173
|
-
`AUD` · `CAD` · `CHF` · `CNY` · `DKK` · `EUR` ·
|
|
175
|
+
🇦🇺 `AUD` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇩🇰 `DKK` · 🇪🇺 `EUR` · 🇭🇰 `HKD` · 🇮🇱 `ILS` · 🇮🇳 `INR` · 🇯🇵 `JPY` · 🇰🇷 `KRW` · 🇲🇾 `MYR` · 🇳🇴 `NOK` · 🇳🇿 `NZD` · 🇵🇱 `PLN` · 🇸🇦 `SAR` · 🇸🇪 `SEK` · 🇸🇬 `SGD` · 🇹🇭 `THB` · 🇹🇷 `TRY` · 🇹🇼 `TWD` · 🇺🇸 `USD` · 🇿🇦 `ZAR`
|
|
174
176
|
|
|
175
177
|
## ⚖️ Published vs derived rates
|
|
176
178
|
|
|
@@ -234,6 +236,14 @@ getRate('GBP', 'USD', { apiKey: 'art_live_...' }).then((pair) => console.log(pai
|
|
|
234
236
|
| `getRatesForDate(date, { apiKey, source?, target? })` | Paid | The official table (or one pair) for a YYYY-MM-DD date |
|
|
235
237
|
| `getHistory({ symbol \| source+target, from?, to? }, { apiKey })` | Paid | Daily series since 2016 |
|
|
236
238
|
|
|
239
|
+
## 📥 Bulk data (no key)
|
|
240
|
+
|
|
241
|
+
Need the whole archive rather than an API call? The same published tables are mirrored daily as open data:
|
|
242
|
+
|
|
243
|
+
- Hugging Face: [AllRates/central-bank-exchange-rates](https://huggingface.co/datasets/AllRates/central-bank-exchange-rates) — one CSV per institution (`rates/boe.csv`)
|
|
244
|
+
- Kaggle: [allratestoday/central-bank-exchange-rates](https://www.kaggle.com/datasets/allratestoday/central-bank-exchange-rates)
|
|
245
|
+
- CDN JSON: `https://cdn.jsdelivr.net/gh/AllRates-Today/central-bank-exchange-rates@main/data/boe/latest.json`
|
|
246
|
+
|
|
237
247
|
## 🔗 Links
|
|
238
248
|
|
|
239
249
|
- [Bank of England rates page](https://allratestoday.com/central-bank-rates-api/boe/) — live table, publication cadence, FAQ
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "boe-exchange-rate",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "Official Bank of England (United Kingdom) daily exchange rates — 23 currencies vs GBP, history since 2016. Zero-dependency Node.js/TypeScript client.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"boe",
|