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

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)

webull/data/request/get_fund_rating_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 GetFundRatingRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/rating", 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_splits_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 GetFundSplitsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/fund/splits", 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_industry_comparison_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 GetIndustryComparisonRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/stock/industry-comparison", 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_sort_by(self, sort_by):
+        if sort_by:
+            self.add_query_param("sort_by", sort_by)

webull/data/request/get_sec_filings_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 GetSecFilingsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/fundamentals/stock/filings", 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/screener/get_52whl_request.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 Get52WHLRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/screener/52whl", version='v2', 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_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)
+
+    def set_direction(self, direction):
+        if direction:
+            self.add_query_param("direction", direction)