bbgo_origin/doc/commands/bbgo.md
2022-07-19 09:48:21 +08:00

62 lines
3.3 KiB
Markdown

## bbgo
bbgo is a crypto trading bot
```
bbgo [flags]
```
### Options
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--cpu-profile string cpu profile
--debug debug mode
--dotenv string the dotenv file you want to load (default ".env.local")
--ftx-api-key string ftx api key
--ftx-api-secret string ftx api secret
--ftx-subaccount string subaccount name. Specify it if the credential is for subaccount.
-h, --help help for bbgo
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
--telegram-bot-auth-token string telegram auth token
--telegram-bot-token string telegram bot token from bot father
```
### SEE ALSO
* [bbgo account](bbgo_account.md) - show user account details (ex: balance)
* [bbgo backtest](bbgo_backtest.md) - run backtest with strategies
* [bbgo balances](bbgo_balances.md) - Show user account balances
* [bbgo build](bbgo_build.md) - build cross-platform binary
* [bbgo cancel-order](bbgo_cancel-order.md) - cancel orders
* [bbgo deposits](bbgo_deposits.md) - A testing utility that will query deposition history in last 7 days
* [bbgo execute-order](bbgo_execute-order.md) - execute buy/sell on the balance/position you have on specific symbol
* [bbgo get-order](bbgo_get-order.md) - Get order status
* [bbgo kline](bbgo_kline.md) - connect to the kline market data streaming service of an exchange
* [bbgo list-orders](bbgo_list-orders.md) - list user's open orders in exchange of a specific trading pair
* [bbgo margin](bbgo_margin.md) - margin related history
* [bbgo market](bbgo_market.md) - List the symbols that the are available to be traded in the exchange
* [bbgo optimize](bbgo_optimize.md) - run optimizer
* [bbgo orderbook](bbgo_orderbook.md) - connect to the order book market data streaming service of an exchange
* [bbgo orderupdate](bbgo_orderupdate.md) - Listen to order update events
* [bbgo pnl](bbgo_pnl.md) - Average Cost Based PnL Calculator
* [bbgo run](bbgo_run.md) - run strategies from config file
* [bbgo submit-order](bbgo_submit-order.md) - place order to the exchange
* [bbgo sync](bbgo_sync.md) - sync trades and orders history
* [bbgo trades](bbgo_trades.md) - Query trading history
* [bbgo tradeupdate](bbgo_tradeupdate.md) - Listen to trade update events
* [bbgo transfer-history](bbgo_transfer-history.md) - show transfer history
* [bbgo userdatastream](bbgo_userdatastream.md) - Listen to session events (orderUpdate, tradeUpdate, balanceUpdate, balanceSnapshot)
* [bbgo version](bbgo_version.md) - show version name
###### Auto generated by spf13/cobra on 19-Jul-2022