简介

捷利交易宝OpenAPI SDK的产品及SDK接口、协议说明

 

系统概述

通过交易宝OpenAPI SDK可连接到捷利交易宝OpenAPI行情服务系统, 调用SDK相关接口可获取各市场(港股、美股、A股)的实时、延时等行情数据。

 

行情权限

捷利交易宝OpenAPI行情服务系统使用行情服务包控制用户行情权限,仅限个人使用。

 

SDK接口

SDK流程图

OpenAPI流程图-流程图

 

SDK线程模型

 

SDK接口返回值

定义返回值描述 
TKAPI_OK0成功 
TKAPI_ERROR-1通用错误 
TKAPI_NETWORK-2网络错误 
TKAPI_NOMEM-3内存不足 

 

SDK接口说明

查询SDK版本

TKAPI_GetVersion

参数类型是否可选描述
-- -- 
参数类型是否可选描述
versionstring必填返回版本的缓存
lenthint必填版本的缓存长度(建议长度不小于48个字节)

 

初始化SDK

TKAPI_Initialize

参数类型是否可选描述
modeint必填SDK模式
0: UAT模式
1: 生产模式
threadsint必填SDK内部线程数
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

初始化行情对象

TKAPI_CreateQuote

参数类型是否可选描述
flagint必填保留参数
备注: 必须是0
contextvoid*必填回调context(透传给回调函数的context参数)
callbackTKAPI_QUOTE_CALLBACK必填行情消息(数据)回调
备注:SDK使用内部创建的线程调用callback
quoteTKAPI_QUOTEOBJECT必填返回行情对象
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  
参数类型是否可选描述
contextvoid*必填透传TKAPI_CreateQuote的context参数
datavoid*必填行情消息(数据)
lengthint必填行情消息(数据)的长度

 

登录行情

TKAPI_Login

参数类型是否可选描述
quoteTKAPI_QUOTEOBJECT必填行情对象
typeint必填登录类型
0: 用户名(通行证)登录
1: 手机号登录
usernamestring必填用户名/手机号
sessionstring必填密码
errmsgstring必填返回错误信息的缓存
lenthint必填错误信息的缓存长度
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

请求/订阅

TKAPI_SendRequest

参数类型是否可选描述
quoteTKAPI_QUOTEOBJECT必填行情对象
stypeint必填数据类型
1:查询请求
2:订阅请求
3:取消订阅请求
datastring必填详细格式说明清查看websocket章节
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

查询用户行情服务包

TKAPI_GetServicePackage

参数类型是否可选描述
quoteTKAPI_QUOTEOBJECT必填行情对象
china_userint*必填返回是否中国内地用户: 'Y': 是 'N': 否
servicepkgTKAPI_SEVICES_PACKAGE*必填返回服务包列表的缓存
countint*必填服务包列表的缓存长度(个)
定义描述  
>0服务包个数  
TKAPI_OK成功(同时表示无任何服务包)  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

查询网络状态

TKAPI_GetNetworkStatus

参数类型是否可选描述
quoteTKAPI_QUOTEOBJECT必填行情对象
sitestring必填返回站点地址的缓存
lenthint必填站点地址的缓存长度
secondsint*必填在线时长
rspeedint*必填下行速度
sspeedint*必填上下速度
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

投递用户数据到回调函数

TKAPI_Post

参数类型是否可选描述
contextTKAPI_QUOTEOBJECT必填回调context(透传给回调函数的context参数)
databyte数组必填投递的数据地址
lengthint必填投递的数据长度(字节)
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

退出登录

TKAPI_Logout

参数类型是否可选描述
quoteTKAPI_QUOTEOBJECT必填行情对象
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

关闭行情对象

TKAPI_CloseQuote

参数类型是否可选描述
quoteTKAPI_QUOTEOBJECT必填行情对象
定义描述  
TKAPI_OK成功  
TKAPI_ERROR通用错误  
TKAPI_NETWORK网络错误  
TKAPI_NOMEM内存不足  

 

数据定义说明

语言类型

lang含义  
0/en英语  
1/chs/zh-ch简体中文(默认)  
2/cht/zh-cht繁体中文  

 

股票代码定义

示 例 定义市场代码股票代码(市场+代码)
示例(HK)E08017E08017
示例(SZ)A000001A000001
示例(SH)B600010B600010
示例(US)NAAPLNAAPL

 

股票类型定义

市场证券类型值证券类型含义 
香港I指数 
 F期货 
 W权证 
 N牛熊证 
 T界内证 
 C创业板股 
 J基金(ETF) 
 Z债券 
 L杠杆及反向基金 
 H预托凭证 
 E投资公司IC 
 R房地产信托基金 
 A[剩余证券] 
