# Packages
# README
A cryptocurrency trading bot supporting multiple exchanges written in Golang.
Please note that this bot is under development and is not ready for production!
Community
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Exchange Support Table
| Exchange | REST API | Streaming API | FIX API |
|---|---|---|---|
| Alphapoint | Yes | Yes | NA |
| Binance | Yes | Yes | NA |
| Bitfinex | Yes | Yes | NA |
| Bitflyer | Yes | No | NA |
| Bithumb | Yes | NA | NA |
| BitMEX | Yes | Yes | NA |
| Bitstamp | Yes | Yes | No |
| Bittrex | Yes | No | NA |
| BTCMarkets | Yes | No | NA |
| BTSE | Yes | Yes | NA |
| COINUT | Yes | Yes | NA |
| Exmo | Yes | NA | NA |
| FTX | Yes | Yes | No |
| CoinbasePro | Yes | Yes | No |
| Coinbene | Yes | No | No |
| GateIO | Yes | Yes | NA |
| Gemini | Yes | Yes | No |
| HitBTC | Yes | Yes | No |
| Huobi.Pro | Yes | Yes | NA |
| ItBit | Yes | NA | No |
| Kraken | Yes | Yes | NA |
| Lbank | Yes | No | NA |
| LakeBTC | Yes | No | NA |
| LocalBitcoins | Yes | NA | NA |
| OKCoin International | Yes | Yes | No |
| OKEX | Yes | Yes | No |
| Poloniex | Yes | Yes | NA |
| Yobit | Yes | NA | NA |
| ZB.COM | Yes | Yes | NA |
We are aiming to support the top 30 exchanges sorted by average liquidity as ranked by CoinMarketCap. However, we welcome pull requests for any exchange which does not match this criterion. If you need help with this, please join us on Slack.
** NA means not applicable as the exchange does not support the feature.
Current Features
- Support for all exchange fiat and digital currencies, with the ability to individually toggle them on/off.
- AES256 encrypted config file.
- REST API support for all exchanges.
- Websocket support for applicable exchanges.
- Ability to turn off/on certain exchanges.
- Communication packages (Slack, SMS via SMSGlobal, Telegram and SMTP).
- HTTP rate limiter package.
- Unified API for exchange usage.
- Customisation of HTTP client features including setting a proxy, user agent and adjusting transport settings.
- NTP client package.
- Database support (Postgres and SQLite3). See database.
- OTP generation tool. See gen otp.
- Connection monitor package.
- gRPC service and JSON RPC proxy. See gRPC service.
- gRPC client. See gctcli.
- Forex currency converter packages (CurrencyConverterAPI, CurrencyLayer, Fixer.io, OpenExchangeRates).
- Packages for handling currency pairs, tickers and orderbooks.
- Portfolio management tool; fetches balances from supported exchanges and allows for custom address tracking.
- Basic event trigger system.
- OHLCV/Candle retrieval support. See OHLCV.
- Scripting support. See gctscript.
- WebGUI (discontinued).
Planned Features
Planned features can be found on our community Trello page.
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
masterbranch.
Compiling instructions
Download and install Go from Go Downloads for your platform.
Linux/OSX
GoCryptoTrader is built using Go Modules and requires Go 1.11 or above Using Go Modules you now clone this repository outside your GOPATH
git clone https://github.com/yurulab/gocryptotrader.git
cd gocryptotrader
go build
mkdir ~/.gocryptotrader
cp config_example.json ~/.gocryptotrader/config.json
Windows
git clone https://github.com/yurulab/gocryptotrader.git
cd gocryptotrader
go build
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
- Make any neccessary changes to the
config.jsonfile. - Run the
gocryptotraderbinary file inside your GOPATH bin folder.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
Binaries
Binaries will be published once the codebase reaches a stable condition.