Bitfinex RESTv1 & RESTv2 APIs for Node.JS
To use, construct a new instance of either the
All API methods return promises and accept a callback as the last parameter; the
callback will be called with
To minimize the data sent over the network the transmitted data is structured in
arrays. In order to reconstruct key / value pairs, set
when creating an interface.
- Official implementation
- REST v2 API
- REST v1 API
npm i --save bfx-api-node-rest
const RESTv2 =const rest = transform: true// do something with the RESTv2 instance
Documentation at https://docs.bitfinex.com/v2/reference
docs/ for JSDoc generated documentation of available methods.
const RESTv2 =const rest =apiKey: '...'apiSecret: '...'authToken: '...' // optional, has priority over API key/secreturl: '...' // optionaltransform: true // to have full models returned by all methodsagent: null // optional proxy agentrest
NOTE: v1 REST and WS clients
Both v1 client classes & server APIs have been deprecated, and will be removed.
In the meantime, some methods available via
RESTv1 have been exposed on
RESTv2 to prevent future migration issues. Although the underlying
implementation of these methods is likely to change once they are fully ported
to v2, the signatures should remain the same.
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.
- 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