草稿√正式发布正在修改CTPIIMiniAPI应用开发参考手册

◎上期技术版本□草稿

W］正式发布

口正在修改

CTPIIMiniAPI应用开发参考手册

(Ver1.5)

上海期货信息技术有限公司

2023年3月

修订历史记录

日期版本修订说明修改者

2021-1-180.1在《CTPIImini_api说明一vl.3》基础上创建夏乾坤

2021-2-190.2去掉不支持的接口调用函数及其他修改合并徐文华

邵悦

夏乾坤

2021-2-250.31）增加接口流程章节,一方面简要勾画API生命周期流夏乾坤

程，一方面增加常见的报、撤单流程；

2）补充交易接口、行情接口中部分交易所特殊业务规则、

字段处理规则、返回常见错误说明等；

2021-3-50.4增加V1.5.6版本变更说明夏乾坤

2021-3-100.5根据项目组审核修改部分内容，主要包括《扳单》章节、徐文华

VI.5.6版本变更、其他修正夏乾坤

2021-3-260.6根据应用运维、测试意见修改：温振辉

1）SubscribeMarketData中示例,采用静态二维数组，廖莹寒

避免初学者误解；夏乾坤

2）勘误:TraderAPI章节中OnRtnlnstrumentStatus是

通过公有流推送；

3）版本变更增加终端连接Session级别流控说明。

更正各个

2021-5-240.7ReqOrderlnsertsReqExecOrderlnserts夏乾坤

ReqQuotelnsert、ReqOptionSelfCloselnsert函数中终

端输入项目中OrderRef字段为必填项目；mini不象CTP

主席对OrderRef为空做了加号处理，需要终端自行维护

必填；

2021-6-90.8V1.5.7版本：配合中金所行情API升级到MdUserAPI夏乾坤

V2.0版本，添加BandingUpperPrice、

BandingLowerPrice字段；对应修改：

1)3.2.24OnRspQryDepthMarketData

2)4.2.8OnRtnDepthMarketData

2021-9-100.9本版本不兼容之前版本变更，API接入认证时加入版本控夏乾坤

制，请各开发商务必更新API,具体变化参见以下各章节：

1）版本变更：增加V1.5.8变更说明

2）更新252.1TraderAPI说明

3）交易接口增加章节3.1.47~3.1.50

4）回应函数增加章节3.2.49~3.2.53

5）ReqQrylnvestorPositionCombineDetail接口及回

调RspQsylnvestorPositionCombineDetail不再支持。

代替以ReqQ「yInvesto「PositionForComb及其回调

RspQrylnvestorPositionForComb实现类似功能。

6）ReqQrylnvestorPositionDetail接口及回调

OnRspQrylnvestocPocitionDetail根据交易后台设置有

条件支持。如查询结果无效，请联系期货公司。

2021-12-71.01）明确字段信息：3.1.47ReqCombActioninsert夏乾坤

2）增加版本变更说明章节2.3.3V1.5.9,主要包括：

ThostFtdcUserApiDataType.h头文件增加郑商所组

合类型定义、ThostFtdcUserApiStruct.h头文件中组

合单腿汇总结构变化，增加三个字段；

2022-1-71.01）4.2.80nRtnDepthMarketData章节增加了参数说夏乾坤

明：从VI.5.8版本开始增加了大商所组合合约行情；

从VI.5.9版本开始增加了郑商所组合合约行情；

2022-2-211.11）新增加章节：2.3.4V1.6.0介绍本版本升级信息夏乾坤

2）新增加章节:3.1.51ReqQryForQuoteParam查询价

差请求；

3）新增加章节：3.2.54OnRspQryForQuoteParam查

询价差请求响应；

2022-5-181.21）增加章节2.3.5VI.6.1夏乾坤

2）增加章节3.1.52ReqMKBatchOrderAction

3）增加章节3.2.55OnRspMKBatchOrderAction

4）增加章节3.1.53SubscribeFlowCtrlWarning

5）增加章节3.1.54UnSubscribeFlowCtrlWarning

6）增加章节3.2.56OnRspSubscribeFlowCtrlWarning

7）增加章节3257OnRspUnSubscribeFlowCtrlWarning

8）增加章节3.2.58OnRtnFlowCtrlWarning

2022-8-111.31）增加章节2.3.6V1.6.2夏乾坤

2）增加章节3.1.55ReqQryTraderOffer

3）增加章节3.2.59OnRspQryTraderOffer

2022-11-1.41）增加章节2.3.7V1.6.3夏乾坤

