# vnpy_xt

**Repository Path**: good-man-z/vnpy_xt

## Basic Information

- **Project Name**: vnpy_xt
- **Description**: vnpy官方的迅投研数据服务接口
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: custom-main-on-main-v1.4.6
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 8
- **Created**: 2025-05-13
- **Last Updated**: 2026-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VeighNa框架的迅投研数据服务接口

<p align="center">
  <img src ="https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy-logo.png"/>
</p>

<p align="center">
    <img src ="https://img.shields.io/badge/version-1.4.6-blueviolet.svg"/>
    <img src ="https://img.shields.io/badge/platform-windows-yellow.svg"/>
    <img src ="https://img.shields.io/badge/python-3.10|3.11|3.12|3.13-blue.svg" />
    <img src ="https://img.shields.io/github/license/vnpy/vnpy.svg?color=orange"/>
</p>

## 说明

基于迅投XtQuant封装开发的实时行情和数据服务接口，支持以下中国金融市场的K线和Tick数据：

* 股票、基金、债券、ETF期权：
  * SSE：上海证券交易所
  * SZSE：深圳证券交易所
* 期货、期货期权：
  * CFFEX：中国金融期货交易所
  * SHFE：上海期货交易所
  * DCE：大连商品交易所
  * CZCE：郑州商品交易所
  * INE：上海国际能源交易中心
  * GFEX：广州期货交易所


## 安装

安装环境推荐基于4.0.0版本以上的【[**VeighNa Studio**](https://www.vnpy.com/)】。

直接使用pip命令：

```
pip install vnpy_xt
```

完成基础安装后，需通过以下任一方法获取 `custom-main-on-main-v1.4.6` 分支代码并替换官方文件：
```bash
# 方法一：Git克隆替换法（推荐开发者使用）
# 分支名说明：custom-main-on-main-v1.4.6 代表「定制main基于官方main的v1.4.6版本」
1. 执行带分支参数的克隆命令（自动检出定制化的 custom-main-on-main-v1.4.6 分支）
   git clone -b custom-main-on-main-v1.4.6 https://gitee.com/good-man-z/vnpy_xt.git
 
2. 将克隆目录内全部文件覆盖至：
   - Linux/Mac: /usr/local/lib/python3.x/site-packages/vnpy_xt/
   - Windows: %PYTHON_HOME%\Lib\site-packages\vnpy_xt\
   └─ 提示：可通过 `pip show vnpy_xt` 查询确切安装路径


# 方法二：下载ZIP包替换法（适合无Git环境）
# 分支名说明：custom-main-on-main-v1.4.6 代表「定制main基于官方main的v1.4.6版本」
1. 访问 https://gitee.com/good-man-z/vnpy_xt
   → 点击左上角「custom-main-on-main-v1.4.6」分支按钮（定制main基于官方main的v1.4.6版本）
   → 点击右上角「克隆/下载」按钮
   → 选择「下载ZIP」获取最新压缩包
 
2. 解压后将解压目录内文件全量覆盖至：
   [同方法一的官方包安装路径]
```

## 使用

**Token连接**

- 请使用官方版本

**客户端连接**

- 请使用官方版本

**券商miniqmt连接**

1. 连接请先登录迅投极速交易终端，同时确保xtquant模块可以正常加载（点击【下载Python库】-【Python库下载】，下载完成后拷贝“Python库路径”下Lib\site-packages文件夹中的xtquant包到自己使用的Python环境的site_packages文件夹下）。
2. 在Veighna Trader的【全局配置】处进行数据服务配置：
    * datafeed.name：xt
    * datafeed.username：client
    * datafeed.password：留空
3. 连接XT中配置：
    * token：留空
    * QMT路径：C:\国金QMT交易端模拟
    * 资金账户：填写您在券商开户的资金账号
4. 请注意以客户端方式连接时，需要保持迅投客户端的运行。