webull-openapi-python-sdk 2.0.19__py3-none-any.whl → 3.0.0__py3-none-any.whl

webull/trade/request/v2/place_option_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class PlaceOptionRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/option/order/place", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/trade/option/order/place", version='v3', method="POST", body_params={})
 
     def set_new_orders(self, new_orders):
         self.add_body_params("new_orders", new_orders)

webull/trade/request/v2/place_order_request.py

@@ -18,7 +18,7 @@ from webull.core.request import ApiRequest
 
 class PlaceOrderRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/stock/order/place", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/trade/stock/order/place", version='v3', method="POST", body_params={})
 
     def set_new_orders(self, new_orders):
         self.add_body_params("new_orders", new_orders)

webull/trade/request/v2/preview_option_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class PreviewOptionRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/option/order/preview", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/trade/option/order/preview", version='v3', method="POST", body_params={})
 
     def set_new_orders(self, new_orders):
         self.add_body_params("new_orders", new_orders)

webull/trade/request/v2/preview_order_request.py

@@ -16,7 +16,7 @@ from webull.core.request import ApiRequest
 
 class PreviewOrderRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/stock/order/preview", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/trade/stock/order/preview", version='v3', method="POST", body_params={})
 
     def set_new_orders(self, new_orders):
         self.add_body_params("new_orders", new_orders)

webull/trade/request/v2/replace_option_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class ReplaceOptionRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/option/order/replace", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/trade/option/order/replace", version='v3', method="POST", body_params={})
 
     def set_modify_orders(self, modify_orders):
         self.add_body_params("modify_orders", modify_orders)

webull/trade/request/v2/replace_order_request.py

@@ -16,7 +16,7 @@ from webull.core.request import ApiRequest
 
 class ReplaceOrderRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/trade/stock/order/replace", version='v2', method="POST", body_params={})
+        ApiRequest.__init__(self, "/openapi/trade/stock/order/replace", version='v3', method="POST", body_params={})
 
     def set_modify_orders(self, modify_orders):
         self.add_body_params("modify_orders", modify_orders)

webull/trade/request/v3/batch_place_order_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class BatchPlaceOrderRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/order/batch-place", version='v2', method="POST", body_params={})
+        super().__init__("/trading/orders/batch-place", version='v3', method="POST", body_params={})
 
     def set_account_id(self, account_id):
         self.add_body_params("account_id", account_id)

webull/trade/request/v3/cancel_order_request.py

@@ -18,7 +18,7 @@ from webull.core.request import ApiRequest
 
 class CancelOrderRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/trade/order/cancel", version='v2', method="POST", body_params={})
+        ApiRequest.__init__(self, "/trading/orders/cancel", version='v3', method="POST", body_params={})
 
     def set_account_id(self, account_id):
         self.add_body_params("account_id", account_id)

webull/trade/request/v3/get_order_detail_request.py

@@ -17,7 +17,7 @@ from webull.core.request import ApiRequest
 
 class OrderDetailRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/trade/order/detail", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/trading/orders/get", version='v3', method="GET", query_params={})
 
     def set_account_id(self, account_id):
         self.add_query_param("account_id", account_id)

webull/trade/request/v3/get_order_history_request.py

@@ -16,8 +16,12 @@ from webull.core.request import ApiRequest
 
 
 class OrderHistoryRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`OrderHistoryRequestV2` instead.
+    """
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/trade/order/history", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/trading/orders/historical-orders/list", version='v2', method="GET", query_params={})
 
     def set_account_id(self, account_id):
         self.add_query_param("account_id", account_id)

webull/trade/request/v3/get_order_history_request_v2.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.
+
+from webull.core.request import ApiRequest
+
+
+class OrderHistoryRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/orders/historical-orders/list", version='v3', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_start_time(self, start_time):
+        if start_time is not None:
+            self.add_query_param("start_time", start_time)
+
+    def set_end_time(self, end_time):
+        if end_time is not None:
+            self.add_query_param("end_time", end_time)
+
+    def set_pagination_key(self, pagination_key):
+        if pagination_key:
+            self.add_query_param("pagination_key", pagination_key)

webull/trade/request/v3/get_order_open_request.py

@@ -16,8 +16,12 @@ from webull.core.request import ApiRequest
 
 
 class OrderOpenRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`OrderOpenRequestV2` instead.
+    """
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/trade/order/open", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/trading/orders/open-orders/list", version='v2', method="GET", query_params={})
 
     def set_account_id(self, account_id):
         self.add_query_param("account_id", account_id)

