09.期货柜台管理协议

版本：v1.0.3

Xele-Trade-Futures是业内领先的基于FPGA、微秒级极速交易系统，独创完整流程的FPGA数据传输系统，拥有纳秒级响应速度，提供最快速准确的资讯通道；是为证券、期货高端人士及机构、基金类专业投资机构及产业巨头量身打造的高性能交易系统。

该文档是极速交易系统Xele-Trade-Futures的柜台管理使用手册，它提供API功能及其使用说明，供柜台管理者方便快捷地对柜台各项功能和配置进行管理。

版本记录

日期	版本号	修订者	修改内容	备注
2023/6/16	1.0.1		文档初始化完成
2023/8/31	1.0.1	leileis	增加交易汇总查询
2023/10/23	1.0.1	leileis	修改客户交易权限模版接口
2024/06/06	1.0.2	leileis	增加风控权限模版配置接口
2024/7/22	1.0.2	leileis	007版本相关接口更改记录：1）资金查询接口，增加“申报费”和“资金可用比例”字段；2）客户交易权限模版接口，其中prc字段增加几个风控项,如：大额撤单、大额撤单单笔最大报单量，大额撤单固定比例，价格偏离度、价格偏离度系数、价格偏离度绝对值、检查期权月份多仓手数上限、检查期权月份空仓手数上限、检查期货期权联合多仓手数上限、检查期货期权联合空仓手数上限
2024/8/23	1.0.3	leileis	增加“报单查询”接口
2024/12/6	1.0.3	leileis	“持仓查询”接口增加了保证金相关的字段
2025/6/18	1.0.3	leileis	修改“持仓查询”接口的请求格式修改“报单查询”接口的响应格式，增加了响应头和AppID字段
2025/7/17	1.0.3	leileis	修改“新增授权码”和“修改授权码”的请求接口，以及“查询授权码”的响应，增加AppID支持绑定投资者功能	007P8引入

09.期货柜台管理协议

公共项统一说明

1) 通信方式及接口说明

柜台管理协议使用的网络协议及其接口说明，如下表所示：

网络协议	HTTP（TCP/IP）
端口	8899	鉴权服务器（以下简称“MA”）默认使用该端口，本文有部分接口是由MA来支持，具体接口使用说明章节会有描述
	8181	柜台服务端（以下简称“MS”）默认使用该端口，本文有部分接口是由MS来支持，具体接口使用说明章节会有描述
接口	遵循restful风格
	method	功能描述
	GET	用于查询操作
	POST	用于添加操作
	PUT	用于修改操作
	DELETE	用于删除操作
	注：柜台管理协议中所有请求均是json格式数据，一般规定均放在HTTP请求的body，发送到柜台端。因考虑web浏览器可能不支持将查询数据放在GET请求的body里，亦可以将其查询数据经base64后，作为参数放在url中，例如：192.168.2.15:8181/api/trade/infos?params=xxxxbase64xxx的方式，其中params是固定的不可换成其它变量。
配套柜台版本	适用于Release-002-P3以上版本

2) 接口使用示例

接口使用方式，本文通过使用第三方HTTP软件进行示例说明，实际使用情况以用户选用的HTTP开发组件而定，下面使用Postman，以对投资者相关的增删改查接口为示例演示接口调用方式。

A. GET请求

数据放body方式:

在Postman 使用GET方式，点击Body标签页，选择raw方式，放入我们推荐的请求数据，如：

JSON
{
    "protocl_version":"1.0.1",
    "token":"EB6F936159EB615CF8C27466BBFB0DC91A78BACE584B94DB35D16CDF1401",
    "serialno":12,
    "operator":"",
    "data":{
        "trading_day":"20250715"
    }
}

数据放URL方式，直接填写对应的ma或ms服务器地址和我们提供的api接口：

HTML
http://{{ma-ip}}:8899/api/auth/trade/query
http://{{ms-ip}}:8181/api/auth/trade/query

选择ma或ms根据不同的接口判断，判断依据本节第1) 通信方式及接口说明进行选择；

B. POST请求

使用PSOT请求方式，同样需要点击Body标签页，选择raw方式，放入我们推荐的请求数据，如出入金新增的请求：

JSON
{
    "protocl_version":"1.0.1",
    "token":"xxx",
    "serialno":12,
    "operator":"",
    "data":{
        "amount":500000,
        "direction":"1",
        "investor_id":"7770123",
        "operator":"admin"
    }
}

C. PUT请求

使用PUT请求方式，同样需要点击Body标签页，选择raw方式，放入我们推荐的请求数据，如出入金审核的请求：

JSON
{
    "protocl_version":"1.0.1",
    "token":"xxx",
    "serialno":12,
    "data":{
        "unique_id":1,
        "status":1
    }
}

D. DELETE请求

使用DELETE请求方式，同样需要点击Body标签页，选择raw方式，放入我们推荐的请求数据，如删除交易权限模板的请求：

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"210"
            }
        ]
    }
}

3) 公共字段说明

鉴于管理协议中所有增删改查接口的请求和响应中存在一些公共的字段，为避免后续章节中字段描述重复，本章节会做统一说明。具体字段的详细描述如下表所示：

*公共字段说明表*

*字段名*	*字段释义*	*数据类型*	*备注*
protocl_version	MS端API协议版本	C64	固定默认为”1.0.1”
client_version	MA端API协议版本	C64	固定默认为”1.0.1”
token	请求token	C128	该字段值来自鉴权服务器，详细获取方式，参考随后章节说明
serialno	API标识符	N4	保留字段，默认可取范围0-65535内任意值
operator	请求发起者	C64	主要用于记录web用户，对于协议用户，该字段可为空
data	数据字段	json	此字段的具体数据组织形式以具体请求类似而定，一般是json数组或者对象
code	请求响应码	int	0：表示成功；其他：表示失败，具体详见《错误码》章节
msg	错误描述	string	0：成功；其他：以具体请求响应错误描述而定，具体详见《错误码》章节。
result	返回结果	json	有些API接口响应可能会包涵来自服务端的一些数据，具体是json数组或者对象，以具体请求类型而定，注意：不是所有的API响应都有这个字段，一般特指查询接口

如无特殊说明，所有请求的响应均是如下格式：

JSON
{
    "data": {
        "code": 0,
        "message": "成功"
    },
    "operator": "",
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "F6826DDF087C3E0BD3B19B378EC69AB04480961D974642671483"
}

4) Token获取

使用MA的8899端口访问/login接口来获取token，Url结构形式如：ip(MA所在机器的管理地址):8899/login，在username和password字段分别填入用户名和密码后即可发送到MA端获取token，从请求后的回报中的ticket字段值就是待获取的token，响应中除ticket以外的其他字段均可忽略不用考虑。

JSON
{
   "data" : {
      "code" : 0,
      "msg" : "Success!",
      "result" : {
         "job_title" : [ "管理员" ],
         "menus" : {
            "投资者交易管理" : {
               "交易信息汇总" : [
                  {
                     "permcode" : "GET",
                     "title" : "查看",
                     "url" : "/api/trade/statistic/info"
                  }
               ]
               ...
               ]
            }
         },
         "ticket" : "71C8D966F86D696A0F8BEC0F1ED995FAC586759945D94DB2889956748A26"
      }
   }
}

5) 错误码

错误码如下表所示：

序号	错误码	描述	备注
1	0	成功
2	100	柜台程序内部参数错误
3	101	url不支持，请核对软件/协议版本
4	102	柜台MS服务无对应API接口的请求响应实现
5	103	请求json参数中存在软件不识别字段，请核对软件/协议版本
6	104	无效的json格式
7	105	不支持的API协议，请核对软件/协议版本
8	106	修改失败
9	107	拒绝接入柜台，本次http链接非法
10	108	不支持的http请求方式
11	109	无效token
12	110	不支持的席位号
13	111	查询失败
14	112	增加失败
15	113	删除失败
16	114	权限不满足，禁止访问
17	115	拒绝响应，请检查传参是否正确
18	116	请求中存在非法字段值
19	117	废弃的API
20	118	出金失败
21	119	入金失败
22	120	平仓失败
23	1000	无	无具体错误描述

6) 注意事项

A. 针对一个请求，在发送时必须保证该请求的所有字段的完整性，对于缺少字段、随意添加字段、修改字段值类型等，服务端都认为请求格式不合法，报错返回；

B. 类型、名称、以及字段值约束等必须要跟要求的一致，否则服务端不予执行，报错返回；

C. 因柜台资源有限，尽量不要尝试以高频率反复发送请求，尤其是查询类请求，否则可能会影响柜台性能。

