Skip to content

Commit e00761c

Browse files
JacobPlasterJacobPlaster
authored andcommitted
update docs/ws2
1 parent 6c55d23 commit e00761c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/ws2.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Communicates with v2 of the Bitfinex WebSocket API
1414
* [._validateMessageSeq(msg)](#WSv2+_validateMessageSeq) ⇒ <code>Error</code>
1515
* [._verifyManagedOBChecksum(symbol, prec, cs)](#WSv2+_verifyManagedOBChecksum) ⇒ <code>Error</code>
1616
* [.getOB(symbol)](#WSv2+getOB) ⇒ <code>OrderBook</code>
17+
* [.getLosslessOB(symbol)](#WSv2+getLosslessOB) ⇒ <code>OrderBook</code>
1718
* [.getCandles(key)](#WSv2+getCandles) ⇒ <code>Array</code>
1819
* [.managedSubscribe(channel, identifier, payload)](#WSv2+managedSubscribe) ⇒ <code>boolean</code>
1920
* [.managedUnsubscribe(channel, identifier)](#WSv2+managedUnsubscribe) ⇒ <code>boolean</code>
@@ -196,6 +197,21 @@ Set `manageOrderBooks: true` in the constructor to use.
196197
| --- | --- |
197198
| symbol | <code>string</code> |
198199

200+
<a name="WSv2+getLosslessOB"></a>
201+
202+
### wSv2.getLosslessOB(symbol) ⇒ <code>OrderBook</code>
203+
Returns an up-to-date lossless copy of the order book for the specified symbol, or
204+
null if no OB is managed for that symbol. All amounts and prices are in original
205+
string format.
206+
Set `manageOrderBooks: true` in the constructor to use.
207+
208+
**Kind**: instance method of [<code>WSv2</code>](#WSv2)
209+
**Returns**: <code>OrderBook</code> - ob - null if not found
210+
211+
| Param | Type |
212+
| --- | --- |
213+
| symbol | <code>string</code> |
214+
199215
<a name="WSv2+getCandles"></a>
200216

201217
### wSv2.getCandles(key) ⇒ <code>Array</code>
@@ -660,6 +676,7 @@ received.
660676
| --- | --- | --- |
661677
| opts | <code>Object</code> | |
662678
| opts.pair | <code>string</code> | |
679+
| opts.symbol | <code>string</code> | |
663680
| opts.cbGID | <code>string</code> | callback group id |
664681
| cb | <code>Method</code> | |
665682

0 commit comments

Comments
 (0)