diff --git a/docs/faq.md b/docs/faq.md index 31a302067..4bbf28fe6 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,43 +2,43 @@ #### I have waited 5 minutes, why hasn't the bot made any trades yet?! -Depending on the buy strategy, the amount of whitelisted coins, the -situation of the market etc, it can take up to hours to find good entry +Depending on the buy strategy, the amount of whitelisted coins, the +situation of the market etc, it can take up to hours to find good entry position for a trade. Be patient! #### I have made 12 trades already, why is my total profit negative?! -I understand your disappointment but unfortunately 12 trades is just -not enough to say anything. If you run backtesting, you can see that our -current algorithm does leave you on the plus side, but that is after -thousands of trades and even there, you will be left with losses on -specific coins that you have traded tens if not hundreds of times. We -of course constantly aim to improve the bot but it will _always_ be a -gamble, which should leave you with modest wins on monthly basis but +I understand your disappointment but unfortunately 12 trades is just +not enough to say anything. If you run backtesting, you can see that our +current algorithm does leave you on the plus side, but that is after +thousands of trades and even there, you will be left with losses on +specific coins that you have traded tens if not hundreds of times. We +of course constantly aim to improve the bot but it will _always_ be a +gamble, which should leave you with modest wins on monthly basis but you can't say much from few trades. -#### I’d like to change the stake amount. Can I just stop the bot with +#### I’d like to change the stake amount. Can I just stop the bot with /stop and then change the config.json and run it again? -Not quite. Trades are persisted to a database but the configuration is -currently only read when the bot is killed and restarted. `/stop` more +Not quite. Trades are persisted to a database but the configuration is +currently only read when the bot is killed and restarted. `/stop` more like pauses. You can stop your bot, adjust settings and start it again. #### I want to improve the bot with a new strategy -That's great. We have a nice backtesting and hyperoptimizing setup. See -the tutorial [here|Testing-new-strategies-with-Hyperopt](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands). +That's great. We have a nice backtesting and hyperoptimizing setup. See +the tutorial [here|Testing-new-strategies-with-Hyperopt](bot-usage.md#hyperopt-commands). -#### Is there a setting to only SELL the coins being held and not +#### Is there a setting to only SELL the coins being held and not perform anymore BUYS? -You can use the `/forcesell all` command from Telegram. +You can use the `/forcesell all` command from Telegram. ### How many epoch do I need to get a good Hyperopt result? -Per default Hyperopts without `-e` or `--epochs` parameter will only -run 100 epochs, means 100 evals of your triggers, guards, .... Too few -to find a great result (unless if you are very lucky), so you probably -have to run it for 10.000 or more. But it will take an eternity to +Per default Hyperopts without `-e` or `--epochs` parameter will only +run 100 epochs, means 100 evals of your triggers, guards, .... Too few +to find a great result (unless if you are very lucky), so you probably +have to run it for 10.000 or more. But it will take an eternity to compute. We recommend you to run it at least 10.000 epochs: @@ -52,7 +52,7 @@ for i in {1..100}; do python3 ./freqtrade/main.py hyperopt -e 100; done ``` #### Why it is so long to run hyperopt? -Finding a great Hyperopt results takes time. +Finding a great Hyperopt results takes time. If you wonder why it takes a while to find great hyperopt results @@ -60,12 +60,11 @@ This answer was written during the under the release 0.15.1, when we had : - 8 triggers - 9 guards: let's say we evaluate even 10 values from each -- 1 stoploss calculation: let's say we want 10 values from that too to +- 1 stoploss calculation: let's say we want 10 values from that too to be evaluated The following calculation is still very rough and not very precise -but it will give the idea. With only these triggers and guards there is -already 8*10^9*10 evaluations. A roughly total of 80 billion evals. -Did you run 100 000 evals? Congrats, you've done roughly 1 / 100 000 th +but it will give the idea. With only these triggers and guards there is +already 8*10^9*10 evaluations. A roughly total of 80 billion evals. +Did you run 100 000 evals? Congrats, you've done roughly 1 / 100 000 th of the search space. - diff --git a/docs/hyperopt.md b/docs/hyperopt.md index 1e96f4b5c..58dc91e3a 100644 --- a/docs/hyperopt.md +++ b/docs/hyperopt.md @@ -12,7 +12,7 @@ and still take a long time. ## Prepare Hyperopting Before we start digging in Hyperopt, we recommend you to take a look at -an example hyperopt file located into [user_data/hyperopts/](https://github.com/gcarq/freqtrade/blob/develop/user_data/hyperopts/test_hyperopt.py) +an example hyperopt file located into [user_data/hyperopts/](https://github.com/freqtrade/freqtrade/blob/develop/user_data/hyperopts/test_hyperopt.py) ### 1. Install a Custom Hyperopt File This is very simple. Put your hyperopt file into the folder diff --git a/docs/installation.md b/docs/installation.md index 10a64c110..e5f514eb1 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -62,7 +62,7 @@ git checkout develop ./setup.sh --install ``` !!! Note - Windows installation is explained [here](/#windows). + Windows installation is explained [here](#windows).
## Easy Installation - Linux Script @@ -137,7 +137,7 @@ cd freqtrade cp -n config.json.example config.json ``` -> To edit the config please refer to the [Bot Configuration](/configuration.md) page. +> To edit the config please refer to the [Bot Configuration](configuration.md) page. **1.5. Create your database file *(optional - the bot will create it if it is missing)** @@ -271,7 +271,7 @@ docker run -d \ freqtrade --strategy AwsomelyProfitableStrategy backtesting ``` -Head over to the [Backtesting Documentation](https://github.com/freqtrade/freqtrade/blob/develop/docs/backtesting.md) for more details. +Head over to the [Backtesting Documentation](backtesting.md) for more details. !!! Note Additional parameters can be appended after the image name (`freqtrade` in the above example). @@ -386,7 +386,7 @@ cd freqtrade cp config.json.example config.json ``` -> *To edit the config please refer to [Bot Configuration](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md).* +> *To edit the config please refer to [Bot Configuration](configuration.md).* #### 5. Install python dependencies diff --git a/docs/telegram-usage.md b/docs/telegram-usage.md index 28213fb5d..fa765f697 100644 --- a/docs/telegram-usage.md +++ b/docs/telegram-usage.md @@ -3,13 +3,13 @@ This page explains how to command your bot with Telegram. ## Pre-requisite -To control your bot with Telegram, you need first to -[set up a Telegram bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/pre-requisite.md) +To control your bot with Telegram, you need first to +[set up a Telegram bot](installation.md) and add your Telegram API keys into your config file. ## 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 +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 | Default | Description | @@ -40,30 +40,30 @@ Below, example of Telegram message you will receive for each command. ### /stop -> `Stopping trader ...` +> `Stopping trader ...` > **Status:** `stopped` ## /status For each open trade, the bot will send you the following message. -> **Trade ID:** `123` +> **Trade ID:** `123` > **Current Pair:** CVC/BTC -> **Open Since:** `1 days ago` -> **Amount:** `26.64180098` -> **Open Rate:** `0.00007489` -> **Close Rate:** `None` -> **Current Rate:** `0.00007489` -> **Close Profit:** `None` -> **Current Profit:** `12.95%` +> **Open Since:** `1 days ago` +> **Amount:** `26.64180098` +> **Open Rate:** `0.00007489` +> **Close Rate:** `None` +> **Current Rate:** `0.00007489` +> **Close Profit:** `None` +> **Current Profit:** `12.95%` > **Open Order:** `None` ## /status table Return the status of all open trades in a table format. ``` - ID Pair Since Profit ----- -------- ------- -------- + ID Pair Since Profit +---- -------- ------- -------- 67 SC/BTC 1 d 13.33% 123 CVC/BTC 1 h 12.95% ``` @@ -73,32 +73,32 @@ Return the status of all open trades in a table format. Return the number of trades used and available. ``` current max ---------- ----- - 2 10 +--------- ----- + 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` +> **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 > **BITTREX:** Selling BTC/LTC with limit `0.01650000 (profit: ~-4.07%, -0.00008168)` -## /forcebuy +## /forcebuy > **BITTREX**: Buying ETH/BTC with limit `0.03400000` (`1.000000 ETH`, `225.290 USD`) @@ -107,7 +107,7 @@ Note that for this to work, `forcebuy_enable` needs to be set to true. ## /performance Return the performance of each crypto-currency the bot has sold. -> Performance: +> Performance: > 1. `RCN/BTC 57.77%` > 2. `PAY/BTC 56.91%` > 3. `VIB/BTC 47.07%` @@ -119,31 +119,30 @@ Return the performance of each crypto-currency the bot has sold. Return the balance of all crypto-currency your have on the exchange. -> **Currency:** BTC -> **Available:** 3.05890234 -> **Balance:** 3.05890234 -> **Pending:** 0.0 +> **Currency:** BTC +> **Available:** 3.05890234 +> **Balance:** 3.05890234 +> **Pending:** 0.0 -> **Currency:** CVC -> **Available:** 86.64180098 -> **Balance:** 86.64180098 +> **Currency:** CVC +> **Available:** 86.64180098 +> **Balance:** 86.64180098 > **Pending:** 0.0 ## /daily -Per default `/daily` will return the 7 last days. +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 +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 ``` ## /version -> **Version:** `0.14.3` - +> **Version:** `0.14.3`