mirror of
https://github.com/freqtrade/freqtrade.git
synced 2024-11-14 04:03:55 +00:00
328 lines
11 KiB
Markdown
328 lines
11 KiB
Markdown
# Telegram usage
|
|
|
|
## Setup your Telegram bot
|
|
|
|
Below we explain how to create your Telegram Bot, and how to get your
|
|
Telegram user id.
|
|
|
|
### 1. Create your Telegram bot
|
|
|
|
Start a chat with the [Telegram BotFather](https://telegram.me/BotFather)
|
|
|
|
Send the message `/newbot`.
|
|
|
|
*BotFather response:*
|
|
|
|
> Alright, a new bot. How are we going to call it? Please choose a name for your bot.
|
|
|
|
Choose the public name of your bot (e.x. `Freqtrade bot`)
|
|
|
|
*BotFather response:*
|
|
|
|
> Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot.
|
|
|
|
Choose the name id of your bot and send it to the BotFather (e.g. "`My_own_freqtrade_bot`")
|
|
|
|
*BotFather response:*
|
|
|
|
> Done! Congratulations on your new bot. You will find it at `t.me/yourbots_name_bot`. You can now add a description, about section and profile picture for your bot, see /help for a list of commands. By the way, when you've finished creating your cool bot, ping our Bot Support if you want a better username for it. Just make sure the bot is fully operational before you do this.
|
|
|
|
> Use this token to access the HTTP API: `22222222:APITOKEN`
|
|
|
|
> For a description of the Bot API, see this page: https://core.telegram.org/bots/api Father bot will return you the token (API key)
|
|
|
|
Copy the API Token (`22222222:APITOKEN` in the above example) and keep use it for the config parameter `token`.
|
|
|
|
Don't forget to start the conversation with your bot, by clicking `/START` button
|
|
|
|
### 2. Telegram user_id
|
|
|
|
#### Get your user id
|
|
|
|
Talk to the [userinfobot](https://telegram.me/userinfobot)
|
|
|
|
Get your "Id", you will use it for the config parameter `chat_id`.
|
|
|
|
#### Use Group id
|
|
|
|
You can use bots in telegram groups by just adding them to the group. You can find the group id by first adding a [RawDataBot](https://telegram.me/rawdatabot) to your group. The Group id is shown as id in the `"chat"` section, which the RawDataBot will send to you:
|
|
|
|
``` json
|
|
"chat":{
|
|
"id":-1001332619709
|
|
}
|
|
```
|
|
|
|
For the Freqtrade configuration, you can then use the the full value (including `-` if it's there) as string:
|
|
|
|
```json
|
|
"chat_id": "-1001332619709"
|
|
```
|
|
|
|
## Control telegram noise
|
|
|
|
Freqtrade provides means to control the verbosity of your telegram bot.
|
|
Each setting has the following possible values:
|
|
|
|
* `on` - Messages will be sent, and user will be notified.
|
|
* `silent` - Message will be sent, Notification will be without sound / vibration.
|
|
* `off` - Skip sending a message-type all together.
|
|
|
|
Example configuration showing the different settings:
|
|
|
|
``` json
|
|
"telegram": {
|
|
"enabled": true,
|
|
"token": "your_telegram_token",
|
|
"chat_id": "your_telegram_chat_id",
|
|
"notification_settings": {
|
|
"status": "silent",
|
|
"warning": "on",
|
|
"startup": "off",
|
|
"buy": "silent",
|
|
"sell": "on",
|
|
"buy_cancel": "silent",
|
|
"sell_cancel": "on"
|
|
},
|
|
"balance_dust_level": 0.01
|
|
},
|
|
```
|
|
|
|
`balance_dust_level` will define what the `/balance` command takes as "dust" - Currencies with a balance below this will be shown.
|
|
|
|
## Create a custom keyboard (command shortcut buttons)
|
|
|
|
Telegram allows us to create a custom keyboard with buttons for commands.
|
|
The default custom keyboard looks like this.
|
|
|
|
```python
|
|
[
|
|
["/daily", "/profit", "/balance"], # row 1, 3 commands
|
|
["/status", "/status table", "/performance"], # row 2, 3 commands
|
|
["/count", "/start", "/stop", "/help"] # row 3, 4 commands
|
|
]
|
|
```
|
|
|
|
### Usage
|
|
|
|
You can create your own keyboard in `config.json`:
|
|
|
|
``` json
|
|
"telegram": {
|
|
"enabled": true,
|
|
"token": "your_telegram_token",
|
|
"chat_id": "your_telegram_chat_id",
|
|
"keyboard": [
|
|
["/daily", "/stats", "/balance", "/profit"],
|
|
["/status table", "/performance"],
|
|
["/reload_config", "/count", "/logs"]
|
|
]
|
|
},
|
|
```
|
|
|
|
!!! Note "Supported Commands"
|
|
Only the following commands are allowed. Command arguments are not supported!
|
|
|
|
`/start`, `/stop`, `/status`, `/status table`, `/trades`, `/profit`, `/performance`, `/daily`, `/stats`, `/count`, `/locks`, `/balance`, `/stopbuy`, `/reload_config`, `/show_config`, `/logs`, `/whitelist`, `/blacklist`, `/edge`, `/help`, `/version`
|
|
|
|
## Telegram commands
|
|
|
|
Per default, the Telegram bot shows predefined commands. Some commands
|
|
are only available by sending them to the bot. The table below list the
|
|
official commands. You can ask at any moment for help with `/help`.
|
|
|
|
| Command | Description |
|
|
|----------|-------------|
|
|
| `/start` | Starts the trader
|
|
| `/stop` | Stops the trader
|
|
| `/stopbuy` | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
|
|
| `/reload_config` | Reloads the configuration file
|
|
| `/show_config` | Shows part of the current configuration with relevant settings to operation
|
|
| `/logs [limit]` | Show last log messages.
|
|
| `/status` | Lists all open trades
|
|
| `/status <trade_id>` | Lists one or more specific trade. Separate multiple <trade_id> with a blank space.
|
|
| `/status table` | List all open trades in a table format. Pending buy orders are marked with an asterisk (*) Pending sell orders are marked with a double asterisk (**)
|
|
| `/trades [limit]` | List all recently closed trades in a table format.
|
|
| `/delete <trade_id>` | Delete a specific trade from the Database. Tries to close open orders. Requires manual handling of this trade on the exchange.
|
|
| `/count` | Displays number of trades used and available
|
|
| `/locks` | Show currently locked pairs.
|
|
| `/unlock <pair | lock_id>` | Remove the lock for this pair (or for this lock id).
|
|
| `/profit` | Display a summary of your profit/loss from close trades and some stats about your performance
|
|
| `/forcesell <trade_id>` | Instantly sells the given trade (Ignoring `minimum_roi`).
|
|
| `/forcesell all` | Instantly sells all open trades (Ignoring `minimum_roi`).
|
|
| `/forcebuy <pair> [rate]` | Instantly buys the given pair. Rate is optional. (`forcebuy_enable` must be set to True)
|
|
| `/performance` | Show performance of each finished trade grouped by pair
|
|
| `/balance` | Show account balance per currency
|
|
| `/daily <n>` | Shows profit or loss per day, over the last n days (n defaults to 7)
|
|
| `/stats` | Shows Wins / losses by Sell reason as well as Avg. holding durations for buys and sells
|
|
| `/whitelist` | Show the current whitelist
|
|
| `/blacklist [pair]` | Show the current blacklist, or adds a pair to the blacklist.
|
|
| `/edge` | Show validated pairs by Edge if it is enabled.
|
|
| `/help` | Show help message
|
|
| `/version` | Show version
|
|
|
|
## Telegram commands in action
|
|
|
|
Below, example of Telegram message you will receive for each command.
|
|
|
|
### /start
|
|
|
|
> **Status:** `running`
|
|
|
|
### /stop
|
|
|
|
> `Stopping trader ...`
|
|
> **Status:** `stopped`
|
|
|
|
### /stopbuy
|
|
|
|
> **status:** `Setting max_open_trades to 0. Run /reload_config to reset.`
|
|
|
|
Prevents the bot from opening new trades by temporarily setting "max_open_trades" to 0. Open trades will be handled via their regular rules (ROI / Sell-signal, stoploss, ...).
|
|
|
|
After this, give the bot time to close off open trades (can be checked via `/status table`).
|
|
Once all positions are sold, run `/stop` to completely stop the bot.
|
|
|
|
`/reload_config` resets "max_open_trades" to the value set in the configuration and resets this command.
|
|
|
|
!!! Warning
|
|
The stop-buy signal is ONLY active while the bot is running, and is not persisted anyway, so restarting the bot will cause this to reset.
|
|
|
|
### /status
|
|
|
|
For each open trade, the bot will send you the following message.
|
|
|
|
> **Trade ID:** `123` `(since 1 days ago)`
|
|
> **Current Pair:** CVC/BTC
|
|
> **Open Since:** `1 days ago`
|
|
> **Amount:** `26.64180098`
|
|
> **Open Rate:** `0.00007489`
|
|
> **Current Rate:** `0.00007489`
|
|
> **Current Profit:** `12.95%`
|
|
> **Stoploss:** `0.00007389 (-0.02%)`
|
|
|
|
### /status table
|
|
|
|
Return the status of all open trades in a table format.
|
|
|
|
```
|
|
ID Pair Since Profit
|
|
---- -------- ------- --------
|
|
67 SC/BTC 1 d 13.33%
|
|
123 CVC/BTC 1 h 12.95%
|
|
```
|
|
|
|
### /count
|
|
|
|
Return the number of trades used and available.
|
|
|
|
```
|
|
current max
|
|
--------- -----
|
|
2 10
|
|
```
|
|
|
|
### /profit
|
|
|
|
Return a summary of your profit/loss and performance.
|
|
|
|
> **ROI:** Close trades
|
|
> ∙ `0.00485701 BTC (258.45%)`
|
|
> ∙ `62.968 USD`
|
|
> **ROI:** All trades
|
|
> ∙ `0.00255280 BTC (143.43%)`
|
|
> ∙ `33.095 EUR`
|
|
>
|
|
> **Total Trade Count:** `138`
|
|
> **First Trade opened:** `3 days ago`
|
|
> **Latest Trade opened:** `2 minutes ago`
|
|
> **Avg. Duration:** `2:33:45`
|
|
> **Best Performing:** `PAY/BTC: 50.23%`
|
|
|
|
### /forcesell <trade_id>
|
|
|
|
> **BITTREX:** Selling BTC/LTC with limit `0.01650000 (profit: ~-4.07%, -0.00008168)`
|
|
|
|
### /forcebuy <pair>
|
|
|
|
> **BITTREX:** Buying ETH/BTC with limit `0.03400000` (`1.000000 ETH`, `225.290 USD`)
|
|
|
|
Note that for this to work, `forcebuy_enable` needs to be set to true.
|
|
|
|
[More details](configuration.md#understand-forcebuy_enable)
|
|
|
|
### /performance
|
|
|
|
Return the performance of each crypto-currency the bot has sold.
|
|
> Performance:
|
|
> 1. `RCN/BTC 57.77%`
|
|
> 2. `PAY/BTC 56.91%`
|
|
> 3. `VIB/BTC 47.07%`
|
|
> 4. `SALT/BTC 30.24%`
|
|
> 5. `STORJ/BTC 27.24%`
|
|
> ...
|
|
|
|
### /balance
|
|
|
|
Return the balance of all crypto-currency your have on the exchange.
|
|
|
|
> **Currency:** BTC
|
|
> **Available:** 3.05890234
|
|
> **Balance:** 3.05890234
|
|
> **Pending:** 0.0
|
|
|
|
> **Currency:** CVC
|
|
> **Available:** 86.64180098
|
|
> **Balance:** 86.64180098
|
|
> **Pending:** 0.0
|
|
|
|
### /daily <n>
|
|
|
|
Per default `/daily` will return the 7 last days.
|
|
The example below if for `/daily 3`:
|
|
|
|
> **Daily Profit over the last 3 days:**
|
|
```
|
|
Day Profit BTC Profit USD
|
|
---------- -------------- ------------
|
|
2018-01-03 0.00224175 BTC 29,142 USD
|
|
2018-01-02 0.00033131 BTC 4,307 USD
|
|
2018-01-01 0.00269130 BTC 34.986 USD
|
|
```
|
|
|
|
### /whitelist
|
|
|
|
Shows the current whitelist
|
|
|
|
> Using whitelist `StaticPairList` with 22 pairs
|
|
> `IOTA/BTC, NEO/BTC, TRX/BTC, VET/BTC, ADA/BTC, ETC/BTC, NCASH/BTC, DASH/BTC, XRP/BTC, XVG/BTC, EOS/BTC, LTC/BTC, OMG/BTC, BTG/BTC, LSK/BTC, ZEC/BTC, HOT/BTC, IOTX/BTC, XMR/BTC, AST/BTC, XLM/BTC, NANO/BTC`
|
|
|
|
### /blacklist [pair]
|
|
|
|
Shows the current blacklist.
|
|
If Pair is set, then this pair will be added to the pairlist.
|
|
Also supports multiple pairs, separated by a space.
|
|
Use `/reload_config` to reset the blacklist.
|
|
|
|
> Using blacklist `StaticPairList` with 2 pairs
|
|
>`DODGE/BTC`, `HOT/BTC`.
|
|
|
|
### /edge
|
|
|
|
Shows pairs validated by Edge along with their corresponding win-rate, expectancy and stoploss values.
|
|
|
|
> **Edge only validated following pairs:**
|
|
```
|
|
Pair Winrate Expectancy Stoploss
|
|
-------- --------- ------------ ----------
|
|
DOCK/ETH 0.522727 0.881821 -0.03
|
|
PHX/ETH 0.677419 0.560488 -0.03
|
|
HOT/ETH 0.733333 0.490492 -0.03
|
|
HC/ETH 0.588235 0.280988 -0.02
|
|
ARDR/ETH 0.366667 0.143059 -0.01
|
|
```
|
|
|
|
### /version
|
|
|
|
> **Version:** `0.14.3`
|