webull-openapi-python-sdk 1.0.2__py3-none-any.whl → 1.0.4__py3-none-any.whl

samples/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.2"
+__version__ = "1.0.4"

samples/trade/trade_client_v2.py

@@ -11,13 +11,12 @@
 # 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.
+
 import json
-import unittest
 import uuid
 from time import sleep
 
 from webull.core.client import ApiClient
-from webull.data.common.category import Category
 from webull.trade.trade_client import TradeClient
 
 optional_api_endpoint = "<api_endpoint>"
@@ -34,87 +33,171 @@ if __name__ == '__main__':
 
     res = trade_client.account_v2.get_account_list()
     if res.status_code == 200:
-        print("account_list=" + json.dumps(res.json(), indent=4))
+        print('get account list:', res.json())
 
     res = trade_client.account_v2.get_account_balance(account_id)
     if res.status_code == 200:
-        print("account_balance=" + json.dumps(res.json(), indent=4))
+        print('get account balance res:', res.json())
 
     res = trade_client.account_v2.get_account_position(account_id)
     if res.status_code == 200:
-        print("account_position=" + json.dumps(res.json(), indent=4))
+        print('get account position res:', res.json())
+
+    # simple order
+    client_order_id = uuid.uuid4().hex
+    print('client order id:', client_order_id)
+    new_simple_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": client_order_id,
+            "symbol": "AAPL",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "LIMIT",
+            "limit_price": "188",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY"
+        }
+    ]
 
-    preview_orders = {
-        "symbol": "AAPL",
-        "instrument_type": "EQUITY",
-        "market": "US",
-        "order_type": "MARKET",
-        "quantity": "1",
-        "support_trading_session": "N",
-        "side": "BUY",
-        "time_in_force": "DAY",
-        "entrust_type": "QTY"
-    }
-    res = trade_client.order_v2.preview_order(account_id=account_id, preview_orders=preview_orders)
+    res = trade_client.order_v2.preview_order(account_id, new_simple_orders)
     if res.status_code == 200:
-        print("preview_res=" + json.dumps(res.json(), indent=4))
+        print('preview order res:', res.json())
 
