add secret_key config

Author: tigersk

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='tigeropen',
-    version='1.4.0',
+    version='1.4.1',
     description='TigerBrokers Open API',
     packages=find_packages(exclude=[]),
     author='TigerBrokers',

tigeropen/common/util/order_utils.py

@@ -8,7 +8,7 @@
 from tigeropen.common.consts import OrderStatus
 
 
-def market_order(account, contract, action, quantity, user_id=None):
+def market_order(account, contract, action, quantity, secret_key=None):
     """
     市价单
     :param account:
@@ -17,10 +17,10 @@ def market_order(account, contract, action, quantity, user_id=None):
     :param quantity:
     :return:
     """
-    return Order(account, contract, action, 'MKT', quantity, user_id=user_id)
+    return Order(account, contract, action, 'MKT', quantity, secret_key=secret_key)
 
 
-def limit_order(account, contract, action, quantity, limit_price, user_id=None):
+def limit_order(account, contract, action, quantity, limit_price, secret_key=None):
     """
     限价单
     :param account:
@@ -30,10 +30,10 @@ def limit_order(account, contract, action, quantity, limit_price, user_id=None):
     :param limit_price: 限价的价格
     :return:
     """
-    return Order(account, contract, action, 'LMT', quantity, limit_price=limit_price, user_id=user_id)
+    return Order(account, contract, action, 'LMT', quantity, limit_price=limit_price, secret_key=secret_key)
 
 
-def stop_order(account, contract, action, quantity, aux_price, user_id=None):
+def stop_order(account, contract, action, quantity, aux_price, secret_key=None):
     """
     止损单
     :param account:
@@ -43,10 +43,10 @@ def stop_order(account, contract, action, quantity, aux_price, user_id=None):
     :param aux_price: 触发止损单的价格
     :return:
     """
-    return Order(account, contract, action, 'STP', quantity, aux_price=aux_price, user_id=user_id)
+    return Order(account, contract, action, 'STP', quantity, aux_price=aux_price, secret_key=secret_key)
 
 
-def stop_limit_order(account, contract, action, quantity, limit_price, aux_price, user_id=None):
+def stop_limit_order(account, contract, action, quantity, limit_price, aux_price, secret_key=None):
     """
     限价止损单
     :param account:
@@ -58,10 +58,10 @@ def stop_limit_order(account, contract, action, quantity, limit_price, aux_price
     :return:
     """
     return Order(account, contract, action, 'STP_LMT', quantity, limit_price=limit_price, aux_price=aux_price,
-                 user_id=user_id)
+                 secret_key=secret_key)
 
 
-def trail_order(account, contract, action, quantity, trailing_percent=None, aux_price=None, user_id=None):
+def trail_order(account, contract, action, quantity, trailing_percent=None, aux_price=None, secret_key=None):
     """
     移动止损单
     :param account:
@@ -73,7 +73,7 @@ def trail_order(account, contract, action, quantity, trailing_percent=None, aux_
     :return:
     """
     return Order(account, contract, action, 'TRAIL', quantity, trailing_percent=trailing_percent, aux_price=aux_price,
-                 user_id=user_id)
+                 secret_key=secret_key)
 
 
 def order_leg(leg_type, price, time_in_force='DAY', outside_rth=None):
@@ -87,7 +87,7 @@ def order_leg(leg_type, price, time_in_force='DAY', outside_rth=None):
     return OrderLeg(leg_type=leg_type, price=price, time_in_force=time_in_force, outside_rth=outside_rth)
 
 
-def limit_order_with_legs(account, contract, action, quantity, limit_price, order_legs=None, user_id=None):
+def limit_order_with_legs(account, contract, action, quantity, limit_price, order_legs=None, secret_key=None):
     """
     限价单 + 附加订单(仅环球账户支持)
     :param account:
@@ -101,7 +101,7 @@ def limit_order_with_legs(account, contract, action, quantity, limit_price, orde
     if order_legs and len(order_legs) > 2:
         raise Exception('2 order legs at most')
     return Order(account, contract, action, 'LMT', quantity, limit_price=limit_price, order_legs=order_legs,
-                 user_id=user_id)
+                 secret_key=secret_key)
 
 
 def algo_order_params(start_time=None, end_time=None, no_take_liq=None, allow_past_end_time=None, participation_rate=None):
@@ -118,7 +118,7 @@ def algo_order_params(start_time=None, end_time=None, no_take_liq=None, allow_pa
                       allow_past_end_time=allow_past_end_time, participation_rate=participation_rate)
 
 
-def algo_order(account, contract, action, quantity, strategy, algo_params=None, limit_price=None, user_id=None):
+def algo_order(account, contract, action, quantity, strategy, algo_params=None, limit_price=None, secret_key=None):
     """
     算法订单
     :param account:
