webull-openapi-python-sdk 2.0.18__tar.gz → 3.0.0__tar.gz

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/PKG-INFO

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

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/samples/screener/screener_client.py

@@ -98,8 +98,8 @@ if __name__ == '__main__':
     # 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 __name__ == '__main__':
     )
     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())

webull_openapi_python_sdk-3.0.0/webull/__init__.py

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

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/core/__init__.py

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

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/core/http/initializer/config/bean/query_config_request.py

@@ -38,4 +38,4 @@ from webull.core.request import ApiRequest
 
 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_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/core/http/initializer/token/bean/check_token_request.py

@@ -38,7 +38,7 @@ from webull.core.request import ApiRequest
 
 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_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/core/http/initializer/token/bean/create_token_request.py

@@ -38,7 +38,7 @@ from webull.core.request import ApiRequest
 
 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_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/core/http/initializer/token/bean/refresh_token_request.py

@@ -38,7 +38,7 @@ from webull.core.request import ApiRequest
 
 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_openapi_python_sdk-3.0.0/webull/data/__init__.py

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

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/data/data_streaming_client.py

@@ -20,10 +20,11 @@ from webull.data.quotes.subscribe.event_depth_decoder import EventDepthDecoder
 from webull.data.quotes.subscribe.event_snapshot_decoder import EventSnapshotDecoder
 from webull.data.quotes.subscribe.event_tick_decoder import EventTickDecoder
 from webull.data.quotes.subscribe.payload_type import PAYLOAD_TYPE_QUOTE, PAYLOAD_TYPE_SHAPSHOT, PAYLOAD_TYPE_TICK, \
-    PAYLOAD_TYPE_EVENT_SHAPSHOT, PAYLOAD_TYPE_EVENT_DEPTH, PAYLOAD_TYPE_EVENT_TICK
+    PAYLOAD_TYPE_EVENT_SHAPSHOT, PAYLOAD_TYPE_EVENT_DEPTH, PAYLOAD_TYPE_EVENT_TICK, PAYLOAD_TYPE_NOTICE
 from webull.data.quotes.subscribe.quote_decoder import QuoteDecoder
 from webull.data.quotes.subscribe.snapshot_decoder import SnapshotDecoder
 from webull.data.quotes.subscribe.tick_decoder import TickDecoder
+from webull.data.quotes.subscribe.notice_decoder import NoticeDecoder
 
 
 class DataStreamingClient(QuotesClient):
@@ -46,6 +47,7 @@ class DataStreamingClient(QuotesClient):
         self.register_payload_decoder(PAYLOAD_TYPE_EVENT_DEPTH, EventDepthDecoder())
         self.register_payload_decoder(PAYLOAD_TYPE_EVENT_SHAPSHOT, EventSnapshotDecoder())
         self.register_payload_decoder(PAYLOAD_TYPE_EVENT_TICK, EventTickDecoder())
+        self.register_payload_decoder(PAYLOAD_TYPE_NOTICE, NoticeDecoder())
 
     @property
     def on_connect_success(self):

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/data/internal/quotes_client.py

@@ -83,7 +83,7 @@ class QuotesClient(mqttc.Client):
                 client._easy_log(
                     LOG_DEBUG, 'decoded message topic: %s, payload: %s', decoded[0], decoded[1])
                 _on_quotes_message = client._on_quotes_message
-                no_callback_topic = ['echo','notice']
+                no_callback_topic = ['echo']
                 if _on_quotes_message and decoded[0] not in no_callback_topic:
                     _on_quotes_message(client, decoded[0], decoded[1])
             else:
@@ -115,7 +115,7 @@ class QuotesClient(mqttc.Client):
 
         self._quotes_message = _quotes_message
         self._quotes_on_connect = _quotes_on_connect
-        mqttc.Client.__init__(self, self._client_id, transport=transport, reconnect_on_failure=False)
+        mqttc.Client.__init__(self, client_id=self._client_id, transport=transport, reconnect_on_failure=False)
         self.username_pw_set(self._app_key, uuid.uuid4().hex)
         if tls_enable:
             self.tls_set()

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/data/quotes/fundamentals.py

@@ -27,6 +27,7 @@ from webull.data.request.get_fund_net_value_request import GetFundNetValueReques
 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 @@ class Fundamentals:
 
     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 @@ class Fundamentals:
         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.

{webull_openapi_python_sdk-2.0.18 → webull_openapi_python_sdk-3.0.0}/webull/data/quotes/instrument.py

@@ -20,7 +20,12 @@ from webull.data.request.get_event_instrument_request import GetEventInstrumentR
 from webull.data.request.get_event_series_categories import GetEventCategoriesRequest
 from webull.data.request.get_event_series_request import GetEventSeriesRequest
 from webull.data.request.get_instruments_request import GetInstrumentsRequest
+from webull.data.request.get_instruments_request_v2 import GetInstrumentsRequestV2
 from webull.data.request.get_crypto_instruments_request import GetCryptoInstrumentsRequest
