Merge branch 'main_merge_261010' into 'main'

feat: support community-related capabilities for  Webull US

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

Author: 方佳

samples/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.2'
+__version__ = '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/__init__.py

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

webull/core/__init__.py

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

webull/data/__init__.py

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

webull/data/data_client.py

@@ -27,6 +27,7 @@
 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 @@ def __init__(self, api_client):
         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/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/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/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/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)