1 CATS API 简介
1.1 CATS API简介
CATS API是中信证券CATS自动化交易平台提供给客户定制程序化交易客户端的API接口工具包。CATS API经过精心的设计及优化,采用全双工异步通信模式,对底层的复杂通信及压缩加密等技术进行封装,并对所提供的业务功能接口进行复合精简设计,最大限度的提升业务接口的易用性及灵活性。
CATS API的优势在于对底层的通信及协议进行了有效封装,采用应用级的函数设计思想,避免让用户需要花时间去了解底层的技术细节,使得用户可以专注于客户端或接入模块的业务功能的实现,大大简化用户开发客户端程序的难度;各个业务功能接口均采用回调的方式,兼顾了接口的灵活性。
1.2 CATS API 与 CATS中间件之间的交互
2 CATS API 函数
2.1 CATS API 调用流程
1. CATS API初始化及结束清理相关调用流程
2. CATS API业务请求调用流程
3. CATS API订阅推送业务调用流程
2.2 CATS API函数分类
【表一:函数分类表】
初始化及退出清理 |
初始化CATSAPI |
CATSAPI_Init |
---|---|---|
退出清理CATS API |
CATSAPI_Fini |
|
初始化通信会话 |
CATSAPI_InitSession |
|
退出清理通信会话 |
CATSAPI_ExitSession |
|
获取CATSAPI版本信息 |
CATSAPI_GetVersion |
|
连接CATS服务器 (交易、行情服务器) |
CATSAPI_Prepare_CatsConnect CATSAPI_Execute_CatsConnect |
|
工具 函数 |
获取默认配置文件(catsapi.ini)的配置信息(配置信息由用户指定) |
get_*_def |
打印或输出DEBUG信息到调试窗口及本地日志文件 |
logdebug |
|
打印或输出WARN信息到调试窗口及本地日志文件 |
logwarn |
|
打印或输出ERROR信息到调试窗口及本地日志文件 |
logerror |
|
打印或输出INFO信息到调试窗口及本地日志文件 |
loginfo |
|
接口入出参函数 |
按名设置业务接口的输入参数 |
CATSAPI_SetParam |
按名设置业务接口的输入参数组 |
CATSAPI_SetGroupParam |
|
按名获取业务接口的输出参数 |
CATSAPI_GetIntField CATSAPI_GetLongField CATSAPI_GetCStrField CATSAPI_GetFloatField |
|
本地内存数据库操作 |
执行批量的SQL |
CATSAPI_MDB_ExecBatchSQL |
执行统计计算SQL并返回第一列整数值 |
CATSAPI_MDB_ExecScalar |
|
执行一条INSERT语句,返回受影响行数 |
CATSAPI_MDB_Insert |
|
执行一条UPDATE语句,返回受影响行数 |
CATSAPI_MDB_Update |
|
执行一条DELETE语句,返回受影响行数 |
CATSAPI_MDB_Delete |
|
执行一条Select语句 |
CATSAPI_MDB_Select |
|
移动光标取下一条,执行完查询需移动光标到第一条记录 |
CATSAPI_MDB_MoveNext |
|
获取列数 |
CATSAPI_MDB_GetColCount |
|
获取列名 |
CATSAPI_MDB_GetColName |
|
获取列类型 |
CATSAPI_MDB_GetColType |
|
获取列类型名 |
CATSAPI_MDB_GetColTypeName |
|
获取列大小 |
CATSAPI_MDB_GetColSize |
|
根据列名,获取列数据 |
CATSAPI_MDB_GetColInt |
|
根据列名,获取列数据 |
CATSAPI_MDB_GetColDbl |
|
根据列名,获取列数据 |
CATSAPI_MDB_GetColCStr |
|
根据列名,获取列数据 |
CATSAPI_MDB_GetColData |
|
错误 处理 |
获取上次调用的错误信息 |
CATSAPI_GetLastError |
1)账户类 |
||
CATS账户管理 |
准备CATS账户登录 |
CATSAPI_Prepare_CatsLogin |
CATS账户登录 |
CATSAPI_Execute_CatsLogin |
|
准备添加子账户 |
CATSAPI_Prepare_AddSubAcc |
|
添加子账户 |
CATSAPI_Execute_AddSubAcc |
|
准备删除子账户 |
CATSAPI_Prepare_DelSubAcc |
|
删除子账户 |
CATSAPI_Execute_DelSubAcc |
|
准备查询子账户 |
CATSAPI_Prepare_QuerySubAcc |
|
查询子账户 |
CATSAPI_Execute_QuerySubAcc |
|
交易账户 |
准备用户登录请求 |
CATSAPI_Prepare_TradeAccLogin |
用户登录 |
CATSAPI_Execute_TradeAccLogin |
|
2)交易订阅类 |
||
|
准备资金及持仓变动订阅请求 |
CATSAPI_PrepSub_AssetUpdate |
订阅资金及持仓变动 |
CATSAPI_Subscribe_AssetUpdate |
|
准备委托成交订阅请求 |
CATSAPI_PreSub_OrderUpdate |
|
订阅委托成交 |
CATSAPI_Subscribe_OrderUpdate |
|
3)行情订阅类 |
||
|
准备行情订阅请求 |
CATSAPI_PreSub_MarketData |
订阅行情 |
CATSAPI_Subscribe_MarketData |
|
准备批量行情订阅请求 |
CATSAPI_PreSub_BatchMarketData |
|
批量订阅行情 |
CATSAPI_Subscribe_BatchMarketData |
|
准备当日分钟线订阅请求 |
CATSAPI_PreSub_MinuteBar |
|
订阅当日分钟线 |
CATSAPI_Subscribe_MinuteBar |
|
准备当日分钟线退订请求 |
CATSAPI_PreUnSub_MinuteBar |
|
退订当日分钟线 |
CATSAPI_UnSubscribe_MinuteBar |
|
准备订阅日线数据 |
CATSAPI_PreSub_DayBar |
|
订阅日线数据 |
CATSAPI_Subscribe_DayBar |
|
准备退订日线数据 |
CATSAPI_PreUnSub_DayBar |
|
退订日线数据 |
CATSAPI_UnSubscribe_DayBar |
|
|
准备分价数据订阅请求 |
CATSAPI_PreSub_PriceList |
|
订阅分价数据 |
CATSAPI_Subscribe_PriceList |
|
准备取消分价数据订阅请求 |
CATSAPI_PreUnSub_PriceList |
|
取消订阅分价数据 |
CATSAPI_UnSubscribe_PriceList |
|
准备逐笔成交订阅请求 |
CATSAPI_PreSub_StockMatchDetail |
|
订阅逐笔成交数据 |
CATSAPI_Subscribe_StockMatchDetail |
|
准备取消逐笔成交数据订阅 |
CATSAPI_PreUnSub_StockMatchDetail |
|
取消订阅逐笔成交数据 |
CATSAPI_UnSubscribe_StockMatchDetail |
|
准备Level2逐笔成交订阅请求 |
CATSAPI_PreSub_StockMatchDetailL2 |
|
订阅L2逐笔成交数据 |
CATSAPI_Subscribe_StockMatchDetailL2 |
|
准备取消L2逐笔成交数据订阅 |
CATSAPI_PreUnSub_StockMatchDetailL2 |
|
取消订阅L2逐笔成交数据 |
CATSAPI_UnSubscribe_StockMatchDetailL2 |
|
准备委托队列数据订阅请求 |
CATSAPI_PreSub_OrderQueue |
|
订阅委托队列数据 |
CATSAPI_Subscribe_OrderQueue |
|
准备取消委托队列数据订阅 |
CATSAPI_PreUnSub_OrderQueue |
|
取消订阅委托队列数据 |
CATSAPI_UnSubscribe_OrderQueue |
4)算法管理类 |
||
|
准备算法实例状态订阅请求 |
CATSAPI_PreSub_AlgoStatus |
订阅算法实例状态 |
CATSAPI_Subscribe_AlgoStatus |
|
准备算法实例状态退订请求 |
CATSAPI_PreUnSub_AlgoStatus |
|
退订算法实例状态 |
CATSAPI_UnSubscribe_AlgoStatus |
|
准备更新算法实例委托状态请求 |
CATSAPI_Prepare_UpdateAlgoOrderStatus |
|
更新算法实例委托状态 |
CATSAPI_Execute_UpdateAlgoOrderStatus |
|
准备算法实例委托指令订阅请求 |
CATSAPI_PreSub_AlgoInstOrders |
|
订阅算法实例委托指令 |
CATSAPI_Subscribe_AlgoInstOrders |
|
准备算法实例撤单指令订阅请求 |
CATSAPI_PreSub_AlgoInstCancelOrders |
|
订阅算法实例撤单指令 |
CATSAPI_Subscribe_AlgoInstCancelOrders |
|
分级基金套利 |
||
|
准备分级基金监控数据订阅请求 |
CATSAPI_PreSub_ICFStatisData |
订阅分级基金监控数据 |
CATSAPI_Subscribe_ICFStatisData |
|
准备分级基金监控数据退订请求 |
CATSAPI_PreUnSub_ICFStatisData |
|
退订分级基金监控数据 |
CATSAPI_UnSubscribe_ICFStatisData |
|
准备添加算法模版 |
CATSAPI_Prepare_AddAlgoTemplates |
|
添加算法模版 |
CATSAPI_Execute_AddAlgoTemplates |
|
5)查询类 |
||
|
准备查询当日分钟线请求 |
CATSAPI_Prepare_QueryMinBar |
查询当日分钟线 |
CATSAPI_Execute_QueryMinBar |
|
准备查询日线数据 |
CATSAPI_Prepare_QueryDayBar |
|
查询日线数据 |
CATSAPI_Execute_QueryDayBar |
|
准备查询历史分钟线数据文件信息 |
CATSAPI_Prepare_QueryHisMinFilePath |
|
查询历史分钟线数据文件信息 |
CATSAPI_Execute_QueryHisMinFilePath |
|
准备FTP下载历史分钟线文件 |
CATSAPI_Prepare_DownloadFile |
|
FTP下载历史分钟线文件 |
CATSAPI_Execute_DownloadFile |
|
准备查询交易时间请求 |
CATSAPI_Prepare_QueryTradeTime |
|
查询交易时间 |
CATSAPI_Execute_QueryTradeTime |
|
准备查询商品信息请求 |
CATSAPI_Prepare_QueryCommodityInfo |
|
查询商品信息 |
CATSAPI_Execute_QueryCommodityInfo |
|
准备查询客户授权算法 |
CATSAPI_Prepare_QryCatsAlgo |
|
执行查询客户授权算法 |
CATSAPI_Execute_QryCatsAlgo |
|
准备查询算法参数 |
CATSAPI_Prepare_QryAlgoParams |
|
执行查询算法参数 |
CATSAPI_Execute_QryAlgoParams |
|
准备查询算法实例 |
CATSAPI_Prepare_QryAlgoInstance |
|
查询算法实例 |
CATSAPI_Execute_QryAlgoInstance |
|
准备查询算法实例参数 |
CATSAPI_Prepare_QryAlgoInstanceParams |
|
查询算法实例参数 |
CATSAPI_Execute_QryAlgoInstanceParams |
|
6)交易类 |
||
|
准备单笔委托请求 |
CATSAPI_Prepare_OrderSingle |
单笔委托 |
CATSAPI_Execute_OrderSingle |
|
准备单笔委托撤单请求 |
CATSAPI_Prepare_WithDrawSingle |
|
单笔委托撤单 |
CATSAPI_Execute_WithDrawSingle |
|
准备组合委托请求 |
CATSAPI_Prepare_OrderBatch |
|
组合委托 |
CATSAPI_Execute_OrderBatch |
|
准备组合委托撤单请求 |
CATSAPI_Prepare_WithDrawBatch |
|
组合委托撤单 |
CATSAPI_Execute_WithDrawBatch |
2.3 数据字典定义
2.3.1 账户类别(AcctType)
代码 |
货币 |
0 |
股票 |
A |
期货 |
C |
信用账户 |
F0 |
快速交易普通账户 |
FC |
快速交易信用账户 |
2.3.2 交易所
代码 |
交易市场 |
SZ |
深圳证券交易所 |
SH |
上海证券交易所 |
CFFEX |
中国金融期货交易所 |
DCE |
大连商品期货交易所 |
SHFE |
上海期货交易所 |
CZCE |
郑州商品期货交易所 |
2.3.3 买卖方向
种类 |
代码 |
货币 |
证券 |
1 |
买入 或 担保品买入 |
2 |
卖出 或 担保品卖出 |
|
F |
ETF申购 |
|
G |
ETF赎回 |
|
信用 |
A |
融资买入 |
B |
融券卖出 |
|
C |
买券还券 |
|
D |
卖券还款 |
|
E |
买入(如果有负债则先买券还券) |
|
期货 |
FA |
开多仓(开仓买入) |
FB |
开空仓(开仓卖出) |
|
FC |
平空仓(平仓买入) |
|
FD |
平多仓(平仓卖出) |
|
FE |
强平空(强平买入) |
|
FF |
强平多(强平卖出) |
|
FG |
平今空(平今买入) |
|
FH |
平今多(平今卖出) |
|
FI |
平昨空(平昨买入) |
|
FJ |
平昨多(平今卖出) |
|
FK |
强减空(强减买入) |
|
FI |
强减多(平今卖出) |
|
FM |
本地强平空(本地强平买入) |
|
FN |
本地强平多(本地强平卖出) |
|
FO |
买入 :先平仓买入、再开仓买入 |
|
FP |
卖出 :先平仓卖出、再开仓卖出 |
2.3.4 订单类别
种类 |
代码 |
类别 |
证券、信用 |
0 |
限价单 |
Q |
市价单(对手方最优价格) |
|
R |
市价单(最优五档即时成交剩余转限价) |
|
S |
市价单(本方最优价格) |
|
T |
市价单(即时成交剩余撤销) |
|
U |
市价单(最优五档即时成交剩余撤销) |
|
V |
市价单(全额成交或撤单) |
|
期货 |
0 |
限价单 |
1 |
市价 |
|
3 |
最优价 |
|
4 |
最新价 |
|
5 |
最新价浮动上浮1个ticks |
|
6 |
最新价浮动上浮2个ticks |
|
7 |
最新价浮动上浮3个ticks |
|
8 |
卖一价 |
|
9 |
卖一价浮动上浮1个ticks |
|
A |
卖一价浮动上浮2个ticks |
|
B |
卖一价浮动上浮3个ticks |
|
C |
买一价 |
|
D |
买一价浮动上浮1个ticks |
|
E |
买一价浮动上浮2个ticks |
|
F |
买一价浮动上浮3个ticks |
2.3.5 订单状态
代码 |
状态 |
0 |
新建 |
1 |
部分成交 |
2 |
完全成交 |
3 |
部分撤单 |
4 |
全部撤单 |
5 |
订单拒绝 |
2.3.6 关联类型
代码 |
状态 |
“”(空) |
普通订单 |
“ALGO” |
算法订单 |
“UNKNOWN” |
未知来源 |
2.3.7 聚集行情订阅查询类型
类型 |
代码 |
状态 |
分钟线聚集 |
1 |
一分钟线 |
5 |
五分钟线 |
|
10 |
十分钟线 |
|
30 |
三十分钟线 |
|
60 |
六十分钟线 |
|
日线聚集 |
61 |
日线 |
62 |
周线 |
|
63 |
月线 |
|
64 |
季线 |
|
65 |
年线 |
|
|
|
|
2.3.8 商品种类
代码 |
品种 |
01 |
股票 |
01 |
基金 |
03 |
债券 |
04 |
指数 |
05 |
股指期货 |
06 |
商品期货 |
99 |
其他 |
2.3.9 证件类型
代码 |
品种 |
0 |
身份证 |
1 |
外国护照 |
2 |
营业执照 |
3 |
军官证 |
4 |
社会保障号 |
C |
解放军文职干部证 |
D |
警官证 |
E |
解放军士兵证 |
F |
户口簿 |
G |
港澳回乡通行证 |
H |
台湾通行证及其他有效旅行证 |
J |
本国护照 |
K |
武警文职干部证 |
L |
武警士兵证 |
M |
社会团体 |
N |
临时身份证 |
P |
全国组织机构代码 |
Q |
海外客户编号 |
R |
境外身份证 |
S |
港澳台居民身份证 |
2.3.10 客户类型
代码 |
品种 |
1 |
个人客户 |
2 |
机构客户 |
2.3.11 算法列表
算法代码 |
算法描述 |
算法参数 |
可选参数 |
备注 |
BENCHMARK ALGOS(基准算法) |
||||
TWAP |
时间加权平均价格算法 |
侵略级别 强制全部成交 |
开始时间 结束时间 限价 |
在指定时间段内按时间平分下单量 |
VWAP |
交易量加权平均价格算法 |
侵略级别 强制全部成交 |
开始时间 结束时间 限价 |
追踪区间市场均价 |
PARTICIPATION ALGOS(参与算法) |
||||
VolumeInLine |
跟量算法 |
侵略级别 跟量比例 |
开始时间 结束时间 |
根据目标比例,实时跟踪市场成交量进行下单 |
LIQUIDITY SEEKING ALGOS(流动性追踪算法) |
||||
Sniper |
狙击手算法 |
置信度 最小间隔 最小数量 |
开始时间 结束时间 限价 |
根据时间区间及限价和置信度准确狙击下单 |
Float |
挂单算法 |
每次挂单数量 挂单价格是否增加一个tick |
开始时间 结束时间 限价 |
实时根据市场价格,动态挂单 |
DMA ORDER TYPES(直接市场通道算法) |
||||
Iceberg |
冰山算法 |
每片数量 时间间隔 |
开始时间 结束时间 限价 |
根据时间价格和每片数量下单,隐藏交易目的 |
Stop |
止损算法 |
触发价格 |
开始时间 结束时间 |
到达指定价位后市价下单 |
DMA |
直接市场通道 |
订单类型 订单价格 |
|
直接市场通道 |
3 CATS API函数详细说明
3.1 初始化及退出清理类
3.1.1 初始化CATSAPI库
Ø 函数原型:int WINAPI CATSAPI_Init( int debug_console )
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
int debug_console |
是否启用调式窗口模式 |
Input |
Ø 返回:0表示成功,其它失败
3.1.2 退出清除CATSAPI库
Ø 函数原型:int WINAPI CATSAPI_Fini ()
Ø 输入参数:无
Ø 返回:0表示成功,其它失败
3.1.3 初始创建CATS会话
Ø 函数原型:int WINAPI CATSAPI_InitSession(CATSHANDLE* hHandle, int use_ssl, int start_conn, TS_Notify_t OnTrdReConnectedAfterUSerLogin, void* arg_TrdRecon, TS_Notify_t OnTrdDisConnectedAfterUSerLogin=NULL, void* arg_TrdDiscon=NULL, TS_Notify_t OnHqReConnectedAfterUSerLogin = NULL, void* arg_HqRecon = NULL, TS_Notify_t OnHqDisConnectedAfterUSerLogin=NULL, void* arg_HqDiscon=NULL )
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE *hHandle |
CATS 句柄 |
Output if null |
int use_ssl |
是否启用SSL通道 |
Input |
int start_conn |
是否自动后台连接CATS服务器 |
Input |
TS_Notify_t OnTrdReConnectedAfterUSerLogin |
重连CATS交易服务器成功后回调用户的钩子函数 |
Input |
void* arg_TrdRecon |
用户钩子函数参数 |
Input |
TS_Notify_t OnTrdDisConnectedAfterUSerLogin |
与CATS交易服务器连接中断后回调用户的钩子函数 |
Input |
void* arg_TrdDiscon |
用户钩子函数参数 |
Input |
TS_Notify_t OnHqReConnectedAfterUSerLogin |
重连CATS行情服务器成功后回调用户的钩子函数 |
Input |
void* arg_HqRecon |
用户钩子函数参数 |
Input |
TS_Notify_t OnHqDisConnectedAfterUSerLogin |
与CATS行情服务器连接中断后回调用户的钩子函数 |
Input |
void* arg_HqDiscon |
用户钩子函数参数 |
Input |
Ø 返回:0表示成功,其它失败
3.1.4 退出清理CATS会话
Ø 函数原型:int WINAPI CATSAPI_ExitSession(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE *hHandle |
CATS 句柄 |
Input |
Ø 返回:0表示成功,其它失败
3.1.5 准备连接CATS服务器
Ø 函数原型:
int WINAPI CATSAPI_Prepare_CatsConnect (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.1.6 连接CATS服务器
Ø 函数原型:
int WINAPI CATSAPI_Execute_CatsConnect (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_CatsConnect接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
serverName |
服务器名称(默认:TAS) |
Y |
user |
用户名(默认:catsuser) |
Y |
password |
密码(默认:GV2gODkBbGg=) |
Y |
tradingServerAddr |
交易服务器地址 |
Y |
tradingServerPort |
交易服务器端口 |
Y |
hqServerAddr |
行情服务器地址 |
Y |
hqServerPort |
行情服务器端口 |
Y |
srcIpAddr |
客户端地址 |
Y |
srcPhyAddr |
客户端物理地址 |
Y |
3. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_CatsConnectResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_CatsConnectResult (CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
latestClientVersion |
客户端最新版本 |
string |
updateServerUsername |
更新文件下载ftp用户名 |
string |
updateServerPassword |
更新文件下载ftp密码 |
string |
updateServerIP |
更新ftp地址 |
string |
updateServerPort |
更新ftp端口 |
string |
updateFileUrl |
更新ftp URL |
string |
3.2 通用函数
3.2.1 获取默认配置文件的配置信息
Ø 函数原型:
int WINAPI get_int_def(const char* sect, const char *name, int def_val)
bool WINAPI get_bool_def(const char* sect, const char *name, bool def_val)
float WINAPI get_float_def(const char* sect, const char *name, float def_val)
char* WINAPI get_string_def(const char* sect, const char *name, char *def_val)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
const char* sect |
配置文件的section名 |
Input |
const char *name |
配置名 |
Input |
def_val |
相应配置的默认值 |
Input |
Ø 返回:相应的配置值
3.2.2 获取CATSAPI版本信息
Ø 函数原型:const char* WINAPI CATSAPI_GetVersion()
Ø 输入参数:无
Ø 返回:CATS API版本字符串
3.2.3 设置业务接口的输入参数
Ø 函数原型:int WINAPI CATSAPI_SetParam(CATSHANDLE hHandle, char* name, char* szValue)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char *name |
参数名 |
Input |
char* szValue |
参数值 |
Input |
Ø 返回:0表示成功,其它失败
3.2.4 设置业务接口的输入参数组
Ø 函数原型:int WINAPI CATSAPI_SetGroupParam(CATSHANDLE hHandle, char* szValue)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
char* szValue |
参数组字符串,示例: "field1=1001;field2=abc" |
Input |
Ø 返回:0表示成功,其它失败
3.2.5 获取业务接口输出参数
Ø 函数原型:int WINAPI CATSAPI_GetValue(CATSHANDLE hHandle, char* name, char* szValue, size_t buffLen)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
char* name |
参数名字 |
Input |
char* szValue |
参数值输出缓冲区 |
Output |
size_t buffLen |
缓冲区大小 |
Input |
Ø 返回:0表示成功,其它失败
3.2.6 打开结果集
Ø 函数原型:int WINAPI CATSAPI_RsOpen(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:0表示成功,其它失败
3.2.7 打开指定名称结果集
Ø 函数原型:int WINAPI CATSAPI_RsOpenByName(CATSHANDLE hHandle, char* name)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
char* name |
结果集名称 |
Input |
Ø 返回:0表示成功,其它失败
3.2.8 获取结果集下一条记录
Ø 函数原型:int WINAPI CATSAPI_RsGetNext(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:0表示成功,其它失败
3.2.9 获取结果集记录中字段的值
Ø 函数原型:int WINAPI CATSAPI_RsGetField(CATSHANDLE hHandle, char* name, char* szValue, size_t buffLen)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
char* name |
参数名字 |
Input |
char* szValue |
字段值输出缓冲区 |
Output |
size_t buffLen |
缓冲区大小 |
Input |
Ø 返回:0表示成功,其它失败
3.2.10 执行批量的SQL
Ø 函数原型:int WINAPI CATSAPI_MDB_ExecBatchSQL(CATSHANDLE hHandle, const char *szSQL)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char *szSQL |
SQL字符串 |
Input |
Ø 返回:0表示成功,其它失败
3.2.11 执行统计计算SQL并返回第一列整数值
Ø 函数原型:int WINAPI CATSAPI_MDB_ExecScalar(CATSHANDLE hHandle, const char * FormatString, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char * FormatString |
Format string示例: select count(*) from mytable 返回mytable的记录条数 |
Input |
... |
参数值 |
Input |
Ø 返回:执行结果
3.2.12 执行一条INSERT语句
Ø 函数原型:int WINAPI CATSAPI_MDB_Insert(CATSHANDLE hHandle, const char * FormatString, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char * FormatString |
Format string |
Input |
... |
参数值 |
Input |
Ø 返回:受影响行数
3.2.13 执行一条UPDATE语句
Ø 函数原型:int WINAPI CATSAPI_MDB_Update(CATSHANDLE hHandle, const char * FormatString, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char * FormatString |
Format string |
Input |
... |
参数值 |
Input |
Ø 返回:受影响行数
3.2.14 执行一条DELETE语句
Ø 函数原型:int WINAPI CATSAPI_MDB_Delete(CATSHANDLE hHandle, const char * FormatString, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char * FormatString |
Format string |
Input |
... |
参数值 |
Input |
Ø 返回:受影响行数
3.2.15 执行一条Select语句
Ø 函数原型:bool WINAPI CATSAPI_MDB_Select(CATSHANDLE hHandle, const char *FormatString, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char * FormatString |
Format string |
Input |
... |
参数值 |
Input |
Ø 返回:true表示成功,其它失败
3.2.16 移动光标取下一条
Ø 函数原型:bool WINAPI CATSAPI_MDB_MoveNext(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:true表示成功,其它失败
移动光标取下一条,执行完查询需移动光标到第一条记录
3.2.17 获取结果集列数
Ø 函数原型:int WINAPI CATSAPI_MDB_GetColCount(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:结果集列数
3.2.18 获取结果集列名
Ø 函数原型:int WINAPI CATSAPI_MDB_GetColName(CATSHANDLE hHandle, int col, char* pColName)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
int col |
列索引 |
Input |
char* pColName |
列名缓冲区 |
Output |
Ø 返回:0表示成功,其它失败
3.2.19 获取结果集列类型
Ø 函数原型:int WINAPI CATSAPI_MDB_GetColType(CATSHANDLE hHandle, int col)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
int col |
列索引 |
Input |
Ø 返回:列类型
3.2.20 获取结果集列类型名
Ø 函数原型:int WINAPI CATSAPI_MDB_GetColTypeName(CATSHANDLE hHandle, int col, char* pColTypeName)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
int col |
列索引 |
Input |
char* pColTypeName |
列类型名缓冲区 |
Output |
Ø 返回:0表示成功,其它失败
3.2.21 获取结果集列大小
Ø 函数原型:int WINAPI CATSAPI_MDB_GetColSize(CATSHANDLE hHandle, int nCol)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
int col |
列索引 |
Input |
Ø 返回:列大小
3.2.22 根据列名获取Int列数据
Ø 函数原型:int WINAPI CATSAPI_MDB_GetColInt(CATSHANDLE hHandle, const char *name, int* val)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char *name |
列名 |
Input |
int* val |
Int数据缓冲区 |
Output |
Ø 返回:0表示成功,其它失败
3.2.23 根据列名获取Double列数据
Ø 函数原型:
int WINAPI CATSAPI_MDB_GetColDbl(CATSHANDLE hHandle, const char *name, double* val)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char *name |
列名 |
Input |
double* val |
double数据缓冲区 |
Output |
Ø 返回:0表示成功,其它失败
3.2.24 根据列名获取字符串型列数据
Ø 函数原型:
int WINAPI CATSAPI_MDB_GetColCStr(CATSHANDLE hHandle, const char *name, char *val, size_t len)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char *name |
列名 |
Input |
char* val |
字符串数据缓冲区 |
Output |
size_t len |
缓冲区大小 |
Input |
Ø 返回:0表示成功,其它失败
3.2.25 根据列名获unsigned char型列数据
Ø 函数原型:
int WINAPI CATSAPI_MDB_GetColData(CATSHANDLE hHandle, const char *name, unsigned char *val, size_t* len)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
const char *name |
列名 |
Input |
unsigned char* val |
数据缓冲区 |
Output |
size_t len |
缓冲区大小 |
Input |
Ø 返回:0表示成功,其它失败
3.3 错误处理类
3.3.1 获取最近一次的系统错误
Ø 函数原型:int WINAPI CATSAPI_GetLastError(CATSHANDLE hHandle, char* errorMsg, size_t buffLen)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
char* errorMsg |
数据缓冲区 |
Input |
size_t buffLen |
缓冲区大小 |
Input |
Ø 返回:errorCode
3.4 调试函数
3.4.1 记录DEBUG信息
Ø 函数原型:void WINAPI logdebug(const char* fmt, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
const char* fmt |
输出信息字符串 |
Input |
... |
可变入参 |
Input |
Ø 返回:无
3.4.2 记录WARN信息
Ø 函数原型:void WINAPI logwarn (const char* fmt, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
const char* fmt |
输出信息字符串 |
Input |
... |
可变入参 |
Input |
Ø 返回:无
3.4.3 记录ERROR信息
Ø 函数原型:void WINAPI logerror (const char* fmt, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
const char* fmt |
输出信息字符串 |
Input |
... |
可变入参 |
Input |
Ø 返回:无
3.4.4 记录INFO信息
Ø 函数原型:void WINAPI loginfo (const char* fmt, ...)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
const char* fmt |
输出信息字符串 |
Input |
... |
可变入参 |
Input |
Ø 返回:无
3.5 账户管理类
3.5.1 准备CATS账户登录
Ø 函数原型:
int WINAPI CATSAPI_Prepare_CatsLogin(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.2 CATS账户登录
Ø 函数原型:
int WINAPI CATSAPI_Execute_CatsLogin(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_Prepare_CatsLogin接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
CATS 账户 |
Y |
catsPassword |
密码 |
Y |
6. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_CatsLoginResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_CatsLoginResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
catsAcct |
CATS账户 |
string |
clientName |
客户姓名 |
string |
clientType |
客户类型 |
string |
certType |
身份证明类型 |
string |
certNo |
身份证明编号 |
string |
catsToken |
会话token |
string |
调用接口CATSAPI_Fetch_CatsSubAccResult提取cats子账户信息结果,函数原型为:
int WINAPI CATSAPI_Fetch_CatsSubAccResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
acctType |
账户类型 |
string |
acct |
账户号码 |
string |
branchName |
营业部名称 |
string |
name |
客户名称 |
string |
mainFlag |
主账户标识 |
(0-辅账户 1-主账户) |
3.5.3 准备修改CATS账户密码
Ø 函数原型:
int WINAPI CATSAPI_Prepare_UpdateCatsPwd (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.4 修改CATS账户密码
Ø 函数原型:
int WINAPI CATSAPI_Execute_UpdateCatsPwd (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_Prepare_UpdateCatsPwd接口
8. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
CATS 账户 |
Y |
catsToken |
Cats token |
Y |
oldPassword |
原有密码 |
Y |
newPassword |
新密码 |
Y |
9. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_GetLastError判断处理结果
调用接口CATSAPI_Fetch_UpdateCatsPwdResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_UpdateCatsPwdResult (CATSHANDLE hHandle)
3.5.5 准备增加子账户
Ø 函数原型:
int WINAPI CATSAPI_Prepare_AddSubAcc(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.6 增加子账户
Ø 函数原型:
int WINAPI CATSAPI_Execute_AddSubAcc(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_AddSubAcc接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
CATS 账户 |
Y |
catsToken |
会话token |
Y |
subAcctType |
子账户类型 |
Y |
subAcct |
子账户 |
Y |
subPassword |
子账户密码 |
Y |
mainFlag |
主账户标识 |
Y(0-辅账户 1-主账户) |
3. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_AddSubAccResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_AddSubAccResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
subAcctType |
子账户类别 |
string |
subAcct |
子账号 |
string |
branchName |
营业部或期货公司名称 |
string |
name |
客户姓名 |
string |
mainFlag |
主账户标识 |
string(0-辅账户 1-主账户) |
3.5.7 准备删除子账户
Ø 函数原型:
int WINAPI CATSAPI_Prepare_DelSubAcc(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.8 删除子账户
Ø 函数原型:
int WINAPI CATSAPI_Execute_DelSubAcc(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_DelSubAcc接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
CATS 账户 |
Y |
catsToken |
会话token |
Y |
subAcctType |
子账户类型 |
Y |
subAcct |
子账户 |
Y |
3. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_DelSubAccResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_DelSubAccResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
subAcctType |
子账户类别 |
string |
subAcct |
子账号 |
string |
3.5.9 准备查询子账户信息
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QuerySubAcc(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.10 查询子账户信息
Ø 函数原型:
int WINAPI CATSAPI_Execute_QuerySubAcc(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QuerySubAcc接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
CATS 账户 |
Y |
catsToken |
会话token |
Y |
3. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_QuerySubAccResult_SubAcc提取子账户结果,函数原型为:
int WINAPI CATSAPI_Fetch_QuerySubAccResult_SubAcc(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
acctType |
账户类型 |
string |
acct |
账户号码 |
string |
3.5.11 准备交易账户登录
Ø 函数原型:
int WINAPI CATSAPI_Prepare_TradeAccLogin(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.12 交易账户登录
Ø 函数原型:
int WINAPI CATSAPI_Execute_TradeAccLogin(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_Prepare_TradeAccLogin接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
password |
客户密码 |
Y |
loginParam |
登录参数 证券登录为委托方式 |
Y |
srcIpAddr |
客户端IP地址 |
Y |
srcPhyAddr |
客户端mac地址 |
Y |
6. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_GetLastError判断处理结果
调用接口CATSAPI_Fetch_TradeAccLoginResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_TradeAccLoginResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
acctType |
账户类别 |
string |
acct |
客户账号 |
string |
userToken |
用户token |
string |
branchName |
营业部或期货公司名称 |
string |
name |
客户名称 |
string |
3.5.13 准备新增或保存系统参数
Ø 函数原型:
int WINAPI CATSAPI_Prepare_SaveSystemParam (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.14 新增或保存系统参数
Ø 函数原型:
int WINAPI CATSAPI_Execute_SaveSystemParam (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_Prepare_SaveSystemParam接口
8. 调用CATSAPI_SetGroupParam接口设置业务参数。
接口参数格式示例:paramKey=abc;paramValue=123;remark=abc
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话token |
Y |
paramKey |
参数代码 |
Y |
paramValue |
参数值 |
Y |
remark |
参数注释 |
Y |
9. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_GetLastError判断处理结果
3.5.15 准备删除系统参数
Ø 函数原型:
int WINAPI CATSAPI_Prepare_DelSystemParam (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.5.16 删除系统参数
Ø 函数原型:
int WINAPI CATSAPI_Execute_DelSystemParam (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
10. 调用CATSAPI_Prepare_DelSystemParam接口
11. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话token |
Y |
paramKey |
参数代码 |
Y |
12. 调用本应用接口
Ø 回调函数处理
调用接口CATSAPI_GetLastError判断处理结果
3.6 交易类
3.6.1 准备单笔委托请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_OrderSingle(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.6.2 单笔委托
Ø 函数原型:
int WINAPI CATSAPI_Execute_OrderSingle(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_OrderSingle接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
password |
客户密码 |
Y |
symbol |
证券代码(代码.交易所代码) |
Y |
orderQty |
委托数量 |
Y |
orderPrice |
委托价格 |
Y |
tradeSide |
买卖方向 |
Y |
orderType |
委托类别 |
Y |
orderParam |
委托参数 |
N |
corrType |
关联类别 |
N |
corrId |
关联Id |
N |
3. 调用本应用接口
Ø 回调函数处理应答
调用CATSAPI_Fetch_OrderSingleResult函数处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_OrderSingleResult(CATSHANDLE hHandle);
业务应答结果:
字段名称 |
字段说明 |
类型 |
orderNo |
委托序号 |
string |
3.6.3 准备单笔撤单请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_WithDrawSingle(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.6.4 单笔撤单
Ø 函数原型:
int WINAPI CATSAPI_Execute_WithDrawSingle(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_WithDrawSingle接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
password |
客户密码 |
Y |
orderNo |
委托序号 |
Y |
corrType |
关联类别 |
N |
corrId |
关联Id |
N |
3. 调用本应用接口
Ø 回调函数处理应答
调用接口CATSAPI_Fetch_WithDrawSingleResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_WithDrawSingleResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
originalOrderNo |
原委托序号 |
string |
orderNo |
撤单委托序号 |
string |
3.6.5 准备组合委托请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_OrderBatch(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.6.6 组合委托
Ø 函数原型:
int WINAPI CATSAPI_Execute_OrderBatch(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_OrderBatch接口
2. 调用多次CATSAPI_SetGroupParam接口设置多笔委托参数。
每笔委托业务入参:
参数名称 |
参数说明 |
是否必须 |
auth.acctType |
账户类别 |
Y |
auth.acct |
客户账号 |
Y |
order.symbol |
证券代码(代码.交易所代码) |
Y |
order.orderQty |
委托数量 |
Y |
order.orderPrice |
委托价格 |
Y |
order.tradeSide |
买卖方向 |
Y |
order.orderType |
委托类别 |
Y |
order.orderParam |
委托参数 |
N |
3. 调用CATSAPI_SetParam接口设置普通业务参数。
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
corrType |
关联类别 |
N |
corrId |
关联Id |
N |
4. 调用本应用接口
Ø 回调函数处理应答:
调用接口CATSAPI_Fetch_OrderBatchResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_OrderBatchResult(CATSHANDLE hHandle)
业务应答结果( 待确认 ):
字段名称 |
字段说明 |
类型 |
batchNo |
批量委托序号 |
string |
调用接口CATSAPI_Fetch_OrderBatchResult_OrderNos处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_OrderBatchResult_OrderNos (CATSHANDLE hHandle)
业务应答结果( 待确认 ):
字段名称 |
字段说明 |
类型 |
orderNo |
委托序号(如果委托成功) |
string |
errorMsg |
错误信息(如果委托失败) |
string |
3.6.7 准备组合撤单请求
Ø 函数原型:int WINAPI CATSAPI_Prepare_WithDrawBatch(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.6.8 组合撤单
Ø 函数原型:
int WINAPI CATSAPI_Execute_WithDrawBatch(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_WithDrawBatch接口
2. 调用多次CATSAPI_SetParam接口设置参数信息。
每笔委托业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
batchNo |
委托批号 |
Y |
corrType |
关联类别 |
N |
corrId |
关联Id |
N |
3. 调用本应用接口
Ø 回调函数处理应答
调用接口CATSAPI_Fetch_WithDrawBatchResult处理应答结果,函数原型为:
int WINAPI CATSAPI_Fetch_WithDrawBatchResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
|
|
|
3.7 算法交易类
3.7.1 准备启动算法请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_StartAlgo(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.7.2 启动算法
Ø 函数原型:
int WINAPI CATSAPI_Execute_StartAlgo(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_StartAlgo接口
2. 调用CATSAPI_SetParam接口设置普通业务参数。
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id(请参照数据字典算法列表说明) |
Y |
3. 调用CATSAPI_SetGroupParam设置策略参数:
参数字段:name(参数名称),value(参数取值)
参数示例:name=abc;value=123
4. 调用本应用接口
Ø 回调函数处理应答:
调用接口CATSAPI_Fetch_StartAlgoResult提取启动算法结果,函数原型为:
int WINAPI CATSAPI_Fetch_StartAlgoResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
algoInstanceId |
算法实例Id |
string |
3.7.3 准备停止算法请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_StopAlgo(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.7.4 停止算法
Ø 函数原型:
int WINAPI CATSAPI_Execute_StopAlgo(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_StopAlgo接口
2. 调用CATSAPI_SetParam接口设置普通业务参数。
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
algoInstanceId |
算法实例Id |
Y |
3. 调用本应用接口
Ø 回调函数处理应答:
调用接口接口CATSAPI_Fetch_StopAlgoResult提取停止算法结果,函数原型为:
int WINAPI CATSAPI_Fetch_StopAlgoResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
|
|
|
3.7.5 准备更新算法实例
Ø 函数原型:
int WINAPI CATSAPI_Prepare_UpdateAlgoInstance (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.7.6 更新算法实例
Ø 函数原型:
int WINAPI CATSAPI_Execute_UpdateAlgoInstance (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_Prepare_UpdateAlgoInstance接口
5. 调用CATSAPI_SetParam接口设置普通业务参数。
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
algoInstanceId |
算法实例Id |
Y |
params |
算法参数 |
Y |
6. 调用CATSAPI_SetGroupParam设置策略参数:
参数字段:name(参数名称),value(参数取值)
参数示例:name=abc;value=123
7. 调用本应用接口
Ø 回调函数处理应答:
调用接口CATSAPI_GetLastError判断处理结果
调用接口接口CATSAPI_Fetch_UpdateAlgoInstanceResult提取停止算法结果,函数原型为:
int WINAPI CATSAPI_Fetch_UpdateAlgoInstanceResult (CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
|
|
|
3.7.7 准备更新算法实例委托状态请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_UpdateAlgoOrderStatus(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.7.8 更新算法实例委托状态请求
Ø 函数原型:
int WINAPI CATSAPI_Execute_UpdateAlgoOrderStatus(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_UpdateAlgoOrderStatus接口
2. 调用CATSAPI_SetParam接口设置普通业务参数。
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
algoInstanceId |
算法实例Id |
Y |
childOrderId |
子单编号 |
Y |
symbol |
证券代码 |
Y |
orderQty |
委托数量 |
Y |
orderPrice |
委托价格 |
Y |
filledQty |
成交数量 |
Y |
avgPrice |
成交均价 |
Y |
cancelQty |
撤单数量 |
Y |
status |
订单状态 |
Y |
message |
相关信息 |
Y |
3. 调用本应用接口
Ø 回调函数处理应答:
调用接口接口CATSAPI_Fetch_UpdateAlgoOrderResult提取停止算法结果,函数原型为:
int WINAPI CATSAPI_Fetch_UpdateAlgoOrderResult(CATSHANDLE hHandle)
业务应答结果:
字段名称 |
字段说明 |
类型 |
|
|
|
3.7.9 准备添加算法模版请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_AddAlgoTemplates (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.7.10 添加算法模版请求
Ø 函数原型:
int WINAPI CATSAPI_Execute_AddAlgoTemplates (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
回调函数入参 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_AddAlgoTemplates接口
2. 调用CATSAPI_SetParam接口设置普通业务参数。
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
templateAlgoCode |
算法模版代码 |
Y |
originAlgoCode |
对应算法代码 |
Y |
templateName |
算法名称 |
Y |
templateDescription |
算法模版描述 |
N |
3. 循环调用CATSAPI_SetGroupParam接口设置算法模版参数信息
示例:CATSAPI_SetGroupParam(gHandle_,” algoCode=xxx, paramCode=xxx, name=xxx, type=xxx, defaultval=xxx, remark=xxx”)
4. 调用本应用接口
Ø 回调函数处理应答:
调用接口CATSAPI_GetLastError判断处理结果
3.8 消息订阅类
3.8.1 准备资金及持仓变动订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_AssetUpdate (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.2 订阅资金及持仓变动
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_AssetUpdate (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg);
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreSub_AssetUpdate接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
password |
客户密码 |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 应答回调函数处理:
调用接口CATSAPI_GetLastError判断订阅处理结果
2. 订阅数据回调函数处理:
2.1调用接口CATSAPI_Fetch_AssetUpdateResult函数处理资金及持仓变动结果,函数原型为:
int WINAPI CATSAPI_Fetch_AssetUpdateResult(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
acctType |
账户类别 |
string |
acct |
客户账号 |
string |
2.2 调用接口CATSAPI_Fetch_AssetUpdateResult_Funds函数提取资金结果,函数原型为:
int WINAPI CATSAPI_Fetch_AssetUpdateResult_Funds(CATSHANDLE hHandle)
业务结果(funds):
字段名称 |
字段说明 |
类型 |
currentBalance |
当前余额 |
float |
enabledBalance |
可用余额 |
float |
moneyType |
币种 |
string |
fundAcct |
账户 |
string |
deposit |
入金金额(期货) |
float |
withdraw |
出金金额(期货) |
float |
frozenMargin |
冻结保证金(期货) |
float |
frozenCash |
冻结资金(期货) |
float |
currMargin |
当前保证金(期货) |
float |
closeProfit |
平仓盈亏(期货) |
float |
positionProfit |
持仓盈亏 |
float |
2.3调用CATSAPI_Fetch_AssetUpdateResult_Positions函数提取持仓结果,函数原型为:
int WINAPI CATSAPI_Fetch_AssetUpdateResult_Positions(CATSHANDLE hHandle)
业务结果(positions):
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
currentQty |
当前数量 |
Integer |
enabledQty |
可用数量 |
Integer |
costPrice |
成本价格 |
float |
lastPrice |
最新价 |
float |
marketValue |
参考市值 |
float |
incomeBalance |
盈亏金额 |
float |
stockName |
证券名称 |
string |
direction |
持仓多空方向(期货):1-净;2-多头;3-空头 |
string |
positionDate |
持仓日期类型(期货):1-今日持仓;2-历史持仓 |
string |
hedgeFlag |
投机套保标志(期货):1-投机;2-套利;3-套保 |
string |
longFrozen |
多头冻结 |
integer |
shortFrozen |
空头冻结 |
integer |
useMargin |
占用保证金 |
float |
positionCost |
持仓成本 |
float |
closeProfit |
平仓盈亏 |
float |
3.8.3 准备信用资产变动订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_CreditAssetUpdate (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.4 订阅信用资产变动
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_CreditAssetUpdate (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg);
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreSub_CreditAssetUpdate接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
6. 调用本业务接口
Ø 回调函数处理
3. 应答回调函数处理:
调用接口CATSAPI_GetLastError判断订阅处理结果
4. 订阅数据回调函数处理:
2.1调用接口CATSAPI_Fetch_CreditAssetUpdateResult函数提取信用资金结果,函数原型为:
int WINAPI CATSAPI_Fetch_CreditAssetUpdateResult (CATSHANDLE hHandle)
业务结果(funds):
字段名称 |
字段说明 |
类型 |
acct |
账户 |
string |
fund_asset |
现金资产 |
float |
market_value |
证券市值 |
float |
assure_asset |
担保资产 |
float |
total_debit |
总负债 |
float |
fetch_balance |
可取金额 |
float |
per_assurescale_value |
个人维持担保比例 |
float |
enable_bail_balance |
可用保证金 |
float |
used_bail_balance |
已用保证金 |
float |
assure_enbuy_balance |
买担保品可用资金 |
float |
fin_enbuy_balance |
买融资标的可用资金 |
float |
slo_enrepaid_balance |
买券还券可用资金 |
float |
fin_enrepaid_balance |
现金还款可用资金 |
float |
fin_max_quota |
融资最高额度 |
float |
fin_enable_quota |
融券可用额度 |
float |
fin_used_quota |
融资已用额度 |
float |
fin_used_bail |
融资已用保证金额 |
float |
fin_compact_balance |
融资合约金额 |
float |
fin_compact_fare |
融资合约费用 |
float |
fin_compact_interest |
融资合约利息 |
float |
fin_market_value |
融资市值 |
float |
fin_income |
融资合约盈亏 |
float |
slo_max_quota |
融券最高额度 |
float |
slo_enable_quota |
融券可用额度 |
float |
slo_used_quota |
融券已用额度 |
float |
slo_used_bail |
融券已用保证金额 |
float |
slo_compact_balance |
融券合约金额 |
float |
slo_compact_fare |
融券合约费用 |
float |
slo_compact_interest |
融券合约利息 |
float |
slo_market_value |
融券市值 |
float |
slo_income |
融券合约盈亏 |
float |
other_fare |
其他费用 |
float |
underly_market_value |
标的证券市值 |
float |
2.3调用CATSAPI_Fetch_CreditAssetUpdate_CompactResult函数提取信用合约结果,函数原型为:
int WINAPI CATSAPI_Fetch_CreditAssetUpdate_CompactResult (CATSHANDLE hHandle)
业务结果(positions):
字段名称 |
字段说明 |
类型 |
open_date |
合约开仓日期 |
string |
compact_id |
合约编号 |
string |
client_id |
客户编号 |
string |
fund_account |
资金账户 |
string |
money_type |
币种 |
string |
exchange_type |
交易类别 |
string |
stock_account |
证券账户 |
string |
stock_code |
证券名称 |
string |
crdt_ratio |
融资融券保证金比例 |
string |
entrust_no |
委托编号 |
string |
entrust_price |
委托价格 |
float |
entrust_amount |
委托数量 |
float |
business_amount |
合约开仓数量 |
float |
business_balance |
合约开仓金额 |
float |
business_fare |
合约开仓费用 |
float |
compact_type |
合约类型 |
string |
compact_status |
合约状态 |
string |
real_compact_balance |
未还合约金额 |
float |
real_compact_amount |
未还合约数量 |
float |
real_compact_fare |
未还合约费用 |
float |
real_compact_interest |
未还合约利息 |
float |
repaid_interest |
已还利息 |
float |
repaid_amount |
已还数量 |
float |
repaid_balance |
已还金额 |
float |
compact_interest |
合约总利息 |
float |
used_bail_balance |
占用保证金 |
float |
year_rate |
合约年利率 |
float |
ret_end_date |
归还截止日 |
string |
date_clear |
了结日期 |
string |
3.8.5 准备委托成交订阅请求
函数原型:int WINAPI CATSAPI_PreSub_OrderUpdate (CATSHANDLE hHandle)
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
返回:0表示成功,其它失败
3.8.6 订阅委托成交
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_OrderUpdate (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreSub_OrderUpdate接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
password |
客户密码 |
Y |
3. 调用本接口
Ø 回调函数处理
1. 应答数据回调函数处理:
调用CATSAPI_GetLastError函数判断订阅结果。
2. 推送数据回调函数处理::
2.1 调用接口函数CATSAPI_Fetch_OrderUpdateResult提取委托成交结果公共数据。函数原型为:
int WINAPI CATSAPI_Fetch_OrderUpdateResult(CATSHANDLE hHandle)
业务结果字段为:
字段名称 |
字段说明 |
类型 |
acctType |
账户类别 |
string |
acct |
客户账号 |
string |
2.2 调用接口函数CATSAPI_Fetch_OrderUpdateResult_Orders >提取订单更新结果,函数原型为:
int WINAPI CATSAPI_Fetch_OrderUpdateResult_Orders(CATSHANDLE hHandle)
业务结果为:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
orderQty |
委托数量 |
Integer |
orderPrice |
委托价格 |
float |
tradeSide |
买卖类别 |
string |
orderType |
委托类型 |
string |
orderParam |
委托参数 |
string |
orderNo |
委托编号 |
string |
filledQty |
成交数量 |
integer |
avgPrice |
成交均价 |
float |
cancelQty |
撤单数量 |
integer |
orderTime |
委托时间 |
string |
status |
订单状态 |
integer |
corrType |
关联类型 |
string |
corrId |
关联Id |
string |
3.8.7 准备期货持仓明细订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_FuturePositionDetail (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.8 订阅期货持仓明细
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_FuturePositionDetail (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg);
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_PreSub_FuturePositionDetail接口
8. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
账户类别 |
Y |
acct |
客户账号 |
Y |
9. 调用本业务接口
Ø 回调函数处理
5. 应答回调函数处理:
调用接口CATSAPI_GetLastError判断订阅处理结果
6. 订阅数据回调函数处理:
2.1调用接口CATSAPI_Fetch_FuturePositionDetailResult函数提取账户信息,函数原型为:
int WINAPI CATSAPI_Fetch_FuturePositionDetailResult (CATSHANDLE hHandle)
业务结果(funds):
字段名称 |
字段说明 |
类型 |
acctType |
账户类型 |
string |
acct |
账户 |
string |
2.3调用CATSAPI_Fetch_FuturePositionDetailResult_Position函数提取持仓明细结果,函数原型为:
int WINAPI CATSAPI_Fetch_FuturePositionDetailResult_Position (CATSHANDLE hHandle)
业务结果(positions):
字段名称 |
字段说明 |
类型 |
tradeNo |
成交编号 |
string |
symbol |
商品代码 |
string |
hedgeFlag |
投保标志 |
string |
direction |
买卖方向 |
string |
openDate |
开仓日期 |
string |
volume |
数量 |
integer |
tradingDay |
交易日期 |
string |
tradeType |
成交类型 |
string |
combInstrumentID |
组合编号 |
string |
openPrice |
开仓价格 |
float |
closeProfitByDate |
逐日盯市平仓盈亏 |
float |
closeProfitByTrade |
逐笔对冲平仓盈亏 |
float |
positionProfitByDate |
逐日盯市持仓盈亏 |
float |
PositionProfitByTrade |
逐笔对冲持仓盈亏 |
float |
margin |
投资者保证金 |
float |
lastSettlementPrice |
昨结算价 |
float |
closeAmount |
平仓金额 |
float |
closeVolume |
平仓量 |
integer |
3.8.9 准备行情订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_MarketData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.10 订阅行情
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_MarketData (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreSub_MarketData接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码(XXXXXX.XX) |
Y |
3. 调用本接口
Ø 回调函数处理
1. 应答回调函数处理
调用接口CATSAPI_GetLastError判断订阅结果。
2. 行情推送数据回调处理
调用接口CATSAPI_Fetch_MarketDataResult提取行情结果,函数原型为:
int WINAPI CATSAPI_Fetch_MarketDataResult(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码(XXXXXX.XX) |
string |
date |
日期(YYYYMMDD) |
integer |
time |
行情时间(HHMMSSmmm) |
integer |
stopMark |
停牌标志(1 停牌) |
integer |
cjbs |
成交笔数 |
integer |
futureCode |
期货交易品种 |
string |
stkName |
证券名称 |
string |
lastPrice |
当前价 |
float |
openPrice |
开盘价 |
float |
highPrice |
最高价 |
float |
lowPrice |
最低价 |
float |
prevClosePrice |
昨日收盘价 |
float |
closePrice |
收盘价 |
float |
highLimited |
涨停价 |
float |
lowLimited |
跌停价 |
float |
settlement |
今结算价(期货行情) |
float |
prevSettlement |
前结算价(期货行情) |
float |
bidPrice1 |
申买价1 |
float |
askPrice1 |
申卖价1 |
float |
bidPrice2 |
申买价2 |
float |
askPrice2 |
申卖价2 |
float |
bidPrice3 |
申买价3 |
float |
askPrice3 |
申卖价3 |
float |
bidPrice4 |
申买价4 |
float |
askPrice4 |
申卖价4 |
float |
bidPrice5 |
申买价5 |
float |
askPrice5 |
申卖价5 |
float |
turnOver |
总成交金额 |
float |
peRatio1 |
市盈率1 |
float |
peRatio2 |
市盈率2 |
float |
prevDelta |
昨虚实度 |
float |
curDelta |
今虚实度 |
float |
openInterest |
持仓量 |
float |
prevOpenInterest |
前持仓量 |
float |
volume |
总成交量 |
integer |
curVol |
现量 |
integer |
bidVol1 |
申买量1 |
integer |
askVol1 |
申卖量1 |
integer |
bidVol2 |
申买量2 |
integer |
askVol2 |
申卖量2 |
integer |
bidVol3 |
申买量3 |
integer |
askVol3 |
申卖量3 |
integer |
bidVol4 |
申买量4 |
integer |
askVol4 |
申卖量4 |
integer |
bidVol5 |
申买量5 |
integer |
askVol5 |
申卖量5 |
integer |
注意:为了减少网络流量,行情数据为二进制传输,调用CATSAPI_GetBuffer获取STRealMarketData结构数据,行情推送第一笔为全量数据,之后推送为增量数据,即不变的数据为负值或空,请注意正确处理。
3.8.11 准备行情退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_MarketData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.12 退订行情
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_MarketData (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreUnSub_MarketData接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
3. 调用本接口
Ø 回调函数处理
调用接口CATSAPI_GetLastError获取退订结果
3.8.13 准备批量行情订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_BatchMarketData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.14 批量订阅行情
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_BatchMarketData (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreSub_BatchMarketData接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
6. 循环调用CATSAPI_SetGroupParam接口设置订阅的商品代码信息
示例:CATSAPI_SetGroupParam(gHandle_,”value=000001.SZ”)
7. 调用本接口
Ø 回调函数处理
3. 应答回调函数处理
调用接口CATSAPI_GetLastError判断订阅结果。
4. 行情推送数据回调处理
调用接口CATSAPI_Fetch_BatchMarketDataResult提取行情结果,函数原型为:
int WINAPI CATSAPI_Fetch_BatchMarketDataResult(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码(XXXXXX.XX) |
string |
date |
日期(YYYYMMDD) |
integer |
time |
行情时间(HHMMSSmmm) |
integer |
stopMark |
停牌标志(1 停牌) |
integer |
cjbs |
成交笔数 |
integer |
futureCode |
期货交易品种 |
string |
stkName |
证券名称 |
string |
lastPrice |
当前价 |
float |
openPrice |
开盘价 |
float |
highPrice |
最高价 |
float |
lowPrice |
最低价 |
float |
prevClosePrice |
昨日收盘价 |
float |
closePrice |
收盘价 |
float |
highLimited |
涨停价 |
float |
lowLimited |
跌停价 |
float |
settlement |
今结算价(期货行情) |
float |
prevSettlement |
前结算价(期货行情) |
float |
bidPrice1 |
申买价1 |
float |
askPrice1 |
申卖价1 |
float |
bidPrice2 |
申买价2 |
float |
askPrice2 |
申卖价2 |
float |
bidPrice3 |
申买价3 |
float |
askPrice3 |
申卖价3 |
float |
bidPrice4 |
申买价4 |
float |
askPrice4 |
申卖价4 |
float |
bidPrice5 |
申买价5 |
float |
askPrice5 |
申卖价5 |
float |
turnOver |
总成交金额 |
float |
peRatio1 |
市盈率1 |
float |
peRatio2 |
市盈率2 |
float |
prevDelta |
昨虚实度 |
float |
curDelta |
今虚实度 |
float |
openInterest |
持仓量 |
float |
prevOpenInterest |
前持仓量 |
float |
volume |
总成交量 |
integer |
curVol |
现量 |
integer |
bidVol1 |
申买量1 |
integer |
askVol1 |
申卖量1 |
integer |
bidVol2 |
申买量2 |
integer |
askVol2 |
申卖量2 |
integer |
bidVol3 |
申买量3 |
integer |
askVol3 |
申卖量3 |
integer |
bidVol4 |
申买量4 |
integer |
askVol4 |
申卖量4 |
integer |
bidVol5 |
申买量5 |
integer |
askVol5 |
申卖量5 |
integer |
3.8.15 准备批量行情退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_BatchMarketData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.16 退订行情
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_BatchMarketData (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreUnSub_BatchMarketData接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
6. 循环调用CATSAPI_SetGroupParam接口设置订阅的商品代码信息
示例:CATSAPI_SetGroupParam(gHandle_,”value=000001.SZ”)
7. 调用本接口
Ø 回调函数处理
调用接口CATSAPI_GetLastError获取退订结果
3.8.17 准备当日分钟线数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_MinuteBar (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.18 订阅当日分钟线行情
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_MinuteBar (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅推送回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅推送回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreSub_MinuteBar接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
type |
订阅类型(参见数据字典) |
Y |
3. 调用本接口
Ø 回调函数处理:
1. 应答回调函数
调用接口CATSAPI_GetLastError获取订阅结果。
2. 行情数据推送回调函数
调用接口CATSAPI_Fetch_MinuteBarResult提取分钟线聚集行情结果,函数原型为:
int WINAPI CATSAPI_Fetch_MinuteBarResult (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
openPrice |
开盘价 |
float |
closePrice |
收盘价 |
float |
highPrice |
最高价 |
float |
lowPrice |
最低价 |
float |
prevClosePrice |
前收盘价 |
float |
volume |
成交量 |
integer |
amount |
成交金额 |
float |
3.8.19 准备分钟行情退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_MinuteBar (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.20 退订分钟行情
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_MinuteBar (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreUnSub_MinuteBar接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
type |
分钟类型(参见数据字典) |
Y |
3. 调用本接口
Ø 回调函数处理
调用CATSAPI_GetLastError函数获取结果数据
3.8.21 准备日线数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_DayBar (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.22 订阅日线行情数据
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_DayBar (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅推送回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅推送回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreSub_DayBar接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
type |
日线类型(参见数据字典) |
Y |
beginDate |
行情开始日期(YYYYMMDD) |
Y |
endDate |
行情结束日期(YYYYMMDD) |
|
6. 调用本接口
Ø 回调函数处理:
3. 应答回调函数
调用接口CATSAPI_GetLastError获取订阅结果。
4. 行情数据推送回调函数
调用接口CATSAPI_Fetch_MinuteBarResult提取分钟线聚集行情结果,函数原型为:
int WINAPI CATSAPI_Fetch_MinuteBarResult (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
openPrice |
开盘价 |
float |
closePrice |
收盘价 |
float |
highPrice |
最高价 |
float |
lowPrice |
最低价 |
float |
prevClosePrice |
前收盘价 |
float |
volume |
成交量 |
integer |
amount |
成交金额 |
float |
3.8.23 准备日线行情退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_DayBar (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.24 退订日线行情
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_DayBar (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreUnSub_DayBar接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
type |
日线类型(参见数据字典) |
Y |
6. 调用本接口
Ø 回调函数处理
调用CATSAPI_GetLastError函数获取结果数据
3.8.25 准备分价数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_PriceList(CATSHANDLE hHandle);
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.26 订阅分价数据
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_PriceList(CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg);
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅推送回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅推送回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_PreSub_PriceList接口
8. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
9. 调用本接口
Ø 回调函数处理:
5. 应答回调函数
调用接口CATSAPI_GetLastError获取订阅结果。
调用接口CATSAPI_Fetch_PriceListResult获取当前存量分价表
6. 行情数据推送回调函数
调用接口CATSAPI_Fetch_PubPriceListResult提取分价数据结果结果,函数原型为:
int WINAPI CATSAPI_Fetch_PubPriceListResult(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
price |
价格 |
float |
volume |
数量 |
integer |
bidRate |
竞买率 |
float |
3.8.27 准备取消分价数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_PriceList(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.28 取消订阅分价数据
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_PriceList(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_PreUnSub_PriceList接口
8. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
9. 调用本接口
Ø 回调函数处理
调用CATSAPI_GetLastError函数获取结果数据
3.8.29 准备逐笔成交订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_StockMatchDetail(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.30 订阅逐笔成交数据
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_StockMatchDetail(CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅推送回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅推送回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
10. 调用CATSAPI_PreSub_StockMatchDetail接口
11. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
12. 调用本接口
Ø 回调函数处理:
7. 应答回调函数
调用接口CATSAPI_GetLastError获取订阅结果。
调用接口CATSAPI_Fetch_StockMatchDetailResult获取当前存量逐笔成交数据
8. 行情数据推送回调函数
调用接口CATSAPI_Fetch_PubStockMatchDetailResult提取逐笔成交数据结果,函数原型为:
int WINAPI CATSAPI_Fetch_PubStockMatchDetailResult(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
price |
价格 |
float |
volume |
数量 |
integer |
prop |
性质 股票(1:买入 2:卖出 3:中性盘) 期货(4:多开 5:空开 6:双开 7:多平 8:空平 9:双平 10:多换 11:空换) |
integer |
increPosition |
增仓 |
integer |
3.8.31 准备取消逐笔成交数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_StockMatchDetail(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.32 取消订阅逐笔成交数据
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_StockMatchDetail(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
10. 调用CATSAPI_PreUnSub_StockMatchDetail接口
11. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
12. 调用本接口
Ø 回调函数处理
调用CATSAPI_GetLastError函数获取结果数据
3.8.33 准备Level2逐笔成交订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_StockMatchDetailL2(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.34 订阅Level2逐笔成交数据
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_StockMatchDetailL2(CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅推送回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅推送回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
13. 调用CATSAPI_PreSub_StockMatchDetailL2接口
14. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
15. 调用本接口
Ø 回调函数处理:
9. 应答回调函数
调用接口CATSAPI_GetLastError获取订阅结果。
调用接口CATSAPI_Fetch_StockMatchDetailResultL2提取存量逐笔成交数据结果,函数原型为:
int WINAPI CATSAPI_Fetch_StockMatchDetailResultL2(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
price |
价格 |
float |
volume |
数量 |
integer |
10. 行情数据推送回调函数
调用接口CATSAPI_Fetch_PubStockMatchDetailResultL2提取逐笔成交数据结果,函数原型为:
int WINAPI CATSAPI_Fetch_PubStockMatchDetailResultL2(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
price |
价格 |
float |
volume |
数量 |
integer |
3.8.35 准备取消Level2逐笔成交数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_StockMatchDetailL2(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.36 取消订阅Level2逐笔成交数据
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_StockMatchDetailL2(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
13. 调用CATSAPI_PreUnSub_StockMatchDetailL2接口
14. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
15. 调用本接口
Ø 回调函数处理
调用CATSAPI_GetLastError函数获取结果数据
3.8.37 准备委托队列数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_OrderQueue(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.38 订阅委托队列数据
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_OrderQueue(CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收订阅推送回调函数 |
Input |
void* pUserOnPublishArg |
接收订阅推送回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
16. 调用CATSAPI_PreSub_OrderQueue接口
17. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
股票代码 |
Y |
18. 调用本接口
Ø 回调函数处理:
11. 应答回调函数
调用接口CATSAPI_GetLastError获取订阅结果。
12. 行情数据推送回调函数
调用接口CATSAPI_Fetch_PubOrderQueueResult提取委托队列数据结果,函数原型为:
int WINAPI CATSAPI_Fetch_PubOrderQueueResult(CATSHANDLE hHandle)
调用接口CATSAPI_Fetch_PubOrderQueueResult_Orders获取结果中的委托列表数据,函数原型为:
int WINAPI CATSAPI_Fetch_PubOrderQueueResult_Orders(CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmssSSS) |
integer |
tradeSide |
买卖方向 |
string |
orders |
委托队列 |
结果集 |
|
price(价格) |
float |
|
Volume(数量) |
integer |
3.8.39 准备取消委托队列数据请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_OrderQueue(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.40 取消委托队列数据订阅
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_OrderQueue(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
退订回调函数 |
Input |
void* arg |
退订回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
16. 调用CATSAPI_PreUnSub_OrderQueue接口
17. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
18. 调用本接口
Ø 回调函数处理
调用CATSAPI_GetLastError函数获取结果数据
3.8.41 准备算法实例列表订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_AlgoInstanceEx (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.42 订阅算法实例列表
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_AlgoInstanceEx (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收推送数据回调函数 |
Input |
void* pUserOnPublishArg |
回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreSub_AlgoInstanceEx接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
3. 调用本接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_AlgoInstanceResultEx提取算法实例状态结果,函数原型为:
int WINAPI CATSAPI_Fetch_AlgoInstanceResultEx (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
algoId |
算法ID |
string |
algoInstanceId |
算法实例ID |
string |
catsAcct |
CATS帐号 |
boolean |
stopped |
是否停止 |
string |
message |
消息 |
string |
date |
日期 |
integer |
time |
时间 |
integer |
调用CATSAPI_Fetch_AlgoInstanceParamResultEx函数提取实例参数结果数据,函数原型为:
int WINAPI CATSAPI_Fetch_AlgoInstanceParamResultEx (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
name |
参数名称 |
string |
value |
参数值 |
string |
3.8.43 准备算法实例列表退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_AlgoInstanceEx (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.44 退订算法实例列表
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_AlgoInstanceEx (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreUnSub_AlgoInstanceEx接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
3. 调用本接口
Ø 回调函数处理应答结果
调用接口CATSAPI_GetLastError获取结果数据
3.8.45 准备算法实例执行信息订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_AlgoExecStatisData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.46 订阅算法实例执行信息
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_AlgoExecStatisData (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收推送数据回调函数 |
Input |
void* pUserOnPublishArg |
回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreSub_AlgoExecStatisData接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
algoInstanceId |
算法实例Id |
Y |
6. 调用本接口
Ø 回调函数处理
调用接口CATSAPI_Fetch_AlgoExecStatisDataResult提取算法实例相关信息,函数原型为:
int WINAPI CATSAPI_Fetch_AlgoExecStatisDataResult (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
algoId |
算法ID |
string |
algoInstanceId |
算法实例ID |
string |
调用接口CATSAPI_Fetch_AlgoExecStatisDataResult_ExecStatisData提取算法实例委托相关信息,函数原型为:
int WINAPI CATSAPI_Fetch_AlgoExecStatisDataResult_ExecStatisData (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
acctType |
帐号类型 |
string |
acct |
账户 |
string |
symbol |
证券代码 |
string |
tradeSide |
买卖方向 |
string |
targetQty |
目标数量 |
integer |
orderQty |
委托数量 |
integer |
orderPrice |
委托价格 |
double |
filledQty |
成交数量 |
integer |
pendingQty |
未知数量 |
integer |
avgPrice |
平均成交价 |
double |
cancelQty |
撤单数量 |
integer |
rejectQty |
下单拒绝数量 |
integer |
orderCnt |
下单次数 |
integer |
cancelCnt |
撤单次数 |
integer |
filledCnt |
成交次数 |
integer |
pendingCnt |
待确定次数 |
integer |
rejectCnt |
下单拒绝次数 |
integer |
Remark |
备注 |
string |
lastOrderNo |
最后一次下单编号 |
string |
lastOrderStatus |
最后下单状态 |
string |
lastError |
最后一次错误信息 |
string |
lastOrderType |
最后一次错误类型 |
string |
lastOrderPrice |
最后一次下单价格 |
double |
3.8.47 准备算法实例执行信息退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_AlgoExecStatisData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.48 退订算法实例执行信息
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_AlgoExecStatisData (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_PreUnSub_AlgoExecStatisData接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoId |
算法Id |
Y |
algoInstanceId |
算法实例Id |
Y |
6. 调用本接口
Ø 回调函数处理应答结果
调用接口CATSAPI_GetLastError获取结果数据
3.8.49 准备分级基金监控数据订阅请求
Ø 函数原型:
int WINAPI CATSAPI_PreSub_ICFStatisData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.50 订阅分级基金监控数据
Ø 函数原型:
int WINAPI CATSAPI_Subscribe_ICFStatisData (CATSHANDLE hHandle, TS_Notify_t pUserOnPublish, void* pUserOnPublishArg, TS_Notify_t pUserOnAnswer, void* pUserOnAnswerArg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnPublish |
接收推送数据回调函数 |
Input |
void* pUserOnPublishArg |
回调函数参数 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreSub_ICFStatisData接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
PSymbol |
父基金证券代码 |
Y |
FSymbol |
期货合约代码 |
Y |
FRatio |
交易额与一手期货金额的比例 |
Y |
3. 调用本接口
Ø 回调函数处理应答结果
调用接口CATSAPI_Fetch_ICFStatisDataResult提取分级基金监控数据结果,函数原型为:
int WINAPI CATSAPI_Fetch_ICFStatisDataResult(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
aiid |
算法实例ID |
string |
PSymbol |
父基金证券代码 |
string |
PIDailyPL |
父基金跟踪指数的涨跌幅 |
float |
PNetWorthYes |
父基金昨日净值 |
float |
PNetWorthEst |
父基金当日预估净值 |
float |
CAValidBuyPrice |
子基金A有效买入价 |
Float |
CBValidBuyPrice |
子基金B有效买入价 |
Float |
PValidBuyPrice |
父基金有效买入价 |
Float |
BuyZYJRate |
买入折溢价率 |
Float |
CABuyQty |
子基金A买入数量 |
Integer |
CBBuyQty |
子基金B买入数量 |
Integer |
CAValidSellPrice |
子基金A有效卖出价 |
float |
CBValidSellPrice |
子基金B有效卖出价 |
float |
PValidSellPrice |
父基金有效卖出价 |
Float |
SellZYJRate |
卖出折溢价率 |
Float |
CASellQty |
子基金A卖出数量 |
Integer |
CBSellQty |
子基金B卖出数量 |
Integer |
isZJ |
是否折价 , true 折价 、false 溢价 |
Boolean |
CAValidPrice |
子基金A有效价 |
Float |
CBValidPrice |
子基金B有效价 |
Float |
PValidPrice |
父基金有效价 |
Float |
ZYJRate |
折溢价率 |
Float |
BasisRate |
基差偏移率 |
Float |
CAQty |
子基金A买卖数量 |
Integer |
CBQty |
子基金B买卖数量 |
Integer |
FSymbol |
期货合约代码 |
String |
FRatio |
交易额与一手期货金额的比例 |
Float |
HqDate |
最新行情日期 |
Integer |
HqTime |
最新行情时间 |
Integer |
FPrice |
期货合约价格 |
Float |
FTPrice |
期货合约跟踪指数价格 |
Float |
seqNo |
序列号 |
integer |
3.8.51 准备分级基金监控数据退订请求
Ø 函数原型:
int WINAPI CATSAPI_PreUnSub_ICFStatisData (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.8.52 退订分级基金监控数据
Ø 函数原型:
int WINAPI CATSAPI_UnSubscribe_ICFStatisData (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
应答回调函数 |
Input |
void* arg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_PreUnSub_ICFStatisData接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
PSymbol |
父基金证券代码 |
Y |
FSymbol |
期货合约代码 |
Y |
FRatio |
交易额与一手期货金额的比例 |
Y |
3. 调用本接口
Ø 回调函数处理应答结果
调用接口CATSAPI_GetLastError获取结果数据
3.9 查询类
3.9.1 准备查询历史分钟线请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryMinBar (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.2 查询历史分钟线
(查询历史分钟线,非当日分钟线)
Ø 函数原型:
int WINAPI CATSAPI_Execute_QueryMinBar(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QueryMinBar接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
type |
分钟类型(参见行情聚合类型数据字典) |
Y |
beginDate |
开始时间(YYYYMMDD) |
Y |
endDate |
结束时间(YYYYMMDD) |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅结果
调用接口CATSAPI_Fetch_QueryMinBarResult_MinBars提取分钟线结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryMinBarResult_MinBars(CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmss) |
integer |
openPrice |
开盘价 |
float |
closePrice |
收盘价 |
float |
highPrice |
最高价 |
float |
lowPrice |
最低价 |
float |
preClosePrice |
前收盘 |
float |
volume |
成交量 |
integer |
amount |
成交金额 |
float |
3.9.3 准备查询历史日线数据请求
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryDayBar (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.4 查询历史日线数据
Ø 函数原型:
int WINAPI CATSAPI_Execute_QueryDayBar (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_Prepare_QueryMinBar接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
type |
日线类型(参见行情聚合类型数据字典) |
Y |
beginDate |
开始时间(YYYYMMDD) |
Y |
endDate |
结束时间(YYYYMMDD) |
Y |
6. 调用本业务接口
Ø 回调函数处理
2. 调用接口CATSAPI_GetLastError判断处理结果
调用接口CATSAPI_Fetch_QueryDayBarResult_DayBars提取日线结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryDayBarResult_DayBars (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
symbol |
证券代码 |
string |
date |
日期(yyyyMMdd) |
integer |
time |
行情时间(hhmmss) |
integer |
openPrice |
开盘价 |
float |
closePrice |
收盘价 |
float |
highPrice |
最高价 |
float |
lowPrice |
最低价 |
float |
preClosePrice |
前收盘 |
float |
volume |
成交量 |
integer |
amount |
成交金额 |
float |
3.9.5 准备查询历史分钟线文件路径信息
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryHisMinFilePath (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.6 查询历史分钟线文件路径信息
Ø 函数原型:
int WINAPI CATSAPI_Execute_QueryHisMinFilePath (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_Prepare_QueryHisMinFilePath接口
8. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
symbol |
证券代码 |
Y |
beginDate |
开始时间(YYYYMMDD) |
Y |
endDate |
结束时间(YYYYMMDD) |
Y |
9. 调用本业务接口
Ø 回调函数处理
3. 调用接口CATSAPI_GetLastError判断处理结果
调用接口CATSAPI_Fetch_QueryHisMinFilePathResult_FilePaths提取历史分钟线文件路径信息,函数原型为:
int WINAPI CATSAPI_Fetch_QueryHisMinFilePathResult_FilePaths (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
filePath |
文件相关信息 |
string |
3.9.7 准备下载历史分钟线文件
Ø 函数原型:
int WINAPI CATSAPI_Prepare_DownloadFile (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.8 下载历史分钟线文件
Ø 函数原型:
int WINAPI CATSAPI_Execute_DownloadFile (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
10. 调用CATSAPI_Prepare_DownloadFile接口
11. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
filePath |
文件信息 |
Y |
12. 调用本业务接口
Ø 回调函数处理
4. 调用接口CATSAPI_GetLastError判断处理结果
3.9.9 准备查询商品信息
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryCommodityInfo (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.10 查询商品信息
Ø 函数原型:
int WINAPICATSAPI_Execute_QueryCommodityInfo (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QueryCommodityInfo接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅处理结果
2. 调用接口CATSAPI_Fetch_QueryCommodityInfoResult提取查询商品信息请求结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryCommodityInfoResult (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
returnCount |
返回证券信息条数 |
integer |
3.
调用接口CATSAPI_Fetch_QueryCommodityInfoResult_CommodityInfo提取提取证券信息结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryCommodityInfoResult_CommodityInfo (CATSHANDLE hHandle)
业务结果:
字段名称 |
字段说明 |
类型 |
commodityCode |
商品代码 |
string |
commodityName |
证券名称 |
string |
commoditySpell |
首字母拼写 |
string |
commodityType |
商品类型(见商品类型字典) |
string |
commoditySubType |
商品子类型 |
string |
exchange |
交易所 |
string |
circulationVol |
总股本 |
integer |
pre |
昨日收盘价 |
float |
status |
状态 |
string |
3.9.11 准备查询交易时间
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryTradeTime(CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.12 查询交易时间
Ø 函数原型:
int WINAPI CATSAPI_Execute_QueryTradeTime(CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QueryTradeTime接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅处理结果
2. 调用接口CATSAPI_Fetch_QueryTradeTimeResult提取交易所交易时间数据结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryTradeTimeResult(CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
exchange |
交易所代码 |
string |
commoditySubType |
商品子类 |
string |
beginTime |
开始时间(HHMMSS) |
integer |
endTime |
结束时间(HHMMSS) |
integer |
minites |
交易时长 |
integer |
3.9.13 准备查询客户授权算法
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QryCatsAlgo (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.14 查询客户授权算法
Ø 函数原型:
int WINAPI CATSAPI_Execute_QryCatsAlgo (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QryCatsAlgo接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅处理结果
2. 调用接口CATSAPI_Fetch_CatsAlgoResult提取授权算法结果,函数原型为:
int WINAPI CATSAPI_Fetch_CatsAlgoResult (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
algoCode |
算法代码 |
string |
name |
算法名称 |
string |
description |
算法描述 |
string |
algoMark |
|
string |
algoType |
算法类型 |
string |
flag |
标识 |
string |
originAlgoCode |
|
string |
3.9.15 准备查询算法参数
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QryAlgoParams (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.16 查询算法参数
Ø 函数原型:
int WINAPI CATSAPI_Execute_QryAlgoParams (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QryAlgoParams接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoCode |
算法代码 |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅处理结果
2. 调用接口CATSAPI_Fetch_AlgoParamsResult提取算法参数结果,函数原型为:
int WINAPI CATSAPI_Fetch_AlgoParamsResult (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
algoCode |
算法代码 |
string |
paramCode |
参数名称 |
string |
name |
参数名称 |
string |
type |
类型 |
string |
defaultval |
默认值 |
string |
remark |
备注 |
string |
3.9.17 准备查询算法实例
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QryAlgoInstance (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.18 查询算法实例
Ø 函数原型:
int WINAPI CATSAPI_Execute_QryAlgoInstance (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QryAlgoInstance接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoCode |
算法代码 |
N |
algoInstCode |
算法实例代码 |
N |
status |
状态 |
N |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅处理结果
2. 调用接口CATSAPI_Fetch_QryAlgoInstResult_AlgoInst提取算法实例结果,函数原型为:
int WINAPI CATSAPI_Fetch_QryAlgoInstResult_AlgoInst (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
algoInstCode |
算法实例代码 |
string |
catsAcct |
Cats账户 |
string |
algoCode |
算法代码 |
string |
startTime |
开始时间 |
string |
stopTime |
结束时间 |
string |
status |
状态 |
string |
3. 调用接口CATSAPI_Fetch_QryAlgoInstResult_AlgoInstParams提取算法实例结果,函数原型为:
int WINAPI CATSAPI_Fetch_QryAlgoInstResult_AlgoInstParams (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
algoInstCode |
算法实例代码 |
string |
paramCode |
算法实例参数代码 |
string |
paramVal |
算法实例参数取值 |
string |
3.9.19 准备查询算法实例参数
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QryAlgoInstanceParams (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.20 查询算法实例参数
Ø 函数原型:
int WINAPI CATSAPI_Execute_QryAlgoInstanceParams (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
1. 调用CATSAPI_Prepare_QryAlgoInstanceParams接口
2. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
algoInstCode |
算法实例代码 |
Y |
3. 调用本业务接口
Ø 回调函数处理
1. 调用接口CATSAPI_GetLastError判断订阅处理结果
2. 调用接口CATSAPI_Fetch_AlgoInstanceParamsResult提取算法实例参数结果,函数原型为:
int WINAPI CATSAPI_Fetch_AlgoInstanceParamsResult (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
algoInstCode |
算法实例代码 |
string |
paramCode |
参数代码 |
string |
paramVal |
参数值 |
string |
3.9.21 准备查询商品类型信息
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryCommodityTypeInfo (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.22 查询商品类型
Ø 函数原型:
int WINAPI CATSAPI_Execute_QueryCommodityTypeInfo (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
4. 调用CATSAPI_Prepare_QueryCommodityTypeInfo接口
5. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
commodityType |
商品类型代码 |
N |
commoditySubType |
商品子类型代码 |
N |
6. 调用本业务接口
Ø 回调函数处理
3. 调用接口CATSAPI_GetLastError判断订阅处理结果
4. 调用接口CATSAPI_Fetch_QueryCommodityTypeInfoResult提取商品类型结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryCommodityTypeInfoResult (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
exchange |
交易所代码 |
string |
commodityType |
商品类型代码 |
string |
commodityTypeName |
商品类型名称 |
string |
commoditySubType |
商品子类型代码 |
string |
commoditySubTypeName |
商品子类型名称 |
string |
multiplier |
乘数 |
float |
tickSize |
最小变动单位 |
float |
3.9.23 准备查询最大可委托数量
Ø 函数原型:
int WINAPI CATSAPI_Prepare_QueryMaxOrderVolume (CATSHANDLE hHandle)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
Ø 返回:
0表示成功,其它失败
3.9.24 查询最大可委托数量
Ø 函数原型:
int WINAPI CATSAPI_Execute_QueryMaxOrderVolume (CATSHANDLE hHandle, TS_Notify_t pUserOnAnswer, void* arg)
Ø 输入参数:
参数名称 |
参数说明 |
用法 |
CATSHANDLE hHandle |
CATS API 句柄 |
Input |
TS_Notify_t pUserOnAnswer |
订阅请求应答回调函数 |
Input |
void* pUserOnAnswerArg |
应答回调函数参数 |
Input |
Ø 返回:
0表示成功,其它失败
Ø 调用步骤:
7. 调用CATSAPI_Prepare_QueryMaxOrderVolume接口
8. 调用CATSAPI_SetParam接口设置业务参数。
业务入参:
参数名称 |
参数说明 |
是否必须 |
catsAcct |
Cats账户 |
Y |
catsToken |
会话 token |
Y |
acctType |
子账户类型 |
Y |
acct |
子账户 |
Y |
symbol |
商品代码 |
Y |
orderPrice |
委托价格 |
Y |
tradeSide |
买卖方向 |
Y |
orderType |
订单类型 |
Y |
orderParam |
类型参数 |
N |
9. 调用本业务接口
Ø 回调函数处理
5. 调用接口CATSAPI_GetLastError判断订阅处理结果
6. 调用接口CATSAPI_Fetch_QueryMaxOrderVolumeResult提取查询结果,函数原型为:
int WINAPI CATSAPI_Fetch_QueryMaxOrderVolumeResult (CATSHANDLE hHandle);
业务结果:
字段名称 |
字段说明 |
类型 |
enableAmount |
最大可委托数量 |
integer |
stockUnit |
存放单位(1:股或张 10:手) |
string |