...
|
...
|
@@ -4,7 +4,7 @@ The 'binance-stepper-bot' is a **trading automation program** for [Binance Excha
|
4
|
4
|
|
5
|
5
|
It is designed to be robust and reliable, so it only utilizes usual _SELL_ and _BUY_ limit orders, each following trade is placed based on the pre-generated array of prices and has only two orders out on the market at the same time.
|
6
|
6
|
|
7
|
|
-Program is capable of sending you daily/weekly/monthly reports with the number of completed trades and estimated profit. It also saves each and every order it places on the market, thus creating monthly trading history.
|
|
7
|
+Program is capable of sending you daily/weekly/monthly CSV reports with the number of completed trades and estimated profit. It also saves each and every order it places on the market in a CSV file, thus creating monthly trading history.
|
8
|
8
|
|
9
|
9
|
## Setting up
|
10
|
10
|
|
...
|
...
|
@@ -69,18 +69,46 @@ The program uses _config.json_ file for basic configuration settings. It is divi
|
69
|
69
|
| api_key | Binance API key |
|
70
|
70
|
| api_secret | Binance API secret key |
|
71
|
71
|
| asset | cryptocurrency listed on Binance you want to buy your coin with (ex. BTC) |
|
72
|
|
-| coin | cryptocurrency listed on Binance you want to sell for you asset (ex. BNB) |
|
73
|
|
-| spread | number of step values between your BUY and SELL order (ex. 4) |
|
74
|
|
-| step | distance between prices (ex. 0.00134) |
|
75
|
|
-| conins_per_order | amount of coin for each trade (ex. 7) |
|
76
|
|
-| sender_address | email address to send emails from |
|
|
72
|
+| coin | cryptocurrency listed on Binance you want to sell for you asset (ex. ETH) |
|
|
73
|
+| spread | number of step values between your BUY and SELL order >= 0 (ex. 2) |
|
|
74
|
+| step | distance between prices >= 0 (ex. 0.00002) |
|
|
75
|
+| conins_per_order | amount of coin for each trade (ex. 5) |
|
|
76
|
+| sender_address | email address to reports emails from |
|
77
|
77
|
| sedner_pass | password from sender email |
|
78
|
|
-| receiver_adderss | email address to send email to (could be the same as sender address) |
|
|
78
|
+| receiver_adderss | email address to send reports to (could be the same as sender address) |
|
79
|
79
|
|
80
|
|
-Some unimplemented configuration, like: toggle emailing, using different SMTP provider, frequency of report generation should be done by commenting appropriate source code section. For now.
|
81
|
|
-
|
82
|
|
-## Usage
|
|
80
|
+Some unimplemented configuration, like: toggle emailing, using different SMTP provider, frequency of report generation, frequency of market review should be done by commenting out appropriate source code section. For now.
|
83
|
81
|
|
84
|
82
|
## Trading Algorithm
|
85
|
83
|
|
|
84
|
+#### Flow Chart
|
|
85
|
+
|
|
86
|
+Simplified version of the general algorithm can be viewed on the flowchart below:
|
|
87
|
+
|
|
88
|
+[Generalized Algorithm](img/flowchart.jpg)
|
|
89
|
+
|
|
90
|
+#### Step and Spread
|
|
91
|
+
|
|
92
|
+In order to set the optimal values inside config file you should first get a brief idea of how do the orders are being generated and how do the values of **step** and **spread** affect them.
|
|
93
|
+
|
|
94
|
+It is easy to demonstrate on an example with arbitrary values:
|
|
95
|
+
|
|
96
|
+Imagine trading BTC against ETH (thus, ETH/BTC pair). Therefore, the values for **asset** and **coin** inside config file would be:
|
|
97
|
+
|
|
98
|
+```
|
|
99
|
+asset: "BTC"
|
|
100
|
+coin: "ETH"
|
|
101
|
+```
|
|
102
|
+
|
|
103
|
+Then you decide that a reasonable values for **step** and **spread** are:
|
|
104
|
+
|
|
105
|
+```
|
|
106
|
+step: 0.00002
|
|
107
|
+spread: 2
|
|
108
|
+```
|
|
109
|
+
|
|
110
|
+To visualize, on a chart it would look like that:
|
|
111
|
+
|
|
112
|
+## Usage
|
|
113
|
+
|
86
|
114
|
## Disclaimer
|