Merge branch 'master' into feature_stock_screener

market screener

Author: tigersk

.gitignore

@@ -139,4 +139,3 @@ cython_debug/
 
 .idea
 .DS_Store
-

CHANGELOG.md

@@ -1,3 +1,143 @@
+## 2.2.2 (2022-11-22)
+### New
+- 订单支持GTD类型, 下单时可通过指定 Order 属性 time_in_force = "GTD" 设置
+- 订单成交明细支持长链接订阅推送
+
+## 2.2.1 (2022-11-07)
+### Fixed
+- 修复 `TradeClient.get_trade_ticks` begin_index 参数传 0 不生效的问题
+
+
+## 2.2.0 (2022-11-01)
+### New
+- 长链接支持期货逐笔推送. 可通过 `PushClient.subscribe_tick` 订阅，使用 `PushClient.tick_changed` 接收回调
+
+
+## 2.1.9 (2022-10-12)
+### New
+- 支持多牌照配置, 分牌照请求不同域名. 可通过 client_config.license 指定牌照
+### Modify
+- `Contract` 新增属性 `short_initial_margin`, `short_maintenance_margin`, 新增方法 `to_str()` 可打印全部属性
+- `QuoteClient.get_financial_report` 增加参数 `begin_date`, `end_date`
+- `QuoteClient.get_trade_ticks` 兼容 1.0 版本接口
+
+
+## 2.1.8 (2022-08-26)
+### Modify
+- `TradeClient.get_orders` 新增参数 `seg_type`， 可指定交易品种(证券SEC/期货FUT/全部ALL)  
+- `PushClient` 修改自动重连重试次数
+- `TradeClient.get_contract` 接口版本升级到V3
+### Fixed
+- 修复 `TradeClient.get_contract` 获取港股期权合约时返回空的问题
+
+
+## 2.1.7 (2022-08-19)
+### New
+- 新增获取期货某类型所有合约接口 `QuoteClient.get_all_future_contracts`
+- 附加订单支持追踪止损单
+
+### Breaking
+- 期货tick接口 `QuoteClient.get_future_trade_ticks`, 合约参数由接受列表改为只接受单个合约
+
+## 2.1.6 (2022-08-11)
+### Modify
+- 支持全局时区配置， 可通过 ClientConfig.timezone 设置时区
+
+
+## 2.1.5 (2022-08-01) 
+### Modify
+- 交易相关接口支持全局语言配置, 可通过 ClientConfig.language 改变默认语言
+
+
+## 2.1.4 (2022-07-18)
+### New
+- 新增历史资产分析接口 `TradeClient.get_analytics_asset`
+- 新增合约价格校正工具函数 `tigeropen.common.util.price_util.PriceUtil`, 可根据请求到的合约tick size, 校正输入的下单价格
+- 订单对象新增属性: 更新时间: `update_time`
+- 查询订单列表接口 `TradeClieng.get_orders (get_open_orders/get_filled_orders)` 支持指定排序规则, 按照订单创建时间或订单状态更新时间排序
+- 查询持仓接口 `TradeClient.get_positions` 支持期权要素(expiry, strike, put_call)参数过滤
+
+
+## 2.1.3 (2022-07-01)
+### New
+- 长连接新增逐笔订阅: `PushClient.subscribe_tick`, 退订 `PushClient.unsubscribe_tick`
+- 新增已订阅查询回调方法 `PushClient.query_subscribed_callback` 取代旧有的 `Pushclient.subscribed_symbols`
+- `QuoteClient.get_trade_ticks` 新增 `trade_session` 参数，可指定该参数查询盘前盘后数据
+
+### Modify
+- `Pushclient.subscribed_symbols` 标记为废弃
+
+
+## 2.1.2 (2022-06-14)
+### Modify
+- 升级 stomp.py 版本, 将之前的 4.1.24 升级到 8.0.1
+### Breaking
+- PushClient 去除 `auto_reconnect` 参数，如需自定义重连方式，可自定义方法并绑定 `disconnect_callback` 进行重连
+- 处理连接被踢的情况，如果有多台设备使用相同 tiger_id 连接, 新连接会将较早的连接踢掉，较早连接会抛出异常，停止接收消息
+
+## 2.1.1 (2022-05-25)
+### New
+- 新增批量分页获取k线接口
+  股票：`QuoteClient.get_bars_by_page`
+  期货：`QuoteClient.get_future_bars_by_page`
+- `QuoteClient.get_future_bars`, `QuoteClient.get_bars` 增加 `page_token` 参数，可用于分页请求定位下一页位置
+- `tigeropen.trade.domain.order.Order` 新增 `user_mark` 属性，用户下单时可传入一定长度的备注信息，该属性值在查询订单时会返回。(需用户提前向平台申请配置)
+
+## 2.1.0 (2022-05-07)
+### New
+- 动态获取服务域名；更改默认域名
+- 新增期权计算工具(examples.option_helpers.helpers)
+- 新增根据期货代码获取期货合约接口 `QuoteClient.get_future_contract`
+- 新增根据正股查衍生合约接口 `TradeClient.get_derivative_contracts`
+
+
+## 2.0.9 (2022-04-18)
+### New
+- 新增历史分时接口 `QuoteClient.get_timeline_history`
+- Order 对象新增字段
+  sub_ids: 附加订单子订单id列表(仅在下附加订单时此字段会有值)
+  adjust_limit: 限价单价格调整限制比例(作为下单参数使用, 查询时不返回)
+  
+### Breaking
+- 下单 `TradeClient.place_order`, 改单 `TradeClient.modify_order`, 撤单 `TradeClient.cancel_order` 三个接口返回值，由之前的
+  `True` 或 `False` 改为订单 id
+- 行情权限抢占，改为在 `QuoteClient` 初始化时默认自动抢占，提供参数 `is_grab_permission` 可配置为不自动抢占。若该参数设置为 `False`, 
+  则需用户自行调用 `QuoteClient.grab_quote_permission()` 进行行情权限抢占
+
+
+## 2.0.7 (2022-01-31)
+### Modify
+- 修改服务域名
+
+## 2.0.6 (2022-01-24)
+### New 
+- Contract 合约对象新增字段。  
+  marginable：是否可融资  
+  close_only：是否只允许平仓   
+  shortable_count：做空池剩余  
+- Order 订单对象新增字段。
+  attr_desc：属性描述（如期权是否为被动行权）  
+  source：订单来源  
+
+### Breaking
+- 将 `tigeropen.quote.request.OpenApiRequest` 移动到 `tigeropen.common.request.OpenApiRequest`
+
+
+## 2.0.5 (2022-01-10)
+### New
+- 查询行情权限接口 QuoteClient.get_quote_permission
+- 订单综合账户成交记录接口 TradeClient.get_transactions
+- 增加一个完整的策略示例
+
+### Changed
+- 方法枚举参数优化，使用枚举参数的方法也可以直接使用该枚举对应值
+- TradeClient.place_order 去除返回数据中 Order.order_id 属性的校验
+- 将 SDK 内部的日志级别由 INFO 调整为 DEBUG, 防止默认情况下输出 SDK 的日志
+- 去除 pandas 固定版本号, 方便安装时灵活指定版本
+
+### Breaking
+- 行情权限抢占接口 QuoteClient.grab_quote_permission 返回的数据项中，'expireAt' 字段格式转换为 'expire_at'
+
 ## 2.0.4 (2021-12-08)
 ### New
 - 综合/模拟账户查询资产接口 TradeClient.get_prime_assets