D. 在调用MA的相关接口前，请确保MA已经启动，MA进程为xele-auth-server；

E. 在调用MS的相关接口前，请确保MS和MA已经启动，MS进程为xele-monitor-server。

1. 资金查询 /api/trade/investor/fund

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/investor/fund

Http请求方式：见本章二级标题

1.1 资金查询信息（GET）

1.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"xxx",
    "serialno":12, 
    "operator":"",
    "data": {
            "content":"",
            "option_scale":{
                "investor_id":true,
                "investor_name":true,
                "pre_balance":true, 
                "static_balance":true,
                "close_profit":true,
                "float_profit_and_loss":true,
                "dynamic_rights":true, 
                "order_commission":true,
               "delivery_margin":true,
                "curr_margin":true,
                "frozen_margin":true,
                "fee":true,
                "frozen_fee":true,
                "premium":true,
                "frozen_premium":true,
                "available":true, 
                "avaiable_limit":true,
                "risk":true,
                "cash_in":true,
                "cash_out":true
                }
            } 
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
content	查询内容	C1024	表示查询内容，若为空，则查询所有，不加以限制
option_scale	json对象
investor_id	投资者账户	B	该字段为true时表示该字段可作为查询条件，反之为false不作为查询条件，以下字段均类似。默认为true
pre_balance	上次结算准备金(静态权益)	B
order_commission	申报费	B
static_balance	静态权益	B
dynamic_rights	动态权益	B
order_commission	申报费	B
delivery_margin	交割保证金	B
close_profit	平仓盈亏	B
curr_margin	当前保证金总额(占用保证金)	B
frozen_margin	冻结保证金	B
available	可用资金	B
avaiable_limit	资金可用比例	B	该字段为整型，计算方式：百分比（小数）10000，例如：12%=0.1210000，该字段值为1200
risk	风险度	B
limited	限制交易风险度	B
delivery_margin	交割保证金	B
fee	手续费	B
frozen_fee	冻结手续费	B
premium	权利金	B
frozen_premium	冻结权利金	B
cash_in	出金	B
cash_out	入金	B
float_profit_and_loss	持仓盈亏	B

1.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": [
           {
                "available": 205321652.45,
                "close_profit": 0,
                "curr_margin": 9100916.7,
                "delivery_margin": 0,
                "dynamic_rights": 0,
               "delivery_margin":0, 
                "order_commission": 0,
                "fee": 0,
                "float_profit_and_loss": 0,
                "frozen_fee": 0,
                "frozen_margin": 0,
                "frozen_premium": 0,
                "investor_id": "7770012",
               "investor_name": "李三",
                "limited": 0,
                "pre_balance": 214422569.15,
                "premium": 0,
                "cash_in": 0.0,
               "cash_out": 0.0,
                "risk": 0,
                "trading_day": "20220412"
            }       
        ]
    },
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "4967692b2fd646039c07ee80c5d9b2e8"
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
investor_id	投资者账户	C13
Investor_name	投资者姓名	C13
trading_day	交易日	C9
pre_balance	上次结算准备金(静态权益)	N8,4
order_commission	申报费	N8,4
static_balance	静态权益	N8,4
dynamic_rights	动态权益	N8,4
order_commission	申报费	N8,4
delivery_margin	交割保证金	N8,4
close_profit	平仓盈亏	N8,4
curr_margin	当前保证金总额(占用保证金)	N8,4
frozen_margin	冻结保证金	N8,4
available	可用资金	N8,4
avaiable_limit	资金可用比例	N8	该字段为整型，计算方式：百分比（小数）10000，例如：12%=0.1210000，该字段值为1200
risk	风险度	N8,4
limited	限制交易风险度	N8,4
delivery_margin	交割保证金	N8,4
fee	手续费	N8,4
frozen_fee	冻结手续费	N8,4
premium	权利金	N8,4
frozen_premium	冻结权利金	N8,4
cash_in	出金	N8,4
cash_out	入金	N8,4
float_profit_and_loss	持仓盈亏

2. 手动出入金操作 /api/trade/cashinout/audit

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/cashinout/audit

Http请求方式：见本章二级标题

2.1 出入金查询（GET）

2.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"F3A8B9DB530BBA60F5D6B4D2B025150F2EC4B7A7CDD88A728BE",
    "serialno":12,
    "operator":"",
    "data":{
        "investor_id":null,
        "investor_name":null,
        "cash_inout":"出金",
        "amount":{"min":0,"max":null},
        "operator":null,
        "status":null,
        "update_time":{"min":"2022-01-10 10:09:35","max":"2022-05-10 10:11:35"}
    }
}

字段说明：

注：所有字段的值当为null或者空时表示忽略此字段作为查询条件，即此条件不参与查询，反之改字段作为查询条件。

*字段名*	*字段释义*	*数据类型*	*备注*
investor_id	投资者账号	C13
investor_name	登陆权限	C13
cash_inout	出入金	C13	此字段可取值：“出金”“入金”
amount	min	最小值	N8	[0-999999999999]
	max	最大值	N8	[0-999999999999]
operator	操作者	C13	默认可填获取token时的用户名
status	操作状态	C13	“待审核”“已通过”“不通过”“失败”“已同步”
update_time	更新时间		时间格式：2022-09-10 10:09:18
	min	开始时间	C32
	max	结束时间	C32

2.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": [
            {
                "amount": 500000,
                "direction": "1",
                "investor_id": "7770012",
                "investor_name": "李雷",
                "operator": "admin",
                "status": 0,
                "unique_id": 1,
                "update_time": "2022-04-11 14:42:31"
            }
        ]
    },
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "4967692b2fd646039c07ee80c5d9b2e8"
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
unique_id	此条记录唯一ID	uN4
investor_id	投资者账号	C13
investor_name	投资者名称	C13
direction	出入金标志	C1	1:入金 2:出金
amount	出入金金额	N8.4
operator	操作者	C13
status	操作状态	N1	0：待审核1：已通过2：不通过3：失败4：已同步
update_time	更新时间	C20	2022-04-06 16:15:01

2.2 出入金审核（PUT）

2.2.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"xxx",
    "serialno":12,
    "data":{
        "unique_id":1,
        "status":1
    }
}

字段说明：参考《出入金查询》响应章节中的字段说明。

2.2.2 响应

参考《公共字段说明》章节。

2.3 出入金新增（POST）

2.3.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"xxx",
    "serialno":12,
    "operator":"",
    "data":{
        "amount":500000,
        "direction":"1",
        "investor_id":"7770123",
        "operator":"admin"
    }
}

2.3.2 响应

参考《公共字段说明》章节。

3. 交易所前置 /api/trade/seat/config

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/seat/config

Http请求方式：见本章二级标题

本柜台支持SHFE、INE、DCE、CFFEX、CZCE、GFEX交易所，各个交易所的前置查询结果可能字段存在差异，下表统一说明，且下述的请求和响应是以上期（SHFE）为例，其他交易所的前置查询同理。

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
seat_type	seat类型	C10	MANAGER 主席SLAVE 次席MARKET 行情
seat_index	席位编号	uN1
exchange_master	交易所的管理席位	B	回报优选的用，默认false
connect_start_day_time	日盘连接时间	C8	时间格式：“00:00:00”，其他格式无效
connect_start_night_time	夜盘连接时间	C8	时间格式：“00:00:00”，其他格式无效
connect_time_enable	是否生效	N1	0：关；1：开
front_ip	前置地址	C32
front_port	前置端口号	uN2
fens_ip	fens地址	C32
fens_port	fens端口号	uN2
fens_enable	是否启用fens	N1	1：生效；0：不生效
flow_control	每秒流控	N2	默认200
weight	权重值	N4	取值[0,1024]
short_code	快捷码	C16
participant_id	会员号	C11
seat_id	席位编码	C11
password	席位密码	C64
enable	配置是否生效	B
exchange_id	交易所	C9
init_password	初始化密码	C64
auth_serial_no	授权码序列号	C45
auth_code	授权码	C45
dce_query_ip	辅助网关ip	C20
dce_query_port	辅助网关port
dce_trader_no	交易或行情网关编号	C17
dce_query_no	辅助网关编号	C17
private_ip	私有流地址	C32	仅郑商使用
private_port	私有流端口	uN2	仅郑商使用
backup_private_ip	备用私有流地址	C32	仅郑商使用
backup_private_port	备用私有流端口	uN2	仅郑商使用
update_time	席位更新时间	C20	2022-03-04 15:30:23

3.1 交易所前置查询（GET）

