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

Latest commit

 

History

History
87 lines (57 loc) · 4.41 KB

README.md

File metadata and controls

87 lines (57 loc) · 4.41 KB
Raw

WARNING: project is no longer actively maintained, make sure to update any dependencies if you plan on using this in your project.

zenbot logo

“To follow the path, look to the master, follow the master, walk with the master, see through the master, become the master.” – Zen Proverb

Zenbot Build/Test Status

Description

Zenbot is a command-line cryptocurrency trading bot using Node.js and MongoDB. It features:

  • Fully-automated technical-analysis-based trading approach
  • Full support for Binance, Bitfinex, Bitstamp, Bittrex, CEX.IO, GDAX, Gemini, HitBTC, Kraken, Poloniexand TheRockTrading, work on further exchange support is ongoing.
  • Plugin architecture for implementing exchange support, or writing new strategies
  • Simulator for backtesting strategies against historical data
  • "Paper" trading mode, operates on a simulated balance while watching the live market
  • Configurable sell stops, buy stops, and (trailing) profit stops
  • Flexible sampling period and trade frequency - averages 1-2 trades/day with 1h period, 15-50/day with 5m period

Disclaimer

  • Zenbot is NOT a sure-fire profit machine. Use it AT YOUR OWN RISK.
  • Crypto-currency is still an experiment, and therefore so is Zenbot. Meaning, both may fail at any time.
  • Running a bot, and trading in general requires careful study of the risks and parameters involved. A wrong setting can cause you a major loss.
  • Never leave the bot un-monitored for long periods of time. Zenbot doesn't know when to stop, so be prepared to stop it if too much loss occurs.
  • Often times the default trade parameters will underperform vs. a buy-hold strategy, so run some simulations and find the optimal parameters for your chosen exchange/pair before going "all-in".

Documentation

The extensive documentation is located at the docs-folder.

Questions

First have a look at the docs and there are also FAQs which may answer your questions. If not, please ask (programming) questions related to Zenbot on Reddit (subreddit zenbot).

Community

Join the Zenbot community on Reddit!

Donate

P.S., some have asked for how to donate to Zenbot development. We accept donations at Bitcoin addresses below:

carlos8f's BTC (original Zenbot author)

187rmNSkSvehgcKpBunre6a5wA5hQQop6W

DeviaVir's BTC (current maintainer)

3A5g4GQ2vmjNcnEschCweJJB4umzu66sdY

zenbot logo

Thanks!

Noteworthy forks

License: MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.