Skip to content

Latest commit

 

History

History
206 lines (170 loc) · 9.41 KB

README.md

File metadata and controls

206 lines (170 loc) · 9.41 KB
Raw

Build Status Software License GoDoc Coverage Status Go Report Card

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.US Yes Yes NA
Binance Yes Yes NA
Bitfinex Yes Yes NA
Bitflyer Yes No NA
Bithumb Yes Yes NA
BitMEX Yes Yes NA
Bitstamp Yes Yes No
BTCMarkets Yes Yes NA
BTSE Yes Yes NA
Bybit Yes Yes NA
CoinbasePro Yes Yes No
COINUT Yes Yes NA
Deribit Yes Yes No
Exmo Yes NA NA
GateIO Yes Yes NA
Gemini Yes Yes No
HitBTC Yes Yes No
Huobi.Pro Yes Yes NA
Kraken Yes Yes NA
Kucoin Yes Yes NA
Lbank Yes No NA
Okx Yes Yes NA
Poloniex Yes Yes NA
Yobit Yes NA 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, Exchange Rates, Fixer.io, OpenExchangeRates, Exchange Rate Host).
  • 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.
  • Recent and historic trade processing. See trades.
  • Backtesting application. An event-driven backtesting tool to test and iterate trading strategies using historical or custom data. See backtester.
  • WebGUI (discontinued).
  • Exchange HTTP mock testing. See mock.
  • Exchange multichain deposits and withdrawals for specific exchanges. See multichain transfer support.

Development Tracking

Our Kanban board provides updates on:

  • New feature development
  • Bug fixes in progress
  • Recently completed work
  • Contribution opportunities

Follow our progress as we continuously improve GoCryptoTrader.

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 master branch.

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/thrasher-corp/gocryptotrader.git
cd gocryptotrader
go build
mkdir ~/.gocryptotrader
cp config_example.json ~/.gocryptotrader/config.json

Windows

git clone https://github.com/thrasher-corp/gocryptotrader.git
cd gocryptotrader
go build
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
  • Make any necessary changes to the config.json file.
  • Run the gocryptotrader binary 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.

Contributor List

A very special thank you to all who have contributed to this program:

User Contribution Amount
thrasher- 700
shazbert 345
dependabot[bot] 317
gloriousCode 234
gbjk 93
dependabot-preview[bot] 88
xtda 47
lrascao 27
Beadko 17
Rots 15
vazha 15
ydm 15
ermalguni 14
MadCozBadd 13
samuael 10
vadimzhukck 10
140am 8
marcofranssen 8
geseq 8
TaltaM 6
cranktakular 6
dackroyd 5
khcchiu 5
yangrq1018 4
woshidama323 3
crackcomm 3
mshogin 2
herenow 2
tk42 2
soxipy 2
andreygrehov 2
azhang 2
bretep 2
Christian-Achilli 2
cornelk 2
gam-phon 2
if1live 2
lozdog245 2
MarkDzulko 2
blombard 1
cavapoo2 1
CodeLingoTeam 1
CodeLingoBot 1
Daanikus 1
daniel-cohen 1
DirectX 1
frankzougc 1
idoall 1
Jimexist 1
lookfirst 1
m1kola 1
mattkanwisher 1
merkeld 1
mKurrels 1
starit 1
zeldrinn 1