@apiverve/treasuryyields 1.1.13 → 1.2.0

package/README.md

@@ -1,13 +1,13 @@
 # Treasury Yields API
 
-Treasury Yields provides current and historical interest rates for US Treasury securities including T-bills, T-notes, T-bonds, TIPS, and Floating Rate Notes. Essential data for yield curve analysis and fixed income research.
+Treasury Yields provides current and historical US Treasury constant-maturity market yields across the full curve (1-month through 30-year), plus TIPS real yields. Essential data for yield curve analysis and fixed income research.
 
 ![Build Status](https://img.shields.io/badge/build-passing-green)
 ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
 ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
 [![npm version](https://img.shields.io/npm/v/@apiverve/treasuryyields.svg)](https://www.npmjs.com/package/@apiverve/treasuryyields)
 
-This is a Javascript Wrapper for the [Treasury Yields API](https://apiverve.com/marketplace/treasuryyields?utm_source=npm&utm_medium=readme)
+This is a Javascript Wrapper for the [Treasury Yields API](https://treasuryyields.apiverve.com?utm_source=npm&utm_medium=readme)
 
 ---
 
@@ -60,8 +60,8 @@ Using the API is simple. All you have to do is make a request. The API will retu
 
 ```javascript
 var query = {
-  date: "2024-01-15",
-  type: "bonds"
+  date: "2025-06",
+  type: "10yr"
 };
 
 api.execute(query, function (error, data) {
@@ -81,8 +81,8 @@ You can also use promises to make requests. The API returns a promise that you c
 
 ```javascript
 var query = {
-  date: "2024-01-15",
-  type: "bonds"
+  date: "2025-06",
+  type: "10yr"
 };
 
 api.execute(query)
@@ -103,8 +103,8 @@ You can also use async/await to make requests. The API returns a promise that yo
 ```javascript
 async function makeRequest() {
     var query = {
-  date: "2024-01-15",
-  type: "bonds"
+  date: "2025-06",
+  type: "10yr"
 };
 
     try {
@@ -130,7 +130,30 @@ async function makeRequest() {
     "notes": 4.35,
     "bonds": 4.67,
     "tips": 2.15,
-    "frn": 5.31
+    "frn": 5.31,
+    "changes": {
+      "bills": {
+        "change1d": 0.02,
+        "direction": "up"
+      },
+      "notes": {
+        "change1d": -0.03,
+        "direction": "down"
+      },
+      "bonds": {
+        "change1d": 0.01,
+        "direction": "up"
+      },
+      "tips": {
+        "change1d": 0,
+        "direction": "unchanged"
+      },
+      "frn": {
+        "change1d": 0.02,
+        "direction": "up"
+      }
+    },
+    "previousDate": "2024-01-31"
   }
 }
 ```

package/index.d.ts

@@ -4,21 +4,48 @@ declare module '@apiverve/treasuryyields' {
     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 treasuryyieldsResponse {
     status: string;
     error: string | null;
     data: TreasuryYieldsData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface TreasuryYieldsData {
-      date:  Date;
-      bills: number;
-      notes: number;
-      bonds: number;
-      tips:  number;
-      frn:   number;
+      date:         Date | null;
+      bills:        number | null;
+      notes:        number | null;
+      bonds:        number | null;
+      tips:         number | null;
+      frn:          number | null;
+      changes:      Changes;
+      previousDate: Date | null;
+  }
+  
+  interface Changes {
+      bills: Bills;
+      notes: Bills;
+      bonds: Bills;
+      tips:  Bills;
+      frn:   Bills;
+  }
+  
+  interface Bills {
+      change1D:  number | null;
+      direction: null | string;
   }
 
   export default class treasuryyieldsWrapper {

package/index.js

@@ -13,16 +13,10 @@ class treasuryyieldsWrapper {
             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 treasuryyieldsWrapper {
         this.baseURL = 'https://api.apiverve.com/v1/treasuryyields';
 
         // Validation rules for parameters (generated from schema)
-        this.validationRules = {"date":{"type":"string","required":false,"format":"date"},"type":{"type":"string","required":false}};
+        this.validationRules = {"date":{"type":"string","required":false},"type":{"type":"string","required":false}};
     }
 
     /**

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/treasuryyields",
-  "version": "1.1.13",
-  "description": "Treasury Yields provides current and historical interest rates for US Treasury securities including T-bills, T-notes, T-bonds, TIPS, and Floating Rate Notes. Essential data for yield curve analysis and fixed income research.",
+  "version": "1.2.0",
+  "description": "Treasury Yields provides current and historical US Treasury constant-maturity market yields across the full curve (1-month through 30-year), plus TIPS real yields. Essential data for yield curve analysis and fixed income research.",
   "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": [
-    ""
+    "treasury yields", "t-bill rates", "treasury bonds", "treasury notes", "tips rates"
   ],
   "author": {
     "name": "APIVerve",
@@ -34,15 +34,14 @@
   "bugs": {
     "url": "https://github.com/apiverve/treasuryyields-api/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/treasuryyields?utm_source=npm&utm_medium=homepage",
+  "homepage": "https://treasuryyields.apiverve.com?utm_source=npm&utm_medium=homepage",
   "devDependencies": {
     "mocha": "^11.0.1",
     "chai": "^5.1.2",
     "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"
   }
 }