Merge branch 'main_merge_0908' into 'main'

feat:Update pagination for some query APIs

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

Author: 方佳

samples/screener/screener_client.py

@@ -98,8 +98,8 @@
     # Get most active stocks by turnover amount
     res = data_client.screener.get_most_active(
         category="US_STOCK",
-        rank_type="TURNOVER",
-        sort_by="TURNOVER",
+        rank_type="RELATIVE_VOLUME_10D",
+        sort_by="RELATIVE_VOLUME_10D",
         direction="DESC",
         page_size=10
     )
@@ -116,3 +116,56 @@
     )
     if res.status_code == 200:
         print('get_high_amplitude_stocks:', res.json())
+
+    # ------------------------------------------------------------------
+    # New endpoints. These rankings are not paginated and return top 200.
+    # ------------------------------------------------------------------
+
+    # Get top gainers for today (new endpoint, no pagination)
+    res = data_client.screener.list_gainers_losers(
+        rank_type="DAY_1",
+        category="US_STOCK",
+        sort_by="CHANGE_RATIO",
+        direction="DESC"
+    )
+    if res.status_code == 200:
+        print('list_gainers (day):', res.json())
+
+    # Get top losers for today (new endpoint, no pagination)
+    res = data_client.screener.list_gainers_losers(
+        rank_type="DAY_1",
+        category="US_STOCK",
+        sort_by="CHANGE_RATIO",
+        direction="ASC"
+    )
+    if res.status_code == 200:
+        print('list_losers (day):', res.json())
+
+    # Get most active stocks by volume (new endpoint, no pagination)
+    res = data_client.screener.list_most_active(
+        category="US_STOCK",
+        rank_type="VOLUME",
+        sort_by="VOLUME",
+        direction="DESC"
+    )
+    if res.status_code == 200:
+        print('list_most_active_by_volume:', res.json())
+
+    # Get high dividend rank list (new endpoint, no pagination)
+    res = data_client.screener.list_high_dividend(
+        category="US_STOCK",
+        sort_by="YIELD",
+        direction="DESC"
+    )
+    if res.status_code == 200:
+        print('list_high_dividend:', res.json())
+
+    # Get 52 week new highs (new endpoint, no pagination)
+    res = data_client.screener.list_52whl(
+        category="US_STOCK",
+        rank_type="NEW_HIGH",
+        sort_by="CHANGE_RATIO_52W",
+        direction="DESC"
+    )
+    if res.status_code == 200:
+        print('list_52whl_new_high:', res.json())

tests/core/log/test_log.py

@@ -34,7 +34,7 @@ def test_set_stream_logger(self):
         api_client.set_stream_logger(stream=sys.stdout, format_string=log_format)
         request = ApiRequest("/sign", protocol="http")
         request.add_query_param("k1", " zhong国=&")
-        request.add_query_param("k2", "v2")
+        request.add_query_param("k2", "v3")
         api_client.get_response(request)
 
     def test_set_file_logger(self):
@@ -43,5 +43,5 @@ def test_set_file_logger(self):
         api_client.set_file_logger(path=log_file_path, format_string=log_format)
         request = ApiRequest("/sign", protocol="http")
         request.add_query_param("k1", " zhong国=&")
-        request.add_query_param("k2", "v2")
+        request.add_query_param("k2", "v3")
         api_client.get_response(request)

webull/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.19'
+__version__ = '3.0.0'

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.0.17'
+__version__ = '3.0.0'
 
 import logging
 

webull/core/http/initializer/config/bean/query_config_request.py

@@ -38,4 +38,4 @@
 
 class GetConfigRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/config", version='v2', method="GET", query_params={})
+        super().__init__("/openapi/config", version='v3', method="GET", query_params={})

webull/core/http/initializer/token/bean/check_token_request.py

@@ -38,7 +38,7 @@
 
 class CheckTokenRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/auth/token/check", version='v2', method="POST", body_params={})
+        super().__init__("/auth/tokens/check", version='v3', method="POST", body_params={})
 
     def set_token(self, token):
         self.add_body_params("token", token)

webull/core/http/initializer/token/bean/create_token_request.py

@@ -38,7 +38,7 @@
 
 class CreateTokenRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/auth/token/create", version='v2', method="POST", body_params={})
+        super().__init__("/auth/tokens/create", version='v3', method="POST", body_params={})
 
     def set_token(self, token):
         if token:

webull/core/http/initializer/token/bean/refresh_token_request.py

@@ -38,7 +38,7 @@
 
 class RefreshTokenRequest(ApiRequest):
     def __init__(self):
-        super().__init__("/openapi/auth/token/refresh", version='v2', method="POST", body_params={})
+        super().__init__("/openapi/auth/token/refresh", version='v3', method="POST", body_params={})
 
     def set_token(self, token):
         self.add_body_params("token", token)

webull/data/__init__.py

@@ -1,3 +1,3 @@
 # coding=utf-8
 
-__version__ = '2.0.17'
+__version__ = '3.0.0'

webull/data/quotes/fundamentals.py

@@ -27,6 +27,7 @@
 from webull.data.request.get_fund_holdings_request import GetFundHoldingsRequest
 from webull.data.request.get_fund_files_request import GetFundFilesRequest
 from webull.data.request.get_fund_dividends_request import GetFundDividendsRequest
+from webull.data.request.get_fund_dividends_request_v2 import GetFundDividendsRequestV2
 from webull.data.request.get_fund_brief_request import GetFundBriefRequest
 from webull.data.request.get_fund_allocation_request import GetFundAllocationRequest
 from webull.data.request.get_financials_indicators_request import GetFinancialsIndicatorsRequest
@@ -197,6 +198,9 @@ def get_fund_files(self, symbol, category=Category.US_STOCK.name):
 
     def get_fund_dividends(self, symbol, category=Category.US_STOCK.name, page_index=None, page_size=None):
         """
+        .. deprecated::
+            Use :meth:`list_fund_dividends` instead.
+
         Query fund dividends for a security.
 
         :param symbol: Security symbol, e.g. QQQ.
@@ -212,6 +216,21 @@ def get_fund_dividends(self, symbol, category=Category.US_STOCK.name, page_index
         response = self.client.get_response(request)
         return response
 
+    def list_fund_dividends(self, symbol, category=Category.US_STOCK.name, pagination_key=None):
+        """
+        Query fund dividends for a security.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        request = GetFundDividendsRequestV2()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_pagination_key(pagination_key)
+        response = self.client.get_response(request)
+        return response
+
     def get_fund_brief(self, symbol, category=Category.US_STOCK.name):
         """
         Query fund brief information.