README.md

@@ -4,7 +4,7 @@
 
 老虎开放平台可以为个人开发者和机构客户提供接口服务，投资者可以充分的利用老虎的交易服务、行情服务、账户服务等实现自己的投资应用程序。
 
-- [官方在线文档](https://quant.itiger.com/openapi/py-docs/zh-cn/docs/intro/quickstart.html)
+- [官方在线文档](https://quant.itiger.com/openapi/zh/python/overview/introduction.html)
 
 -------------------
 
@@ -22,9 +22,9 @@ python setup.py install
 ### 使用须知
 
 - 接入前需要在[开放平台](https://quant.itiger.com/#openapi)登记开发者信息
-- 详情查看[接入说明](https://quant.itiger.com/openapi/py-docs/zh-cn/docs/intro/quickstart.html)
+- 详情查看[接入说明](https://quant.itiger.com/openapi/zh/python/overview/introduction.html)
 
-###### 注: 本SDK当前支持Python2, Python3
+###### 注: 本SDK当前支持 Python3.4 及以上版本
 
 ---
 
@@ -47,7 +47,6 @@ from tigeropen.trade.trade_client import TradeClient
 
 def get_client_config():
     """
-    https://www.itiger.com/openapi/info 开发者信息获取
     :return:
     """
     is_sandbox = False

requirements.txt

@@ -1,9 +1,10 @@
-simplejson==3.17.3
+simplejson==3.17.6
 delorean==1.0.0
-pandas==1.1.5
+pandas
 python-dateutil==2.8.2
-pytz==2021.1
+pytz==2022.1
 pyasn1==0.4.8
-rsa==4.7.2
-stomp.py==4.1.24
-getmac==0.8.2
+rsa==4.8
+stomp.py==8.0.1
+getmac==0.8.3
+cryptography==37.0.2

setup.py

@@ -8,17 +8,18 @@
 from setuptools import find_packages, setup
 from tigeropen import __VERSION__
 
-
 with open(path.join(path.abspath(path.dirname(__file__)), 'requirements.txt')) as f:
     install_requires = f.read()
+with open(path.join(path.abspath(path.dirname(__file__)), 'README.md')) as f:
+    long_description = f.read()
 
 setup(
     name='tigeropen',
     version=__VERSION__,
     description='TigerBrokers Open API',
-    long_description = file: README.md
-    long_description_content_type = text/markdown
-    packages=find_packages(exclude=[]),
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    packages=find_packages(exclude=["tests"]),
     author='TigerBrokers',
     author_email='[email protected]',
     license='Apache License v2',
@@ -36,5 +37,6 @@
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
     ],
 )

tests/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/6/24
+# @Author  : sukai

tests/test_client_config.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/10/8
+# @Author  : sukai
+import unittest
+from unittest.mock import MagicMock
+
+from tigeropen.common.consts import License
+from tigeropen.tiger_open_config import TigerOpenClientConfig, GATEWAY_SUFFIX
+
+
+class TestClientConfig(unittest.TestCase):
+
+    def test_refresh_server_info(self):
+        domain_map = {
+            'socket_port': 9883,
+            'port': 9887,
+            'TBSG-QUOTE': 'https://openapi.tigerfintech.com/sgp-quote',
+            'TBNZ-QUOTE': 'https://openapi.tigerfintech.com/hkg-quote',
+            'TBSG-PAPER': 'https://openapi-sandbox.tigerfintech.com/sgp',
+            'TBNZ-PAPER': 'https://openapi-sandbox.tigerfintech.com/hkg',
+            'TBSG': 'https://openapi.tigerfintech.com/sgp',
+            'TBNZ': 'https://openapi.tigerfintech.com/hkg',
+            'COMMON': 'https://openapi.tigerfintech.com',
+        }
+        config = TigerOpenClientConfig()
+        config.query_domains = MagicMock(name='query_domains', return_value=domain_map)
+        config.domain_conf = config.query_domains()
+
+        self.assertEqual('https://openapi.tigerfintech.com' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual(('ssl', 'openapi.tigerfintech.com', 9883), config.socket_host_port)
+
+        config.license = License.TBNZ
+        config.refresh_server_info()
+        self.assertEqual('https://openapi.tigerfintech.com/hkg' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual('https://openapi.tigerfintech.com/hkg-quote' + GATEWAY_SUFFIX, config.quote_server_url)
+
+        config.license = 'TBSG'
+        config.refresh_server_info()
+        self.assertEqual('https://openapi.tigerfintech.com/sgp' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual('https://openapi.tigerfintech.com/sgp-quote' + GATEWAY_SUFFIX, config.quote_server_url)
+
+        config.is_paper = True
+        config.license = 'TBNZ'
+        config.refresh_server_info()
+        self.assertEqual('https://openapi-sandbox.tigerfintech.com/hkg' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual('https://openapi.tigerfintech.com/hkg-quote' + GATEWAY_SUFFIX, config.quote_server_url)
+
+        config = TigerOpenClientConfig(enable_dynamic_domain=False)
+        config.query_domains = MagicMock(name='query_domains', return_value=domain_map)
+        config.domain_conf = config.query_domains()
+        config.license = 'TBNZ'
+        config.refresh_server_info()
+        self.assertEqual('https://openapi.tigerfintech.com' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual(('ssl', 'openapi.tigerfintech.com', 9883), config.socket_host_port)

tests/test_push_client.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/6/24
+# @Author  : sukai
+import unittest
+
+from tigeropen.push.push_client import PushClient
+
+
+class TestPushClient(unittest.TestCase):
+
+    def test_tick_convert(self):
+        body = '{"symbol":"QQQ","tickType":"*****","serverTimestamp":1656062042242,"priceOffset":2,' \
+               '"volumes":[99,10,10,10,800],"partCode":["t","p","p","p","t"],"cond":"IIIIT","type":"TradeTick",' \
+               '"times":[1656062084833,11,0,0,31],"quoteLevel":"usStockQuote","priceBase":28770,"sn":878,' \
+               '"prices":[6,3,2,2,0],"timestamp":1656062085570}'
+
+        expected = 'QQQ', [{'tick_type': '*', 'price': 287.76, 'volume': 99, 'part_code': 'NSDQ',
+                     'part_code_name': 'NASDAQ Stock Market, LLC (NASDAQ)', 'cond': 'US_ODD_LOT_TRADE',
+                     'time': 1656062084833, 'server_timestamp': 1656062042242, 'type': 'TradeTick',
+                     'quote_level': 'usStockQuote', 'sn': 878, 'timestamp': 1656062085570},
+                    {'tick_type': '*', 'price': 287.73, 'volume': 10, 'part_code': 'ARCA',
+                     'part_code_name': 'NYSE Arca, Inc. (NYSE Arca)', 'cond': 'US_ODD_LOT_TRADE',
+                     'time': 1656062084844, 'server_timestamp': 1656062042242, 'type': 'TradeTick',
+                     'quote_level': 'usStockQuote', 'sn': 878, 'timestamp': 1656062085570},
+                    {'tick_type': '*', 'price': 287.72, 'volume': 10, 'part_code': 'ARCA',
+                     'part_code_name': 'NYSE Arca, Inc. (NYSE Arca)', 'cond': 'US_ODD_LOT_TRADE',
+                     'time': 1656062084844, 'server_timestamp': 1656062042242, 'type': 'TradeTick',
+                     'quote_level': 'usStockQuote', 'sn': 878, 'timestamp': 1656062085570},
+                    {'tick_type': '*', 'price': 287.72, 'volume': 10, 'part_code': 'ARCA',
+                     'part_code_name': 'NYSE Arca, Inc. (NYSE Arca)', 'cond': 'US_ODD_LOT_TRADE',
+                     'time': 1656062084844, 'server_timestamp': 1656062042242, 'type': 'TradeTick',
+                     'quote_level': 'usStockQuote', 'sn': 878, 'timestamp': 1656062085570},
+                    {'tick_type': '*', 'price': 287.7, 'volume': 800, 'part_code': 'NSDQ',
+                     'part_code_name': 'NASDAQ Stock Market, LLC (NASDAQ)', 'cond': 'US_FORM_T',
+                     'time': 1656062084875, 'server_timestamp': 1656062042242, 'type': 'TradeTick',
+                     'quote_level': 'usStockQuote', 'sn': 878, 'timestamp': 1656062085570}]
+        self.assertEqual(expected, PushClient._convert_tick(body))

tests/test_utils.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/7/14
+# @Author  : sukai
+import unittest
+
+from tigeropen.common.util.price_util import PriceUtil
+
+
+class TestUtils(unittest.TestCase):
+    def test_price_util(self):
+        delta = 1e-6
+        tick_sizes = [{'begin': '0', 'end': '1', 'type': 'CLOSED', 'tick_size': 0.0001},
+                      {'begin': '1', 'end': 'Infinity', 'type': 'OPEN', 'tick_size': 0.01}]
+        self.assertFalse(PriceUtil.match_tick_size(None, None))
+        self.assertTrue(PriceUtil.match_tick_size(2.33, tick_sizes))
+        self.assertTrue(PriceUtil.match_tick_size(2.3, tick_sizes))
+        self.assertFalse(PriceUtil.match_tick_size(1.334, tick_sizes))
+        self.assertTrue(PriceUtil.match_tick_size(0.5, tick_sizes))
+        self.assertFalse(PriceUtil.match_tick_size(0.22223, tick_sizes))
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(2.334, tick_sizes, True), 2.34, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(2.334, tick_sizes, False), 2.33, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(2.3345, None), 2.3345, delta=delta)
+
+        tick_sizes = [{'begin': '0', 'end': '1', 'type': 'CLOSED', 'tick_size': 0.0005},
+                      {'begin': '1', 'end': '100', 'type': 'OPEN_CLOSED', 'tick_size': 0.05},
+                      {'begin': '100', 'end': '1000', 'type': 'OPEN_CLOSED', 'tick_size': 1.0},
+                      {'begin': '1000', 'end': '10000', 'type': 'OPEN_CLOSED', 'tick_size': 2.0},
+                      {'begin': '10000', 'end': 'Infinity', 'type': 'OPEN', 'tick_size': 5.0}]
+        self.assertTrue(PriceUtil.match_tick_size(0.0005, tick_sizes))
+        self.assertTrue(PriceUtil.match_tick_size(1.15, tick_sizes))
+        self.assertFalse(PriceUtil.match_tick_size(0.0008, tick_sizes))
+        self.assertFalse(PriceUtil.match_tick_size(1.11, tick_sizes))
+        self.assertTrue(PriceUtil.match_tick_size(300, tick_sizes))
+        self.assertFalse(PriceUtil.match_tick_size(300.5, tick_sizes))
+        self.assertFalse(PriceUtil.match_tick_size(5001, tick_sizes))
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(0.0021, tick_sizes), 0.002, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(0.0021, tick_sizes, True), 0.0025, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(3.027, tick_sizes), 3.0, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(3.027, tick_sizes, True), 3.05, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(200.5, tick_sizes), 200, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(2001, tick_sizes, True), 2002, delta=delta)
+        self.assertAlmostEqual(PriceUtil.fix_price_by_tick_size(20001, tick_sizes, True), 20005, delta=delta)

tigeropen/__init__.py

@@ -4,4 +4,4 @@
 
 @author: gaoan
 """
-__VERSION__ = '2.0.4'
+__VERSION__ = '2.2.2'