美股I指数 
 W权证 
 T界内证 
 Z债券 
 J基金 
 U组合证券(UNIT) 
 OOTC证券 
 A[剩余证券] 
上海/深圳I指数 
 W权证 
 J基金 
 Z债券 
 A正股 
 BB股 
 K科创板(上海特有) 
 O其它 

 

个股行情状态

取值含义备注 
空值未知状态初始化值 
S开盘前  
C开盘竞价  
U收盘竞价  
T交易中  
B休市  
E已收盘  
P停牌  
Q盘前交易  
H盘后交易  
D等待开盘  
W待上市  

 

排序ID定义

行情数据排序ID sortid值排序内容  
0证券代码  
1证券名称  
2昨收价  
3今开价  
4最高价  
5最低价  
6按盘价(或现价)  
7成交量  
8成交额  
9买1价  
10买1量  
11卖1价  
12卖1量  
13委比  
14委差  
15涨跌(或升跌)  
16涨跌幅(或升跌幅)  
17量比  
18均价  
19振幅  
20内盘  
21外盘  
22涨速(率)  
2352周最高(不用作排序)  
2452周最低(不用作排序)  
25现手  
26市值或基金的资产规模  
27每股净资产  
28市盈(率)  
29换手(率)  
30股息(率)  
31周息率  
32成交笔数  
33次数  
34股数  
35金额  
36经纪席位号  
37经纪席位名称  
38平均价=金额/股数  
39市净率  
40市盈率(TTM)  
41股息(TTM)  
42股息率(TTM)  
43费用占比  
44上市日期  
45上限(价)  
46下限(价)  
47距离(到期日)日期天数  
    
60溢价  
61杠杆比率  
62有效杠杆  
63对冲值  
64引申波幅  
65类别  
66行使价  
67打和点  
68到期日期  
69收回价  
70收回价差  
71距收回价  
72换股比率  
73街货量(%)  
74内在价值  
75值博率  
76贡献点数  
77总股本(或基金总发行量)  
78流通股本  
805日涨跌幅  
8110日涨跌幅  
8220日涨跌幅  
8360日涨跌幅  
84120日涨跌幅  
85250日涨跌幅  
86月初至今涨跌幅  
87年初至今涨跌幅  
个股实时资金流向排序ID   
100总流入  
101总流出  
102净流入  
103净流入率  
104小单流入  
105小单流出  
106小单净流入  
107中单流入  
108中单流出  
109中单净流入  
110大单流入  
111大单流出  
112大单净流入  
113特大单流入  
114特大单流出  
115特大单净流入  
116经纪席位准确率  
117主力流入(大单+特大单)  
118主力流出  
119主力净流入  
120散户流入(大单+特大单)  
121散户流出  
122散户净流入  
个股3天资金流向排序ID   
140流入天数  
141阶段流入资金  
142阶段流出资金  
143阶段净流入  
144阶段成交额  
145阶段净流入率  
146阶段涨幅  
147阶段换手  
148主力净流入  
149散户净流入  
个股一周(5天)资金流向排序ID   
150流入天数  
151阶段流入资金  
152阶段流出资金  
153阶段净流入  
154阶段成交额  
155阶段净流入率  
156阶段涨幅  
157阶段换手  
158主力净流入  
159散户净流入  
个股一月(20天)资金流向排序ID   
170流入天数  
171阶段流入资金  
172阶段流出资金  
173阶段净流入  
174阶段成交额  
175阶段净流入率  
176阶段涨幅  
177阶段换手  
178主力净流入  
179散户净流入  
个股三个月(60天)资金流向排序ID   
180流入天数  
181阶段流入资金  
182阶段流出资金  
183阶段净流入  
184阶段成交额  
185阶段净流入率  
186阶段涨幅  
187阶段换手  
188主力净流入  
189散户净流入  
板块排序ID   
200板块名称  
201平均价  
202平均涨幅  
203流入资金  
204流出资金  
205净流入  
206净流入率  
207领涨股  
208领涨股现价  
209领涨股涨幅  
十大成交活跃股排序ID   
220买入及卖出  
221买入  
222卖出  

 

行情时段值定义

行情时段由 period 参数控制,目前仅美股有效,其值含义如下表所示:

period 取值含义备注 
0盘中默认值 
1盘前  
2盘后  
100全盘仅请求时使用 

 

美国交易所ID值定义

ID取值含义备注 
0未定义初始化值 
1纳斯达克(NASDAQ)  
2纽交所(NYSE)  
3美交所(AMEX)  
4BATS  
5OTC  

 

美国纽交所字所值定义

字符值十进制ASCII 值含义备注
 32未知初始化值
