capical flow api;

Author: tigersk

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.2.4 (2022-12-09)
+### new
+- 资金流接口 `QuoteClient.get_capital_flow`
+- 资金分布接口 `QuoteClient.get_capital_distribution`
+- 港股经纪商接口 `QuoteClient.get_stock_broker`
+
+
 ## 2.2.3 (2022-12-07)
 ### new
 - 选股器 `QuoteClient.market_scanner`

tigeropen/__init__.py

@@ -4,4 +4,4 @@
 
 @author: gaoan
 """
-__VERSION__ = '2.2.3'
+__VERSION__ = '2.2.4'

tigeropen/common/consts/__init__.py

@@ -107,6 +107,16 @@ class BarPeriod(Enum):
     SIX_HOURS = '6hour'  # 6小时
 
 
+class CapitalPeriod(Enum):
+    INTRADAY = "intraday"
+    DAY = "day"
+    WEEK = "week"
+    MONTH = "month"
+    YEAR = "year"
+    QUARTER = "quarter"
+    HALFAYEAR = "6month"
+
+
 class OrderStatus(Enum):
     PENDING_NEW = 'PendingNew'
     NEW = 'Initial'  # 订单初始状态

tigeropen/examples/quote_client_demo.py

@@ -10,7 +10,7 @@
 import pandas as pd
 from tigeropen.common.consts import Market, QuoteRight, FinancialReportPeriodType, Valuation, \
     Income, Balance, CashFlow, BalanceSheetRatio, Growth, Leverage, Profitability, IndustryLevel, BarPeriod, \
-    SortDirection
+    SortDirection, CapitalPeriod
 from tigeropen.common.consts.filter_fields import AccumulateField, StockField, FinancialField, MultiTagField, \
     AccumulatePeriod, FinancialPeriod
 from tigeropen.quote.domain.filter import OptionFilter, StockFilter, SortFilterData
@@ -187,7 +187,7 @@ def get_fundamental():
     print(stock_industry)
 
 
-def test_market_scanner(self):
+def test_market_scanner():
     # 股票基本数据过滤(is_no_filter为True时表示不启用该过滤器)
     base_filter1 = StockFilter(StockField.FloatShare, filter_min=1e7, filter_max=1e13, is_no_filter=True)
     base_filter2 = StockFilter(StockField.MarketValue, filter_min=1e8, filter_max=1e14, is_no_filter=False)
@@ -240,24 +240,47 @@ def test_market_scanner(self):
     print(f'scanned symbols:{scanner_result_symbols}')
 
 
-def test_stock_broker(self):
+def test_stock_broker():
     """
 
     :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'}]}]}
+    StockBroker({'symbol': '01810',
+        'bid_broker': [
+            LevelBroker({'level': 1, 'price': 11.46, 'broker_count': 5,
+                'broker': [Broker({'id': '5999', 'name': '中国创盈'}), Broker({'id': '4374', 'name': '巴克莱亚洲'}),
+                        Broker({'id': '1438', 'name': 'Susquehanna'}), Broker({'id': '4821', 'name': '华盛'}),
+                         Broker({'id': '6998', 'name': '中国投资'})]})],
+        'ask_broker': [
+            LevelBroker({'level': 1, 'price': 11.48, 'broker_count': 5,
+                'broker': [Broker({'id': '4374', 'name': '巴克莱亚洲'}), Broker({'id': '9056', 'name': '瑞银'}),
+                        Broker({'id': '2027', 'name': '东亚'}), Broker({'id': '4821', 'name': '华盛'}),
+                        Broker({'id': '4374', 'name': '巴克莱亚洲'})]})]})
     """
-    result = openapi_client.get_stock_broker('00700', limit=5)
+    result = openapi_client.get_stock_broker('01810', limit=5)
+    print(result)
+
+
+def test_capital_flow():
+    """
+               time      timestamp    net_inflow symbol period
+    0    2022-02-24  1645678800000 -5.889058e+08   AAPL    day
+    1    2022-02-25  1645765200000 -1.229127e+08   AAPL    day
+    2    2022-02-28  1646024400000  1.763644e+08   AAPL    day
+    """
+    result = openapi_client.get_capital_flow('AAPL', market=Market.US, period=CapitalPeriod.INTRADAY)
+    print(result)
+
+
+def test_capital_distribution():
+    """
+
+    :return:
+    CapitalDistribution({'symbol': 'JD', 'net_inflow': -14178801.76, 'in_all': 157357147.5,
+    'in_big': 25577130.842900004, 'in_mid': 13664116.789999994, 'in_small': 118115899.86410056,
+    'out_all': 171535949.25, 'out_big': 22642951.677099995, 'out_mid': 12733553.691200001,
+    'out_small': 136159443.88620025})
+    """
+    result = openapi_client.get_capital_distribution('JD', market=Market.US)
     print(result)
 
 

tigeropen/quote/domain/capital_distribution.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/12/9
+# @Author  : sukai
+class CapitalDistribution:
+    def __init__(self):
+        self.symbol = None
+        self.net_inflow = None
+        self.in_all = None
+        self.in_big = None
+        self.in_mid = None
+        self.in_small = None
+        self.out_all = None
+        self.out_big = None
+        self.out_mid = None
+        self.out_small = None
+
+    def __repr__(self):
+        return "CapitalDistribution(%s)" % self.__dict__

tigeropen/quote/domain/stock_broker.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/12/9
+# @Author  : sukai
+
+class Broker:
+    def __init__(self):
+        self.id = None
+        self.name = None
+
+    def __repr__(self):
+        return "Broker(%s)" % self.__dict__
+
+
+class LevelBroker:
+    def __init__(self):
+        self.level = None
+        self.price = None
+        self.broker_count = None
+        self.broker = None
+
+    def __repr__(self):
+        return "LevelBroker(%s)" % self.__dict__
+
+
+class StockBroker:
+    def __init__(self):
+        self.symbol = None
+        self.bid_broker = None
+        self.ask_broker = None
+
+    def __repr__(self):
+        return "StockBroker(%s)" % self.__dict__

tigeropen/quote/quote_client.py

@@ -15,7 +15,8 @@
 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, STOCK_BROKER
+    HISTORY_TIMELINE, FUTURE_CONTRACT_BY_CONTRACT_CODE, TRADING_CALENDAR, FUTURE_CONTRACTS, MARKET_SCANNER, \
+    STOCK_BROKER, CAPITAL_FLOW, CAPITAL_DISTRIBUTION
 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, \
@@ -39,7 +40,9 @@
 from tigeropen.quote.request.model import MarketParams, MultipleQuoteParams, MultipleContractParams, \
     FutureQuoteParams, FutureExchangeParams, FutureContractParams, FutureTradingTimeParams, SingleContractParams, \
     SingleOptionQuoteParams, DepthQuoteParams, OptionChainParams, TradingCalendarParams, MarketScannerParams, \
-    StockBrokerParams
+    StockBrokerParams, CapitalParams
+from tigeropen.quote.response.capital_distribution_response import CapitalDistributionResponse
+from tigeropen.quote.response.capital_flow_response import CapitalFlowResponse
 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
@@ -1411,7 +1414,6 @@ def grab_quote_permission(self):
                 return response.permissions
             else:
                 raise ApiException(response.code, response.message)
-        return False
 
     def get_quote_permission(self):
         """
