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

samples/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.10'
+__version__ = '2.0.12'

samples/data/data_client.py

@@ -164,3 +164,123 @@ if __name__ == '__main__':
     res = data_client.option_market_data.get_option_snapshot("AAPL260522C00300000", Category.US_OPTION.name)
     if res.status_code == 200:
         print('get_option_snapshot:', res.json())
+
+    # Fundamentals - Capital Flow
+    res = data_client.fundamentals.get_capital_flow("AAPL", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_capital_flow:', res.json())
+
+    # Fundamentals - Industry Comparison
+    res = data_client.fundamentals.get_industry_comparison("AAPL", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_industry_comparison:', res.json())
+
+    # Fundamentals - SEC Filings
+    res = data_client.fundamentals.get_sec_filings("AAPL", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_sec_filings:', res.json())
+
+    # Fundamentals - Earnings Calendar
+    res = data_client.fundamentals.get_earnings_calendar("AAPL", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_earnings_calendar:', res.json())
+
+    # Fundamentals - Dividend Calendar
+    res = data_client.fundamentals.get_dividend_calendar("TSLA", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_dividend_calendar:', res.json())
+
+    # Fundamentals - Fund Splits
+    res = data_client.fundamentals.get_fund_splits("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_splits:', res.json())
+
+    # Fundamentals - Fund Rating
+    res = data_client.fundamentals.get_fund_rating("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_rating:', res.json())
+
+    # Fundamentals - Fund Performance
+    res = data_client.fundamentals.get_fund_performance("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_performance:', res.json())
+
+    # Fundamentals - Fund Net Value
+    res = data_client.fundamentals.get_fund_net_value("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_net_value:', res.json())
+
+    # Fundamentals - Fund Holdings
+    res = data_client.fundamentals.get_fund_holdings("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_holdings:', res.json())
+
+    # Fundamentals - Fund Files
+    res = data_client.fundamentals.get_fund_files("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_files:', res.json())
+
+    # Fundamentals - Fund Dividends
+    res = data_client.fundamentals.get_fund_dividends("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_dividends:', res.json())
+
+    # Fundamentals - Fund Brief
+    res = data_client.fundamentals.get_fund_brief("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_brief:', res.json())
+
+    # Fundamentals - Fund Allocation
+    res = data_client.fundamentals.get_fund_allocation("QQQ", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_fund_allocation:', res.json())
+
+    # Fundamentals - Financials Indicators
+    res = data_client.fundamentals.get_financials_indicators("TSLA", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_financials_indicators:', res.json())
+
+    # Fundamentals - Financials Income
+    res = data_client.fundamentals.get_financials_income("TSLA", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_financials_income:', res.json())
+
+    # Fundamentals - Financials Cashflow
+    res = data_client.fundamentals.get_financials_cashflow("TSLA", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_financials_cashflow:', res.json())
+
+    # Fundamentals - Financials Balance Sheet
+    res = data_client.fundamentals.get_financials_balance_sheet("TSLA", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_financials_balance_sheet:', res.json())
+
+    # Fundamentals - Financials Alert
+    res = data_client.fundamentals.get_financials_alert("AAPL", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_financials_alert:', res.json())
+
+    # Fundamentals - Forecast EPS
+    res = data_client.fundamentals.get_forecast_eps("AAPL", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_forecast_eps:', res.json())
+
+    # Screener - Market Sectors
+    res = data_client.screener.get_market_sectors(Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_market_sectors:', res.json())
+
+    # Screener - Market Sectors Detail
+    res = data_client.screener.get_market_sectors_detail("6391", Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_market_sectors_detail:', res.json())
+
+    # Screener - High Dividend Rank
+    res = data_client.screener.get_high_dividend(Category.US_STOCK.name)
+    if res.status_code == 200:
+        print('get_high_dividend:', res.json())
+
+    # Screener - 52 Week High/Low
+    res = data_client.screener.get_52whl(Category.US_STOCK.name, rank_type="NEW_HIGH")
+    if res.status_code == 200:
+        print('get_52whl:', res.json())

samples/trade/trade_client_v3.py

@@ -815,7 +815,8 @@ if __name__ == '__main__':
             "order_type": "TRAILING_STOP_LOSS_LIMIT",
             "quantity": "200",
             "trailing_stop_step": "0.1",
-            "trailing_limit_price": "580",
+            # also supports the legacy field name "trailing_limit_price"
+            "trailing_limit_price_offset": "580",
             "trailing_type": "PERCENTAGE",
             "support_trading_session": "CORE",
             "side": "BUY",
@@ -836,7 +837,8 @@ if __name__ == '__main__':
             "stop_price": "560.77",
             "quantity": "200",
             "trailing_stop_step": "0.15",
-            "trailing_limit_price": "581",
+            # also supports the legacy field name "trailing_limit_price"
+            "trailing_limit_price_offset": "581",
             "trailing_type": "PERCENTAGE",
             "trigger_price_type": "PRICE"
         }

webull/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.10'
+__version__ = '2.0.12'

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.0.10'
+__version__ = '2.0.12'
 
 import logging
 

webull/core/common/region.py

@@ -12,3 +12,5 @@ class Region(Enum):
     UK = 'uk'
     BR = 'br'
     MX = 'mx'
+    ZA = 'za'
+    EU = 'eu'

webull/core/data/endpoints.json

@@ -1,6 +1,6 @@
 {
     "default_region": "us",
-    "regions": ["us", "hk", "jp", "sg", "th", "au", "my", "uk", "br", "mx"],
+    "regions": ["us", "hk", "jp", "sg", "th", "au", "my", "uk", "br", "mx", "za", "eu"],
     "region_mapping": {
         "us": {
             "api": "api.webull.com",
@@ -51,6 +51,16 @@
             "api": "api.webull.com",
             "quotes-api": "data-api.webull.com",
             "events-api": "events-api.webull.com"
+        },
+        "za": {
+            "api": "api.webull.com.au",
+            "quotes-api": "data-api.webull.com.au",
+            "events-api": "events-api.webull.com.au"
+        },
+        "eu": {
+            "api": "api.webull.eu",
+            "quotes-api": "data-api.webull.eu",
+            "events-api": "events-api.webull.eu"
         }
     }
 }

webull/core/http/initializer/client_initializer.py

@@ -54,38 +54,12 @@ class ClientInitializer:
     @staticmethod
     def init_token(api_client):
         """Initialize token"""
-        disable_config_region_ids = ["hk"]
-        if api_client.get_region_id() in disable_config_region_ids:
-            if not ClientInitializer._check_region_token_enable(api_client):
-                return
-        else:
-            if not ClientInitializer._check_token_enable(api_client):
-                return
+        if not ClientInitializer._check_token_enable(api_client):
+            return
 
         token_manager = TokenManager(api_client.get_token_dir())
         token_manager.init_token(api_client)
 
-    @staticmethod
-    def _check_region_token_enable(api_client):
-        """
-        Check whether token checking is enabled in the specified region
-        """
-        if api_client is None:
-            logger.warning("_check_region_token_enable api_client is null, return False")
-            return False
-
-        if not api_client.get_region_id():
-            logger.warning("_check_region_token_enable region_id is null, return False")
-            return False
-
-        enable_region_ids = ["hk"]
-        result = api_client.get_region_id() in enable_region_ids
-        logger.info(
-            "_check_region_token_enable result is %s, enable regionIds is %s.",
-            result, enable_region_ids
-        )
-        return result
-
     @staticmethod
     def _check_token_enable(api_client):
         """

webull/data/__init__.py

@@ -1,3 +1,3 @@
 # coding=utf-8
 
-__version__ = '2.0.10'
+__version__ = '2.0.12'

webull/data/data_client.py

@@ -24,6 +24,7 @@ from webull.data.quotes.futures_market_data import FuturesMarketData
 from webull.data.quotes.instrument import Instrument
 from webull.data.quotes.market_data import MarketData
 from webull.data.quotes.option_market_data import OptionMarketData
+from webull.data.quotes.fundamentals import Fundamentals
 from webull.data.quotes.screener import Screener
 from webull.data.quotes.watchlist import Watchlist
 
@@ -38,6 +39,7 @@ class DataClient:
         self.futures_market_data = FuturesMarketData(api_client)
         self.option_market_data = OptionMarketData(api_client)
         self.event_market_data = EventMarketData(api_client)
+        self.fundamentals = Fundamentals(api_client)
         self.screener = Screener(api_client)
         self.watchlist = Watchlist(api_client)
 

webull/data/quotes/fundamentals.py

@@ -0,0 +1,335 @@
+# 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.data.common.category import Category
+from webull.data.request.get_capital_flow_request import GetCapitalFlowRequest
+from webull.data.request.get_industry_comparison_request import GetIndustryComparisonRequest
+from webull.data.request.get_sec_filings_request import GetSecFilingsRequest
+from webull.data.request.get_earnings_calendar_request import GetEarningsCalendarRequest
+from webull.data.request.get_dividend_calendar_request import GetDividendCalendarRequest
+from webull.data.request.get_fund_splits_request import GetFundSplitsRequest
+from webull.data.request.get_fund_rating_request import GetFundRatingRequest
+from webull.data.request.get_fund_performance_request import GetFundPerformanceRequest
+from webull.data.request.get_fund_net_value_request import GetFundNetValueRequest
+from webull.data.request.get_fund_holdings_request import GetFundHoldingsRequest
+from webull.data.request.get_fund_files_request import GetFundFilesRequest
+from webull.data.request.get_fund_dividends_request import GetFundDividendsRequest
+from webull.data.request.get_fund_brief_request import GetFundBriefRequest
+from webull.data.request.get_fund_allocation_request import GetFundAllocationRequest
+from webull.data.request.get_financials_indicators_request import GetFinancialsIndicatorsRequest
+from webull.data.request.get_financials_income_request import GetFinancialsIncomeRequest
+from webull.data.request.get_financials_cashflow_request import GetFinancialsCashflowRequest
+from webull.data.request.get_financials_balance_sheet_request import GetFinancialsBalanceSheetRequest
+from webull.data.request.get_financials_alert_request import GetFinancialsAlertRequest
+from webull.data.request.get_forecast_eps_request import GetForecastEpsRequest
+
+
+class Fundamentals:
+    def __init__(self, api_client):
+        self.client = api_client
+
+    def get_capital_flow(self, symbol, category=Category.US_STOCK.name, count=None):
+        """
+        Query the capital flow distribution for a stock.
+
+        :param symbol: Security symbol, e.g. AAPL, TSLA.
+        :param category: Security type. Supported: US_STOCK, HK_STOCK, CN_STOCK, JP_STOCK.
+        :param count: Number of distribution records (default 5), range 1-5.
+        """
+        request = GetCapitalFlowRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_count(count)
+        response = self.client.get_response(request)
+        return response
+
+    def get_industry_comparison(self, symbol, category=Category.US_STOCK.name, sort_by=None):
+        """
+        Query industry comparison data for a stock. Shows up to 20 stocks in the same industry, including the target stock.
+
+        :param symbol: Security symbol, e.g. AAPL, TSLA.
+        :param category: Security type. Supported: US_STOCK, HK_STOCK, CN_STOCK.
+        :param sort_by: Sort by a certain type. Default: EPS_TTM. Options: EPS_TTM, NAPS, DPS_TTM, ROE, DEBT_TO_ASSETS, NET_MARGIN, DIV_YIELD_TTM, PE_TTM, PB_RATIO.
+        """
+        request = GetIndustryComparisonRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_sort_by(sort_by)
+        response = self.client.get_response(request)
+        return response
+
+    def get_sec_filings(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query SEC filings for a stock. Only supports US stocks. Returns data within the last 3 years.
+
+        :param symbol: Security symbol, e.g. AAPL, TSLA.
+        :param category: Security type. Only supports US_STOCK.
+        """
+        request = GetSecFilingsRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_earnings_calendar(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query earnings calendar for a stock. Returns earnings reports within half a year before and after the current date.
+        Sorted by date in ascending order (oldest to newest).
+        Use eps_actual to distinguish published reports (has eps_actual value) from upcoming ones (no eps_actual value).
+
+        :param symbol: Security symbol, e.g. AAPL, TSLA.
+        :param category: Security type. Supported: US_STOCK, HK_STOCK, CN_STOCK, JP_STOCK.
+        """
+        request = GetEarningsCalendarRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_dividend_calendar(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query dividend calendar for a stock. Returns dividends within half a year before and after the current date.
+        Sorted by date in ascending order (oldest to newest).
+
+        :param symbol: Security symbol, e.g. AAPL, TSLA.
+        :param category: Security type. Supported: US_STOCK, HK_STOCK, CN_STOCK, JP_STOCK.
+        """
+        request = GetDividendCalendarRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_splits(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund splits for a stock.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundSplitsRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_rating(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund rating for a security.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundRatingRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_performance(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund performance for a security.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundPerformanceRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_net_value(self, symbol, category=Category.US_STOCK.name, last_date=None, count=None):
+        """
+        Query fund net value for a security.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        :param last_date: Last query date, e.g. 2026-04-01.
+        :param count: The number of each query, default 5, maximum 20.
+        """
+        request = GetFundNetValueRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_last_date(last_date)
+        request.set_count(count)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_holdings(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund top 10 holdings.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundHoldingsRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_files(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund files for a security.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundFilesRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_dividends(self, symbol, category=Category.US_STOCK.name, page_index=None, page_size=None):
+        """
+        Query fund dividends for a security.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        :param page_index: Page index, default 1. If not passed, the first page will be searched by default.
+        :param page_size: Number of entries per page, default 10, maximum 20.
+        """
+        request = GetFundDividendsRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_page_index(page_index)
+        request.set_page_size(page_size)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_brief(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund brief information.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundBriefRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_fund_allocation(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query fund asset allocation.
+
+        :param symbol: Security symbol, e.g. QQQ.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFundAllocationRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_financials_indicators(self, symbol, category=Category.US_STOCK.name, type=None, count=None):
+        """
+        Query financials indicators for a stock.
+
+        :param symbol: Security symbol, e.g. TSLA.
+        :param category: Security type. Category values are as shown in the enum.
+        :param type: Financial type, default QUARTERLY. Options: ANNUAL, QUARTERLY.
+        :param count: The number of each query, default 5, maximum 20.
+        """
+        request = GetFinancialsIndicatorsRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_type(type)
+        request.set_count(count)
+        response = self.client.get_response(request)
+        return response
+
+    def get_financials_income(self, symbol, category=Category.US_STOCK.name, type=None, count=None):
+        """
+        Query financials income statement for a stock.
+
+        :param symbol: Security symbol, e.g. TSLA.
+        :param category: Security type. Category values are as shown in the enum.
+        :param type: Financial type, default QUARTERLY. Options: ANNUAL, QUARTERLY.
+        :param count: The number of each query, default 5, maximum 20.
+        """
+        request = GetFinancialsIncomeRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_type(type)
+        request.set_count(count)
+        response = self.client.get_response(request)
+        return response
+
+    def get_financials_cashflow(self, symbol, category=Category.US_STOCK.name, type=None, count=None):
+        """
+        Query financials cashflow statement for a stock.
+
+        :param symbol: Security symbol, e.g. TSLA.
+        :param category: Security type. Category values are as shown in the enum.
+        :param type: Financial type, default QUARTERLY. Options: ANNUAL, QUARTERLY.
+        :param count: The number of each query, default 5, maximum 20.
+        """
+        request = GetFinancialsCashflowRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_type(type)
+        request.set_count(count)
+        response = self.client.get_response(request)
+        return response
+
+    def get_financials_balance_sheet(self, symbol, category=Category.US_STOCK.name, type=None, count=None):
+        """
+        Query financials balance sheet for a stock.
+
+        :param symbol: Security symbol, e.g. TSLA.
+        :param category: Security type. Category values are as shown in the enum.
+        :param type: Financial type, default QUARTERLY. Options: ANNUAL, QUARTERLY.
+        :param count: The number of each query, default 5, maximum 20.
+        """
+        request = GetFinancialsBalanceSheetRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        request.set_type(type)
+        request.set_count(count)
+        response = self.client.get_response(request)
+        return response
+
+    def get_financials_alert(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query financials alert for a stock.
+
+        :param symbol: Security symbol, e.g. TSLA.
+        :param category: Security type. Category values are as shown in the enum.
+        """
+        request = GetFinancialsAlertRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response
+
+    def get_forecast_eps(self, symbol, category=Category.US_STOCK.name):
+        """
+        Query forecast EPS for a stock. Returns the historical actual EPS of the most recent four disclosed
+        fiscal periods, plus the latest analyst consensus forecast EPS (if available).
+        Sorted by time in ascending order, returns up to 5 records.
+
+        :param symbol: Security symbol, e.g. AAPL. Only supports a single symbol.
+        :param category: Security type. Supported: US_STOCK, HK_STOCK, CN_STOCK.
+        """
+        request = GetForecastEpsRequest()
+        request.set_symbol(symbol)
+        request.set_category(category)
+        response = self.client.get_response(request)
+        return response