a97NYSE American 
c99NYSE National Exchange 
d100NYSE TRF 
m109NYSE Chicago 
n110NYSE BQT 
p112NYSE Arca 

 

成交明细买卖方向值定义

含义--备注
1主动卖出、内盘--绿色向下箭头(↓):代表卖方主动性成交已下单的买单
2主动买入、外盘--红色向上箭头(↑):代表买方主动性成交已下单的卖单
0中性盘--没有箭头:代表两笔委托价格相同(其中市价买入/卖出的情况不做参考)且时间相同的成交单

 

数据接口说明

1. 数据格式使用WebSocket的string (Json)的消息类型,

2. 下行(应答、推送)统一格式:

 

请求应答接口

查询指数行情(index)

查询指数

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填指数代码多个,逗号间隔
langstring可选语言类型
其它   

RDS.do?pkgtype=index&code=EHSI&lang=1

 

查询个股静态数据(itemstaticdata)

查询个股静态数据

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填股票代码
langstring可选语言类型
其它   

RDS.do?pkgtype=itemstaticdata&code=A002202&lang=1

 

查询个股动态数据(itemdynamicdata)

查询个股动态数据

参数类型是否可选描述
pkgtypestring必填协议类型 (itemdynamicdata)
codestring必填股票代码
langstring可选语言类型
其它   

RDS.do?pkgtype=Itemdynamicdata&code=E08421&lang=1

 

查询个股档位报价(quoteprice)

查询个股档位报价

参数类型是否可选描述
pkgtypestring必填协议类型 (quoteprice)
codestring必填股票代码
lvstring必填报价档位: 1或5或10;
其它   

/RDS.do?pkgtype=quoteprice

 

查询个股经纪队列(brokers)

查询个股经纪队列

参数类型是否可选描述
pkgtypestring必填协议类型 (brokers)
codestring必填股票代码
lvstring必填报价档位: 1或5或10;
其它   

/RDS.do?pkgtype=brokers&code=E08017

 

获取个股分时图数据(itemtimesharing)

获取个股分时图数据

参数类型是否可选描述
pkgtypestring必填协议类型 (itemtimesharing)
codestring必填股票代码
vunitstring可选成交量单位值
periodstring必填时段 有效值:盘前、盘中、盘后、全盘
其它   

RDS.do?pkgtype=itemtimesharing&code=E08017

 

查询个股分钟K线数据(minutekLine)

查询个股分钟K线数据

参数类型是否可选描述
pkgtypestring必填协议类型 (minutekLine)
codestring必填股票代码
minstring必填分钟数据类型(1, 15)
endstring必填结束日期,表示取该日期(含该日期)以前的历史数据,格式YYYYMMDD 不传或传0表示当日日期
endminstring必填结束分钟时间,表示取该分钟时间点(含该时间)以前的历史数据,格式HHMM不传或传0表示默认处理
countstring必填以end日期endmin分钟往前取数据的数量(最大值为6000)
vunitstring可选成交量单位值
其它   

RDS.do?pkgtype=minutekLine&code=E08017&min=1&end=20170906&endmin=930&count=100

 

查询个股k线数据(hiskline)

查询个股k线数据

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填股票代码
typestring必填周期类型(3=日k,4=周k,5=月k) 当参数ext=1时,type=3
powerstring必填复权类型(0=不复权,1=前复权,2=后复权)
extstring可选扩展字段: 0(默认):不启用start 参数 1:启用start 参数 (仅type=3有效)
startstring可选起始日期,表示取该日期(含该日期)以后的历史数据,格式YYYYMMDD 不传或传0表示最早日期
endstring必填结束日期,表示取该日期(含该日期)以前的历史数据,格式YYYYMMDD 不传或传0表示当日日期
countstring必填以end日期往前取数据的数量(最大值为200) 当ext=1时: count=0:返回start到end日期的数量(超过最大值按默认处理)
vunitstring可选成交量单位值: 0 (默认):内地股票(SH、SZ、SB)成交量单位为手 1:上海科创板成交量单位为股,剩余内地股票成交量单位都为手
其它   

RDS.do?pkgtype=hiskline&code=EHSI&ext=0&start=0&end=0&power=0&count=5&type=3

 

查询个股交易明细(tk)

查询个股交易明细

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填股票代码
posstring必填A、pos =-1&& dir=-1:从最新位置向前(新->旧)查询(含最新位置) B、pos =-1&& dir=1:从最旧位置向后(旧->新)查询(含最旧位置) 其他值:从指定pos位置查询,但不含pos该位置本身
dirstring必填 
sizestring必填分页大小
extstring可选扩展字段 0(默认):返回数据不带成交额 1: 返回数据带成交额
vunitstring可选成交量单位值
periodstring必填时段 有效值:盘前、盘中、盘后、全盘