3.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"30CD63111765D77EDD01559686FF08B4F9FC141CDB9C002E50721",
    "serialno":12,
    "operator":"admin",
    "data":{
        "seat_index":null
    }
}

字段说明：seat_index为null时，表示查询所有柜台的席位，否则需要指定席位号来查询对应席位的信息，其中席位号[0-32)

3.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": [
            {
                "enable": true,
                "exchange_id": "SHFE",
                "fens_enable": 1,
                "fens_ip": "192.168.2.123",
                "fens_port": 5050,
                "front_ip": "192.168.2.123",
                "front_port": 5050,
                "participant_id": "0049",
                "password": "xxx",
                "seat_id": "08112010",
                "seat_index": 0,
                "seat_type": "MANAGER"
            }
        ]
    },
    "operator": "admin",
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "CCC7CEA950C30CD63111786FF08B4F9FC141CDB9C002E50721"
}

4. 交易所前置实时控制 /api/trade/front/control

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/front/control

Http请求方式：见本章二级标题

4.1 前置实时控制查询（GET）

只有当柜台正常启动后查询到的前置实时控制信息才准确，否则查询的可能是上一次柜台生成实时控制信息

4.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"223B4DF0CF552165352F71CD0CFB31AAC28E5B3",
    "serialno":12,
    "operator":"",
    "data":{
        "exchange_id":"CFFEX"
    }
}

4.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": [
            {
                "exchange_id": "CFFEX",
                "flow_control": 200,
                "front_ip": "124.93.249.141",
                "seat_index": 0,
                "seat_type": "MANAGER",
                "update_time": "2023-05-29 13:46:35",
                "weight": 17
            }
        ]
    },
    "model_switch": 1,
    "operator": "",
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "223B4DF0CF552165352F71CD0CFB31AAC28E5B3"
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
exchange_id	交易所	C9	该字段取值："DCE","SHFE","INE","SHFE;INE","CZCE","CFFEX","GFEX"
seat_index	席位号	N1	从0开始
seat_type	席位类型	C12	MANAGER：主席SLAVE：次席MARKET：行情
model_switch	报单方式	N1	0：优先发送；1：概率发送
flow_control	每秒流控	N4
weight	权重值	N4	取值大于等于0，该字段的实际意义取决与model_switch开关。当model_switch=0时，该字段表示优先级；当model_switch=1时，该字段标识权重值；
front_ip	前置地址	C45
update_time	席位更新时间	C20	2022-03-04 15:30:23

4.2 前置实时控制（PUT）

该功能需要先查询前置实时控制，之后在查询到的席位上做实时控制的配置操作，且要满足柜台正常启动，否则无法进行前置实时控制。

4.2.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"223B4DF0CF552165352F71CD0CFB31AAC28E5B3",
    "serialno":12,
    "operator":"",
    "model_switch":0,
    "data": [
            {
                "seat_index":0,
                "flow_control":200,
                "weight":10
            }
    ] 
}

4.2.2 响应

参考《公共字段说明》章节。

4.2.3 示例说明

假设柜台有8个席位，编号分别为0到7，实际使用中发现其中的1、3、6号前置比较快，此时想要轮训这3个前置报单，则这3个前置需设置一样的值99，其它前置的权重均设置为0，即此种用例下这8个席位就需要同时被设置，具体做法如下：

1）model_switch字段设置为1，将柜台设置在概率发送模式；

2）data字段设置：此字段是个json数组类型，原则上有多少个前置需要被改动，此字段就需要配置多少个json对象；

3）其它字段，照常填写,flow_control字段，因有些交易所的柜台暂不支持，此时可填默认值200，其它依实际情况照常填写。

本示例的完整请求如下：

JSON
{
    "protocl_version":"1.0.1",
    "token":"223B4DF0CF552165352F71CD0CFB31AAC28E5B3",
    "serialno":12,
    "operator":"",
    "model_switch":1,
    "data": [
            {
                "seat_index":0, "flow_control":200, "weight":0
            },{
                "seat_index":1, "flow_control":200, "weight":99
            },{
                "seat_index":2, "flow_control":200, "weight":0
            },{
                "seat_index":3, "flow_control":200, "weight":99
            },{
                "seat_index":4, "flow_control":200, "weight":0
            },{
                "seat_index":5, "flow_control":200, "weight":0
            },{
                "seat_index":6, "flow_control":200, "weight":99
            },{
                "seat_index":7, "flow_control":200, "weight":0
            }
    ] 
}

5. 看穿式信息 /api/trade/export/clientsystem/info

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/export/clientsystem/info

Http请求方式：见本章二级标题

5.1 看穿式信息导出（GET）

5.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"14ECE9F83C95B13DE4BA7BF63A059E616A2B5F163463",
    "serialno":12,
    "operator":"",
    "data":{
        "trading_day":"20220412"
    }
}

字段说明：trading_day导出日期，日期格式：“yyyyMMdd”。

5.1.2 响应

查询到的记录格式如下所示，否则返回空。

clientinfo20220412.txt

JSON
accelecom@1@cXh1/VOIJzjdk0ntG1RwvH0QT+2g1RWsj85ibq7rFyJvXinH4nacxtJB6C+HLntaFftCY9HJsM3Yh/+MuAlGiknYzDb7xn+uwIAxSjG37qAwn2fXDBdkWGZNEnQiak88xkRBDyix8qw/T3E7faBYqjyHrTsDjSL7/dIXgHUA3DTRpVI/05nE1aXfIfA63/I9BXBUdGbIXU4w6l4XDzLMDlkjWqnDJ80byYERLJHgDx99a7N6bHMawl1h2W/vLg6JkUc/pKJMgPVcaFuWZ5WiANEtIQywiVLnT8D9WImKX8HxYeasi6+ph+/7URUm1JIWs8q+FX9xsBqG7U3I9t0yJg==@c3BOrP5udH92c+vrd1kknV2mVuAh2fUZRXZLC0xBsvOMqkA3Z1GE+6QuEB52k1A97G7JSM8EgrT8Lv07lVnqcdRwMOlCKb49G/xu+1YR7qOphTJ/y6IIzdzSV5CPa/rjw8eqOCEiZiXN5xAb6wbf+d5ax9J786cru62mb9uwkDgTVFDiaBjm8Bth4gq8t8NCYKtxY/sA3bSIfWyWHuy8sICfS5sbcQoSqbJyhs/scD62cWq0W6JVYV598c++8XqBk2vbP9iufxhj6+vKwVNFVTPIt/iFKIUGqGzMA+AqEGW2SBAxCjy9yFfMI4/aOXeiP1G8eNzu2ZAzFgvoXv2P/Q==
accelecom@1@cXh1/VOIJzjdk0ntG1RwvH0QT+2g1RWsj85ibq7rFyJvXinH4nacxtJB6C+HLntaFftCY9HJsM3Yh/+MuAlGiknYzDb7xn+uwIAxSjG37qAwn2fXDBdkWGZNEnQiak88xkRBDyix8qw/T3E7faBYqjyHrTsDjSL7/dIXgHUA3DTRpVI/05nE1aXfIfA63/I9BXBUdGbIXU4w6l4XDzLMDlkjWqnDJ80byYERLJHgDx99a7N6bHMawl1h2W/vLg6JkUc/pKJMgPVcaFuWZ5WiANEtIQywiVLnT8D9WImKX8HxYeasi6+ph+/7URUm1JIWs8q+FX9xsBqG7U3I9t0yJg==@c3BOrP5udH92c+vrd1kknV2mVuAh2fUZRXZLC0xBsvOMqkA3Z1GE+6QuEB52k1A97G7JSM8EgrT8Lv07lVnqcdRwMOlCKb49G/xu+1YR7qOphTJ/y6IIzdzSV5CPa/rjw8eqOCEiZiXN5xAb6wbf+d5ax9J786cru62mb9uwkDgTVFDiaBjm8Bth4gq8t8NCYKtxY/sA3bSIfWyWHuy8sICfS5sbcQoSqbJyhs/scD62cWq0W6JVYV598c++8XqBk2vbP9iufxhj6+vKwVNFVTPIt/iFKIUGqGzMA+AqEGW2SBAxCjy9yFfMI4/aOXeiP1G8eNzu2ZAzFgvoXv2P/Q==

字段说明：

1）返回结果的第一行是导出文件的文件名，例如：clientinfo20220412.txt；

2）之后的每一行就是一条看穿式监管的信息，均需要依次写入文件clientinfo20220412.txt中。

6. 持仓 /api/trade/position/info

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/position/info

Http请求方式：见本章二级标题

6.1 持仓查询（GET）

6.1.1 请求

