Skip to content

Commit ba14162

Browse files
committed
Working on docks
1 parent 7220c52 commit ba14162

File tree

4 files changed

+30
-13
lines changed

4 files changed

+30
-13
lines changed

Docs/FLOW.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ such as balance change, order creation or cancellation. It also uses REST API to
2121
about exchange rules and limits and other functionality like placing orders.
2222

2323
In general, the trade flow comprised of up to 3 execution strategies:
24-
1. Entry
25-
2. Exit
26-
3. Stop Loss
24+
1. Entry
25+
2. Exit
26+
3. Stop Loss
2727

2828
Each strategy is optional. Each strategy has a target which is essentially price and volume and additional configuration
2929
parameters.

Docs/SETUP.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ and `-e "SECRET=BINANCE_API_SECRET"`
2424
## Running bot on Mac
2525
1. Pull the image `docker pull iilunin/crypto-bot:stable`.
2626
2. Create the folder for active and completed trades:
27-
- `mkdir Active`
28-
- `mkdir Completed`
27+
- `mkdir Active` - where you will put all new trades
28+
- `mkdir Completed` - where bot will put completed trades
2929
3. If you store your API keys in `api.json` file then you need to create another
3030
folder `mkdir Config` and copy `api.json` there.
3131
4. Run the Bot. You will also need to specify timezone in the `TZ` parameter.
@@ -42,6 +42,9 @@ docker run -d --rm --name cryptobot \
4242
iilunin/crypto-bot:stable
4343
```
4444

45+
Once the bot is started, you can place your trade files into the `Active` directory, so they picked up by the bot.
46+
If by the start time `Active` directory has trade files they will be picked up as well.
47+
4548
To stop the bot run `docker stop cryptobot`
4649

4750
### Known Issues

Docs/TRADE_FILE.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Trade File Structure
2+
Trade file is a simple JSON document describing different trade parameters and used by bot to store some additional trading
3+
states.
4+
5+
Here is the example of the trade document
6+

README.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
11
# Cryptobot
22

33
The main purpose of the bot is to keep track of your Binance trades while you're away.
4-
This bot is not supposed to earn money by itself, it requires targets and stop-loss inputs.
4+
This bot is not supposed to earn money by itself, it requires targets and stop-loss inputs to follow your trades.
55

6-
This project is based on [sammchardy/python-binance](https://github.com/sammchardy/python-binance)
7-
Binance API wrapper
6+
Binance REST API is based on [sammchardy/python-binance](https://github.com/sammchardy/python-binance) project
7+
8+
**Please read carefully all provided documentation before using the bot**
9+
10+
## Disclaimer
11+
- **Use it at your own risk.**
12+
- It is not a commercial project, immediate response and or fixes are not guaranteed.
13+
- This project was developed to improve my personal experience with Binance trading,
14+
I am not taking any responsibility for the outcomes you get when using it.
15+
- Works on Mac and Amazon Linux. Other platforms were not verified.
816

9-
**Use at your own risk**
1017

1118
## Features
1219
- Manage an unlimited number of trading pairs
13-
- Supports smart trade entry, though I often buy coins myself.
20+
- Supports "smart" trade entry
1421
- Unlimited exit targets
1522
- Each exit target can be "smart" to gain max profits
16-
- Flexible stop loss settings: Fixed/Trialing + Custom SL after each target reached.
17-
- OCO
23+
- Flexible stop loss settings: Fixed/Trialing + Custom SL after each target reached
24+
- One Cancels the Other functionality (OCO)
1825
- FREE :)
1926

2027
## Limitations
21-
- Can't have multiple trades of for one trading pair
28+
- Can't have multiple trades for one trading pair
29+
- If you place orders manually, there is a chance they will be canceled by bot
2230

2331
## Installation
2432
[Setup Instructions](./Docs/SETUP.md)

0 commit comments

Comments
 (0)