Merge branch 'feat_broker_hold' into 'master'

Feat broker hold

See merge request server/openapi/openapi-python-sdk!235

Author: tigersk

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.3.5 (2025-04-11)
+### New
+- `QuoteClient.get_broker_hold` 经纪商市值
+
 ## 3.3.4 (2025-04-09)
 ### New
 - `TradeClient.get_aggregate_assets`

tigeropen/__init__.py

@@ -4,4 +4,4 @@
 
 @author: gaoan
 """
-__VERSION__ = '3.3.4'
+__VERSION__ = '3.3.5'

tigeropen/common/consts/service_types.py

@@ -67,6 +67,7 @@
 GET_QUOTE_PERMISSION = "get_quote_permission"
 TRADING_CALENDAR = "trading_calendar"
 STOCK_BROKER = "stock_broker"  # 港股股票实时经纪队列
+BROKER_HOLD = "broker_hold"
 CAPITAL_DISTRIBUTION = "capital_distribution"  # 股票当日资金分布
 CAPITAL_FLOW = "capital_flow"  # 股票资金流向
 WARRANT_FILTER = "warrant_filter"

tigeropen/quote/quote_client.py

@@ -11,14 +11,15 @@
 import pandas as pd
 
 from tigeropen.common.consts import Market, QuoteRight, BarPeriod, OPEN_API_SERVICE_VERSION_V3, \
-    OPEN_API_SERVICE_VERSION_V1, Language
+    OPEN_API_SERVICE_VERSION_V1, Language, SortDirection
 from tigeropen.common.consts import THREAD_LOCAL, SecurityType, CorporateActionType, IndustryLevel
 from tigeropen.common.consts.filter_fields import FieldBelongType
 from tigeropen.common.consts.service_types import GRAB_QUOTE_PERMISSION, QUOTE_DELAY, GET_QUOTE_PERMISSION, \
-    HISTORY_TIMELINE, FUTURE_CONTRACT_BY_CONTRACT_CODE, STOCK_FUNDAMENTAL, TRADE_RANK, TRADING_CALENDAR, FUTURE_CONTRACTS, MARKET_SCANNER, \
+    HISTORY_TIMELINE, FUTURE_CONTRACT_BY_CONTRACT_CODE, STOCK_FUNDAMENTAL, TRADE_RANK, TRADING_CALENDAR, \
+    FUTURE_CONTRACTS, MARKET_SCANNER, \
     STOCK_BROKER, CAPITAL_FLOW, CAPITAL_DISTRIBUTION, WARRANT_REAL_TIME_QUOTE, WARRANT_FILTER, MARKET_SCANNER_TAGS, \
     KLINE_QUOTA, FUND_ALL_SYMBOLS, FUND_CONTRACTS, FUND_QUOTE, FUND_HISTORY_QUOTE, FINANCIAL_CURRENCY, \
-    FINANCIAL_EXCHANGE_RATE, ALL_HK_OPTION_SYMBOLS, OPTION_DEPTH
+    FINANCIAL_EXCHANGE_RATE, ALL_HK_OPTION_SYMBOLS, OPTION_DEPTH, BROKER_HOLD
 from tigeropen.common.consts.service_types import MARKET_STATE, ALL_SYMBOLS, ALL_SYMBOL_NAMES, BRIEF, \
     TIMELINE, KLINE, TRADE_TICK, OPTION_EXPIRATION, OPTION_CHAIN, FUTURE_EXCHANGE, OPTION_BRIEF, \
     OPTION_KLINE, OPTION_TRADE_TICK, FUTURE_KLINE, FUTURE_TICK, FUTURE_CONTRACT_BY_EXCHANGE_CODE, \
@@ -45,7 +46,9 @@
 from tigeropen.quote.request.model import MarketParams, MultipleQuoteParams, MultipleContractParams, \
     FutureQuoteParams, FutureExchangeParams, FutureContractParams, FutureTradingTimeParams, SingleContractParams, \
     SingleOptionQuoteParams, DepthQuoteParams, OptionChainParams, TradingCalendarParams, MarketScannerParams, \
-    StockBrokerParams, CapitalParams, WarrantFilterParams, KlineQuotaParams, SymbolsParams, OptionContractsParams
+    StockBrokerParams, CapitalParams, WarrantFilterParams, KlineQuotaParams, SymbolsParams, OptionContractsParams, \
+    BrokerHoldParams
+from tigeropen.quote.response.broker_hold_response import BrokerHoldResponse
 from tigeropen.quote.response.capital_distribution_response import CapitalDistributionResponse
 from tigeropen.quote.response.capital_flow_response import CapitalFlowResponse
 from tigeropen.quote.response.fund_contracts_response import FundContractsResponse
@@ -1689,6 +1692,27 @@ def get_stock_broker(self, symbol, limit=40, lang=None):
             else:
                 raise ApiException(response.code, response.message)
 
+    def get_broker_hold(self, market=Market.HK, order_by='marketValue', direction=SortDirection.ASC, limit=50,
+                        page=0, lang=None):
+        """获取港股实时经纪队列数据"""
+        params = BrokerHoldParams()
+        params.market = get_enum_value(market)
+        params.order_by = order_by
+        params.direction = get_enum_value(direction.name)
+        params.limit = limit
+        params.page = page
+        params.lang = get_enum_value(lang) if lang else get_enum_value(self._lang)
+        request = OpenApiRequest(BROKER_HOLD, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = BrokerHoldResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.result
+            else:
+                raise ApiException(response.code, response.message)
+                
+
     def get_capital_flow(self, symbol, market, period, begin_time=-1, end_time=-1, limit=200, lang=None):
         """Get capital net inflow Data, including different time periods, such as daily, weekly, monthly, etc.
         :param symbol: 股票代号