@@ -131,7 +131,7 @@ def algo_order(account, contract, action, quantity, strategy, algo_params=None,
     :return:
     """
     return Order(account, contract, action, order_type=strategy, quantity=quantity, algo_params=algo_params,
-                 limit_price=limit_price, outside_rth=False, user_id=user_id)
+                 limit_price=limit_price, outside_rth=False, secret_key=secret_key)
 
 
 def get_order_status(value):

tigeropen/examples/client_config.py

@@ -18,10 +18,10 @@ def get_client_config():
     client_config = TigerOpenClientConfig(sandbox_debug=is_sandbox)
     client_config.private_key = read_private_key('your private key file path')
     client_config.tiger_id = 'your tiger id'
-    client_config.account = 'your account'  # 环球账户.
-    # 只使用一个账户时，不论是环球账户, 标准账户或是模拟账户, 都填在 client_config.account 下, 默认只会使用这里的账户.
+    client_config.account = 'your account'  # 账户. 不论是环球账户, 综合账户或是模拟账户, 都填在此处
     # standard_account 属性和 paper_account 属性只是为多账户时取用方便, 一般可忽略
-    client_config.standard_account = None  # 标准账户
-    client_config.paper_account = None  # 模拟账户
+    client_config.standard_account = None
+    client_config.paper_account = None
+    client_config.secret_key = None  # 机构密钥(机构用户需要填写, 个人开发者无需填写)
     client_config.language = Language.en_US
     return client_config

tigeropen/tiger_open_config.py

@@ -36,18 +36,18 @@ class TigerOpenClientConfig(object):
     def __init__(self, sandbox_debug=False):
         # 开发者应用id
         self._tiger_id = ''
-        # 授权账户(环球账户，推荐)
+        # 授权账户
         self._account = ''
-        # 标准账户
+        # 综合账户
         self._standard_account = ''
         # 模拟账户
         self._paper_account = ''
         # 开发者应用私钥
         self._private_key = ''
         # 请求签名类型，推荐RSA2
         self._sign_type = SIGN_TYPE
-        # 用户id
-        self._user_id = ''
+        # 机构密钥
+        self._secret_key = ''
 
         # 老虎证券开放平台网关地址
         self._server_url = SERVER_URL
@@ -165,32 +165,32 @@ def timeout(self, value):
         self._timeout = value
 
     @property
-    def user_id(self):
-        return self._user_id
+    def secret_key(self):
+        return self._secret_key
 
-    @user_id.setter
-    def user_id(self, value):
-        self._user_id = value
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
 
 
 def get_client_config(private_key_path, tiger_id, account, standard_account=None, paper_account=None,
                       sandbox_debug=False, sign_type=None, timeout=None, language=None, charset=None,
-                      server_url=None, socket_host_port=None, user_id=None):
+                      server_url=None, socket_host_port=None, secret_key=None):
     """
     生成客户端配置
     :param private_key_path: 私钥文件路径, 如 '/Users/tiger/.ssh/rsa_private_key.pem'
     :param tiger_id: 开发者应用 id
-    :param account: 授权账户 (必填. 作为发送请求时的默认账户)
-    :param standard_account:
-    :param paper_account:
+    :param account: 授权账户 (必填. 作为发送请求时的默认账户. 不论是环球账户, 综合账户或是模拟账户, 都使用此参数)
+    :param standard_account: 多账户时可将综合账户填在此处, 一般可忽略
+    :param paper_account: 多账户时可将模拟账户填在此处, 一般可忽略
     :param sandbox_debug: 是否请求 sandbox 环境
     :param sign_type: 签名类型
     :param timeout: 请求超时时间, 单位秒
     :param language: 语言, 取值为 tigeropen.common.consts.Language 中的枚举类型
     :param charset: 字符集编码
     :param server_url: 网关地址
     :param socket_host_port: 推送长连接的域名端口, 值为协议, 域名, 端口构成的三元组
-    :param user_id: 用户id
+    :param secret_key: 机构密钥(个人开发者无需指定)
     :return:
     """
     config = TigerOpenClientConfig(sandbox_debug=sandbox_debug)
@@ -213,7 +213,7 @@ def get_client_config(private_key_path, tiger_id, account, standard_account=None
         config.server_url = server_url
     if socket_host_port:
         config.socket_host_port = socket_host_port
-    if user_id:
-        config.user_id = user_id
+    if secret_key:
+        config.secret_key = secret_key
     return config
 

tigeropen/trade/domain/order.py

@@ -16,13 +16,13 @@ class Order(object):
     __slots__ = ["account", "id", "order_id", "parent_id", "order_time", "reason", "trade_time", "contract", "action",
                  "quantity", "filled", "_remaining", "avg_fill_price", "commission", "realized_pnl", "_status",
                  "trail_stop_price", "limit_price", "aux_price", "trailing_percent", "percent_offset", "action",
-                 "order_type", "time_in_force", "outside_rth", "order_legs", "algo_params", "user_id"]
+                 "order_type", "time_in_force", "outside_rth", "order_legs", "algo_params", "secret_key"]
 
     def __init__(self, account, contract, action, order_type, quantity, limit_price=None, aux_price=None,
                  trail_stop_price=None, trailing_percent=None, percent_offset=None, time_in_force=None,
                  outside_rth=None, filled=0, avg_fill_price=0, commission=None, realized_pnl=None,
                  id=None, order_id=None, parent_id=None, order_time=None, trade_time=None, order_legs=None,
-                 algo_params=None, user_id=None):
+                 algo_params=None, secret_key=None):
         """
         - account: 订单所属的账户
         - id: 全局订单 id
@@ -50,7 +50,7 @@ def __init__(self, account, contract, action, order_type, quantity, limit_price=
         - remaining: 未成交的数量
         - order_legs: 附加订单列表
         - algo_params: 算法订单参数
-        - user_id: 用户id
+        - secret_key: 机构密钥
         """
 
         self.id = id
@@ -79,7 +79,7 @@ def __init__(self, account, contract, action, order_type, quantity, limit_price=
         self.trade_time = trade_time
         self.order_legs = order_legs
         self.algo_params = algo_params
-        self.user_id = user_id
+        self.secret_key = secret_key
 
     def to_dict(self):
         dct = {name: getattr(self, name) for name in self.__slots__ if name not in ORDER_FIELDS_TO_IGNORE}