hk stock broker api

Author: tigersk

tigeropen/common/consts/service_types.py

@@ -55,6 +55,9 @@
 MARKET_SCANNER = "market_scanner"  # 选股器
 GET_QUOTE_PERMISSION = "get_quote_permission"
 TRADING_CALENDAR = "trading_calendar"
+STOCK_BROKER = "stock_broker"  # 港股股票实时经纪队列
+CAPITAL_DISTRIBUTION = "capital_distribution"  # 股票当日资金分布
+CAPITAL_FLOW = "capital_flow"  # 股票资金流向
 
 # 期权行情
 OPTION_EXPIRATION = "option_expiration"

tigeropen/examples/quote_client_demo.py

@@ -240,6 +240,26 @@ def test_market_scanner(self):
     print(f'scanned symbols:{scanner_result_symbols}')
 
 
+def test_stock_broker(self):
+    """
+
+    :return:
+    {'symbol': '00700',
+    'bid_broker':
+        [{'level': 1, 'price': 322.4, 'broker_count': 5,
+        'broker': [{'id': '5345', 'name': 'J.P. Morgan'},
+            {'id': '6996', 'name': '中国投资'}, {'id': '6999', 'name': '中国投资'}, {'id': '6999', 'name': '中国投资'},
+             {'id': '6997', 'name': '中国投资'}]}],
+    'ask_broker':
+        [{'level': 1, 'price': 322.6, 'broker_count': 2,
+            'broker': [{'id': '8461', 'name': 'FUTU Securities'}, {'id': '7389', 'name': '花旗'}]},
+        {'level': 2, 'price': 322.8, 'broker_count': 3,
+            'broker': [{'id': '6999', 'name': '中国投资'},
+            {'id': '0746', 'name': '万邦亚太'}, {'id': '5339', 'name': 'J.P. Morgan'}]}]}
+    """
+    result = openapi_client.get_stock_broker('00700', limit=5)
+    print(result)
+
 
 if __name__ == '__main__':
     with pd.option_context('display.max_rows', None, 'display.max_columns', None):

tigeropen/quote/quote_client.py

@@ -15,7 +15,7 @@
 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, TRADING_CALENDAR, FUTURE_CONTRACTS, MARKET_SCANNER
+    HISTORY_TIMELINE, FUTURE_CONTRACT_BY_CONTRACT_CODE, TRADING_CALENDAR, FUTURE_CONTRACTS, MARKET_SCANNER, STOCK_BROKER
 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, \
@@ -38,7 +38,8 @@
 from tigeropen.quote.domain.filter import OptionFilter
 from tigeropen.quote.request.model import MarketParams, MultipleQuoteParams, MultipleContractParams, \
     FutureQuoteParams, FutureExchangeParams, FutureContractParams, FutureTradingTimeParams, SingleContractParams, \
-    SingleOptionQuoteParams, DepthQuoteParams, OptionChainParams, TradingCalendarParams, MarketScannerParams
+    SingleOptionQuoteParams, DepthQuoteParams, OptionChainParams, TradingCalendarParams, MarketScannerParams, \
+    StockBrokerParams
 from tigeropen.quote.response.future_briefs_response import FutureBriefsResponse
 from tigeropen.quote.response.future_contract_response import FutureContractResponse
 from tigeropen.quote.response.future_exchange_response import FutureExchangeResponse
@@ -61,6 +62,7 @@
 from tigeropen.quote.response.quote_timeline_response import QuoteTimelineResponse
 from tigeropen.quote.response.market_scanner_response import MarketScannerResponse
 from tigeropen.quote.response.stock_briefs_response import StockBriefsResponse
+from tigeropen.quote.response.stock_broker_response import StockBrokerResponse
 from tigeropen.quote.response.stock_details_response import StockDetailsResponse
 from tigeropen.quote.response.stock_short_interest_response import ShortInterestResponse
 from tigeropen.quote.response.stock_trade_meta_response import TradeMetaResponse
@@ -1454,3 +1456,24 @@ def get_trading_calendar(self, market, begin_date=None, end_date=None):
             else:
                 raise ApiException(response.code, response.message)
         return False
+
+    def get_stock_broker(self, symbol, limit=40, lang=None):
+        """Get stock broker information
+        :param symbol:
+        :param limit: The maximum number of items returned. Default value is 40.
+        :param lang: tigeropen.common.consts.Language
+        """
+        params = StockBrokerParams()
+        params.symbol = symbol
+        params.limit = limit
+        params.lang = get_enum_value(lang) if lang else get_enum_value(self._lang)
+        request = OpenApiRequest(STOCK_BROKER, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = StockBrokerResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.result
+            else:
+                raise ApiException(response.code, response.message)
+        return False

tigeropen/quote/request/model.py

@@ -929,7 +929,8 @@ def to_openapi_dict(self):
         "market":"US"}
         :return:
         """
-        params = dict()
+        params = super().to_openapi_dict()
+
         if self.market:
             params['market'] = self.market
         if self.base_filter_list:
@@ -947,3 +948,34 @@ def to_openapi_dict(self):
         if self.page_size is not None:
             params['page_size'] = self.page_size
         return params
+
+
+class StockBrokerParams(BaseParams):
+    def __init__(self):
+        super().__init__()
+        self._symbol = None
+        self._limit = None
+
+    @property
+    def symbol(self):
+        return self._symbol
+
+    @symbol.setter
+    def symbol(self, value):
+        self._symbol = value
+
+    @property
+    def limit(self):
+        return self._limit
+
+    @limit.setter
+    def limit(self, value):
+        self._limit = value
+
+    def to_openapi_dict(self):
+        params = super().to_openapi_dict()
+        if self.symbol:
+            params['symbol'] = self.symbol
+        if self.limit:
+            params['limit'] = self.limit
+        return params

tigeropen/quote/response/stock_broker_response.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022-12-09
+# @Author  : sukai
+from tigeropen.common.response import TigerResponse
+from tigeropen.common.util import string_utils
+
+
+class StockBrokerResponse(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:
+            self.result = string_utils.camel_to_underline_obj(self.data)