This repository has been archived by the owner on Feb 16, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] add docs on papertrader, tradebot rewrite simulation explanati…
…on in backtester
- Loading branch information
Showing
3 changed files
with
38 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Paper trading | ||
|
||
Gekko can automatically run a strategy over the live markets and simulate in realtime what happen if you would have traded on its signals. Paper trading and [backtesting](../backtesting.md) are the two simulation modes that come with Gekko. It's a great way to experiment with strategies without putting your money on the line. | ||
|
||
You can start a paper trader by going to live gekkos and clicking on "Start a new live Gekko". | ||
|
||
Keep in mind that a paper trader is a simulation, and the accuracy depends on the market you decide to run it on (you'll get pretty accurate results on big markets like USD/BTC). You can read more about the details and limitations of the simulation on [the backtesting page](../backtesting.md#Simplified-simulation). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Trading bot | ||
|
||
Once you have run enough simulations (using [backtesting](./hacktesting.md) and [paper trading](./paper_trading.md)) and you are confident in your strategy you can use Gekko as a trading bot. | ||
|
||
Gekko will run your strategy on the live market and automatically trade on your exchange account when trade signals come out of your strategy. | ||
|
||
## Preparation | ||
|
||
1. Make sure you are fully confident in your strategy! If you want to play around use either the [paper trader](./paper_trader.md) or the [backtester](./backtesting.md). Once you are confident continue with this list. | ||
2. Gekko will need to have API keys to your exchange account that have permissions to view balances and orders and create new orders. Keep in mind: | ||
- Gekko does NOT need withdrawal access, for your safety DO NOT create API keys that can withdraw. | ||
- Make sure you only use the API key for Gekko, and for nothing else. | ||
- If possible try to restrict the API key to the IP address you will run Gekko from (this makes moest sense in server environments) | ||
3. Start your gekko through either the UI or the commandline interface! | ||
|
||
## Notes | ||
|
||
Gekko will trade on the market you configured that consists of two currencies (for example USD/BTC): | ||
- Try to not trade either of these currencies on the account you use with Gekko. (in the example above: don't trade any USD nor any BTC). | ||
- Try to not withdraw or deposit more of either of these currencies. | ||
|
||
While Gekko will handle the situations above, all the profit calculations will be incorrect since your balances are taken into account while calculating profits. |