webull-openapi-python-sdk 2.0.10__py3-none-any.whl → 2.0.12__py3-none-any.whl

webull/data/quotes/screener.py

@@ -16,6 +16,10 @@
 
 from webull.data.request.screener.get_gainers_losers_request import GetGainersLosersRequest
 from webull.data.request.screener.get_most_active_request import GetMostActiveRequest
+from webull.data.request.screener.get_market_sectors_request import GetMarketSectorsRequest
+from webull.data.request.screener.get_market_sectors_detail_request import GetMarketSectorsDetailRequest
+from webull.data.request.screener.get_high_dividend_request import GetHighDividendRequest
+from webull.data.request.screener.get_52whl_request import Get52WHLRequest
 
 
 class Screener:
@@ -114,3 +118,87 @@ class Screener:
         request.set_direction(direction)
         response = self.client.get_response(request)
         return response
+
+    def get_market_sectors(self, category, agg_type=None, period=None, page_index=None, page_size=None, direction=None):
+        """
+        Get all sector overview data.
+
+        :param category: Security category. Required. (e.g., 'US_STOCK')
+        :param agg_type: Statistics type, default is MARKET_VALUE. Enum: MARKET_VALUE, VOLUME.
+        :param period: Statistics period, default is D1. Enum: D1, D5, M01, M03.
+        :param page_index: Page index.
+        :param page_size: Number of records per page.
+        :param direction: Sorting direction. Enum: ASC (ascending), DESC (descending).
+        """
+        request = GetMarketSectorsRequest()
+        request.set_category(category)
+        request.set_agg_type(agg_type)
+        request.set_period(period)
+        request.set_page_index(page_index)
+        request.set_page_size(page_size)
+        request.set_direction(direction)
+        response = self.client.get_response(request)
+        return response
+
+    def get_market_sectors_detail(self, sector_id, category, period=None, page_index=None, page_size=None, sort_by=None, direction=None):
+        """
+        Get stock list and statistics for a specific sector.
+
+        :param sector_id: Sector ID. Required.
+        :param category: Security category. Required. (e.g., 'US_STOCK')
+        :param period: Statistics period, default is D1. Enum: D1, D5, M01, M03.
+        :param page_index: Page index.
+        :param page_size: Number of records per page.
+        :param sort_by: Sort field, default is CHANGE_RATIO. Enum: CHANGE_RATIO, RELATIVE_VOLUME_10D, MARKET_VALUE, CLOSE, PRICE, PE_TTM, HIGH, LOW, AMPLITUDE, TURNOVER, VOLUME, YIELD, DIVIDEND.
+        :param direction: Sorting direction. Enum: ASC (ascending), DESC (descending).
+        """
+        request = GetMarketSectorsDetailRequest()
+        request.set_sector_id(sector_id)
+        request.set_category(category)
+        request.set_period(period)
+        request.set_page_index(page_index)
+        request.set_page_size(page_size)
+        request.set_sort_by(sort_by)
+        request.set_direction(direction)
+        response = self.client.get_response(request)
+        return response
+
+    def get_high_dividend(self, category, sort_by=None, page_index=None, page_size=None, direction=None):
+        """
+        Get high dividend rank list.
+
+        :param category: Security category. Required. (e.g., 'US_STOCK')
+        :param sort_by: Sort field, default is YIELD. Enum: CHANGE_RATIO, RELATIVE_VOLUME_10D, MARKET_VALUE, CLOSE, PRICE, PE_TTM, HIGH, LOW, AMPLITUDE, TURNOVER, VOLUME, YIELD, DIVIDEND.
+        :param page_index: Page index.
+        :param page_size: Number of records per page.
+        :param direction: Sorting direction. Enum: ASC (ascending), DESC (descending).
+        """
+        request = GetHighDividendRequest()
+        request.set_category(category)
+        request.set_sort_by(sort_by)
+        request.set_page_index(page_index)
+        request.set_page_size(page_size)
+        request.set_direction(direction)
+        response = self.client.get_response(request)
+        return response
+
+    def get_52whl(self, category, rank_type=None, sort_by=None, page_index=None, page_size=None, direction=None):
+        """
+        Get 52 week high/low rank list.
+
+        :param category: Security category. Required. (e.g., 'US_STOCK')
+        :param rank_type: Index code. Enum: NEW_HIGH, NEAR_HIGH, NEW_LOW, NEAR_LOW.
+        :param sort_by: Sort field, default is CHANGE_RATIO_52W. Enum: CHANGE_RATIO, RELATIVE_VOLUME_10D, MARKET_VALUE, CLOSE, PRICE, PE_TTM, HIGH, LOW, AMPLITUDE, TURNOVER, VOLUME, YIELD, DIVIDEND.
+        :param page_index: Page index.
+        :param page_size: Number of records per page.
+        :param direction: Sorting direction. Enum: ASC (ascending), DESC (descending).
+        """
+        request = Get52WHLRequest()
+        request.set_rank_type(rank_type)
+        request.set_category(category)
+        request.set_sort_by(sort_by)
+        request.set_page_index(page_index)
+        request.set_page_size(page_size)
+        request.set_direction(direction)
+        response = self.client.get_response(request)
+        return response

