industry api

tigersk · tigersk · commit a5498c27db4f · 2020-03-18T14:52:05.000+08:00
diff --git a/tigeropen/common/consts/__init__.py b/tigeropen/common/consts/__init__.py
@@ -133,3 +133,14 @@ class CorporateActionType(Enum):
     SPLIT = 'split'  # 拆合股
     DIVIDEND = 'dividend'  # 分红
     EARNINGS_CALENDAR = 'earning'  # 财报日历
+
+
+@unique
+class IndustryLevel(Enum):
+    """
+    行业级别. 级别从1级到4级依次为: GSECTOR, GGROUP, GIND, GSUBIND
+    """
+    GSECTOR = 'GSECTOR'
+    GGROUP = 'GGROUP'
+    GIND = 'GIND'
+    GSUBIND = 'GSUBIND'
diff --git a/tigeropen/common/consts/service_types.py b/tigeropen/common/consts/service_types.py
@@ -65,3 +65,9 @@
 FINANCIAL_DAILY = 'financial_daily'
 FINANCIAL_REPORT = 'financial_report'
 CORPORATE_ACTION = 'corporate_action'
+
+# 行业数据
+INDUSTRY_LIST = 'industry_list'
+INDUSTRY_STOCKS = 'industry_stocks'
+STOCK_INDUSTRY = 'stock_industry'
+
diff --git a/tigeropen/examples/quote_client_demo.py b/tigeropen/examples/quote_client_demo.py
@@ -7,7 +7,7 @@
 import logging
 import pandas as pd
 from tigeropen.common.consts import Market, QuoteRight, FinancialReportPeriodType, Valuation, \
-    Income, Balance, CashFlow, BalanceSheetRatio, Growth, Leverage, Profitability
+    Income, Balance, CashFlow, BalanceSheetRatio, Growth, Leverage, Profitability, IndustryLevel
 
 from tigeropen.quote.quote_client import QuoteClient
 
@@ -108,6 +108,17 @@ def get_fundamental():
     earnings_calendar = openapi_client.get_corporate_earnings_calendar(Market.US, '2020-01-01', '2020-02-01')
     print(earnings_calendar)
 
+    # 行业数据
+    # 获取行业列表
+    industries = quote_client.get_industry_list(IndustryLevel.GGROUP)
+    print(industries)
+    # 获取某行业下公司列表
+    industry_stocks = quote_client.get_industry_stocks(50101020)
+    print(industry_stocks)
+    # 获取某股票的行业
+    stock_industry = quote_client.get_stock_industry('AAPL', Market.US)
+    print(stock_industry)
+
 
 if __name__ == '__main__':
     with pd.option_context('display.max_rows', None, 'display.max_columns', None):
diff --git a/tigeropen/fundamental/request/model.py b/tigeropen/fundamental/request/model.py
@@ -207,3 +207,59 @@ def to_openapi_dict(self):
 
         return params
 