+from webull.data.request.get_crypto_instruments_request_v2 import GetCryptoInstrumentsRequestV2
+from webull.data.request.get_event_series_request_v2 import GetEventSeriesRequestV2
+from webull.data.request.get_event_instrument_request_v2 import GetEventInstrumentRequestV2
+from webull.data.request.get_option_contracts_request_v2 import GetOptionContractsRequestV2
 from webull.data.request.get_futures_instruments_request import GetFuturesInstrumentsRequest
 from webull.data.request.get_futures_products_request import GetFuturesProductsRequest
 from webull.data.request.get_futures_instruments_by_code_request import GetFuturesInstrumentsByCodeRequest
@@ -35,6 +40,9 @@ class Instrument:
     def get_instrument(self, symbols=None, category=Category.US_STOCK.name, status=None, sub_category=None,
                        last_instrument_id=None, page_size=1000):
         """
+         .. deprecated::
+            Use :meth:`list_instruments` instead.
+
          Query the underlying information according to the security symbol list and security type.
 
         :param symbols: Securities symbol, such as: 00700,00981.
@@ -54,9 +62,32 @@ class Instrument:
         response = self.client.get_response(instruments_request)
         return response
 
+    def list_instruments(self, symbols=None, category=Category.US_STOCK.name, status=None, sub_category=None,
+                         pagination_key=None):
+        """
+         Query the underlying information according to the security symbol list and security type.
+
+        :param symbols: Securities symbol, such as: 00700,00981.
+        :param category: Security type, enumeration.
+        :param status: Tradable status.
+        :param sub_category: Security sub category.
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        instruments_request = GetInstrumentsRequestV2()
+        instruments_request.set_symbols(symbols)
+        instruments_request.set_category(category)
+        instruments_request.set_status(status)
+        instruments_request.set_sub_category(sub_category)
+        instruments_request.set_pagination_key(pagination_key)
+        response = self.client.get_response(instruments_request)
+        return response
+
     def get_crypto_instrument(self, symbols=None, status=None, last_instrument_id=None,
                               category=Category.US_CRYPTO.name, page_size=1000):
         """
+        .. deprecated::
+            Use :meth:`list_crypto_instruments` instead.
+
          Query the crypto underlying information according to the security symbol.
         :param symbols: Securities symbol, such as: BTCUSD,ETHUSD.
         :param status: Tradable status.
@@ -75,6 +106,25 @@ class Instrument:
         response = self.client.get_response(crypto_instruments_request)
         return response
 
+    def list_crypto_instruments(self, symbols=None, status=None, category=Category.US_CRYPTO.name,
+                                pagination_key=None):
+        """
+         Query the crypto underlying information according to the security symbol.
+        :param symbols: Securities symbol, such as: BTCUSD,ETHUSD.
+        :param status: Tradable status.
+        :param category: (str, required) Instrument type.
+                     Possible values: ["US_CRYPTO"]
+                     Example: "US_CRYPTO"
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        crypto_instruments_request = GetCryptoInstrumentsRequestV2()
+        crypto_instruments_request.set_symbols(symbols)
+        crypto_instruments_request.set_category(category)
+        crypto_instruments_request.set_status(status)
+        crypto_instruments_request.set_pagination_key(pagination_key)
+        response = self.client.get_response(crypto_instruments_request)
+        return response
+
     def get_futures_instrument(self, symbols=None, category=Category.US_STOCK.name, code=None, status=None):
         """
          Query the futures instrument information based on the futures contract symbol.
@@ -155,6 +205,9 @@ class Instrument:
 
     def get_event_series(self, category=None, symbols=None, last_series_id=None, page_size=500):
         """
+        .. deprecated::
+            Use :meth:`list_event_series` instead.
+
         Retrieve multiple series with specified filters.
         A series represents a template for recurring events that follow the same format and rules (e.g., “Monthly Jobs Report” ).
         This endpoint allows you to browse and discover available series templates by category.
@@ -178,6 +231,28 @@ class Instrument:
         response = self.client.get_response(event_series_request)
         return response
 
+    def list_event_series(self, category=None, symbols=None, pagination_key=None):
+        """
+        Retrieve multiple series with specified filters.
+        A series represents a template for recurring events that follow the same format and rules.
+        This endpoint allows you to browse and discover available series templates by category.
+
+        :param category: The category which this series belongs to.Allowed values:
+                        ECONOMICS, FINANCIALS, POLITICS, ENTERTAINMENT, SCIENCE_TECHNOLOGY,
+                        CLIMATE_WEATHER, TRANSPORTATION, CRYPTO, SPORTS
+        :param symbols: Symbol of the event series, supports JSON array format, multiple symbols separated by commas; maximum 100 symbols per query.
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        event_series_request = GetEventSeriesRequestV2()
+        if category:
+            event_series_request.set_category(category)
+        if symbols:
+            event_series_request.set_symbols(symbols)
+        if pagination_key:
+            event_series_request.set_pagination_key(pagination_key)
+        response = self.client.get_response(event_series_request)
+        return response
+
     def get_event_events(self, series_symbol, symbols=None, status=None):
         """
         Query event contract events
