Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/froggleston/freqtrade-frogtrade9000

A command-line freqtrade REST API client
https://github.com/froggleston/freqtrade-frogtrade9000

Last synced: about 1 month ago
JSON representation

A command-line freqtrade REST API client

Awesome Lists containing this project

README 

        
# This project is no longer under active development.



## Please move over to the new formal successor to frogtrade9000, [FTUI](https://github.com/freqtrade/ftui)



# frogtrade9000 - a command-line Rich client for the freqtrade REST API



I found FreqUI too cumbersome and slow on my Raspberry Pi 400 when running multiple instances of freqtrade bots. So I came up with a python Rich client:



It has very basic interactivity via the keyboard module which has cross-platform issues. I might consider porting this all to prompt-toolkit in the future, but not now.



![image](https://user-images.githubusercontent.com/1872302/130063115-1e0be16d-7f6b-4762-8730-6aaee2e91f78.png)



### Requirements



If you don't have freqtrade, get it [here](https://github.com/freqtrade/freqtrade/), and you'll satisfy most of the requirements. If not you'll need to pip install the following requirements.



#### Existing Freqtrade install



If you're intending to copy the scripts into an existing freqtrade folder, you'll need to activate your venv (e.g. `source ./path/to/freqtrade/env/bin/activate`) and pip install:



- keyboard

- rich

- psutil



#### Standalone



You'll need to activate your venv or use the global python environment, and `pip install -r requirements.txt` or manually install the following:



- numpy

- pandas

- ccxt

- python-rapidjson

- keyboard

- rich

- psutil



### Installation



#### Existing venv Freqtrade install

Once cloned, copy the script files into your freqtrade/scripts folder. That's it!



#### Existing dockerised Freqtrade install

You need to add a COPY command into your freqtrade dockerfile to copy the scripts into the container and rebuild. Full instructions coming soon!



#### Standalone

You'll need the rest_client.py file from the core freqtrade repo and place it in the same folder that you put these files. Grab it from here:

https://github.com/freqtrade/freqtrade/blob/stable/scripts/rest_client.py or



`wget https://raw.githubusercontent.com/freqtrade/freqtrade/stable/scripts/rest_client.py`



### Running



The easiest way to configure frogtrade9000 is with a YAML file. You can use a YAML file (see `example_frogtrade_config.yaml`) that contains the options you wish to run frogtrade9000 with, including multiple servers:



> ./scripts/frogtrade9000.py -y frogtrade_config.yaml



Running frogtrade9000 with no options will make it look for your `config.json` file and read in the `api_server` stanza from there, picking up the server IP, port, username and password:



> ./scripts/frogtrade9000.py



To specify a config use `-c`:



> ./scripts/frogtrade9000.py -c my-other.config.json



The nice thing about frogtrade9000 is that you can monitor multiple bots and strategies. If you run multiple bots with different IPs/ports use the `-s` flag to manually specify your own botname, the IP and ports and any username/password info of the freqtrade API servers separated by commas:



> ./scripts/frogtrade9000.py -s \[bot1\]user:[email protected]:8081,\[bot2\]user:[email protected]:8082



For simpler TTYs/terminals that cannot display curved symbols, use the `-b` option to use square edges so plots render correctly:



> ./scripts/frogtrade9000.py -s \[bot1\]user:[email protected]:8081,\[bot2\]user:[email protected]:8082 -b



Other options include:

- exclude the pair and profit charts using the `-x` flag

- include system information from the system that the bot is running on using `-s`

- include candle information from open trades (freqtrade REST API provides 5m candles) using `-k`



**Note that your password has to be RFC compliant. You can use alphanumeric characters and `- . _ ~ % ! $ & ' ( ) * + , ; =`**



### Using frogtrade9000



There's not much to say. The view updates every 5 seconds.



It uses the Rich library to provide a console view, so there isn't really any decent interactivity as part of that library. However, if the keyboard is working (see below) then you can:



- use the number keys to change the top OHCLV chart to whichever open pair your bot is trading, e.g. from the screenshot above, pressing `1` would change the chart to SHIB/USDT. Pressing `0` takes you back to BTC/USDT (or whatever informative pair you've specified in the code).

- use the letter keys to change the bottom profit chart based on whichever bots you're running, e.g. pressing `B` will take you to the bot running on `192.168.1.77:8082`

- use the PgUp key to cycle through the OHCLV chart timeframe (supports 1m, 5m, 15m, 1h, 4h)



### Known issues



- The `keyboard` module needs root/sudo on Linux to gain access to `/dev/input*`. You can run frogtrade9000 without sudo, but any of the hokey keyboard interactivity will be disabled.

- The display flickers on some terminals, e.g. git bash. I can't do anything about that.

- The exception handling is lame. This needs improvement.

- A JSON config file would help with more granular bot use and general tool settings, e.g. informative pair as default. I'll get round to this soon.

- Try setting the remote character set to UTF-8 if you see strange characters and non-functional layouts when using some terminal clients, such as SecureCRT.



### Acknowledgements



The very cool ASCII charts are from https://github.com/kroitor/asciichart under the [MIT licence](https://github.com/kroitor/asciichart/blob/master/LICENSE.txt)