JSON
{
    "protocl_version":"1.0.3",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
    "serialno":12,
    "operator":"admin",
    "data":{
        "content":"ss2303",
        "investor_id":["xxx"],
        "investor_name":["xxx"],
        "instrument_id":["ag2013"],
        "bought_position_sum":{"min":0,"max":999999},
        "bought_position":{"min":0,"max":999999},
        "old_bought_position":{"min":0,"max":999999},
        "sold_position_sum":{"min":0,"max":999999},
        "sold_position":{"min":0,"max":999999},
        "old_sold_position":{"min":0,"max":999999},
        "close_old_bought_position":{"min":0,"max":999999},
        "close_old_sold_position":{"min":0,"max":999999},
        "last_price":{"min":0,"max":228.3},
        "upper_limit_price":{"min":0,"max":228.3},
        "lower_limit_price":{"min":0,"max":228.3},
        "long_margin":{"min":0,"max":228.3},
        "short_margin":{"min":0,"max":228.3}, 
        "margin":{"min":0,"max":228.3},
        "hedge_flag":null
    }
}

字段说明：

investor_id	投资者账号	C12	数组
content	模糊搜索内容	C1024	字符串
investor_name	投资者姓名	C12	数组
instrument_id	合约ID	C32	数组
bought_position_sum	总买仓	N4
	min	最小值
	max	最大值
bought_position	今买仓	N4
	min	最小值
	max	最大值
old_bought_position	昨买仓	N4
	min	最小值
	max	最大值
close_old_bought_position	可平买仓	N4
	min	最小值
	max	最大值
sold_position_sum	总卖仓	N4
	min	最小值
	max	最大值
sold_position	今卖仓	N4
	min	最小值
	max	最大值
old_sold_position	昨卖仓	N4
	min	最小值
	max	最大值
close_old_sold_position	可平卖仓	N4
	min	最小值
	max	最大值
last_price	最新价	N8	double
	min	最小值
	max	最大值
upper_limit_price	涨停价	N8	double
	min	最小值
	max	最大值
lower_limit_price	跌停价	N8	double
	min	最小值
	max	最大值
long_margin	多仓保证金	N8	double
	min	最小值
	max	最大值
short_margin	空仓保证金	N8	double
	min	最小值
	max	最大值
margin	保证金	N8	double
	min	最小值
	max	最大值
hedge_flag	投保标记	C32	json数组，保留字段，默认为null

6.1.2 响应

该请求响应主要由*响应头***和*响应内容***两个部分组成，其中响应头位于整个响应数据的开头第一行，并以逗号（‘，’）分割各数据字段；从整个响应数据的第二行开始一直到响应数据末尾均是响应内容，且每行以“|”符号分割的方式进行传输，有多少单量就对应多少行的数据，具体格式及说明如下：

1）响应头

JSON
MS,PosiQry,1.0.3,18,1474     ,InvestorId | InvestorName | InstrumentId | BoughtSumPosition | BoughtPosition | OldBoughtPosition | CloseOldBoughtPosition | SoldSumPosition | SoldPosition | OldSoldPosition | CloseOldSoldPosition | LongMargin | ShortMargin | Margin | LastPrice | UpperLimitPrice | LowerLimitPrice |HedgeFlagg

字段名	字段释义	备注
MS	magic	响应数据的开头标识
PosiQry	响应数据类别	OrderQry：报单查询；OptExecQry：行权查询QuoteQry：报价查询QuoteDemandQry：询价查询*PosiQry*：持仓查询ComboPosiQry：组合持仓查询LoginQry：客户登录查询
3rdOffset	协议版本号	当前1.0.3
4thOffset	响应内容的列数	当前18,响应内容有18个子属性列
5thOffset	响应内容的条数	当前1474，响应内容有1474条数据
5thOffset	响应内容的属性字段组合格式	以“\|”分隔

例如：

JSON
41033540|华某某|zn2308|45|0|45|45|52|0|52|52|4470342.9750|6955718.6400|11426061.6150||0.0000|0.0000|投机

41033540|华某某|zn2307|77|0|77|77|86|0|86|86|11383662.2515|17842962.1870|29226624.4385||0.0000|0.0000|投机

2）响应内容

该请求响应是按行且每行以“|”符号分割的方式进行传输，有多少单就对应多少行的数据；具体数据格式如下：

JSON
InvestorId  | InvestorName | InstrumentId | BoughtSumPosition | BoughtPosition| OldBoughtPosition | CloseOldBoughtPosition | SoldSumPosition | SoldPosition | OldSoldPosition | CloseOldSoldPosition | LongMargin | ShortMargin | Margin |LastPrice | UpperLimitPrice | LowerLimitPrice | HedgeFlag

例如：

JSON
41033540|华某某|zn2308|45|0|45|45|52|0|52|52|4470342.9750|6955718.6400|11426061.6150||0.0000|0.0000|投机

41033540|华某某|zn2307|77|0|77|77|86|0|86|86|11383662.2515|17842962.1870|29226624.4385||0.0000|0.0000|投机

字段说明：

字段名	字段释义	数据类型	备注
InvestorId	投资者账号	C13
InvestorName	投资者姓名	C13
InstrumentId	合约	C13
BoughtPositionSum	总买仓	C32	以下行字段（除投保外）均是数值型的*字符串*，例如：”101.0003”
BoughtPosition	今买仓	C32
OldBoughtPosition	昨买仓	C32
SoldPositionSum	总卖仓	C32
SoldPosition	今卖仓	C32
OldSoldPosition	昨卖仓	C32
CloseOldBoughtPosition	可平买仓	C32
CloseOldSoldPosition	可平卖仓	C32
LastPrice	最新价	C32
UpperLimitPrice	涨停价	C32
LowerLimitPrice	跌停价	C32
LongMargin	多头保证金	C32
ShortMargin	空头保证金	C32
Margin	保证金	C32
HedgeFlag	投保	C32

7. 客户费率 /api/trade/investor/rates

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/investor/rates

Http请求方式：见本章二级标题

7.1 费率查询（GET）

7.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
    "serialno":12,
    "operator":"",
    "data":{
        "content":"0006",
        "investor_id":[],
        "instrument_id":[],
        "volume_multiple":{"min":null,"max":null},
        "open_ratio_by_money":{"min":null,"max":null},
        "open_ratio_by_volume":{"min":null,"max":null},
        "close_ratio_by_money":{"min":null,"max":null},
        "close_ratio_by_volume":{"min":null,"max":null},
        "close_today_ratio_by_money":{"min":null,"max":null},
        "close_today_ratio_by_volume":{"min":null,"max":null},
        "long_margin_ratio_by_money":{"min":null,"max":null},
        "short_margin_ratio_by_money":{"min":null,"max":null}
    }
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
content	模糊搜索的关键字	C64	为了检索的准确性，请输入尽可能贴近结果的关键字
investor_id	投资者账号	array	该字段是字符串型的json数组例如："investor_id”:[“0001”,”002”]
instrument_id	合约	array	该字段是字符串型的json数组例如："instrument_id”:[“au001”,”au002”]
volume_multiple	合约乘数	对于字段查询范围[min,max]，有如下情况：1， min值非空，max值为空，则查询范围为>=min;2， min值为空，max不为空，则查询范围为<=max；3， min值不为空，max不为空，则查询范围为>=min && <= max;4， min值为空，max为空，则忽略此查询条件其它范围查询字段均类似
	min	最小值	N4
	max	最大值	N4
open_ratio_by_money	开仓按金额手续费率
	min	最小值	N8.6
	max	最大值	N8.6
open_ratio_by_volume	开仓按手数手续费率
	min	最小值	N8.6
	max	最大值	N8.6
close_ratio_by_money	平仓按金额手续费率
	min	最小值	N8.6
	max	最大值	N8.6
close_ratio_by_volume	平仓按手数手续费率
	min	最小值	N8.6
	max	最大值	N8.6
close_today_ratio_by_money	平今按金额手续费率
	min	最小值	N8.6
	max	最大值	N8.6
close_today_ratio_by_volume	平今按手数手术续费
	min	最小值	N8.6
	max	最大值	N8.6
long_margin_ratio_by_money	多头按金额保证金率
	min	最小值	N8.6
	max	最大值	N8.6
short_margin_ratio_by_money	空头按金额保证金率
	min	最小值	N8.6
	max	最大值	N8.6

7.1.2 响应

若根据查询条件已查到结果，则查询结果的格式如下：