-    client_order_id = uuid.uuid4().hex
-    new_orders = {
-        "client_order_id": client_order_id,
-        "symbol": "AAPL",
-        "instrument_type": "EQUITY",
-        "market": "US",
-        "order_type": "LIMIT",
-        "limit_price": "188",
-        "quantity": "1",
-        "support_trading_session": "N",
-        "side": "BUY",
-        "time_in_force": "DAY",
-        "entrust_type": "QTY",
-        # "account_tax_type": "GENERAL"
-        # "total_cash_amount": "100.20"
-        # "sender_sub_id": "123321-lzg",
-        # "no_party_ids":[
-        #     {"party_id":"BNG144.666555","party_id_source":"D","party_role":"3"}
-        # ]
-    }
-
-    # This is an optional feature; you can still make a request without setting it.
-    custom_headers_map = {"category": Category.US_STOCK.name}
-    trade_client.order_v2.add_custom_headers(custom_headers_map)
-    res = trade_client.order_v2.place_order(account_id=account_id, new_orders=new_orders)
-    trade_client.order_v2.remove_custom_headers()
-    if res.status_code == 200:
-        print("place_order_res=" + json.dumps(res.json(), indent=4))
-    sleep(5)
-
-    modify_orders = {
-        "client_order_id": client_order_id,
-        "quantity": "100",
-        "limit_price": "200"
-    }
-    res = trade_client.order_v2.replace_order(account_id=account_id, modify_orders=modify_orders)
-    if res.status_code == 200:
-        print("replace_order_res=" + json.dumps(res.json(), indent=4))
-    sleep(5)
-
-    res = trade_client.order_v2.cancel_order_v2(account_id=account_id, client_order_id=client_order_id)
-    if res.status_code == 200:
-        print("cancel_order_res=" + json.dumps(res.json(), indent=4))
-
-    res = trade_client.order_v2.get_order_history_request(account_id=account_id)
-    if res.status_code == 200:
-        print("order_history_res=" + json.dumps(res.json(), indent=4))
+    res = trade_client.order_v2.place_order(account_id, new_simple_orders)
+    if res.status_code == 200:
+        print('place order res:', res.json())
+    sleep(3)
+
+    modify_simple_orders = [
+        {
+            "client_order_id": client_order_id,
+            "quantity": "100",
+            "limit_price": "200"
+        }
+    ]
+    res = trade_client.order_v2.replace_order(account_id, modify_simple_orders)
+    if res.status_code == 200:
+        print('replace order res:', res.json())
+    sleep(3)
+
+    res = trade_client.order_v2.cancel_order(account_id, client_order_id)
+    if res.status_code == 200:
+        print('cancel order res:', res.json())
+
+    res = trade_client.order_v2.get_order_open(account_id=account_id)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v2.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v2.get_order_detail(account_id, client_order_id)
+    if res.status_code == 200:
+        print('get order detail res:', res.json())
+
+
+
+    # Combo Order
+    master_client_order_id = uuid.uuid4().hex
+    stop_profit_client_order_id = uuid.uuid4().hex
+    stop_loss_client_order_id = uuid.uuid4().hex
+    print('master_client_order_id:', master_client_order_id)
+    print('stop_profit_client_order_id:', stop_profit_client_order_id)
+    print('stop_loss_client_order_id:', stop_loss_client_order_id)
+    new_combo_orders = [
+        {
+            "client_order_id": master_client_order_id,
+            "combo_type": "MASTER",
+            "symbol": "F",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "LIMIT",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "limit_price": "10.5",
+            "side": "BUY",
+            "entrust_type": "QTY",
+            "time_in_force": "DAY"
+        },
+        {
+            "client_order_id": stop_profit_client_order_id,
+            "combo_type": "STOP_PROFIT",
+            "symbol": "F",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "LIMIT",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "limit_price": "11.5",
+            "side": "SELL",
+            "entrust_type": "QTY",
+            "time_in_force": "DAY"
+        },
+        {
+            "client_order_id": stop_loss_client_order_id,
+            "combo_type": "STOP_LOSS",
+            "symbol": "F",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "STOP_LOSS",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "stop_price": "10",
+            "side": "SELL",
+            "entrust_type": "QTY",
+            "time_in_force": "DAY"
+        }
+    ]
+
+    res = trade_client.order_v2.preview_order(account_id, new_combo_orders)
+    if res.status_code == 200:
+        print('preview combo order res:', res.json())
+
+    res = trade_client.order_v2.place_order(account_id, new_combo_orders)
+    if res.status_code == 200:
+        print('place combo order res:', res.json())
+    sleep(3)
+
+    modify_combo_orders = [
+        {
+            "client_order_id": master_client_order_id,
+            "quantity": "2"
+        },
+        {
+            "client_order_id": stop_profit_client_order_id,
+            "quantity": "2"
+        },
+        {
+            "client_order_id": stop_loss_client_order_id,
+            "quantity": "2"
+        }
+    ]
+    res = trade_client.order_v2.replace_order(account_id, modify_combo_orders)
+    if res.status_code == 200:
+        print('replace combo order res:', res.json())
+    sleep(3)
+
+    res = trade_client.order_v2.cancel_order(account_id, master_client_order_id)
+    if res.status_code == 200:
+        print('cancel master order res:', res.json())
+
+    res = trade_client.order_v2.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
 
     res = trade_client.order_v2.get_order_open(account_id=account_id)
     if res.status_code == 200:
         print("order_open_res=" + json.dumps(res.json(), indent=4))
 
