@allratestoday/sdk 1.3.3 โ 1.3.4
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 +22 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,21 +8,21 @@
|
|
|
8
8
|
|
|
9
9
|
**Real-time mid-market currency exchange rates for Node.js and browsers. The most elegant way to access 160+ currencies from Reuters/Refinitiv.**
|
|
10
10
|
|
|
11
|
-
## Why Choose This Client?
|
|
11
|
+
## ๐ Why Choose This Client?
|
|
12
12
|
|
|
13
|
-
- **Lightning Fast
|
|
14
|
-
- **Real-Time Data
|
|
15
|
-
- **Mid-Market Rates
|
|
16
|
-
- **160+ Currencies
|
|
17
|
-
- **Type-Safe
|
|
18
|
-
- **Universal
|
|
19
|
-
- **Developer-Friendly
|
|
13
|
+
- โก **Lightning Fast** โ Zero runtime dependencies, pure TypeScript performance
|
|
14
|
+
- ๐ก **Real-Time Data** โ Rates updated every 60 seconds from Reuters (Refinitiv) and interbank feeds
|
|
15
|
+
- ๐น **Mid-Market Rates** โ The true interbank rate โ no hidden spread or markup
|
|
16
|
+
- ๐ **160+ Currencies** โ Major, minor, and exotic currency pairs
|
|
17
|
+
- ๐ท **Type-Safe** โ Full TypeScript support with intelligent autocomplete
|
|
18
|
+
- ๐ **Universal** โ Works seamlessly in Node.js 18+ and modern browsers
|
|
19
|
+
- ๐งโ๐ป **Developer-Friendly** โ Simple API, extensive documentation, and great DX
|
|
20
20
|
|
|
21
|
-
## Get Your API Key
|
|
21
|
+
## ๐ Get Your API Key
|
|
22
22
|
|
|
23
23
|
Ready to start? Get your free API key from [allratestoday.com/register](https://allratestoday.com/register).
|
|
24
24
|
|
|
25
|
-
## Installation
|
|
25
|
+
## ๐ฆ Installation
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
28
|
npm install @allratestoday/sdk
|
|
@@ -36,7 +36,7 @@ yarn add @allratestoday/sdk
|
|
|
36
36
|
pnpm add @allratestoday/sdk
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
## Quick Start
|
|
39
|
+
## ๐ Quick Start
|
|
40
40
|
|
|
41
41
|
Get up and running in seconds:
|
|
42
42
|
|
|
@@ -51,7 +51,7 @@ const { rates } = await client.latest({ base: 'USD', symbols: ['EUR', 'GBP', 'JP
|
|
|
51
51
|
console.log(rates);
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
## API Reference
|
|
54
|
+
## ๐ API Reference
|
|
55
55
|
|
|
56
56
|
- [Latest Rates](#-latest-exchange-rates) โ Get current exchange rates
|
|
57
57
|
- [Historical Data](#-historical-exchange-rates) โ Fetch rates for specific dates
|
|
@@ -285,7 +285,7 @@ console.log(history);
|
|
|
285
285
|
|
|
286
286
|
---
|
|
287
287
|
|
|
288
|
-
## Configuration
|
|
288
|
+
## ๐ง Configuration
|
|
289
289
|
|
|
290
290
|
```typescript
|
|
291
291
|
const client = new AllRatesToday({
|
|
@@ -303,7 +303,7 @@ const client = new AllRatesToday({
|
|
|
303
303
|
|
|
304
304
|
---
|
|
305
305
|
|
|
306
|
-
## Per-Request API Key Override
|
|
306
|
+
## ๐ Per-Request API Key Override
|
|
307
307
|
|
|
308
308
|
Every method supports a per-request API key override โ useful for multi-tenant apps:
|
|
309
309
|
|
|
@@ -318,7 +318,7 @@ const { symbols } = await client.symbols({ apiKey: 'another_key' });
|
|
|
318
318
|
|
|
319
319
|
---
|
|
320
320
|
|
|
321
|
-
## Error Handling
|
|
321
|
+
## ๐ก๏ธ Error Handling
|
|
322
322
|
|
|
323
323
|
All errors are thrown as `AllRatesTodayError` with an optional HTTP status code:
|
|
324
324
|
|
|
@@ -345,7 +345,7 @@ try {
|
|
|
345
345
|
|
|
346
346
|
---
|
|
347
347
|
|
|
348
|
-
## TypeScript
|
|
348
|
+
## ๐ท TypeScript
|
|
349
349
|
|
|
350
350
|
The SDK is written in TypeScript and ships full type definitions. All interfaces are exported:
|
|
351
351
|
|
|
@@ -371,7 +371,7 @@ import AllRatesToday, {
|
|
|
371
371
|
|
|
372
372
|
---
|
|
373
373
|
|
|
374
|
-
## CommonJS
|
|
374
|
+
## ๐ฆ CommonJS
|
|
375
375
|
|
|
376
376
|
```javascript
|
|
377
377
|
const AllRatesToday = require('@allratestoday/sdk').default;
|
|
@@ -382,7 +382,7 @@ client.latest().then(data => console.log(data.rates));
|
|
|
382
382
|
|
|
383
383
|
---
|
|
384
384
|
|
|
385
|
-
## Examples
|
|
385
|
+
## ๐ก Examples
|
|
386
386
|
|
|
387
387
|
### Currency Dropdown (React)
|
|
388
388
|
|
|
@@ -457,7 +457,7 @@ console.log({ labels, values });
|
|
|
457
457
|
|
|
458
458
|
---
|
|
459
459
|
|
|
460
|
-
## Methods Reference
|
|
460
|
+
## ๐ Methods Reference
|
|
461
461
|
|
|
462
462
|
| Method | Description |
|
|
463
463
|
| ------ | ----------- |
|
|
@@ -472,7 +472,7 @@ console.log({ labels, values });
|
|
|
472
472
|
|
|
473
473
|
---
|
|
474
474
|
|
|
475
|
-
## Testing
|
|
475
|
+
## ๐งช Testing
|
|
476
476
|
|
|
477
477
|
Run isolated unit tests (no API calls needed):
|
|
478
478
|
|
|
@@ -494,7 +494,7 @@ npm run test:watch
|
|
|
494
494
|
|
|
495
495
|
---
|
|
496
496
|
|
|
497
|
-
## Links
|
|
497
|
+
## ๐ Links
|
|
498
498
|
|
|
499
499
|
- [API Documentation](https://allratestoday.com/developers)
|
|
500
500
|
- [Register (Free)](https://allratestoday.com/register)
|
|
@@ -502,6 +502,6 @@ npm run test:watch
|
|
|
502
502
|
- [Status](https://allratestoday.com/status)
|
|
503
503
|
- [GitHub](https://github.com/allratestoday/exchange-rates-api)
|
|
504
504
|
|
|
505
|
-
## License
|
|
505
|
+
## ๐ License
|
|
506
506
|
|
|
507
507
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@allratestoday/sdk",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.4",
|
|
4
4
|
"description": "Exchange Rate API โ Real-time mid-market currency exchange rates for Node.js and browsers. 160+ currencies from Reuters/Refinitiv, zero dependencies, free tier.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|