Skip to content

Commit

Permalink
add env vars doc
Browse files Browse the repository at this point in the history
  • Loading branch information
c9s committed Jan 26, 2022
1 parent 59cc4d7 commit 98170b2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 18 additions & 0 deletions doc/configuration/envvars.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 98170b2

Please sign in to comment.