162）增加查询郑商所SPBM组合产品保证金明细请求及查

询回应章节

3.1.56ReqQryInvestorProdSPBMDetail_______、

3.2.60OnRspQ「yInvestorP「odSPBMDetail

2023-2-201.51）更新1.2架构中架构图,增加广期所；夏乾坤

2）增加章节2.3.8V1.6.4

3）更新323OnRspUserLogin章节,变更结构增加广

期所时间字段CThostFtdcRspUserLoginField

目录

修订历史记录

目录

1系统介绍

1.1概述

1.2架构

1.3特点

2API介绍

2.1基本文件

2.2开发平台

2.3版本变更

2.3.1之前版本.

2.3.2VI.5.8

2.3.3VI.5.9

2.3.4VI.6.0

2.3.5VI.6.1

2.3.6VI.6.2

2.3.7VI.6.3

2.3.8VI.6.4

2.4网络通信

2.4.1通讯模式.

2.4.2通讯实现.

2.5接口分类

2.5.1管理接口

2.5.2业务接口

2.6接口流程

2.6.1交易

2.6.2行情

3交易接口.............................................................

3.1CTHOSTFTDCTRADERAPI.......................................

3.1.1CreateFtdcTraderApi..................................................................

3.1.2GetApiVersion..............................................................................

3.1.3Release...........................................................................................

3.1.4Init...................................................................................................

3.1.5Join.................................................................................................

3.1.6GetTradingDay..............................................................................

3.1.7RegisterFront................................................................................

3.1.8RegisterSpi....................................................................................

3.1.9SubscribePrivateTopic...............................................................

3.1.10SubscribePubHcTopic.................................................................

3.1.11ReqAuthenticate.........................................................................

3.1.12ReqUserLogin..............................................................................

3.1.13ReqUserLoginEncrypt................................................................

3.1.14ReqUserLogout...........................................................................

3.1.15ReqOrderlnsert............................................................................

3.1.16ReqOrderAction..........................................................................

3.1.17ReqExecOrderlnsert...................................................................

3.1.18ReqExecOrderAction..................................................................

3.1.19ReqForQuotelnsert.....................................................................

3.1.20ReqQuotelnsert...........................................................................

3.1.21ReqQuoteAction..........................................................................

3.1.22ReqOptionSelfCloselnsert.......................................................

3.1.23ReqOptionSelfCloseAction......................................................

3.1.24ReqQryOrder...............................................................................

3.1.25ReqQryTrade................................................................................

3.1.26ReqQrylnvestorPosition............................................................

3.1.27ReqQryTradingAccount.............................................................

3.1.28ReqQrylnvestor...........................................................................

3.1.29ReqQryTradingCode..................................................................

3.1.30ReqQrylnstrumentMarginRate................................................

3.1.31ReqQrylnstrumentCommissionRate......................................

3.1.32ReqQryExchange.........................................................................

3.1.33ReqQrylnstrument......................................................................

3.1.34ReqQryDepthMarketData.........................................................

3.1.35ReqQryOptionSelfClose............................................................

3.1.36ReqQrylnstrumentStatus..........................................................

3.1.37ReqQrylnvestorPositionDetail.................................................

3.1.38ReqQrylnvestorPositionCombineDetail................................

3.1.39ReqQryExchangeMarginRate...................................................

3.1.40ReqQryExchangeMarginRateAdjust......................................

3.1.41ReqQryOptionlnstrTradeCost..................................................

3.1.42ReqQryOptionlnstrCommRate................................................

3.1.43ReqQryExecOrder........................................................................

3.1.44ReqQryForQuote.........................................................................

3.1.45ReqQryQuote...............................................................................

3.1.46ReqQrylnstrumentOrderCommRate......................................

3.1.47ReqCombActionlnsert...............................................................

3.1.48ReqQryCombAction....................................................................

3.1.49ReqQryComblnstrument...........................................................

3.1.50ReqQrylnvestorPositionForComb...........................................

3.1.51ReqQryForQuoteParam.............................................................

3.1.52ReqMKBatchOrderAction..........................................................

3.1.53SubscribeFlowCtrlWarning.......................................................

3.1.54UnSubscribeFlowCtr/Warning.................................................

3.1.55ReqQryTraderOffer.....................................................................

3.1.56ReqQrylnvestorProdSPBMDetaH.............................................

3.2CTHOSTFTDCTRADERSPI.......................................

3.2.1OnFrontConnected......................................................................

3.2.2OnFrontDisconnected.................................................................

3.2.3OnRspUserLogin..........................................................................

