https://github.com/bitfinexcom/bfx-stuff-ui
Bitfinex UI Goodies
https://github.com/bitfinexcom/bfx-stuff-ui
Last synced: 3 months ago
JSON representation
Bitfinex UI Goodies
- Host: GitHub
- URL: https://github.com/bitfinexcom/bfx-stuff-ui
- Owner: bitfinexcom
- Created: 2018-10-25T17:29:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-21T15:02:11.000Z (over 7 years ago)
- Last Synced: 2025-10-15T15:04:11.701Z (8 months ago)
- Language: JavaScript
- Homepage: https://www.bitfinex.com
- Size: 557 KB
- Stars: 14
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bfx-stuff-ui
## CONFIGURE
1. Setup the configuration file.
```
cp config.json.example config.json
```
2. Add your Bitfinex `apiKey` and `apiSecret` (you can generate those from https://www.bitfinex.com/api).
3. If you want to run Twitter examples, configure your Twitter authentication keys `twitterKey`, `twitterSecret`, `twitterAccessToken`, `twitterAccessSecret`.
* If you want to run Telegram examples, configure your Telegram bot key `tgKey`.
## RUN EXAMPLES
#### BASIC EXAMPLES
* Shows a simple notification in your Bitfinex UI.
```
node bi.js notify_basic
```
* Adds 5 chart markers in your Bitfinex UI chart
Note: make sure to use the 5m (or 15m) timeframe and zoom towards current time
```
node bi.js chart_marks_basic
```
* Add custom shapes to Bitfinex UI chart
```
node bi.js chart_shapes_basic
```
#### TWITTER SENTIMENT ANALISYS AND CHART MARKERS
Subscribes to a list of Twitter influencers, performs basic sentiment analysis and adds the relative markers to the Bitfinex UI chart.
```
node bi.js chart_marks_twitter
```
#### TELEGRAM BOT AND CHART MARKERS
Registers a Telegram Bot command: `notify`
Once running you'll be able to interact with the bot sending `/notify fooooooo` message and you'll see `fooooooo` appearing as notification in Bitfinex UI.
```
node bi.js notify_telegram
```