webull-openapi-python-sdk 2.0.3__tar.gz → 2.0.4__tar.gz

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webull-openapi-python-sdk
-Version: 2.0.3
+Version: 2.0.4
 Summary: Webull Python SDK.
 Home-page: 
 Author: Webull

webull_openapi_python_sdk-2.0.4/samples/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.0.4'

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/samples/trade/trade_client_v3.py

@@ -49,6 +49,12 @@ if __name__ == '__main__':
     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 @@ if __name__ == '__main__':
             "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_openapi_python_sdk-2.0.4/webull/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.0.4'

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/core/__init__.py

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

webull_openapi_python_sdk-2.0.4/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_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/core/auth/composer/default_signature_composer.py

@@ -38,6 +38,7 @@ which was part of Alibaba Group.
 """
 
 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 @@ PARAM_KV_JOIN = "="
 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_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/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_openapi_python_sdk-2.0.4/webull/data/__init__.py

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

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-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")

webull_openapi_python_sdk-2.0.4/webull/trade/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.0.4'

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/trade/common/category.py

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

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/trade/events/signature_composer.py

@@ -14,14 +14,14 @@
 
 # coding=utf-8
 from asyncio.log import logger
-from webull.core.auth.algorithm import sha_hmac1
+from webull.core.auth.algorithm import sha_hmac1, sha_hmac256_new
 from webull.core.auth.composer import default_signature_composer
 import webull.core.headers as hd
 import webull.core.utils.common as core_common
 import logging
 logger = logging.getLogger(__name__)
 
-def _build_sign_metadata(app_key_id, signer_spec=sha_hmac1):
+def _build_sign_metadata(app_key_id, signer_spec):
     sign_params = {}
     sign_algorithm = signer_spec.get_signer_name()
     sign_version = signer_spec.get_signer_version()
@@ -41,17 +41,21 @@ def _build_sign_metadata(app_key_id, signer_spec=sha_hmac1):
     sign_params[hd.TIMESTAMP] = ts
     return metadata, sign_params
 
-def _get_body_string(pb_object):
+def _get_body_string(pb_object, signer_spec):
     if pb_object:
         pb_object_bytes = pb_object.SerializeToString()
-        return core_common.md5_hex(pb_object_bytes)
+
+        if signer_spec == sha_hmac256_new:
+            return core_common.sha256_hex(pb_object_bytes)
+        else:
+            return core_common.md5_hex(pb_object_bytes)
     return None
     
-def calc_signature(app_key_id, app_key_secret, pb_object, signer_spec=sha_hmac1):
+def calc_signature(app_key_id, app_key_secret, pb_object, signer_spec):
     metadata, sign_params = _build_sign_metadata(app_key_id, signer_spec)
     sign_params = default_signature_composer._lower_key_dict(sign_params)
     logger.debug("sign_params:%s", sign_params)
-    body_string = _get_body_string(pb_object)
+    body_string = _get_body_string(pb_object,signer_spec)
     logger.debug("body_string:%s" % body_string) 
     string_to_sign = default_signature_composer._build_sign_string(sign_params, None, body_string)
     logger.debug("string_to_sign:%s" % string_to_sign)

webull_openapi_python_sdk-2.0.4/webull/trade/request/v2/get_account_position_details_request.py

@@ -0,0 +1,35 @@
+# 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.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class AccountPositionDetailsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/assets/position/details", version='v2', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_instrument_id(self, instrument_id):
+        self.add_query_param("instrument_id", instrument_id)
+
+    def set_page_size(self, page_size):
+        if page_size:
+            self.add_query_param("page_size", page_size)
+
+    def set_last_id(self, last_id):
+        if last_id:
+            self.add_query_param("last_id", last_id)

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/trade/trade/v2/account_info_v2.py

@@ -15,6 +15,7 @@
 
 from webull.trade.request.v2.get_account_balance_request import AccountBalanceRequest
 from webull.trade.request.v2.get_account_list_request import GetAccountListRequest
+from webull.trade.request.v2.get_account_position_details_request import AccountPositionDetailsRequest
 from webull.trade.request.v2.get_account_positions_request import AccountPositionsRequest
 
 
@@ -24,7 +25,7 @@ class AccountV2:
 
     def get_account_list(self):
         """
-        This interface is currently supported only for Webull HK and Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         account_list = GetAccountListRequest()
@@ -33,7 +34,7 @@ class AccountV2:
 
     def get_account_balance(self, account_id):
         """
-        This interface is currently supported only for Webull HK and Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         account_balance_request = AccountBalanceRequest()
@@ -43,10 +44,23 @@ class AccountV2:
 
     def get_account_position(self, account_id):
         """
-        This interface is currently supported only for Webull HK and Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         account_positions_request = AccountPositionsRequest()
         account_positions_request.set_account_id(account_id)
         response = self.client.get_response(account_positions_request)
         return response
+
+    def get_account_position_details(self, account_id, instrument_id, page_size=None, last_id=None):
+        """
+        This interface is currently supported only for Webull JP.
+        Support for other regions will be available in future updates.
+        """
+        account_position_details_request = AccountPositionDetailsRequest()
+        account_position_details_request.set_account_id(account_id)
+        account_position_details_request.set_instrument_id(instrument_id)
+        account_position_details_request.set_page_size(page_size)
+        account_position_details_request.set_last_id(last_id)
+        response = self.client.get_response(account_position_details_request)
+        return response

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/trade/trade/v3/order_opration_v3.py

