webull-openapi-python-sdk 3.0.1__tar.gz → 3.0.2__tar.gz

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.2}/PKG-INFO

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

webull_openapi_python_sdk-3.0.2/samples/__init__.py

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

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.2}/samples/trade/trade_client_v3.py

@@ -18,6 +18,7 @@ from time import sleep
 
 from webull.core.client import ApiClient
 from webull.trade.trade_client import TradeClient
+from webull.trade.common.transfer_activities_param import TransferActivitiesParam
 
 optional_api_endpoint = "<api_endpoint>"
 your_app_key = "<your_app_key>"
@@ -888,3 +889,40 @@ if __name__ == '__main__':
     res = trade_client.order_v3.get_order_detail(account_id, trailing_stop_loss_limit_client_order_id)
     if res.status_code == 200:
         print('get trailing stop loss limit order detail res:', res.json())
+
+    # ============================================================
+    # Position Transfers Example (US only)
+    # ============================================================
+
+    # First page: pass no pagination_key and no filters.
+    res = trade_client.activity.list_transfers_activities(TransferActivitiesParam(account_id))
+    if res.status_code == 200:
+        print('list transfers activities res:', res.json())
+
+    # Iterate all pages using the returned pagination_key until it is absent.
+    pagination_key = (res.json() or {}).get('pagination_key') if res.status_code == 200 else None
+    while pagination_key:
+        res = trade_client.activity.list_transfers_activities(
+            TransferActivitiesParam(account_id, pagination_key=pagination_key))
+        if res.status_code != 200:
+            break
+        print('list transfers activities next page res:', res.json())
+        pagination_key = (res.json() or {}).get('pagination_key')
+
+    # Filtered query: ACATS/crypto incoming transfers, FULL type, within a time range.
+    res = trade_client.activity.list_transfers_activities(
+        TransferActivitiesParam(
+            account_id,
+            transfer_method="ACATS,CRYPTO_TRANSFER",
+            direction="INCOMING",
+            status="PENDING,COMPLETED",
+            acats_transfer_types="FULL",
+            start_time="2026-08-01T00:00:00Z",
+            end_time="2026-08-31T23:59:59Z"))
+    if res.status_code == 200:
+        print('list transfers activities filtered res:', res.json())
+
+    # Get a single transfer record by account_id and transfer_id.
+    res = trade_client.activity.get_transfer_activity_detail(account_id, transfer_id="<your_transfer_id>")
+    if res.status_code == 200:
+        print('get transfer activity res:', res.json())

webull_openapi_python_sdk-3.0.2/webull/__init__.py

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

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.2}/webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '3.0.1'
+__version__ = '3.0.2'
 
 import logging
 

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.2}/webull/core/utils/validation.py

@@ -46,4 +46,11 @@ def assert_integer_positive(integer, name):
     if isinstance(integer, int) and integer > 0:
         return
     raise ClientException(error_code.SDK_INVALID_PARAMETER,
-                          "{0} should be a positive integer.".format(name))
+                          "{0} should be a positive integer.".format(name))
+
+
+def assert_string_not_empty(value, name):
+    if isinstance(value, str) and value.strip():
+        return
+    raise ClientException(error_code.SDK_INVALID_PARAMETER,
+                          "{0} should not be empty.".format(name))

webull_openapi_python_sdk-3.0.2/webull/data/__init__.py

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

webull_openapi_python_sdk-3.0.2/webull/trade/__init__.py

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

webull_openapi_python_sdk-3.0.2/webull/trade/common/transfer_activities_param.py

@@ -0,0 +1,44 @@
+# 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.utils import validation
+
+
+class TransferActivitiesParam:
+    """
+    Parameter object for :meth:`Activity.list_transfers_activities`.
+
+    :param account_id: Account ID (required).
+    :param transfer_method: Transfer method filter, comma-separated (e.g. ACATS,CRYPTO_TRANSFER) (optional).
+    :param direction: Direction filter: INCOMING or OUTGOING (optional).
+    :param status: Status filter, comma-separated: PENDING, COMPLETED, REJECTED, FAILED, CANCELLED (optional).
+    :param acats_transfer_types: ACATS transfer types filter, comma-separated: FULL, PARTIAL, RESIDUAL, RECLAIM, OTHER (optional).
+    :param start_time: ISO8601 UTC start time of transfer create time (optional).
+    :param end_time: ISO8601 UTC end time of transfer create time (optional).
+    :param pagination_key: Pagination key from the previous page response; not returned on the last page (optional).
+    """
+
+    def __init__(self, account_id, transfer_method=None, direction=None, status=None,
+                 acats_transfer_types=None, start_time=None, end_time=None, pagination_key=None):
+        validation.assert_string_not_empty(account_id, "account_id")
+        self.account_id = account_id
+        self.transfer_method = transfer_method
+        self.direction = direction
+        self.status = status
+        self.acats_transfer_types = acats_transfer_types
+        self.start_time = start_time
+        self.end_time = end_time
+        self.pagination_key = pagination_key