webull/data/request/get_capital_flow_request.py

@@ -0,0 +1,35 @@
+# 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 GetCapitalFlowRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/stock/capital-flow", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_count(self, count):
+        if count:
+            self.add_query_param("count", count)

webull/data/request/get_dividend_calendar_request.py

@@ -0,0 +1,31 @@
+# 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 GetDividendCalendarRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/stock/dividend-calendar", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_earnings_calendar_request.py

@@ -0,0 +1,31 @@
+# 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 GetEarningsCalendarRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/stock/earnings-calendar", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_financials_alert_request.py

@@ -0,0 +1,31 @@
+# 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 GetFinancialsAlertRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/financial/alert", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_financials_balance_sheet_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 GetFinancialsBalanceSheetRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/financial/balance-sheet", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_type(self, type):
+        if type:
+            self.add_query_param("type", type)
+
+    def set_count(self, count):
+        if count:
+            self.add_query_param("count", count)

webull/data/request/get_financials_cashflow_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 GetFinancialsCashflowRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/financial/cash-flow", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_type(self, type):
+        if type:
+            self.add_query_param("type", type)
+
+    def set_count(self, count):
+        if count:
+            self.add_query_param("count", count)

webull/data/request/get_financials_income_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 GetFinancialsIncomeRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/financial/income", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_type(self, type):
+        if type:
+            self.add_query_param("type", type)
+
+    def set_count(self, count):
+        if count:
+            self.add_query_param("count", count)

webull/data/request/get_financials_indicators_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 GetFinancialsIndicatorsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/financial/indicators", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_type(self, type):
+        if type:
+            self.add_query_param("type", type)
+
+    def set_count(self, count):
+        if count:
+            self.add_query_param("count", count)

webull/data/request/get_forecast_eps_request.py

@@ -0,0 +1,31 @@
+# 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 GetForecastEpsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/stock/forecast-eps", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_fund_allocation_request.py

@@ -0,0 +1,31 @@
+# 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 GetFundAllocationRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/allocation", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_fund_brief_request.py

@@ -0,0 +1,31 @@
+# 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 GetFundBriefRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/brief", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_fund_dividends_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 GetFundDividendsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/dividends", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_page_index(self, page_index):
+        if page_index:
+            self.add_query_param("page_index", page_index)
+
+    def set_page_size(self, page_size):
+        if page_size:
+            self.add_query_param("page_size", page_size)

webull/data/request/get_fund_files_request.py

@@ -0,0 +1,31 @@
+# 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 GetFundFilesRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/files", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_fund_holdings_request.py

@@ -0,0 +1,31 @@
+# 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 GetFundHoldingsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/holdings", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)

webull/data/request/get_fund_net_value_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 GetFundNetValueRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/net-value", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)
+
+    def set_last_date(self, last_date):
+        if last_date:
+            self.add_query_param("last_date", last_date)
+
+    def set_count(self, count):
+        if count:
+            self.add_query_param("count", count)

webull/data/request/get_fund_performance_request.py

@@ -0,0 +1,31 @@
+# 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 GetFundPerformanceRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/performance", version='v2', method="GET",
+                           query_params={})
+
+    def set_symbol(self, symbol):
+        if symbol:
+            self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        if category:
+            self.add_query_param("category", category)