# 介绍
# 概述
华盛证券为开发者的程序化交易提供了交易和行情接口,开发者可通过OpenAPI Gateway快速集成应用程序和第三方工具,构建自己的量化交易策略。
华盛OpenAPI Gateway是华盛OpenAPI的网关程序,在您本地电脑运动后,负责中转协议及转发处理后的数据,支持 Windows、macOS、Linux(即将上线) ;
提供 Java
、Python
、C++
接入 Gateway SDK,也提供 protobuf
接口定义文件可自行对接;
# 开通指引
# 1.注册
开发者需要在华盛通注册并开通交易业务;
# 2.提供开发者信息
内容 | 是否必填 | 说明 |
---|---|---|
开发者RSA公钥 | 是 | 初始化链接时使用,验证开发者的身份。注:此RSA公钥不是平台的公钥。 |
IP白名单 | 否 | 只有在白名单内的IP才可以访问API接口,多个IP间以英文逗号分隔(,)分隔。 |
# 3.开通申请
开发者需要确认并签署《API问卷评估调查》、《API测试结果申报表》、《API开发者授权协议》、《API免责声明》,通过合规部门审核(2-3工作日)后,才可以开通OpenAPI实盘功能;
# 4.配置账号
审核通过后,点击此处配置开发者RSA公钥 (opens new window)
# 费用说明
# 行情
通过OpenAPI获取行情与通过华盛通APP获取行情权限一致,如您没有行情权限,请与客户经理联系。
# 交易
通过OpenAPI进行交易,交易费用与通过华盛通APP交易费用一致。
# 安装说明
提供 Windows、macOS、Linux(即将上线) 客户端程序:华盛通 OpenAPI Gateway 桌面端
(命令行和GUI两个版本)
点击此处下载 华盛通 OpenAPI Gateway (GUI 安装包) for Windows (opens new window)
点击此处下载 华盛通 OpenAPI Gateway (GUI 安装包) for macOS (opens new window)
点击此处下载 华盛通 OpenAPI Gateway (命令行程序) for Windows (opens new window)
提供 Java
、Python
、C++
接入 Gateway SDK,也提供 protobuf
接口定义文件可自行对接
点击此处下载 Java SDK (opens new window)
点击此处下载 Python SDK (opens new window)
点击此处下载 C++ SDK (opens new window)
点击此处下载 protobuf (opens new window)
# 编程环境搭建
不同编程语言,编程环境的搭建方式不同,此处以Python为例
- 环境要求
操作系统要求
Windows 7/10 的 64 位操作系统
Mac 11 及以上的 64 位操作系统Python版本要求
Python 3.6 及以上
- 环境搭建
- 安装Python
- 安装PyCharm(可选)
- 下载Python SDK
初次安装:Windows 系统 pip install --upgrade pip,pip install wheel, pip install setuptools; Linux/Mac系统 pip3 install --upgrade pip,pip3 install wheel, pip3 install setuptools。
二次升级:Windows 系统 pip install --upgrade pip,Linux/Mac系统 $ pip3 install --upgrade pip.
# 加密解密流程
- 生成密钥对:可到这个网址 (opens new window)或其他第三方网站,在线生成随机 RSA 密钥对,密钥格式必须为 PCKS#8,密钥长度 1024,不要设置密码;
- 将生成的私钥复制保存到文件中,然后将私钥文件通过GUI版本的 Gateway "导入开发者私钥" ,或使用命令行版本时,将私钥配置到 Gateway的privateKeyPath配置项中;
- 将生成的公钥点击此处配置开发者RSA公钥 (opens new window)
配置好公私钥后,华盛通 OpenAPI Gateway 已自动处理以下事项:
- 发送数据加密
- 接收数据解密
# 华盛通 OpenAPI Gateway 桌面端(GUI版本)
- 下载GUI安装包,支持 Windows、macOS、Linux ;
- 安装运行GUI
- 登录账号并配置 配置项如下:
- 登录账号、登录密码
- 选择平台测试环境/生产环境
- 导入开发者私钥(此私钥为您生成的与公钥配对的私钥)
- 选择交易服务源(建议程序在大陆运行使用内地源,在其他地区运行使用香港源)
- 运行程序
- 检查日志 可自行检查程序运行日志,或遇到问题时可提供日志,方便技术快速定位问题; 日志路径如下: windows:%appdata%\OpenAPIGateway\logs
# 华盛通 OpenAPI Gateway 桌面端(命令行版本)
1.下载解压,运行 HSOpenAPIGateway.exe
2.通过软件根目录 config.xml
配置参数
<!--华盛通OpenAPIGateway配置文件-->
<hs_gateway>
<!--mobile 【必填】登录手机号-->
<!--countryCode 【必填】登录手机号区号:CHN、HKG、...(或者+86、+852、...会被自动识别)-->
<!--listenIp 【可以不填】本地服务地址(默认127.0.0.1)-->
<!--listenHttpPort 【可以不填】HTTP请求端口(默认11111)-->
<!--listenTcpPort 【可以不填】TCP推送端口(默认11112)-->
<!--logPath 【可以不填】日志路径(默认软件根目录)-->
...
<mobile>13500000000</mobile>
<countryCode>+86</countryCode>
...
</hs_gateway>
3.命令行启动,根据提示完成登录流程
[1] API权限已开通!
[2] 设备已绑定!
[3] 登录成功!
[4] 网络正常!
====================================================
版本号 1.0.3
日志文件路径 /patn/to/log
HTTP 请求地址 http://127.0.0.1:11111
TCP 长连接地址 127.0.0.1:11112
OpenAPI在线文档 http://quant-open.hstong.com/api-docs/
Q,q - 终止
help - 帮助
info - 状态
relogin - 重新登录&连接
tradelogin - 交易登录
tradelogout - 交易登出
====================================================
# HTTP请求协议
仅支持 HTTP
,暂不支持 HTTPS。
仅支持 POST
,暂不支持 GET。
请求地址和 protobuf 协议一致,例如 http://127.0.0.1:11111/trade/TradeLogin (也支持 /TradeLoginRequest 和 /TradeLoginRequestMsgType)
请求参数格式为 JSON,保存在 Content。
POST /trade/xxxRequest HTTP/1.1
Host: 127.0.0.1:11111
Content-Type: application/json
Content-Length: 123
{"timeout_sec":10,"params":{"key":"value"}}
请求参数格式(JSON)
{
"timeout_sec": 10,
"params": {
"key": "value"
}
}
请求返回格式(JSON)
{
"ok": true,
"err": "错误信息",
"data": {
"key": "value"
}
}
# TCP推送协议
基于TCP Socket长链接。
报文格式:通讯头(header) + 报文体(msgBody)+业务实体(payload)。
header固定151字节。
msgBody采用Protobuf编码二进制格式。推送(PBNotify)payload为业务实体,见具体接口中“消息类型”定义部分。
# 通讯头
位数 | 属性 | 类型 | 说明 | 可能值 | 默认值 |
---|---|---|---|---|---|
1-2 | szHeaderFlag | Chars(utf-8) | 包头起始标志 | 固定为"HS" | HS |
3-4 | msgType | Int16(Little Endian) | 消息类型 | OpenAPI Gateway 仅使用 "3" 推送 | 3 |
5 | protoFmtType | Byte | 数据格式 | OpenAPI Gateway 仅使用 "0" Protobu | 0 |
6 | protoVer | Byte | 协议版本,用于迭代兼容 | 0 | |
7-10 | serialNo | Int32(Little Endian) | 包序列号,要求递增 | ||
11-14 | bodyLen | Int32(Little Endian) | 包体最终(加密后)长度 | OpenAPI Gateway 为解密后长度 | |
15-142 | bodySHA1 | Bytes | 包体原始数据的SHA1WithRSA签名值,用于验签 | OpenAPI Gateway 已自动签名(日志) | |
143 | compressAlgorithm | Byte | 压缩算法 | OpenAPI Gateway 仅使用 "0"不压缩 | 0 |
144-151 | reserved | Int64(Little Endian) | 保留8字节扩展 |
# 推送报文体
message PBNotify {
NotifyMsgType notifyMsgType = 1;
string notifyId = 2;
uint64 notifyTime = 3;
google.protobuf.Any payload = 4;
}
属性 | 类型 | 说明 |
---|---|---|
notifyMsgType | NotifyMsgType枚举 | 推送消息类型 |
notifyId | String | 推送ID |
notifyTime | Long | 推送时间戳 |
payload | Any | 推送消息实体 |
# 接入说明
接口调用时序图
# 平台接口
# 查询汇率
# 接口说明
查询各币种汇率(CNY、HKD、USD)。
# 接口地址
POST http://127.0.0.1:11111/hs/rate/queryList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
rateType | String | 否 | 0:换汇汇率, 1:即期汇率 如果不传,默认查询换汇汇率 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"rateType": "0"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"HKD": {
"USD": "0.12718763",
"CNY": "0.90785293"
},
"USD": {
"HKD": "7.83510000",
"CNY": "7.22780000"
},
"CNY": {
"HKD": "1.07770000",
"USD": "0.13925443"
}
}
}
# 交易接口
# 交易登录
# 接口说明
交易相关接口都必须交易登录成功后才可以调用。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeLogin
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
password | String | 是 | 交易密码,加密格式:Base64(AES(password)) | AES秘钥"m+qS04/2CH1OweCnmXZ3TDZkCQS+hBzY" |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"password": "password"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"success": true
}
}
# 交易登出
# 接口说明
客户退出交易状态
# 接口地址
POST http://127.0.0.1:11111/trade/TradeLogout
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"success": true
}
}
# 查询客户资金
# 接口说明
查询客户资金信息
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryMarginFundInfo
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易市场类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"holdsBalance": "string 持仓盈亏(废弃,该值不可靠,不建议使用该字段)",
"assetBalance": "string 总资产",
"enableBalance": "string 可用金额(购买力)",
"marketValue": "string 证券市值(废弃,该值不可靠,不建议使用该字段)",
"cashOnHold": "string 交易冻结金额",
"creditValue": "string 已用额度",
"creditLine": "string 信用额度",
"fetchBalance": "string 可取金额",
"frozenBalance": "string 总冻结金额",
"accountStatus": "string 账户状态",
"spentRatio": "string 资金使用率",
"currentCreditLimit": "string 当前信用额度",
"maxCreditLimit": "string 提升最大信用额度",
"unitCreditLimit": "string 统一信用额度",
"unitMaxCreditLimit": "string 最大统一信用额度",
"buyPower": "string 购买力 (统一和单一市场对应市场主币种)",
"buyPowerCredit": "string 购买力,提升信用额度后购买力 (统一和单一市场对应市场主币种)",
"buyPowerHk": "string 港股购买力",
"buyPowerUs": "string 美股购买力",
"buyPowerCn": "string 中华通购买力",
"unitedBuyPowerHk": "string 统一港股购买力",
"unitedBuyPowerUs": "string 统一美股购买力",
"unitedBuyPowerCn": "string 统一中华通购买力",
"thirdBuyPowerHk": "string 第三方港股购买力",
"thirdBuyPowerUs": "string 第三方美股购买力",
"thirdBuyPowerCn": "string 第三方中华通购买力",
"buyPowerShortMarket": "string 卖空购买力",
"buyPowerMoney": "string 现金购买力"
}
}
# 查询持仓列表
# 接口说明
查询持仓股票列表
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryHoldsList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 否 | 交易市场类别 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"stockName": "string 股票名称",
"enableAmount": "string 可卖数量",
"currentAmount": "string 持仓",
"stockCode": "string 股票代码",
"lastPrice": "string 最新价(废弃,该值不可靠,不建议使用该字段)",
"incomeBalance": "string 浮动盈亏(废弃,该值不可靠,不建议使用该字段)",
"costPrice": "string 成本价",
"marketValue": "string 股票市值(废弃,该值不可靠,不建议使用该字段)",
"marketValueRate": "string 盈亏比例(废弃,该值不可靠,不建议使用该字段)",
"incomeRatio": "string 市值占比(废弃,该值不可靠,不建议使用该字段)",
"dayCostPrice": "string 当日成本价",
"dayInComeAmount": "string 当日有效入金",
"dayOutComeAmount": "string 当日有效出金",
"keepCostPrice": "string 保本价",
"exchangeType": "string 交易市场类型"
}
}
# 查询最大可买
# 接口说明
获取最大可买数量
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryBuyAmount
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 | |
entrustPrice | String | 是 | 委托价格 | |
queryType | String | 是 | 查询类型 | '0'-默认、'1'-Margin |
clientType | Integer | 否 | 客户端类型 | '0'-internet |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"entrustPrice": "35.900",
"clientType": 0,
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "int32 最大可买数量"
}
}
# 查询最大可卖
# 接口说明
获取最大可卖数量
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQuerySellAmount
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 | |
clientType | Integer | 否 | 客户端类型 | '0'-internet |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"clientType": 0,
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "int32 最大可卖数量"
}
}
# 查询当日资金流水
# 接口说明
查询客户当日资金流水。分页时当收到的列表为空或数量小于queryCount,表示没有下一页。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryRealFundJourList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
queryCount | Integer | 是 | 每页返回数量 | 默认 20(限制小于100) |
queryParamStr | String | 是 | 游标 | 初始值为0 开始,分页时传上一页最后一条数据的queryParamStr |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"queryCount": 20,
"queryParamStr": "0"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"businessBalance": "string 发生金额",
"type": "string 类型",
"typeDesc": "string 类型描述",
"fundJourParentType": "string 资金流水父类型",
"time": "string 成交日期,当日资金流水没有,历史资金流水有",
"queryParamStr": "string 当前记录的索引,用于分页"
}
}
# 查询历史资金流水
# 接口说明
查询客户历史资金流水。分页时当收到的列表为空或数量小于queryCount,表示没有下一页。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryHistoryFundJourList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
queryCount | Integer | 是 | 每页返回数量 | 默认 20(限制小于100) |
queryParamStr | String | 是 | 游标 | 初始值为0 开始,分页时传上一页最后一条数据的queryParamStr |
startDate | String | 是 | 起始日期 | 格式为:yyyyMMdd |
endDate | String | 是 | 结束日期 | 格式为:yyyyMMdd |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"queryCount": 20,
"queryParamStr": "0",
"startDate": "20230101",
"endDate": "20230102"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"businessBalance": "string 发生金额",
"type": "string 类型",
"typeDesc": "string 类型描述",
"fundJourParentType": "string 资金流水父类型",
"time": "string 成交日期,当日资金流水没有,历史资金流水有",
"queryParamStr": "string 当前记录的索引,用于分页"
}]
}
}
# 期货-查询客户资金信息
# 接口说明
获取指定用户下指定资金账户的当前最新资金信息 。
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryFundInfo
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"fundInfo": {
"assetBalance": "string 资产净值",
"enableBalance": "string 可用金额(购买力)",
"marginCall": "string 追缴保证金",
"incomeBalance": "string 持仓盈亏",
"cashBal": "string 现金结余",
"iMargin": "string 基本保证金",
"mMargin": "string 维持保证金",
"marginLevel": "string 保证金水平",
"maxMargin": "string 最高保证金",
"creditLimit": "string 信贷限额",
"ctrlLevel": "string 控制级数",
"marginClass": "string 保证金类型",
"aeId": "string 经纪",
"cashBalHKD": "string 港币现金结余",
"cashBalUSD": "string 美元现金结余",
"cycRateUSDtoHSD": "string 美元兑港币汇率",
"marginStatus": "string 风险状态 //1:安全 2:预警 3:危险 4:平仓",
"statusPercent": "string 风险状态画图百分比",
"closeProfit": "string 已实现盈亏",
"cashBalCNH": "string 人民币现金结余"
}
}
}
# 期货-查询持仓列表
# 接口说明
获取用户的持仓信息
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryHoldsList
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"fundInfo": {
"assetBalance": "string 资产净值",
"enableBalance": "string 可用金额(购买力)",
"marginCall": "string 追缴保证金",
"incomeBalance": "string 持仓盈亏",
"cashBal": "string 现金结余",
"iMargin": "string 基本保证金",
"mMargin": "string 维持保证金",
"marginLevel": "string 保证金水平",
"maxMargin": "string 最高保证金",
"creditLimit": "string 信贷限额",
"ctrlLevel": "string 控制级数",
"marginClass": "string 保证金类型",
"aeId": "string 经纪",
"cashBalHKD": "string 港币现金结余",
"cashBalUSD": "string 美元现金结余",
"cycRateUSDtoHSD": "string 美元兑港币汇率",
"marginStatus": "string 风险状态 //1:安全 2:预警 3:危险 4:平仓",
"statusPercent": "string 风险状态画图百分比",
"closeProfit": "string 已实现盈亏",
"cashBalCNH": "string 人民币现金结余"
},
"holdsList": [{
"stockName": "string 股票名称",
"stockCode": "string 股票代码,1.港股有后缀 .HK",
"lastDayQty": "string 上日持仓数量",
"lastDayPrice": "string 上日持仓成本",
"depQty": "string 存储仓位",
"dayLongQty": "string 今日长仓数量",
"dayLongPrice": "string 今日长仓均价",
"dayShortQty": "string 今日短仓数量",
"dayShortPrice": "string 今日短仓均价",
"dayNetQty": "string 今日净仓数量",
"dayNetPrice": "string 今日净仓均价",
"currentQty": "string 持仓 上日持仓数量 + 今日净仓数量 = 净仓数量",
"costPrice": "string 成本价",
"lastPrice": "string 现价",
"preClosePrice": "string 昨收价",
"profitLoss": "string 盈亏",
"ccyRate": "string 参考兑换率",
"contractValue": "string 合约值",
"profitLossBaseCcy": "string 盈亏(基本货币)",
"ccy": "string 产品系列的交易币种",
"dataType": "string 仅仅期货是返回dataType,因为港期和美期",
"closeProfit": "string 已实现盈亏",
"closeProfitHKD": "string 已实现盈亏(HKD)"
}]
}
}
# 期货-查询最大可买可卖
# 接口说明
查询最大可买可卖数量
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryMaxBuySellAmount
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"stockCode": "01810.HK"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"positionStatus": "int32 持仓头寸状态:0未建仓,1正仓,2负仓",
"maxBuyAmount": "int64 最大可买",
"maxSellAmount": "int64 最大可卖",
"initialMargin": "string 开仓按金",
"ccy": "string 币种"
}
}
# 期货-查询合约产品信息
# 接口说明
查询最大可买可卖数量
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryProductInfo
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"stockCode": ["股票代码"]
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"productInfoVos": [{
"prodCode": "string 产品代码",
"instCode": "string 合约系列类型",
"lotSize": "int32 每手数量",
"decInPrice": "int32 产品价格小数位 0表示1,1表示0.1,2表示0.01跟priceDecimalPoint对应",
"contractSize": "string 合约值",
"priceDecimalPoint": "string 价格小数点,跟decInPrice对应]",
"expiryDate": "string 产品到期时间 yyyy-MM-dd",
"isSupportT1": "int32 是否支持T+1交易,0:否,1:是"
}]
}
}
# 订单
# 委托
# 接口说明
委托下单,如果委托数量超过单笔最大数量,则会进行拆单
# 接口地址
POST http://127.0.0.1:11111/trade/TradeEntrust
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 | |
entrustAmount | String | 是 | 委托数量 | |
entrustPrice | String | 否 | 委托价格 | <如果为条件单,该值可为空> |
entrustBs | String | 是 | 买卖方向 | '1'-买入、'2'-卖出(若为空头持仓情况,服务端接口按照持仓头寸自动处理买卖方向,也可使用 3'-空头平仓、'4'-空头开仓作为入参) |
entrustType | String | 是 | 委托类型 | 港股:'0'-竞价限价、'1'-竞价、'2'-增强限价盘、'3'-限价盘、'4'-特别限价盘、'6'-暗盘、'7'-碎股 美股:'3'-限价盘、'5'-市价盘、'8'-冰山市价、'9'-冰山限价、'10'-隐藏市价、'11'-隐藏限价 A股:'3'-限价盘 条件单:'31'-止盈限价单、'32'-止盈市价单(美股)、'33'-止损限价单、'34'-止损市价单(美股)、'35'-追踪止损限价单、'36'-追踪止损市价单(美股) |
clientType | Integer | 否 | 客户端类型 | '0' internet |
exchange | String | 否 | 交易所(IB通道) | 枚举值参考数据字典:exchange 交易所 |
sessionType | String | 否 | 盘前盘后交易 | 0:否 1:是 3:只支持盘中 5:港股支持盘中及暗盘 7:美股支持盘中及盘前盘后 <如果为普通订单,默认值为 0,可能值:0、1> <如果为条件单,默认值为 3,可能值:3、5、7> |
iceBergDisplaySize | String | 否 | 冰山单披露数量 | 如为冰山单,该值必填,且该值必须大于0,小于等于委托数量 |
validDays | String | 否 | 有效天数 | <如果为条件单,该值必传,最多支持100个自然日> |
condValue | String | 否 | 触发条件值 | <如果为条件单,该值必传,可能值:价格、价差、百分比数字> |
condTrackType | string | 否 | 跟踪类型 | 1百分比、2价差 <如果为条件跟踪单,该值必传> |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"entrustAmount": "100",
"entrustPrice": "35.900",
"entrustBs": "1",
"entrustType": "3",
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 委托编号"
}
}
# 撤单
# 接口说明
委托撤单
# 接口地址
POST http://127.0.0.1:11111/trade/TradeCancelEntrust
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 | |
entrustAmount | String | 否 | 委托数量 | 必须传原委托的委托数量 |
entrustPrice | String | 否 | 委托价格 | |
entrustId | String | 是 | 委托编号 | |
entrustType | String | 否 | 委托类型 | 条件单类型参考上述 委托接口 <如果为条件单,该值必传,必须传原委托的委托类型> |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"entrustAmount": "100",
"entrustPrice": "35.900",
"entrustId": "1234567",
"entrustType": "3",
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 委托编号"
}
}
# 批量撤单
# 接口说明
委托批量撤单(注:如果当日订单量超过一定阈值,该接口可能超时)
# 接口地址
POST http://127.0.0.1:11111/trade/TradeBatchCancelEntrust
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通(传'v'或者't',会将中华通所有订单都执行撤单) 会将该交易类型下的所有订单执行撤单 |
entrustId | List | 否 | 委托编号列表 | 不包含条件单 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"entrustId": ["1234567"],
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"successEntrustId": ["string 撤单成功的委托编号"],
"failCancelEntrust": [{
"failEntrustId": "string 撤单失败的委托编号",
"remark": "string 撤单失败备注"
}]
}
}
# 改单
# 接口说明
修改委托单,如果改单后的委托数量超过单笔最大数量,则会进行拆单。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeChangeEntrust
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 | |
entrustAmount | String | 是 | 修改后的委托数量 | |
entrustPrice | String | 否 | 修改后的委托价格 | <如果为条件单,该值可为空> |
entrustId | String | 是 | 原始委托编号 | |
entrustType | String | 否 | 委托类型 | 条件单类型参考上述 委托接口 <如果为条件单,该值必传,必须传原委托的委托类型> |
sessionType | String | 否 | 盘前盘后交易 | 3:只支持盘中 5:港股支持盘中及暗盘 7:美股支持盘中及盘前盘后 |
validDays | String | 否 | 有效天数 | 最多支持100个自然日 |
condValue | String | 否 | 触发条件值 | <如果为条件单,该值必传,可能值:价格、价差、百分比数字> |
condTrackType | String | 否 | 跟踪类型 | 1百分比、2价差 <如果为条件跟踪单,该值必传> |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"entrustAmount": "100",
"entrustPrice": "35.900",
"entrustId": "1234567",
"entrustType": "3",
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 委托编号"
}
}
# 查询最大可用资产
# 接口说明
获取最大可用资产
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryMaxAvailableAsset
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 | |
entrustPrice | String | 是 | 委托价格 | |
entrustType | String | 是 | 委托类型 | 港股:'0'-竞价限价、'1'-竞价、'2'-增强限价盘、'3'-限价盘、'4'-特别限价盘、'6'-暗盘、'7'-碎股 美股:'3'-限价盘、'5'-市价盘、'8'-冰山市价、'9'-冰山限价、'10'-隐藏市价、'11'-隐藏限价 A股:'3'-限价盘 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"entrustPrice": "35.900",
"entrustType": "3",
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": {
"positionStatus": "string 持仓头寸状态:0未建仓,1做多,2做空",
"position": "string 持仓头寸",
"longOpenAvailable": "string 做多数据:做多可开仓(买入)数量",
"longCloseAvailable": "string 做多数据:做多可平仓(卖出)数量",
"cashAvailableToOpen": "string 做多数据:现金可开仓数量",
"marginAvailableToOpen": "string 做多数据:融资可开仓数量",
"cashAndMarginAvailableToOpen": "string 做多数据:现金和融资可开仓数量",
"cashAvailableAmount": "string 做多数据:现金购买力",
"marginAvailableAmount": "string 做多数据:融资购买力",
"cashAndMarginAvailableAmount": "string 做多数据:现金和融资总共的购买力",
"shortOpenAvailable": "string 做空数据:做空可开仓(卖出)数量",
"shortCloseAvailable": "string 做空数据:做空可平仓(买入)数量",
"shortCloseCashAvailable": "string 做空数据:做空现金可平仓(买入)数量",
"shortOpenPool": "string 做空数据:卖空池",
"shortBuyPower": "string 做空数据:做空购买力",
"contractSize": "string 期权合约单位",
"unitedBuyPowerStatus": "string 开通统一购买力",
"creditLimit": "string 透支额度",
"optionLongMarginAmount": "string 期权保证金(做多)",
"optionShortMarginAmount": "string 期权保证金(做空)"
}
}
}
# 查询当日委托
# 接口说明
查询客户当日委托信息。分页时当收到的列表为空或数量小于queryCount,表示没有下一页。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryRealEntrustList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
queryCount | Integer | 否 | 每页数量(分页时必填) | 默认 20(限制小于100) |
queryParamStr | String | 否 | 游标(分页时必填) | 初始值为0 开始,分页时传上一页最后一条数据的queryParamStr |
entrustId | List | 否 | 委托编号列表,传此参数时分页参数无效 | 最大传100条 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"queryCount": 20,
"queryParamStr": "0",
"entrustId": ["1234567"],
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": {
"stockCode": "string 股票代码",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入、2:卖出",
"entrustPrice": "string 委托价格",
"businessBalance": "string 成交金额",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口,委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态",
"entrustId": "string 委托编号",
"unBusinessAmount": "string 未成交数量",
"canBeCanceled": "int32 可撤单 1:可撤单、0:不可撤单",
"entrustType": "string 委托类型",
"opponentSeat": "string 对手席位号,仅当日成交有该字段",
"entrustTypeNum": "string 委托类型对应的数字",
"remarkType": "string 备注类型 0:无、1:废单",
"remark": "string 备注信息",
"fareVo": "FareVo 费用",
"exchangeType": "string 交易类型",
"canBeUpdated": "int32 是否可改单 1:可改单,0:不可改单",
"exchange": "string 交易所"
}
}
}
# 查询历史委托
# 接口说明
查询客户历史委托信息。分页时当收到的列表为空或数量小于queryCount,表示没有下一页。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryHistoryEntrustList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
queryCount | Integer | 是 | 每页返回数量 | 默认 20(限制小于100) |
queryParamStr | String | 是 | 游标 | 初始值为0 开始,分页时传上一页最后一条数据的queryParamStr |
startDate | String | 是 | 起始日期 | 格式为:yyyyMMdd |
endDate | String | 是 | 结束日期 | 格式为:yyyyMMdd |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"queryCount": 20,
"queryParamStr": "0",
"startDate": "20230101",
"endDate": "20230102",
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入、2:卖出",
"entrustPrice": "string 委托价格",
"businessBalance": "string 成交金额",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口,委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态",
"entrustId": "string 委托编号",
"unBusinessAmount": "string 未成交数量",
"canBeCanceled": "int32 可撤单 1:可撤单、0:不可撤单",
"entrustType": "string 委托类型",
"opponentSeat": "string 对手席位号,仅当日成交有该字段",
"entrustTypeNum": "string 委托类型对应的数字",
"remarkType": "string 备注类型 0:无、1:废单",
"remark": "string 备注信息",
"fareVo": "FareVo 费用",
"exchangeType": "string 交易类型",
"canBeUpdated": "int32 是否可改单 1:可改单,0:不可改单",
"exchange": "string 交易所"
}]
}
}
# 查询当日成交
# 接口说明
查询客户当日成交信息。分页时当收到的列表为空或数量小于queryCount,表示没有下一页。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryRealDeliverList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
queryCount | Integer | 是 | 每页返回数量 | 默认 20(限制小于100) |
queryParamStr | String | 是 | 游标 | 初始值为0 开始,分页时传上一页最后一条数据的queryParamStr |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"queryCount": 20,
"queryParamStr": "0"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入、2:卖出",
"entrustPrice": "string 委托价格",
"businessBalance": "string 成交金额",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口,委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态",
"entrustId": "string 委托编号",
"unBusinessAmount": "string 未成交数量",
"canBeCanceled": "int32 可撤单 1:可撤单、0:不可撤单",
"entrustType": "string 委托类型",
"opponentSeat": "string 对手席位号,仅当日成交有该字段",
"entrustTypeNum": "string 委托类型对应的数字",
"remarkType": "string 备注类型 0:无、1:废单",
"remark": "string 备注信息",
"fareVo": "FareVo 费用",
"exchangeType": "string 交易类型",
"canBeUpdated": "int32 是否可改单 1:可改单,0:不可改单",
"exchange": "string 交易所"
}]
}
}
# 查询历史成交
# 接口说明
查询客户历史成交信息,港股历史成交会进行合单,和委托单不能直接对应起来。分页时当收到的列表为空或数量小于queryCount,表示没有下一页。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryHistoryDeliverList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
queryCount | Integer | 是 | 每页返回数量 | 默认 20(限制小于100) |
queryParamStr | String | 是 | 游标 | 初始值为0 开始,分页时传上一页最后一条数据的queryParamStr |
startDate | String | 是 | 起始日期 | 格式为:yyyyMMdd |
endDate | String | 是 | 结束日期 | 格式为:yyyyMMdd |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"queryCount": 20,
"queryParamStr": "0",
"startDate": "20230101",
"endDate": "20230102"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入、2:卖出",
"entrustPrice": "string 委托价格",
"businessBalance": "string 成交金额",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口,委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态",
"entrustId": "string 委托编号",
"unBusinessAmount": "string 未成交数量",
"canBeCanceled": "int32 可撤单 1:可撤单、0:不可撤单",
"entrustType": "string 委托类型",
"opponentSeat": "string 对手席位号,仅当日成交有该字段",
"entrustTypeNum": "string 委托类型对应的数字",
"remarkType": "string 备注类型 0:无、1:废单",
"remark": "string 备注信息",
"fareVo": {
"fare0": "string 港股:佣金、美股:佣金",
"fare1": "string 港股:印花税、美股:证监会费",
"fare2": "string 港股:交易费、美股:交易活动费",
"fare3": "string 港股:交易征费、美股:交易征费",
"fare4": "string 港股:待用、美股:待用",
"fare5": "string 港股:待用、美股:待用",
"fare6": "string 港股:平台使用费、美股:平台使用费",
"fare7": "string 港股:待用、美股:待用",
"farex": "string 港股:结算费、美股:交收费",
"faret": "string 港股:总成交费用、美股:总成交费用"
},
"exchangeType": "string 交易类型",
"canBeUpdated": "int32 是否可改单 1:可改单,0:不可改单",
"exchange": "string 交易所"
}]
}
}
# 查询当日条件单
# 接口说明
查询当日条件单列表。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryRealCondOrderList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 否 | 证券代码 | |
pageNo | Integer | 是 | 页码 | 1(从1开始) |
pageSize | Integer | 是 | 每页条数 | 20(限制小于100) |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"pageNo": 1,
"pageSize": 20,
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"condOrderId": "string 条件单号",
"dataType": "string 股票dataType",
"stockCode": "string 股票代码",
"stockName": "string 股票名称",
"stockNameTc": "string 股票名称-繁体",
"stockNameEn": "string 股票名称-英文",
"exchangeType": "string 市场代码",
"entrustType": "string 31止盈限价单 32止盈市价单(美股) 33止损限价单 34止损市价单(美股) 35追踪止损限价单 36追踪止损市价单(美股)",
"sessionType": "string 3只支持盘中 6美股只支持盘前盘后 7美股支持盘中及盘前盘后",
"status": "string 条件单状态 1:待触发 2:已触发 3:暂停 4:已过期 5:已删除 6:错误 8:止盈止损单失效 9:除权除息失效",
"canBeCancel": "string 是否可以撤单 0否 1是",
"canBeModify": "string 是否可以改单 0否 1是",
"entrustBs": "string 买卖方向 '1'-多头开仓、'2'-多头平仓、'3'-空头平仓、'4'-空头开仓",
"entrustAmount": "string 委托数量",
"createTime": "string 下单时间",
"startTime": "string 启动时间",
"endTime": "string 到期时间",
"errorCode": "string 错误码",
"errorMsg": "string 异常信息",
"condValue": "string 条件值 价格/价差/百分比值",
"condPrice": "string 条件指定价",
"condTrackType": "string 条件跟踪类型 1百分比、2价差、3价格"
}],
"curPageNo": "int32",
"curPageSize": "int32",
"totalPages": "int64"
}
}
# 查询历史条件单
# 接口说明
查询历史条件单列表。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryHistoryCondOrderList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 否 | 证券代码 | |
pageNo | String | 是 | 页码 | 1(从1开始) |
pageSize | String | 是 | 每页条数 | 20(限制小于100) |
startTime | String | 是 | 开始时间 | 格式为: 2021-01-01 19:21:21 |
endTime | String | 是 | 结束时间 | 格式为: 2021-01-02 19:21:21 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK",
"pageNo": "1",
"pageSize": "20",
"startTime": "2021-01-01 19:21:21",
"endTime": "2021-01-02 19:21:21"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"condOrderId": "string 条件单号",
"dataType": "string 股票dataType",
"stockCode": "string 股票代码",
"stockName": "string 股票名称",
"stockNameTc": "string 股票名称-繁体",
"stockNameEn": "string 股票名称-英文",
"exchangeType": "string 市场代码",
"entrustType": "string 31止盈限价单 32止盈市价单(美股) 33止损限价单 34止损市价单(美股) 35追踪止损限价单 36追踪止损市价单(美股)",
"sessionType": "string 3只支持盘中 6美股只支持盘前盘后 7美股支持盘中及盘前盘后",
"status": "string 条件单状态 1:待触发 2:已触发 3:暂停 4:已过期 5:已删除 6:错误 8:止盈止损单失效 9:除权除息失效",
"canBeCancel": "string 是否可以撤单 0否 1是",
"canBeModify": "string 是否可以改单 0否 1是",
"entrustBs": "string 买卖方向 '1'-多头开仓、'2'-多头平仓、'3'-空头平仓、'4'-空头开仓",
"entrustAmount": "string 委托数量",
"createTime": "string 下单时间",
"startTime": "string 启动时间",
"endTime": "string 到期时间",
"errorCode": "string 错误码",
"errorMsg": "string 异常信息",
"condValue": "string 条件值 价格/价差/百分比值",
"condPrice": "string 条件指定价",
"condTrackType": "string 条件跟踪类型 1百分比、2价差、3价格"
}],
"curPageNo": "int32",
"curPageSize": "int32",
"totalPages": "int64"
}
}
# 查询是否支持盘前盘后交易
# 接口说明
查询某支股票是否支持盘前盘后交易。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryBeforeAndAfterSupport
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
stockCode | String | 是 | 证券代码 | |
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 1: 是, 0:否"
}
}
# 查询股票沽空信息
# 接口说明
查询股票的沽空信息。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryStockShortInfo
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
stockCode | String | 是 | 证券代码 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"exchangeType": "K",
"stockCode": "01810.HK"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"supportShort": "string 是否支持沽空(1-支持、0-不支持)",
"interestRate": "string 沽空利率",
}
}
# 查询股票融资融券数据
# 接口说明
查询股票融资融券数据。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeQueryMarginFullInfo
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
dataType | String | 是 | 股票类型(值参看下文数据字典股票类型定义) | |
stockCode | String | 是 | 股票代码 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"dataType": "10000",
"stockCode": "01810.HK"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"marginAllow": "string 是否支持融资 0:不支持,1:支持",
"marginInitRatio": "string 融资保证金率",
"marginKeepRatio": "string 维持保证金率",
"shortAllow": "string 是否支持融券 0:不支持,1:支持",
"shortInitMarginRatio": "string 融券保证金率",
"shortInterestRate": "string 融券参考利率",
"shortKeepMarginRatio": "string 维持保证金率",
"shortLastAvailableQty": "string 沽空池剩余",
"rate": [{
"currencyCode": "string 币种代码",
"currencyDesc": "string 币种描述",
"interestRateWithinMortgage": "string 融资参考利率"
}]
}
}
# 期货-委托
# 接口说明
委托下单
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesEntrust
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"stockCode": "string 期货合约代码",
"entrustType": "string 0 限价单、1 竞价单、2 市价单",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"entrustBs": "string 1:买入,2:卖出",
"validTimeType": "string 0 即日有效、1 成交并取消、2 全额或取消、3 到期日有效、4 指定日期有效",
"validTime": "string 当validTimeType==4 必填yyyyMMdd",
"orderOptions": "string 0:默认 1:T+1"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 委托编号(不一定会返回)"
}
}
# 期货-撤单
# 接口说明
委托撤单, 用户委托没有完全成交之前撤销剩余的委托
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesCancelEntrust
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"entrustId": "string 委托编号",
"stockCode": "string 期货合约代码"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 委托编号"
}
}
# 期货-改单
# 接口说明
修改委托单
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesModifyEntrust
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"entrustId": "string 委托Id",
"stockCode": "string 股票代码",
"entrustPrice": "string 价格",
"entrustAmount": "string 数量",
"entrustBs": "string 1:买入,2:卖出",
"validTimeType": "string 0 即日有效、1 成交并取消、2 全额或取消、3 到期日有效、4 指定日期有效",
"validTime": "string 当validTimeType==4 必填yyyyMMdd",
"orderOptions": "string 0:默认 1:T+1"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 委托编号"
}
}
# 期货-查询当日委托
# 接口说明
查询客户当日最新的委托列表,最大返回500条
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryRealEntrustList
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码,1.港股有后缀 .HK",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入,2:卖出",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口, 委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态(华盛com.huasheng.stock.common.trade.type.EntrustStatus)",
"entrustId": "string 委托编号",
"canBeCanceled": "int32 可撤单 1 可撤单, 0 不可撤单",
"entrustType": "string 委托类型",
"entrustTypeNum": "string 委托类型对应的数字",
"isValid": "int32 0 无效 1 有效",
"canBeUpdated": "int32 是否可改单 1 可改单,0 不可改单",
"validType": "string 有效期类型 0当天有效,1成交并取消,2成交或取消,3直到有效期,4直到自定时间",
"validTypeDesc": "string validType的相关描述,4直到自定时间 直接返回时间yyyy/MM/dd",
"orderOptions": "int32 0=默认,1=T+1",
"validTime": "string 有效期时间,yyyy/MM/dd"
}]
}
}
# 期货-查询历史委托
# 接口说明
分页查询客户历史委托列表
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryHistoryEntrustList
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"pageNo": "int32 默认1",
"pageSize": "int32 默认20",
"startDate": "string yyyyMMdd",
"endDate": "string yyyyMMdd"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码,1.港股有后缀 .HK",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入,2:卖出",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口, 委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态(华盛com.huasheng.stock.common.trade.type.EntrustStatus)",
"entrustId": "string 委托编号",
"canBeCanceled": "int32 可撤单 1 可撤单, 0 不可撤单",
"entrustType": "string 委托类型",
"entrustTypeNum": "string 委托类型对应的数字",
"isValid": "int32 0 无效 1 有效",
"canBeUpdated": "int32 是否可改单 1 可改单,0 不可改单",
"validType": "string 有效期类型 0当天有效,1成交并取消,2成交或取消,3直到有效期,4直到自定时间",
"validTypeDesc": "string validType的相关描述,4直到自定时间 直接返回时间yyyy/MM/dd",
"orderOptions": "int32 0=默认,1=T+1",
"validTime": "string 有效期时间,yyyy/MM/dd"
}],
"curPageNo": "int32 当前页",
"curPageSize": "int32 当前页大小",
"totalPageNo": "int32 最大页【作废】",
"lastPage": "int32 是否最后一页,0:否,1:是"
}
}
# 期货-查询当日成交
# 接口说明
查询客户当日成交列表,最大返回200条
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryRealDeliverList
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码,1.港股有后缀 .HK",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入,2:卖出",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口, 委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态(华盛com.huasheng.stock.common.trade.type.EntrustStatus)",
"entrustId": "string 委托编号",
"canBeCanceled": "int32 可撤单 1 可撤单, 0 不可撤单",
"entrustType": "string 委托类型",
"entrustTypeNum": "string 委托类型对应的数字",
"isValid": "int32 0 无效 1 有效",
"canBeUpdated": "int32 是否可改单 1 可改单,0 不可改单",
"validType": "string 有效期类型 0当天有效,1成交并取消,2成交或取消,3直到有效期,4直到自定时间",
"validTypeDesc": "string validType的相关描述,4直到自定时间 直接返回时间yyyy/MM/dd",
"orderOptions": "int32 0=默认,1=T+1",
"validTime": "string 有效期时间,yyyy/MM/dd"
}]
}
}
# 期货-查询历史成交
# 接口说明
分页查询客户历史成交列表
# 接口地址
POST http://127.0.0.1:11111/trade/FuturesQueryHistoryDeliverList
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"pageNo": "int32 默认1",
"pageSize": "int32 默认20",
"startDate": "string yyyyMMdd",
"endDate": "string yyyyMMdd"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": [{
"stockCode": "string 股票代码,1.港股有后缀 .HK",
"stockName": "string 股票名称",
"businessPrice": "string 成交价格",
"entrustBs": "string 委托方向 1:买入,2:卖出",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"businessAmount": "string 成交数量",
"date": "string 如果是成交接口,成交日期,如果是委托接口, 委托日期",
"businessTime": "string 成交时间",
"entrustTime": "string 委托时间",
"queryParamStr": "string 当前记录的索引,用于分页",
"statusDesc": "string 委托状态中文描述",
"status": "string 委托状态(华盛com.huasheng.stock.common.trade.type.EntrustStatus)",
"entrustId": "string 委托编号",
"canBeCanceled": "int32 可撤单 1 可撤单, 0 不可撤单",
"entrustType": "string 委托类型",
"entrustTypeNum": "string 委托类型对应的数字",
"isValid": "int32 0 无效 1 有效",
"canBeUpdated": "int32 是否可改单 1 可改单,0 不可改单",
"validType": "string 有效期类型 0当天有效,1成交并取消,2成交或取消,3直到有效期,4直到自定时间",
"validTypeDesc": "string validType的相关描述,4直到自定时间 直接返回时间yyyy/MM/dd",
"orderOptions": "int32 0=默认,1=T+1",
"validTime": "string 有效期时间,yyyy/MM/dd"
}],
"curPageNo": "int32 当前页",
"curPageSize": "int32 当前页大小",
"totalPageNo": "int32 最大页【作废】",
"lastPage": "int32 是否最后一页,0:否,1:是"
}
}
# 策略单-下单
# 接口说明
策略单委托下单
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoAddOrder
# 参数说明
参数 | 参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|---|
stockCode | String | 是 | 证券代码 | ||
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 | |
entrustType | String | 是 | 委托类型 | '1'-限价单、'2'-市价单 | |
entrustPrice | String | 是 | 委托价格 | ||
entrustAmount | String | 是 | 委托数量 | ||
entrustBs | String | 是 | 买入卖出 | '1'-买入、'2'-卖出 | |
targetStrategy | String | 是 | 策略类型 | '1'-VWAP、'1001'-TWAP、'1002'-ICE_BERG、 '1003'-TPOV、'1005'-INLINE | |
sessionType | String | 是 | 盘前盘后交易 | '0'-否、'1'-是 | |
strategyParam | Object | 是 | 策略参数(不同的策略参数有些差别) | ||
origStartTime | String | 否 | 开始时间 | 格式为HKT的HHmmSS,默认000000为交易所开盘时间 (开盘后为当前系统时间) | |
origEndTime | String | 否 | 结束时间 | 格式为HKT的HHmmSS,默认000000为交易所的休市时间 | |
maxVolume | String | 是 | 每笔子单最大的委托数量 | ||
minAmount | String | 否 | 每笔子单的最小交易金额 | ||
sensitivity | String | 是 | 订单的执行效率 | '1'-中性(neutral),'2'-主动(aggressive),'3'-被动(passive) | |
showQty | String | 否 | <IceBerg策略使用>:每次的报单数量 | ||
qtyPercent | String | 否 | <TPOV策略使用>:订单盘口占比, <Inline策略使用>:累计成交占比 | 可设置1-99 | |
interval | int | 否 | <Inline策略使用>:订单报单间隔(默认60) |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"stockCode": "string 股票代码",
"exchangeType": "string 市场 [K:港股 P:美股 v:深股通 t:沪股通]",
"entrustType": "string 委托类型 [1:限价单 2:市价单]",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"entrustBs": "string [1:买入 2:卖出]",
"targetStrategy": "string 策略类型 [1:VWAP 1001:TWAP 1002:ICE_BERG 1003:TPOV 1005:INLINE]",
"sessionType": "string 盘前盘后交易 [0:否 1:是]",
"strategyParam": {
"origStartTime": "string 开始时间, 可以不填, 格式为HKT的HHmmSS",
"origEndTime": "string 结束时间,可以不填,格式为HKT的HHmmSS",
"maxVolume": "string 每笔子单最大的委托数量",
"minAmount": "string 每笔子单的最小交易金额, 可不填",
"sensitivity": "string 订单的执行效率[1:中性(neutral) 2:主动(aggressive) 3:被动(passive)]",
"showQty": "string IceBerg订单使用, 每次的报单数量",
"qtyPercent": "string TPOV策略使用订单盘口占比, Inline使用累计成交占比(可设置1-99)",
"interval": "int32 订单报单间隔,Inline策略使用(默认60)"
}
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 订单ID"
}
}
# 策略单-撤销母单
# 接口说明
策略单撤销母单
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoCancelOrder
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
orderId | String | 是 | 订单(母单)ID | |
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"orderId": "string 订单ID",
"exchangeType": "string 市场 [K:港股 P:美股 v:深股通 t:沪股通]"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 订单ID"
}
}
# 策略单-撤销子单
# 接口说明
策略单撤销子单
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoCancelEntrust
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
orderId | String | 是 | 订单(母单)ID | |
entrustId | String | 是 | 委托(子单)ID | |
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"orderId": "string 订单ID",
"entrustId": "string 子单ID",
"exchangeType": "string 市场 [K:港股 P:美股 v:深股通 t:沪股通]"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 子单ID"
}
}
# 策略单-改单
# 接口说明
策略单改单
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoChangeOrder
# 参数说明
参数 | 参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|---|
orderId | String | 是 | 订单ID | ||
stockCode | String | 是 | 股票代码 | 只能传订单股票代码 | |
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 | |
entrustPrice | String | 是 | 委托价格 | ||
entrustAmount | String | 是 | 委托数量 | ||
strategyParam | Object | 是 | 策略参数(不同的策略参数有些差别) | ||
origStartTime | String | 否 | 开始时间 | 格式为HKT的HHmmSS,默认000000为交易所开盘时间 (开盘后为当前系统时间) | |
origEndTime | String | 否 | 结束时间 | 格式为HKT的HHmmSS,默认000000为交易所的休市时间 | |
maxVolume | String | 否 | 每笔子单最大的委托数量 | ||
minAmount | String | 否 | 每笔子单的最小交易金额 | ||
sensitivity | String | 否 | 订单的执行效率 | '1'-中性(neutral),'2'-主动(aggressive),'3'-被动(passive) | |
showQty | String | 否 | <IceBerg策略使用>:每次的报单数量 | ||
qtyPercent | String | 否 | <TPOV策略使用>:订单盘口占比, <Inline策略使用>:累计成交占比 | 可设置1-99 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"orderId": "string 订单ID",
"stockCode": "string 股票代码",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"strategyParam": {
"origStartTime": "string 开始时间, 可以不填, 格式为HKT的HHmmSS",
"origEndTime": "string 结束时间,可以不填,格式为HKT的HHmmSS",
"maxVolume": "string 每笔子单最大的委托数量",
"minAmount": "string 每笔子单的最小交易金额, 可不填",
"sensitivity": "string 订单的执行效率[1:中性(neutral) 2:主动(aggressive) 3:被动(passive)]",
"showQty": "string IceBerg订单使用, 每次的报单数量",
"qtyPercent": "string TPOV策略使用订单盘口占比, Inline使用累计成交占比(可设置1-99)"
}
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 订单ID"
}
}
# 策略单-操作
# 接口说明
策略单相关操作
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoActionOrder
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
orderId | String | 是 | 订单(母单)ID | |
action | String | 是 | 操作 | '1'-START、'2'-STOP、'3'-SUSPEND、'4'-RESUME |
targetStrategy | String | 是 | 策略类型 | '1'-VWAP、'1001'-TWAP、'1002'-ICE_BERG、 '1003'-TPOV、'1005'-INLINE |
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"orderId": "string 订单ID",
"action": "string 操作 [1:START 2:STOP 3:SUSPEND 4:RESUME]",
"targetStrategy": "string 策略类型 [1:VWAP 1001:TWAP 1002:ICE_BERG 1003:TPOV 1005:INLINE]"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"data": "string 订单ID"
}
}
# 策略单-查询母单列表
# 接口说明
查询策略单母单列表
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoQueryOrderList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
pageNo | String | 是 | 当前页号 | 默认1 |
pageSize | String | 是 | 每页条数 | 默认30 |
startDate | String | 是 | 开始日期 | yyyyMMdd |
endDate | String | 是 | 结束日期 | yyyyMMdd |
exchangeType | String | 否 | 市场 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通(如果传了股票代码,该值必传) |
stockCode | String | 否 | 股票代码 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"pageNo": "int32 当前页号 默认1",
"pageSize": "int32 每页条数 默认30",
"startDate": "string 开始日期 必须",
"endDate": "string 结束日期 必须",
"exchangeType": "string 市场 可选 [K:港股 P:美股 v:深股通 t:沪股通]",
"stockCode": "string 股票代码 可选"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"algoOrderList": [{
"orderId": "string 订单ID",
"stockCode": "string 股票代码,1.港股有后缀 .HK",
"exchangeType": "string 市场 [K:港股 P:美股 v:深股通 t:沪股通]",
"tradeDate": "string 委托日期",
"entrustType": "string 委托类型",
"entrustPrice": "string 委托价格",
"entrustAmount": "string 委托数量",
"cumQty": "string 股数",
"leavesQty": "string 剩余订单数量",
"status": "string 委托状态 [0:已报 1:部分成交 2:全部成交 3:当日完成 4:已撤 5:已改:6 待撤 8:废单 A:待报 C:过期 E:待改]",
"entrustBs": "string [1:买入 2:卖出]",
"targetStrategy": "string 策略类型 [1:VWAP 1001:TWAP 1002:ICE_BERG 1003:TPOV 1005:INLINE]",
"strategyStatus": "string 策略状态 [1:START 2:STOP 3:SUSPEND 4:RESUME]",
"strategyParam": {
"origStartTime": "string 开始时间, 格式为HKT的HHmmSS",
"origEndTime": "string 结束时间,格式为HKT的HHmmSS",
"maxVolume": "string 每笔子单最大的订单数",
"minAmount": "string 每笔子单的最小交易金额",
"sensitivity": "string 订单的执行效率[1:中性(neutral) 2:主动(aggressive) 3:被动(passive)]",
"showQty": "string IceBerg订单使用, 每次的报单数量",
"qtyPercent": "string TPOV策略使用订单盘口占比, Inline使用累计成交占比(可设置1-99)",
"interval": "int32 订单报单间隔, Inline策略使用(默认60)"
},
"roundLot": "string 证券交易手数",
"sendingTime": "string 传输时间",
"transactionTime": "string 委托时间",
"avgPx": "string 平均成本"
}]
}
}
# 策略单-查询子单
# 接口说明
查询策略单子单
# 接口地址
POST http://127.0.0.1:11111/trade/AlgoQueryEntrustIdList
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
orderId | String | 是 | 订单(母单)ID | |
tradeDate | String | 是 | 交易日期 | yyyyMMdd |
exchangeType | String | 是 | 交易类型 | 'K'-港股、'P'-美股、'v'-深股通、't'-沪股通 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"orderId": "string 订单(母单)ID",
"tradeDate": "string 交易日期",
"exchangeType": "string 市场 [K:港股 P:美股 v:深股通 t:沪股通]"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"entrustId": ["string 委托ID"]
}
}
# 订阅交易推送
# 接口说明
订阅交易推送消息接口,初始化交易链接会默认订阅订单成交推送。
# 接口地址
POST http://127.0.0.1:11111/trade/TradeSubscribe
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"success": ["bool 是否执行成功"]
}
}
# 取消订阅交易推送
# 接口说明
取消订阅交易推送接口
# 接口地址
POST http://127.0.0.1:11111/trade/TradeUnsubscribe
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"success": ["bool 是否执行成功"]
}
}
# 交易推送消息
# 消息说明
消息类型:NotifyMsgType.TradeStockDeliverMsgType
推送结果实体:
message TradeStockDeliverNotify {
string fundAccount = 1; //资金账号
string stockCode = 2; //股票代码
string stockName = 3; //股票名称
string entrustBs = 4; //委托方向
string businessPrice = 5; //成交价格
string businessAmount = 6; //成交数量
string businessDate = 7; //成交日期
string businessTime = 8; //成交时间
string exchangeType = 9; //交易类型
string entrustStatus = 10; //委托状态
string clientId = 11; //客户号
string entrustNo=12; //委托编号,撤单/改单委托会变
string sumBusinessAmount = 13; //总数量
string sumBusinessBalance=14; //总金额
string originalAmount=15; //原始委托数量
string originalPrice = 16; //原始委托价格
string leftAmount=17; //剩余挂单数量
string entrustPrice=18; //改后委托价格
string entrustAmount=19; //改后委托数量
string recordNo=20; //委托库记录号,与下单委托号一致
string remark=21; //备注
}
# 场景说明
订单的委托状态有变化即会推送消息,场景包括:下单、改单、撤单、成交
# 期货-交易推送消息
# 消息说明
消息类型:NotifyMsgType.FuturesTradeStockDeliverMsgType
推送结果实体:
message TradeStockDeliverNotify {
string fundAccount = 1; //资金账号
string stockCode = 2; //股票代码
string stockName = 3; //股票名称
string entrustBs = 4; //委托方向
string businessPrice = 5; //成交价格
string businessAmount = 6; //成交数量
string businessDate = 7; //成交日期
string businessTime = 8; //成交时间
string entrustStatus = 10; //委托状态
string clientId = 11; //客户号
string entrustNo=12; //委托编号
string sumBusinessAmount = 13; //总数量
string sumBusinessBalance=14; //总金额
string recordNo=20; //订单号,与entrustNo相同
string matchNo=22; //成交流水号,有成交的情况才会有
}
# 场景说明
订单的委托状态有变化即会推送消息,场景包括:成交
# 响应状态码
# 系统状态码
状态码 | 说明 |
---|---|
0000 | 处理成功 |
1001 | 系统未知错误 |
1002 | 签名错误 |
1003 | 数据加密错误 |
1004 | Socket未初始化 |
1005 | 接口已经废弃 |
1006 | 用户暂未授权 |
1007 | 重复提交 |
1008 | 接口调用失败 |
1009 | 接口不存在 |
1010 | 非法请求 |
1011 | 服务繁忙,请稍后重试 |
1012 | 用户未登录 |
1013 | 登录被挤下线 |
1014 | 登录超时 |
1015 | 接口调用超时 |
1016 | 接口调用参数不合法 |
1017 | 建立长连接失败 |
1018 | 正在尝试重连,请稍后重试! |
20033 | 期货交易接口登录超时 |
40001 | 查询品种信息失败 |
40002 | 查询合约信息失败 |
# 数据字典
# RequestMsgType 请求业务类型
请求业务类型 | 请求值 | 说明 |
---|---|---|
InitConnectRequestMsgType | 0 | 初始化链接接口 |
TradeLoginRequestMsgType | 14 | 交易登录接口 |
TradeLogoutRequestMsgType | 15 | 交易登出接口 |
TradeEntrustRequestMsgType | 16 | 委托接口 |
TradeCancelEntrustRequestMsgType | 17 | 撤单接口 |
TradeQueryHoldsListRequestMsgType | 18 | 查询持仓列表接口 |
TradeQueryBuyAmountRequestMsgType | 19 | 查询最大可买接口 |
TradeQuerySellAmountRequestMsgType | 20 | 查询最大可卖接口 |
TradeQueryMarginFundInfoRequestMsgType | 21 | 查询客户资金信息接口 |
TradeQueryRealEntrustListRequestMsgType | 22 | 查询当日委托接口 |
TradeQueryHistoryEntrustListRequestMsgType | 23 | 查询历史委托接口 |
TradeQueryRealDeliverListRequestMsgType | 24 | 查询当日成交接口 |
TradeQueryHistoryDeliverListRequestMsgType | 25 | 查询历史成交接口 |
TradeQueryRealFundJourListRequestMsgType | 26 | 查询当日资金流水接口 |
TradeQueryHistoryFundJourListRequestMsgType | 27 | 查询历史资金流水接口 |
TradeSubscribeRequestMsgType | 28 | 订阅交易推送 |
TradeUnsubscribeRequestMsgType | 29 | 取消订阅交易推送 |
TradeChangeEntrustRequestMsgType | 30 | 改单接口 |
# ResponseMsgType 响应业务类型
响应业务类型 | 响应值 | 说明 |
---|---|---|
InitConnectResponseMsgType | 0 | 初始化链接接口 |
TradeLoginResponseMsgType | 14 | 交易登录接口 |
TradeLogoutResponseMsgType | 15 | 交易登出接口 |
TradeEntrustResponseMsgType | 16 | 委托接口 |
TradeCancelEntrustResponseMsgType | 17 | 撤单接口 |
TradeQueryHoldsListResponseMsgType | 18 | 查询持仓列表接口 |
TradeQueryBuyAmountResponseMsgType | 19 | 查询最大可买接口 |
TradeQuerySellAmountResponseMsgType | 20 | 查询最大可卖接口 |
TradeQueryMarginFundInfoResponseMsgType | 21 | 查询客户资金信息接口 |
TradeQueryRealEntrustListResponseMsgType | 22 | 查询当日委托接口 |
TradeQueryHistoryEntrustListResponseMsgType | 23 | 查询历史委托接口 |
TradeQueryRealDeliverListResponseMsgType | 24 | 查询当日成交接口 |
TradeQueryHistoryDeliverListResponseMsgType | 25 | 查询历史成交接口 |
TradeQueryRealFundJourListResponseMsgType | 26 | 查询当日资金流水接口 |
TradeQueryHistoryFundJourListResponseMsgType | 27 | 查询历史资金流水接口 |
TradeSubscribeResponseMsgType | 28 | 订阅交易推送 |
TradeUnsubscribeResponseMsgType | 29 | 取消订阅交易推送 |
TradeChangeEntrustResponseMsgType | 30 | 改单接口 |
ErrorResponseMsgType | 999 | 系统错误 |
# NotifyMsgType 推送消息类型
推送消息类型 | 响应值 | 说明 |
---|---|---|
TradeStockDeliverMsgType | 1 | 成交消息推送 |
# entrustProp 委托属性
委托属性 | 业务类型 | 委托类别(0下单,2撤单,B订单修改,C成交拒绝,E成交修改) |
---|---|---|
d | 竞价单 | 0 |
g | 竞价限价单 | 0 |
e | 增强限价单 | 0 |
j | 特殊限价单 | 0 |
h | 限价单 | 0 |
m | 碎股挂单 | 0 |
o | 手动交易 | 0 |
p | 批量撤单 | 2 |
# entrustStatus 委托状态
委托状态 | 说明 |
---|---|
0 | No Register(未报) |
1 | Wait to Register(待报) |
2 | Host Registered(已报) |
3 | Wait for Cancel(已报待撤) |
4 | Wait for Cancel(Partially Matched)(部成待撤) |
5 | Partially Cancelled(部撤) |
6 | Cancelled(已撤) |
7 | Partially Filled(部成) |
8 | Filled(已成) |
9 | Host Reject(废单) |
A | Wait for Modify (Registed)(已报待改) |
B | Unregistered(无用) |
C | Registering(无用) |
D | Revoke Cancel(无用) |
W | Wait for Confirming(待确认) |
X | Pre Filled(无用) |
E | Wait for Modify (Partially Matched)(部成待改) |
F | Reject(预埋单检查废单) |
G | Cancelled(Pre-Order)(预埋单已撤) |
H | Wait for Review(待审核) |
J | Review Fail(审核失败) |
# exchangeType 交易类别
交易类别 | 说明 |
---|---|
K | 港股,大写 |
P | 美股,大写 |
v | 深股通,小写 |
t | 沪股通,小写 |
# entrustBs 委托买卖方向
委托买卖方向 | 说明 |
---|---|
1 | 多头开仓(买入) |
2 | 多头平仓(卖出) |
3 | 空头平仓 |
4 | 空头开仓 |
# entrustType 委托类别
委托类别 | 说明 |
---|---|
0 | 买卖 |
1 | 查询 |
2 | 撤单 |
3 | 补单 |
B | 改单 |
# exchange 交易所
交易所(IB通道) |
---|
SMART |
AMEX |
ARCA |
BATS |
BEX |
BYX |
CBOE |
CHX |
DRCTEDGE |
EDGEA |
EDGX |
IBKRTS |
IEX |
ISE |
ISLAND |
LTSE |
MEMX |
NYSE |
NYSENAT |
PEARL |
PHLX |
PSX |
# realStatus 成交状态
成交状态 | 说明 |
---|---|
0 | 成交 |
2 | 废单 |
4 | 确认 |
# realType 成交类别
成交类别 | 说明 |
---|---|
0 | 买卖 |
1 | 查询 |
2 | 撤单 |
# stockType 证券类型
证券类别 | 说明 |
---|---|
0 | 股票(stock) |
1 | 基金(Fund) |
2 | 红利(Dividend) |
D | 交易权证(WRNT) |
F | 一篮子权证(BWRT) |
U | 债券(BOND) |
# dataType 股票类型
股票类型 | 说明 |
---|---|
10000 | 港股股票 |
10001 | 港股指数 |
10002 | 港股ETF |
10003 | 港股窝轮 |
10004 | 港股牛熊证 |
10005 | 港股债券 |
10006 | 港股行业板块 |
10007 | 港股概念板块 |
10009 | 衍生品期货 |
10010 | 香港指数期货 |
10011 | 港股股票期货 |
10012 | 港股恒指股息期货 |
10013 | 港股人民币货币期货 |
10014 | 港股中华交易服务期货 |
10015 | 恒指波幅指数期货 |
10016 | 界内证 |
20000 | 美股股票 |
20001 | 美股指数 |
20002 | 美股ETF |
20003 | 美股期权 |
20006 | 美股行业板块 |
20007 | 美股概念板块 |
30000 | A股股票 |
30001 | A股指数 |
30002 | A股ETF |
30006 | A股行业 |
30007 | A股概念 |
30008 | A股科创板 |
# moneyType 币种
币种 | 说明 |
---|---|
0 | 人民币 |
1 | 美圆 |
2 | 港币 |
4 | 阿联酋迪拉姆 |
5 | 奥地利先令 |
6 | 澳大利亚元 |
7 | 孟加拉塔卡 |
8 | 比利时可兑换法郎 |
9 | 比利时金融法郎 |
A | 巴林第纳尔 |
B | 文莱元 |
C | 巴希克鲁赛多 |
D | 缅甸元 |
E | 加拿大元 |
F | 瑞士法郎 |
H | 塞普路斯镑 |
I | 德国马克 |
J | 丹麦克郎 |
K | 厄瓜多尔苏克列 ECS |
L | 西班牙比塞塔 / 陪士特 |
M | 欧元 |
N | 芬兰马克 |
O | 斐济元 |
P | 法国法郎 |
Q | 英镑 |
S | 印度尼西亚盾/ 卢比 |
T | 爱尔兰镑 |
U | 印度卢比 |
V | 意大利里拉 |
W | 日元 |
X | 肯尼亚先令 |
Y | 韩国元 |
Z | 科威特第纳尔 |
a | 黎巴嫩镑 |
c | 斯里兰卡卢比 |
d | 澳门元 |
e | 毛里求斯卢比 |
f | 马来西亚令吉 |
g | 尼日利亚奈拉 |
h | 荷兰盾 |
i | 挪威克郎 |
j | 新西兰元(纽元) |
k | 阿曼里亚尔 |
l | 菲律宾比索 |
m | 巴基斯坦卢比 |
n | 葡萄牙埃斯库多 |
o | 卡塔尔 |
p | 沙特里亚尔 |
q | 塞舌尔卢比 |
r | 特别提款权(国际货币基金) |
s | 瑞典克郎 |
t | 新加坡元 |
u | 塞拉利昂利昂 |
v | 泰铢 |
w | 新台币元 |
x | 南非兰特 |
# countryCode 区号代码
区号 | 说明 |
---|---|
CHN | 中国大陆 |
HKG | 中国香港 |
MAC | 中国澳门 |
TWN | 中国台湾 |
SGP | 新加坡 |
KOR | 韩国 |
JPN | 日本 |
USA | 美国 |
GBR | 英国 |
FRA | 法国 |
RUS | 俄罗斯 |
BEL | 比利时 |
DEU | 德国 |
CAN | 加拿大 |
ESP | 西班牙 |
NZL | 新西兰 |
# FundJourVo.type 资金流水类别
类型 | 说明 |
---|---|
0 | 初始值 |
1 | 下买单请求 |
2 | 下卖单请求 |
3 | 下买单请求失败 |
4 | 下卖单请求失败 |
5 | 买入证券 |
6 | 卖出证券 |
7 | 改买单请求 |
9 | 改买单失败 |
10 | 改买单成功 |
11 | 改买单被拒 |
13 | 买单取消 |
15 | 买单拒绝 |
17 | 买单过期 |
18 | 买单成交撤回 |
19 | 收市关闭买单 |
20 | 卖单成交撤回 |
21 | 存入资金 |
22 | 转出资金 |
23 | 资金冻结 |
24 | 资金解冻 |
25 | 司法冻结 |
26 | 司法解冻 |
27 | 虚增金额 |
28 | 虚减金额 |
29 | 换汇-兑入资金 |
30 | 换汇-兑出资金 |
31 | 存入资金 |
32 | 处理客户存款 |
33 | 重置today金额 |
34 | 第三方结算落地 |
42 | 支票入金冻结 |
43 | 支票入金解冻 |
44 | 转出资金冻结 |
45 | 转出资金解冻 |
46 | 内部转入后冻结 |
47 | 内部转入后解冻 |
48 | 转出资金 |
82 | 交收资金 |
83 | 期权自动行权 |
84 | 期权指派 |
85 | 期权过期 |
88 | 资产账号升级 |
89 | 资产账号降级 |
95 | 资金存 |
98 | 买入证券 |
99 | 卖出证券 |
121 | 罚息调整 |
122 | 调整利息罚息 |
141 | 返还证券资金-卖单交易取消后的证券、资金反向流水 |
142 | 返还证券资金-买单交易取消后的证券、资金反向流水 |
143 | 返还证券资金-买单交易取消后的证券、资金反向流水 |
144 | 交收-HS |
145 | 交收-HS |
147 | 资金冻结-HS |
148 | 资金解冻-HS |
149 | 支票确认-HS |
150 | 证券存取费用-HS |
151 | 利息归本回算-HS |
152 | 成交卖出-HS |
153 | 成交买入-HS |
154 | 未转换-HS |
181 | 撤回加款 |
182 | 撤回扣款 |
183 | 撤回冻结 |
184 | 内部转入资金 |
185 | 内部转出资金 |
186 | 待处理客户存款退回 |
187 | 客户转仓手续费 |
188 | 基金转入证券 |
189 | 证券转入基金 |
190 | 资金取 |
210 | 佣金返回 |
213 | 行情费用收取 |
214 | 平台费返回 |
215 | 活动现金存 |
216 | 证券资金转投顾 |
217 | 投顾资金转证券 |
218 | 咨询费收取 |
229 | 债券资金转入证券 |
230 | 证券资金转入债券 |
264 | 交易金额抵扣券 |
# 下单期权代码 规则说明
华盛行情期权code组成规则为:【正股代码】+【期权到期日】+【期权类型】+【行权价】
例如:【AAPL】+【220916】+【C】+【3000000】
具体的拼接规则应该是正股代码+yyyyMMdd格式的到期日取后6位即yyMMdd+期权类型+行权价保留4位小数点将小数点移除的字符串
比如行权价位0.1的期权保留4位小数位的行权价为0.1000转换出来的行权价字符串为01000
90行权价的期权保留4位小数位90.0000的行权价转换出来的字符串为900000
# 行情接口
# 通用VO结构说明
股票定义
{
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
}
# 基础报价
# 接口说明
批量查询股票基础报价
# 接口地址
POST http://127.0.0.1:11111/hq/BasicQot
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
Security | Security | 是 | 股票信息 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"security": [{
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
}]
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"basicQot": [{
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"isSuspended": "bool 是否停牌",
"openPrice": "double 开盘价",
"highPrice": "double 最高价",
"lowPrice": "double 最低价",
"lastPrice": "double 最新价",
"lastClosePrice": "double 昨收价",
"priceSpread": "double 价差",
"volume": "int64 成交量",
"turnover": "double 成交额",
"turnoverRate": "double 换手率",
"amplitude": "double 振幅",
"secStatus": "int32 SecurityStatus, 股票状态",
"listTime": "string 上市日期字符串(目前未返回该字段)",
"futureExData": {
"expiryDate": "string 到期日字符串",
"expiryDateDistance": "int32 距离到期日天数"
},
"optionExData": {
"strikePrice": "string 行权价",
"openInterest": "string 未平仓数",
"expireDate": "string 到期日 yyyyMMdd",
"premium": "string 溢价",
"intrinsicValue": "string 内在价值",
"dueDate": "string 距离到期日",
"iv": "string 隐含波动率",
"timeValue": "string 时间价值",
"actualLeverage": "string 实际杠杆",
"delta": "string DELTA",
"gamma": "string GAMMA",
"vega": "string VEGA",
"theta": "string THETA",
"rho": "string RHO"
},
"lotSize": "int32 每手",
"tradeTime": "string 交易时间",
"marketTime": "string 市场时间",
"stockStatus": "string 股票状态字段",
"volumeStr": "string 成交量兼容字段"
}]
}
}
# 买卖经纪摆盘
# 接口说明
买卖经纪摆盘,只支持港股
# 接口地址
POST http://127.0.0.1:11111/hq/Broker
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
Security | Security | 是 | 股票信息 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
}
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"brokerAskList": {
"level": "int32 档位",
"item": "string 经纪商代码",
"type": "int32 type=B或66代表item为买卖经纪商代码, 当type=S或者83代表该位置无买卖经纪,item可用作档位",
"name": "string 经济商名称"
},
"brokerBidList": {
"level": "int32 档位",
"item": "string 经纪商代码",
"type": "int32 type=B或66代表item为买卖经纪商代码, 当type=S或者83代表该位置无买卖经纪,item可用作档位",
"name": "string 经济商名称"
}
}
}
# 买卖档
# 接口说明
查询买卖档
# 接口地址
POST http://127.0.0.1:11111/hq/OrderBook
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
Security | Security | 是 | 股票信息 | |
mktTmType | Int | 否 | -1 1 -2 盘前 盘中 盘后 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"mktTmType": "int32 -1 1 -2 美股 盘前 盘中 盘后",
"depthBookType": "int32 2 3 totalview arcabook (非必填)"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"orderBookAskList": [{
"level": "int32 档位",
"price": "double 委托价格",
"volume": "int64 委托数量",
"orederCount": "int32 委托订单个数",
"brokeId": "string 交易所"
}],
"orderBookBidList": [{
"level": "int32 档位",
"price": "double 委托价格",
"volume": "int64 委托数量",
"orederCount": "int32 委托订单个数",
"brokeId": "string 交易所"
}],
"spreadLevel": "double 最小价格单位"
}
}
# 查询最近多少条逐笔
# 接口说明
查询最近多少条的逐笔列表
# 接口地址
POST http://127.0.0.1:11111/hq/Ticker
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
Security | Security | 是 | 股票信息 | |
limit | Int | 是 | 返回的逐笔个数 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"limit": "int32 返回的逐笔个数,实际返回数量可能少于该值,最多返回100个",
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"ticker": [{
"time": "string 时间字符串",
"side": "int32 TickerDirection, 买卖方向 0平1买2卖",
"price": "double 价格",
"volume": "int64 成交量",
"turnover": "double 成交额",
"type": "int32 TickerType, 逐笔类型",
"timestamp": "int64 时间戳"
}]
}
}
# 查询K线
# 接口说明
获取K线数据
# 接口地址
POST http://127.0.0.1:11111/hq/KL
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
Security | Security | 是 | 股票信息 | |
startDate | Int | 是 | yyyyMMdd | |
direction | Security | 是 | 方向 | |
exRightFlag | Int | 是 | 复权 | |
cycType | Int | 是 | k线类型 | 参看下面数据字典说明 |
limit | Int | 是 | 如果查分钟级的数据: 1)limit表示每次查询多少天(1分钟查6天,3分钟查9天,5分钟查12天,15分钟查24天,30分钟查36天,60分钟查60天,120分钟查96天),美股支持(10分钟查18天,240分钟查180天) 如果查天级以上的数据: 1)limit表示每次查数据记录的条数 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"startDate": "int64 yyyyMMdd",
"direction": "int32 方向",
"exRightFlag": "int32 复权",
"cycType": "int32 k线类型",
"limit": "int32 天数/数量"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"kline": [{
"date": "string 日期 yyyy-MM-dd",
"highPrice": "double 最高价",
"openPrice": "double 开盘价",
"lowPrice": "double 最低价",
"closePrice": "double 收盘价",
"lastClosePrice": "double 昨收价",
"volume": "int64 成交量",
"turnover": "double 成交额",
"timestamp": "int64 时间戳",
"time": "string 时间字符串 HH:mm"
}]
}
}
# 查询分时
# 接口说明
获取分时
# 接口地址
POST http://127.0.0.1:11111/hq/TimeShare
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
Security | Security | 是 | 股票信息 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
}
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"security": {
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
},
"timeShare": [{
"time": "string 时间字符串",
"price": "double 当前价",
"lastClosePrice": "double 昨收价",
"avgPrice": "double 均价",
"volume": "int64 成交量",
"turnover": "double 成交额"
}]
}
}
# 期权链到期日列表
# 接口说明
通过正股代码获取期权链到期日列表
# 接口地址
POST http://127.0.0.1:11111/hq/UsOptionChainExpireDate
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
securityCode | string | 是 | 正股代码 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"securityCode": "string 正股代码"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"expireDate": ["string 到期日 yyyy/MM/dd"]
}
}
# 期权链Code列表
# 接口说明
通过期权过期日期获取期权链Code列表
# 接口地址
POST http://127.0.0.1:11111/hq/UsOptionChainCode
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
securityCode | string | 是 | 正股代码 | |
expireDate | string | 是 | 到期日 | yyyy/MM/dd |
flagInOut | int | 否 | 价内/价外 | 价内=1 价外=2 |
optionType | string | 否 | 期权类型 | 看涨=C 看跌P |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"securityCode": "string 正股代码",
"expireDate": "string 到期日 yyyy/MM/dd",
"flagInOut": "int32 价内=1 价外=2",
"optionType": "string 期权类型 看涨=C 看跌P"
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {
"optionCode": ["string 期权代码"]
}
}
# 行情推送消息
# 订阅行情推送
# 接口说明
订阅行情推送
# 接口地址
POST http://127.0.0.1:11111/hq/Subscribe
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
topicId | int | 是 | 订阅类型,参考如下 | |
Security | Security | 是 | 股票信息,可批量 |
# 示例
Post请求示例:
{
"timeout_sec": 10,
"params": {
"topicId": "int 订阅类型,参考如下",
"security": [{
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
}]
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {}
}
# 取消行情订阅
# 接口说明
取消订阅行情推送
# 接口地址
POST http://127.0.0.1:11111/hq/Unsubscribe
# 参数说明
参数 | 类型 | 必填 | 说明 | 可能值 |
---|---|---|---|---|
topicId | int | 是 | 订阅类型,参考如下 | |
Security | Security | 是 | 股票信息,可批量 |
Post请求示例:
{
"timeout_sec": 10,
"params": {
"topicId": "int 订阅类型,参考如下",
"security": [{
"dataType": "int32 股票类型",
"code": "string 股票代码(行情接口:港股、沪深市场股票代码需要带后缀 .HK .SH .SZ)"
}]
}
}
响应结果:
{
"ok": true,
"err": "",
"data": {}
}
# 基础行情推送
topicId:11
推送消息实体
message BasicQotNotify {
Security security = 1;
BasicQot basicQot=2; // 基础行情返回
}
# 买卖经纪推送
topicId:16
推送消息实体
message BrokerNotify {
Security security = 1;
int32 side = 2; // 1买2卖
repeated Broker brokerList = 3;
}
# 买卖档推送
topicId:17
推送消息实体
message OrderBookFullNotify {
Security security = 1;
string side = 2; //0买1卖
repeated OrderBook orderBookBidList = 3;
int32 mktTmType = 4;
}
# 逐笔推送
topicId:14
推送消息实体
message TickerNotify {
Security security = 1;
Ticker ticker=2; // 逐笔列表
}
# 深度摆盘-ARCABOOK买卖档推送
topicId:25
推送消息实体
message OrderBookFullNotify {
Security security = 1;
string side = 2; //0买1卖
repeated OrderBook orderBookBidList = 3;
int32 mktTmType = 4;
}
# 深度摆盘-TOTALVIEW买卖档推送
topicId:26
推送消息实体
message OrderBookFullNotify {
Security security = 1;
string side = 2; //0买1卖
repeated OrderBook orderBookBidList = 3;
int32 mktTmType = 4;
}
# 响应状态码
# 系统状态码
状态码 | 说明 |
---|---|
0000 | 处理成功 |
# 业务状态码
状态码 | 说明 |
---|---|
# 数据字典
# RequestMsgType 请求业务类型
请求业务类型 | 请求值 | 说明 |
---|---|---|
InitConnectRequestMsgType | 0 | Socket登录接口 |
# ResponseMsgType 响应业务类型
响应业务类型 | 响应值 | 说明 |
---|---|---|
InitConnectResponseMsgType | 0 | Socket登录接口 |
# NotifyMsgType 推送消息类型
推送消息类型 | 响应值 | 说明 |
---|---|---|
TradeStockDeliverMsgType | 1 | 成交消息推送 |
# dataType 股票类型
股票类型 | 说明 |
---|---|
10000 | 港股股票 |
10001 | 港股指数 |
10002 | 港股ETF |
10003 | 港股窝轮 |
10004 | 港股牛熊证 |
10005 | 港股债券 |
10006 | 港股行业板块 |
10007 | 港股概念板块 |
10009 | 衍生品期货 |
10010 | 香港指数期货 |
10011 | 港股股票期货 |
10012 | 港股恒指股息期货 |
10013 | 港股人民币货币期货 |
10014 | 港股中华交易服务期货 |
10015 | 恒指波幅指数期货 |
10016 | 界内证 |
20000 | 美股股票 |
20001 | 美股指数 |
20002 | 美股ETF |
20003 | 美股期权 |
20006 | 美股行业板块 |
20007 | 美股概念板块 |
20009 | 美股OTC股票(由于上游供应商不支持,买卖档数据的拉取和推送不支持OTC) |
30000 | A股股票 |
30001 | A股指数 |
30002 | A股ETF |
30006 | A股行业 |
30007 | A股概念 |
30008 | A股科创板 |
# cycType K线类型
币种 | 说明 |
---|---|
2 | 日线 |
3 | 周线 |
4 | 月线 |
11 | 季度线 |
12 | 年度线 |
5 | 1分钟 |
6 | 5分钟 |
7 | 15分钟 |
8 | 30分钟 |
9 | 60分钟 |
10 | 120分钟 |
# ExRightFlag 复权
币种 | 说明 |
---|---|
0 | 不复权 |
1 | 前复权 |
2 | 后复权 |
# Direction 方向
币种 | 说明 |
---|---|
0 | 往左查询 |
1 | 往右查询 |
# 常见问题
# 账户相关
申请一个开发者账户只能交易一个证券账号吗? 可否处理多个证券账号?
目前仅支持一个开发者对应一个华盛号以及对应的证券账号;如有需要进行多个证券账号交易需求,需要申请多个开发者账号。
交易登录超时是什么原因?
交易登录的时间是按照您在华盛通APP上设置的登录时间进行限制,如需要更长登录时间,请前往华盛通APP进行修改。
# 交易相关
港股的下单类型如何选择?
通过委托接口中委托类型进行区分,港股:'0'竞价限价、'1'竞价、'2'增强限价盘、'3'限价盘、'4'特别限价盘、'6'暗盘。
想要查看成交的费用信息在哪里查看?
由于当日成交还未进行清算,因此通过历史成交接口可以看到费用信息。
收到错误消息“当前时间不允许委托”是什么原因?
请检查委托时间是否处于市场开盘时间。
# 接口相关
Token的有效性如何判断呢?只能根据调用接口后的错误结果来处理吗?
登录后token有效性为3小时,调用接口会延长这个时间。可以通过判断错误码来处理自动重新登录,还可以定时轮询查询类接口来保持登录态。
PB接口地址列表是固定的吗?是否需要经常动态获取配置接口?
PB接口地址列表是固定的,没有特殊情况不会更新。
设备绑定是强制的吗? 是只要绑定一次就可以吗?
目前设备绑定是强制的,一个设备只要绑定一次即可,如更换设备需要重新绑定。
测试环境API接口调试时段说明。
工作日周一到周五:9:00~18:00。
OpenAPI接口文档说明。 点击此处 (opens new window)可查看原接口文档,建议您及时更换新的接入方式。
# 问题反馈
如遇到疑问可致电华盛客服(400-788-1390),或直接联系您的客户经理,我们将为您提供专门的技术团队协助解决。