From 98170b2d8e34fa0f05f43f31848d5a5e2694e6ff Mon Sep 17 00:00:00 2001 From: c9s Date: Wed, 26 Jan 2022 23:56:16 +0800 Subject: [PATCH] add env vars doc --- README.md | 3 +++ doc/configuration/envvars.md | 18 ++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 doc/configuration/envvars.md diff --git a/README.md b/README.md index 0ca430615c..8b3eb6e556 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/configuration/envvars.md b/doc/configuration/envvars.md new file mode 100644 index 0000000000..40579c4748 --- /dev/null +++ b/doc/configuration/envvars.md @@ -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 +``` +