feat: Add support for Webull JP

Author: yuanou1123

README.md

@@ -1,5 +1,7 @@
 # Webull OpenAPI Python SDK
 
+Note: This is the new version of the Webull SDK, currently applicable only to Webull Hong Kong, Webull US, or Webull JP customers.
+
 Webull OpenAPI aims to provide quantitative trading investors with convenient, fast and secure services. Webull aims to help every quant traders achieve flexible and changeable trading or market strategies.
 
 The main function:
@@ -20,6 +22,7 @@ Subscription to real-time information: Subscribe to order status changes, market
 |-----------|-------------------------------------------------|
 | Webull HK | https://www.webull.hk/open-api                  |
 | Webull US | https://www.webull.com/center#openApiManagement |
+| Webull JP | https://www.webull.co.jp/center/openapi/manage |
 
 - Requires Python 3.7 through 3.11.
 
@@ -35,7 +38,8 @@ The bottom layer of Webull OpenAPI provides three protocols, HTTP / GRPC / MQTT,
 
 ## Developer documentation
 
-| Broker    | Link                                   |
-|-----------|----------------------------------------|
-| Webull HK | https://developer.webull.hk/apis/docs  |
-| Webull US | https://developer.webull.com/apis/docs |
+| Broker    | Link                                     |
+|-----------|------------------------------------------|
+| Webull HK | https://developer.webull.hk/apis/docs    |
+| Webull US | https://developer.webull.com/apis/docs   |
+| Webull JP | https://developer.webull.co.jp/apis/docs |

samples/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.3'
+__version__ = '2.0.4'

samples/trade/trade_client_v3.py

@@ -49,6 +49,12 @@
     if res.status_code == 200:
         print('get account position res:', res.json())
 
+    # Currently, only Webull JP is supported.
+    # instrument_id = None # Get the instrument_id from the position list.
+    # res = trade_client.account_v2.get_account_position_details(account_id, instrument_id)
+    # if res.status_code == 200:
+    #     print('get account position details res:', res.json())
+
     # ============================================================
     # Equity Order Example
     # ============================================================
@@ -66,10 +72,13 @@
             "order_type": "LIMIT",
             "limit_price": "188",
             "quantity": "1",
-            "support_trading_session": "N",
+            "support_trading_session": "CORE",
             "side": "BUY",
             "time_in_force": "DAY",
-            "entrust_type": "QTY"
+            "entrust_type": "QTY",
+            # Currently, only Webull JP is supported.
+            # "account_tax_type":"GENERAL",
+            # "margin_type": "ONE_DAY"
         }
     ]
 

webull/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.3'
+__version__ = '2.0.4'

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.0.3'
+__version__ = '2.0.4'
 
 import logging
 

webull/core/auth/algorithm/sha_hmac256_new.py

@@ -0,0 +1,64 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/algorithm/sha_hmac256.py
+which was part of Alibaba Group.
+"""
+import hashlib
+import hmac
+
+from webull.core.compat import ensure_string
+from webull.core.compat import ensure_bytes
+from webull.core.compat import b64_encode_bytes
+
+
+def get_sign_string(source, secret):
+    source = ensure_bytes(source)
+    secret = ensure_bytes(secret)
+    h = hmac.new(secret, source, hashlib.sha256)
+    signature = ensure_string(b64_encode_bytes(h.digest()).strip())
+    return signature
+
+
+def get_signer_name():
+    return "HMAC-SHA256"
+
+
+def get_signer_version():
+    return "1.0"
+
+
+def get_signer_type():
+    return ""

webull/core/auth/composer/default_signature_composer.py

@@ -38,6 +38,7 @@
 """
 
 from webull.core.auth.algorithm import sha_hmac1
+from webull.core.auth.algorithm import sha_hmac256_new
 from webull.core.exception import error_code
 from webull.core.exception.exceptions import ClientException
 from webull.core.utils import common
@@ -51,27 +52,36 @@
 PARAMS_JOIN = "&"
 SECRET_TAILER = "&"
 
-def _refresh_sign_headers(host, headers, app_key_id, signer_spec=sha_hmac1):
+def _refresh_sign_headers(host, headers, app_key_id, signer_spec):
     if not host:
         raise ClientException(error_code.SDK_INVALID_PARAMETER)
     sign_headers = {}
     sign_headers[hd.APP_KEY] = app_key_id
     sign_headers[hd.TIMESTAMP] = common.get_iso_8601_date()
