bitfinexcomBitfinex RESTv1 & RESTv2 APIs for Node.JS
A Node.JS reference implementation of the Bitfinex REST APIs
To use, construct a new instance of either the RESTv1 or RESTv2 classes.
All API methods return promises and accept a callback as the last parameter; the
callback will be called with (error, response).
To minimize the data sent over the network the transmitted data is structured in
arrays. In order to reconstruct key / value pairs, set opts.transform to true
when creating an interface.
Features
- Official implementation
- REST v2 API
- REST v1 API
Installation
npm i --save bfx-api-node-restQuickstart
const { RESTv2 } = require('bfx-api-node-rest')
const rest = new RESTv2({ transform: true })
// do something with the RESTv2 instanceDocs
Documentation at https://docs.bitfinex.com/v2/reference
See docs/ for JSDoc generated documentation of available methods.
Example
const { RESTv2 } = require('bfx-api-node-rest')
const rest = new RESTv2({
apiKey: '...',
apiSecret: '...',
authToken: '...', // optional, has priority over API key/secret
url: '...', // optional
transform: true, // to have full models returned by all methods
agent: null, // optional proxy agent
})
rest.candles({
timeframe: '1m',
symbol: 'tBTCUSD',
query: {
start: Date.now() - (24 * 60 * 60 * 1000),
end: Date.now(),
limit: 1000,
}
}).then((candles) => {
// ...
}).catch((err) => {
console.log(err)
})FAQ
nonce too small
I make multiple parallel request and I receive an error that the nonce is too small. What does it mean?
Nonces are used to guard against replay attacks. When multiple HTTP requests arrive at the API with the wrong nonce, e.g. because of an async timing issue, the API will reject the request.
If you need to go parallel, you have to use multiple API keys right now.
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