<p align="center">
  <img src ="https://raw.githubusercontent.com/shinnytech/tqsdk-python/master/doc/images/tqsdk_new_logo.png"/>
</p>
<p align="center">
    <img src ="https://img.shields.io/pypi/v/tqsdk?color=blueviolet">
    <img src ="https://img.shields.io/badge/platform-windows|linux|macos-green.svg"/>
    <img src ="https://img.shields.io/badge/python-3.8+-blue.svg" />
    <img src ="https://img.shields.io/pypi/dm/tqsdk?color=yellowgreen">
    <img src ="https://img.shields.io/github/license/shinnytech/tqsdk-python.svg?color=orange"/>
</p>

# TqSdk 天勤量化交易策略程序开发包

TqSdk 是一个由[信易科技](https://www.shinnytech.com)发起并贡献主要代码的开源 Python 库。
TqSdk 支持用户使用极少的代码量构建各种类型的量化交易策略程序，
并提供包含期货、期权、股票的 历史数据-实时数据-开发调试-策略回测-模拟交易-实盘交易-运行监控-风险管理 全套解决方案。

## 快速开始

``` python
from tqsdk import TqApi, TqAuth, TqAccount, TargetPosTask

api = TqApi(TqAccount("H海通期货", "4003242", "123456"), auth=TqAuth("快期账户", "账户密码"))      # 创建 TqApi 实例, 指定交易账户
q_2309 = api.get_quote("SHFE.rb2309")                         # 订阅近月合约行情
t_2309 = TargetPosTask(api, "SHFE.rb2309")                    # 创建近月合约调仓工具
q_2401 = api.get_quote("SHFE.rb2401")                         # 订阅远月合约行情
t_2401 = TargetPosTask(api, "SHFE.rb2401")                    # 创建远月合约调仓工具

while True:
  api.wait_update()                                           # 等待数据更新
  spread = q_2309["last_price"] - q_2401["last_price"]        # 计算近月合约-远月合约价差
  print("当前价差:", spread)
  if spread > 250:
    print("价差过高: 空近月，多远月")                            
    t_2309.set_target_volume(-1)                              # 要求把2309合约调整为空头1手
    t_2401.set_target_volume(1)                               # 要求把2401合约调整为多头1手
  elif spread < 200:
    print("价差回复: 清空持仓")                               # 要求把 2309 和 2401合约都调整为不持仓
    t_2309.set_target_volume(0)
    t_2401.set_target_volume(0)
```

要快速了解如何使用TqSdk，请访问我们的 [十分钟快速入门指南](https://doc.shinnytech.com/tqsdk/latest/quickstart.html)。

## 系统架构

<img alt="系统架构图" src="https://raw.githubusercontent.com/shinnytech/tqsdk-python/master/doc/arch.svg?sanitize=true">

* 行情网关负责提供实时行情和历史数据
* 交易中继网关负责连接到期货公司交易系统
* 这两个网关统一以Diff协议对下方提供服务
* TqSdk按照Diff协议连接到行情网关和交易中继网关，实现行情和交易功能

## 主要功能特点

TqSdk提供的功能可以支持从简单到复杂的各类策略程序：

* **公司级数据运维**，提供当前所有可交易合约从上市开始的**全部Tick数据和K线数据**
* **多账户支持**，支持使用多个实盘账户、模拟账户同时交易
* **支持市场上90%的期货公司实盘交易**
* **支持股票、期权、期货交易** 
* **支持CTP直连交易**，以及众期、融航、杰宜斯等资管柜台，易达、ctpmini 等高速柜台
* **支持模拟交易**
* **支持Tick级和K线级回测**，支持复杂策略回测
* **提供近百个技术指标函数及源码**
* **用户无须建立和维护数据库**，行情和交易数据全在内存数据库，无访问延迟
* **优化支持pandas和numpy库**，方便数据分析
* **灵活的策略编写方式**，无强制框架结构，支持任意复杂度的策略，在一个交易策略程序中使用多个品种的K线/实时行情并交易多个品种

* **配合天勤AI助手**，提供函数解释、策略编写指导、错误分析等支持

## 配合 AI / Agent 使用 TqSdk

如果你想让自己的 AI、Agent 或 OpenClaw 更好地理解和使用 TqSdk，可以把下面这段内容直接复制给它：

> 请先下载并解压 TqSdk 技能包：https://doc.shinnytech.com/tqsdk/latest/ai_editor/skills/tqsdk-trading-and-data.zip，然后先阅读其中的 SKILL.md，并按里面的说明再回答任何 TqSdk 问题或编写任何 TqSdk 代码。

相关文档与资源：

* [通过 AI 工具使用 TqSdk](https://doc.shinnytech.com/tqsdk/latest/ai_editor/index.html)
* [在 Trae 中高效学习和使用 TqSdk](https://doc.shinnytech.com/tqsdk/latest/ai_editor/tqsdk_trae.html)
* [在 CodeBuddy 中高效学习和使用 TqSdk](https://doc.shinnytech.com/tqsdk/latest/ai_editor/tqsdk_codebuddy.html)
* [使用 Codex 协作开发 TqSdk 项目](https://doc.shinnytech.com/tqsdk/latest/ai_editor/tqsdk_codex.html)
* [TqSdk Skills 压缩包与使用说明](https://doc.shinnytech.com/tqsdk/latest/ai_editor/tqsdk_skills.html)
* [下载 TqSdk 技能包 `tqsdk-trading-and-data.zip`](https://doc.shinnytech.com/tqsdk/latest/ai_editor/skills/tqsdk-trading-and-data.zip)

## 安装方法

TqSdk 仅支持 Python 3.8 及更高版本。要安装 TqSdk，可使用 pip：

```bash
pip install tqsdk
```

## 文档与社区支持

在线阅读HTML版本文档: https://doc.shinnytech.com/tqsdk/latest

知乎账户【天勤量化】：https://www.zhihu.com/org/tian-qin-liang-hua/activities

天勤AI助手：https://www.shinnytech.com/products/tqsdk - 解释函数，编写demo策略，分析报错原因，它都可以做到！

用户交流QQ群: **611806823** (目前只允许给我们点过STAR的同学加入, 加群时请提供github用户名)

## 关于我们

[信易科技](https://www.shinnytech.com) 是专业的期货软件供应商和交易所授权行情服务商。旗下的快期系列产品已为市场服务超过10年。TqSdk 是公司开源计划的一部分。

