Skip to content

kuzetsa/gekko

 
 

Repository files navigation

Gekko (origin of the name)

1987 movie "Wall Street"

The most valuable commodity I know of is information. -- Gordon Gekko

Gekko (this tool / bot)

This tool is based on REST APIs, and is written the node.js dialect of javascript, which itself based on v8, Google's open source JavaScript engine.

 
 

**WARNING:** *Use Gekko at you own risk.*

Automated reinvestment

Gekko comes with a few technical analysis (TA) methods which implement a single indicator (DEMA, MACD, RSI, and PPO). The parameters of these indicators are all configurable and changing them changes the outcome drastically. Gekko's interface allows you to add your own trading methods. Read more about that in the documentation.

Note: much of this information is outdated, and/or not relevant to reinvestment-only mode.

Supported exchanges

Gekko reinvests cloud mining income on the following platforms:

  • CEX.io (Currently only BTC, planned support for NMC reinvestment.)

Plugin interface

Gekko also has a plugin system that can do certain things whenever something happens or let Gekko communicate through more platforms. Gekko implements the following example plugins:

  • Campfire: Enables Gekko to talk on Campfire and report latest market data and advice.
  • IRC bot: Enables Gekko to talk on IRC and report latest market data and advice.
  • Mailer: Automatically sends email when your trading method has new advice.
  • Profit Simulator (paper trader): Hold a fake portfolio and simulate trades based on advice.
  • Redis Beacon: Broadcast events propagating through Gekko on Redis pub/sub.

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/kuzetsa/gekko.git
    cd gekko

You need to download Gekko's dependencies, which can easily be done with npm:

    npm install

Configuring Gekko / before you start

Read the configuring Gekko documentation for a detailed explanation.

Running Gekko

To run the bot you just have to start Gekko:

    node gekko

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

Updating Gekko

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

    git pull
    npm update

How does Gekko work?

If you want to contribute or are interested in how Gekko works:

Credits

  • The title is inspired by Bateman.
  • This project is inspired by the GoxTradingBot Chrome plugin (though no code is taken from it).
  • Original implementation of gekko was written by Mike van Rossum
  • After 2014, June 25th, reinvestment-only fork maintained by Sarah White AKA kuzetsa
  • Credits for the reduced-lag EMA methods go to Patrick G. Mulloy for publishing
    "Smoothing Data With Less Lag" in 1994

License

(Legal rights and restrictions to copy and use this code)

Copyright (c) 2013-2014 Sarah White (AKA kuzetsa, forked 2014 June 25th)

This file is part of gekko.

gekko is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

gekko is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with gekko.  If not, see <http://www.gnu.org/licenses/>.

I, Sarah White (kuzetsa) have personally opted to use the "sublicensing" right under the permissive MIT license to sublicense my own work. All of my own code and documentation commits in this project are under the AGPLv3 license

The MIT License (MIT)

Copyright (c) 2014 Mike van Rossum mike@mvr.me (original author, initial code in gekkobot)

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.

About

A GHS reinvestment bot written in node.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.7%
  • Shell 0.3%