mirror of
https://github.com/c9s/bbgo.git
synced 2024-11-25 08:15:15 +00:00
109 lines
2.5 KiB
Markdown
109 lines
2.5 KiB
Markdown
# bbgo
|
|
|
|
A trading bot framework written in Go. The name bbgo comes from the BB8 bot in the Star Wars movie. aka Buy BitCoin Go!
|
|
|
|
## Current Status
|
|
|
|
_Working hard in progress_
|
|
|
|
[](https://travis-ci.org/c9s/bbgo)
|
|
|
|
Aim to release v1.0 before 11/14
|
|
|
|
## Features
|
|
|
|
- Exchange abstraction interface
|
|
- Stream integration (user data websocket)
|
|
- PnL calculation.
|
|
|
|
## Supported Exchanges
|
|
|
|
- MAX Exchange (located in Taiwan)
|
|
- Binance Exchange
|
|
|
|
## Installation
|
|
|
|
Install the builtin commands:
|
|
|
|
```sh
|
|
go get -u github.com/c9s/bbgo/cmd/bbgo
|
|
```
|
|
|
|
## Examples
|
|
|
|
Please check out the example directory: [examples](examples)
|
|
|
|
|
|
Initialize MAX API:
|
|
|
|
```go
|
|
key := os.Getenv("MAX_API_KEY")
|
|
secret := os.Getenv("MAX_API_SECRET")
|
|
|
|
maxRest := maxapi.NewRestClient(maxapi.ProductionAPIURL)
|
|
maxRest.Auth(key, secret)
|
|
```
|
|
|
|
Creating user data stream to get the orderbook (depth):
|
|
|
|
```go
|
|
stream := max.NewStream(key, secret)
|
|
stream.Subscribe(types.BookChannel, symbol, types.SubscribeOptions{})
|
|
|
|
streambook := types.NewStreamBook(symbol)
|
|
streambook.BindStream(stream)
|
|
```
|
|
|
|
## New Trading Bot API design
|
|
|
|
_**still under construction**_
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/c9s/bbgo"
|
|
)
|
|
|
|
mysqlURL := viper.GetString("mysql-url")
|
|
mysqlURL = fmt.Sprintf("%s?parseTime=true", mysqlURL)
|
|
db, err := sqlx.Connect("mysql", mysqlURL)
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
t := bbgo.New(bbgo.Config{
|
|
DB: db,
|
|
})
|
|
t.AddNotifier(slacknotifier.New(slackToken))
|
|
t.AddLogHook(slacklog.NewLogHook(slackToken))
|
|
|
|
t.AddExchange("binance", binance.New(viper.Getenv("binance-api-key"), viper.Getenv("binance-api-secret")))).
|
|
Subscribe("binance", "btcusdt", "kline@5m", "book", "trade").
|
|
AddStrategy(bondtrade.New, bondtrade.New).
|
|
Symbols("btcusdt", "bnbusdt")
|
|
|
|
t.AddExchange("max", max.New(viper.Getenv("max-key"), viper.Getenv("max-secret")))).
|
|
Subscribe("max", "btctwd", "kline@5m", "book", "trade").
|
|
AddStrategy(flashdrop.New, bondtrade.New)
|
|
|
|
t.AddCrossExchangeStrategy(hedgemaker.New(...))
|
|
```
|
|
|
|
## Support
|
|
|
|
You may register your exchange account with my referral ID to support this project.
|
|
|
|
- For MAX Exchange: <https://max.maicoin.com/signup?r=c7982718> (default commission rate to your account)
|
|
- For Binance Exchange: <https://www.binancezh.com/en/register?ref=VGDGLT80> (5% commission back to your account)
|
|
|
|
Or support this project by cryptocurrency:
|
|
|
|
- BTC omni `3J6XQJNWT56amqz9Hz2BEVQ7W4aNmb5kiU`
|
|
- USDT erc20 `0x63E5805e027548A384c57E20141f6778591Bac6F`
|
|
|
|
## License
|
|
|
|
MIT License
|