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