@@ -197,13 +272,16 @@ class Instrument:
 
     def get_event_instrument(self, series_symbol, event_symbol=None, symbols=None, expiration_date_after=None, last_instrument_id=None, page_size=500):
         """
+        .. deprecated::
+            Use :meth:`list_event_instruments` instead.
+
         Retrieve profile information for event contract markets based on the series symbol.
 
         :param series_symbol: Symbol that identifies this series.
         :param event_symbol: Symbol of the event events.
         :param symbols: Symbol of the event market, supports JSON array format, multiple symbols separated by commas; maximum 100 symbols per query.
         :param expiration_date_after: Used to filter items whose expiration date is later than a specified date; the default selection is the current day (inclusive).
-        :param last_instrument_id: Last instrument id for pagination.
+        :param last_instrument_id: Last series id for pagination.
         :param page_size: Page size, default 500.
         """
 
@@ -221,11 +299,40 @@ class Instrument:
         response = self.client.get_response(event_instrument_request)
         return response
 
+    def list_event_instruments(self, series_symbol=None, event_symbol=None, symbols=None, expiration_date_after=None,
+                               pagination_key=None):
+        """
+        Retrieve profile information for event contract markets based on the series symbol.
+
+        :param series_symbol: Symbol that identifies this series.
+        :param event_symbol: Symbol of the event events.
+        :param symbols: Symbol of the event market, supports JSON array format, multiple symbols separated by commas; maximum 100 symbols per query.
+        :param expiration_date_after: Used to filter items whose expiration date is later than a specified date; the default selection is the current day (inclusive).
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+
+        event_instrument_request = GetEventInstrumentRequestV2()
+        if series_symbol:
+            event_instrument_request.set_series_symbol(series_symbol)
+        if event_symbol:
+            event_instrument_request.set_event_symbol(event_symbol)
+        if symbols:
+            event_instrument_request.set_symbols(symbols)
+        if expiration_date_after:
+            event_instrument_request.set_expiration_date_after(expiration_date_after)
+        if pagination_key:
+            event_instrument_request.set_pagination_key(pagination_key)
+        response = self.client.get_response(event_instrument_request)
+        return response
+
     def get_option_contracts(self, category=Category.US_OPTION.name, underlying_symbols=None, status=None,
                                start_date=None, end_date=None, root_symbol=None, option_symbol=None,
                                option_type=None, style=None, strike_price_gte=None, strike_price_lte=None,
                                ppind=None, show_deliverables=None, page_size=10, last_instrument_id=None):
         """
+        .. deprecated::
+            Use :meth:`list_option_contracts` instead.
+
         Query option contracts list by conditions such as underlying_symbols, status, expiration date, etc.
 
         :param category: Market category. Value: US_OPTION.
@@ -263,6 +370,46 @@ class Instrument:
         response = self.client.get_response(request)
         return response
 
+    def list_option_contracts(self, category=Category.US_OPTION.name, option_symbols=None, underlying_symbols=None,
+                              status=None, start_date=None, end_date=None, root_symbol=None, option_type=None,
+                              style=None, strike_price_gte=None, strike_price_lte=None, ppind=None,
+                              show_deliverables=None, pagination_key=None):
+        """
+        Query option contracts list by conditions such as underlying_symbols, status, expiration date, etc.
+
+        :param category: Market category. Value: US_OPTION.
+        :param option_symbols: Option symbol(s), comma-separated for multiple, e.g. AAPL250620C00150000.
+        :param underlying_symbols: Underlying symbol(s), comma-separated for multiple, e.g. AAPL,MSFT.
+        :param status: Contract status: LISTING (default), DELISTING.
+        :param start_date: Exact expiration date, format YYYY-MM-DD.
+        :param end_date: Expiration date lower bound (inclusive), format YYYY-MM-DD.
+        :param root_symbol: Root symbol filter (series symbol, e.g. SPXW), mainly for index options and non-standard contracts after CA.
+        :param option_type: Contract type: CALL / PUT.
+        :param style: Exercise style: AMERICAN / EUROPEAN.
+        :param strike_price_gte: Strike price lower bound (inclusive).
+        :param strike_price_lte: Strike price upper bound (inclusive).
+        :param ppind: Penny Program Indicator: true = Penny Pilot, false = non-Penny Pilot.
+        :param show_deliverables: Whether to return deliverables array in response: true / false, default false.
+        :param pagination_key: Pagination key from the previous page response; not returned on the last page.
+        """
+        request = GetOptionContractsRequestV2()
+        request.set_category(category)
+        request.set_option_symbols(option_symbols)
+        request.set_underlying_symbols(underlying_symbols)
+        request.set_status(status)
+        request.set_start_date(start_date)
+        request.set_end_date(end_date)
+        request.set_root_symbol(root_symbol)
+        request.set_option_type(option_type)
+        request.set_style(style)
+        request.set_strike_price_gte(strike_price_gte)
+        request.set_strike_price_lte(strike_price_lte)
+        request.set_ppind(ppind)
+        request.set_show_deliverables(show_deliverables)
+        request.set_pagination_key(pagination_key)
+        response = self.client.get_response(request)
+        return response
+
     def get_company_profile(self, symbol, category=Category.US_STOCK.name):
         """
         Get company profile for one instrument.