bbgo_origin/doc/commands/bbgo_orderbook.md
2022-05-05 09:04:04 +08:00

46 lines
1.8 KiB
Markdown

## bbgo orderbook
connect to the order book market data streaming service of an exchange
```
bbgo orderbook --session=[exchange_name] --symbol=[pair_name] [flags]
```
### Options
```
--dump-update dump the depth update
-h, --help help for orderbook
--session string session name
--symbol string the trading pair. e.g, BTCUSDT, LTCUSDT...
```
### Options inherited from parent commands
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--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.
--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](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022