The modern cryptocurrency trading bot framework written in Go.
Go to file
Yo-An Lin 9f416579ec Merge pull request #25 from c9s/feature/go-compile-os-arch
feature: support go build with custom os and arch
2020-10-24 17:45:03 +08:00
cmd/bbgo compile local strategies into the wrapper binary 2020-10-24 15:38:13 +08:00
config compile local strategies into the wrapper binary 2020-10-24 15:38:13 +08:00
examples move cmdutil package 2020-10-21 15:58:58 +08:00
migrations add migration files 2020-10-05 17:51:01 +08:00
pkg Merge pull request #25 from c9s/feature/go-compile-os-arch 2020-10-24 17:45:03 +08:00
strategies/buyandhold move Cmd to the strategy package 2020-10-16 10:09:42 +08:00
.gitignore update git ignore list 2020-10-24 15:38:36 +08:00
.travis.yml travis: adjust test command 2020-10-12 22:46:40 +08:00
go.mod integrate AverageCostPnLReporter 2020-10-22 15:57:50 +08:00
go.sum integrate AverageCostPnLReporter 2020-10-22 15:57:50 +08:00
LICENSE Create LICENSE 2020-10-08 22:20:59 +08:00
README.md Update README.md 2020-10-22 11:16:28 +08:00

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

Build Status

Aim to release v1.0 before 11/14

Features

  • Exchange abstraction interface
  • Stream integration (user data websocket)
  • PnL calculation.
  • Slack notification

Supported Exchanges

  • MAX Exchange (located in Taiwan)
  • Binance Exchange

Installation

Install the builtin commands:

go get -u github.com/c9s/bbgo/cmd/bbgo

Add your dotenv file:

SLACK_TOKEN=

BINANCE_API_KEY=
BINANCE_API_SECRET=

MAX_API_KEY=
MAX_API_SECRET=

MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USERNAME=root
MYSQL_PASSWORD=
MYSQL_DATABASE=bbgo
MYSQL_URL=root@tcp(127.0.0.1:3306)/bbgo

You can get your API key and secret after you register the accounts:

Then run the migrate command to initialize your database:

dotenv -f .env.local -- bbgo migrate up

There are some other commands you can run:

dotenv -f .env.local -- bbgo migrate status
dotenv -f .env.local -- bbgo migrate redo

(It internally uses goose to run these migration files, see migrations)

To query transfer history:

dotenv -f .env.local -- bbgo transfer-history --exchange max --asset USDT --since "2019-01-01"

To calculate pnl:

dotenv -f .env.local -- bbgo pnl --exchange binance --asset BTC --since "2019-01-01"

Exchange API Examples

Please check out the example directory: examples

Initialize MAX API:

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):

stream := max.NewStream(key, secret)
stream.Subscribe(types.BookChannel, symbol, types.SubscribeOptions{})

streambook := types.NewStreamBook(symbol)
streambook.BindStream(stream)

Strategies

Please check out the directory: strategies

New API Design

still under construction

package main

import (
    "github.com/c9s/bbgo"
)

func main() {
    mysqlURL := viper.GetString("mysql-url")
    mysqlURL = fmt.Sprintf("%s?parseTime=true", mysqlURL)
    db, err := sqlx.Connect("mysql", mysqlURL)
    if err != nil {
        return err
    }

    environment := bbgo.NewEnvironment(db)
    environment.AddExchange("binance", binance.New(viper.Getenv("binance-api-key"), viper.Getenv("binance-api-secret"))))
    environment.AddExchange("max", max.New(viper.Getenv("max-key"), viper.Getenv("max-secret"))))

    trader := bbgo.NewTrader(bbgo.Config{
        Environment: environment,
        DB: db,
    })

    trader.AddNotifier(slacknotifier.New(slackToken))
    trader.AddLogHook(slacklog.NewLogHook(slackToken))

    // when any trade execution happened
    trader.OnTrade(func(session string, exchange types.Exchange, trade types.Trade) {
        notify(trade)
        notifyPnL()
    })

    // mount strategy on an exchange
    trader.AddExchangeStrategy("binance",
        bondtrade.New("btcusdt", "5m"),
        bondtrade.New("ethusdt", "5m"))

    // mount cross exchange strategy
    trader.AddCrossExchangeStrategy(hedgemaker.New("max", "binance"))

    t.Run(ctx)
}

Support

By contributing pull requests

Any pull request is welcome, documentation, format fixing, testing, features.

By registering account with referral ID

You may register your exchange account with my referral ID to support this project.

By small amount cryptos

  • BTC address 3J6XQJNWT56amqz9Hz2BEVQ7W4aNmb5kiU
  • USDT ERC20 address 0x63E5805e027548A384c57E20141f6778591Bac6F

License

MIT License