JSON
00060258|au2304P19696|0.000000|10.000000|0.000000|10.000000|0.000000|10.000000|0.000000|0.000000|1000
00060258|rb2305P5400|0.000000|6.000000|0.000000|6.000000|0.000000|6.000000|0.000000|0.000000|10
00060258|au2304C14216|0.000000|10.000000|0.000000|10.000000|0.000000|10.000000|0.000000|0.000000|1000
00060258|au2304P9744|0.000000|10.000000|0.000000|10.000000|0.000000|10.000000|0.000000|0.000000|1000

各字段用“|”符号分割，各自所表示的意义如下顺序：

8. 客户交易权限 /api/auth/trade/query

请求接收方：MA

Url：ip(MA所在机器的管理地址):8899/api/auth/trade/query

Http请求方式：见本章二级标题

8.1 查询交易权限（GET）

8.1.1 请求

JSON
{
    "client_version":"1.2.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
    "data":{
    "exchange":["CFFEX"],
    "investor_id":["10101010"],
    "product_id":["1"] ,
    "prc_type":[
            {
                "enable" : 1,
                "prc_type" : "TradingEnable",
                "value" : 2
            }
        ]
    }
}

字段说明：

字段名	字段释义	数据类型	备注
exchange	交易所	C8	该字段可填：SHFE、INE、DCE、CZCE、CFFEX、GFEX。且必须是全匹配
investor_id	投资者ID	C16	该字段数组中目前只支持单值
product_id	品种ID	C8	该字段数组中目前只支持单值
prc	风控项	jsonArray
	enable	开关	enable(该字段保留，默认可为1):1：开；0：关
	value	配置值	value:0:允许交易 1:只能平仓 2:禁止交易
	prc_type	风控ID	prc_type（该字段保留，默认为TradingEnable）

注意：虽然请求中exchange、investor_id、product_id字段都是json数组，但只是为了考虑后期扩展用，暂时各数组中只需要填单个值即可

8.1.2 响应

JSON
{
   "client_version" : "1.2.1",
   "data" : {
      "code" : 0,
      "msg" : "Success!",
      "result" : [
         {
            "exchange" : "CFFEX",
            "investor" : "10101010",
            "product" : "1",
            "templ" : "test1",
            "trade_perm" : {
               "enable" : 1,
               "prc_name" : "交易权限",
               "prc_type" : "TradingEnable ",
               "value" : -1
            }
         }
      ]
   },
   "token" : "4967692b2fd646039c07ee80c5d9b2e8"
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
exchange	交易所	C8	该字段可填：SHFE、INE、DCE、CZCE、CFFEX、GFEX。且必须是全匹配
investor_id	投资者ID	C16	该字段数组中目前只支持单值
product_id	品种ID	C8	该字段数组中目前只支持单值
"templ	模版名
trade_perm:
prc_type	交易权限ID	C16
prc_name	交易权限名	C64
enable	交易权限开关	N1	1：开；0：关
value	配置值	N4	默认为-1，若为-1则表示该配置项只有开关，没有配置值，反之则存在配置值

9. 客户交易权限模版 /api/auth/trade

请求接收方：MA

Url：ip(MA所在机器的管理地址):8899/api/auth/trade

Http请求方式：见本章二级标题

9.1 查询客户交易权限模版（GET）

9.1.1 请求

JSON
{
    "client_version":"1.2.1",
    "token":" B8F43EAC8C1E94C65145BEF "
}

9.1.2 响应

JSON
{
   "client_version" : "1.0.1",
   "data" : {
      "code" : 0,
      "msg" : "Success!",
      "prcperm" : [
         {
            "enable" : 0,
            "exchange" : [ "SHFE" ],
            "hedge" : [ "投机" ],
            "investor" : [ "777001" ],
            "prc" : [
               {
                  "enable" : 1,
                  "prc_name" : "限制交易命令",
                  "prc_type" : " TradingEnable ",
                  "value" : 130
               }
            ], 
            "product_type" : ["期货"],
            "product" : [ "au", "am" ],
            "templ" : "210",
            "update_time" : "2023-02-14 10:03:31"
         }
      ]
   },
   "token" : " B8F43EAC8C1E94C65145BEF "
}

字段说明：

字段名	字段释义	数据类型	备注
templ	模版名称	C64	唯一
templ_new	新模版名称	C64	唯一，且只能用在修改接口中，如果该字段为空不填，则表示本次修改不修改模版名称
enable	状态	int	1：启动；0：禁用
trade	柜台	jsonArray	改字段是json对象的json数组，例如：trade:[ {"ip" :"192.168.2.58","name" : "cd118"}]name:柜台名ip:柜台IP约定：trade:[ {"ip" :“null-null”,"name" : “null-null”}]表示该字段不生效，即可忽略该字段
produtct_type	产品类型	jsonArray	改字段是字符串的json数组，例如：{product_type:[ "期货"]}[“null-null”]表示该字段不生效，即可忽略该字段；其中product_type数组的可取值范围包括：“期货”,”期权”,”组合”,”即期”,”期转现”,”股指期权”，其他值不识别
product	品种	jsonArray	改字段是字符串的json数组，例如：{product:[“au”,”fm”]}[“null-null”]表示该字段不生效，即可忽略该字段
investor	投资者	jsonArray	改字段是字符串的json数组，例如：{investor:[“777001”,”777002”]}[“null-null”]表示该字段不生效，即可忽略该字段
hedge	投保标志	jsonArray	改字段是字符串的json数组，例如：{hedge:[“投机”,” 套利”]},一般默认只有一个“投机”，其它需要柜台支持。[“null-null”]表示该字段不生效，即可忽略该字段
exchange	交易所	jsonArray	改字段是字符串的json数组，例如：{exchange:[“SHFE”,”INE”]}其中exchange数组的可取值范围包括：“SHFE”,”INE”,”DCE”,”CZCE”,”CFFEX”,”GFEX” ，其他值不识别[“null-null”]表示该字段不生效，即可忽略该字段
prc	风控项	jsonArray	enable(该字段保留，默认可为1):1：开；0：关value:0:允许交易 1:只能平仓 2:禁止交易prc_type字段默认固定取值：” TradingEnable”prc_name字段默认固定取值：“限制交易命令”
	enable	开关
	value	配置值
	prc_type	风控ID
	prc_name	风控名		其他值不识别

9.2 新增交易权限模版（POST）

9.2.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"210",
                "priority":1022,
                "enable":0,
                "exchange":["SHFE"],
                "investor":["777001"],
                "product":["au","am"],
                 "product_type" : ["期货"],
                "hedge":["投机"],
                "prc":[
                    {
                        "prc_type":"TradingEnable",
                        "enable":1,
                        "value":-1
                    }
                ]
            }
        ]
    }
}

字段说明：

sync_flag表示是否将模版同步到柜台，1：表示同步，0：不同步;建议该字段置为1表示同步到柜台，因为这些配置最终是要在柜台端生效。目前prc字段的数组中默认固定为{"prc_type":"TradingEnable ","enable":1, "value":130}一个json对象，且prc_type字段值不可修改固定为TradingEnable，enable和value可修改。其他字段的说明参考《查询客户交易权限模版（GET）》章节

9.2.2 响应

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data" : {
      "code" : 0,
      "msg" : "Success!" ,
      "comment" : [
{
            "result" : {
               "code" : -2,
               "message" : "柜台离线",
               "product" : "---"
            },
            "trade" : "cd118"
         }
]
   }
}

注意：

1） code字段值为0，表示模版配置操作已完成，因可能存在有些柜台配置失败的情况，例如：柜台离线、柜台不支持该接口等，故当柜台模版配置失败时，MA则会将配置出错的柜台的具体信息放在comment数组中返回。

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
code	错误码	N4	柜台执行模版的错误码
message	错误描述	C1024	执行出错时具体原因
product	产品信息	C128	主要是版本信息（暂时可忽略此字段）
trade	柜台名	C128

2）若code不为0，则没有comment数组。

9.3 修改交易权限模版（PUT）

9.3.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"210",
                "templ_new":"",
                "priority":1022,
                "enable":0,
                "exchange":["SHFE"],
                "investor":["777001"],
                "product":["au","am"],
                 "product_type" : ["期货"],
                "hedge":["投机"],
                "prc":[
                    {
                        "prc_type":"TradingEnable",
                        "enable":1,
                        "value":130
                    }
                ]
            }
        ]
    }
}

字段说明：

sync_flag表示是否将模版同步到柜台，1：表示同步，0：不同步。目前prc字段的数组中默认固定为{"prc_type":"TradingEnable","enable":1, "value":130}一个json对象，且prc_type字段值不可修改，enable和value可修改。其他字段的说明参考《查询交易权限模版（GET）》章节。

9.3.2 响应

