version 1.0.1

Author: metalpriceapi-user

README.md

@@ -60,7 +60,7 @@ await api.fetchLive('USD', ['XAU', 'XAG', 'XPD', 'XPT']);
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
 
 ```js
-await api.fetchHistorical('2021-04-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
+await api.fetchHistorical('2024-02-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_historical)
@@ -74,7 +74,7 @@ await api.fetchHistorical('2021-04-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
 - `date` <[string]> Optional. Specify date to use historical midpoint value for conversion with format `YYYY-MM-DD`. Otherwise, it will use live exchange rate date if value not passed in.
 
 ```js
-await api.convert('USD', 'EUR', 100, '2021-04-05');
+await api.convert('USD', 'EUR', 100, '2024-02-05');
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_convert)
@@ -88,7 +88,7 @@ await api.convert('USD', 'EUR', 100, '2021-04-05');
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
 
 ```js
-await api.timeframe('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
+await api.timeframe('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_timeframe)
@@ -102,11 +102,23 @@ await api.timeframe('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XP
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
 
 ```js
-await api.change('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
+await api.change('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_change)
 
+---
+#### carat(base, date)
+
+- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
+- `date` <[string]> Optional. Specify date to get Carat using format `YYYY-MM-DD`. If not specified, uses live rates.
+
+```js
+await api.carat('USD', '2024-02-06');
+```
+
+[Link](https://metalpriceapi.com/documentation#api_carat)
+
 ---
 **[Official documentation](https://metalpriceapi.com/documentation)**
 

example/index.js

@@ -1,4 +1,5 @@
 const api = require('../index');
+// const api = require('metalpriceapi');
 
 const apiKey = 'REPLACE_ME';
 
@@ -13,15 +14,15 @@ const apiKey = 'REPLACE_ME';
   result = await api.fetchLive('USD', ['XAU', 'XAG', 'XPD', 'XPT']);
   console.log(result.data);
 
-  result = await api.fetchHistorical('2021-04-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
+  result = await api.fetchHistorical('2024-02-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
   console.log(result.data);
 
-  result = await api.convert('USD', 'EUR', 100, '2021-04-05');
+  result = await api.convert('USD', 'EUR', 100, '2024-02-05');
   console.log(result.data);
 
-  result = await api.timeframe('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
+  result = await api.timeframe('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
   console.log(result.data);
 
-  result = await api.change('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
+  result = await api.change('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
   console.log(result.data);
 })();

index.js

@@ -85,4 +85,15 @@
       }),
     });
   }
+
+  exports.carat = function(base, date) {
+    return axios({
+      url: 'https://api.metalpriceapi.com/v1/carat',
+      params: removeEmpty({
+        api_key: this.apiKey,
+        base: base,
+        date: date,
+      }),
+    });
+  }
 })();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalpriceapi",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Official Node.js Library for MetalpriceAPI",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,7 @@
   "author": "MetalpriceAPI",
   "license": "GNU GPLv3",
   "dependencies": {
-    "axios": "^0.24.0"
+    "axios": "^1.6.7"
   },
   "homepage": "https://metalpriceapi.com",
   "repository": {