Skip to content

Latest commit

 

History

History
167 lines (113 loc) · 8.67 KB

README.md

File metadata and controls

167 lines (113 loc) · 8.67 KB
Raw

Gekko npm Build Status Build status

Gordon Gekko

The most valuable commodity I know of is information.

-Gordon Gekko

Gekko is a Bitcoin trading bot and backtesting platform that connects to popular Bitcoin exchanges. It is written in javascript and runs on nodejs.

Use Gekko at your own risk.

Main features

  • Automated trading (trade bot)
  • Paper trading (for TA strategies)
  • Backtester (for TA strategies)
  • Tool for systematic trading
  • Low level market library
  • Monitor the live market
  • Import historical market data
  • Broadcast market data over pubsub messaging systems

TA strategies

Gekko comes with some basic strategies (which implement a single indicator). But with some basic javascript you can create your own strategies. You can use over 130 indicators to create your perfect prediction model (full list of supported indicators). Why don't you combine Bollinger Bands, CCI and MACD with a STOCHRSI indicator?

Automated Trading platform

Gekko can watch the realtime markets, you can apply automated trading methods to do live or simulated trading (automated trading or paper trading). Gekko stores all market data it sees, this makes it possible to simulate trading strategies against historical data to see whether they would have been profitable (backtesting).

Gekko is not built for HFT or anything related to being the fastest (like arbitrage). The trading methods Gekko can do are based on TA indicators used by human day traders. This means that Gekko does not look at data below the one minute timescale and will not trade more than a couple of times per week (depending on configuration).

So Gekko is not:

  • A trading platform for human day traders with a GUI and charts.
  • A High frequency trading bot designed to operate on < minute resolution.
  • A fully automated trading bot that you turn on and will generate profit without you having to do anything.
  • An exchange.
  • An arbitrage bot.

Supported exchanges

Exchange Monitoring Trading Importing Notes
Poloniex ✓ ✓ ✓
BTCC ✓ ✓ ✓ (=BTCChina)
Bitstamp ✓ ✓ ✗
Kraken ✓ ✓ ✗
Bitfinex ✓ ✓ ✗
BTC-e ✓ ✓ ✗
Okcoin.cn ✓ ✓ ✗ (China, see #352)
Cex.io ✓ ✓ ✗
BTC Markets ✓ ✓ ✗
bitX ✓ ✗ ✗
lakeBTC ✓ ✗ ✗
meXBT ✓ ✗ ✗ see here.
zaif ✓ ✗ ✗
lakeBTC ✓ ✗ ✗
bx.in.th ✓ ✗ ✗

Monitoring means that Gekko is able to watch the realtime market and thus also:

  • Run trading strategies against the data (in semi-realtime)
  • Simulate trading profits (paper trader)
  • Store all data (to backtest in the future)

Installing Gekko

Windows user? Here is a step-by-step guide on how to get Gekko running on Windows.

Gekko runs on nodejs, once you have that installed you can either download all files in a zip or clone the repository via git:

git clone git://github.com/askmike/gekko.git
cd gekko

You need to download Gekko's dependencies, which can easily be done with npm (this came with your nodejs installation):

npm install

Docker user? Installing and running gekko is simple on Docker with the following command:

docker run -d -v /path/to/your/config.js:/usr/src/gekko/config.js --name gekko barnumd/gekko

To see process logs: docker logs --follow gekko. More info can be found here.

Configuring Gekko

Configuring Gekko consists of two parts:

  • Watching a realtime market
  • Enabling plugins

Read the configuring Gekko documentation for a detailed explanation. Don't forget to rename a copy of sample-config.js to config.js.

Running Gekko

node gekko

For backtesting, please see the backtesting documentation.

You can also run Gekko silently or use more complex features, for examples check out the advanced features.

Updating Gekko

If you installed Gekko via git you can easily fetch the latest updates by running:

git pull && npm install

How does Gekko work?

Gekko architecture

TODO

  • Stabilize importing API.
  • More tests
  • Better documentation for TA-lib indicators.
  • More indicators (maybe use this native js lib?)
  • Webbased interface (first step)?

Better exchange support:

  • add GDAX exchange (supports importing)
  • support importing at bitfinex (here).
  • add okcoin China
  • add okcoin
  • add bitmex
  • fix cryptsy integration..

Credits

Final

If Gekko helped you in any way, you can always leave me a tip at (BTC) 13r1jyivitShUiv9FJvjLH7Nh1ZZptumwW

License

The MIT License (MIT)

Copyright (c) 2014 Mike van Rossum [email protected]

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.