Skip to content
This repository has been archived by the owner on Feb 15, 2022. It is now read-only.

WIP: Rework docs #1816

Merged
merged 41 commits into from
Mar 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
3f6a48d
shortened the readme
DJCrashdummy Jan 16, 2019
65c13fd
added cut out parts of the old readme
DJCrashdummy Jan 16, 2019
3f9bf0e
corrected links
DJCrashdummy Jan 16, 2019
c8dbe60
Create requirements.md
DJCrashdummy Jan 16, 2019
a84c3e6
Create debian-ubuntu.md
DJCrashdummy Jan 16, 2019
d85c0f4
Create docker.md
DJCrashdummy Jan 16, 2019
85ac5fc
Create install.md
DJCrashdummy Jan 16, 2019
366767f
Create notifiers.md
DJCrashdummy Jan 16, 2019
52f0107
Create list-strategies.md
DJCrashdummy Jan 16, 2019
c8d8b15
Create trend_ema.md
DJCrashdummy Jan 16, 2019
1b8a98f
Create macd.md
DJCrashdummy Jan 16, 2019
09f9934
Create rsi.md
DJCrashdummy Jan 16, 2019
035808b
Create sar.md
DJCrashdummy Jan 16, 2019
06ee59e
Create speed.md
DJCrashdummy Jan 16, 2019
6004d75
Create tweaking.md
DJCrashdummy Jan 16, 2019
8bae5a3
moved raspberrypi.md into install-folder
DJCrashdummy Jan 16, 2019
e99a5b3
Create noop.md
DJCrashdummy Jan 16, 2019
a883984
added Pushover
DJCrashdummy Jan 17, 2019
2d5756d
made an own section for Documentation
DJCrashdummy Jan 17, 2019
c3d4424
Delete discord.png
DJCrashdummy Jan 17, 2019
7c9326b
updated FAQs
DJCrashdummy Jan 17, 2019
b4d5ac4
fixed jump-marks
DJCrashdummy Jan 17, 2019
c1323e7
audited headers
DJCrashdummy Jan 17, 2019
e9d4c5f
fixed last header
DJCrashdummy Jan 17, 2019
e50dd7c
improved ("automatized") jump-marks
DJCrashdummy Jan 17, 2019
f2e979f
deleted old ("manual") jump-marks
DJCrashdummy Jan 17, 2019
772191d
reworked links
DJCrashdummy Jan 17, 2019
a9253cf
fixed jump-marks again
DJCrashdummy Jan 17, 2019
06f5477
added Binance, HitBTC & TheRockTrading to the supported exchanges
DJCrashdummy Jan 17, 2019
4e865de
sorted OSes according recommendation
DJCrashdummy Jan 17, 2019
c9e9042
made it match the other guides
DJCrashdummy Jan 19, 2019
8f4c2cf
added link to install guide
DJCrashdummy Jan 19, 2019
98632d3
reworked guide a bit
DJCrashdummy Jan 19, 2019
30e9c44
separated links
DJCrashdummy Jan 19, 2019
2473140
minor corrections
DJCrashdummy Jan 19, 2019
00746e2
minor polish
DJCrashdummy Jan 19, 2019
48e3d31
moved & renamed file
DJCrashdummy Jan 19, 2019
688e025
moved file
DJCrashdummy Jan 19, 2019
e4ae863
moved file
DJCrashdummy Jan 19, 2019
35ce07f
moved file
DJCrashdummy Jan 19, 2019
d0377e1
moved file
DJCrashdummy Jan 20, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
800 changes: 14 additions & 786 deletions README.md

Large diffs are not rendered by default.

Binary file removed assets/discord.png
Binary file not shown.
114 changes: 63 additions & 51 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,92 +1,86 @@
## Frequently Asked Questions
# Frequently Asked Questions

Here are a few questions that have been asked often as well as answers from the community.

