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

Comparing version 1.1.9 to 1.1.10

docs/model_docs.md

@@ -28,8 +28,8 @@ ## Classes
 </dd>
+<dt><a href="#FundingTicker">FundingTicker</a></dt>
+<dd><p>Funding Ticker model</p>
+</dd>
 <dt><a href="#FundingTickerHist">FundingTickerHist</a></dt>
 <dd><p>Historical Funding Ticker model</p>
 </dd>
-<dt><a href="#FundingTicker">FundingTicker</a></dt>
-<dd><p>Funding Ticker model</p>
-</dd>
 <dt><a href="#FundingTrade">FundingTrade</a></dt>
@@ -45,2 +45,5 @@ <dd><p>Funding Trade model</p>
 </dd>
+<dt><a href="#Login">Login</a></dt>
+<dd><p>OHLCV Candle model</p>
+</dd>
 <dt><a href="#MarginInfo">MarginInfo</a></dt>
@@ -58,5 +61,2 @@ <dd><p>Margin Info model</p>
 </dd>
-<dt><a href="#OrderBook">OrderBook</a></dt>
-<dd><p>High level OB model to automatically integrate WS updates &amp; maintain sort</p>
-</dd>
 <dt><a href="#Order">Order</a></dt>
@@ -66,2 +66,5 @@ <dd><p>High level order model; provides methods for execution &amp; can stay updated via
 </dd>
+<dt><a href="#OrderBook">OrderBook</a></dt>
+<dd><p>High level OB model to automatically integrate WS updates &amp; maintain sort</p>
+</dd>
 <dt><a href="#Position">Position</a></dt>
@@ -79,19 +82,16 @@ <dd><p>Position model</p>
 </dd>
+<dt><a href="#TradingTicker">TradingTicker</a></dt>
+<dd><p>Trading Ticker model</p>
+</dd>
 <dt><a href="#TradingTickerHist">TradingTickerHist</a></dt>
 <dd><p>Historical Trading Ticker model</p>
 </dd>
-<dt><a href="#TradingTicker">TradingTicker</a></dt>
-<dd><p>Trading Ticker model</p>
-</dd>
 <dt><a href="#UserInfo">UserInfo</a></dt>
 <dd><p>User Info model</p>
 </dd>
-<dt><a href="#WalletHist">WalletHist</a></dt>
-<dd><p>Historical Wallet Update model</p>
-</dd>
 <dt><a href="#Wallet">Wallet</a></dt>
 <dd><p>Wallet model</p>
 </dd>
-<dt><a href="#Login">Login</a></dt>
-<dd><p>Login model</p>
+<dt><a href="#WalletHist">WalletHist</a></dt>
+<dd><p>Historical Wallet Update model</p>
 </dd>
@@ -117,7 +117,7 @@ </dl>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.key | <code>string</code> |
-| data.type | <code>string</code> |
-| data.symbol | <code>string</code> |
-| data.price | <code>string</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.key | <code>string</code> | 
+| data.type | <code>string</code> | 
+| data.symbol | <code>string</code> | 
+| data.price | <code>string</code> | 
 
@@ -132,3 +132,3 @@ <a name="Alert.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -152,5 +152,5 @@ <a name="BalanceInfo"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.amount | <code>number</code> |
-| data.amountNet | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.amount | <code>number</code> | 
+| data.amountNet | <code>number</code> | 
 
@@ -165,3 +165,3 @@ <a name="BalanceInfo.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -185,9 +185,9 @@ <a name="Candle"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.mts | <code>number</code> |
-| data.open | <code>number</code> |
-| data.close | <code>number</code> |
-| data.high | <code>number</code> |
-| data.low | <code>number</code> |
-| data.volume | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.mts | <code>number</code> | 
+| data.open | <code>number</code> | 
+| data.close | <code>number</code> | 
+| data.high | <code>number</code> | 
+| data.low | <code>number</code> | 
+| data.volume | <code>number</code> | 
 
@@ -202,3 +202,3 @@ <a name="Candle.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -222,8 +222,8 @@ <a name="Currency"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>string</code> |
-| data.name | <code>string</code> |
-| data.pool | <code>string</code> |
-| data.exporer | <code>string</code> |
-| data.symbol | <code>string</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>string</code> | 
+| data.name | <code>string</code> | 
+| data.pool | <code>string</code> | 
+| data.exporer | <code>string</code> | 
+| data.symbol | <code>string</code> | 
 
@@ -238,3 +238,3 @@ <a name="Currency.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -258,22 +258,21 @@ <a name="FundingCredit"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.symbol | <code>string</code> |
-| data.side | <code>number</code> |
-| data.mtsCreate | <code>number</code> |
-| data.mtsUpdate | <code>number</code> |
-| data.mtsOpening | <code>number</code> |
-| data.mtsLastPayout | <code>number</code> |
-| data.amount | <code>number</code> |
-| data.flags | <code>number</code> |
-| data.status | <code>number</code> |
-| data.type | <code>string</code> |
-| data.rate | <code>number</code> |
-| data.rateReal | <code>number</code> |
-| data.period | <code>number</code> |
-| data.positionPair | <code>string</code> |
-| data.notify | <code>number</code> \| <code>boolean</code> |
-| data.hidden | <code>number</code> \| <code>boolean</code> |
-| data.renew | <code>number</code> \| <code>boolean</code> |
-| data.noClose | <code>number</code> \| <code>boolean</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.symbol | <code>string</code> | 
+| data.side | <code>number</code> | 
+| data.mtsCreate | <code>number</code> | 
+| data.mtsUpdate | <code>number</code> | 
+| data.mtsOpening | <code>number</code> | 
+| data.mtsLastPayout | <code>number</code> | 
+| data.amount | <code>number</code> | 
+| data.flags | <code>number</code> | 
+| data.status | <code>number</code> | 
+| data.rate | <code>number</code> | 
+| data.rateReal | <code>number</code> | 
+| data.period | <code>number</code> | 
+| data.positionPair | <code>string</code> | 
+| data.notify | <code>number</code> \| <code>boolean</code> | 
+| data.hidden | <code>number</code> \| <code>boolean</code> | 
+| data.renew | <code>number</code> \| <code>boolean</code> | 
+| data.noClose | <code>number</code> \| <code>boolean</code> | 
 
