@allratestoday/bok-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 +68 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Bank of Korea Exchange Rate API — bok-exchange-rate
1
+ # Bank of Korea Exchange Rates API — bok-exchange-rate
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@allratestoday%2Fbok-exchange-rate.svg)](https://www.npmjs.com/package/@allratestoday/bok-exchange-rate)
4
4
  [![license](https://img.shields.io/npm/l/@allratestoday%2Fbok-exchange-rate.svg)](https://github.com/AllRates-Today/bok-exchange-rate/blob/main/LICENSE)
@@ -18,6 +18,21 @@
18
18
 
19
19
  > **Official rate, not mid-market:** every value here is a number Bank of Korea 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 Bank of Korea 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/bok?source=USD&target=KRW"
27
+ ```
28
+
29
+ ```js
30
+ const r = await fetch('https://allratestoday.com/api/open/central-bank/bok').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/bok-exchange-rate
36
51
  pnpm add @allratestoday/bok-exchange-rate
37
52
  ```
38
53
 
39
- Scoped mirror of [`bok-exchange-rate`](https://www.npmjs.com/package/bok-exchange-rate) — same code, same versions.
54
+ Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Scoped mirror of [`bok-exchange-rate`](https://www.npmjs.com/package/bok-exchange-rate) — same code, same versions.
40
55
 
41
56
  ## 🏁 Quick start
42
57
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'KRW', { apiKey: 'art_live_...' });
70
85
  {
71
86
  bank: 'bok',
72
87
  name: 'Bank of Korea',
73
- rate_date: '2026-08-24', // Bank of Korea's own publication date
88
+ rate_date: '2026-09-09', // Bank of Korea's own publication date
74
89
  source: 'USD',
75
90
  target: 'KRW',
76
- rate: 1383.6,
91
+ rate: 1341.1,
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: 'bok',
100
115
  name: 'Bank of Korea',
101
- rate_date: '2026-08-24',
116
+ rate_date: '2026-09-09',
102
117
  rates: [
103
- { "base": "USD", "quote": "KRW", "type": "reference", "value": 1383.6 },
118
+ { "base": "USD", "quote": "KRW", "type": "reference", "value": 1341.1 },
104
119
  // … the rest of the published table (43 currencies vs KRW)
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/bok-exchange-rate';
141
156
 
142
157
  const series = await getHistory(
143
- { source: 'USD', target: 'KRW', from: '2026-01-01', to: '2026-08-24' },
158
+ { source: 'USD', target: 'KRW', 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: 'KRW',
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: 1383.6, rate_type: 'reference', derived: false, method: 'published' },
175
+ { date: '2026-09-09', rate: 1341.1, rate_type: 'reference', derived: false, method: 'published' },
161
176
  // …
162
177
  ],
163
178
  disclaimer: '…'
@@ -174,6 +189,39 @@ Bank of Korea currently publishes rates covering **43 currencies** against the K
174
189
 
175
190
  🇦🇪 `AED` · 🇦🇷 `ARS` · 🇦🇺 `AUD` · 🇧🇩 `BDT` · 🇧🇭 `BHD` · 🇧🇳 `BND` · 🇧🇷 `BRL` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇨🇿 `CZK` · 🇩🇰 `DKK` · 🇪🇬 `EGP` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇭🇰 `HKD` · 🇭🇺 `HUF` · 🇮🇩 `IDR` · 🇮🇱 `ILS` · 🇮🇳 `INR` · 🇯🇴 `JOD` · 🇯🇵 `JPY` · 🇰🇼 `KWD` · 🇰🇿 `KZT` · 🇲🇳 `MNT` · 🇲🇽 `MXN` · 🇲🇾 `MYR` · 🇳🇴 `NOK` · 🇳🇿 `NZD` · 🇵🇭 `PHP` · 🇵🇰 `PKR` · 🇵🇱 `PLN` · 🇶🇦 `QAR` · 🇷🇺 `RUB` · 🇸🇦 `SAR` · 🇸🇪 `SEK` · 🇸🇬 `SGD` · 🇹🇭 `THB` · 🇹🇷 `TRY` · 🇹🇼 `TWD` · 🇺🇸 `USD` · 🇻🇳 `VND` · 🇿🇦 `ZAR`
176
191
 
192
+ ## 🏛️ Source
193
+
194
+ The Bank of Korea publishes the won's daily basic exchange rates (매매기준율, the market average rate set by Seoul Money Brokerage each business morning at 08:10 KST) for around 40 active currencies through its ECOS statistics system, with history reaching back to 1964.
195
+
196
+ - Publisher's own page: [ECOS — Economic Statistics System (3.1.1.1)](https://ecos.bok.or.kr/#/SearchStat) · [www.bok.or.kr/eng/main/main.do](https://www.bok.or.kr/eng/main/main.do)
197
+ - Publication: every business day; the exact schedule, freshness status and any current delay are on the [Bank of Korea rates page](https://allratestoday.com/central-bank-rates-api/bok/)
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
+ - Bank of Korea quotes **KRW per 1 unit of foreign currency** (e.g. `base: "USD", quote: "KRW"` means KRW 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
+ - `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.
206
+
207
+ ## 🧩 ERP & accounting systems
208
+
209
+ Loading the official Bank of Korea rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:
210
+
211
+ - [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code
212
+ - [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/)
213
+
214
+ 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:
215
+
216
+ ```bash
217
+ curl "https://allratestoday.com/api/v1/central-bank/bok/latest?format=xml&api_key=art_live_..."
218
+ ```
219
+
220
+ ## 🤖 AI agents
221
+
222
+ - 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
223
+ - Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)
224
+
177
225
  ## ⚖️ Published vs derived rates
178
226
 
179
227
  If Bank of Korea 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 +284,20 @@ getRate('USD', 'KRW', { apiKey: 'art_live_...' }).then((pair) => console.log(pai
236
284
  | `getRatesForDate(date, { apiKey, source?, target? })` | Paid | The official table (or one pair) for a YYYY-MM-DD date |
237
285
  | `getHistory({ symbol \| source+target, from?, to? }, { apiKey })` | Paid | Daily series since 1964 |
238
286
 
287
+ ## 📥 Bulk data (no key)
288
+
289
+ Need the whole archive rather than an API call? The same published tables are mirrored daily as open data:
290
+
291
+ - Hugging Face: [AllRates/central-bank-exchange-rates](https://huggingface.co/datasets/AllRates/central-bank-exchange-rates) — one CSV per institution (`rates/bok.csv`)
292
+ - Kaggle: [allratestoday/central-bank-exchange-rates](https://www.kaggle.com/datasets/allratestoday/central-bank-exchange-rates)
293
+ - CDN JSON: `https://cdn.jsdelivr.net/gh/AllRates-Today/central-bank-exchange-rates@main/data/bok/latest.json`
294
+
239
295
  ## 🔗 Links
240
296
 
241
297
  - [Bank of Korea rates page](https://allratestoday.com/central-bank-rates-api/bok/) — live table, publication cadence, FAQ
242
298
  - [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/)
299
+ - [Package docs on the site](https://allratestoday.com/docs/sdk/bok-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)
300
+ - [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)
244
301
  - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
245
302
  - [GitHub](https://github.com/AllRates-Today/bok-exchange-rate)
246
303
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@allratestoday/bok-exchange-rate",
3
- "version": "1.2.7",
3
+ "version": "1.3.1",
4
4
  "description": "Official Bank of Korea (South Korea) daily exchange rates — 43 currencies vs KRW, history since 1964. Zero-dependency Node.js/TypeScript client.",
5
5
  "keywords": [
6
6
  "bok",