bfx-api-node-rest - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

docs/rest2.md

@@ -27,2 +27,3 @@ <a name="RESTv2"></a>
     * [.accountTrades(symbol, start, end, limit, sort, cb)](#RESTv2+accountTrades) ⇒ <code>Promise</code>
+    * [.logins(start, end, limit, cb)](#RESTv2+logins) ⇒ <code>Promise</code>
     * [.wallets(cb)](#RESTv2+wallets) ⇒ <code>Promise</code>
@@ -105,3 +106,3 @@ * [.walletsHistory(end, currency, cb)](#RESTv2+walletsHistory) ⇒ <code>Promise</code>
 | --- | --- |
-| Notification.notify_info | <code>Object</code> | 
+| Notification.notify_info | <code>Object</code> |
 
@@ -129,3 +130,3 @@ <a name="RESTv2+orderBook"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -141,5 +142,5 @@ <a name="RESTv2+statusMessages"></a>
 | --- | --- | --- |
-| type | <code>string</code> | <code>&quot;deriv&quot;</code> | 
-| keys | <code>Array.&lt;string&gt;</code> |  | 
-| cb | <code>Method</code> |  | 
+| type | <code>string</code> | <code>&quot;deriv&quot;</code> |
+| keys | <code>Array.&lt;string&gt;</code> |  |
+| cb | <code>Method</code> |  |
 
@@ -155,4 +156,4 @@ <a name="RESTv2+ticker"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -168,4 +169,4 @@ <a name="RESTv2+tickers"></a>
 | --- | --- |
-| symbols | <code>Array.&lt;string&gt;</code> | 
-| cb | <code>Method</code> | 
+| symbols | <code>Array.&lt;string&gt;</code> |
+| cb | <code>Method</code> |
 
@@ -181,7 +182,7 @@ <a name="RESTv2+tickersHistory"></a>
 | --- | --- | --- |
-| symbols | <code>Array.&lt;string&gt;</code> |  | 
-| start | <code>number</code> |  | 
-| end | <code>number</code> |  | 
-| limit | <code>number</code> | <code>250</code> | 
-| cb | <code>Method</code> |  | 
+| symbols | <code>Array.&lt;string&gt;</code> |  |
+| start | <code>number</code> |  |
+| end | <code>number</code> |  |
+| limit | <code>number</code> | <code>250</code> |
+| cb | <code>Method</code> |  |
 
@@ -197,5 +198,5 @@ <a name="RESTv2+stats"></a>
 | --- | --- | --- |
-| key | <code>string</code> | <code>&quot;pos.size:1m:tBTCUSD:long&quot;</code> | 
-| context | <code>string</code> | <code>&quot;hist&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| key | <code>string</code> | <code>&quot;pos.size:1m:tBTCUSD:long&quot;</code> |
+| context | <code>string</code> | <code>&quot;hist&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -226,4 +227,4 @@ <a name="RESTv2+candles"></a>
 | --- | --- |
-| keys | <code>Array.&lt;string&gt;</code> | 
-| cb | <code>Method</code> | 
+| keys | <code>Array.&lt;string&gt;</code> |
+| cb | <code>Method</code> |
 
@@ -252,4 +253,4 @@ <a name="RESTv2+currencies"></a>
 | --- | --- | --- |
-| type | <code>string</code> | <code>&quot;price&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| type | <code>string</code> | <code>&quot;price&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -265,5 +266,5 @@ <a name="RESTv2+alertSet"></a>
 | --- | --- | --- |
-| type | <code>string</code> | <code>&quot;price&quot;</code> | 
-| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> | 
-| price | <code>number</code> | <code>0</code> | 
+| type | <code>string</code> | <code>&quot;price&quot;</code> |
+| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
+| price | <code>number</code> | <code>0</code> |
 
@@ -279,4 +280,4 @@ <a name="RESTv2+alertDelete"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> | 
-| price | <code>number</code> | <code>0</code> | 
+| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
+| price | <code>number</code> | <code>0</code> |
 
@@ -340,3 +341,3 @@ <a name="RESTv2+trades"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -352,6 +353,21 @@ <a name="RESTv2+walletsHistory"></a>
 | --- | --- | --- |
-| end | <code>number</code> |  | 
-| currency | <code>string</code> | <code>null</code> | 
-| cb | <code>Method</code> |  | 
+| end | <code>number</code> |  |
+| currency | <code>string</code> | <code>null</code> |
+| cb | <code>Method</code> |  |
 
+<a name="RESTv2+logins"></a>
+
+### resTv2.logins(start, end, limit, cb) ⇒ <code>Promise</code>
+**Kind**: instance method of [<code>RESTv2</code>](#RESTv2)  
+**Returns**: <code>Promise</code> - p  
+**See**: https://docs.bitfinex.com/v2/reference#rest-auth-logins-hist  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| start | <code>number</code> |  |
+| end | <code>number</code> |  |
+| limit | <code>number</code> |  |
+| cb | <code>Method</code> |  |
+
+
 <a name="RESTv2+userInfo"></a>
@@ -366,3 +382,3 @@
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -378,3 +394,3 @@ <a name="RESTv2+activeOrders"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -435,8 +451,8 @@ <a name="RESTv2+movements"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> | 
-| start | <code>number</code> | <code></code> | 
-| end | <code>number</code> | <code></code> | 
-| limit | <code>number</code> | <code></code> | 
-| orderID | <code>number</code> |  | 
-| cb | <code>Method</code> |  | 
+| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
+| start | <code>number</code> | <code></code> |
+| end | <code>number</code> | <code></code> |
+| limit | <code>number</code> | <code></code> |
+| orderID | <code>number</code> |  |
+| cb | <code>Method</code> |  |
 
@@ -452,3 +468,3 @@ <a name="RESTv2+positions"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -464,6 +480,6 @@ <a name="RESTv2+positionsHistory"></a>
 | --- | --- | --- |
-| start | <code>Number</code> | <code>0</code> | 
-| end | <code>Number</code> |  | 
-| limit | <code>Number</code> | <code>50</code> | 
-| cb | <code>Method</code> |  | 
+| start | <code>Number</code> | <code>0</code> |
+| end | <code>Number</code> |  |
+| limit | <code>Number</code> | <code>50</code> |
+| cb | <code>Method</code> |  |
 
@@ -479,7 +495,7 @@ <a name="RESTv2+positionsAudit"></a>
 | --- | --- | --- |
-| id | <code>Array.&lt;Array&gt;</code> |  | 
-| start | <code>Number</code> | <code>0</code> | 
-| end | <code>Number</code> |  | 
-| limit | <code>Number</code> | <code>250</code> | 
-| cb | <code>Method</code> |  | 
+| id | <code>Array.&lt;Array&gt;</code> |  |
+| start | <code>Number</code> | <code>0</code> |
+| end | <code>Number</code> |  |
+| limit | <code>Number</code> | <code>250</code> |
+| cb | <code>Method</code> |  |
 
@@ -495,4 +511,4 @@ <a name="RESTv2+fundingOffers"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -523,4 +539,4 @@ <a name="RESTv2+fundingOfferHistory"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -551,4 +567,4 @@ <a name="RESTv2+fundingLoanHistory"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -594,4 +610,4 @@ <a name="RESTv2+fundingCreditHistory"></a>
 | --- | --- | --- |
-| key | <code>string</code> | <code>&quot;base&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| key | <code>string</code> | <code>&quot;base&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -607,4 +623,4 @@ <a name="RESTv2+fundingInfo"></a>
 | --- | --- | --- |
-| key | <code>string</code> | <code>&quot;fUSD&quot;</code> | 
-| cb | <code>Method</code> |  | 
+| key | <code>string</code> | <code>&quot;fUSD&quot;</code> |
+| cb | <code>Method</code> |  |
 
@@ -620,3 +636,3 @@ <a name="RESTv2+performance"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -632,7 +648,7 @@ <a name="RESTv2+calcAvailableBalance"></a>
 | --- | --- | --- |
-| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> | 
-| dir | <code>string</code> |  | 
-| rate | <code>number</code> |  | 
-| type | <code>string</code> |  | 
-| cb | <code>Method</code> |  | 
+| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
+| dir | <code>string</code> |  |
+| rate | <code>number</code> |  |
+| type | <code>string</code> |  |
+| cb | <code>Method</code> |  |
 
@@ -693,3 +709,3 @@ <a name="RESTv2+symbols"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -709,3 +725,3 @@ <a name="RESTv2+accountInfo"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -725,3 +741,3 @@ <a name="RESTv2+accountFees"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -742,3 +758,3 @@ <a name="RESTv2+accountSummary"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -758,3 +774,3 @@ <a name="RESTv2+keyPermissions"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -774,3 +790,3 @@ <a name="RESTv2+balances"></a>
 | --- | --- |
-| cb | <code>Method</code> | 
+| cb | <code>Method</code> |
 
@@ -788,5 +804,5 @@ <a name="RESTv2+closePosition"></a>
 | --- | --- |
-| params | <code>Object</code> | 
-| params.position_id | <code>number</code> | 
-| cb | <code>Method</code> | 
+| params | <code>Object</code> |
+| params.position_id | <code>number</code> |
+| cb | <code>Method</code> |
 
@@ -812,4 +828,4 @@ <a name="RESTv2+updateSettings"></a>
 | --- | --- |
-| keys | <code>Array.&lt;string&gt;</code> | 
-| cb | <code>Method</code> | 
+| keys | <code>Array.&lt;string&gt;</code> |
+| cb | <code>Method</code> |
 
@@ -824,4 +840,4 @@ <a name="RESTv2+getSettings"></a>
 | --- | --- |
-| keys | <code>Array.&lt;string&gt;</code> | 
-| cb | <code>Method</code> | 
+| keys | <code>Array.&lt;string&gt;</code> |
+| cb | <code>Method</code> |
 
@@ -847,7 +863,7 @@ <a name="RESTv2+exchangeRate"></a>
 | --- | --- |
-| opts | <code>Object</code> | 
-| opts.ttl | <code>number</code> | 
-| opts.scope | <code>string</code> | 
-| opts.writePermission | <code>boolean</code> | 
-| cb | <code>Method</code> | 
+| opts | <code>Object</code> |
+| opts.ttl | <code>number</code> |
+| opts.scope | <code>string</code> |
+| opts.writePermission | <code>boolean</code> |
+| cb | <code>Method</code> |
 
@@ -1015,2 +1031,1 @@ <a name="RESTv2+submitOrder"></a>
 | cb | <code>\*</code> |  |
-

lib/rest2.js

@@ -33,3 +33,4 @@ 'use strict'
   StatusMessagesDeriv,
-  Notification
+  Notification,
+  Login
 } = require('bfx-api-node-models')
@@ -624,4 +625,20 @@
   /**
+   * @param {number} start
+   * @param {number} end
+   * @param {number} limit
    * @param {Method} cb
    * @return {Promise} p
+   * @see https://docs.bitfinex.com/v2/reference#rest-auth-logins-hist
+   */
+  logins (start = 0, end = Date.now(), limit = 25, cb) {
+    const url = '/auth/r/logins/hist'
+
+    return this._makeAuthRequest(url, {
+      start, end, limit
+    }, cb, Login)
+  }
+
+  /**
+   * @param {Method} cb
+   * @return {Promise} p
    * @see https://docs.bitfinex.com/v2/reference#rest-auth-wallets
@@ -1007,7 +1024,8 @@ */
    * @return {Promise} p
-   * @deprecated
    * @see https://docs.bitfinex.com/v1/reference#rest-auth-summary
    */
   accountSummary (cb) {
-    return this._makeAuthLegacyRequest('summary', {}, cb)
+    const url = '/auth/r/int/summary'
+    const pickSummary = (res) => res && res[0] && res[0].summary
+    return this._makeAuthRequest(url, { }, cb, pickSummary)
   }
@@ -1014,0 +1032,0 @@

package.json

 {
   "name": "bfx-api-node-rest",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Official Bitfinex REST v1 & v2 API interfaces",
@@ -5,0 +5,0 @@ "engines": {

test/lib/rest-2-integration.js

@@ -109,2 +109,3 @@ /* eslint-env mocha */
     ['wallets', 'wallets'],
+    ['logins', 'logins_hist', ['start', 'end', 'limit']],
     ['walletsHistory', 'wallets_hist.end.currency', ['end', 'currency']],
@@ -111,0 +112,0 @@ ['activeOrders', 'active_orders'],

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

129811

increased by0.8%

Lines of code

2294

increased by0.75%

No dependency changes