@apiverve/interestrate 1.1.13 → 1.2.0

package/README.md

@@ -1,6 +1,6 @@
 # Interest Rate API
 
-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.
+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.
 
 ![Build Status](https://img.shields.io/badge/build-passing-green)
 ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
@@ -60,7 +60,8 @@ Using the API is simple. All you have to do is make a request. The API will retu
 
 ```javascript
 var query = {
-  country: "US"
+  country: "US",
+  date: "2024-06"
 };
 
 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
 
 ```javascript
 var query = {
-  country: "US"
+  country: "US",
+  date: "2024-06"
 };
 
 api.execute(query)
@@ -101,7 +103,8 @@ You can also use async/await to make requests. The API returns a promise that yo
 ```javascript
 async function makeRequest() {
     var query = {
-  country: "US"
+  country: "US",
+  date: "2024-06"
 };
 
     try {
@@ -125,9 +128,13 @@ async function makeRequest() {
     "country": "US",
     "countryName": "United States",
     "centralBank": "Federal Reserve",
-    "rate": 3.75,
+    "rate": 4.5,
     "date": "2026-02-05",
-    "lastUpdated": "2026-02-05T05:00:00.000Z"
+    "lastUpdated": "2026-02-05T05:00:00.000Z",
+    "lastChanged": "2026-01-29",
+    "change": -0.25,
+    "changeDirection": "down",
+    "previousRate": 4.75
   }
 }
 ```

package/index.d.ts

@@ -4,21 +4,37 @@ declare module '@apiverve/interestrate' {
     secure?: boolean;
   }
 
+  /**
+   * Describes fields the current plan does not unlock. Locked fields arrive as null
+   * in `data`; `locked_fields` names them, using dot paths for nested fields.
+   * Absent when the plan unlocks everything.
+   */
+  export interface PremiumInfo {
+    message: string;
+    upgrade_url: string;
+    locked_fields: string[];
+  }
+
   export interface interestrateResponse {
     status: string;
     error: string | null;
     data: InterestRateData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface InterestRateData {
-      country:     string;
-      countryName: string;
-      centralBank: string;
-      rate:        number;
-      date:        Date;
-      lastUpdated: Date;
+      country:         null | string;
+      countryName:     null | string;
+      centralBank:     null | string;
+      rate:            number | null;
+      date:            Date | null;
+      lastUpdated:     Date | null;
+      lastChanged:     Date | null;
+      change:          number | null;
+      changeDirection: null | string;
+      previousRate:    number | null;
   }
 
   export default class interestrateWrapper {

package/index.js

@@ -13,16 +13,10 @@ class interestrateWrapper {
             throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
         }
 
-        // Validate API key format (GUID or alphanumeric with hyphens)
-        const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
+        // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
+        const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
         if (!apiKeyPattern.test(api_key)) {
-            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
-        }
-
-        // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
-        const trimmedKey = api_key.replace(/-/g, '');
-        if (trimmedKey.length < 32) {
-            throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
+            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
         }
 
         if (typeof secure !== 'boolean') {
@@ -36,7 +30,7 @@ class interestrateWrapper {
         this.baseURL = 'https://api.apiverve.com/v1/interestrate';
 
         // Validation rules for parameters (generated from schema)
-        this.validationRules = {"country":{"type":"string","required":true,"minLength":2,"maxLength":2}};
+        this.validationRules = {"country":{"type":"string","required":true,"minLength":2,"maxLength":2},"date":{"type":"string","required":false}};
     }
 
     /**

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/interestrate",
-  "version": "1.1.13",
-  "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.",
+  "version": "1.2.0",
+  "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.",
   "main": "index.js",
   "types": "index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "index.js",
@@ -23,7 +23,7 @@
     "directory": "npm"
   },
   "keywords": [
-    ""
+    "interest rate", "central bank", "policy rate", "federal funds rate", "ecb rate"
   ],
   "author": {
     "name": "APIVerve",
@@ -41,8 +41,7 @@
     "dotenv": "^16.4.7"
   },
   "dependencies": {
-    "node-fetch": "^3.3.2",
-    "promise": "^8.3.0",
-    "axios": "1.13.2"
+    "axios": "1.13.2",
+    "form-data": "^4.0.1"
   }
 }