3.2.4OnRspAuthenticate......................................................................

3.2.5OnRspOrderlnsert........................................................................

3.2.6OnRspOrderAction.......................................................................

3.2.7OnRspExecOrderlnsert...............................................................

3.2.8OnRspExecOrderAction..............................................................

3.2.9OnRspForQuotelnserf................................................................

3.2.10OnRspQuotelnsert......................................................................

3.2.11OnRspQuoteAction.....................................................................

3.2.12OnRspOptionSelfCloseinsert...................................................

3.2.13OnRspOptionSelfCloseAction.................................................

3.2.14OnRspQryOrder..........................................................................

3.2.15OnRspQryTrade...........................................................................

3.2.16OnRspQrylnvestorPosition......................................................

3.2.17OnRspQryTradingAccount.......................................................

3.2.18OnRspQrylnvestor.....................................................................

3.2.19OnRspQryTradingCode.............................................................

3.2.20OnRspQrylnstrumentMarginRate..........................................

3.2.21OnRspQrylnstrumentCommissionRate................................

3.2.22OnRspQryExchange...................................................................

3.2.23OnRspQrylnstrument................................................................

3.2.24OnRspQryDepthMarketData...................................................

3.2.25OnRspQrylnstrumentStatus.....................................................

3.2,26OnRspQrylnvestorPositionDetail...........................................

3.2.27OnRspQrylnvestorPositionCombineDetail..........................

3.2.28OnRspQryExchangeMarginRate.............................................

3.2.29OnRspQryExchangeMarginRateAdjust.................................

3.2.30OnRspQryOptionlnstrTradeCost............................................

3.2.31OnRspQryOptionlnstrCommRate..........................................

3.2.32OnRspQryExecOrder..................................................................

3.2.33OnRspQryForQuote...................................................................

3.2.34OnRspQryQuote..........................................................................

3.2.35OnRspQryOptionSelfClose......................................................

3,2.36OnRtnOrder.................................................................................

3.2.37OnRtnTrade..................................................................................

3.2.38OnErrRtnOrderAction................................................................

3.2.39OnRtnlnstrumentStatus...........................................................

3.2.40OnRtnExecOrder.........................................................................

3.2.41OnErrRtnExecOrderAction.......................................................

3.2.42OnErrRtnForQuotelnsert..........................................................

3.2.43OnRtnQuote................................................................................

3.2.44OnErrRtnQuoteAction...............................................................

3.2.45OnRtnForQuoteRsp...................................................................

3.2.46OnRtnOptionSelfClose..............................................................

3.2.47OnErrRtnOptionSelfCloseAction............................................

3.2.48OnRspQrylnstrumentOrderCommRate................................

3.2.49OnRspCombActionlnsert.........................................................

3.2.50OnRtnCombAction.......................................................................

3.2.51OnRspQryCombAction................................................................

3.2.52OnRspQryComblnstrument.......................................................

3.2.53OnRspQrylnvestorPositionForComb......................................

3.2.54OnRspQryForQuoteParam.........................................................

3.2.55OnRspMKBatchOrderAction...........................................................

3.2.56OnRspSubscribeFlowCtr/Warning............................................

3.2.57OnRspUnSubscribeF/owCtr/Warning......................................

3.2.58OnRtnFlowCtrlWarning..............................................................

3.2.59OnRspQryTraderOffer.................................................................

3.2.60OnRspQrylnvestorProdSPBMDetail.........................................

4行情接口..............................................................

4.1CTHOSTFTDCMDAPI...........................................

4.1.1CreateFtdcMdApi..........................................................................

4.1.2GetApiVersion................................................................................

4.1.3Release.............................................................................................

4.1.4Init.....................................................................................................

4.1.5Join...................................................................................................

4.1.6GetTradingDay................................................................................

4.1.7RegisterFront..................................................................................

4.1.8RegisterSpi......................................................................................

4.1.9SubscribeMarketData..................................................................

4.1.10UnSubscribeMarketData............................................................

4.1.11SubscribeForQuoteRsp...............................................................

4.1.12UnSubscribeForQuoteRsp..........................................................

4.1.13ReqUserLogin................................................................................

4.2CTHOSTFTDCMDSPI...........................................

4.2.1OnFrontConnected.......................................................................

4??OnFrnnt-Di<;rnnnprtPcl.........................................

4.2.3OnRspUserLogin...........................................................................

4.2.4OnRspSubMarketData..................................................................

4.2.5OnRspUnSubMarketData............................................................

4.2.6OnRspSubForQuoteRsp...............................................................

