coinspot-readonly-api - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

index.js

@@ -55,4 +55,13 @@ const hmac = require("crypto").createHmac;
     }
+
+    self.deposits = (params, callback) => {
+        request(`/api/ro/my/deposits/`, params, callback);
+    }
+
+    self.referralPayments = callback => {
+        request('/api/ro/my/referralpayments', {}, callback);
+    }
+
 }
 
 module.exports = coinspot

package.json

 {
   "name": "coinspot-readonly-api",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Read-only API client for coinspot.com.au",
@@ -5,0 +5,0 @@ "main": "index.js",

README.MD

@@ -11,13 +11,30 @@ ### Read Only Coinspot API
 
-```
+```js
 var coinspot = require('coinspot-api');
 
+var key = ''; // insert your key here
 var secret = ''; // insert your secret here
-var key = ''; // insert your key here
 
-var client = new coinspot(key, secret);
+var coinspotClient = new coinspot(key, secret);
 
+// Simple balance check
 coinspotClient.balances((e, data) => {
     console.log(data);
 });
+
+// List deposits - note empty params
+coinspotClient.balances({}, (e, data) => {
+    console.log(data);
+});
+
+// List deposits - with start and/or end date
+// Note lowercase startdate/enddate
+coinspotClient.balances({ startdate: '2020-01-01'}, (e, data) => {
+    console.log(data);
+});
+
+// List referral payments
+coinspotClient.referralPayments((e, data) => {
+    console.log(data);
+});
 ```
@@ -31,3 +48,3 @@
 | List a Coins Balance | 🕑 Not yet |
-| List Deposit History | 🕑 Not yet |
+| List Deposit History | ✅ **Yes** |
 | List Withdrawal History | 🕑 Not yet |
@@ -40,3 +57,3 @@ | List Transaction History | 🕑 Not yet |
 | List My Affiliate Payments | 🕑 Not yet |
-| List My Referral Payments | 🕑 Not yet |
+| List My Referral Payments | ✅ **Yes** |
 
@@ -43,0 +60,0 @@ #### Support

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4718

increased by15.69%

Lines of code

51

increased by13.33%

Number of lines in readme file

60

increased by39.53%

No dependency changes