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

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

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

webull_openapi_python_sdk-3.0.3/samples/__init__.py

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

webull_openapi_python_sdk-3.0.3/samples/data/community.py

@@ -0,0 +1,62 @@
+# 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.client import ApiClient
+from webull.data.common.category import Category
+from webull.data.data_client import DataClient
+
+optional_api_endpoint = "<api_endpoint>"
+your_app_key = "<your_app_key>"
+your_app_secret = "<your_app_secret>"
+region_id = "<region_id>"
+
+api_client = ApiClient(your_app_key, your_app_secret, region_id)
+api_client.add_endpoint(region_id, optional_api_endpoint)
+
+
+if __name__ == '__main__':
+    data_client = DataClient(api_client)
+
+    response = data_client.community.create_post(
+        "Hello, this is a test post from OpenAPI!",
+        symbol="NVDA",
+        category=Category.US_STOCK.name,
+    )
+    if response.status_code == 200:
+        print('create_post:', response.json())
+
+    response = data_client.community.create_comment(
+        "995005758239301632",
+        "Hello, this is a test comment from OpenAPI!",
+    )
+    if response.status_code == 200:
+        print('create_comment:', response.json())
+
+    response = data_client.community.list_hot_stocks()
+    if response.status_code == 200:
+        print('list_hot_stocks:', response.json())
+
+    response = data_client.community.list_posts_by_symbol("NVDA", Category.US_STOCK.name)
+    if response.status_code == 200:
+        print('list_posts_by_symbol:', response.json())
+
+    response = data_client.community.get_post("995005758239301632")
+    if response.status_code == 200:
+        print('get_post:', response.json())
+
+    response = data_client.community.list_my_posts()
+    if response.status_code == 200:
+        print('list_my_posts:', response.json())

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.3}/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.3/webull/__init__.py

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

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

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

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.3}/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.3/webull/data/__init__.py

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

{webull_openapi_python_sdk-3.0.1 → webull_openapi_python_sdk-3.0.3}/webull/data/data_client.py

@@ -27,6 +27,7 @@ from webull.data.quotes.option_market_data import OptionMarketData
 from webull.data.quotes.fundamentals import Fundamentals
 from webull.data.quotes.screener import Screener
 from webull.data.quotes.watchlist import Watchlist
+from webull.data.quotes.community import Community
 
 
 class DataClient:
@@ -42,6 +43,7 @@ class DataClient:
         self.fundamentals = Fundamentals(api_client)
         self.screener = Screener(api_client)
         self.watchlist = Watchlist(api_client)
+        self.community = Community(api_client)
 
     def _init_logger(self, api_client):
         # No logger configured, using default console and local file logging.

webull_openapi_python_sdk-3.0.3/webull/data/quotes/community.py

@@ -0,0 +1,105 @@
+# 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.data.request.create_comment_request import CreateCommentRequest
+from webull.data.request.create_post_request import CreatePostRequest
+from webull.data.request.get_post_request import GetPostRequest
+from webull.data.request.list_hot_stocks_request import ListHotStocksRequest
+from webull.data.request.list_my_posts_request import ListMyPostsRequest
+from webull.data.request.list_posts_by_symbol_request import ListPostsBySymbolRequest
+
+
+class Community:
+    """Community API operations."""
+
+    def __init__(self, api_client):
+        self.client = api_client
+
+    def create_post(self, text, symbol=None, category=None):
+        """
+        Create a plain-text community post.
+
+        :param text: Post content.
+        :param symbol: Optional ticker symbol. Provide it with category.
+        :param category: Optional ticker market category. Provide it with symbol.
+        :return: Response containing the created post identifier.
+        """
+        request = CreatePostRequest()
+        request.set_text(text)
+        request.set_symbol(symbol)
+        request.set_category(category)
+        return self.client.get_response(request)
+
+    def create_comment(self, post_id, text):
+        """
+        Create a plain-text comment on an existing community post.
+
+        :param post_id: Parent post identifier.
+        :param text: Comment content.
+        :return: Response containing the created comment identifier.
+        """
+        request = CreateCommentRequest()
+        request.set_post_id(post_id)
+        request.set_text(text)
+        return self.client.get_response(request)
+
+    def list_hot_stocks(self):
+        """
+        List stocks ranked by community activity.
+
+        :return: Response containing hot stock ranking entries.
+        """
+        request = ListHotStocksRequest()
+        return self.client.get_response(request)
+
+    def list_posts_by_symbol(self, symbol, category, keyword=None, pagination_key=None):
+        """
+        List community posts associated with a symbol.
+
+        :param symbol: Stock symbol.
+        :param category: Market category.
+        :param keyword: Optional search keyword.
+        :param pagination_key: Optional key from the previous response.
+        :return: Paginated post list response.
+        """
+        request = ListPostsBySymbolRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_keyword(keyword)
+        request.set_pagination_key(pagination_key)
+        return self.client.get_response(request)
+
+    def get_post(self, post_id):
+        """
+        Get detailed information for a community post.
+
+        :param post_id: Post identifier.
+        :return: Post detail response.
+        """
+        request = GetPostRequest()
+        request.set_post_id(post_id)
+        return self.client.get_response(request)
+
+    def list_my_posts(self, pagination_key=None):
+        """
+        List posts created by the current user.
+
+        :param pagination_key: Optional key from the previous response.
+        :return: Paginated post list response.
+        """
+        request = ListMyPostsRequest()
+        request.set_pagination_key(pagination_key)
+        return self.client.get_response(request)