tigeropen/quote/request/model.py

@@ -1099,6 +1099,60 @@ def to_openapi_dict(self):
             params['limit'] = self.limit
         return params
 
+class BrokerHoldParams(BaseParams):
+    def __init__(self):
+        super().__init__()
+        self._market = None
+        self._page = None
+        self._limit = None
+        self._order_by = None
+        self._direction = None
+
+    @property
+    def market(self):
+        return self._market
+    @market.setter
+    def market(self, value):
+        self._market = value
+    @property
+    def page(self):
+        return self._page
+    @page.setter
+    def page(self, value):
+        self._page = value
+    @property
+    def limit(self):
+        return self._limit  
+    @limit.setter   
+    def limit(self, value): 
+        self._limit = value
+    @property
+    def order_by(self):
+        return self._order_by
+    @order_by.setter
+    def order_by(self, value):
+        self._order_by = value
+    @property
+    def direction(self):
+        return self._direction
+    @direction.setter
+    def direction(self, value):
+        self._direction = value
+    def to_openapi_dict(self):
+        params = super().to_openapi_dict()  
+        if self.market:
+            params['market'] = self.market
+        if self.page is not None and self.page >= 0:
+            params['page'] = self.page
+        if self.limit:
+            params['limit'] = self.limit
+        if self.order_by:
+            params['order_by'] = self.order_by
+        if self.direction:
+            params['direction'] = self.direction
+        return params
+
+
 
 class CapitalParams(BaseParams):
     def __init__(self):

tigeropen/quote/response/broker_hold_response.py

@@ -0,0 +1,23 @@
+import pandas as pd
+from tigeropen.common.response import TigerResponse
+from tigeropen.common.util import string_utils
+
+class BrokerHoldResponse(TigerResponse):
+    def __init__(self):
+        super().__init__()
+        self.result = None
+        self._is_success = None
+        
+    def parse_response_content(self, response_content):
+        response = super().parse_response_content(response_content)
+        if 'is_success' in response:
+            self._is_success = response['is_success']
+        if self.data:
+            formated_data = string_utils.camel_to_underline_obj(self.data)
+            items = formated_data.get('items')
+            result = pd.DataFrame(data=items)
+            result['page'] = formated_data.get('page')
+            result['total_page'] = formated_data.get('total_page')
+            result['total_count'] = formated_data.get('total_count')
+            self.result = result
+