@@ -288,3 +287,3 @@ <a name="FundingCredit.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -319,3 +318,3 @@ <a name="FundingInfo"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -339,21 +338,20 @@ <a name="FundingLoan"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.symbol | <code>string</code> |
-| data.side | <code>number</code> |
-| data.mtsCreate | <code>number</code> |
-| data.mtsUpdate | <code>number</code> |
-| data.mtsOpening | <code>number</code> |
-| data.mtsLastPayout | <code>number</code> |
-| data.amount | <code>number</code> |
-| data.flags | <code>number</code> |
-| data.status | <code>number</code> |
-| data.type | <code>string</code> |
-| data.rate | <code>number</code> |
-| data.rateReal | <code>number</code> |
-| data.period | <code>number</code> |
-| data.notify | <code>number</code> \| <code>boolean</code> |
-| data.hidden | <code>number</code> \| <code>boolean</code> |
-| data.renew | <code>number</code> \| <code>boolean</code> |
-| data.noClose | <code>number</code> \| <code>boolean</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.symbol | <code>string</code> | 
+| data.side | <code>number</code> | 
+| data.mtsCreate | <code>number</code> | 
+| data.mtsUpdate | <code>number</code> | 
+| data.mtsOpening | <code>number</code> | 
+| data.mtsLastPayout | <code>number</code> | 
+| data.amount | <code>number</code> | 
+| data.flags | <code>number</code> | 
+| data.status | <code>number</code> | 
+| data.rate | <code>number</code> | 
+| data.rateReal | <code>number</code> | 
+| data.period | <code>number</code> | 
+| data.notify | <code>number</code> \| <code>boolean</code> | 
+| data.hidden | <code>number</code> \| <code>boolean</code> | 
+| data.renew | <code>number</code> \| <code>boolean</code> | 
+| data.noClose | <code>number</code> \| <code>boolean</code> | 
 
@@ -368,3 +366,3 @@ <a name="FundingLoan.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -458,46 +456,55 @@ <a name="FundingOffer"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="FundingTickerHist"></a>
+<a name="FundingTicker"></a>
 
-## FundingTickerHist
-Historical Funding Ticker model
+## FundingTicker
+Funding Ticker model
 
 **Kind**: global class  
 
