跳到主要内容

配置文件说明

配置文件是Open Quant系统的核心配置，它定义了系统的运行环境、策略文件路径、交易所连接等信息。本文档将详细介绍配置文件的格式和选项。

配置文件格式​

配置文件使用TOML格式，文件扩展名为.toml。以下是一个完整的配置示例：

strategy_path = "strategy.py"
strategy_config_path = "strategy.toml"

# [log]
# # file: 文件路径，如果填入文件名，则写入文件
# file = "logs/depth_imbalance"
# # level: 日志级别 支持 trace, debug, info, warn, error
# level = "trace"
# 日志限频 interval设置为0则不限制
# max_tokens：令牌桶最大容量，同时决定初始令牌数
# interval：令牌桶令牌生成速率 单位：秒
# rate_limit = {max_tokens = 50, interval = 1}

# [execution_engine]
# # 执行引擎任务数量
# task_count = 500
# # 执行引擎类型 支持 Stand
# typ = "Stand"

[[exchanges]]
exchange = "BinanceSwap"
is_colo = false
is_testnet = false
is_unified = false
key = ""
passphrase = ""
rebate_rate = 0
secret = ""

[[exchanges]]
exchange = "BitgetSwap"
is_colo = false
is_testnet = false
is_unified = false
key = ""
passphrase = ""
rebate_rate = 0
secret = ""
params = {cookie = "",code = ""}

配置项说明​

启动配置​

【必填】 strategy_path​

  • 描述：策略脚本路径，必填
  • 示例：strategy_path = "strategy.py"

【必填】 strategy_config_path​

  • 描述：策略配置文件路径，必填
  • 示例：strategy_config_path = "strategy.toml"

日志配置 [log]​

日志文件路径 file​

  • 描述：日志文件存储路径
  • 说明：如果仅填入文件名，则写入该文件
  • 示例：file = "logs/depth_imbalance"

日志级别 level​

  • 描述：控制日志输出的详细程度
  • 支持的值：
    • trace：最详细的日志级别
    • debug：调试信息
    • info：普通信息
    • warn：警告信息
    • error：错误信息
  • 默认值："info"

日志限频 rate_limit​

  • 描述：控制日志输出的频率，详情见日志限频功能使用
  • 参数：
    • max_tokens：令牌桶最大容量，决定初始令牌数
    • interval：令牌生成速率（单位：秒）
  • 特殊说明：interval 设置为 0 则不限制日志输出
  • 示例：rate_limit = {max_tokens = 50, interval = 1}

执行引擎配置 [execution_engine]​

任务数量 task_count​

  • 描述：执行引擎可处理的最大任务数量
  • 默认值：500

引擎类型 typ​

  • 描述：执行引擎的类型
  • 支持的值："Stand"（标准执行引擎）

CEX 交易所配置 [[exchanges]]​

  • 描述：配置与特定 CEX 交易所相关的参数。可以填多个
  • 包含字段：
    • exchange: 交易所名称，支持的交易所见：Exchange
    • key: API Key
    • secret: API Secret
    • passphrase: API Passphrase
    • is_colo: 是否为同机房服务器，默认为false
    • is_testnet: 是否为测试网，默认为false
    • is_unified: 是否为统一账户，默认为false
    • rebate_rate: 返佣率，默认为0
    • host: 自定义交易所主机地址，一般置为None使用默认的域名，需要使用自定义域名时则会覆盖
    • ws_host: 自定义交易所websocket主机地址，同上
    • ws_api_host: 自定义交易所websocket api主机地址，同上
    • use_ws_api: 是否使用ws api，使用websocket api下单，默认BinanceSpot、OkxSwap、OkxSpot、OkxMargin为true，BinanceSwap、GateSwap、GateSpot为false，其他交易所不支持
    • params:用于指定非标参数，
      • 如{aws=true}，表示使用aws所在的URL
      • 如cookie，表示网页cookie，BitgetSwap、CoinexSwap支持
      • 如code，一般配合 cookie 使用，BitgetSwap、CoinexSwap支持
      • 如org_id，表示机构ID，BitgetSwap、CoinexSwap支持
      • 如discount，表示原生币折扣信息
  • 示例： 
    [[exchanges]]
    exchange = "BinanceSwap"
    is_colo = false
    is_testnet = false
    is_unified = false
    key = ""
    passphrase = ""
    rebate_rate = 0
    secret = ""
    host = ""
    parmas = {}