参考《新增交易权限模版》的响应章节。

9.4 删除交易权限模版（DELETE）

9.4.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"210"
            }
        ]
    }
}

字段说明：

参考《新增客户交易权限模版》章节的字段说明。

9.4.2 响应

参考《新增交易权限模版》的响应章节。

10. 授权码 /api/trade/authentication/code

请求接收方：MA

Url：ip(MA所在机器的管理地址):8899/api/trade/authentication/code

Http请求方式：见本章二级标题

10.1 查询授权码（GET）

10.1.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
}

10.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": [
            {
                "allow_investor" : [],
                "app_id": "1",
                "auth_code": "2",
                "unique_id": 0,
                "update_time": "2022-03-25 17:16:13"
            },
            {
                "allow_investor" : ["12345678","67890"],
                "app_id": "1234",
                "auth_code": "1234",
                "unique_id": 1,
                "update_time": "2022-04-21 10:47:51"
            }
        ]
    },
    "client_version":"1.0.1",
    "token": "4967692b2fd646039c07ee80c5d9b2e8"
}

字段说明：

*字段名*	*字段释义*	*数据类型*	*备注*
unique_id	此条记录唯一ID	uN4
auth_code	鉴权码	C16
allow_investor	投资者列表	Array	默认包括所有投资者：[] 未指定任何投资者：["null-null"] 指定具体投资者： ["12345678","12378"]
app_id	appid	C28
update_time	更新时间	C20	2022-03-04 15:30:23

10.2 新增授权码（POST）

10.2.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
    "data":{
    "allow_investor" : ["12345678"],
    "app_id": "120034",
    "auth_code": "120034"
    }
}

字段说明：

字段allow_investor的详细说明参考《查询授权码》的请求章节。

*字段名*	*字段释义*	*数据类型*	*备注*
auth_code	鉴权码	C16
app_id	appid	C28

10.2.2 响应

参考《公共字段说明》章节。

10.3 修改授权码（PUT）

10.3.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
    "data":[{
    "unique_id":1,
    "app_id": "1234",
    "allow_investor" : ["12345678"],
    "auth_code": "1234"
  }]
}

字段说明：

字段allow_investor的详细说明参考《查询授权码》的请求章节。

*字段名*	*字段释义*	*数据类型*
unique_id	此条记录唯一ID	uN4
auth_code	鉴权码	C17
app_id	appid	C29

10.3.2 响应

参考《公共字段说明》章节。

10.4 删除授权码（DELETE）

10.4.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
"data":{
    "app_id": "120034",
    "auth_code": "120034"
  }
}

10.4.2 响应

格式及内容与新增授权码响应一致。

11. 交易汇总信息 /api/trade/statistic/info

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/statistic/info

Http请求方式：见本章二级标题

11.1 查询交易汇总信息（GET）

11.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"4967692b2fd646039c07ee80c5d9b2e8",
    "serialno":12,
    "operator":"admin",
            "data":{
            "content":"",
            "option_scale":{
                "investor_id":true,
                "investor_name":true,
                "exchange_id":true,
                "order_volume_total":true,
                "order_times":true,
                "action_volume_total":true,
                "action_times":true,
                "bargin_volume_total":true,
                "bargin_times":true,
                "nobargin_volume_total":true,
                "error_volume_total":true,
                "bargin_rates":true,
                "action_rates":true,
                "instrument_amount":true,
                "trading_day":true
                }
            }
}

字段说明：

字段名	字段释义	数据类型	备注
content	模糊搜索的关键字	C64	为了检索的准确性，请输入尽可能贴近结果的关键字
investor_id	投资者账号	B	true:选中此列作为搜索限制条件；false：不选中此列作为搜索限制条件。*以下行字段类型类同：*
investor_name	投资者姓名	B
exchange_id	交易所	B
order_volume_total	报单手数	B
order_times	报单笔数	B
action_volume_total	撤单手数	B
action_times	撤单笔数	B
bargin_volume_total	成交手数	B
bargin_times	成交笔数	B
nobargin_volume_total	未成交单手数	B
error_volume_total	错单手数	B
bargin_rates	成交率	B
action_rates	撤单率	B
instrument_amount	交易合约数	B
trading_day	日期

11.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": [
            {
                "ActionRates": "0.00",
                "ActionTimes": "0",
                "ActionVolumeTotal": "4",
                "BarginRates": "0.00",
                "BarginTimes": "2",
                "BarginVolumeTotal": "0",
                "ErrorVolumeTotal": "0",
                "ExchangeId": "SHFE",
                "InsturmentAmount": "0",
                "InvestorId": "7770012",
                "InvestorName": "李四",
                "NobarginVolumeTotal": "0",
                "OrderTimes": "1",
                "OrderVolumeTotal": "1",
                "TradingDay": "20220507"
            }
        ]
    },
    "operator": "admin",
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "4967692b2fd646039c07ee80c5d9b2e8"
}

字段说明：

字段名	字段释义	数据类型	备注
content	模糊搜索的关键字	C64	为了检索的准确性，请输入尽可能贴近结果的关键字
InvestorId	投资者账号	C64	以下行字段（除投保外）均是数值型的*字符串，例如：”101.0003”：*
InvestorName	投资者姓名	C64
ExchangeId	交易所	C64
OrderVolumeTotal	报单手数	C64
OrderTimes	报单笔数	C64
ActionVolumeTotal	撤单手数	C64
ActionTimes	撤单笔数	C64
BarginVolumeTotal	成交手数	C64
BarginTimes	成交笔数	C64
NobarginVolumeTotal	未成交单手数	C64
ErrorVolumeTotal	错单手数	C64
BarginRates	成交率	C64
ActionRates	撤单率	C64
InsturmentAmount	交易合约数	C64
TradingDay	日期	C64

12. 系统监控：/api/trade/system/info

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/system/info

Http请求方式：见本章二级标题

12.1 系统监控查询（GET）

12.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"ED707C6A0C3D87FFD7BA92C59DD8AAEF388F218CA03568E48E",
    "serialno":12,
    "operator":""
}

12.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": {
            "CpuName": "Intel(R) Xeon(R) CPU E5-2643 v3 @ 3.40GHz",
            "CpuNum": 12,
            "CpuTempl": 41,
            "CpuUsage": 0,
            "DiskUsage": 27,
            "OsRunTime": "1天1时10分28秒",
            "OsRunTimeFigure": {
                "Days": 1,
                "Hours": 1,
                "Mins": 10,
                "Secs": 28
            },
            "XtfServer": "",
            "XtfVersion": "xtf-v41-beta-011-20220825"
        }
    },
    "operator": "",
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": " ED707C6A0C3D87FFD7BA92C59DD8AAEF388F218CA03568E48E "
}

字段说明：

字段名	字段释义	数据类型	备注
CpuName	CPU型号	C32	字符型
CpuNum	CPU核数	N4
CpuTempl	CPU温度	N4.2
CpuUsage	CPU使用率	N4.2
DiskUsage	磁盘使用率	N4.2
OsRunTime	系统运行时间	C64
OsRunTimeFigure	系统运行时间	Array	此字段值选用已运行时间按：Days：天；Hours：小时Mins：分钟Secs：秒
XtfServer	服务器名称	C32	预留
XtfVersion	柜台版本	C32

13. 柜台监控：/api/trade/xtfsystem/info

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/xtfsystem/info

Http请求方式：见本章二级标题

13.1 柜台监控查询（GET）

13.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"9881D6531489BBE7C68FC848FF73F580",
    "serialno":12,
    "operator":""
}

13.1.2 响应

JSON
{
    "data": {
        "code": 0,
        "message": "成功",
        "result": {
            "CancelTimesSum": 2210,
            "ErrorVolumeSum": 1218352031,
            "ExchangeId": "GFEX",
            "OrderTimesSum": 147840,
            "TradeVolumeSum": 7017,
            "Xbm": {
                "ErrMsg": "备份进程未启动",
                "Status": false
            },
            "Xtf": {
                "ErrMsg": "柜台未启",
                "Status": false
            }
        }
    },
    "operator": "",
    "protocl_version": "1.0.1",
    "serialno": 12,
    "token": "9881D6531489BBE7C68FC848FF73F580"
}

字段说明：

字段名	字段释义	数据类型	备注
CancelTimesSum	撤单笔数	Node	当前实时最新值
ErrorVolumeSum	错单手数	N4	当前实时最新值
TradeVolumeSum	成交手数	N4	当前实时最新值
OrderTimesSum	报单笔数	N4	当前实时最新值
ExchangeId	交易所	C8
Xbm	主备管理程序运行状态	C64	Status：true：运行正常;fasle：运行异常;ErrMsg：异常原因
Xtf	柜台程序运行状态	C64	Status：true：运行正常;fasle：运行异常;ErrMsg：异常原因

