bfx-api-node-util
v1.0.12
Published
Utilities for the Bitfinex node API
Downloads
2,892
Readme
Bitfinex API Utilities for Node.JS
This repo contains minor utilities shared by the Bitfinex Node.JS API libraries.
Features
prepareAmount
andpreparePrice
for making values API-compatiblenonce
generator functionpadCandles
for handling gaps in candle data returned by the Bitfinex APIs
Installation
npm i --save bfx-api-node-util
Quickstart
const { nonce } = require('bfx-api-node-util')
const n = nonce()
// n is ready to be passed to API requests, or used as order CIDs, etc
Docs
Refer to docs/func_docs.md
for JSDoc-generated API documentation
Example: Padding Candles
const { padCandles } = require('bfx-api-node-util')
const { RESTv2 } = require('bfx-api-node-rest')
const rest = new RESTv2()
const candles = await rest.candles({
symbol: 'tBTCUSD',
timeframe: '1m',
})
const paddedCandles = padCandles(candles, 60 * 1000)
// paddedCandles are ready to be used for processing where 0-volume candles are required
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