adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more links corrected

Browse Source
This commit is contained in:
misagh 2018-12-31 14:00:36 +01:00
parent 366980fd62
commit 827a8309d7
4 changed files with 73 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/faq.md
View File

@ -2,43 +2,43 @@
#### I have waited 5 minutes, why hasn't the bot made any trades yet?! #### 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 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 situation of the market etc, it can take up to hours to find good entry
position for a trade. Be patient! position for a trade. Be patient!
#### I have made 12 trades already, why is my total profit negative?! #### I have made 12 trades already, why is my total profit negative?!
I understand your disappointment but unfortunately 12 trades is just I understand your disappointment but unfortunately 12 trades is just
not enough to say anything. If you run backtesting, you can see that our 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 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 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 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 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 gamble, which should leave you with modest wins on monthly basis but
you can't say much from few trades. 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? /stop and then change the config.json and run it again?
Not quite. Trades are persisted to a database but the configuration is Not quite. Trades are persisted to a database but the configuration is
currently only read when the bot is killed and restarted. `/stop` more 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. like pauses. You can stop your bot, adjust settings and start it again.
#### I want to improve the bot with a new strategy #### I want to improve the bot with a new strategy
That's great. We have a nice backtesting and hyperoptimizing setup. See 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). 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? 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? ### How many epoch do I need to get a good Hyperopt result?
Per default Hyperopts without `-e` or `--epochs` parameter will only Per default Hyperopts without `-e` or `--epochs` parameter will only
run 100 epochs, means 100 evals of your triggers, guards, .... Too few 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 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 have to run it for 10.000 or more. But it will take an eternity to
compute. compute.
We recommend you to run it at least 10.000 epochs: 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? #### 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 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 - 8 triggers
- 9 guards: let's say we evaluate even 10 values from each - 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 be evaluated
The following calculation is still very rough and not very precise 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 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. 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 Did you run 100 000 evals? Congrats, you've done roughly 1 / 100 000 th
of the search space. of the search space.

2
docs/hyperopt.md
View File

@ -12,7 +12,7 @@ and still take a long time.
## Prepare Hyperopting ## Prepare Hyperopting
Before we start digging in Hyperopt, we recommend you to take a look at 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 ### 1. Install a Custom Hyperopt File
This is very simple. Put your hyperopt file into the folder This is very simple. Put your hyperopt file into the folder

8
docs/installation.md
View File

@ -62,7 +62,7 @@ git checkout develop
./setup.sh --install ./setup.sh --install
``` ```
!!! Note !!! Note
Windows installation is explained [here](/#windows). Windows installation is explained [here](#windows).
<hr/> <hr/>
## Easy Installation - Linux Script ## Easy Installation - Linux Script
@ -137,7 +137,7 @@ cd freqtrade
cp -n config.json.example config.json 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)** **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 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 !!! Note
Additional parameters can be appended after the image name (`freqtrade` in the above example). 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 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 #### 5. Install python dependencies

87
docs/telegram-usage.md
View File

