Bitfinex API wrapper node for node-red
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
icons
locales/en-US
.gitignore
CHANGELOG.md
LICENSE
README.md
bitfinex.html
bitfinex.js
package.json

README.md

Bitfinex Function Node for Node-RED

npm version

node-red-contrib-bitfinex make Bitfinex API very easy to access, you can visually show exchange data in node-red's dashboard, mashup with other services, or trade from weird objects around your house.

Install

  1. Install Node-RED npm install -g node-red
  2. Go to Node-RED user directory (default: ~/.node-red)
  3. npm install node-red-contrib-bitfinex

Or start Node-RED via node-red, then go settings > Palette > Install tab in node-red and search bitfinex to install this module.

Features

Imgur

  • A credential configuration block

Imgur

  • Installed Blocks are provide in bitfinex category
  • Guides and workable rest/websocket examples are provided in help tab
  • expose rest method in function block to easy access REST API calls.

Imgur

Imgur

  • expose bfx method in function block that allows advanced usage.
  • rest, ws returned data are auto transformed to object based on bfx-api-node-models
  • The functoin block supports multiple outputs (ex: can subscribe multiple tickers and export at the same block)

Imgur

Imgur

Usage

Refer official Bitfinex document https://docs.bitfinex.com/v2/docs for all APIs.

Bitfinex API credentials can be obtained from https://www.bitfinex.com/api

Credit

The block is derived from node-red's build-in function block. And refer node-red-contrib-aws-sdk for the credential block.

The functions are build on top of Bitfinex's nodejs API library

License

MIT License