Merge branch 'main_merge_260921' into 'main'

feat: support transfers activities for Webull US

See merge request webull/webull-openapi-python-sdk!46

Author: 方佳

samples/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1'
+__version__ = '3.0.2'

samples/trade/trade_client_v3.py

@@ -18,6 +18,7 @@
 
 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 @@
     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/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1'
+__version__ = '3.0.2'

webull/core/__init__.py

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

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/data/__init__.py

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

webull/trade/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1'
+__version__ = '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/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/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)