bfx-api-node-ws1
v1.0.4
Published
Legacy WSv1 transport for the Bitfinex Node API
Downloads
2,219
Readme
Bitfinex WSv1 Reference Implementation for Node.JS
This repo contains the reference implementation for version 1 of the websocket Bitfinex API. It is deprecated in favour of version 2, and should no longer be used.
For the version 2 API library, see bitfinex-api-node
Features
- Emits API data as events from the class instance
- Provides methods for channel management & listening to incoming data
Installation
npm i --save bfx-api-node-ws1
Quickstart & Example
const WSv1 = require('bfx-api-node-ws1')
const ws = new WSv1()
ws.open()
ws.on('open', () => {
ws.subscribeTrades('BTCUSD')
})
ws.on('trades', (pair, trade) => {
console.log(JSON.stringify({ pair, trade }, null, 2))
})
Docs
For JSDoc-generated API documentation, see docs/ws1.md
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request