webull-openapi-python-sdk 2.0.19__py3-none-any.whl → 3.0.0__py3-none-any.whl

webull/data/request/get_historical_bars_request.py

@@ -17,7 +17,7 @@ from webull.core.request import ApiRequest
 
 class GetHistoricalBarsRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/stock/bars", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/stocks/bars/get", version='v3', method="GET", query_params={})
 
     def set_symbol(self, symbol):
         self.add_query_param("symbol", symbol)

webull/data/request/get_industry_comparison_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class GetIndustryComparisonRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/fundamentals/stock/industry-comparison", version='v2', method="GET",
+        ApiRequest.__init__(self, "/market-data/fundamentals/industry-comparisons/get", version='v3', method="GET",
                            query_params={})
 
     def set_symbol(self, symbol):

webull/data/request/get_instruments_request.py

@@ -17,8 +17,12 @@
 from webull.core.request import ApiRequest
 
 class GetInstrumentsRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`GetInstrumentsRequestV2` instead.
+    """
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/instrument/stock/list", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/openapi/instrument/stock/list", version='v3', method="GET", query_params={})
 
     def set_symbols(self, symbols):
         if isinstance(symbols, str):

webull/data/request/get_instruments_request_v2.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.request import ApiRequest
+
+
+class GetInstrumentsRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/instruments/stocks/profiles/list", version='v3', method="GET",
+                            query_params={})
+
+    def set_symbols(self, symbols):
+        if isinstance(symbols, str):
+            self.add_query_param("symbols", symbols)
+        elif isinstance(symbols, list):
+            self.add_query_param("symbols", ",".join(symbols))
+
+    def set_category(self, category):
+        self.add_query_param("category", category)
+
+    def set_status(self, status):
+        if status:
+            self.add_query_param("status", status)
+
+    def set_sub_category(self, sub_category):
+        if sub_category:
+            self.add_query_param("sub_category", sub_category)
+
+    def set_pagination_key(self, pagination_key):
+        if pagination_key:
+            self.add_query_param("pagination_key", pagination_key)

webull/data/request/get_noii_bars_request.py

@@ -26,7 +26,7 @@ class GetNoiiBarsRequest(ApiRequest):
     """
 
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/stock/noii/bars", version="v2", method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/stocks/noii-bars/list", version="v3", method="GET", query_params={})
 
     def set_symbol(self, symbol):
         """

webull/data/request/get_noii_snapshot_request.py

@@ -30,7 +30,8 @@ class GetNoiiSnapshotRequest(ApiRequest):
     """
 
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/stock/noii/snapshot", version="v2", method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/stocks/noii-snapshots/list", version="v3", method="GET",
+                            query_params={})
 
     def set_symbol(self, symbol):
         """

webull/data/request/get_option_bars_request.py

@@ -25,7 +25,7 @@ class GetOptionBarsRequest(ApiRequest):
     """
 
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/option/bars", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/options/bars/list", version='v3', method="GET", query_params={})
 
     def set_symbols(self, symbols):
         """

webull/data/request/get_option_contracts_request.py

@@ -18,8 +18,12 @@ from webull.core.request import ApiRequest
 
 
 class GetOptionContractsRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`GetOptionContractsRequestV2` instead.
+    """
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/instrument/option/contracts", version="v2", method="GET",
+        ApiRequest.__init__(self, "/openapi/instrument/option/contracts", version="v3", method="GET",
                            query_params={})
 
     def set_category(self, category):

webull/data/request/get_option_contracts_request_v2.py

