@allratestoday/sbv-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 +61 -14
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # State Bank of Vietnam Exchange Rate API — sbv-exchange-rate
1
+ # State Bank of Vietnam Exchange Rates API — sbv-exchange-rate
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@allratestoday%2Fsbv-exchange-rate.svg)](https://www.npmjs.com/package/@allratestoday/sbv-exchange-rate)
4
4
  [![license](https://img.shields.io/npm/l/@allratestoday%2Fsbv-exchange-rate.svg)](https://github.com/AllRates-Today/sbv-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 State Bank of Vietnam 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 State Bank of Vietnam 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 State Bank of Vietnam 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/sbv?source=USD&target=VND"
27
+ ```
28
+
29
+ ```js
30
+ const r = await fetch('https://allratestoday.com/api/open/central-bank/sbv').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 @allratestoday/sbv-exchange-rate
36
51
  pnpm add @allratestoday/sbv-exchange-rate
37
52
  ```
38
53
 
39
- Scoped mirror of [`sbv-exchange-rate`](https://www.npmjs.com/package/sbv-exchange-rate) — same code, same versions.
54
+ Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Scoped mirror of [`sbv-exchange-rate`](https://www.npmjs.com/package/sbv-exchange-rate) — same code, same versions.
40
55
 
41
56
  ## 🏁 Quick start
42
57
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'VND', { apiKey: 'art_live_...' });
70
85
  {
71
86
  bank: 'sbv',
72
87
  name: 'State Bank of Vietnam',
73
- rate_date: '2026-09-09', // State Bank of Vietnam's own publication date
88
+ rate_date: '2026-09-26', // State Bank of Vietnam's own publication date
74
89
  source: 'USD',
75
90
  target: 'VND',
76
- rate: 25594,
91
+ rate: 25641,
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,11 +113,9 @@ console.log(table.rate_date, table.rates.length);
98
113
  {
99
114
  bank: 'sbv',
100
115
  name: 'State Bank of Vietnam',
101
- rate_date: '2026-09-09',
116
+ rate_date: '2026-09-26',
102
117
  rates: [
103
- { "base": "USD", "quote": "VND", "type": "reference", "value": 25594 },
104
- { "base": "USD", "quote": "VND", "type": "sell", "value": 26823 },
105
- { "base": "USD", "quote": "VND", "type": "buy", "value": 24365 },
118
+ { "base": "USD", "quote": "VND", "type": "reference", "value": 25641 },
106
119
  // … the rest of the published table (28 currencies vs VND)
107
120
  ],
108
121
  disclaimer: '…'
@@ -142,7 +155,7 @@ Paid plans. One resolved rate per publication date — ready for charting, reval
142
155
  import { getHistory } from '@allratestoday/sbv-exchange-rate';
143
156
 
144
157
  const series = await getHistory(
145
- { source: 'USD', target: 'VND', from: '2026-01-01', to: '2026-09-09' },
158
+ { source: 'USD', target: 'VND', from: '2026-01-01', to: '2026-09-26' },
146
159
  { apiKey: 'art_live_...' }
147
160
  );
148
161
  ```
@@ -155,11 +168,11 @@ const series = await getHistory(
155
168
  source: 'USD',
156
169
  target: 'VND',
157
170
  from: '2026-01-01',
158
- to: '2026-09-09',
171
+ to: '2026-09-26',
159
172
  count: 152,
160
173
  rates: [
161
174
  // one entry per publication date
162
- { date: '2026-09-09', rate: 25594, rate_type: 'reference', derived: false, method: 'published' },
175
+ { date: '2026-09-26', rate: 25641, rate_type: 'reference', derived: false, method: 'published' },
163
176
  // …
164
177
  ],
165
178
  disclaimer: '…'
@@ -176,6 +189,39 @@ State Bank of Vietnam currently publishes rates covering **28 currencies** again
176
189
 
177
190
  🇦🇪 `AED` · 🇦🇺 `AUD` · 🇧🇷 `BRL` · 🇨🇦 `CAD` · 🇨🇭 `CHF` · 🇨🇳 `CNY` · 🇩🇰 `DKK` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇭🇰 `HKD` · 🇮🇩 `IDR` · 🇮🇳 `INR` · 🇯🇵 `JPY` · 🇰🇭 `KHR` · 🇰🇷 `KRW` · 🇱🇦 `LAK` · 🇲🇴 `MOP` · 🇲🇾 `MYR` · 🇳🇴 `NOK` · 🇳🇿 `NZD` · 🇵🇱 `PLN` · 🇷🇺 `RUB` · 🇸🇪 `SEK` · 🇸🇬 `SGD` · 🇹🇭 `THB` · 🇹🇷 `TRY` · 🇹🇼 `TWD` · 🇺🇸 `USD`
178
191
 
192
+ ## 🏛️ Source
193
+
194
+ The State Bank of Vietnam announces a daily USD/VND central rate — each announcement carrying its own decree number — around which banks may trade within a band, plus reference buying and selling rates for seven currencies and a weekly 27-currency cross-rate table used for customs and tax valuation. The central-rate series reaches back to 2009.
195
+
196
+ - Publisher's own page: [Central exchange rate](https://www.sbv.gov.vn/bieu-do-ty-gia-trung-tam) · [www.sbv.gov.vn](https://www.sbv.gov.vn)
197
+ - Publication: every business day; the exact schedule, freshness status and any current delay are on the [State Bank of Vietnam rates page](https://allratestoday.com/central-bank-rates-api/sbv/)
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
+ - State Bank of Vietnam quotes **VND per 1 unit of foreign currency** (e.g. `base: "USD", quote: "VND"` means VND 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 State Bank of Vietnam 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/sbv/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
+
179
225
  ## ⚖️ Published vs derived rates
180
226
 
181
227
  If State Bank of Vietnam 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:
@@ -250,7 +296,8 @@ Need the whole archive rather than an API call? The same published tables are mi
250
296
 
251
297
  - [State Bank of Vietnam rates page](https://allratestoday.com/central-bank-rates-api/sbv/) — live table, publication cadence, FAQ
252
298
  - [All central bank sources](https://allratestoday.com/central-bank-rates-api/)
253
- - [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/sbv-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/)
254
301
  - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
255
302
  - [GitHub](https://github.com/AllRates-Today/sbv-exchange-rate)
256
303
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@allratestoday/sbv-exchange-rate",
3
- "version": "1.3.0",
3
+ "version": "1.3.3",
4
4
  "description": "Official State Bank of Vietnam (Vietnam) daily exchange rates — 28 currencies vs VND, history since 2009. Zero-dependency Node.js/TypeScript client.",
5
5
  "keywords": [
6
6
  "sbv",