@apiverve/benchmarkrate 1.1.13 → 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 CHANGED
@@ -7,7 +7,7 @@ Benchmark Rate is a tool for retrieving current risk-free reference rates that r
7
7
  ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
8
8
  [![npm version](https://img.shields.io/npm/v/@apiverve/benchmarkrate.svg)](https://www.npmjs.com/package/@apiverve/benchmarkrate)
9
9
 
10
- This is a Javascript Wrapper for the [Benchmark Rate API](https://apiverve.com/marketplace/benchmarkrate?utm_source=npm&utm_medium=readme)
10
+ This is a Javascript Wrapper for the [Benchmark Rate API](https://benchmarkrate.apiverve.com?utm_source=npm&utm_medium=readme)
11
11
 
12
12
  ---
13
13
 
@@ -127,9 +127,13 @@ async function makeRequest() {
127
127
  "currency": "USD",
128
128
  "region": "United States",
129
129
  "administrator": "Federal Reserve Bank of New York",
130
- "value": 3.65,
130
+ "value": 4.32,
131
131
  "date": "2026-02-04",
132
- "lastUpdated": "2026-02-05T05:00:00.000Z"
132
+ "lastUpdated": "2026-02-05T05:00:00.000Z",
133
+ "change1d": -0.01,
134
+ "changeDirection": "down",
135
+ "previousValue": 4.33,
136
+ "previousDate": "2026-02-03"
133
137
  }
134
138
  }
135
139
  ```
package/index.d.ts CHANGED
@@ -4,23 +4,39 @@ declare module '@apiverve/benchmarkrate' {
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 benchmarkrateResponse {
8
19
  status: string;
9
20
  error: string | null;
10
21
  data: BenchmarkRateData;
11
22
  code?: number;
23
+ premium?: PremiumInfo;
12
24
  }
13
25
 
14
26
 
15
27
  interface BenchmarkRateData {
16
- rate: string;
17
- name: string;
18
- currency: string;
19
- region: string;
20
- administrator: string;
21
- value: number;
22
- date: Date;
23
- lastUpdated: Date;
28
+ rate: null | string;
29
+ name: null | string;
30
+ currency: null | string;
31
+ region: null | string;
32
+ administrator: null | string;
33
+ value: number | null;
34
+ date: Date | null;
35
+ lastUpdated: Date | null;
36
+ change1D: number | null;
37
+ changeDirection: null | string;
38
+ previousValue: number | null;
39
+ previousDate: Date | null;
24
40
  }
25
41
 
26
42
  export default class benchmarkrateWrapper {
package/index.js CHANGED
@@ -13,16 +13,10 @@ class benchmarkrateWrapper {
13
13
  throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
14
  }
15
15
 
16
- // Validate API key format (GUID or alphanumeric with hyphens)
17
- const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
16
+ // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
17
+ const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
18
18
  if (!apiKeyPattern.test(api_key)) {
19
- throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
20
- }
21
-
22
- // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
23
- const trimmedKey = api_key.replace(/-/g, '');
24
- if (trimmedKey.length < 32) {
25
- throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
19
+ 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');
26
20
  }
27
21
 
28
22
  if (typeof secure !== 'boolean') {
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@apiverve/benchmarkrate",
3
- "version": "1.1.13",
3
+ "version": "1.2.0",
4
4
  "description": "Benchmark Rate is a tool for retrieving current risk-free reference rates that replaced LIBOR. It returns rates for SOFR (US), SONIA (UK), ESTR (EU), TONA (Japan), and SARON (Switzerland).",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "sideEffects": false,
8
8
  "engines": {
9
- "node": ">=14.0.0"
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
+ "benchmark rate", "sofr", "sonia", "estr", "tona"
27
27
  ],
28
28
  "author": {
29
29
  "name": "APIVerve",
@@ -34,15 +34,14 @@
34
34
  "bugs": {
35
35
  "url": "https://github.com/apiverve/benchmarkrate-api/issues"
36
36
  },
37
- "homepage": "https://apiverve.com/marketplace/benchmarkrate?utm_source=npm&utm_medium=homepage",
37
+ "homepage": "https://benchmarkrate.apiverve.com?utm_source=npm&utm_medium=homepage",
38
38
  "devDependencies": {
39
39
  "mocha": "^11.0.1",
40
40
  "chai": "^5.1.2",
41
41
  "dotenv": "^16.4.7"
42
42
  },
43
43
  "dependencies": {
44
- "node-fetch": "^3.3.2",
45
- "promise": "^8.3.0",
46
- "axios": "1.13.2"
44
+ "axios": "1.13.2",
45
+ "form-data": "^4.0.1"
47
46
  }
48
47
  }