@apiverve/interestrate 1.1.14 → 1.2.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 +13 -6
- package/index.d.ts +22 -6
- package/index.js +1 -1
- package/package.json +6 -7
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Interest Rate API
|
|
2
2
|
|
|
3
|
-
Interest Rate is a tool for retrieving current central bank policy interest rates for major economies worldwide. It returns the latest rate along with the central bank name and effective date.
|
|
3
|
+
Interest Rate is a tool for retrieving current and historical central bank policy interest rates for major economies worldwide. It returns the latest rate along with the central bank name and effective date.
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
@@ -60,7 +60,8 @@ Using the API is simple. All you have to do is make a request. The API will retu
|
|
|
60
60
|
|
|
61
61
|
```javascript
|
|
62
62
|
var query = {
|
|
63
|
-
country: "US"
|
|
63
|
+
country: "US",
|
|
64
|
+
date: "2024-06"
|
|
64
65
|
};
|
|
65
66
|
|
|
66
67
|
api.execute(query, function (error, data) {
|
|
@@ -80,7 +81,8 @@ You can also use promises to make requests. The API returns a promise that you c
|
|
|
80
81
|
|
|
81
82
|
```javascript
|
|
82
83
|
var query = {
|
|
83
|
-
country: "US"
|
|
84
|
+
country: "US",
|
|
85
|
+
date: "2024-06"
|
|
84
86
|
};
|
|
85
87
|
|
|
86
88
|
api.execute(query)
|
|
@@ -101,7 +103,8 @@ You can also use async/await to make requests. The API returns a promise that yo
|
|
|
101
103
|
```javascript
|
|
102
104
|
async function makeRequest() {
|
|
103
105
|
var query = {
|
|
104
|
-
country: "US"
|
|
106
|
+
country: "US",
|
|
107
|
+
date: "2024-06"
|
|
105
108
|
};
|
|
106
109
|
|
|
107
110
|
try {
|
|
@@ -125,9 +128,13 @@ async function makeRequest() {
|
|
|
125
128
|
"country": "US",
|
|
126
129
|
"countryName": "United States",
|
|
127
130
|
"centralBank": "Federal Reserve",
|
|
128
|
-
"rate":
|
|
131
|
+
"rate": 4.5,
|
|
129
132
|
"date": "2026-02-05",
|
|
130
|
-
"lastUpdated": "2026-02-05T05:00:00.000Z"
|
|
133
|
+
"lastUpdated": "2026-02-05T05:00:00.000Z",
|
|
134
|
+
"lastChanged": "2026-01-29",
|
|
135
|
+
"change": -0.25,
|
|
136
|
+
"changeDirection": "down",
|
|
137
|
+
"previousRate": 4.75
|
|
131
138
|
}
|
|
132
139
|
}
|
|
133
140
|
```
|
package/index.d.ts
CHANGED
|
@@ -4,21 +4,37 @@ declare module '@apiverve/interestrate' {
|
|
|
4
4
|
secure?: boolean;
|
|
5
5
|
}
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* Describes fields the current plan does not unlock. Locked fields arrive as null
|
|
9
|
+
* in `data`; `locked_fields` names them, using dot paths for nested fields.
|
|
10
|
+
* Absent when the plan unlocks everything.
|
|
11
|
+
*/
|
|
12
|
+
export interface PremiumInfo {
|
|
13
|
+
message: string;
|
|
14
|
+
upgrade_url: string;
|
|
15
|
+
locked_fields: string[];
|
|
16
|
+
}
|
|
17
|
+
|
|
7
18
|
export interface interestrateResponse {
|
|
8
19
|
status: string;
|
|
9
20
|
error: string | null;
|
|
10
21
|
data: InterestRateData;
|
|
11
22
|
code?: number;
|
|
23
|
+
premium?: PremiumInfo;
|
|
12
24
|
}
|
|
13
25
|
|
|
14
26
|
|
|
15
27
|
interface InterestRateData {
|
|
16
|
-
country:
|
|
17
|
-
countryName: string;
|
|
18
|
-
centralBank: string;
|
|
19
|
-
rate:
|
|
20
|
-
date:
|
|
21
|
-
lastUpdated:
|
|
28
|
+
country: null | string;
|
|
29
|
+
countryName: null | string;
|
|
30
|
+
centralBank: null | string;
|
|
31
|
+
rate: number | null;
|
|
32
|
+
date: Date | null;
|
|
33
|
+
lastUpdated: Date | null;
|
|
34
|
+
lastChanged: Date | null;
|
|
35
|
+
change: number | null;
|
|
36
|
+
changeDirection: null | string;
|
|
37
|
+
previousRate: number | null;
|
|
22
38
|
}
|
|
23
39
|
|
|
24
40
|
export default class interestrateWrapper {
|
package/index.js
CHANGED
|
@@ -30,7 +30,7 @@ class interestrateWrapper {
|
|
|
30
30
|
this.baseURL = 'https://api.apiverve.com/v1/interestrate';
|
|
31
31
|
|
|
32
32
|
// Validation rules for parameters (generated from schema)
|
|
33
|
-
this.validationRules = {"country":{"type":"string","required":true,"minLength":2,"maxLength":2}};
|
|
33
|
+
this.validationRules = {"country":{"type":"string","required":true,"minLength":2,"maxLength":2},"date":{"type":"string","required":false}};
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
/**
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@apiverve/interestrate",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Interest Rate is a tool for retrieving current central bank policy interest rates for major economies worldwide. It returns the latest rate along with the central bank name and effective date.",
|
|
3
|
+
"version": "1.2.0",
|
|
4
|
+
"description": "Interest Rate is a tool for retrieving current and historical central bank policy interest rates for major economies worldwide. It returns the latest rate along with the central bank name and effective date.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
7
7
|
"sideEffects": false,
|
|
8
8
|
"engines": {
|
|
9
|
-
"node": ">=
|
|
9
|
+
"node": ">=18.0.0"
|
|
10
10
|
},
|
|
11
11
|
"files": [
|
|
12
12
|
"index.js",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"directory": "npm"
|
|
24
24
|
},
|
|
25
25
|
"keywords": [
|
|
26
|
-
""
|
|
26
|
+
"interest rate", "central bank", "policy rate", "federal funds rate", "ecb rate"
|
|
27
27
|
],
|
|
28
28
|
"author": {
|
|
29
29
|
"name": "APIVerve",
|
|
@@ -41,8 +41,7 @@
|
|
|
41
41
|
"dotenv": "^16.4.7"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"
|
|
45
|
-
"
|
|
46
|
-
"axios": "1.13.2"
|
|
44
|
+
"axios": "1.13.2",
|
|
45
|
+
"form-data": "^4.0.1"
|
|
47
46
|
}
|
|
48
47
|
}
|