+
+class IndustryParams(object):
+    def __init__(self):
+        self._industry_level = None
+        self._industry_id = None
+        self._market = None
+        self._symbol = None
+
+    @property
+    def industry_level(self):
+        return self._industry_level
+
+    @industry_level.setter
+    def industry_level(self, value):
+        self._industry_level = value
+
+    @property
+    def industry_id(self):
+        return self._industry_id
+
+    @industry_id.setter
+    def industry_id(self, value):
+        self._industry_id = value
+
+    @property
+    def market(self):
+        return self._market
+
+    @market.setter
+    def market(self, value):
+        self._market = value
+
+    @property
+    def symbol(self):
+        return self._symbol
+
+    @symbol.setter
+    def symbol(self, value):
+        self._symbol = value
+
+    def to_openapi_dict(self):
+        params = dict()
+
+        if self.industry_level:
+            params['industry_level'] = self.industry_level
+
+        if self.industry_id:
+            params['industry_id'] = self.industry_id
+
+        if self.market:
+            params['market'] = self.market
+
+        if self.symbol:
+            params['symbol'] = self.symbol
+
+        return params
diff --git a/tigeropen/fundamental/response/industry_response.py b/tigeropen/fundamental/response/industry_response.py
@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+
+import pandas as pd
+import six
+from tigeropen.common.consts import Market
+from tigeropen.common.util.string_utils import get_string
+from tigeropen.common.response import TigerResponse
+
+
+class IndustryListResponse(TigerResponse):
+    def __init__(self):
+        super(IndustryListResponse, self).__init__()
+        self.industry_list = list()
+        self._is_success = None
+
+    def parse_response_content(self, response_content):
+        response = super(IndustryListResponse, self).parse_response_content(response_content)
+        if 'is_success' in response:
+            self._is_success = response['is_success']
+        if self.data:
+            for ind in self.data:
+                industry = dict(industry_level=ind.get('industryLevel'), id=ind.get('id'),
+                                name_cn=get_string(ind.get('nameCN')),
+                                name_en=get_string(ind.get('nameEN')))
+                self.industry_list.append(industry)
+
+
+class IndustryStocksResponse(TigerResponse):
+    def __init__(self):
+        super(IndustryStocksResponse, self).__init__()
+        self.industry_stocks = list()
+        self._is_success = None
+
+    def parse_response_content(self, response_content):
+        response = super(IndustryStocksResponse, self).parse_response_content(response_content)
+        if 'is_success' in response:
+            self._is_success = response['is_success']
+        if self.data:
+            for item in self.data:
+                industry_list = list()
+                industries = item.get('industryDetailDTOList', [])
+                for ind in industries:
+                    industry_list.append(dict(industry_level=ind.get('industryLevel'), id=ind.get('id'),
+                                              name_cn=get_string(ind.get('nameCN')),
+                                              name_en=get_string(ind.get('nameEN'))))
+                company = dict(symbol=item.get('symbol'), company_name=item.get('companyName'),
+                               market=item.get('market'), industry_list=industry_list)
+                self.industry_stocks.append(company)
+
+
+class StockIndustryResponse(TigerResponse):
+    def __init__(self):
+        super(StockIndustryResponse, self).__init__()
+        self.stock_industry = list()
+        self._is_success = None
+
+    def parse_response_content(self, response_content):
+        response = super(StockIndustryResponse, self).parse_response_content(response_content)
+        if 'is_success' in response:
+            self._is_success = response['is_success']
+        if self.data:
+            for item in self.data:
+                industry = dict(industry_level=item.get('industryLevel'), id=item.get('id'),
+                                name_cn=get_string(item.get('nameCN')),
+                                name_en=get_string(item.get('nameEN')))
+                self.stock_industry.append(industry)
diff --git a/tigeropen/quote/quote_client.py b/tigeropen/quote/quote_client.py
@@ -9,14 +9,17 @@
 import delorean
 import six
 
-from tigeropen.common.consts import THREAD_LOCAL, SecurityType, CorporateActionType
+from tigeropen.common.consts import THREAD_LOCAL, SecurityType, CorporateActionType, IndustryLevel
 from tigeropen.common.exceptions import ApiException
-from tigeropen.fundamental.request.model import FinancialDailyParams, FinancialReportParams, CorporateActionParams
+from tigeropen.fundamental.request.model import FinancialDailyParams, FinancialReportParams, CorporateActionParams, \
+    IndustryParams
 from tigeropen.fundamental.response.corporate_dividend_response import CorporateDividendResponse
 from tigeropen.fundamental.response.corporate_earnings_calendar_response import EarningsCalendarResponse
 from tigeropen.fundamental.response.corporate_split_response import CorporateSplitResponse
 from tigeropen.fundamental.response.financial_report_response import FinancialReportResponse
 from tigeropen.fundamental.response.financial_daily_response import FinancialDailyResponse
+from tigeropen.fundamental.response.industry_response import IndustryListResponse, IndustryStocksResponse, \
+    StockIndustryResponse
 from tigeropen.quote.response.future_briefs_response import FutureBriefsResponse
 from tigeropen.quote.response.future_exchange_response import FutureExchangeResponse
 from tigeropen.quote.response.future_contract_response import FutureContractResponse