webull_openapi_python_sdk-3.0.3/webull/data/request/create_comment_request.py

@@ -0,0 +1,33 @@
+# 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 CreateCommentRequest(ApiRequest):
+    """Request for creating a plain-text comment on a community post."""
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/communities/comments/create", version="v3", method="POST",
+                            body_params={})
+
+    def set_post_id(self, post_id):
+        """Set the parent post identifier."""
+        self.add_body_params("post_id", post_id)
+
+    def set_text(self, text):
+        """Set the comment text."""
+        self.add_body_params("text", text)

webull_openapi_python_sdk-3.0.3/webull/data/request/create_post_request.py

@@ -0,0 +1,39 @@
+# 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 CreatePostRequest(ApiRequest):
+    """Request for creating a plain-text community post."""
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/communities/posts/create", version="v3", method="POST",
+                            body_params={})
+
+    def set_text(self, text):
+        """Set the post text."""
+        self.add_body_params("text", text)
+
+    def set_symbol(self, symbol):
+        """Set the optional ticker symbol."""
+        if symbol is not None:
+            self.add_body_params("symbol", symbol)
+
+    def set_category(self, category):
+        """Set the optional ticker market category."""
+        if category is not None:
+            self.add_body_params("category", category)

webull_openapi_python_sdk-3.0.3/webull/data/request/get_post_request.py

@@ -0,0 +1,29 @@
+# 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 GetPostRequest(ApiRequest):
+    """Request for retrieving a community post by identifier."""
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/communities/posts/get", version="v3", method="GET",
+                            query_params={})
+
+    def set_post_id(self, post_id):
+        """Set the post identifier."""
+        self.add_query_param("post_id", post_id)

webull_openapi_python_sdk-3.0.3/webull/data/request/list_hot_stocks_request.py

@@ -0,0 +1,25 @@
+# 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 ListHotStocksRequest(ApiRequest):
+    """Request for listing stocks ranked by community activity."""
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/communities/stock-rankings/list", version="v3", method="GET",
+                            query_params={})

webull_openapi_python_sdk-3.0.3/webull/data/request/list_my_posts_request.py

@@ -0,0 +1,30 @@
+# 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 ListMyPostsRequest(ApiRequest):
+    """Request for listing posts created by the current user."""
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/communities/my-posts/list", version="v3", method="GET",
+                            query_params={})
+
+    def set_pagination_key(self, pagination_key):
+        """Set the optional pagination key from the previous response."""
+        if pagination_key is not None:
+            self.add_query_param("pagination_key", pagination_key)

webull_openapi_python_sdk-3.0.3/webull/data/request/list_posts_by_symbol_request.py

@@ -0,0 +1,43 @@
+# 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 ListPostsBySymbolRequest(ApiRequest):
+    """Request for listing community posts associated with a symbol."""
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/communities/posts/symbols/list", version="v3", method="GET",
+                            query_params={})
+
+    def set_symbol(self, symbol):
+        """Set the stock symbol."""
+        self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        """Set the market category."""
+        self.add_query_param("category", category)
+
+    def set_keyword(self, keyword):
+        """Set the optional search keyword."""
+        if keyword is not None:
+            self.add_query_param("keyword", keyword)
+
+    def set_pagination_key(self, pagination_key):
+        """Set the optional pagination key from the previous response."""
+        if pagination_key is not None:
+            self.add_query_param("pagination_key", pagination_key)

webull_openapi_python_sdk-3.0.3/webull/trade/__init__.py

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

webull_openapi_python_sdk-3.0.3/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.3/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.3/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)