doc: grid strategy

This commit is contained in:
Andy Cheng 2021-12-27 18:42:42 +08:00
parent 62253d8d4e
commit 7099f72cc2
No known key found for this signature in database
GPG Key ID: 936427CF651A9D28
2 changed files with 33 additions and 1 deletions

View File

@ -233,7 +233,8 @@ Check out the strategy directory [strategy](pkg/strategy) for all built-in strat
order [buyandhold](pkg/strategy/pricedrop)
- `bollgrid` strategy implements a basic grid strategy with the built-in bollinger
indicator [bollgrid](pkg/strategy/bollgrid)
- `grid` strategy implements the fixed price band grid strategy [grid](pkg/strategy/grid)
- `grid` strategy implements the fixed price band grid strategy [grid](pkg/strategy/grid). See
[document](./doc/strategy/grid.md).
- `support` strategy implements the fixed price band grid strategy [support](pkg/strategy/support). See
[document](./doc/strategy/support.md).
- `flashcrash` strategy implements a strategy that catches the flashcrash [flashcrash](pkg/strategy/flashcrash)

31
doc/strategy/grid.md Normal file
View File

@ -0,0 +1,31 @@
### Grid Strategy
This strategy places buy and sell orders within the specified price range. The gap between orders are equal, thus they
form `grids`. The price gap is calculated from price range and the number of grids.
#### Parameters
- `symbol`
- The trading pair symbol, e.g., `BTCUSDT`, `ETHUSDT`
- `quantity`
- Quantity per order
- `gridNumber`
- Number of grids, which is the maximum numbers of orders minus one.
- `profitSpread`
- The arbitrage profit amount of a set of buy and sell orders. In other words, the profit you want to add to your
sell order when your buy order is executed.
- `upperPrice`
- The upper bond price
- `lowerPrice`
- The lower bond price
- `long`
- If true, the sell order is submitted in the same order amount as the filled corresponding buy order, rather than
the same quantity, which means the arbitrage profit is accumulated in the base asset rather than the quote asset.
- `catchUp`
- If true, BBGO will try to submit orders for missing grids.
#### Examples
See [grid.yaml](../../config/grid.yaml)