14. 报单记录：/api/trade/xtfsystem/history

请求接收方：MS

Url：ip(MS所在柜台的管理地址):8181/api/trade/xtfsystem/history

Http请求方式：见本章二级标题

14.1 查询报单记录（GET）

14.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"4FC63C00F215101B940C1B1A6056B92B8645066B",
    "serialno":12,
    "operator":""
}

14.1.2 响应

返回结果若存在，则可按行取，反之则为空，例如：

JSON
2023-01-05 12:19:18|10|6|0|3
2023-01-05 12:19:28|10|6|0|3
2023-01-05 12:19:38|10|6|0|3
2023-01-05 12:19:48|10|6|0|3
2023-01-05 12:19:58|10|6|0|3
2023-01-05 12:20:08|10|6|0|3
2023-01-05 12:20:18|10|6|0|3
...

字段说明：

每一行表示在某个时刻，柜台的报单笔数、撤单笔数、成交笔数和错单手数，字段之间用“|”符号间隔。

15. 风控权限模板：/api/auth/prc

请求接收方：MA

Url：ip(MA所在机器的管理地址):8899/api/auth/prc

Http请求方式：见本章二级标题

注意事项：

1）风控权限模版配置是针对web管理的所有柜台，模版中任一个字段改动都会触发web后台向所有柜台同步的操作，即所有被管理的柜台均会收到模版的改动，因此每次进行风控模版配置时需要谨慎操作，避免因配置不当而影响其它正常运行的柜台；

2）因为风控权限配置都是要在各个柜台端实时生效的，为了不影响盘中柜台的执行，切勿频繁的进行配置操作。

15.1 查询风控权限模板（GET）

15.1.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53"
}

15.1.2 响应

JSON
{
   "client_version" : "1.0.1",
   "data" : {
      "code" : 0,
      "msg" : "Success!",
      "prcperm" : [
         {
            "enable" : 1,
            "exchange" : [],
            "hedge" : [],
            "instrument" : [],
            "investor" : [null],
            "update_time" : "2023-02-09 14:24:11",
            "prc" : [
               {
                 "enable" : 200,
                  "prc_name" : "资金可用限度",
                  "prc_type" : "AvaiableLimit",
                  "value" : 1               
}
            ], 
            "product_type" : ["期货"],
            "priority" : 1,
            "product" : [],
            "templ" : "默认模板",
            "trade" : [
               {
                  "ip" : "192.168.2.58",
                  "name" : "cd118"
               }]
         }
      ]
   },
   "token" : "679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53"
}

字段说明：

字段名	字段释义	数据类型	备注
templ	模版名称	C64	唯一
priority	优先级	int	默认取值范围(-1024,0)U(0,1024)，当为负数时表示在本优先级之前添加/修改
enable	状态	int	1：启动；0：禁用
trade	柜台	jsonArray	改字段是json对象的json数组，例如：trade:[ {"ip" :"192.168.2.58","name" : "cd118"}]name:柜台名ip:柜台IP约定：trade:[ {"ip" :“null-null”,"name" : “null-null”}]表示该字段不生效，即可忽略该字段
produtct_type	产品类型	jsonArray	改字段是字符串的json数组，例如：{product_type:[ "期货"]}product_type取值："期货","即期","期权","期转现","组合","股指期权"[“null-null”]表示该字段不生效，即可忽略该字段
product	品种	jsonArray	改字段是字符串的json数组，例如：{product:[“au”,”fm”]}[“null-null”]表示该字段不生效，即可忽略该字段
instrument	合约	jsonArray	改字段是字符串的json数组，例如：{instrument:[“au001”,”au002”]}[“null-null”]表示该字段不生效，即可忽略该字段
investor	投资者	jsonArray	改字段是字符串的json数组，例如：{investor:[“777001”,”777002”]}[“null-null”]表示该字段不生效，即可忽略该字段
hedge	投保标志	jsonArray	改字段是字符串的json数组，例如：{hedge:[“投机”,” 套利”]},一般都是“投机”。[“null-null”]表示该字段不生效，即可忽略该字段
exchange	交易所	jsonArray	改字段是字符串的json数组，例如：{exchange:[“SHFE”,”INE”]}exchange取值："DCE","SHFE","INE" ,"CZCE","CFFEX","GFEX"[“null-null”]表示该字段不生效，即可忽略该字段
prc	风控项	jsonArray
	enable	开关	enable:1：开；0：关
	value	配置值
	prc_type	风控ID	prc_type:
	prc_name	风控名
	*prc中包涵的具体风控项及取值：*
	prc_type	prc_name	enable	value
	PriceCheckEnable	检查报单价格在涨跌停范围内	1：开；0：关	-1
	SelfDealEnable	拦截自成交订单	1：开；0：关	-1
	CancelLimitByPro	检查品种撤单笔数上限	1：开；0：关	[0-65535]，默认3000
	LongPositionLimitByPro	检查品种多仓手数上限	1：开；0：关	[0-65535]，默认3000
	ShortPositionLimitByPro	检查品种空仓手数上限	1：开；0：关	[0-65535]，默认3000
	TradeLimitByPro	检查品种开仓成交手数上限	1：开；0：关	[0-65535]，默认3000
	CancelLimitByIns	检查合约撤单笔数上限	1：开；0：关	[0-65535]，默认1000
	LongPositionLimitByIns	检查合约多仓手数上限	1：开；0：关	[0-65535]，默认1000
	ShortPositionLimitByIns	检查合约空仓手数上限	1：开；0：关	[0-65535]，默认1000
	TradeLimitByIns	检查合约开仓成交手数上限	1：开；0：关	[0-65535]，默认1000
	OpenLimit	检查单笔开仓手数上限	1：开；0：关	[0-65535]，默认1000
	LargeOrderCancel	大额撤单	1：开；0：关	固定0，该字段存在时，LargeOrderCancelOrderNum和LargeOrderCancelFixedRatio字段一定存在
	LargeOrderCancelOrderNum	大额撤单单笔最大报单量	1：开；0：关	[0-65535]，默认800，注意：只有当LargeOrderCancel存在时该字段才有效
	LargeOrderCancelFixedRatio	大额撤单固定比例	1：开；0：关	[0-100]，默认100，注意：只有当LargeOrderCancel存在时该字段才有效
	PriceDeviation	价格偏离度	1：开；0：关	固定0，该字段存在时，PriceDeviationCoefficient和PriceDeviationAbsoluteValue字段一定存在
	PriceDeviationCoefficient	价格偏离度系数	1：开；0：关	[0-100]，默认0，注意：只有当PriceDeviation存在时该字段才有效
	PriceDeviationAbsoluteValue	价格偏离度绝对值	1：开；0：关	[0- 9999999999999]，默认0，该值是由浮点型*10000计算出，例如：实际值为190.8921，需将其乘10000后转化为整型作为该字段的值。注意：只有当PriceDeviation存在时该字段才有效
	LongOptPosLimit	检查期权月份多仓手数上限	1：开；0：关	[0,65535]，默认值为2000手
	ShortOptPosLimit	检查期权月份空仓手数上限	1：开；0：关	[0,65535]，默认值为2000手
	LongFutOptPosLimit	检查期货期权联合多仓手数上限	1：开；	[0,65535]，默认值为2000手
	ShortFutOptPosLimit	检查期货期权联合空仓手数上限	0：关	[0,65535]，默认值为2000手

15.2 添加风控权限模板（POST）

15.2.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"2",
                "priority":2,
                "enable":0,
                "exchange":["SHFE"],
                "trade":["118","119"],
                "investor":["777001"],
                "product":["au","am"],
                "product_type" : ["期货"],
                "instrument":["au001","au002"],
                "hedge":["投机"],
                "prc":[
                    {
                        "prc_type":" AvaiableLimit",
                        "enable":1,
                        "value":13
                    }
                ]
            }
        ]
    }
}

字段说明：

sync_flag表示是否将模版同步到柜台，1：表示同步，0：不同步；其它字段请参考《查询风控权限》的字段说明表；

15.2.2 响应

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data" : {
      "code" : 0,
      "msg" : "Success!" ,
      "comment" : [
        {
            "result" : {
               "code" : -2,
               "message" : "柜台离线",
               "product" : "---"
            },
            "trade" : "cd118"
         }
    ]
   }
}

注意：

