Node reference library for Bitfinex API
npm install bitfinex-api-node-modbash
npm install bitfinex-api-node
`
Usage
Version 1.0.0 supports the new v2 Websocket and Rest API. As Network calls are slow, the data is sent as lists.
In order to reconstruct key / value pairs, set opts.transform to true.
`js
const BFX = require('bitfinex-api-node')
const API_KEY = 'secret'
const API_SECRET = 'secret'
const opts = {
version: 2,
transform: true
}
const bws = new BFX(API_KEY, API_SECRET, opts).ws
bws.on('auth', () => {
// emitted after .auth()
// needed for private api endpoints
console.log('authenticated')
// bws.submitOrder ...
})
bws.on('open', () => {
bws.subscribeTicker('BTCUSD')
bws.subscribeOrderBook('BTCUSD')
bws.subscribeTrades('BTCUSD')
// authenticate
// bws.auth()
})
bws.on('orderbook', (pair, book) => {
console.log('Order book:', book)
})
bws.on('trade', (pair, trade) => {
console.log('Trade:', trade)
})
bws.on('ticker', (pair, ticker) => {
console.log('Ticker:', ticker)
})
bws.on('error', console.error)
`
new BFX(API_KEY, API_SECRET, opts)
Where opts can be:
`
const opts = {
// use v1 or v2 of the API, values: 1, 2
version: 2,
// transform lists for the v2 API. values: true, false, function
transform: true
}
`
Version 1.0.0 Breaking changes:
$3
Old:
`js
new BFX(API_KEY, API_SECRET, 2)
`
since 1.0.0:
`js
new BFX(API_KEY, API_SECRET, { version: 2 })
`
Note version must be of type Number.
$3
To make dealing with snapshots better predictable, snapshots are emitted as an array.
$3
Lists of raw orderbooks (R0) are ordered in the same order as P0, P1, P2, P3
Tests
`bash
npm test
``