@@ -28,7 +28,7 @@ class OrderOperationV3:
 
     def preview_order(self, account_id, preview_orders, client_combo_order_id=None):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         preview_order_request = PreviewOrderRequest()
@@ -40,7 +40,7 @@ class OrderOperationV3:
 
     def place_order(self, account_id, new_orders, client_combo_order_id=None):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         place_order_request = PlaceOrderRequest()
@@ -65,7 +65,7 @@ class OrderOperationV3:
 
     def replace_order(self, account_id, modify_orders, client_combo_order_id=None):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         replace_order_request = ReplaceOrderRequest()
@@ -77,7 +77,7 @@ class OrderOperationV3:
 
     def cancel_order(self, account_id, client_order_id):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         cancel_order_request = CancelOrderRequest()
@@ -88,7 +88,7 @@ class OrderOperationV3:
 
     def get_order_detail(self, account_id, client_order_id):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
         """
         order_detail_request = OrderDetailRequest()
@@ -99,7 +99,7 @@ class OrderOperationV3:
 
     def get_order_history(self, account_id, page_size=None, start_date=None, end_date=None, last_client_order_id=None):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
 
         Historical orders. If they are group orders, will be returned together,
@@ -127,7 +127,7 @@ class OrderOperationV3:
 
     def get_order_open(self, account_id, page_size=None, last_client_order_id=None):
         """
-        This interface is currently supported only for Webull US.
+        This interface is currently supported only for Webull HK, Webull US, and Webull JP.
         Support for other regions will be available in future updates.
 
         Paging query pending orders.

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull/trade/trade_events_client.py

@@ -19,7 +19,10 @@ import threading
 import time
 
 import grpc
+
+from webull.core.auth.algorithm import sha_hmac256_new, sha_hmac1
 from webull.core.common import api_type
+from webull.core.utils import common
 from webull.core.endpoint.default_endpoint_resolver import \
     DefaultEndpointResolver
 from webull.core.endpoint.resolver_endpoint_request import \
@@ -77,7 +80,21 @@ class TradeEventsClient():
             timestamp=int(time.time() * 1000),  # millis
             accounts=accounts,
         )
-        signature, metadata = calc_signature(app_key, app_secret, request)
+        if common.is_not_upgrade_api_host(self._host):
+            signer_spec = sha_hmac256_new
+        else:
+            signer_spec = sha_hmac1
+
+        signature, metadata = calc_signature(app_key, app_secret, request, signer_spec)
+        
+        # Print detailed request parameters
+        print("\n=== gRPC Request Details ===")
+        print(f"Request: {request}")
+        print(f"Signature: {signature}")
+        print(f"Metadata: {metadata}")
+        print(f"Signer Spec: {signer_spec.__name__ if hasattr(signer_spec, '__name__') else signer_spec}")
+        print("=============================\n")
+        
         return request, metadata
 
     def _stream_processing(self, stub, accounts):
@@ -226,6 +243,14 @@ class TradeEventsClient():
 
     def do_subscribe(self, accounts):
         target = self._host + ":" + str(self._port)
+        # Print gRPC connection parameters
+        print("\n=== gRPC Connection Parameters ===")
+        print(f"Host: {self._host}")
+        print(f"Port: {self._port}")
+        print(f"Target: {target}")
+        print(f"TLS Enabled: {self._tls_enable}")
+        print("==================================\n")
+        
         if self._tls_enable:
             ssl_channel_credentials = grpc.ssl_channel_credentials()
             with grpc.secure_channel(target, ssl_channel_credentials) as channel:
@@ -234,4 +259,4 @@ class TradeEventsClient():
         else:
             with grpc.insecure_channel(target) as channel:
                 stub = pb_grpc.EventServiceStub(channel)
-                self._stream_processing(stub, accounts)
+                self._stream_processing(stub, accounts)

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull_openapi_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webull-openapi-python-sdk
-Version: 2.0.3
+Version: 2.0.4
 Summary: Webull Python SDK.
 Home-page: 
 Author: Webull

{webull_openapi_python_sdk-2.0.3 → webull_openapi_python_sdk-2.0.4}/webull_openapi_python_sdk.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ webull/core/auth/credentials.py
 webull/core/auth/algorithm/__init__.py
 webull/core/auth/algorithm/sha_hmac1.py
 webull/core/auth/algorithm/sha_hmac256.py
+webull/core/auth/algorithm/sha_hmac256_new.py
 webull/core/auth/composer/__init__.py
 webull/core/auth/composer/default_signature_composer.py
 webull/core/auth/signers/__init__.py
@@ -221,6 +222,7 @@ webull/trade/request/v2/cancel_order_request.py
 webull/trade/request/v2/get_account_balance_request.py
 webull/trade/request/v2/get_account_list.py
 webull/trade/request/v2/get_account_list_request.py
+webull/trade/request/v2/get_account_position_details_request.py
 webull/trade/request/v2/get_account_positions_request.py
 webull/trade/request/v2/get_order_detail_request.py
 webull/trade/request/v2/get_order_history_request.py

webull_openapi_python_sdk-2.0.3/samples/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.0.3'

webull_openapi_python_sdk-2.0.3/webull/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.0.3'

webull_openapi_python_sdk-2.0.3/webull/data/__init__.py

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

webull_openapi_python_sdk-2.0.3/webull/trade/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.0.3'