mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 15:09:42 +00:00
051675255d
* Add initial workflows config * Add PSQL service * Add 32bit and frontend jobs * Add gcc-multilib and fix typo * Fix backtester test for linux/unix filesystem errors and npm commands * 32-bit Add -race to purposefully throw an error to ensure envs are set correctly (will revert) * Revert "32-bit Add -race to purposefully throw an error to ensure envs are set correctly (will revert)" This reverts commit b97e66c49fca859f8738e01107f96f9ca4040b2e. * Bump workers count for orderbook processing * Remove comments to trigger 32-bit cache hit after job success * Cancel addition plus version bump, spawn more overlords * Update build badge to Github Actions * Brach -> Branch
136 lines
6.2 KiB
Cheetah
136 lines
6.2 KiB
Cheetah
{{define "root" -}}
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
[](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader)
|
|
[](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
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](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk)
|
|
|
|
## 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 | Yes | NA |
|
|
| BTSE | Yes | Yes | NA |
|
|
| CoinbasePro | Yes | Yes | No|
|
|
| Coinbene | Yes | Yes | No |
|
|
| COINUT | Yes | Yes | NA |
|
|
| Exmo | Yes | NA | NA |
|
|
| FTX | Yes | Yes | 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 |
|
|
| LakeBTC | Yes | Yes | NA |
|
|
| Lbank | 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](https://coinmarketcap.com/rankings/exchanges/).
|
|
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](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk).
|
|
|
|
** 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](/database/README.md).
|
|
+ OTP generation tool. See [gen otp](/cmd/gen_otp).
|
|
+ Connection monitor package.
|
|
+ gRPC service and JSON RPC proxy. See [gRPC service](/gctrpc/README.md).
|
|
+ gRPC client. See [gctcli](/cmd/gctcli/README.md).
|
|
+ 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](/docs/OHLCV.md).
|
|
+ Scripting support. See [gctscript](/gctscript/README.md).
|
|
+ Recent and historic trade processing. See [trades](/exchanges/trade/README.md).
|
|
+ Backtesting application. An event-driven backtesting tool to test and iterate trading strategies using historical or custom data. See [backtester](/backtester/README.md).
|
|
+ WebGUI (discontinued).
|
|
|
|
## Planned Features
|
|
|
|
Planned features can be found on our [community Trello page](https://trello.com/b/ZAhMhpOy/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](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
+ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
+ Code must adhere to our [coding style](https://github.com/thrasher-corp/gocryptotrader/blob/master/.github/CONTRIBUTING.md).
|
|
+ Pull requests need to be based on and opened against the `master` branch.
|
|
|
|
## Compiling instructions
|
|
|
|
Download and install Go from [Go Downloads](https://golang.org/dl/) for your
|
|
platform.
|
|
|
|
### Linux/OSX
|
|
|
|
GoCryptoTrader is built using [Go Modules](https://github.com/golang/go/wiki/Modules) and requires Go 1.11 or above
|
|
Using Go Modules you now clone this repository **outside** your GOPATH
|
|
|
|
```bash
|
|
git clone https://github.com/thrasher-corp/gocryptotrader.git
|
|
cd gocryptotrader
|
|
go build
|
|
mkdir ~/.gocryptotrader
|
|
cp config_example.json ~/.gocryptotrader/config.json
|
|
```
|
|
|
|
### Windows
|
|
|
|
```bash
|
|
git clone https://github.com/thrasher-corp/gocryptotrader.git
|
|
cd gocryptotrader
|
|
go build
|
|
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
|
|
```
|
|
|
|
+ Make any neccessary changes to the `config.json` file.
|
|
+ Run the `gocryptotrader` binary file inside your GOPATH bin folder.
|
|
|
|
{{template "donations" .}}
|
|
|
|
## Binaries
|
|
|
|
Binaries will be published once the codebase reaches a stable condition.
|
|
{{template "contributors" .}}
|
|
{{- end}}
|