@@ -0,0 +1,78 @@
+# 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 GetOptionContractsRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trading/instruments/options/contracts/list", version="v3", method="GET",
+                           query_params={})
+
+    def set_category(self, category):
+        self.add_query_param("category", category)
+
+    def set_option_symbols(self, option_symbols):
+        if option_symbols:
+            self.add_query_param("option_symbols", option_symbols)
+
+    def set_underlying_symbols(self, underlying_symbols):
+        if underlying_symbols:
+            self.add_query_param("underlying_symbols", underlying_symbols)
+
+    def set_status(self, status):
+        if status:
+            self.add_query_param("status", status)
+
+    def set_start_date(self, start_date):
+        if start_date:
+            self.add_query_param("start_date", start_date)
+
+    def set_end_date(self, end_date):
+        if end_date:
+            self.add_query_param("end_date", end_date)
+
+    def set_root_symbol(self, root_symbol):
+        if root_symbol:
+            self.add_query_param("root_symbol", root_symbol)
+
+    def set_option_type(self, option_type):
+        if option_type:
+            self.add_query_param("option_type", option_type)
+
+    def set_style(self, style):
+        if style:
+            self.add_query_param("style", style)
+
+    def set_strike_price_gte(self, strike_price_gte):
+        if strike_price_gte is not None:
+            self.add_query_param("strike_price_gte", strike_price_gte)
+
+    def set_strike_price_lte(self, strike_price_lte):
+        if strike_price_lte is not None:
+            self.add_query_param("strike_price_lte", strike_price_lte)
+
+    def set_ppind(self, ppind):
+        if ppind is not None:
+            self.add_query_param("ppind", ppind)
+
+    def set_show_deliverables(self, show_deliverables):
+        if show_deliverables is not None:
+            self.add_query_param("show_deliverables", show_deliverables)
+
+    def set_pagination_key(self, pagination_key):
+        if pagination_key:
+            self.add_query_param("pagination_key", pagination_key)

webull/data/request/get_option_snapshot_request.py

@@ -25,7 +25,7 @@ class GetOptionSnapshotRequest(ApiRequest):
     """
 
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/option/snapshot", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/options/snapshots/list", version='v3', method="GET", query_params={})
 
     def set_symbols(self, symbols):
         """

webull/data/request/get_option_tick_request.py

@@ -25,7 +25,7 @@ class GetOptionTickRequest(ApiRequest):
     """
 
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/option/tick", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/options/ticks/list", version='v3', method="GET", query_params={})
 
     def set_symbol(self, symbol):
         """

webull/data/request/get_quotes_request.py

@@ -18,7 +18,7 @@ from webull.core.request import ApiRequest
 
 class GetQuotesRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/stock/quotes", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/stocks/depths/list", version='v3', method="GET", query_params={})
 
     def set_symbol(self, symbol):
         self.add_query_param("symbol", symbol)

webull/data/request/get_sec_filings_request.py

@@ -19,7 +19,7 @@ from webull.core.request import ApiRequest
 
 class GetSecFilingsRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/fundamentals/stock/filings", version='v2', method="GET",
+        ApiRequest.__init__(self, "/market-data/fundamentals/filings/list", version='v3', method="GET",
                            query_params={})
 
     def set_symbol(self, symbol):

webull/data/request/get_snapshot_request.py

@@ -18,7 +18,7 @@ from webull.core.request import ApiRequest
 
 class GetSnapshotRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/stock/snapshot", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/stocks/snapshots/list", version='v3', method="GET", query_params={})
 
     def set_symbols(self, symbols):
         if isinstance(symbols, str):

webull/data/request/get_tick_request.py

@@ -18,7 +18,7 @@ from webull.core.request import ApiRequest
 
 class GetTickRequest(ApiRequest):
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/stock/tick", version='v2', method="GET", query_params={})
+        ApiRequest.__init__(self, "/market-data/stocks/ticks/list", version='v3', method="GET", query_params={})
 
     def set_symbol(self, symbol):
         self.add_query_param("symbol", symbol)

webull/data/request/screener/get_52whl_request.py

@@ -18,6 +18,10 @@ from webull.core.request import ApiRequest
 
 
 class Get52WHLRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`Get52WHLRequestV2` instead.