-    # order detail
-    res = trade_client.order_v2.get_order_detail(account_id=account_id, client_order_id=client_order_id)
+    res = trade_client.order_v2.get_order_detail(account_id, master_client_order_id)
     if res.status_code == 200:
-        print("order detail=" + json.dumps(res.json(), indent=4))
+        print('get master order detail res:', res.json())
+
 
     # Options
     # For option order inquiries, please use the V2 query interface: api.order_v2.get_order_detail(account_id, client_order_id).
@@ -125,18 +208,18 @@ if __name__ == '__main__':
             "combo_type": "NORMAL",
             "order_type": "LIMIT",
             "quantity": "1",
-            "limit_price": "11.25",
+            "limit_price": "21.25",
             "option_strategy": "SINGLE",
             "side": "BUY",
             "time_in_force": "GTC",
             "entrust_type": "QTY",
-            "orders": [
+            "legs": [
                 {
                     "side": "BUY",
                     "quantity": "1",
-                    "symbol": "AAPL",
-                    "strike_price": "250.0",
-                    "init_exp_date": "2025-08-15",
+                    "symbol": "TSLA",
+                    "strike_price": "400",
+                    "option_expire_date": "2025-12-26",
                     "instrument_type": "OPTION",
                     "option_type": "CALL",
                     "market": "US"
@@ -144,42 +227,76 @@ if __name__ == '__main__':
             ]
         }
     ]
+
     # preview
     res = trade_client.order_v2.preview_option(account_id, option_new_orders)
     if res.status_code == 200:
-        print("preview option=" + json.dumps(res.json(), indent=4))
-    sleep(5)
-    # place
+        print("preview option res:" + json.dumps(res.json(), indent=4))
 
-    # This is an optional feature; you can still make a request without setting it.
-    custom_headers_map = {"category": Category.US_OPTION.name}
-    trade_client.order_v2.add_custom_headers(custom_headers_map)
+    # place
     res = trade_client.order_v2.place_option(account_id, option_new_orders)
-    trade_client.order_v2.remove_custom_headers()
     if res.status_code == 200:
-        print("place option=" + json.dumps(res.json(), indent=4))
-    sleep(5)
+        print("place option res:" + json.dumps(res.json(), indent=4))
+    sleep(3)
 
-    # replace
-    option_modify_orders = [
-        {
-            "client_order_id": client_order_id,
-            "quantity": "2",
-            "limit_price": "11.3",
-            "orders": [
-                {
-                    "client_order_id": client_order_id,
-                    "quantity": "2"
-                }
-            ]
-        }
-    ]
-    res = trade_client.order_v2.replace_option(account_id, option_modify_orders)
+    # replace for Webull HK
+    # option_modify_orders = [
+    #     {
+    #         "client_order_id": client_order_id,
+    #         "quantity": "2",
+    #         "limit_price": "11.3"
+    #     }
+    # ]
+    # res = trade_client.order_v2.replace_option(account_id, option_modify_orders)
+    # if res.status_code == 200:
+    #     print("replace option res:" + json.dumps(res.json(), indent=4))
+    # sleep(5)
+
+    # replace for Webull US
+    res = trade_client.order_v2.get_order_detail(account_id, client_order_id)
     if res.status_code == 200:
-        print("replace option=" + json.dumps(res.json(), indent=4))
-    sleep(5)
+        print('get option order detail res:', res.json())
+    data = res.json() or {}
+    leg_id = (
+        data.get("orders", [{}])[0]
+        .get("legs", [{}])[0]
+        .get("id")
+    )
+    print('get option order detail id :', leg_id)
+
+    # If it is a multi-leg option, you need to manually match it to the corresponding sub-leg orderId.
+    if leg_id:
+        option_modify_orders = [
+            {
+                "client_order_id": client_order_id,
+                "quantity": "2",
+                "limit_price": "21.3",
+                "legs": [
+                    {
+                        "id": leg_id,
+                        "quantity": "2"
+                    }
+                ]
+            }
+        ]
+        res = trade_client.order_v2.replace_option(account_id, option_modify_orders)
+        if res.status_code == 200:
+            print("replace option res:" + json.dumps(res.json(), indent=4))
+        sleep(3)
 
     # cancel
     res = trade_client.order_v2.cancel_option(account_id, client_order_id)
     if res.status_code == 200:
