## WSv1 Communicates with v1 of the Bitfinex WebSocket API **Kind**: global class * [WSv1](#WSv1) * [new WSv1()](#new_WSv1_new) * [.open()](#WSv1+open) * [.close()](#WSv1+close) * [.send(msg)](#WSv1+send) * [.subscribeOrderBook(pair, precision, length)](#WSv1+subscribeOrderBook) * [.subscribeTrades(pair)](#WSv1+subscribeTrades) * [.subscribeTicker(pair)](#WSv1+subscribeTicker) * [.unsubscribe(chanId)](#WSv1+unsubscribe) * [.auth()](#WSv1+auth) ### new WSv1() | Param | Type | Description | | --- | --- | --- | | opts.apiKey | sting | | | opts.apiSecret | string | | | opts.url | string | ws connection url | ### wSv1.open() Opens a new websocket conection to the configured URL **Kind**: instance method of [WSv1](#WSv1) ### wSv1.close() Close the websocket connection **Kind**: instance method of [WSv1](#WSv1) ### wSv1.send(msg) Send a packet via the ws connection; automatically converted to a JSON string. **Kind**: instance method of [WSv1](#WSv1) | Param | Type | | --- | --- | | msg | \* | ### wSv1.subscribeOrderBook(pair, precision, length) Subscribe to order book updates. Snapshot will be sent as multiple updates. Event will be emited as `PAIRNAME_book`. **Kind**: instance method of [WSv1](#WSv1) **See**: http://docs.bitfinex.com/#order-books | Param | Type | Default | Description | | --- | --- | --- | --- | | pair | string | "BTCUSD" | | | precision | string | | price aggregation level (P0 (def), P1, P2, P3) | | length | string | | number of price points. 25 (default) or 100. | ### wSv1.subscribeTrades(pair) Subscribe to trades. Snapshot will be sent as multiple updates. Event will be emited as `PAIRNAME_trades`. **Kind**: instance method of [WSv1](#WSv1) **See**: http://docs.bitfinex.com/#trades75 | Param | Type | Default | | --- | --- | --- | | pair | string | "BTCUSD" | ### wSv1.subscribeTicker(pair) Subscribe to ticker updates. The ticker is a high level overview of the state of the market. It shows you the current best bid and ask, as well as the last trade price. Event will be emited as `PAIRNAME_ticker`. **Kind**: instance method of [WSv1](#WSv1) **See**: http://docs.bitfinex.com/#ticker76 | Param | Type | Default | Description | | --- | --- | --- | --- | | pair | string | "BTCUSD" | pair | ### wSv1.unsubscribe(chanId) Unsubscribe from a channel. **Kind**: instance method of [WSv1](#WSv1) | Param | Type | Description | | --- | --- | --- | | chanId | number | ID of the channel received on `subscribed` event | ### wSv1.auth() Authenticate the user. Will receive executed traded updates. **Kind**: instance method of [WSv1](#WSv1) **See**: http://docs.bitfinex.com/#wallet-updates