3） code字段值为0，表示模版配置操作完成，因可能存在有些柜台配置失败的情况，故当柜台模版配置失败时，MA则会将配置出错的柜台的具体信息放在comment数组中返回。

字段说明：

字段名	字段释义	数据类型	备注
code	错误码	N4	柜台执行模版的错误码
message	错误描述	C1024	执行出错时具体原因
product	产品信息	C128	主要是版本信息（暂时可忽略此字段）
trade	柜台名	C128

4） code不为0，则没有comment数组。

15.3 修改风控权限模板（PUT）

15.3.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"2",
                "templ_new":"",
                "priority":2,
                "enable":0,
                "exchange":["SHFE"],
                "trade":["118","119"],
                "investor":["777001"],
                "product":["au","am"],
                "product_type" : ["期货"],
                "instrument":["au001","au002"],
                "hedge":["投机"],
                "prc":[
                    {
                        "prc_type":"AvaiableLimit",
                        "enable":1,
                        "value":13
                    }
                ]
            }
        ]
    }
}

字段说明：

如果需要修改默认名称，则将待修改新模版名放入templ_new字段，若模版名不做修改，则改字段值默认填空即"templ_new":"",其它字段说明参考《添加风控权限》章节的字段说明。

15.3.2 响应

参考《添加风控权限》章节。

15.4 删除风控权限模板（DELETE）

15.4.1 请求

JSON
{
    "client_version":"1.0.1",
    "token":"679EC666E5922BA55595F3508B4C288B9B32621FF69D503F53",
    "data":{
        "sync_flag":1,
        "template":[
            {
                "templ":"2"
            }
        ]
    }
}

字段说明：

参考《添加风控权限》章节的字段说明。

15.4.2 响应

参考《添加风控权限》。

16. 报单查询：/api/trade/order/query

请求接收方：MS

Url：ip(MS所在机器的管理地址):8181/api/trade/order/query

Http请求方式：见本章二级标题

16.1 报单查询（GET）

16.1.1 请求

JSON
{
    "protocl_version":"1.0.1",
    "token":"A3055FFDB237C33C99E1669BC688913365CD126164E36D1",
    "serialno":12,
    "operator":"",
    "data":{
            "content":"",
            "max_result_count":0,
            "investor_id":["777001","777002"],
            "order_system_id":{"min":0,"max":999999}, 
            "order_user_id":{"min":0,"max":9999999999}, 
            "exchange_order_id":{"min":"0","max":"999999"},
            "userref":{"min":null,"max": null },
            "seat_id":["0081c1","0081c2"],
            "instrument_id":["si0012","su0012"],
            "direction":["买","卖"],
            "order_type":["正常","报价衍生","组合衍生"],
           "delegate_type":["限价GFD"],
            "comb_offset_flag":["开仓","平仓"],
            "order_status":["全部成交"],
            "order_price":{"min":0,"max":226.8},
            "order_volume":{"min":0,"max":200},
            "nobargin_volume":{"min":0,"max":200},
            "bargin_volume":{"min":0,"max":200},
            "order_time":{"min":"10:09:35","max":"10:11:35"},
            "insert_time":{"min":"2022-01-10 10:09:35","max":"2022-11-10 10:11:35"},
            "error_code":{"min":2001,"max":2002},
            "error_msg":"xxxx",
            "appid":"xxxx",
            "trading_day":"20221202",
            "update_time":{"min":"2022-01-10 10:09:35","max":"2022-11-10 10:11:35"},
            "hedge_flag":["投机","套利"]
        }
}

字段说明：

字段名	字段释义	数据类型	备注
investor_id	投资者账号	C12	数组
content	模糊搜索内容	C1024	字符串
max_result_count	查询条数	N4	为0表示返回结果不限制，大于0表示从已查询结果中返回指定数量的最新的查询结果。
order_system_id	柜台报单编号	uN4	柜台报单编号是4字节无符号整型
	min	最小编号
	max	最大编号
exchange_order_id	交易所报单编号	C32	交易所报单编号是8字节无符号整型，因数值可能会比较大，为了方便处理，这里采用字符串类型存放，例如:{”min”:”1”,”max”:”9999”}
	min	最小编号
	max	最大编号
userref	用户自定义	uN4	该min和max字段取值为整型
	min	最小值
	max	最大值
order_user_id	客户报单编号	N4	该min和max字段取值为整型
	min	最小值
	max	最大值
seat_id	委托席位	C12	数组
instrument_id	合约	C12	数组
direction	买卖	C12	此字段取值：“买”或者“卖”
order_type	报价类型	C12	该字段取值：“正常”“报价衍生”“组合衍生”
delegate_type	委托类型	C32	该字段取值：“限价GFD”、“限价FAK”、“限价FOK”、“GIS”
comb_offset_flag	开平	C12	此字段取值：“开仓”“平仓”“平今”“平昨”
order_status	状态	C12	此字段取值：“全部成交”“部分成交还在队列”“部分成交不在队列”“未成交还在队列”“未成交不在队列”“错单”“撤单”
order_price	报单价格	N8.4	该min和max字段取值为浮点型
	min	最低价格
	max	最高价格
order_volume	报单手数	N4	该min和max字段取值为整型
	min	最小手数
	max	最大手数
nobargin_volume	未成交手数	N4	该min和max字段取值为整型
	min	最小手数
	max	最大手数
bargin_volume	成交手数	N4	该min和max字段取值为整型
	min	最小手数
	max	最大手数
order_time	报单时间	C12	此字段取值格式：“15:27:02”
	min	时间下限
	max	时间上限
insert_time	插入时间	C12	此字段取值格式：“2022-10-25 14:29:31.071”
	min	时间下限
	max	时间上限
error_code	错误码	N4	错误码搜索范围在min和max之间
	min	最小值
	max	最大值
error_msg	详细信息	C12
appid	AppID	C64
trading_day	交易日	C12	该字段取值格式：“20221110”
update_time	最后更新时间	C12	此字段取值格式：“2022-10-25 14:29:31.071”
	min	时间下限
	max	时间上限
hedge_flag	投保	C12	该字段取值：“投机”“套利”“套保”“做市商”

16.1.2 响应

该请求响应主要由*响应头***和*响应内容***两个部分组成，详细描述参见《持仓查询》的响应章节。

1）响应头

JSON
MS,OrderQry,1.0.3,25,20       ,InvestorId | OrderSysId | OrderUserId | ExchangeOrderId | UserRef | AppID | MFL | SeatId | InstrumentId | Direction | CombOffsetFlag | OrderStatus | OrderType | DelegateType | OrderPrice | OrderVolume | NobarginVolume | BarginVolume | TradingDay | HedgeFlag | OrderTime | InsertTime |UpdateTime | ErrCode | ErrMsg

2）响应内容

该请求响应是按行且每行以“|”符号分割的方式进行传输，有多少单就对应多少行的数据；具体数据格式如下：

JSON
InvestorId | OrderSysId | OrderUserId | ExchangeOrderId | UserRef | AppID | MFL | SeatId | InstrumentId | Direction | CombOffsetFlag | OrderStatus | OrderType | DelegateType | OrderPrice | OrderVolume | NobarginVolume | BarginVolume | TradingDay | HedgeFlag | OrderTime | InsertTime | UpdateTime | ErrCode | ErrMsg  

字段说明：

字段名	字段释义	数据类型	备注
content	模糊搜索的关键字	C64	为了检索的准确性，请输入尽可能贴近结果的关键字
InvestorId	投资者账号	C64	以下行字段（除投保外）均是数值型的*字符串，例如：”101.0003”：*
OrderSysId	柜台报单编号	C64
OrderUserId	客户报单编号	C64	003版本引入，之前版本无此字段
ExchangeOrderId	交易所报单编号	C64
UserRef	用户自定义列	C64	007版本引入，之前版本无此字段
OrderType	报单类型	C64	003版本引入，之前版本无此字段
DelegateType	委托类型	C64	007P7版本引入，之前版本无此字段
AppID	AppID	C64	007P7版本引入，之前版本无此字段
MFL	本柜台标记	C64	1：本柜台；0：非本柜台
SeatId	委托席位	C64
InstrumentId	合约	C64
Direction	买卖	C64
CombOffsetFlag	开平	C64
OrderStatus	状态	C64
OrderPrice	报单价格	C64
OrderVolume	报单手数	C64
NobarginVolume	未成交手数	C64
BarginVolume	成交手数	C64
OrderTime	报单时间	C64
InsertTime	插入时间	C64
ErrCode	错误码	C64
ErrMsg	详细信息	C64
TradingDay	交易日	C64
UpdateTime	最后更新时间	C64
HedgeFlag	投保	C64