@@ -47,7 +50,8 @@
     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, \
     FUTURE_TRADING_DATE, QUOTE_SHORTABLE_STOCKS, FUTURE_REAL_TIME_QUOTE, \
-    FUTURE_CURRENT_CONTRACT, QUOTE_REAL_TIME, QUOTE_STOCK_TRADE, FINANCIAL_DAILY, FINANCIAL_REPORT, CORPORATE_ACTION
+    FUTURE_CURRENT_CONTRACT, QUOTE_REAL_TIME, QUOTE_STOCK_TRADE, FINANCIAL_DAILY, FINANCIAL_REPORT, CORPORATE_ACTION, \
+    INDUSTRY_LIST, INDUSTRY_STOCKS, STOCK_INDUSTRY
 from tigeropen.common.consts import Market, Language, QuoteRight, BarPeriod
 from tigeropen.common.util.contract_utils import extract_option_info
 from tigeropen.common.util.common_utils import eastern
@@ -954,3 +958,71 @@ def get_financial_report(self, symbols, market, fields, period_type):
                 return response.financial_report
             else:
                 raise ApiException(response.code, response.message)
+
+    def get_industry_list(self, industry_level=IndustryLevel.GGROUP):
+        """
+        获取行业列表
+        :param industry_level: 行业级别. 可选值为 common.consts.IndustryLevel 枚举类型. 默认一级行业
+        :return: 由行业信息 dict 构成的列表. industry_level 为行业级别, id 为行业 id
+          如 [{'industry_level': 'GGROUP', 'id': '5020', 'name_cn': '媒体与娱乐', 'name_en': 'Media & Entertainment'},
+             {'industry_level': 'GGROUP', 'id': '2550', 'name_cn': '零售业', 'name_en': 'Retailing'},
+             ...]
+        """
+        params = IndustryParams()
+        params.industry_level = industry_level.value
+        request = OpenApiRequest(INDUSTRY_LIST, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = IndustryListResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.industry_list
+            else:
+                raise ApiException(response.code, response.message)
+
+    def get_industry_stocks(self, industry, market=Market.US):
+        """
+        获取某行业下的股票列表
+        :param industry: 行业 id
+        :param market: 市场枚举类型
+        :return: 公司信息列表.
+            如 [{'symbol': 'A', 'company_name': 'A', 'market': 'US', 'industry_list': [{...}, {...},..]},
+               {'symbol': 'B', 'company_name': 'B', 'market': 'US', 'industry_list': [{...}, {...},..]},
+               ...]
+        """
+        params = IndustryParams()
+        params.market = market.value
+        params.industry_id = industry
+        request = OpenApiRequest(INDUSTRY_STOCKS, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = IndustryStocksResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.industry_stocks
+            else:
+                raise ApiException(response.code, response.message)
+
+    def get_stock_industry(self, symbol, market=Market.US):
+        """
+        获取股票的行业
+        :param symbol: 股票 symbol
+        :param market: 市场枚举类型
+        :return: 所属多级行业的列表
+            如 [{'industry_level': 'GSECTOR', 'id': '45', 'name_cn': '信息技术', 'name_en': 'Information Technology'},
+              {'industry_level': 'GGROUP', 'id': '4520', 'name_cn': '技术硬件与设备', 'name_en': 'Technology Hardware & Equipment'},
+              {'industry_level': 'GIND', 'id': '452020', 'name_cn': '电脑与外围设备', 'name_en': 'Technology Hardware, Storage & Peripherals'},
+              {'industry_level': 'GSUBIND', 'id': '45202030', 'name_cn': '电脑硬件、储存设备及电脑周边', 'name_en': 'Technology Hardware, Storage & Peripherals'}]
+        """
+        params = IndustryParams()
+        params.symbol = symbol
+        params.market = market.value
+        request = OpenApiRequest(STOCK_INDUSTRY, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = StockIndustryResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.stock_industry
+            else:
+                raise ApiException(response.code, response.message)