If you have a question that is not answered here, feel free to ask in the [Discord](#community) chat and suggest it to be placed here.
If you have a question that is not answered here, feel free to ask in the [Reddit](#is-there-a-community-to-get-involved-with-zenbot) community and suggest it to be placed here.

Thanks!


### Contents

* [Will I make money with Zenbot?](#money)
* [Is Docker necessary when installing Zenbot?](#docker)
* [Why do simulations, paper trading, and live trading all yield different results?](#sim-live-differences)
* [Why should I use simulations or paper trading if they do not reflect live trading?](#why-sim)
* [How do I launch Zenbot?](#commands)
* [Does Zenbot use Limit orders or Market orders?](#limit-market-orders)
* [Is there a community to get involved with Zenbot?](#community)
* [Can I install Zenbot on Windows?](#windows)
* [How do I update Zenbot?](#update)
* [Why do I keep getting a this "Nonce" error?](#error-1)
## Contents

### [General](#general-1)
* [Is there a community to get involved with Zenbot?](#is-there-a-community-to-get-involved-with-zenbot)

### [Trading](#trading-1)
* [Will I make money with Zenbot?](#will-i-make-money-with-zenbot)
* [Why do simulations, paper trading, and live trading all yield different results?](#why-do-simulations-paper-trading-and-live-trading-all-yield-different-results)
* [Why should I use simulations or paper trading if they do not reflect live trading?](#why-should-i-use-simulations-or-paper-trading-if-they-do-not-reflect-live-trading)
* [Does Zenbot use Limit (maker) orders or Market (taker) orders?](#does-zenbot-use-limit-maker-orders-or-market-taker-orders)

**Will I make money with Zenbot?** <a name="money"></a>
### [Technical](#technical-1)
* [Can I install Zenbot on Windows?](#can-i-install-zenbot-on-windows)
* [Is Docker necessary when installing Zenbot?](#is-docker-necessary-when-installing-zenbot)
* [How do I launch Zenbot?](#how-do-i-launch-zenbot)
* [How do I update Zenbot?](#how-do-i-update-zenbot)

That depends… Different configurations and strategies will yield different results.
### [Errors](#errors-1)
* [Why do I keep getting a "Nonce" error?](#why-do-i-keep-getting-a-nonce-error)

The current default config and parameters will likely lose you money, so proceed with caution. Try running simulations and paper trading first to see how the bot acts (see warning below).


## Answers

**Is Docker necessary when installing Zenbot?** <a name="docker"></a>
### General

No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Ubuntu, CentOS, etc.) without Docker.
#### Is there a community to get involved with Zenbot?

If running Zenbot on Windows, Docker may be needed.
Of course! Check out our Reddit community ([subreddit zenbot](https://reddit.com/r/zenbot)).

There is also [a shared Google Docs spreadsheet containing community sim results and variable descriptions](https://docs.google.com/spreadsheets/d/1WjFKRUY4KpkdIJiA3RVvKqiyNkMe9xtgLSfYESFXk1g/edit#gid=70204991).


**Why do simulations, paper trading, and live trading all yield different results?** <a name="sim-live-differences"></a>

Simulations and paper trading almost always give overly optimistic results compared to live trading. This is because simulations and paper trading both make assumptions about when/if an order is filled.
### Trading

Because Zenbot defaults to using Limit orders (which often lessen fees), there tends to be much more slippage (the difference between when the bot decides to buy and when it actually buys) in live trading. Due to this, live trading is almost always worse than sims and paper trading.
#### Will I make money with Zenbot?

Also, remember that past results do not guarantee future returns.
That depends… Different configurations and strategies will yield different results.

The current default config and parameters will likely lose you money, so proceed with caution. Try running simulations and paper trading first to see how the bot acts (see warning below).


**Why should I use simulations or paper trading if they do not reflect live trading?** <a name="why-sim"></a>

Simulations are more optimistic than paper trading.
Paper trading is more optimistic than live trading.
Therefore, if a simulation does not yield good results, odds are that neither will paper trading or (by extension) live trading.
#### Why do simulations, paper trading, and live trading all yield different results?

Simulations and paper trading almost always give overly optimistic results compared to live trading. This is because simulations and paper trading both make assumptions about when/if an order is filled.

**How do I launch Zenbot?** <a name="commands"></a>
Because Zenbot defaults to using Limit orders (which often lessen fees), there tends to be much more slippage (the difference between when the bot decides to buy and when it actually buys) in live trading. Due to this, live trading is almost always worse than sims and paper trading.

After installation, you lauch Zenbot via command line.
Example:
```
./zenbot.sh backfill gdax.ETH-BTC
./zenbot.sh sim gdax.ETH-BTC --days=14 or zenbot sim --days 14
```
[You can generate a command with this google spreadsheet](https://docs.google.com/spreadsheets/d/1HECEHW-I9Evve_FQV3LT_IWGV6FU34tHif9TEouKtfg/edit?usp=sharing).
Do not hesitate to copy this file to your Google drive or download it as an Excel file, as everybody can modify it simultaneously.
Also, remember that past results do not guarantee future returns.


**Why does Zenbot use Limit orders by default?** <a name="limit-market-orders"></a>

On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there is no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order.
#### Why should I use simulations or paper trading if they do not reflect live trading?

Check your exchange for fees.
Simulations are more optimistic than paper trading.
Paper trading is more optimistic than live trading.
Therefore, if a simulation does not yield good results, odds are that neither will paper trading or (by extension) live trading.



**Is there a community to get involved with Zenbot?** <a name="community"></a>
#### Does Zenbot use Limit (maker) orders or Market (taker) orders?

Of course! Check out our Discord channel:
Zenbot uses Limit orders by default because on most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there is no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order.

[![zenbot logo](https://rawgit.com/carlos8f/zenbot/master/assets/discord.png)](https://discord.gg/ZdAd2gP)
Check your exchange for fees.

There is also a shared Google Doc spreadsheet containing community sim results and variable descriptions:
[Click here for the Google Sheet](https://docs.google.com/spreadsheets/d/1WjFKRUY4KpkdIJiA3RVvKqiyNkMe9xtgLSfYESFXk1g/edit#gid=70204991).


### Technical

**Can I install Zenbot on Windows?** <a name="windows"></a>
#### Can I install Zenbot on Windows?

Yes, Zenbot can be installed on Windows, although it is recommended that Linux or macOS is used instead.

Expand All @@ -108,19 +102,38 @@ To install Zenbot on Windows it is currently required to have Visual Studio 2015



**How do I update Zenbot?** <a name="update"></a>
#### Is Docker necessary when installing Zenbot?

No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Debian, CentOS, etc.) without Docker.

If running Zenbot on Windows, Docker may be needed.



#### How do I launch Zenbot?

After installation, you lauch Zenbot via command line.
Examples:
```
./zenbot.sh backfill gdax.ETH-BTC
./zenbot.sh sim gdax.ETH-BTC --days=14
zenbot sim --days 14
```
You can [generate a command with this shared Google Docs spreadsheet](https://docs.google.com/spreadsheets/d/1HECEHW-I9Evve_FQV3LT_IWGV6FU34tHif9TEouKtfg/edit?usp=sharing).
Do not hesitate to copy this file to your Google drive or download it as an spreadsheet, as everybody can modify it simultaneously.


Without Docker:

#### How do I update Zenbot?

Without Docker:
```
git pull
npm install
./zenbot.sh trade --paper
```


With Docker:

```
git pull
docker-compose down
Expand All @@ -131,10 +144,9 @@ docker-compose up -d




### Errors

**Why do I keep getting this "Nonce" error? How do I solve it?** <a name="error-1"></a>
#### Why do I keep getting a "Nonce" error?

This error may occur when multiple instances of Zenbot are used with the same API key. To avoid this, use a different API key for each concurrent instance of Zenbot.

Expand Down
Loading