webull/trade/request/v3/get_order_open_request_v2.py

@@ -0,0 +1,27 @@
+# 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 OrderOpenRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/orders/open-orders/list", version='v3', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_pagination_key(self, pagination_key):
+        if pagination_key:
+            self.add_query_param("pagination_key", pagination_key)

webull/trade/request/v3/place_order_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class PlaceOrderRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/order/place", version='v2', method="POST", body_params={})
+        super().__init__("/trading/orders/place", version='v3', method="POST", body_params={})
 
     def set_new_orders(self, new_orders):
         self.add_body_params("new_orders", new_orders)

webull/trade/request/v3/preview_order_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class PreviewOrderRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/trade/order/preview", version='v2', method="POST", body_params={})
+        super().__init__("/trading/orders/preview", version='v3', method="POST", body_params={})
 
     def set_new_orders(self, new_orders):
         self.add_body_params("new_orders", new_orders)

webull/trade/request/v3/replace_order_request.py

@@ -18,7 +18,7 @@ from webull.core.request import ApiRequest
 
 class ReplaceOrderRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/trade/order/replace", version='v2', method="POST", body_params={})
+        ApiRequest.__init__(self, "/trading/orders/replace", version='v3', method="POST", body_params={})
 
     def set_modify_orders(self, modify_orders):
         self.add_body_params("modify_orders", modify_orders)

webull/trade/trade/activity.py

@@ -15,6 +15,7 @@
 # coding=utf-8
 
 from webull.trade.request.get_activities_request import GetActivitiesRequest
+from webull.trade.request.get_activities_request_v2 import GetActivitiesRequestV2
 
 
 class Activity:
@@ -24,6 +25,11 @@ class Activity:
     def get_activities(self, account_id, activity_types=None, start_time=None, end_time=None,
                        last_activity_id=None, page_size=10):
         """
+        .. deprecated::
+            Use :meth:`list_activities` instead.
+
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
         Query cash activities by type with pagination support.
         This interface is currently supported only for Webull US.
 
@@ -47,3 +53,30 @@ class Activity:
         get_activities_request.set_page_size(page_size)
         response = self.client.get_response(get_activities_request)
         return response
+
+    def list_activities(self, account_id, activity_types=None, start_time=None, end_time=None,
+                        pagination_key=None):
+        """
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
+        Query cash activities by type with pagination support.
+        This interface is currently supported only for Webull US.
+
+        :param account_id: Account ID
+        :param activity_types: Activity types filter, comma-separated string (optional)
+        :param start_time: Start time filter (optional)
+        :param end_time: End time filter (optional)
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        get_activities_request = GetActivitiesRequestV2()
+        get_activities_request.set_account_id(account_id)
+        if activity_types is not None:
+            get_activities_request.set_activity_types(activity_types)
+        if start_time is not None:
+            get_activities_request.set_start_time(start_time)
+        if end_time is not None:
+            get_activities_request.set_end_time(end_time)
+        if pagination_key is not None:
+            get_activities_request.set_pagination_key(pagination_key)
+        response = self.client.get_response(get_activities_request)
+        return response

webull/trade/trade/v2/account_info_v2.py

@@ -16,6 +16,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_position_details_request_v2 import AccountPositionDetailsRequestV2
 from webull.trade.request.v2.get_account_positions_request import AccountPositionsRequest
 
 
@@ -54,6 +55,11 @@ class AccountV2:
 
     def get_account_position_details(self, account_id, instrument_id, page_size=None, last_id=None):
         """
+        .. deprecated::
+            Use :meth:`list_position_details` instead.
+
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
         This interface is currently supported only for Webull JP.
         Support for other regions will be available in future updates.
         """
@@ -64,3 +70,21 @@ class AccountV2:
         account_position_details_request.set_last_id(last_id)
         response = self.client.get_response(account_position_details_request)
         return response