4.2.7OnRspUnSubForQuoteRsp..........................................................

4.2.8OnRtnDepthMarketData.............................................................

4.2.9OnRtnForQuoteRsp......................................................................

1系统介绍

为了方便广大CTPIIMiniAPI开发者更好了解CTPIIMini产品，本章对产品做一个概括介

绍，希望从整体上帮助到每个开发者。

1.1概述

作为市场细分产品，CTPIIMini为极速客户提供一个专业、极速、轻量级、小投入的期货

及其衍生品交易通道，为程序化客户、算法交易者、高频投资者等提供高性价比服务平台，为

做市商打造一个独特、独享、开放式接入的完备做市平台。

一台机器、一套系统、多路接入、全部国内交易所业务支持，给您简而美的不二选择！

1.2架构

CTPIIMini整体系统架构示意如下图：

（_______________（pi|［盘中同步,

做市商\

交易报盘

—国奖

C石舱口独立报盘

高频交易者■T

P

=事前风控安全mi日志管理

M报

算法交易考■——5-查询核心।内存调度中心।盘

一I

A前

P

3t任务调度中心S

接n

程序化投资者:M调

入

,鹿口管理码।度

调

口

小二席投羯目—度

管事后风控盘中风控应急管理交易报盘

理

快速交易者;——集成报盘

盘中管理盘后管理।

oprdispatcher

UserAPl接口洞度段后回号

ThostUserRCWin结算柜台

Min峥员操作员

从以上架构可以看到，CTPHMiniAPI开发主要包括两块：

X投资者交易终端应用API开发：TraderAPI（交易）+MdAPI（行情）;

工期货公司内部应用API开发：UserAPI（交易）+MdAPI（行情）；

从开发的角度简化流程图如下示意：

投资者，A期货公司V

0

做市商•

T交易通道,

C

高频交易者T

P

=

M

_

算法交易者■n

一A

PCTPIIMini

3交易案经

5

程序化投资者-

箫

口

不席投资者

——IK

驷交易者-

1.3特点

•小快而灵-一满足极速投资者交易需要

-高速度、高吞吐量；

-五所业务支持，风控合宜；

-实时资金同步，快速资金到位；

-各种应急处理，紧急风控快速纠偏。

•持续创新--精益求精，守正出新

-分仓、分资金、分交易所交易；

-软硬件一体化结合全面提升性能；

-服务极速投资者，全面支持做市商；

-开放标准化API接口，支持CTP异构系统接入。

•未来已来--不辍耕耘，奋斗不息，服务客户

-精简架构，全面提升性能；

-高性能内存交易，实时快捷风控；

自适应均衡通讯，精确重演，完备稽核；

特色交易功能支持，想客户之所想，急客户之所需。

2API介绍

2.1基本文件

上海期货信息技术有限公司(简称“上期技术")于2018年12月成功上线了CTPIIMini

交易系统。系统使用了开放的主流平台，API可以运行在Linux和Windows操作系统上。

交易系统包括交易接口和行情接口(

CTPIIMiniAPIAPI(TraderAPI)APIMdAPI)o

终端程序调用TraderAPI即可完成与CTPIIMini交易模块的对接,接收到交易所的报单

和成交回报后TraderAPI将回调(Callback)相关接口；终端程序调用MdAPI即可完成与

CTPIIMini行情模块对接，接收到交易所行情后MdAPI将回调(Callback)相关接口。

TraderAPI把与CTPIIMini交易系统之间复杂的协议转换、数据同步和网络通信进行了封

装。TraderAPI通过与交易前置机之间的TCP连接进行通讯。通过TraderAPI建立的连接通

道支持断线自动重连。

MdAPI与TraderAPI类似，与行情前置机之间建立TCP连接，实现行情的订阅和接收。

CTPIIMiniAPI是一个基于C++的类库，通过使用或继承类库提供的接口来实现交易和

行情转发功能，包括报单录入、报单撤销、报单查询、成交单查询、投资者查询、持仓查询、

合约查询、合约交易状态查询、报价录入、询价请求等等。

该类库文件列表如下：

文件2版本文件描述

TraderAPI（交易API）

ThostFtdcTraderApi.hVl.5.6交易接口头文件

ThostFtdcUserApiStruct.hVl.5.6定义了一系列业务相关的数据结构的头文件

ThostFtdcUserApiDataType.hVl.5.6定义了一系列数据类型的头文件

Vl.5.6Windows动态链接库

Vl.5.6Windows导入库文件

Vl.5.6Linux动态库