boe-exchange-rate 1.0.1 → 1.1.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 CHANGED
@@ -1,10 +1,10 @@
1
1
  # Bank of England Exchange Rate API client
2
2
 
3
- Official **Bank of England** (the United Kingdom) daily exchange rates in Node.js / TypeScript — ~23 currencies against the GBP, with history back to 2016. Zero dependencies, works in Node 18+, Bun, Deno, and edge runtimes (uses global `fetch`).
3
+ Official **Bank of England** (the United Kingdom) daily exchange rates in Node.js / TypeScript — 23 currencies against the GBP, with history back to 2016. Zero dependencies, works in Node 18+, Bun, Deno, and edge runtimes (uses global `fetch`).
4
4
 
5
- These are the *published central bank rates* required for tax filings, customs valuations, audits, and compliant invoicing — not moving market rates. Every response carries the bank's own publication date.
5
+ These are the *published central bank rates* required for tax filings, customs valuations, audits, and compliant invoicing — not moving market rates. Every response carries the publisher's own publication date.
6
6
 
7
- Powered by [AllRatesToday](https://allratestoday.com/central-bank-rates-api/boe/). Get a free API key at [allratestoday.com/register](https://allratestoday.com/register) — 300 requests/month, no credit card.
7
+ Powered by [AllRatesToday](https://allratestoday.com/central-bank-rates-api/boe/). Get a free API key at [allratestoday.com/register](https://allratestoday.com/register) — no credit card required.
8
8
 
9
9
  ## Install
10
10
 
@@ -42,6 +42,14 @@ const series = await getHistory(
42
42
  );
43
43
  ```
44
44
 
45
+ ## Currencies covered
46
+
47
+ Bank of England currently publishes rates covering **24 currencies** (as of the latest table):
48
+
49
+ `AUD` · `CAD` · `CHF` · `CNY` · `DKK` · `EUR` · `GBP` · `HKD` · `ILS` · `INR` · `JPY` · `KRW` · `MYR` · `NOK` · `NZD` · `PLN` · `SAR` · `SEK` · `SGD` · `THB` · `TRY` · `TWD` · `USD` · `ZAR`
50
+
51
+ Pairs the central bank does not print directly are resolved from this table (see below).
52
+
45
53
  ## Published vs derived rates
46
54
 
47
55
  If Bank of England does not print a pair directly, the API resolves it from the bank's table (inverse, or a cross rate via GBP) and flags it `derived: true` with the `method` — so official and computed values are never confused.
@@ -50,7 +58,7 @@ If Bank of England does not print a pair directly, the API resolves it from the
50
58
 
51
59
  - Every request counts toward your AllRatesToday monthly quota. Rates change once per business day — cache a day's table locally and a small quota goes a long way.
52
60
  - Latest rates are on every plan (including free); historical dates and time series need a [paid plan](https://allratestoday.com/pricing/).
53
- - Full API reference: [allratestoday.com/docs#central-bank](https://allratestoday.com/docs/#central-bank) · All covered banks: [central bank rates API](https://allratestoday.com/central-bank-rates-api/)
61
+ - Full API reference: [allratestoday.com/docs#central-bank](https://allratestoday.com/docs/#central-bank) · All covered sources: [central bank rates API](https://allratestoday.com/central-bank-rates-api/)
54
62
 
55
63
  ## License
56
64
 
package/index.cjs CHANGED
@@ -1,7 +1,7 @@
1
1
  'use strict';
2
2
  // Bank of England exchange rates via the AllRatesToday API.
3
3
  const BASE = 'https://allratestoday.com/api/v1/central-bank/boe';
4
- const KEY_HINT = 'An apiKey is required — get a free key at https://allratestoday.com/register (300 requests/month, no credit card).';
4
+ const KEY_HINT = 'An apiKey is required — get a free key at https://allratestoday.com/register (no credit card required).';
5
5
 
6
6
  async function request(path, params, options) {
7
7
  const apiKey = options && options.apiKey;
package/index.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  // Bank of England exchange rates via the AllRatesToday API.
2
2
  const BASE = 'https://allratestoday.com/api/v1/central-bank/boe';
3
- const KEY_HINT = 'An apiKey is required — get a free key at https://allratestoday.com/register (300 requests/month, no credit card).';
3
+ const KEY_HINT = 'An apiKey is required — get a free key at https://allratestoday.com/register (no credit card required).';
4
4
 
5
5
  async function request(path, params, options) {
6
6
  const apiKey = options && options.apiKey;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "boe-exchange-rate",
3
- "version": "1.0.1",
4
- "description": "Official Bank of England (United Kingdom) daily exchange rates — ~23 currencies vs GBP, history since 2016. Zero-dependency Node.js/TypeScript client.",
3
+ "version": "1.1.0",
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",
7
7
  "bank",