+    """
     def __init__(self):
         ApiRequest.__init__(self, "/openapi/market-data/screener/52whl", version='v2', method="GET",
                            query_params={})

webull/data/request/screener/get_52whl_request_v2.py

@@ -0,0 +1,45 @@
+# 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 Get52WHLRequestV2(ApiRequest):
+    """
+    Request class for 52 Week High/Low Rank API.
+
+    The ranking is not paginated and returns the top 200 results.
+    """
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/screeners/week52-high-low/list", version='v3', method="GET",
+                            query_params={})
+
+    def set_rank_type(self, rank_type):
+        if rank_type:
+            self.add_query_param("rank_type", rank_type)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_sort_by(self, sort_by):
+        if sort_by:
+            self.add_query_param("sort_by", sort_by)
+
+    def set_direction(self, direction):
+        if direction:
+            self.add_query_param("direction", direction)

webull/data/request/screener/get_gainers_losers_request.py

@@ -19,6 +19,9 @@ from webull.core.request import ApiRequest
 
 class GetGainersLosersRequest(ApiRequest):
     """
+    .. deprecated::
+        Use :class:`GetGainersLosersRequestV2` instead.
+
     Request class for Stock Top Gainers/Losers Rank API.
     
     This API returns stocks ranked by price change percentage over different time periods.
@@ -26,7 +29,8 @@ class GetGainersLosersRequest(ApiRequest):
     """
     
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/screener/gainers-losers", version="v2", method="GET", query_params={})
+        ApiRequest.__init__(self, "/openapi/market-data/screener/gainers-losers", version="v2", method="GET",
+                            query_params={})
 
     def set_rank_type(self, rank_type):
         """

webull/data/request/screener/get_gainers_losers_request_v2.py

@@ -0,0 +1,94 @@
+# 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 GetGainersLosersRequestV2(ApiRequest):
+    """
+    Request class for Stock Top Gainers/Losers Rank API.
+
+    This API returns stocks ranked by price change percentage over different time periods.
+    Use direction=DESC for gainers (top performers) and direction=ASC for losers (worst performers).
+
+    The ranking is not paginated and returns the top 200 results.
+    """
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/screeners/gainers-losers/list", version="v3", method="GET",
+                            query_params={})
+
+    def set_rank_type(self, rank_type):
+        """
+        Set the ranking time dimension.
+
+        :param rank_type: Time period for ranking. Optional (defaults to DAY_1).
+            Enum values:
+            - PRE_MARKET: Pre-market session
+            - AFTER_MARKET: After-market session
+            - MIN_3: 3 minutes
+            - MIN_5: 5 minutes
+            - DAY_1: 1 day
+            - DAY_5: 5 days
+            - MONTH_1: 1 month
+            - MONTH_3: 3 months
+            - WEEK_52: 52 weeks
+        """
+        if rank_type is not None:
+            self.add_query_param("rank_type", rank_type)
+
+    def set_category(self, category):
+        """
+        Set the security market category.
+
+        :param category: Security market category. Required.
+            Enum values: US_STOCK
+        """
+        if category is not None:
+            self.add_query_param("category", category)
+
+    def set_sort_by(self, sort_by):
+        """
+        Set the secondary sort field for further ordering within the ranking.
+
+        :param sort_by: Sort field. Optional (defaults to CHANGE_RATIO).
+            Enum values:
+            - CHANGE_RATIO: Price change percentage
+            - RELATIVE_VOLUME_10D: 10-day relative volume
+            - MARKET_VALUE: Market capitalization
+            - CLOSE: Closing price
+            - PRICE: Current price
+            - PE_TTM: Trailing twelve months P/E ratio
+            - HIGH: Intraday high
+            - LOW: Intraday low
+            - AMPLITUDE: Price amplitude
+            - TURNOVER: Turnover amount
+            - VOLUME: Trading volume
+        """
+        if sort_by is not None:
+            self.add_query_param("sort_by", sort_by)
+
+    def set_direction(self, direction):
+        """
+        Set the sort direction.
+
+        :param direction: Sort direction. Optional (defaults to DESC).
+            Enum values:
+            - ASC: Ascending order (for losers/worst performers)
+            - DESC: Descending order (for gainers/top performers)
+        """
+        if direction is not None:
+            self.add_query_param("direction", direction)

webull/data/request/screener/get_high_dividend_request.py

@@ -18,6 +18,10 @@ from webull.core.request import ApiRequest
 
 
 class GetHighDividendRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`GetHighDividendRequestV2` instead.