-* [FundingTickerHist](#FundingTickerHist)
-    * [new FundingTickerHist(data)](#new_FundingTickerHist_new)
+* [FundingTicker](#FundingTicker)
+    * [new FundingTicker(data)](#new_FundingTicker_new)
     * _instance_
-        * [.quote()](#FundingTickerHist+quote) ⇒ <code>string</code>
-        * [.base()](#FundingTickerHist+base) ⇒ <code>string</code>
+        * [.quote()](#FundingTicker+quote) ⇒ <code>string</code>
+        * [.base()](#FundingTicker+base) ⇒ <code>string</code>
     * _static_
-        * [.unserialize(arr)](#FundingTickerHist.unserialize) ⇒ <code>Object</code>
+        * [.unserialize(arr)](#FundingTicker.unserialize) ⇒ <code>Object</code>
 
-<a name="new_FundingTickerHist_new"></a>
+<a name="new_FundingTicker_new"></a>
 
-### new FundingTickerHist(data)
+### new FundingTicker(data)
 
 | Param | Type |
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.symbol | <code>string</code> |
-| data.bid | <code>number</code> |
-| data.bidPeriod | <code>number</code> |
-| data.ask | <code>number</code> |
-| data.mtsUpdate | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.symbol | <code>string</code> | 
+| data.frr | <code>number</code> \| <code>boolean</code> | 
+| data.bid | <code>number</code> | 
+| data.bidSize | <code>number</code> | 
+| data.bidPeriod | <code>number</code> | 
+| data.ask | <code>number</code> | 
+| data.askSize | <code>number</code> | 
+| data.askPeriod | <code>number</code> | 
+| data.dailyChange | <code>number</code> | 
+| data.dailyChangePerc | <code>number</code> | 
+| data.lastPrice | <code>number</code> | 
+| data.volume | <code>number</code> | 
+| data.high | <code>number</code> | 
+| data.low | <code>number</code> | 
 
-<a name="FundingTickerHist+quote"></a>
+<a name="FundingTicker+quote"></a>
 
-### fundingTickerHist.quote() ⇒ <code>string</code>
-**Kind**: instance method of [<code>FundingTickerHist</code>](#FundingTickerHist)  
+### fundingTicker.quote() ⇒ <code>string</code>
+**Kind**: instance method of [<code>FundingTicker</code>](#FundingTicker)  
 **Returns**: <code>string</code> - quoteCurrency  
-<a name="FundingTickerHist+base"></a>
+<a name="FundingTicker+base"></a>
 
-### fundingTickerHist.base() ⇒ <code>string</code>
-**Kind**: instance method of [<code>FundingTickerHist</code>](#FundingTickerHist)  
+### fundingTicker.base() ⇒ <code>string</code>
+**Kind**: instance method of [<code>FundingTicker</code>](#FundingTicker)  
 **Returns**: <code>string</code> - baseCurrency  
-<a name="FundingTickerHist.unserialize"></a>
+<a name="FundingTicker.unserialize"></a>
 
-### FundingTickerHist.unserialize(arr) ⇒ <code>Object</code>
-**Kind**: static method of [<code>FundingTickerHist</code>](#FundingTickerHist)  
+### FundingTicker.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of [<code>FundingTicker</code>](#FundingTicker)  
 **Returns**: <code>Object</code> - pojo  
@@ -507,55 +514,46 @@
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="FundingTicker"></a>
+<a name="FundingTickerHist"></a>
 
-## FundingTicker
-Funding Ticker model
+## FundingTickerHist
+Historical Funding Ticker model
 
 **Kind**: global class  
 
-* [FundingTicker](#FundingTicker)
-    * [new FundingTicker(data)](#new_FundingTicker_new)
+* [FundingTickerHist](#FundingTickerHist)
+    * [new FundingTickerHist(data)](#new_FundingTickerHist_new)
     * _instance_
-        * [.quote()](#FundingTicker+quote) ⇒ <code>string</code>
-        * [.base()](#FundingTicker+base) ⇒ <code>string</code>
+        * [.quote()](#FundingTickerHist+quote) ⇒ <code>string</code>
+        * [.base()](#FundingTickerHist+base) ⇒ <code>string</code>
     * _static_
-        * [.unserialize(arr)](#FundingTicker.unserialize) ⇒ <code>Object</code>
+        * [.unserialize(arr)](#FundingTickerHist.unserialize) ⇒ <code>Object</code>
 
-<a name="new_FundingTicker_new"></a>
+<a name="new_FundingTickerHist_new"></a>
 
-### new FundingTicker(data)
+### new FundingTickerHist(data)
 
 | Param | Type |
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.symbol | <code>string</code> |
-| data.frr | <code>number</code> \| <code>boolean</code> |
-| data.bid | <code>number</code> |
-| data.bidSize | <code>number</code> |
-| data.bidPeriod | <code>number</code> |
-| data.ask | <code>number</code> |
-| data.askSize | <code>number</code> |
-| data.askPeriod | <code>number</code> |
-| data.dailyChange | <code>number</code> |
-| data.dailyChangePerc | <code>number</code> |
-| data.lastPrice | <code>number</code> |
-| data.volume | <code>number</code> |
-| data.high | <code>number</code> |
-| data.low | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.symbol | <code>string</code> | 
+| data.bid | <code>number</code> | 
+| data.bidPeriod | <code>number</code> | 
+| data.ask | <code>number</code> | 
+| data.mtsUpdate | <code>number</code> | 
 
-<a name="FundingTicker+quote"></a>
+<a name="FundingTickerHist+quote"></a>
 
-### fundingTicker.quote() ⇒ <code>string</code>
-**Kind**: instance method of [<code>FundingTicker</code>](#FundingTicker)  
+### fundingTickerHist.quote() ⇒ <code>string</code>
+**Kind**: instance method of [<code>FundingTickerHist</code>](#FundingTickerHist)  
 **Returns**: <code>string</code> - quoteCurrency  
-<a name="FundingTicker+base"></a>
+<a name="FundingTickerHist+base"></a>
 
-### fundingTicker.base() ⇒ <code>string</code>
-**Kind**: instance method of [<code>FundingTicker</code>](#FundingTicker)  
+### fundingTickerHist.base() ⇒ <code>string</code>
+**Kind**: instance method of [<code>FundingTickerHist</code>](#FundingTickerHist)  
 **Returns**: <code>string</code> - baseCurrency  
-<a name="FundingTicker.unserialize"></a>
+<a name="FundingTickerHist.unserialize"></a>
 
-### FundingTicker.unserialize(arr) ⇒ <code>Object</code>
-**Kind**: static method of [<code>FundingTicker</code>](#FundingTicker)  
+### FundingTickerHist.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of [<code>FundingTickerHist</code>](#FundingTickerHist)  
 **Returns**: <code>Object</code> - pojo  
@@ -565,3 +563,3 @@
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -585,11 +583,11 @@ <a name="FundingTrade"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.symbol | <code>string</code> |
-| data.mtsCreate | <code>number</code> |
-| data.offerID | <code>number</code> |
-| data.amount | <code>number</code> |
-| data.rate | <code>number</code> |
-| data.period | <code>number</code> |
-| data.maker | <code>number</code> \| <code>boolean</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.symbol | <code>string</code> | 
+| data.mtsCreate | <code>number</code> | 
+| data.offerID | <code>number</code> | 
+| data.amount | <code>number</code> | 
+| data.rate | <code>number</code> | 
+| data.period | <code>number</code> | 
+| data.maker | <code>number</code> \| <code>boolean</code> | 
 
@@ -604,3 +602,3 @@ <a name="FundingTrade.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -625,9 +623,9 @@ <a name="LedgerEntry"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.currency | <code>string</code> |
-| data.mts | <code>number</code> |
-| data.amount | <code>number</code> |
-| data.balance | <code>number</code> |
-| data.description | <code>string</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.currency | <code>string</code> | 
+| data.mts | <code>number</code> | 
+| data.amount | <code>number</code> | 
+| data.balance | <code>number</code> | 
+| data.description | <code>string</code> | 
 
@@ -642,3 +640,3 @@ <a name="LedgerEntry.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -662,10 +660,10 @@ <a name="Liquidations"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.posId | <code>number</code> |
-| data.mtsUpdated | <code>number</code> |
-| data.symbol | <code>string</code> |
-| data.amount | <code>number</code> |
-| data.basePrice | <code>number</code> |
-| data.isMatch | <code>number</code> \| <code>boolean</code> |
-| data.isMarketSold | <code>number</code> \| <code>boolean</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.posId | <code>number</code> | 
+| data.mtsUpdated | <code>number</code> | 
+| data.symbol | <code>string</code> | 
+| data.amount | <code>number</code> | 
+| data.basePrice | <code>number</code> | 
+| data.isMatch | <code>number</code> \| <code>boolean</code> | 
+| data.isMarketSold | <code>number</code> \| <code>boolean</code> | 
 
@@ -680,4 +678,37 @@ <a name="Liquidations.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
+<a name="Login"></a>
+
+## Login
+OHLCV Candle model
+
+**Kind**: global class  
+
+* [Login](#Login)
+    * [new Login(data)](#new_Login_new)
+    * [.unserialize(arr)](#Login.unserialize) ⇒ <code>Object</code>
+
+<a name="new_Login_new"></a>
+
+### new Login(data)
+
+| Param | Type |
+| --- | --- |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.time | <code>number</code> | 
+| data.ip | <code>string</code> | 
+| data.extraData | <code>object</code> | 
+
+<a name="Login.unserialize"></a>
+
+### Login.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of [<code>Login</code>](#Login)  
+**Returns**: <code>Object</code> - pojo  
+
+| Param | Type |
+| --- | --- |
+| arr | <code>Object</code> \| <code>Array</code> | 
+
 <a name="MarginInfo"></a>
@@ -711,3 +742,3 @@
 | --- | --- |
-| arr | <code>Array</code> |
+| arr | <code>Array</code> | 
 
@@ -787,13 +818,13 @@ <a name="Model"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.currency | <code>string</code> |
-| data.currencyName | <code>string</code> |
-| data.mtsStarted | <code>number</code> |
-| data.mtsUpdated | <code>number</code> |
-| data.status | <code>string</code> |
-| data.amount | <code>number</code> |
-| data.fees | <code>number</code> |
-| data.destinationAddress | <code>string</code> |
-| data.transactionId | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.currency | <code>string</code> | 
+| data.currencyName | <code>string</code> | 
+| data.mtsStarted | <code>number</code> | 
+| data.mtsUpdated | <code>number</code> | 
+| data.status | <code>string</code> | 
+| data.amount | <code>number</code> | 
+| data.fees | <code>number</code> | 
+| data.destinationAddress | <code>string</code> | 
+| data.transactionId | <code>number</code> | 
 
@@ -808,3 +839,3 @@ <a name="Movement.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -828,10 +859,10 @@ <a name="Notification"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.mts | <code>number</code> |
-| data.type | <code>string</code> |
-| data.messageID | <code>number</code> |
-| data.notifyInfo | <code>Object</code> |
-| data.code | <code>number</code> |
-| data.status | <code>string</code> |
-| data.text | <code>string</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.mts | <code>number</code> | 
+| data.type | <code>string</code> | 
+| data.messageID | <code>number</code> | 
+| data.notifyInfo | <code>Object</code> | 
+| data.code | <code>number</code> | 
+| data.status | <code>string</code> | 
+| data.text | <code>string</code> | 
 
@@ -846,205 +877,4 @@ <a name="Notification.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="OrderBook"></a>
-
-## OrderBook
-High level OB model to automatically integrate WS updates & maintain sort
-
-**Kind**: global class  
-
-* [OrderBook](#OrderBook)
-    * [new OrderBook(snapshot, raw)](#new_OrderBook_new)
-    * _instance_
-        * [.volBPSMid(bps)](#OrderBook+volBPSMid) ⇒ <code>number</code>
-        * [.checksum()](#OrderBook+checksum) ⇒ <code>number</code>
-        * [.updateFromSnapshot(snapshot)](#OrderBook+updateFromSnapshot)
-        * [.updateWith(entry)](#OrderBook+updateWith) ⇒ <code>boolean</code>
-        * [.topBid()](#OrderBook+topBid) ⇒ <code>number</code>
-        * [.topBidLevel()](#OrderBook+topBidLevel) ⇒ <code>number</code>
-        * [.topAsk()](#OrderBook+topAsk) ⇒ <code>number</code>
-        * [.topAskLevel()](#OrderBook+topAskLevel) ⇒ <code>number</code>
-        * [.midPrice()](#OrderBook+midPrice) ⇒ <code>number</code>
-        * [.spread()](#OrderBook+spread) ⇒ <code>number</code>
-        * [.bidAmount()](#OrderBook+bidAmount) ⇒ <code>number</code>
-        * [.askAmount()](#OrderBook+askAmount) ⇒ <code>number</code>
-        * [.getEntry(price)](#OrderBook+getEntry) ⇒ <code>Object</code>
-        * [.serialize()](#OrderBook+serialize) ⇒ <code>Array.&lt;Array&gt;</code>
-        * [.toJS()](#OrderBook+toJS) ⇒ <code>Object</code>
-    * _static_
-        * [.checksumArr(arr, raw)](#OrderBook.checksumArr) ⇒ <code>number</code>
-        * [.updateArrayOBWith(ob, entry, raw)](#OrderBook.updateArrayOBWith) ⇒ <code>boolean</code>
-        * [.arrayOBMidPrice(ob, raw)](#OrderBook.arrayOBMidPrice)
-        * [.unserialize(arr, raw)](#OrderBook.unserialize) ⇒ <code>Object</code>
-
-<a name="new_OrderBook_new"></a>
-
-### new OrderBook(snapshot, raw)
-Initializes the order book with an existing snapshot (array form)
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| snapshot | <code>Array.&lt;Array&gt;</code> \| [<code>OrderBook</code>](#OrderBook) |  |
-| raw | <code>boolean</code> | true for raw 'R0' order books |
-
-<a name="OrderBook+volBPSMid"></a>
-
-### orderBook.volBPSMid(bps) ⇒ <code>number</code>
-Returns the total volume at n basis points from the mid price
-
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - vol - total volume  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bps | <code>number</code> | basis points from mid price |
-
-<a name="OrderBook+checksum"></a>
-
-### orderBook.checksum() ⇒ <code>number</code>
-Generates a crc-32 checksum of our current state. The checksum'ed string
-itself is a concatenated list of the top 25 bids & asks, alternating.
-
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - cs  
-**See**: http://blog.bitfinex.com/api/bitfinex-api-order-books-checksums  
-<a name="OrderBook+updateFromSnapshot"></a>
-
-### orderBook.updateFromSnapshot(snapshot)
-Resets the internal bid/ask arrays and re-populates them with the provided
-snapshot.
-
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-
-| Param | Type |
-| --- | --- |
-| snapshot | <code>Array.&lt;Array&gt;</code> |
-
-<a name="OrderBook+updateWith"></a>
-
-### orderBook.updateWith(entry) ⇒ <code>boolean</code>
-Integrate an update packet (add, update, or remove a price level). Emits an
-'update' event on success
-
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>boolean</code> - success - false if entry doesn't match OB  
-
-| Param | Type |
-| --- | --- |
-| entry | <code>Array</code> |
-
-<a name="OrderBook+topBid"></a>
-
-### orderBook.topBid() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - topBid - may be null  
-<a name="OrderBook+topBidLevel"></a>
-
-### orderBook.topBidLevel() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - topBidLevel - may be null  
-<a name="OrderBook+topAsk"></a>
-
-### orderBook.topAsk() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - topAsk - may be null  
-<a name="OrderBook+topAskLevel"></a>
-
-### orderBook.topAskLevel() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - topAskLevel - may be null  
-<a name="OrderBook+midPrice"></a>
-
-### orderBook.midPrice() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - price  
-<a name="OrderBook+spread"></a>
-
-### orderBook.spread() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - spread - top bid/ask difference  
-<a name="OrderBook+bidAmount"></a>
-
-### orderBook.bidAmount() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - amount - total buy-side volume  
-<a name="OrderBook+askAmount"></a>
-
-### orderBook.askAmount() ⇒ <code>number</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - amount - total sell-side volume  
-<a name="OrderBook+getEntry"></a>
-
-### orderBook.getEntry(price) ⇒ <code>Object</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>Object</code> - entry - unserialized, null if not found  
-
-| Param | Type |
-| --- | --- |
-| price | <code>number</code> |
-
-<a name="OrderBook+serialize"></a>
-
-### orderBook.serialize() ⇒ <code>Array.&lt;Array&gt;</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>Array.&lt;Array&gt;</code> - - arr  
-<a name="OrderBook+toJS"></a>
-
-### orderBook.toJS() ⇒ <code>Object</code>
-**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>Object</code> - pojo  
-<a name="OrderBook.checksumArr"></a>
-
-### OrderBook.checksumArr(arr, raw) ⇒ <code>number</code>
-Like checksum(), but for raw array-format order books
-
-**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>number</code> - cs  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| arr | <code>Array.&lt;Array&gt;</code> |  | assumed sorted, [topBid, bid, ..., topAsk, ask, ...] |
-| raw | <code>boolean</code> | <code>false</code> | true for raw 'R0' order books |
-
-<a name="OrderBook.updateArrayOBWith"></a>
-
-### OrderBook.updateArrayOBWith(ob, entry, raw) ⇒ <code>boolean</code>
-Modifies an array-format OB in place with an update entry. Maintains sort
-
-**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>boolean</code> - success - false if entry doesn't match OB  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| ob | <code>Array.&lt;Array.&lt;number&gt;&gt;</code> |  |  |
-| entry | <code>Array.&lt;number&gt;</code> |  |  |
-| raw | <code>boolean</code> | <code>false</code> | true for raw 'R0' order books |
-
-<a name="OrderBook.arrayOBMidPrice"></a>
-
-### OrderBook.arrayOBMidPrice(ob, raw)
-Resolves the mid-price of an array-format OB
-
-**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| ob | <code>Array.&lt;Array&gt;</code> |  |  |
-| raw | <code>boolean</code> | <code>false</code> | default false |
-
-<a name="OrderBook.unserialize"></a>
-
-### OrderBook.unserialize(arr, raw) ⇒ <code>Object</code>
-Converts an array order book entry or snapshot to an object, with 'price',
-'count', and 'amount' keys on entries
-
-**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
-**Returns**: <code>Object</code> - ob - either a map w/ bids & asks, or single entry object  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| arr | <code>Array.&lt;number&gt;</code> \| <code>Array.&lt;Array.&lt;number&gt;&gt;</code> |  |  |
-| raw | <code>boolean</code> | <code>false</code> | true for raw 'R0' order books |
-
 <a name="Order"></a>
@@ -1061,2 +891,3 @@
     * _instance_
+        * [.toString()](#Order+toString) ⇒ <code>string</code>
         * [.isOCO()](#Order+isOCO) ⇒ <code>boolean</code>
@@ -1121,4 +952,14 @@ * [.isHidden()](#Order+isHidden) ⇒ <code>boolean</code>
 | data.placedId | <code>number</code> |  |
+| data.affiliateCode | <code>string</code> |  |
+| data.lev | <code>number</code> |  |
 | apiInterface | <code>Object</code> | saved for a later call to registerListeners() |
 
+<a name="Order+toString"></a>
+
+### order.toString() ⇒ <code>string</code>
+Returns a string representation of the order
+TODO: add verbose option to log all order information (TIF, etc)
+
+**Kind**: instance method of [<code>Order</code>](#Order)  
+**Returns**: <code>string</code> - desc  
 <a name="Order+isOCO"></a>
@@ -1171,3 +1012,3 @@
 | --- | --- |
-| v | <code>boolean</code> |
+| v | <code>boolean</code> | 
 
@@ -1181,3 +1022,3 @@ <a name="Order+setPostOnly"></a>
 | --- | --- |
-| v | <code>boolean</code> |
+| v | <code>boolean</code> | 
 
@@ -1191,3 +1032,3 @@ <a name="Order+setNoVariableRates"></a>
 | --- | --- |
-| v | <code>boolean</code> |
+| v | <code>boolean</code> | 
 
@@ -1201,3 +1042,3 @@ <a name="Order+setPositionClose"></a>
 | --- | --- |
-| v | <code>boolean</code> |
+| v | <code>boolean</code> | 
 
@@ -1211,3 +1052,3 @@ <a name="Order+setReduceOnly"></a>
 | --- | --- |
-| v | <code>boolean</code> |
+| v | <code>boolean</code> | 
 
@@ -1307,3 +1148,3 @@ <a name="Order+update"></a>
 | --- | --- |
-| order | [<code>Order</code>](#Order) |
+| order | [<code>Order</code>](#Order) | 
 
@@ -1358,3 +1199,3 @@ <a name="Order+getLastFillAmount"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -1381,2 +1222,171 @@ <a name="Order.getBaseCurrency"></a>
 
+<a name="OrderBook"></a>
+
+## OrderBook
+High level OB model to automatically integrate WS updates & maintain sort
+
+**Kind**: global class  
+
+* [OrderBook](#OrderBook)
+    * [new OrderBook(snapshot, raw)](#new_OrderBook_new)
+    * _instance_
+        * [.volBPSMid(bps)](#OrderBook+volBPSMid) ⇒ <code>number</code>
+        * [.checksum()](#OrderBook+checksum) ⇒ <code>number</code>
+        * [.updateWith(entry)](#OrderBook+updateWith) ⇒ <code>boolean</code>
+        * [.topBid()](#OrderBook+topBid) ⇒ <code>number</code>
+        * [.topBidLevel()](#OrderBook+topBidLevel) ⇒ <code>number</code>
+        * [.topAsk()](#OrderBook+topAsk) ⇒ <code>number</code>
+        * [.topAskLevel()](#OrderBook+topAskLevel) ⇒ <code>number</code>
+        * [.midPrice()](#OrderBook+midPrice) ⇒ <code>number</code>
+        * [.spread()](#OrderBook+spread) ⇒ <code>number</code>
+        * [.bidAmount()](#OrderBook+bidAmount) ⇒ <code>number</code>
+        * [.askAmount()](#OrderBook+askAmount) ⇒ <code>number</code>
+        * [.getEntry(price)](#OrderBook+getEntry) ⇒ <code>Object</code>
+        * [.toJS()](#OrderBook+toJS) ⇒ <code>Object</code>
+    * _static_
+        * [.checksumArr(arr, raw)](#OrderBook.checksumArr) ⇒ <code>number</code>
+        * [.updateArrayOBWith(ob, entry, raw)](#OrderBook.updateArrayOBWith) ⇒ <code>boolean</code>
+        * [.unserialize(arr, raw)](#OrderBook.unserialize) ⇒ <code>Object</code>
+
+<a name="new_OrderBook_new"></a>
+
+### new OrderBook(snapshot, raw)
+Initializes the order book with an existing snapshot (array form)
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| snapshot | <code>Array.&lt;Array&gt;</code> \| [<code>OrderBook</code>](#OrderBook) |  |
+| raw | <code>boolean</code> | true for raw 'R0' order books |
+
+<a name="OrderBook+volBPSMid"></a>
+
+### orderBook.volBPSMid(bps) ⇒ <code>number</code>
+Returns the total volume at n basis points from the mid price
+
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - vol - total volume  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| bps | <code>number</code> | basis points from mid price |
+
+<a name="OrderBook+checksum"></a>
+
+### orderBook.checksum() ⇒ <code>number</code>
+Generates a crc-32 checksum of our current state. The checksum'ed string
+itself is a concatenated list of the top 25 bids & asks, alternating.
+
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - cs  
+**See**: http://blog.bitfinex.com/api/bitfinex-api-order-books-checksums  
+<a name="OrderBook+updateWith"></a>
+
+### orderBook.updateWith(entry) ⇒ <code>boolean</code>
+Integrate an update packet (add, update, or remove a price level). Emits an
+'update' event on success
+
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>boolean</code> - success - false if entry doesn't match OB  
+
+| Param | Type |
+| --- | --- |
+| entry | <code>Array</code> | 
+
+<a name="OrderBook+topBid"></a>
+
+### orderBook.topBid() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - topBid - may be null  
+<a name="OrderBook+topBidLevel"></a>
+
+### orderBook.topBidLevel() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - topBidLevel - may be null  
+<a name="OrderBook+topAsk"></a>
+
+### orderBook.topAsk() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - topAsk - may be null  
+<a name="OrderBook+topAskLevel"></a>
+
+### orderBook.topAskLevel() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - topAskLevel - may be null  
+<a name="OrderBook+midPrice"></a>
+
+### orderBook.midPrice() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - price  
+<a name="OrderBook+spread"></a>
+
+### orderBook.spread() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - spread - top bid/ask difference  
+<a name="OrderBook+bidAmount"></a>
+
+### orderBook.bidAmount() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - amount - total buy-side volume  
+<a name="OrderBook+askAmount"></a>
+
+### orderBook.askAmount() ⇒ <code>number</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - amount - total sell-side volume  
+<a name="OrderBook+getEntry"></a>
+
+### orderBook.getEntry(price) ⇒ <code>Object</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>Object</code> - entry - unserialized, null if not found  
+
+| Param | Type |
+| --- | --- |
+| price | <code>number</code> | 
+
+<a name="OrderBook+toJS"></a>
+
+### orderBook.toJS() ⇒ <code>Object</code>
+**Kind**: instance method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>Object</code> - pojo  
+<a name="OrderBook.checksumArr"></a>
+
+### OrderBook.checksumArr(arr, raw) ⇒ <code>number</code>
+Like checksum(), but for raw array-format order books
+
+**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>number</code> - cs  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| arr | <code>Array.&lt;Array&gt;</code> |  | assumed sorted, [topBid, bid, ..., topAsk, ask, ...] |
+| raw | <code>boolean</code> | <code>false</code> | true for raw 'R0' order books |
+
+<a name="OrderBook.updateArrayOBWith"></a>
+
+### OrderBook.updateArrayOBWith(ob, entry, raw) ⇒ <code>boolean</code>
+Modifies an array-format OB in place with an update entry. Maintains sort
+
+**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>boolean</code> - success - false if entry doesn't match OB  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| ob | <code>Array.&lt;Array.&lt;number&gt;&gt;</code> |  |  |
+| entry | <code>Array.&lt;number&gt;</code> |  |  |
+| raw | <code>boolean</code> | <code>false</code> | true for raw 'R0' order books |
+
+<a name="OrderBook.unserialize"></a>
+
+### OrderBook.unserialize(arr, raw) ⇒ <code>Object</code>
+Converts an array order book entry or snapshot to an object, with 'price',
+'count', and 'amount' keys on entries
+
+**Kind**: static method of [<code>OrderBook</code>](#OrderBook)  
+**Returns**: <code>Object</code> - ob - either a map w/ bids & asks, or single entry object  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| arr | <code>Array.&lt;number&gt;</code> \| <code>Array.&lt;Array.&lt;number&gt;&gt;</code> |  |  |
+| raw | <code>boolean</code> | <code>false</code> | true for raw 'R0' order books |
+
 <a name="Position"></a>
@@ -1441,3 +1451,3 @@
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -1461,3 +1471,3 @@ <a name="PublicTrade"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
 
@@ -1472,3 +1482,3 @@ <a name="PublicTrade.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -1492,10 +1502,10 @@ <a name="StatusMessagesDeriv"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.key | <code>string</code> |
-| data.timestamp | <code>number</code> |
-| data.price | <code>string</code> |
-| data.priceSpot | <code>string</code> |
-| data.fundBal | <code>string</code> |
-| data.fundingAccrued | <code>string</code> |
-| data.fundingStep | <code>string</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.key | <code>string</code> | 
+| data.timestamp | <code>number</code> | 
+| data.price | <code>string</code> | 
+| data.priceSpot | <code>string</code> | 
+| data.fundBal | <code>string</code> | 
+| data.fundingAccrued | <code>string</code> | 
+| data.fundingStep | <code>string</code> | 
 
@@ -1510,3 +1520,3 @@ <a name="StatusMessagesDeriv.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -1530,14 +1540,14 @@ <a name="Trade"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.symbol | <code>string</code> |
-| data.mtsCreate | <code>number</code> |
-| data.orderID | <code>number</code> |
-| data.execAmount | <code>string</code> |
-| data.execPrice | <code>string</code> |
-| data.orderType | <code>string</code> |
-| data.orderPrice | <code>string</code> |
-| data.maker | <code>number</code> \| <code>boolean</code> |
-| data.fee | <code>string</code> |
-| data.feeCurrency | <code>string</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.symbol | <code>string</code> | 
+| data.mtsCreate | <code>number</code> | 
+| data.orderID | <code>number</code> | 
+| data.execAmount | <code>string</code> | 
+| data.execPrice | <code>string</code> | 
+| data.orderType | <code>string</code> | 
+| data.orderPrice | <code>string</code> | 
+| data.maker | <code>number</code> \| <code>boolean</code> | 
+| data.fee | <code>string</code> | 
+| data.feeCurrency | <code>string</code> | 
 
@@ -1552,51 +1562,4 @@ <a name="Trade.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="TradingTickerHist"></a>
-
-## TradingTickerHist
-Historical Trading Ticker model
-
-**Kind**: global class  
-
-* [TradingTickerHist](#TradingTickerHist)
-    * [new TradingTickerHist(data)](#new_TradingTickerHist_new)
-    * _instance_
-        * [.quote()](#TradingTickerHist+quote) ⇒ <code>string</code>
-        * [.base()](#TradingTickerHist+base) ⇒ <code>string</code>
-    * _static_
-        * [.unserialize(arr)](#TradingTickerHist.unserialize) ⇒ <code>Object</code>
-
-<a name="new_TradingTickerHist_new"></a>
-
-### new TradingTickerHist(data)
-
-| Param | Type |
-| --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.symbol | <code>string</code> |
-| data.bid | <code>string</code> |
-| data.ask | <code>string</code> |
-| data.mtsUpdate | <code>number</code> |
-
-<a name="TradingTickerHist+quote"></a>
-
-### tradingTickerHist.quote() ⇒ <code>string</code>
-**Kind**: instance method of [<code>TradingTickerHist</code>](#TradingTickerHist)  
-**Returns**: <code>string</code> - quoteCurrency  
-<a name="TradingTickerHist+base"></a>
-
-### tradingTickerHist.base() ⇒ <code>string</code>
-**Kind**: instance method of [<code>TradingTickerHist</code>](#TradingTickerHist)  
-**Returns**: <code>string</code> - baseCurrency  
-<a name="TradingTickerHist.unserialize"></a>
-
-### TradingTickerHist.unserialize(arr) ⇒ <code>Object</code>
-**Kind**: static method of [<code>TradingTickerHist</code>](#TradingTickerHist)  
-**Returns**: <code>Object</code> - pojo  
-
-| Param | Type |
-| --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
-
 <a name="TradingTicker"></a>
@@ -1623,14 +1586,14 @@
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.symbol | <code>string</code> |
-| data.bid | <code>number</code> |
-| data.bidSize | <code>number</code> |
-| data.ask | <code>number</code> |
-| data.askSize | <code>number</code> |
-| data.dailyChange | <code>number</code> |
-| data.dailyChangePerc | <code>number</code> |
-| data.lastPrice | <code>number</code> |
-| data.volume | <code>number</code> |
-| data.high | <code>number</code> |
-| data.low | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.symbol | <code>string</code> | 
+| data.bid | <code>number</code> | 
+| data.bidSize | <code>number</code> | 
+| data.ask | <code>number</code> | 
+| data.askSize | <code>number</code> | 
+| data.dailyChange | <code>number</code> | 
+| data.dailyChangePerc | <code>number</code> | 
+| data.lastPrice | <code>number</code> | 
+| data.volume | <code>number</code> | 
+| data.high | <code>number</code> | 
+| data.low | <code>number</code> | 
 
@@ -1655,31 +1618,45 @@ <a name="TradingTicker+quote"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="UserInfo"></a>
+<a name="TradingTickerHist"></a>
 
-## UserInfo
-User Info model
+## TradingTickerHist
+Historical Trading Ticker model
 
 **Kind**: global class  
 
-* [UserInfo](#UserInfo)
-    * [new UserInfo(data)](#new_UserInfo_new)
-    * [.unserialize(arr)](#UserInfo.unserialize) ⇒ <code>Object</code>
+* [TradingTickerHist](#TradingTickerHist)
+    * [new TradingTickerHist(data)](#new_TradingTickerHist_new)
+    * _instance_
+        * [.quote()](#TradingTickerHist+quote) ⇒ <code>string</code>
+        * [.base()](#TradingTickerHist+base) ⇒ <code>string</code>
+    * _static_
+        * [.unserialize(arr)](#TradingTickerHist.unserialize) ⇒ <code>Object</code>
 
-<a name="new_UserInfo_new"></a>
+<a name="new_TradingTickerHist_new"></a>
 
-### new UserInfo(data)
+### new TradingTickerHist(data)
 
 | Param | Type |
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.email | <code>string</code> |
-| data.username | <code>string</code> |
-| data.timezone | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.symbol | <code>string</code> | 
+| data.bid | <code>string</code> | 
+| data.ask | <code>string</code> | 
+| data.mtsUpdate | <code>number</code> | 
 
-<a name="UserInfo.unserialize"></a>
+<a name="TradingTickerHist+quote"></a>
 
-### UserInfo.unserialize(arr) ⇒ <code>Object</code>
-**Kind**: static method of [<code>UserInfo</code>](#UserInfo)  
+### tradingTickerHist.quote() ⇒ <code>string</code>
+**Kind**: instance method of [<code>TradingTickerHist</code>](#TradingTickerHist)  
+**Returns**: <code>string</code> - quoteCurrency  
+<a name="TradingTickerHist+base"></a>
+
+### tradingTickerHist.base() ⇒ <code>string</code>
+**Kind**: instance method of [<code>TradingTickerHist</code>](#TradingTickerHist)  
+**Returns**: <code>string</code> - baseCurrency  
+<a name="TradingTickerHist.unserialize"></a>
+
+### TradingTickerHist.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of [<code>TradingTickerHist</code>](#TradingTickerHist)  
 **Returns**: <code>Object</code> - pojo  
@@ -1689,33 +1666,31 @@
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="WalletHist"></a>
+<a name="UserInfo"></a>
 
-## WalletHist
-Historical Wallet Update model
+## UserInfo
+User Info model
 
 **Kind**: global class  
 
-* [WalletHist](#WalletHist)
-    * [new WalletHist(data)](#new_WalletHist_new)
-    * [.unserialize(arr)](#WalletHist.unserialize) ⇒ <code>Object</code>
+* [UserInfo](#UserInfo)
+    * [new UserInfo(data)](#new_UserInfo_new)
+    * [.unserialize(arr)](#UserInfo.unserialize) ⇒ <code>Object</code>
 
-<a name="new_WalletHist_new"></a>
+<a name="new_UserInfo_new"></a>
 
-### new WalletHist(data)
+### new UserInfo(data)
 
 | Param | Type |
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.type | <code>string</code> |
-| data.currency | <code>string</code> |
-| data.balance | <code>number</code> |
-| data.unsettledInterest | <code>number</code> |
-| data.balanceAvailable | <code>number</code> |
-| data.mtsUpdate | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.id | <code>number</code> | 
+| data.email | <code>string</code> | 
+| data.username | <code>string</code> | 
+| data.timezone | <code>number</code> | 
 
-<a name="WalletHist.unserialize"></a>
+<a name="UserInfo.unserialize"></a>
 
-### WalletHist.unserialize(arr) ⇒ <code>Object</code>
-**Kind**: static method of [<code>WalletHist</code>](#WalletHist)  
+### UserInfo.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of [<code>UserInfo</code>](#UserInfo)  
 **Returns**: <code>Object</code> - pojo  
@@ -1725,3 +1700,3 @@
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
@@ -1745,8 +1720,8 @@ <a name="Wallet"></a>
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.type | <code>string</code> |
-| data.currency | <code>string</code> |
-| data.balance | <code>number</code> |
-| data.unsettledInterest | <code>number</code> |
-| data.balanceAvailable | <code>number</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.type | <code>string</code> | 
+| data.currency | <code>string</code> | 
+| data.balance | <code>number</code> | 
+| data.unsettledInterest | <code>number</code> | 
+| data.balanceAvailable | <code>number</code> | 
 
@@ -1761,31 +1736,33 @@ <a name="Wallet.unserialize"></a>
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
 
-<a name="Login"></a>
+<a name="WalletHist"></a>
 
-## Login
-Historical Users Login model
+## WalletHist
+Historical Wallet Update model
 
 **Kind**: global class  
 
-* [Login](#Login)
-    * [new Login(data)](#new_Login_new)
-    * [.unserialize(arr)](#Login.unserialize) ⇒ <code>Object</code>
+* [WalletHist](#WalletHist)
+    * [new WalletHist(data)](#new_WalletHist_new)
+    * [.unserialize(arr)](#WalletHist.unserialize) ⇒ <code>Object</code>
 
 <a name="new_WalletHist_new"></a>
 
-### new Login(data)
+### new WalletHist(data)
 
 | Param | Type |
 | --- | --- |
-| data | <code>Object</code> \| <code>Array</code> |
-| data.id | <code>number</code> |
-| data.time | <code>number</code> |
-| data.ip | <code>string</code> |
-| data.extraData | <code>Object</code> |
+| data | <code>Object</code> \| <code>Array</code> | 
+| data.type | <code>string</code> | 
+| data.currency | <code>string</code> | 
+| data.balance | <code>number</code> | 
+| data.unsettledInterest | <code>number</code> | 
+| data.balanceAvailable | <code>number</code> | 
+| data.mtsUpdate | <code>number</code> | 
 
-<a name="Login.unserialize"></a>
+<a name="WalletHist.unserialize"></a>
 
-### Login.unserialize(arr) ⇒ <code>Object</code>
-**Kind**: static method of [<code>Login</code>](#Login)  
+### WalletHist.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of [<code>WalletHist</code>](#WalletHist)  
 **Returns**: <code>Object</code> - pojo  
@@ -1795,2 +1772,3 @@
 | --- | --- |
-| arr | <code>Object</code> \| <code>Array</code> |
+| arr | <code>Object</code> \| <code>Array</code> | 
+

lib/order.js

@@ -81,2 +81,3 @@ 'use strict'
    * @param {string?} data.affiliateCode
+   * @param {number} data.lev
    * @param {Object?} apiInterface - saved for a later call to registerListeners()
@@ -95,2 +96,3 @@ */
 
+    this.lev = data.lev
     this.affiliateCode = data.affiliateCode
@@ -308,3 +310,3 @@ this._apiInterface = apiInterface
   toPreview () {
-    return {
+    const prev = {
       gid: this.gid,
@@ -319,2 +321,6 @@ cid: this.cid,
     }
+    if (!Number.isNaN(+this.lev)) {
+      prev.lev = +this.lev
+    }
+    return prev
   }
@@ -535,2 +541,6 @@
 
+    if (!Number.isNaN(+this.lev)) {
+      data.lev = +this.lev
+    }
+
     if (this.priceTrailing !== null && !Number.isNaN(+this.priceTrailing)) {
@@ -537,0 +547,0 @@ data.price_trailing = preparePrice(+this.priceTrailing)

package.json

 {
   "name": "bfx-api-node-models",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "description": "Object models for usage with the Bitfinex node API",
@@ -5,0 +5,0 @@ "engines": {

test/lib/models/order.js

@@ -298,2 +298,11 @@ /* eslint-env mocha */
   })
+
+  it('lev: field is passed into newOrderPacket', () => {
+    const o = new Order({
+      price: 42,
+      amount: 1,
+      lev: 100
+    })
+    assert(o.toNewOrderPacket().lev, 100)
+  })
 })

No alert changes

Improved metrics

Lines of code

4196

increased by0.41%

Worsened metrics

Total package byte prevSize

183105

decreased by-0.05%

No dependency changes