webull-openapi-python-sdk 2.0.16__tar.gz → 2.0.18__tar.gz

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/PKG-INFO

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

webull_openapi_python_sdk-2.0.18/samples/__init__.py

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

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/samples/trade/trade_client_v3.py

@@ -60,6 +60,17 @@ if __name__ == '__main__':
     # ============================================================
 
     # normal equity order
+    # normal equity order
+    # leg_in_or_out: Currently, only the US market is supported.
+    #   Specifies whether this order is adding or removing a leg from an existing position.
+    #   LEG_IN: Add this leg to an existing position to form a multi-leg strategy.
+    #   LEG_OUT: Close this leg from an existing multi-leg strategy position.
+    # position_id: Currently, only the US market is supported.
+    #   The unique position identifier of the target leg. Obtained from the Account Positions API.
+    #   Required when leg_in_or_out is specified.
+    # leg_in_strategy: Currently, only the US market is supported.
+    #   The target strategy type expected after legging in. Only applicable when leg_in_or_out is LEG_IN.
+    #   (e.g., VERTICAL, CALENDAR, STRANGLE, STRADDLE, IRON_CONDOR, BUTTERFLY, CUSTOM).
     normal_equity_client_order_id = uuid.uuid4().hex
     print('client order id:', normal_equity_client_order_id)
     new_normal_equity_orders = [
@@ -76,6 +87,9 @@ if __name__ == '__main__':
             "side": "BUY",
             "time_in_force": "DAY",
             "entrust_type": "QTY",
+            "leg_in_or_out": "LEG_IN",
+            "position_id": "<your_position_id>",
+            "leg_in_strategy": "VERTICAL",
             # Currently, only Webull JP is supported.
             # "account_tax_type":"GENERAL",
             # "margin_type": "ONE_DAY"
@@ -119,6 +133,9 @@ if __name__ == '__main__':
     if res.status_code == 200:
         print('get order detail res:', res.json())
 
+    res = trade_client.order_v3.get_order_executions(account_id, client_order_id= "", start_date="2026-01-20", end_date="2026-01-23")
+    if res.status_code == 200:
+        print('get order executions res:', res.json())
 
 
     # combo equity order
@@ -257,6 +274,15 @@ if __name__ == '__main__':
 
     # normal option order
     # position_intent: Currently, only the US market is supported, and only options orders are allowed.
+    # leg_in_or_out: Currently, only the US market is supported.
+    #   Specifies whether this leg is being legged into or legged out of an existing position.
+    #   LEG_IN: Add this leg to an existing position.
+    #   LEG_OUT: Close this leg from an existing multi-leg strategy position.
+    # position_id: Currently, only the US market is supported.
+    #   The unique position identifier of the target leg to be legged in or legged out. Obtained from the Account Positions API. Required when leg_in_or_out is specified.
+    # leg_in_strategy: Currently, only the US market is supported.
+    #   The target strategy type expected after legging in. Specifies what multi-leg strategy the position should become once this leg is added. Only applicable when leg_in_or_out is LEG_IN.
+    #   (e.g., VERTICAL, CALENDAR, STRANGLE, STRADDLE, IRON_CONDOR, BUTTERFLY, CUSTOM).
     normal_option_client_order_id = uuid.uuid4().hex
     new_normal_option_orders = [
         {
@@ -270,6 +296,9 @@ if __name__ == '__main__':
             "time_in_force": "GTC",
             "entrust_type": "QTY",
             "position_intent": "BUY_TO_OPEN",
+            "leg_in_or_out": "LEG_IN",
+            "position_id": "<your_position_id>",
+            "leg_in_strategy": "VERTICAL",
             "legs": [
                 {
                     "side": "BUY",

webull_openapi_python_sdk-2.0.18/webull/__init__.py

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

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.0.16'
+__version__ = '2.0.17'
 
 import logging
 

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull/core/http/initializer/token/bean/access_token.py

@@ -34,7 +34,8 @@
 # coding=utf-8
 
 class AccessToken:
-    def __init__(self, token, expires, status):
+    def __init__(self, token, expires, status, expires_at=None):
         self.token = token
         self.expires = expires
-        self.status = status
+        self.status = status
+        self.expires_at = expires_at

webull_openapi_python_sdk-2.0.18/webull/data/__init__.py

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

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull/data/quotes/instrument.py

@@ -32,14 +32,15 @@ class Instrument:
     def __init__(self, api_client):
         self.client = api_client
 
-    def get_instrument(self, symbols=None, category=Category.US_STOCK.name, status=None, last_instrument_id=None,
-                       page_size=1000):
+    def get_instrument(self, symbols=None, category=Category.US_STOCK.name, status=None, sub_category=None,
+                       last_instrument_id=None, page_size=1000):
         """
          Query the underlying information according to the security symbol list and security type.
 
         :param symbols: Securities symbol, such as: 00700,00981.
         :param category: Security type, enumeration.
         :param status: Tradable status.
+        :param sub_category: Security sub category.
         :param last_instrument_id: Last instrument id for pagination.
         :param page_size: Page size, default 1000.
         """
@@ -47,6 +48,7 @@ class Instrument:
         instruments_request.set_symbols(symbols)
         instruments_request.set_category(category)
         instruments_request.set_status(status)
+        instruments_request.set_sub_category(sub_category)
         instruments_request.set_last_instrument_id(last_instrument_id)
         instruments_request.set_page_size(page_size)
         response = self.client.get_response(instruments_request)

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull/data/request/get_instruments_request.py

@@ -33,6 +33,10 @@ class GetInstrumentsRequest(ApiRequest):
         if status:
             self.add_query_param("status", status)
 
+    def set_sub_category(self, sub_category):
+        if sub_category:
+            self.add_query_param("sub_category", sub_category)
+
     def set_last_instrument_id(self, last_instrument_id):
         if last_instrument_id:
             self.add_query_param("last_instrument_id", last_instrument_id)

webull_openapi_python_sdk-2.0.18/webull/trade/__init__.py

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

webull_openapi_python_sdk-2.0.18/webull/trade/request/v2/get_order_executions_request.py

@@ -0,0 +1,38 @@
+# 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.
+
+from webull.core.request import ApiRequest
+
+
+class GetOrderExecutionsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/orders/executions/list", version='v2', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_client_order_id(self, client_order_id):
+        self.add_query_param("client_order_id", client_order_id)
+
+    def set_start_date(self, start_date):
+        self.add_query_param("start_date", start_date)
+
+    def set_end_date(self, end_date):
+        self.add_query_param("end_date", end_date)
+
+    def set_last_execution_id(self, last_execution_id):
+        self.add_query_param("last_execution_id", last_execution_id)
+
+    def set_page_size(self, page_size):
+        self.add_query_param("page_size", page_size)

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull/trade/trade/v3/order_opration_v3.py

@@ -20,6 +20,7 @@ from webull.trade.request.v3.cancel_order_request import CancelOrderRequest
 from webull.trade.request.v3.get_order_detail_request import OrderDetailRequest
 from webull.trade.request.v3.get_order_history_request import OrderHistoryRequest
 from webull.trade.request.v3.get_order_open_request import OrderOpenRequest
+from webull.trade.request.v2.get_order_executions_request import GetOrderExecutionsRequest
 
 
 class OrderOperationV3:
@@ -90,6 +91,11 @@ class OrderOperationV3:
         """
         This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK, Webull BR, Webull MX, Webull ZA, Webull EU.
         Support for other regions will be available in future updates.
+
+        Response fields (per order item, US market only):
+        - leg_in_or_out: Indicates whether this order is legging in or out. Values: LEG_IN, LEG_OUT.
+        - position_id: The unique position identifier of the target leg.
+        - leg_in_strategy: The target strategy type after legging in (e.g., VERTICAL, CALENDAR, STRANGLE, STRADDLE, IRON_CONDOR, BUTTERFLY, CUSTOM).
         """
         order_detail_request = OrderDetailRequest()
         order_detail_request.set_account_id(account_id=account_id)
@@ -111,6 +117,11 @@ class OrderOperationV3:
         :param end_date: End date (if empty, the default is the last 7 days), in the format of yyyy-MM-dd.
         :param last_client_order_id: The last client order ID from the previous response. For the first page query,
         this parameter is not required.
+
+        Response fields (per order item, US market only):
+        - leg_in_or_out: Indicates whether this order is legging in or out. Values: LEG_IN, LEG_OUT.
+        - position_id: The unique position identifier of the target leg.
+        - leg_in_strategy: The target strategy type after legging in (e.g., VERTICAL, CALENDAR, STRANGLE, STRADDLE, IRON_CONDOR, BUTTERFLY, CUSTOM).
         """
         order_history_request = OrderHistoryRequest()
         order_history_request.set_account_id(account_id=account_id)
@@ -136,6 +147,11 @@ class OrderOperationV3:
         :param page_size: Limit the number of records per query to 10 by default.
         :param last_client_order_id: The last client order ID from the previous response. For the first page query,
         this parameter is not required.
+
+        Response fields (per order item, US market only):
+        - leg_in_or_out: Indicates whether this order is legging in or out. Values: LEG_IN, LEG_OUT.
+        - position_id: The unique position identifier of the target leg.
+        - leg_in_strategy: The target strategy type after legging in (e.g., VERTICAL, CALENDAR, STRANGLE, STRADDLE, IRON_CONDOR, BUTTERFLY, CUSTOM).
         """
         order_open_request = OrderOpenRequest()
         order_open_request.set_account_id(account_id=account_id)
@@ -145,3 +161,33 @@ class OrderOperationV3:
             order_open_request.set_last_client_order_id(last_client_order_id=last_client_order_id)
         response = self.client.get_response(order_open_request)
         return response
+
+    def get_order_executions(self, account_id, client_order_id=None, start_date=None, end_date=None, last_execution_id=None, page_size=None):
+        """
+        This interface is currently supported only for Webull HK.
+        Support for other regions will be available in future updates.
+
+        Query order execution records within a specified date range.
+
+        :param account_id: Account ID (required).
+        :param client_order_id: The 3rd party order ID.
+        :param start_date: Start date in the format of yyyy-MM-dd.
+        :param end_date: End date in the format of yyyy-MM-dd.
+        :param last_execution_id: The last execution ID from the previous response. For the first page query,
+        this parameter is not required.
+        :param page_size: Number of records per page, defaults to 10.
+        """
+        request = GetOrderExecutionsRequest()
+        request.set_account_id(account_id)
+        if start_date:
+            request.set_start_date(start_date)
+        if end_date:
+            request.set_end_date(end_date)
+        if last_execution_id:
+            request.set_last_execution_id(last_execution_id)
+        if client_order_id:
+            request.set_client_order_id(client_order_id)
+        if page_size:
+            request.set_page_size(page_size)
+        response = self.client.get_response(request)
+        return response

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull_openapi_python_sdk.egg-info/PKG-INFO

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

{webull_openapi_python_sdk-2.0.16 → webull_openapi_python_sdk-2.0.18}/webull_openapi_python_sdk.egg-info/SOURCES.txt

@@ -280,6 +280,7 @@ 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_executions_request.py
 webull/trade/request/v2/get_order_history_request.py
 webull/trade/request/v2/get_order_open_request.py
 webull/trade/request/v2/palce_order_request.py

webull_openapi_python_sdk-2.0.16/samples/__init__.py

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

webull_openapi_python_sdk-2.0.16/webull/__init__.py

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

webull_openapi_python_sdk-2.0.16/webull/data/__init__.py

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

webull_openapi_python_sdk-2.0.16/webull/trade/__init__.py

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