@ -3,13 +3,13 @@
This page explains how to command your bot with Telegram. This page explains how to command your bot with Telegram.
## Pre-requisite ## Pre-requisite
To control your bot with Telegram, you need first to 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) [set up a Telegram bot](installation.md)
and add your Telegram API keys into your config file. and add your Telegram API keys into your config file.
## Telegram commands ## Telegram commands
Per default, the Telegram bot shows predefined commands. Some 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 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`. official commands. You can ask at any moment for help with `/help`.
| Command | Default | Description | | Command | Default | Description |
@ -40,30 +40,30 @@ Below, example of Telegram message you will receive for each command.
### /stop ### /stop
> `Stopping trader ...` > `Stopping trader ...`
> **Status:** `stopped` > **Status:** `stopped`
## /status ## /status
For each open trade, the bot will send you the following message. For each open trade, the bot will send you the following message.
> **Trade ID:** `123` > **Trade ID:** `123`
> **Current Pair:** CVC/BTC > **Current Pair:** CVC/BTC
> **Open Since:** `1 days ago` > **Open Since:** `1 days ago`
> **Amount:** `26.64180098` > **Amount:** `26.64180098`
> **Open Rate:** `0.00007489` > **Open Rate:** `0.00007489`
> **Close Rate:** `None` > **Close Rate:** `None`
> **Current Rate:** `0.00007489` > **Current Rate:** `0.00007489`
> **Close Profit:** `None` > **Close Profit:** `None`
> **Current Profit:** `12.95%` > **Current Profit:** `12.95%`
> **Open Order:** `None` > **Open Order:** `None`
## /status table ## /status table
Return the status of all open trades in a table format. 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% 67 SC/BTC 1 d 13.33%
123 CVC/BTC 1 h 12.95% 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. Return the number of trades used and available.
``` ```
current max current max
--------- ----- --------- -----
2 10 2 10
``` ```
## /profit ## /profit
Return a summary of your profit/loss and performance. Return a summary of your profit/loss and performance.
> **ROI:** Close trades > **ROI:** Close trades
> ∙ `0.00485701 BTC (258.45%)` > ∙ `0.00485701 BTC (258.45%)`
> ∙ `62.968 USD` > ∙ `62.968 USD`
> **ROI:** All trades > **ROI:** All trades
> ∙ `0.00255280 BTC (143.43%)` > ∙ `0.00255280 BTC (143.43%)`
> ∙ `33.095 EUR` > ∙ `33.095 EUR`
> >
> **Total Trade Count:** `138` > **Total Trade Count:** `138`
> **First Trade opened:** `3 days ago` > **First Trade opened:** `3 days ago`
> **Latest Trade opened:** `2 minutes ago` > **Latest Trade opened:** `2 minutes ago`
> **Avg. Duration:** `2:33:45` > **Avg. Duration:** `2:33:45`
> **Best Performing:** `PAY/BTC: 50.23%` > **Best Performing:** `PAY/BTC: 50.23%`
## /forcesell <trade_id> ## /forcesell <trade_id>
> **BITTREX:** Selling BTC/LTC with limit `0.01650000 (profit: ~-4.07%, -0.00008168)` > **BITTREX:** Selling BTC/LTC with limit `0.01650000 (profit: ~-4.07%, -0.00008168)`
## /forcebuy <pair> ## /forcebuy <pair>
> **BITTREX**: Buying ETH/BTC with limit `0.03400000` (`1.000000 ETH`, `225.290 USD`) > **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 ## /performance
Return the performance of each crypto-currency the bot has sold. Return the performance of each crypto-currency the bot has sold.
> Performance: > Performance:
> 1. `RCN/BTC 57.77%` > 1. `RCN/BTC 57.77%`
> 2. `PAY/BTC 56.91%` > 2. `PAY/BTC 56.91%`
> 3. `VIB/BTC 47.07%` > 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. Return the balance of all crypto-currency your have on the exchange.
> **Currency:** BTC > **Currency:** BTC
> **Available:** 3.05890234 > **Available:** 3.05890234
> **Balance:** 3.05890234 > **Balance:** 3.05890234
> **Pending:** 0.0 > **Pending:** 0.0
> **Currency:** CVC > **Currency:** CVC
> **Available:** 86.64180098 > **Available:** 86.64180098
> **Balance:** 86.64180098 > **Balance:** 86.64180098
> **Pending:** 0.0 > **Pending:** 0.0
## /daily <n> ## /daily <n>
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`: The example below if for `/daily 3`:
> **Daily Profit over the last 3 days:** > **Daily Profit over the last 3 days:**
``` ```
Day Profit BTC Profit USD Day Profit BTC Profit USD
---------- -------------- ------------ ---------- -------------- ------------
2018-01-03 0.00224175 BTC 29,142 USD 2018-01-03 0.00224175 BTC 29,142 USD
2018-01-02 0.00033131 BTC 4,307 USD 2018-01-02 0.00033131 BTC 4,307 USD
2018-01-01 0.00269130 BTC 34.986 USD 2018-01-01 0.00269130 BTC 34.986 USD
``` ```
## /version ## /version
> **Version:** `0.14.3` > **Version:** `0.14.3`