webull_openapi_python_sdk-3.0.2/webull/trade/request/v3/get_transfer_activities_detail_request.py

@@ -0,0 +1,28 @@
+# 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 TransferActivitiesDetailRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/activities/transfer-activities/get", version='v3', method="GET",
+                            query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_transfer_id(self, transfer_id):
+        self.add_query_param("transfer_id", transfer_id)

webull_openapi_python_sdk-3.0.2/webull/trade/request/v3/get_transfer_activities_request.py

@@ -0,0 +1,55 @@
+# 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
+from webull.core.utils import validation
+
+
+class TransferActivitiesRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/activities/transfer-activities/list", version='v3', method="GET",
+                            query_params={})
+
+    def set_account_id(self, account_id):
+        validation.assert_string_not_empty(account_id, "account_id")
+        self.add_query_param("account_id", account_id)
+
+    def set_transfer_method(self, transfer_method):
+        if transfer_method is not None:
+            self.add_query_param("transfer_method", transfer_method)
+
+    def set_direction(self, direction):
+        if direction is not None:
+            self.add_query_param("direction", direction)
+
+    def set_status(self, status):
+        if status is not None:
+            self.add_query_param("status", status)
+
+    def set_acats_transfer_types(self, acats_transfer_types):
+        if acats_transfer_types is not None:
+            self.add_query_param("acats_transfer_types", acats_transfer_types)
+
+    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_openapi_python_sdk-3.0.2/webull/trade/trade/activity.py

