-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
meta.yaml
376 lines (291 loc) · 25.9 KB
/
meta.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
{% set name = "unicorn-binance-trailing-stop-loss" %}
{% set version = "1.1.0" %}
package:
name: {{ name|lower }}
version: {{ version }}
source:
path: .
build:
script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
entry_points:
- ubtsl=unicorn_binance_trailing_stop_loss.cli:main
number: 0
channels:
- lucit
- conda-forge
- default
requirements:
build:
- {{ compiler('c') }}
host:
- python
- lucit::lucit-licensing-python
- lucit::unicorn-binance-rest-api
- lucit::unicorn-binance-websocket-api
- cython
- requests
run:
- python
- lucit::lucit-licensing-python
- lucit::unicorn-binance-rest-api
- lucit::unicorn-binance-websocket-api
- cython
- requests
dependencies:
- anaconda-client
- conda-build
test:
imports:
- unicorn_binance_trailing_stop_loss
commands:
- pip check
requires:
- pip
about:
summary: |
A Python library by LUCIT with a command line interface for a trailing stop loss and smart entry on the Binance exchange.
description: |
[](https://shop.lucit.services)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/releases)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/releases)
[](https://anaconda.org/lucit/unicorn-binance-trailing-stop-loss)
[](https://anaconda.org/lucit/unicorn-binance-trailing-stop-loss)
[](https://pypi.org/project/unicorn-binance-trailing-stop-loss/)
[](https://pepy.tech/project/unicorn-binance-trailing-stop-loss)
[](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/license.html)
[](https://www.python.org/downloads/)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/issues)
[](https://codecov.io/gh/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/actions/workflows/codeql-analysis.yml)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/actions/workflows/unit-tests.yml)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/actions/workflows/build_wheels.yml)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/actions/workflows/build_conda.yml)
[](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/)
[](https://medium.lucit.tech)
[](https://t.me/unicorndevs)
[](https://gitter.im/unicorn-binance-suite/unicorn-binance-trailing-stop-loss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html)
# UNICORN Binance Trailing Stop Loss
[Description](#description) | [Smart Entry](#smart-entry) | [Installation](#installation-and-upgrade) |
[Documentation](#documentation) | [Examples](#examples) | [Change Log](#change-log) | [Wiki](#wiki) | [Social](#social) |
[Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) |
[Contributing](#contributing) | [Disclaimer](#disclaimer) | [Commercial Support](#commercial-support)
A Python library by [LUCIT](https://www.lucit.tech) with a [command line interface](https://www.lucit.tech/ubtsl-cli.html) for a trailing stop loss and
[smart entry](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html#smart-entry) on the Binance exchange.
Please read carefully all provided [documentation](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/), our
[disclaimer](#disclaimer) and look in the
[issues](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/issues) about known
problems before using this tool - ***you use it at your own risk!***
If you put this engine on a market, you should stop trading manually on this market yourself!
Part of '[UNICORN Binance Suite](https://www.lucit.tech/unicorn-binance-suite.html)'.
## Get a UNICORN Binance Suite License
To run modules of the *UNICORN Binance Suite* you need a [valid license](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8#4ca4)!
## How to start the trailing stop loss engine:
```
from unicorn_binance_trailing_stop_loss import BinanceTrailingStopLossManager
def callback_error(msg):
print(f"STOP LOSS ERROR - ENGINE IS SHUTTING DOWN! - {msg}")
ubtsl.stop_manager()
def callback_finished(msg):
print(f"STOP LOSS FINISHED - ENGINE IS SHUTTING DOWN! - {msg}")
ubtsl.stop_manager()
def callback_partially_filled(msg):
print(f"STOP LOSS PARTIALLY_FILLED - ENGINE IS STILL RUNNING! - {msg}")
ubtsl = BinanceTrailingStopLossManager(callback_error=callback_error,
callback_finished=callback_finished,
callback_partially_filled=callback_partially_filled,
binance_public_key="aaa",
binance_private_key="bbb",
borrow_threshold="100%",
exchange="binance.com",
keep_threshold="20%",
market="BTCUSDT",
print_notifications=True,
reset_stop_loss_price=True,
send_to_email_address="[email protected]",
send_from_email_address="[email protected]",
send_from_email_password="pass",
send_from_email_server="mail.example.com",
send_from_email_port=25,
stop_loss_limit="1.5%",
stop_loss_order_type="LIMIT",
stop_loss_price=88,
stop_loss_start_limit="0.5%",
telegram_bot_token="telegram_bot_token",
telegram_send_to="telegram_send_to")
```
## Stop the engine:
```
ubtsl.stop_manager()
```
[Discover more possibilities](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/unicorn_binance_trailing_stop_loss.html).
## Start the engine on the command line (Windows, Linux and Mac):
```
$ ubtsl --profile BTCUSDT_SELL --stoplosslimit 0.5%
```
Read about the [CLI usage](https://www.lucit.tech/ubtsl-cli.html).
## Description
The Python package [UNICORN Binance Trailing Stop Loss](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html)
provides a reuseable library and [CLI interface](https://www.lucit.tech/ubtsl-cli.html).
After starting the engine, a stop/loss order is placed on Binance and trailed until it is completely fulfilled. If desired, a
notification can be sent via email and Telegram afterwards. Then it calls the function
passed with the `callback_finished` parameter or on error it calls the function passed to `callback_error`.
Partially filled orders are currently not handled by the engine. If you want to react individually to this event, you
can use the function provided to `callback_partially_filled`.
In addition, there is a [smart entry](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html#smart-entry) option
called `jump-in-and-trail`. This offers the possibility to buy spot, future and margin assets with a limit or market
order and then to trail a stop/loss order until sold.
### What are the benefits of the UNICORN Binance Trailing Stop Loss?
- Using websockets for push notifications about price updates and order status updates. (Fast data transfer and low
used API weight!)
- [Smart entry](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html#smart-entry)
- Supported exchanges:
| Exchange | Exchange string | trail | jump-in-and-trail |
|----------------------------------------------------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Binance](https://www.binance.com) | `binance.com` |  |  |
| [Binance Testnet](https://testnet.binance.vision/) | `binance.com-testnet` |  |  |
| [Binance Futures](https://www.binance.com) | `binance.com-futures` |  |  |
| [Binance Isolated Margin](https://www.binance.com) | `binance.com-isolated_margin` |  |  (experimental) |
| [Binance Margin](https://www.binance.com) | `binance.com-margin` |  |  |
- All parameters that expect numbers can be configured with fixed numerical values as well as with percentage values.
- Integrated notification system (e-Mail and Telegram).
- Test "notification", "binance-connectivity" and "streams" without starting the engine.
- Powered by [UNICORN Binance REST API](https://www.lucit.tech/unicorn-binance-rest-api.html) and
[UNICORN Binance WebSocket API](https://www.lucit.tech/unicorn-binance-websocket-api.html).
- Well tested on Linux, Mac and Windows.
If you like the project, please [](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/stargazers) it on
[GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss)!
### Smart entry
***This function is still in an experimental phase and only available for Isolated Margin.***
Do a smart entry by using `engine = 'jump-in-and-trail'` and providing `borrow_threshold`.
By activating the `jump-in-and-trail` engine, the engine first buys the predefined asset amount and then trails them
automatically.
## Installation and Upgrade
The module requires Python 3.7 or above, as it depends on Pythons latest asyncio features for asynchronous/concurrent
processing.
For the PyPy interpreter we offer packages only from Python version 3.9 and higher.
Anaconda packages are available from Python version 3.8 and higher.
The current dependencies are listed [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/blob/master/requirements.txt).
If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/wiki/Installation).
### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/)
Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/),
these wheels offer significant advantages for Python developers:
- ***Performance Boost with Cython Wheels:***
Cython is a programming language that supplements Python with static typing and C-level performance. By compiling
Python code into C, Cython Wheels can significantly enhance the execution speed of Python code, especially in
computationally intensive tasks. This means faster runtimes and more efficient processing for users of our package.
- ***PyPy Wheels for Enhanced Efficiency:***
PyPy is an alternative Python interpreter known for its speed and efficiency. It uses Just-In-Time (JIT) compilation,
which can dramatically improve the performance of Python code. Our PyPy Wheels are tailored for compatibility with
PyPy, allowing users to leverage this speed advantage seamlessly.
Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that
you get the optimized version of our package with minimal setup, allowing you to focus on development rather than
configuration.
#### Installation
`pip install unicorn-binance-trailing-stop-loss`
#### Update
`pip install unicorn-binance-trailing-stop-loss --upgrade`
### A Conda Package of the latest version with `conda` from [Anaconda](https://anaconda.org/lucit)
The `unicorn-binance-trailing-stop-loss` package is available with [Conda](https://docs.conda.io/en/latest/) through the
[`lucit` channel](https://anaconda.org/lucit).
For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
[`conda-forge` channel](https://anaconda.org/conda-forge).
#### Installation
```
conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-binance-trailing-stop-loss
```
#### Update
`conda update -c lucit unicorn-binance-trailing-stop-loss`
### From source of the latest release with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss)
#### Linux, macOS, ...
Run in bash:
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`
#### Windows
Use the below command with the version (such as 1.1.0) you determined
[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/releases/latest):
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/archive/1.1.0.tar.gz --upgrade`
### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss)
This is not a release version and can not be considered to be stable!
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/tarball/master --upgrade`
### [Conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html), [Virtualenv](https://virtualenv.pypa.io/en/latest/) or plain [Python](https://www.python.org)
Download the [latest release](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/releases/latest)
or the [current master branch](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/archive/master.zip)
and use:
- ./environment.yml
- ./pyproject.toml
- ./requirements.txt
- ./setup.py
## Change Log
[https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/CHANGELOG.html](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/CHANGELOG.html)
## Documentation
- [General](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech)
- [Modules](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/modules.html)
- [CLI](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/CLI.html)
## Examples
- [example_logging.py](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/blob/master/example_logging.py)
## Howto
- [How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8)
## Project Homepage
[https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html)
## Wiki
[https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/wiki](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/wiki)
## Social
- [Discussions](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/discussions)
- [https://t.me/unicorndevs](https://t.me/unicorndevs)
- [https://dev.binance.vision](https://dev.binance.vision)
- [https://community.binance.org](https://community.binance.org)
## Receive Notifications
To receive notifications on available updates you can
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/watchers)
the repository on [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss), write your
[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/blob/master/example_version_of_this_package.py)
with using
[`is_update_available()`](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/unicorn_binance_trailing_stop_loss.html#unicorn_binance_trailing_stop_loss.manager.BinanceWebSocketApiManager.is_update_availabe)
or you use the
[monitoring API service](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/wiki/UNICORN-Monitoring-API-Service).
Follow us on [LinkedIn](https://www.linkedin.com/company/lucit-systems-and-development),
[X](https://twitter.com/LUCIT_SysDev) or [Facebook](https://www.facebook.com/lucit.systems.and.development)!
To receive news (like inspection windows/maintenance) about the Binance API`s subscribe to their telegram groups:
- [https://t.me/binance_api_announcements](https://t.me/binance_api_announcements)
- [https://t.me/binance_api_english](https://t.me/binance_api_english)
- [https://t.me/Binance_USA](https://t.me/Binance_USA)
- [https://t.me/TRBinanceTR](https://t.me/TRBinanceTR)
- [https://t.me/BinanceExchange](https://t.me/BinanceExchange)
## How to report Bugs or suggest Improvements?
[List of planned features](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) -
click  if you need one of them or suggest a new feature!
Before you report a bug, [try the latest release](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss#installation-and-upgrade). If the issue still exists, provide the error trace, OS
and Python version and explain how to reproduce the error. A demo script is appreciated.
If you dont find an issue related to your topic, please open a new [issue](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/issues)!
[Report a security bug!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/security/policy)
## Contributing
[UNICORN Binance Trailing Stop Loss](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html) is an open
source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To
contribute follow
[this guide](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/blob/master/CONTRIBUTING.md).
### Contributors
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/graphs/contributors)
We  open source!
## Disclaimer
This project is for informational purposes only. You should not construe this information or any other material as
legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation,
endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in
this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such
jurisdiction.
### If you intend to use real money, use it at your own risk!
Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities
of any kind, including but not limited to direct or indirect damages for loss of profits.
## Commercial Support
[](https://www.lucit.tech/get-support.html)
***Do you need a developer, operator or consultant?*** [Contact us](https://www.lucit.tech/contact.html) for a non-binding initial consultation!
dev_url: https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss
doc_url: https://unicorn-binance-trailing-stop-loss.docs.lucit.tech
home: https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html
license: LSOSL
license_file: LICENSE
extra:
recipe-maintainers:
- oliver-zehentleitner