RDS.do?pkgtype=tk&code=E00001&pos=-1&dir=-1&size=2

 

查询盘前或盘后快照(itemsnapshotba)

查询盘前或盘后快照

参数类型是否可选描述
pkgtypestring必填协议类型 (itemsnapshotba)
codestring必填股票代码,多只股票,逗号间隔
langstring可选语言类型
其它   

RDS.do?pkgtype=itemsnapshotba&code=NAAPL&lang=1

 

查询个股基本行情数据(100)

查询个股基本行情数据

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填股票代码。多个股票,逗号间隔
sortidstring必填排序id
sortstring可选升降序。0降序,1升序
langstring可选语言类型
其它   

RDS.do?pkgtype=100&code=B600036&sortid=-1&sort=0&lang=1

 

查询基本行情数据(1702)

查询基本行情数据

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填股票代码。多个股票,逗号间隔
sortidstring必填排序id
sortstring必填升降序。0降序,1升序
langstring可选语言类型
其它   

RDS.ashx?pkgtype=1702&code=B600036&sortid=-1&sort=0&lang=1

 

获取个股全盘逐笔成交明细(itemtradeticks)

获取个股逐笔成交明细

参数类型是否可选描述
pkgtypestring必填协议类型 (itemtradeticks)
codestring必填股票代码
posstring必填A、pos=-1&& dir=-1:从最新位置向前(新->旧)查询(含最新) B、pos=-1&& dir=1:从最旧位置向后(旧->新)查询(含最旧) C、其他值:从指定pos位置查询,但不含pos该位置本身
dirstring必填 
countstring必填数量(限制5000)

RDS.do?pkgtype=itemtradeticks&code=E00001&pos=-1&dir=-1&count=2

 

获取个股全盘逐笔成交还原(ItemTradeResumes)

获取个股全盘逐笔成交还原

参数类型是否可选描述
pkgtypestring必填协议类型
codestring必填股票代码
posstring必填A、pos=-1&& dir=-1:从最新位置向前(新->旧)查询(含最新) B、pos=-1&& dir=1:从最旧位置向后(旧->新)查询(含最旧) C、其他值:从指定pos位置查询,但不含pos该位置本身
dirstring必填 
countstring可选数量(限制5000)

RDS.do?pkgtype=ItemTradeResumes&code=E00001&pos=-1&dir=-1&count=2

 

获取个股全盘逐笔委托(entryorders)

获取个股全盘逐笔委托

参数类型是否可选描述
pkgtypestring必填协议类型 (entryorders)
codestring必填股票代码
typestring必填委托类型: 1: 增加 100: 全部 101: 修改+删除
posstring必填A、pos=-1&& dir=-1:从最新位置向前(新->旧)查询(含最新) B、pos=-1&& dir=1:从最旧位置向后(旧->新)查询(含最旧) C、其他值:从指定pos位置查询,但不含pos该位置本身
dirstring必填 
countstring可选数量(限制5000)

RDS.do?pkgtype=entryorders&code=E00001&type=100&pos=-1&dir=-1&count=2

 

订阅推送接口

多股票行情(scsi)

订阅或取消订阅多股票行情数据

参数类型是否可选描述
stypestring必填ws请求类型 0:登录 1:查询 2:订阅 3:取消订阅
verifystring必填随机验证码
pkgtypestring必填协议类型 (scsi)
codestring必填股票代码,多只股票以逗号分隔
extstring可选扩展数据说明: 0(默认): 返回除ext=1外的所有数据 1: 返回部分数据加ext=1的数据
langstring可选语言类型
其它   

pkgtype=scsi&code=E00001&ext=0&lang=1

 

个股行情详情数据(spmic)

个股行情详情数据

参数类型是否可选描述
stypestring必填ws请求类型 0:登录 1:查询 2:订阅 3:取消订阅
verifystring必填随机验证码
pkgtypestring必填协议类型
codestring必填股票代码
langstring可选语言类型
smidstring必填订阅页面板块id
extstring必填扩展值(与smid组合使用)
simd值ext值ppmic对应字段含义
0  无效值
1--base股票详情信息
21/5/10que1/5/10档买卖行情
3--tk交易明细
40/1brokers经纪队列: ext=0:带席位名称 ext=1:不带席位名称
2011/100/101fulltickorder港股全盘委托 1: 增加 100: 全部 101: 修改+删除
2020fulltickresume港股全盘还原

pkgtype=scsi&code=E00001&ext=0&lang=1

 

推送用户退出消息(puqi)

个股行情详情数据

 

推送广播消息

个股行情详情数据