@@ -1431,7 +1433,6 @@ def get_quote_permission(self):
                 return response.permissions
             else:
                 raise ApiException(response.code, response.message)
-        return False
 
     def get_trading_calendar(self, market, begin_date=None, end_date=None):
         """
@@ -1455,7 +1456,6 @@ def get_trading_calendar(self, market, begin_date=None, end_date=None):
                 return response.calendar
             else:
                 raise ApiException(response.code, response.message)
-        return False
 
     def get_stock_broker(self, symbol, limit=40, lang=None):
         """Get stock broker information
@@ -1476,4 +1476,52 @@ def get_stock_broker(self, symbol, limit=40, lang=None):
                 return response.result
             else:
                 raise ApiException(response.code, response.message)
-        return False
+
+    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: 股票代号
+        :param market: tigeropen.common.consts.Market
+        :param period: period, possible values are: intraday, day, week, month, year, quarter, 6month
+        :param begin_time: 开始时间. 若是时间戳需要精确到毫秒, 为13位整数;
+                                    或是日期时间格式的字符串, 如 "2019-01-01" 或 "2019-01-01 12:00:00"
+        :param end_time: 结束时间. 格式同 begin_time
+        :param limit: 数量限制
+        :param lang: 语言支持: zh_CN,zh_TW,en_US
+        """
+        params = CapitalParams()
+        params.symbol = symbol
+        params.market = get_enum_value(market)
+        params.period = get_enum_value(period)
+        params.begin_time = begin_time
+        params.end_time = end_time
+        params.limit = limit
+        params.lang = get_enum_value(lang) if lang else get_enum_value(self._lang)
+        request = OpenApiRequest(CAPITAL_FLOW, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = CapitalFlowResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.result
+            else:
+                raise ApiException(response.code, response.message)
+
+    def get_capital_distribution(self, symbol, market, lang=None):
+        """Get capital distribution.
+        :param symbol: 股票代号
+        :param market: tigeropen.common.consts.Market
+        :param lang: 语言支持: zh_CN,zh_TW,en_US
+        """
+        params = CapitalParams()
+        params.symbol = symbol
+        params.market = get_enum_value(market)
+        params.lang = get_enum_value(lang) if lang else get_enum_value(self._lang)
+        request = OpenApiRequest(CAPITAL_DISTRIBUTION, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = CapitalDistributionResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.result
+            else:
+                raise ApiException(response.code, response.message)

tigeropen/quote/request/model.py

@@ -979,3 +979,78 @@ def to_openapi_dict(self):
         if self.limit:
             params['limit'] = self.limit
         return params
+
+
+class CapitalParams(BaseParams):
+    def __init__(self):
+        super().__init__()
+        self._symbol = None
+        self._market = None
+        self._period = None
+        self._begin_time = None
+        self._end_time = None
+        self._limit = None
+
+    @property
+    def symbol(self):
+        return self._symbol
+
+    @symbol.setter
+    def symbol(self, value):
+        self._symbol = value
+
+    @property
+    def market(self):
+        return self._market
+
+    @market.setter
+    def market(self, value):
+        self._market = value
+
+    @property
+    def period(self):
+        return self._period
+
+    @period.setter
+    def period(self, value):
+        self._period = value
+
+    @property
+    def begin_time(self):
+        return self._begin_time
+
+    @begin_time.setter
+    def begin_time(self, value):
+        self._begin_time = value
+
+    @property
+    def end_time(self):
+        return self._end_time
+
+    @end_time.setter
+    def end_time(self, value):
+        self._end_time = 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.market:
+            params['market'] = self.market
+        if self.period:
+            params['period'] = self.period
+        if self.begin_time:
+            params['begin_time'] = self.begin_time
+        if self.end_time:
+            params['end_time'] = self.end_time
+        if self.limit:
+            params['limit'] = self.limit
+        return params

tigeropen/quote/response/capital_distribution_response.py

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