+    """
     def __init__(self):
         ApiRequest.__init__(self, "/openapi/market-data/screener/high-dividend", version='v2', method="GET",
                            query_params={})

webull/data/request/screener/get_high_dividend_request_v2.py

@@ -0,0 +1,41 @@
+# 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 GetHighDividendRequestV2(ApiRequest):
+    """
+    Request class for High Dividend Rank API.
+
+    The ranking is not paginated and returns the top 200 results.
+    """
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/screeners/high-dividend-ranks/list", version='v3', method="GET",
+                            query_params={})
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_sort_by(self, sort_by):
+        if sort_by:
+            self.add_query_param("sort_by", sort_by)
+
+    def set_direction(self, direction):
+        if direction:
+            self.add_query_param("direction", direction)

webull/data/request/screener/get_market_sectors_detail_request.py

@@ -18,6 +18,10 @@ from webull.core.request import ApiRequest
 
 
 class GetMarketSectorsDetailRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`GetMarketSectorsDetailRequestV2` instead.
+    """
     def __init__(self):
         ApiRequest.__init__(self, "/openapi/market-data/screener/market-sectors-detail", version='v2', method="GET",
                            query_params={})

webull/data/request/screener/get_market_sectors_detail_request_v2.py

@@ -0,0 +1,47 @@
+# 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 GetMarketSectorsDetailRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/screeners/market-sectors/get", version='v3', method="GET",
+                           query_params={})
+
+    def set_sector_id(self, sector_id):
+        if sector_id:
+            self.add_query_param("sector_id", sector_id)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_period(self, period):
+        if period:
+            self.add_query_param("period", period)
+
+    def set_sort_by(self, sort_by):
+        if sort_by:
+            self.add_query_param("sort_by", sort_by)
+
+    def set_direction(self, direction):
+        if direction:
+            self.add_query_param("direction", direction)
+
+    def set_pagination_key(self, pagination_key):
+        if pagination_key:
+            self.add_query_param("pagination_key", pagination_key)

webull/data/request/screener/get_market_sectors_request.py

@@ -18,8 +18,12 @@ from webull.core.request import ApiRequest
 
 
 class GetMarketSectorsRequest(ApiRequest):
+    """
+    .. deprecated::
+        Use :class:`GetMarketSectorsRequestV2` instead.
+    """
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/screener/market-sectors", version='v2', method="GET",
+        ApiRequest.__init__(self, "/openapi/market-data/screener/market-sectors", version='v3', method="GET",
                            query_params={})
 
     def set_category(self, category):

webull/data/request/screener/get_market_sectors_request_v2.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 GetMarketSectorsRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/screeners/market-sectors/list", version='v3', method="GET",
+                           query_params={})
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_agg_type(self, agg_type):
+        if agg_type:
+            self.add_query_param("agg_type", agg_type)
+
+    def set_period(self, period):
+        if period:
+            self.add_query_param("period", period)
+
+    def set_direction(self, direction):
+        if direction:
+            self.add_query_param("direction", direction)
+
+    def set_pagination_key(self, pagination_key):
+        if pagination_key:
+            self.add_query_param("pagination_key", pagination_key)

webull/data/request/screener/get_most_active_request.py

@@ -19,6 +19,9 @@ from webull.core.request import ApiRequest
 
 class GetMostActiveRequest(ApiRequest):
     """
+    .. deprecated::
+        Use :class:`GetMostActiveRequestV2` instead.
+
     Request class for Stock Top Active Rank API.
     
     This API returns the most actively traded stocks ranked by volume, relative volume,
@@ -31,7 +34,8 @@ class GetMostActiveRequest(ApiRequest):
     """
     
     def __init__(self):
-        ApiRequest.__init__(self, "/openapi/market-data/screener/top-active", version="v2", method="GET", query_params={})
+        ApiRequest.__init__(self, "/openapi/market-data/screener/top-active", version="v2", method="GET",
+                            query_params={})
 
     def set_rank_type(self, rank_type):
         """