+
+    def list_position_details(self, account_id, instrument_id, pagination_key=None):
+        """
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
+        This interface is currently supported only for Webull JP.
+        Support for other regions will be available in future updates.
+
+        :param account_id: Account ID
+        :param instrument_id: Instrument ID
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        account_position_details_request = AccountPositionDetailsRequestV2()
+        account_position_details_request.set_account_id(account_id)
+        account_position_details_request.set_instrument_id(instrument_id)
+        account_position_details_request.set_pagination_key(pagination_key)
+        response = self.client.get_response(account_position_details_request)
+        return response

webull/trade/trade/v3/{order_opration_v3.py → order_operation_v3.py}

@@ -19,8 +19,11 @@ from webull.trade.request.v3.replace_order_request import ReplaceOrderRequest
 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_history_request_v2 import OrderHistoryRequestV2
 from webull.trade.request.v3.get_order_open_request import OrderOpenRequest
+from webull.trade.request.v3.get_order_open_request_v2 import OrderOpenRequestV2
 from webull.trade.request.v2.get_order_executions_request import GetOrderExecutionsRequest
+from webull.trade.request.v2.get_order_executions_request_v2 import GetOrderExecutionsRequestV2
 
 
 class OrderOperationV3:
@@ -105,9 +108,14 @@ class OrderOperationV3:
 
     def get_order_history(self, account_id, page_size=None, start_date=None, end_date=None, last_client_order_id=None):
         """
+        .. deprecated::
+            Use :meth:`list_order_history` instead.
+
         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.
 
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
         Historical orders. If they are group orders, will be returned together,
         and the number of orders returned on one-page may exceed the page_size.
 
@@ -136,11 +144,42 @@ class OrderOperationV3:
         response = self.client.get_response(order_history_request)
         return response
 
+    def list_order_history(self, account_id, start_time=None, end_time=None, pagination_key=None):
+        """
+        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.
+
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
+        Historical orders. If they are group orders, will be returned together,
+        and the number of orders returned on one-page may exceed the page size.
+
+        :param account_id: Account ID
+        :param start_time: Start time, format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
+        :param end_time: End time, format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        order_history_request = OrderHistoryRequestV2()
+        order_history_request.set_account_id(account_id=account_id)
+        if start_time:
+            order_history_request.set_start_time(start_time=start_time)
+        if end_time:
+            order_history_request.set_end_time(end_time=end_time)
+        if pagination_key:
+            order_history_request.set_pagination_key(pagination_key=pagination_key)
+        response = self.client.get_response(order_history_request)
+        return response
+
     def get_order_open(self, account_id, page_size=None, last_client_order_id=None):
         """
+        .. deprecated::
+            Use :meth:`list_order_open` instead.
+
         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.
 
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
         Paging query pending orders.
 
         :param account_id: Account ID
@@ -162,11 +201,36 @@ class OrderOperationV3:
         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):
+    def list_order_open(self, account_id, pagination_key=None):
+        """
+        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.
+
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
+        Paging query pending orders.
+
+        :param account_id: Account ID
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        order_open_request = OrderOpenRequestV2()
+        order_open_request.set_account_id(account_id=account_id)
+        if pagination_key:
+            order_open_request.set_pagination_key(pagination_key=pagination_key)
+        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):
         """
+        .. deprecated::
+            Use :meth:`list_order_executions` instead.
+
         This interface is currently supported only for Webull HK.
         Support for other regions will be available in future updates.
 
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
         Query order execution records within a specified date range.
 
         :param account_id: Account ID (required).
@@ -191,3 +255,32 @@ class OrderOperationV3:
             request.set_page_size(page_size)
         response = self.client.get_response(request)
         return response
+
+    def list_order_executions(self, account_id, client_order_id=None, start_date=None, end_date=None,
+                             pagination_key=None):
+        """
+        This interface is currently supported only for Webull HK.
+        Support for other regions will be available in future updates.
+
+        The x-version header distinguishes the legacy and new pagination protocols for this path.
+
+        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 pagination_key: Pagination key from previous response for next page.
+        """
+        request = GetOrderExecutionsRequestV2()
+        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 client_order_id:
+            request.set_client_order_id(client_order_id)
+        if pagination_key is not None:
+            request.set_pagination_key(pagination_key)
+        response = self.client.get_response(request)
+        return response

webull/trade/trade_client.py

@@ -22,7 +22,7 @@ from webull.trade.trade.trade_calendar import TradeCalendar
 from webull.trade.trade.trade_instrument import TradeInstrument
 from webull.trade.trade.v2.account_info_v2 import AccountV2
 from webull.trade.trade.v2.order_operation_v2 import OrderOperationV2
-from webull.trade.trade.v3.order_opration_v3 import OrderOperationV3
+from webull.trade.trade.v3.order_operation_v3 import OrderOperationV3
 
 
 class TradeClient:

{webull_openapi_python_sdk-2.0.19.dist-info → webull_openapi_python_sdk-3.0.0.dist-info}/METADATA

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