Merge branch 'feature_institution_secret_key' into 'dev'

Feature institution secret key

See merge request server/openapi/openapi-python-sdk!70

Author: zhanggoo9527

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/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,16 +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
+        # 机构交易员专有密钥
+        self._secret_key = ''
 
         # 老虎证券开放平台网关地址
         self._server_url = SERVER_URL
@@ -162,24 +164,33 @@ def timeout(self):
     def timeout(self, value):
         self._timeout = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @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):
+                      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 secret_key: 机构交易员专有密钥 (个人开发者无需指定)
     :return:
     """
     config = TigerOpenClientConfig(sandbox_debug=sandbox_debug)
@@ -202,5 +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 secret_key:
+        config.secret_key = secret_key
     return config
 

tigeropen/trade/domain/order.py

@@ -11,17 +11,18 @@
 ALGO_PARAMS_TAG_MAP = {'noTakeLiq': 'no_take_liq', 'startTime': 'start_time', 'endTime': 'end_time',
                        'participationRate': 'participation_rate', 'allowPastEndTime': 'allow_past_end_time'}
 
+
 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"]
+                 "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):
+                 algo_params=None, secret_key=None):
         """
         - account: 订单所属的账户
         - id: 全局订单 id
@@ -49,6 +50,7 @@ def __init__(self, account, contract, action, order_type, quantity, limit_price=
         - remaining: 未成交的数量
         - order_legs: 附加订单列表
         - algo_params: 算法订单参数
+        - secret_key: 机构交易员专有密钥
         """
 
         self.id = id
@@ -77,6 +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.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}

tigeropen/trade/request/model.py

@@ -9,6 +9,7 @@
 class AccountsParams(object):
     def __init__(self):
         self._account = None
+        self._secret_key = None
 
     @property
     def account(self):
@@ -18,17 +19,27 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     def to_openapi_dict(self):
         params = dict()
         if self.account:
             params['account'] = self.account
-
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
         return params
 
 
 class AssetParams(object):
     def __init__(self):
         self._account = None
+        self._secret_key = None
         self._segment = False
         self._market_value = False
         self._sub_accounts = None
@@ -41,6 +52,14 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     @property
     def segment(self):
         return self._segment
@@ -70,6 +89,9 @@ def to_openapi_dict(self):
         if self.account:
             params['account'] = self.account
 
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+
         if self.segment:
             params['segment'] = self.segment
 
@@ -85,6 +107,7 @@ def to_openapi_dict(self):
 class PositionParams(object):
     def __init__(self):
         self._account = None
+        self._secret_key = None
         self._symbol = None
         self._sec_type = None
         self._currency = None
@@ -99,6 +122,14 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     @property
     def symbol(self):
         return self._symbol
@@ -144,6 +175,9 @@ def to_openapi_dict(self):
         if self.account:
             params['account'] = self.account
 
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+
         if self.symbol:
             params['symbol'] = self.symbol
 
@@ -165,6 +199,7 @@ def to_openapi_dict(self):
 class ContractParams(object):
     def __init__(self):
         self._account = None
+        self._secret_key = None
         self._symbol = None
         self._symbols = None
         self._sec_type = None
@@ -182,6 +217,14 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     @property
     def symbol(self):
         return self._symbol
@@ -251,6 +294,9 @@ def to_openapi_dict(self):
         if self.account:
             params['account'] = self.account
 
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+
         if self.symbol:
             params['symbol'] = self.symbol
 
@@ -281,6 +327,7 @@ def to_openapi_dict(self):
 class OrderParams(object):
     def __init__(self):
         self._account = None  # 账户
+        self._secret_key = None
         self._id = None  # 订单号(全局)
         self._order_id = None  # 订单号(账户维度)
         self._is_brief = None
@@ -294,6 +341,14 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     @property
     def order_id(self):
         return self._order_id
@@ -331,6 +386,9 @@ def to_openapi_dict(self):
         if self.account:
             params['account'] = self.account
 
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+
         if self.order_id:
             params['order_id'] = self.order_id
 
@@ -349,6 +407,7 @@ def to_openapi_dict(self):
 class OrdersParams(object):
     def __init__(self):
         self._account = None  # 账户
+        self._secret_key = None
         self._market = None  # 市场
         self._sec_type = None  # 合约类型
         self._symbol = None  # 合约代码
@@ -368,6 +427,14 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     @property
     def market(self):
         return self._market
@@ -453,6 +520,9 @@ def to_openapi_dict(self):
         if self.account:
             params['account'] = self.account
 
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+
         if self.market:
             params['market'] = self.market
 
@@ -489,6 +559,7 @@ def to_openapi_dict(self):
 class PlaceModifyOrderParams(object):
     def __init__(self):
         self.account = None
+        self.secret_key = None
         self.id = None
         self.order_id = None
         self.contract = None
@@ -530,6 +601,8 @@ def to_openapi_dict(self):
 
             if self.account:
                 params['account'] = self.account
+            if self.secret_key:
+                params['secret_key'] = self.secret_key
 
             if self.order_id:
                 params['order_id'] = self.order_id
@@ -591,6 +664,7 @@ def to_openapi_dict(self):
 class CancelOrderParams(object):
     def __init__(self):
         self._account = None
+        self._secret_key = None
         self._id = None
         self._order_id = None
 
@@ -602,6 +676,14 @@ def account(self):
     def account(self, value):
         self._account = value
 
+    @property
+    def secret_key(self):
+        return self._secret_key
+
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+
     @property
     def order_id(self):
         return self._order_id
@@ -623,6 +705,9 @@ def to_openapi_dict(self):
         if self.account:
             params['account'] = self.account
 
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+
         if self.order_id:
             params['order_id'] = self.order_id