@@ -0,0 +1,155 @@
+# 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.common.region import Region
+from webull.core.exception import error_code
+from webull.core.exception.exceptions import ClientException
+from webull.trade.request.get_activities_request import GetActivitiesRequest
+from webull.trade.request.get_activities_request_v2 import GetActivitiesRequestV2
+from webull.trade.request.v3.get_transfer_activities_request import TransferActivitiesRequest
+from webull.trade.request.v3.get_transfer_activities_detail_request import TransferActivitiesDetailRequest
+from webull.trade.common.transfer_activities_param import TransferActivitiesParam
+
+
+class Activity:
+    def __init__(self, api_client):
+        self.client = api_client
+
+    def _assert_us_region(self, operation):
+        region_id = self.client.get_region_id()
+        if region_id != Region.US.value:
+            raise ClientException(
+                error_code.SDK_NOT_SUPPORT,
+                "%s is currently supported only for Webull US region, current region is %s." % (
+                    operation, region_id))
+
+    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.
+
+        :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 last_activity_id: The last activity ID of the previous page for cursor-based pagination (optional)
+        :param page_size: Number of entries per page, default value is 10
+        """
+        get_activities_request = GetActivitiesRequest()
+        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 last_activity_id is not None:
+            get_activities_request.set_last_activity_id(last_activity_id)
+        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
+
+    def list_transfers_activities(self, param):
+        """
+        Query transfer records with pagination support. Results are ordered by create time descending.
+        Routes to ACATS or crypto transfer downstream by account type.
+        This interface is currently supported only for Webull US.
+
+        Each record is a summary view containing: account_id, transfer_method, transfer_id, direction,
+        status, failure_reason, acats_associated_number, acats_transfer_types, create_time, update_time,
+        transfer_settlement_date. Detailed fields (acats_control_number, contra_broker, crypto_transaction_hash,
+        crypto_from_address, crypto_to_address, cash, positions) are returned only by get_transfer_activity.
+
+        :param param: A :class:`TransferActivitiesParam` object carrying account_id and optional filters.
+        """
+        self._assert_us_region("list_transfers_activities")
+        if not isinstance(param, TransferActivitiesParam):
+            raise ClientException(
+                error_code.SDK_INVALID_PARAMETER,
+                "param should be a TransferActivitiesParam object.")
+        get_transfers_request = TransferActivitiesRequest()
+        get_transfers_request.set_account_id(param.account_id)
+        if param.transfer_method is not None:
+            get_transfers_request.set_transfer_method(param.transfer_method)
+        if param.direction is not None:
+            get_transfers_request.set_direction(param.direction)
+        if param.status is not None:
+            get_transfers_request.set_status(param.status)
+        if param.acats_transfer_types is not None:
+            get_transfers_request.set_acats_transfer_types(param.acats_transfer_types)
+        if param.start_time is not None:
+            get_transfers_request.set_start_time(param.start_time)
+        if param.end_time is not None:
+            get_transfers_request.set_end_time(param.end_time)
+        if param.pagination_key is not None:
+            get_transfers_request.set_pagination_key(param.pagination_key)
+        response = self.client.get_response(get_transfers_request)
+        return response
+
+    def get_transfer_activity_detail(self, account_id, transfer_id):
+        """
+        Get a single transfer record by account ID and transfer ID.
+        This interface is currently supported only for Webull US.
+
+        Returns the full detail view. In addition to the summary fields from list_transfers_activities,
+        it also includes: acats_control_number, contra_broker (broker_name, dtc_number, account_type,
+        account_number), crypto_transaction_hash, crypto_from_address, crypto_to_address, cash
+        (amount, currency, settlement_date) and positions (asset_type is one of EQUITY, OPTION, FUTURES,
+        CRYPTO, EVENT, MUTUAL_FUND, BOND; plus symbol, name, cusip, quantity, fee_quantity, total_quantity,
+        transfer_price, settlement_date).
+
+        :param account_id: Account ID
+        :param transfer_id: Transfer record ID
+        """
+        self._assert_us_region("get_transfer_activity_detail")
+        get_transfer_request = TransferActivitiesDetailRequest()
+        get_transfer_request.set_account_id(account_id)
+        get_transfer_request.set_transfer_id(transfer_id)
+        response = self.client.get_response(get_transfer_request)
+        return response

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.2}/webull_openapi_python_sdk.egg-info/PKG-INFO

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

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.2}/webull_openapi_python_sdk.egg-info/SOURCES.txt

@@ -259,6 +259,7 @@ webull/trade/common/position_intent.py
 webull/trade/common/trade_policy.py
 webull/trade/common/trading_date_type.py
 webull/trade/common/trailing_type.py
+webull/trade/common/transfer_activities_param.py
 webull/trade/events/__init__.py
 webull/trade/events/default_retry_policy.py
 webull/trade/events/events_pb2.py
@@ -314,6 +315,8 @@ webull/trade/request/v3/get_order_history_request.py
 webull/trade/request/v3/get_order_history_request_v2.py
 webull/trade/request/v3/get_order_open_request.py
 webull/trade/request/v3/get_order_open_request_v2.py
+webull/trade/request/v3/get_transfer_activities_detail_request.py
+webull/trade/request/v3/get_transfer_activities_request.py
 webull/trade/request/v3/place_order_request.py
 webull/trade/request/v3/preview_order_request.py
 webull/trade/request/v3/replace_order_request.py

webull_openapi_python_sdk-3.0.1/samples/__init__.py

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

webull_openapi_python_sdk-3.0.1/webull/__init__.py

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

webull_openapi_python_sdk-3.0.1/webull/data/__init__.py

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

webull_openapi_python_sdk-3.0.1/webull/trade/__init__.py

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

webull_openapi_python_sdk-3.0.1/webull/trade/trade/activity.py

@@ -1,82 +0,0 @@
-# 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.trade.request.get_activities_request import GetActivitiesRequest
-from webull.trade.request.get_activities_request_v2 import GetActivitiesRequestV2
-
-
-class Activity:
-    def __init__(self, api_client):
-        self.client = api_client
-
-    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.
-
-        :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 last_activity_id: The last activity ID of the previous page for cursor-based pagination (optional)
-        :param page_size: Number of entries per page, default value is 10
-        """
-        get_activities_request = GetActivitiesRequest()
-        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 last_activity_id is not None:
-            get_activities_request.set_last_activity_id(last_activity_id)
-        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