lychiyu/bbgo_origin
1
0
Fork 0
mirror of https://github.com/c9s/bbgo.git synced 2024-11-21 22:43:52 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

add env vars doc

Browse Source
This commit is contained in:
c9s 2022-01-26 23:56:16 +08:00
parent 59cc4d7243
commit 98170b2d8e
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -121,6 +121,9 @@ KUCOIN_API_KEY_VERSION=2
Prepare your dotenv file `.env.local` and BBGO yaml config file `bbgo.yaml`.
To check the available environment variables, please see [Environment Variables](./doc/configuration/envvars.md)
The minimal bbgo.yaml could be generated by:
```sh

18
doc/configuration/envvars.md Normal file
View File

@ -0,0 +1,18 @@
# Environment Variables
## MAX Exchange
```shell
# MAX_QUERY_CLOSED_ORDERS_NUM_OF_PAGES=[number of pages]
# The MAX Exchange API does not support time-range based query for the closed orders
# We can only sync the closed orders by page number, here is the maximum pages you want to sync
MAX_QUERY_CLOSED_ORDERS_NUM_OF_PAGES=10
# MAX_QUERY_CLOSED_ORDERS_ALL=[1 or 0]
# The MAX Exchange API does not support time-range based query for the closed orders
# If you want to sync all the orders, you must start from the first page
# To enable this mode, set this variable to 1
MAX_QUERY_CLOSED_ORDERS_ALL=1
```