## WSv2 Communicates with v2 of the Bitfinex WebSocket API **Kind**: global class * [WSv2](#WSv2) * [new WSv2()](#new_WSv2_new) * [.open()](#WSv2+open) ⇒ Promise * [.close(code, reason)](#WSv2+close) ⇒ Promise * [.auth(calc)](#WSv2+auth) ⇒ Promise * [.reconnect()](#WSv2+reconnect) ⇒ Promise * [.getOB(symbol)](#WSv2+getOB) ⇒ OrderBook * [.getCandles(key)](#WSv2+getCandles) ⇒ Array * [.managedSubscribe(channel, identifier, payload)](#WSv2+managedSubscribe) ⇒ boolean * [.managedUnsubscribe(channel, identifier)](#WSv2+managedUnsubscribe) ⇒ boolean * [.getChannelData(opts)](#WSv2+getChannelData) ⇒ Object * [.send(msg)](#WSv2+send) * [.enableSequencing(args)](#WSv2+enableSequencing) * [.onServerRestart(cb)](#WSv2+onServerRestart) * [.onMaintenanceStart(cb)](#WSv2+onMaintenanceStart) * [.onMaintenanceEnd(cb)](#WSv2+onMaintenanceEnd) * [.subscribe(channel, payload)](#WSv2+subscribe) * [.subscribeTicker(symbol)](#WSv2+subscribeTicker) ⇒ boolean * [.subscribeTrades(symbol)](#WSv2+subscribeTrades) ⇒ boolean * [.subscribeOrderBook(symbol, prec, len)](#WSv2+subscribeOrderBook) ⇒ boolean * [.subscribeCandles(key)](#WSv2+subscribeCandles) ⇒ boolean * [.unsubscribe(chanId)](#WSv2+unsubscribe) * [.unsubscribeTicker(symbol)](#WSv2+unsubscribeTicker) ⇒ boolean * [.unsubscribeTrades(symbol)](#WSv2+unsubscribeTrades) ⇒ boolean * [.unsubscribeOrderBook(symbol, prec, len)](#WSv2+unsubscribeOrderBook) ⇒ boolean * [.unsubscribeCandles(symbol, frame)](#WSv2+unsubscribeCandles) ⇒ boolean * [.removeListeners(cbGID)](#WSv2+removeListeners) * [.requestCalc(prefixes)](#WSv2+requestCalc) * [.submitOrder(order)](#WSv2+submitOrder) ⇒ Promise * [.cancelOrder(order)](#WSv2+cancelOrder) ⇒ Promise * [.cancelOrders(orders)](#WSv2+cancelOrders) ⇒ Promise * [.submitOrderMultiOp(opPayloads)](#WSv2+submitOrderMultiOp) ⇒ Promise * [.isAuthenticated()](#WSv2+isAuthenticated) ⇒ boolean * [.isOpen()](#WSv2+isOpen) ⇒ boolean * [.onInfoMessage(code, cb)](#WSv2+onInfoMessage) * [.onMessage(opts, cb)](#WSv2+onMessage) * [.onCandle(opts, cb)](#WSv2+onCandle) * [.onOrderBook(opts, cb)](#WSv2+onOrderBook) * [.onTrades(opts, cb)](#WSv2+onTrades) * [.onTicker(opts, cb)](#WSv2+onTicker) * [.onOrderSnapshot(opts, cb)](#WSv2+onOrderSnapshot) * [.onOrderNew(opts, cb)](#WSv2+onOrderNew) * [.onOrderUpdate(opts, cb)](#WSv2+onOrderUpdate) * [.onOrderClose(opts, cb)](#WSv2+onOrderClose) * [.onPositionSnapshot(opts, cb)](#WSv2+onPositionSnapshot) * [.onPositionNew(opts, cb)](#WSv2+onPositionNew) * [.onPositionUpdate(opts, cb)](#WSv2+onPositionUpdate) * [.onPositionClose(opts, cb)](#WSv2+onPositionClose) * [.onTradeEntry(opts, cb)](#WSv2+onTradeEntry) * [.onTradeUpdate(opts, cb)](#WSv2+onTradeUpdate) * [.onFundingOfferSnapshot(opts, cb)](#WSv2+onFundingOfferSnapshot) * [.onFundingOfferNew(opts, cb)](#WSv2+onFundingOfferNew) * [.onFundingOfferUpdate(opts, cb)](#WSv2+onFundingOfferUpdate) * [.onFundingOfferClose(opts, cb)](#WSv2+onFundingOfferClose) * [.onFundingCreditSnapshot(opts, cb)](#WSv2+onFundingCreditSnapshot) * [.onFundingCreditNew(opts, cb)](#WSv2+onFundingCreditNew) * [.onFundingCreditUpdate(opts, cb)](#WSv2+onFundingCreditUpdate) * [.onFundingCreditClose(opts, cb)](#WSv2+onFundingCreditClose) * [.onFundingLoanSnapshot(opts, cb)](#WSv2+onFundingLoanSnapshot) * [.onFundingLoanNew(opts, cb)](#WSv2+onFundingLoanNew) * [.onFundingLoanUpdate(opts, cb)](#WSv2+onFundingLoanUpdate) * [.onFundingLoanClose(opts, cb)](#WSv2+onFundingLoanClose) * [.onWalletSnapshot(opts, cb)](#WSv2+onWalletSnapshot) * [.onWalletUpdate(opts, cb)](#WSv2+onWalletUpdate) * [.onBalanceInfoUpdate(opts, cb)](#WSv2+onBalanceInfoUpdate) * [.onMarginInfoUpdate(opts, cb)](#WSv2+onMarginInfoUpdate) * [.onFundingInfoUpdate(opts, cb)](#WSv2+onFundingInfoUpdate) * [.onFundingTradeEntry(opts, cb)](#WSv2+onFundingTradeEntry) * [.onFundingTradeUpdate(opts, cb)](#WSv2+onFundingTradeUpdate) * [.onNotification(opts, cb)](#WSv2+onNotification) ### new WSv2() Instantiate a new ws2 transport. Does not auto-open | Param | Type | Description | | --- | --- | --- | | opts.apiKey | string | | | opts.apiSecret | string | | | opts.url | string | ws connection url | | opts.orderOpBufferDelay | number | multi-order op batching timeout | | opts.transform | boolean | if true, packets are converted to models | | opts.agent | Object | optional node agent for ws connection (proxy) | | opts.manageOrderBooks | boolean | enable local OB persistence | | opts.manageCandles | boolean | enable local candle persistence | | opts.seqAudit | boolean | enable sequence numbers & verification | | opts.autoReconnect | boolean | if true, we will reconnect on close | | opts.reconnectDelay | number | optional, defaults to 1000 (ms) | | opts.packetWDDelay | number | watch-dog forced reconnection delay | ### wSv2.open() ⇒ Promise Opens a connection to the API server. Rejects with an error if a connection is already open. Resolves on success **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p ### wSv2.close(code, reason) ⇒ Promise Closes the active connection. If there is none, rejects with a promise. Resolves on success **Kind**: instance method of [WSv2](#WSv2) | Param | Type | Description | | --- | --- | --- | | code | number | passed to ws | | reason | string | passed to ws | ### wSv2.auth(calc) ⇒ Promise Generates & sends an authentication packet to the server; if already authenticated, rejects with an error. Resolves on success **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p | Param | Type | Default | Description | | --- | --- | --- | --- | | calc | number | 0 | optional, default is 0 | ### wSv2.reconnect() ⇒ Promise Utility method to close & re-open the ws connection. Re-authenticates if previously authenticated **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p - resolves on completion ### wSv2.getOB(symbol) ⇒ OrderBook Returns an up-to-date copy of the order book for the specified symbol, or null if no OB is managed for that symbol. Set `manageOrderBooks: true` in the constructor to use. **Kind**: instance method of [WSv2](#WSv2) **Returns**: OrderBook - ob - null if not found | Param | Type | | --- | --- | | symbol | string | ### wSv2.getCandles(key) ⇒ Array Fetch a reference to the full set of synced candles for the specified key. Set `manageCandles: true` in the constructor to use. **Kind**: instance method of [WSv2](#WSv2) **Returns**: Array - candles - empty array if none exist | Param | Type | | --- | --- | | key | string | ### wSv2.managedSubscribe(channel, identifier, payload) ⇒ boolean Subscribes and tracks subscriptions per channel/identifier pair. If already subscribed to the specified pair, nothing happens. **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - subSent | Param | Type | Description | | --- | --- | --- | | channel | string | | | identifier | string | for uniquely identifying the ref count | | payload | Object | merged with sub packet | ### wSv2.managedUnsubscribe(channel, identifier) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - unsubSent | Param | Type | | --- | --- | | channel | string | | identifier | string | ### wSv2.getChannelData(opts) ⇒ Object **Kind**: instance method of [WSv2](#WSv2) **Returns**: Object - chanData - null if not found | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.chanId | number | | | opts.channel | string | optional | | opts.symbol | string | optional | | opts.key | string | optional | ### wSv2.send(msg) Send a packet to the WS server **Kind**: instance method of [WSv2](#WSv2) | Param | Type | Description | | --- | --- | --- | | msg | \* | packet, gets stringified | ### wSv2.enableSequencing(args) Configures the seq flag to enable sequencing (packet number) for this connection. When enabled, the seq number will be the last value of channel packet arrays. **Kind**: instance method of [WSv2](#WSv2) | Param | Type | Description | | --- | --- | --- | | args | Object | | | args.audit | boolean | if true, an error is emitted on invalid seq | ### wSv2.onServerRestart(cb) Register a callback in case of a ws server restart message; Use this to call reconnect() if needed. (code 20051) **Kind**: instance method of [WSv2](#WSv2) | Param | Type | | --- | --- | | cb | method | ### wSv2.onMaintenanceStart(cb) Register a callback in case of a 'maintenance started' message from the server. This is a good time to pause server packets until maintenance ends **Kind**: instance method of [WSv2](#WSv2) | Param | Type | | --- | --- | | cb | method | ### wSv2.onMaintenanceEnd(cb) Register a callback to be notified of a maintenance period ending **Kind**: instance method of [WSv2](#WSv2) | Param | Type | | --- | --- | | cb | method | ### wSv2.subscribe(channel, payload) **Kind**: instance method of [WSv2](#WSv2) | Param | Type | Description | | --- | --- | --- | | channel | string | | | payload | Object | optional extra packet data | ### wSv2.subscribeTicker(symbol) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - subscribed | Param | Type | | --- | --- | | symbol | string | ### wSv2.subscribeTrades(symbol) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - subscribed | Param | Type | | --- | --- | | symbol | string | ### wSv2.subscribeOrderBook(symbol, prec, len) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - subscribed | Param | Type | Default | Description | | --- | --- | --- | --- | | symbol | string | | | | prec | string | "P0" | P0, P1, P2, or P3 (default P0) | | len | string | "25" | 25 or 100 (default 25) | ### wSv2.subscribeCandles(key) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - subscribed | Param | Type | | --- | --- | | key | string | ### wSv2.unsubscribe(chanId) **Kind**: instance method of [WSv2](#WSv2) | Param | Type | | --- | --- | | chanId | number | ### wSv2.unsubscribeTicker(symbol) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - unsubscribed | Param | Type | | --- | --- | | symbol | string | ### wSv2.unsubscribeTrades(symbol) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - unsubscribed | Param | Type | | --- | --- | | symbol | string | ### wSv2.unsubscribeOrderBook(symbol, prec, len) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - unsubscribed | Param | Type | Default | Description | | --- | --- | --- | --- | | symbol | string | | | | prec | string | "P0" | P0, P1, P2, or P3 (default P0) | | len | string | "25" | 25 or 100 (default 25) | ### wSv2.unsubscribeCandles(symbol, frame) ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - unsubscribed | Param | Type | Description | | --- | --- | --- | | symbol | string | | | frame | string | time frame | ### wSv2.removeListeners(cbGID) **Kind**: instance method of [WSv2](#WSv2) | Param | Type | | --- | --- | | cbGID | string | ### wSv2.requestCalc(prefixes) **Kind**: instance method of [WSv2](#WSv2) | Param | Type | | --- | --- | | prefixes | Array.<string> | ### wSv2.submitOrder(order) ⇒ Promise Sends a new order to the server and resolves the returned promise once the order submit is confirmed. Emits an error if not authenticated. The order can be either an array, key/value map, or Order object instance. **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p - resolves on submit notification | Param | Type | | --- | --- | | order | Object | Array | ### wSv2.cancelOrder(order) ⇒ Promise Cancels an order by ID and resolves the returned promise once the cancel is confirmed. Emits an error if not authenticated. The ID can be passed as a number, or taken from an order array/object. **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p | Param | Type | | --- | --- | | order | Object | Array | number | ### wSv2.cancelOrders(orders) ⇒ Promise Cancels multiple orders, returns a promise that resolves once all operations are confirmed. **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p **See**: cancelOrder | Param | Type | | --- | --- | | orders | Array.<Object> | Array.<Array> | Array.<number> | ### wSv2.submitOrderMultiOp(opPayloads) ⇒ Promise Sends the op payloads to the server as an 'ox_multi' command. A promise is returned and resolves immediately if authenticated, as no confirmation is available for this message type. **Kind**: instance method of [WSv2](#WSv2) **Returns**: Promise - p - rejects if not authenticated | Param | Type | | --- | --- | | opPayloads | Array.<Object> | ### wSv2.isAuthenticated() ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - authenticated ### wSv2.isOpen() ⇒ boolean **Kind**: instance method of [WSv2](#WSv2) **Returns**: boolean - open ### wSv2.onInfoMessage(code, cb) Registers a new callback to be called when a matching info message is received. **Kind**: instance method of [WSv2](#WSv2) | Param | Type | Description | | --- | --- | --- | | code | number | from WSv2.info.* | | cb | method | | ### wSv2.onMessage(opts, cb) **Kind**: instance method of [WSv2](#WSv2) | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onCandle(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-public-candle | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.key | string | candle set key, i.e. trade:30m:tBTCUSD | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onOrderBook(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-public-order-books | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.prec | string | | | opts.len | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onTrades(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-public-trades | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.pair | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onTicker(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-public-ticker | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onOrderSnapshot(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-orders | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.gid | number | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onOrderNew(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-orders | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.gid | number | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onOrderUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-orders | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.gid | number | | | opts.cid | number | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onOrderClose(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-orders | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.gid | number | | | opts.cid | number | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onPositionSnapshot(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-position | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onPositionNew(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-position | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onPositionUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-position | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onPositionClose(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-position | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onTradeEntry(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-trades | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.pair | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onTradeUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-trades | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.pair | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingOfferSnapshot(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-offers | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingOfferNew(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-offers | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingOfferUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-offers | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingOfferClose(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-offers | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingCreditSnapshot(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-credits | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingCreditNew(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-credits | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingCreditUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-credits | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingCreditClose(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-credits | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingLoanSnapshot(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-loans | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingLoanNew(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-loans | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingLoanUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-loans | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingLoanClose(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-loans | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onWalletSnapshot(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-wallets | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onWalletUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-wallets | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onBalanceInfoUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-balance | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onMarginInfoUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-margin | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingInfoUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-funding | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingTradeEntry(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-funding-trades | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onFundingTradeUpdate(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-funding-trades | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.symbol | string | | | opts.cbGID | string | callback group id | | cb | Method | | ### wSv2.onNotification(opts, cb) **Kind**: instance method of [WSv2](#WSv2) **See**: https://docs.bitfinex.com/v2/reference#ws-auth-notifications | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.type | string | | | opts.cbGID | string | callback group id | | cb | Method | |