webull-openapi-python-sdk 2.0.4__py3-none-any.whl → 2.0.6__py3-none-any.whl

webull/data/request/screener/get_gainers_losers_request.py

@@ -0,0 +1,109 @@
+# 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 GetGainersLosersRequest(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).
+    """
+    
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/screener/gainers-losers", version="v2", method="GET", query_params={})
+
+    def set_rank_type(self, rank_type):
+        """
+        Set the ranking time dimension.
+        
+        :param rank_type: Time period for ranking. Required.
+            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. Required.
+            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_page_index(self, page_index):
+        """
+        Set the page number for pagination.
+        
+        :param page_index: Page number, starting from 1. Optional.
+        """
+        if page_index is not None:
+            self.add_query_param("page_index", page_index)
+
+    def set_page_size(self, page_size):
+        """
+        Set the number of records per page.
+        
+        :param page_size: Number of records returned per page. Optional.
+        """
+        if page_size is not None:
+            self.add_query_param("page_size", page_size)
+
+    def set_direction(self, direction):
+        """
+        Set the sort direction.
+        
+        :param direction: Sort direction. Optional.
+            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_most_active_request.py

@@ -0,0 +1,110 @@
+# 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 GetMostActiveRequest(ApiRequest):
+    """
+    Request class for Stock Top Active Rank API.
+    
+    This API returns the most actively traded stocks ranked by volume, relative volume,
+    turnover, turnover rate, or amplitude.
+    
+    Default sort: rank_type=VOLUME, order=VOLUME, direction=DESC
+    
+    The relative_volume_10d field is unique to the Top Active response compared to
+    the Gainers/Losers endpoint.
+    """
+    
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/screener/most-active", version="v2", method="GET", query_params={})
+
+    def set_rank_type(self, rank_type):
+        """
+        Set the ranking dimension that determines which activity metric is used for filtering.
+        
+        :param rank_type: Activity metric for ranking. Optional (defaults to VOLUME).
+            Enum values:
+            - VOLUME: Trading volume
+            - RELATIVE_VOLUME_10D: 10-day relative volume
+            - TURNOVER: Turnover amount
+            - TURNOVER_RATE: Turnover rate
+            - AMPLITUDE: Price amplitude
+        """
+        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.
+            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_page_index(self, page_index):
+        """
+        Set the page number for pagination.
+        
+        :param page_index: Page number, starting from 1. Optional.
+        """
+        if page_index is not None:
+            self.add_query_param("page_index", page_index)
+
+    def set_page_size(self, page_size):
+        """
+        Set the number of records per page.
+        
+        :param page_size: Number of records returned per page. Optional.
+        """
+        if page_size is not None:
+            self.add_query_param("page_size", page_size)
+
+    def set_direction(self, direction):
+        """
+        Set the sort direction.
+        
+        :param direction: Sort direction. Optional (defaults to DESC).
+            Enum values:
+            - ASC: Ascending order
+            - DESC: Descending order
+        """
+        if direction is not None:
+            self.add_query_param("direction", direction)

webull/data/request/watchlist/__init__.py

@@ -0,0 +1,13 @@
+# 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.

webull/data/request/watchlist/add_watchlist_instruments_request.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 AddWatchlistInstrumentsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/instruments/add", version="v2", method="POST", body_params={})
+
+    def set_watchlist_id(self, watchlist_id):
+        """
+        Set the watchlist unique identifier.
+
+        :param watchlist_id: Watchlist unique identifier.
+        """
+        self.add_body_params("watchlist_id", watchlist_id)
+
+    def set_instruments(self, instruments):
+        """
+        Set the list of instruments to add.
+
+        :param instruments: List of instruments to add. Each instrument should contain:
+            - symbol: Instrument symbol (e.g., AAPL)
+            - category: Instrument category (e.g., US_STOCK, US_CRYPTO)
+            - sort: Sort order number
+        """
+        self.add_body_params("instruments", instruments)

webull/data/request/watchlist/create_watchlist_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 CreateWatchlistRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/create", version="v2", method="POST", body_params={})
+
+    def set_name(self, name):
+        """
+        Set the watchlist name.
+
+        :param name: Watchlist name. Maximum 1000 watchlists can be created.
+        """
+        self.add_body_params("name", name)
+
+    def set_sort(self, sort):
+        """
+        Set the sort order.
+
+        :param sort: Sort order number.
+        """
+        if sort is not None:
+            self.add_body_params("sort", sort)

webull/data/request/watchlist/delete_watchlist_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 DeleteWatchlistRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/delete", version="v2", method="POST", body_params={})
+
+    def set_watchlist_id(self, watchlist_id):
+        """
+        Set the watchlist unique identifier.
+
+        :param watchlist_id: Watchlist unique identifier.
+        """
+        self.add_body_params("watchlist_id", watchlist_id)

webull/data/request/watchlist/get_watchlist_instruments_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 GetWatchlistInstrumentsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/instruments/list", version="v2", method="GET", query_params={})
+
+    def set_watchlist_id(self, watchlist_id):
+        """
+        Set the watchlist unique identifier.
+
+        :param watchlist_id: Watchlist unique identifier.
+        """
+        self.add_query_param("watchlist_id", watchlist_id)

webull/data/request/watchlist/get_watchlist_request.py

@@ -0,0 +1,22 @@
+# 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 GetWatchlistRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/list", version="v2", method="GET", query_params={})

webull/data/request/watchlist/remove_watchlist_instruments_request.py

@@ -0,0 +1,40 @@
+# 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 RemoveWatchlistInstrumentsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/instruments/remove", version="v2", method="POST", body_params={})
+
+    def set_watchlist_id(self, watchlist_id):
+        """
+        Set the watchlist unique identifier.
+
+        :param watchlist_id: Watchlist unique identifier.
+        """
+        self.add_body_params("watchlist_id", watchlist_id)
+
+    def set_instruments(self, instruments):
+        """
+        Set the list of instruments to remove.
+
+        :param instruments: List of instruments to remove. Each instrument should contain:
+            - symbol: Instrument symbol (e.g., AAPL)
+            - category: Instrument category (e.g., US_STOCK)
+        """
+        self.add_body_params("instruments", instruments)

webull/data/request/watchlist/update_watchlist_instruments_request.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 UpdateWatchlistInstrumentsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/instruments/update", version="v2", method="POST", body_params={})
+
+    def set_watchlist_id(self, watchlist_id):
+        """
+        Set the watchlist unique identifier.
+
+        :param watchlist_id: Watchlist unique identifier.
+        """
+        self.add_body_params("watchlist_id", watchlist_id)
+
+    def set_instruments(self, instruments):
+        """
+        Set the list of instruments to update.
+
+        :param instruments: List of instruments to update. Each instrument should contain:
+            - symbol: Instrument symbol (for locating)
+            - category: Instrument category (for locating)
+            - sort: New sort order number
+        """
+        self.add_body_params("instruments", instruments)

webull/data/request/watchlist/update_watchlist_request.py

@@ -0,0 +1,48 @@
+# 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 UpdateWatchlistRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/watchlist/update", version="v2", method="POST", body_params={})
+
+    def set_watchlist_id(self, watchlist_id):
+        """
+        Set the watchlist unique identifier.
+
+        :param watchlist_id: Watchlist unique identifier.
+        """
+        self.add_body_params("watchlist_id", watchlist_id)
+
+    def set_name(self, name):
+        """
+        Set the new watchlist name.
+
+        :param name: New watchlist name.
+        """
+        if name is not None:
+            self.add_body_params("name", name)
+
+    def set_sort(self, sort):
+        """
+        Set the new sort order.
+
+        :param sort: New sort order number.
+        """
+        if sort is not None:
+            self.add_body_params("sort", sort)

webull/trade/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.4'
+__version__ = '2.0.6'

{webull_openapi_python_sdk-2.0.4.dist-info → webull_openapi_python_sdk-2.0.6.dist-info}/METADATA

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