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

Commit

Permalink
move supported exchanges to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
askmike committed Jun 26, 2016
1 parent 99fcadf commit 80240db
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 26 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Gekko is a Bitcoin trading bot and backtesting platform that connects to popular
* 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

## Automated Trading platform

Expand All @@ -38,7 +41,27 @@ Gekko has a plugin system that can do certain things whenever something happens

## Supported exchanges

Gekko supports multiple cryptocurreny exchanges, see [here](https://github.com/askmike/gekko/blob/stable/docs/supported_exchanges.md).
| Exchange | Monitoring | [Trading](https://github.com/askmike/gekko/blob/stable/docs/Plugins.md#trader) | [Importing](https://github.com/askmike/gekko/blob/stable/docs/Importing.md) | Notes |
| --------------- |:----------:|:-------:|:---------:|-------|
| [Poloniex](https://poloniex.com/) |||| |
| [Bitstamp](https://bitstamp.com/) |||| |
| [Kraken](https://kraken.com/) |||| |
| [Bitfinex](https://bitfinex.com/) |||| |
| [BTC-e](https://btc-e.com/) |||| |
| [BTCC](https://btcc.com/) |||| (=BTCChina) |
| [Cex.io](https://bitstamp.com/) |||| |
| [bitX](https://www.bitx.co/) |||| |
| [lakeBTC](https://lakebtc.com/) |||| |
| [meXBT](https://mexbt.com/) |||| (see [here](https://github.com/askmike/gekko/issues/288#issuecomment-223810974)) |
| [zaif](https://zaif.jp/trade_btc_jpy) |||| |
| [lakeBTC](https://lakebtc.com/) |||| |
| [bx.in.th](https://bx.in.th/) |||| |

Monitoring means that Gekko is able to watch the realtime market, this automatically means that Gekko is also able to:

- run trading strategies against the data (in semi-realtime)
- simulate trading profits (paper trader)
- store all data (to backtest in the future)

## Installing Gekko

Expand Down Expand Up @@ -78,10 +101,6 @@ If you installed Gekko via git you can easily fetch the latest updates by runnin

## How does Gekko work?

![Gekko 0.1.0 architecture](http://data.wizb.it/misc/gekko-0.1.0-architecture.jpg)

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

- Read about [Gekko's overall architecture](https://github.com/askmike/gekko/tree/stable/docs/internals/architecture.md).
- Read on how to add [a new exchange to Gekko](https://github.com/askmike/gekko/tree/stable/docs/internals/exchanges.md).
- Read on how to [create your own plugin](https://github.com/askmike/gekko/tree/stable/docs/internals/plugins.md).
Expand All @@ -92,7 +111,7 @@ If you want to contribute or are interested in how Gekko works:
* More tests
* More exchanges
* More indicators
* Webbased interface (?)
* Webbased interface ([first step](https://github.com/askmike/gekko/issues/338#issuecomment-228368499))?

## Credits

Expand Down
2 changes: 1 addition & 1 deletion docs/Backtesting.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Besides that, make sure to configure `config.watch`.

## Historical data

Gekko requires historical data to backtest strategies against. The easiest way to get this is to run Gekko on real markets with the plugin sqliteWriter enabled (this will cause Gekko to store realtime data on disk).
Gekko requires historical data to backtest strategies against. The easiest way to get this is to let Gekko import historical data, however this is not supported by a lot of exchanges (see [here](https://github.com/askmike/gekko#supported-exchanges)). The second easiest and most universal way is to run Gekko on real markets with the plugin sqliteWriter enabled (this will cause Gekko to store realtime data on disk).

## Configure

Expand Down
20 changes: 1 addition & 19 deletions docs/supported_exchanges.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
# Supported Exchanges

## Fully working

- [Bitstamp](http://bitstamp.com/)
- [kraken](http://kraken.com/)
- [bitfinex](https://bitfinex.com/)
- [btc-e](https://btc-e.com/)
- [poloniex](https://poloniex.com/)
- [BTCC](https://btcc.com/) (formerly called BTCChina)

## Partially working

*(monitoring, paper trading and backtesting works fine, however real trading might not)*

- [Cex.io](https://cex.io/)
- [bitX](https://www.bitx.co/)
- [lakeBTC](https://lakebtc.com/)
- [meXBT](https://mexbt.com/) (see [here](https://github.com/askmike/gekko/issues/288#issuecomment-223810974))
- [zaif](https://zaif.jp/trade_btc_jpy)
- [bx.in.th](https://bx.in.th/)
TODO.

2 comments on commit 80240db

@valeriominetti
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cexio link is wrong, it should point to https://cex.io and instead it points to bitstamp.

@askmike
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, will fix asap!

Please sign in to comment.