+
+    if common.is_not_upgrade_api_host(host):
+        signer_spec = sha_hmac256_new
+    else:
+        signer_spec = sha_hmac1
+
     sign_headers[hd.SIGN_VERSION] = signer_spec.get_signer_version()
     sign_headers[hd.SIGN_ALGORITHM] = signer_spec.get_signer_name()
     sign_headers[hd.NONCE] = common.get_uuid()
     headers.update(sign_headers)
     # DO NOT PUT Host Header in headers object, just put into sign_headers
     sign_headers[hd.NATIVE_HOST] = host
-    return sign_headers
+    return sign_headers,signer_spec
 
-def _gen_signature(string_to_sign, secret, signer_spec=sha_hmac1):
+def _gen_signature(string_to_sign, secret, signer_spec):
     return signer_spec.get_sign_string(string_to_sign, secret + SECRET_TAILER)
 
-def _get_body_string(body_params):
+def _get_body_string(body_params, signer_spec):
     if body_params is not None:
         raw_str = common.json_dumps_compact(body_params)
-        hex_digest = common.md5_hex(raw_str)
+        if signer_spec == sha_hmac256_new:
+            hex_digest = common.sha256_hex(raw_str)
+        else:
+            hex_digest = common.md5_hex(raw_str)
         return hex_digest.upper()
     else:
         return None
@@ -100,8 +110,8 @@ def _lower_key_dict(od):
         lower_key_dict[k.lower()] = v
     return lower_key_dict
 
-def calc_signature(headers, host, uri, queries, body_params, app_key_id, app_key_secret, signer_spec=sha_hmac1):
-    sign_headers = _refresh_sign_headers(host, headers, app_key_id, signer_spec)
+def calc_signature(headers, host, uri, queries, body_params, app_key_id, app_key_secret, signer_spec):
+    sign_headers,signer_spec = _refresh_sign_headers(host, headers, app_key_id, signer_spec)
     logger.debug("sign_headers:%s", sign_headers)
     sign_params = _lower_key_dict(sign_headers)
     logger.debug("sign_queries:%s", queries)
@@ -114,12 +124,11 @@ def calc_signature(headers, host, uri, queries, body_params, app_key_id, app_key
                 cv = str(v)
             sign_params[k] = cv
     logger.debug("body:%s", body_params)
-    body_string = _get_body_string(body_params)
+    body_string = _get_body_string(body_params, signer_spec)
     logger.debug("body_string:%s" % body_string)
     string_to_sign = _build_sign_string(sign_params, uri, body_string)
     logger.debug("string_to_sign:%s" % string_to_sign)
     signature = _gen_signature(string_to_sign, app_key_secret, signer_spec)
     headers[hd.SIGNATURE] = signature
     logger.debug("signature:%s", signature)
-    return signature
-
+    return signature

webull/core/utils/common.py

@@ -58,5 +58,20 @@ def md5_hex(content):
     content_bytes = ensure_bytes(content)
     return hashlib.md5(content_bytes).hexdigest()
 
+def sha256_hex(content):
+    content_bytes = ensure_bytes(content)
+    return hashlib.sha256(content_bytes).hexdigest()
+
 def json_dumps_compact(content):
-    return json.dumps(content, ensure_ascii=False, separators=(',', ':'))
+    return json.dumps(content, ensure_ascii=False, separators=(',', ':'))
+
+def is_not_upgrade_api_host(host):
+    upgrade_hosts = {
+        "api.webull.com","events-api.webull.com",
+        "api.webull.hk","events-api.webull.hk",
+        "pre-openapi-us-alb.webullbroker.com","pre-openapi-us-events.webullbroker.com",
+        "pre-openapi-alb.webullbroker.com","pre-openapi-events.webullbroker.com",
+        "us-openapi-alb.uat.webullbroker.com","us-openapi-events.uat.webullbroker.com",
+        "hk-openapi.uat.webullbroker.com", "hk-openapi-events-api.uat.webullbroker.com"
+    }
+    return host not in upgrade_hosts

webull/data/__init__.py

@@ -1,3 +1,3 @@
 # coding=utf-8
 
-__version__ = '2.0.3'
+__version__ = '2.0.4'

webull/data/common/category.py

@@ -26,3 +26,4 @@ class Category(EasyEnum):
     US_CRYPTO = (8, "US CRYPTO")
     US_FUTURES = (12, "US FUTURES")
     US_EVENT = (13, "US EVENT")
+    HK_FUTURES = (13, "HK FUTURES")