-        print("cancel option=" + json.dumps(res.json(), indent=4))
+        print("cancel option res:" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v2.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v2.get_order_open(account_id=account_id)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v2.get_order_detail(account_id, client_order_id)
+    if res.status_code == 200:
+        print('get option order detail res:', res.json())

samples/trade/trade_event_client.py

@@ -12,36 +12,38 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import unittest
+import logging
 
-from webull.trade.trade_events_client import TradeEventsClient
 from webull.trade.events.types import ORDER_STATUS_CHANGED, EVENT_TYPE_ORDER
+from webull.trade.trade_events_client import TradeEventsClient
 
 your_app_key = "<your_app_key>"
 your_app_secret = "<your_app_secret>"
 account_id = "<your_account_id>"
-region_id = "hk"
+region_id = "<region_id>"
 
 optional_api_endpoint = "<event_api_endpoint>"
 
 
+def _on_log(level, log_content):
+    print(logging.getLevelName(level), log_content)
+
+def my_on_events_message(event_type, subscribe_type, payload, raw_message):
+    if EVENT_TYPE_ORDER == event_type and ORDER_STATUS_CHANGED == subscribe_type:
+        print('----request_id:%s----' % payload['request_id'])
+        print(payload)
+
 if __name__ == '__main__':
+
     # Create EventsClient instance
     trade_events_client = TradeEventsClient(your_app_key, your_app_secret, region_id)
-    trade_events_client.enable_logger()
     # For non production environment, you need to set the domain name of the subscription service through eventsclient. For example, the domain name of the UAT environment is set here
     # trade_events_client = TradeEventsClient(your_app_key, your_app_secret, region_id, host=optional_api_endpoint)
+    trade_events_client.on_log = _on_log
 
     # Set the callback function when the event data is received.
     # The data of order status change is printed here
 
-    def my_on_events_message(event_type, subscribe_type, payload, raw_message):
-        if EVENT_TYPE_ORDER == event_type and ORDER_STATUS_CHANGED == subscribe_type:
-            print('----request_id:%s----' % payload['request_id'])
-            print(payload['account_id'])
-            print(payload['client_order_id'])
-            print(payload['order_status'])
-
     trade_events_client.on_events_message = my_on_events_message
     # Set the account ID to be subscribed and initiate the subscription. This method is synchronous
     trade_events_client.do_subscribe([account_id])

webull/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.2"
+__version__ = "1.0.4"

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.2"
+__version__ = "1.0.4"
 
 import logging
 

webull/core/http/initializer/client_initializer.py

@@ -35,6 +35,9 @@
 
 import logging
 
+from webull.core import compat
+from webull.core.exception.exceptions import ClientException
+from webull.core.http.initializer.config.config_operation import ConfigOperation
 from webull.core.http.initializer.token.token_manager import TokenManager
 
 logger = logging.getLogger(__name__)
@@ -51,29 +54,62 @@ class ClientInitializer:
     @staticmethod
     def init_token(api_client):
         """Initialize token"""
-        if not ClientInitializer.check_region_token_enable(api_client):
-            return
+        disable_config_region_ids = ["hk"]
+        if api_client.get_region_id() in disable_config_region_ids:
+            if not ClientInitializer._check_region_token_enable(api_client):
+                return
+        else:
+            if not ClientInitializer._check_token_enable(api_client):
+                return
 
         token_manager = TokenManager()
         token_manager.init_token(api_client)
 
     @staticmethod
-    def check_region_token_enable(api_client):
+    def _check_region_token_enable(api_client):
         """
         Check whether token checking is enabled in the specified region
         """
         if api_client is None:
-            logger.warning("check_region_token_enable api_client is null, return False")
+            logger.warning("_check_region_token_enable api_client is null, return False")
             return False
 
         if not api_client.get_region_id():
-            logger.warning("check_region_token_enable region_id is null, return False")
+            logger.warning("_check_region_token_enable region_id is null, return False")
             return False
 
         enable_region_ids = ["hk"]
         result = api_client.get_region_id() in enable_region_ids
         logger.info(
-            "check_region_token_enable result is %s, enable regionIds is %s. current regionsId is %s",
-            result, enable_region_ids, api_client.get_region_id()
+            "_check_region_token_enable result is %s, enable regionIds is %s.",
+            result, enable_region_ids
         )
+        return result
+
+    @staticmethod
+    def _check_token_enable(api_client):
+        """
+        Check whether token checking is enabled
+        """
+        if api_client is None:
+            logger.warning("_check_token_enable api_client is null, return False")
+            return False
+
+        config_operation = ConfigOperation(api_client)
+        response = config_operation.get_config()
+
+        if response.status_code != 200:
+            msg = "_check_token_enable get_token_config returned non-200 response, raising exception. status_code:%s" % response.status_code
+            logger.error(compat.ensure_string(msg))
+            raise ClientException("ERROR_CHECK_TOKEN_ENABLE", msg)
+
+        token_config = response.json()
+        if not token_config:
+            msg = "_check_token_enable get_token_config result is empty."
+            logger.error(msg)
+            raise ClientException("ERROR_CHECK_TOKEN_ENABLE", msg)
+
+        result = token_config.get("token_check_enabled", False)
+        logger.info("_check_token_enable result is %s",result)
+
         return result

webull/core/http/initializer/config/bean/query_config_request.py

@@ -0,0 +1,41 @@
+# 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
+
+from webull.core.request import ApiRequest
+
+
+class GetConfigRequest(ApiRequest):
+    def __init__(self):
+        super().__init__("/openapi/config", version='v2', method="GET", query_params={})

webull/core/http/initializer/config/config_operation.py

@@ -0,0 +1,49 @@
+# 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
+
+from webull.core.http.initializer.config.bean.query_config_request import GetConfigRequest
+
+
+class ConfigOperation:
+    def __init__(self, api_client):
+        self.client = api_client
+
+    def get_config(self):
+        """
+        Get Config
+        """
+        get_config_request = GetConfigRequest()
+        response = self.client.get_response(get_config_request)
+        return response

webull/core/http/initializer/token/bean/check_token_request.py

@@ -38,7 +38,7 @@ from webull.core.request import ApiRequest
 
 class CheckTokenRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/auth/token/check", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/auth/token/check", version='v2', method="POST", body_params={})
 
     def set_token(self, token):
         self.add_body_params("token", token)

webull/core/http/initializer/token/bean/create_token_request.py

@@ -38,7 +38,7 @@ from webull.core.request import ApiRequest
 
 class CreateTokenRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/auth/token/create", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/auth/token/create", version='v2', method="POST", body_params={})
 
     def set_token(self, token):
         if token:

webull/core/http/initializer/token/bean/refresh_token_request.py

@@ -38,7 +38,7 @@ from webull.core.request import ApiRequest
 
 class RefreshTokenRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/auth/token/refresh", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/auth/token/refresh", version='v2', method="POST", body_params={})
 
     def set_token(self, token):
         self.add_body_params("token", token)

webull/core/http/initializer/token/token_operation.py

@@ -33,8 +33,6 @@
 
 # coding=utf-8
 
-import logging
-
 from webull.core.http.initializer.token.bean.check_token_request import CheckTokenRequest
 from webull.core.http.initializer.token.bean.create_token_request import CreateTokenRequest
 from webull.core.http.initializer.token.bean.refresh_token_request import RefreshTokenRequest