https://www.youquant.com/api/v1?中，?符号后跟请求参数。使用Python语言描述请求参数： {
'version' : '1.0',
'access_key': 'xxx', # AccessKey，在账户管理页面申请
'method' : 'GetNodeList', # 具体调用的方法
'args' : [], # 具体调用的method方法的参数列表
'nonce' : 1516292399361, # 时间戳，单位毫秒，允许和标准时间时间戳前后误差1小时，nonce必须比上一次访问时的nonce数值大
'sign' : '085b63456c93hfb243a757366600f9c2' # 签名
}
各个参数以字符&分隔，参数名和参数值用符号=连接，完整的请求URL（method=GetNodeList为例）：
https://www.youquant.com/api/v1?
access_key=xxx&
nonce=1516292399361&
args=%5B%5D&
sign=085b63456c93hfb243a757366600f9c2&
version=1.0&
method=GetNodeList
注意请求参数中没有secret_key这个参数。
- 签名方式
请求参数中sign参数加密方式如下，按照格式：
version + "|" + method + "|" + args + "|" + nonce + "|" + secretKey
拼接字符串后，使用MD5加密算法加密字符串，并转换为十六进制数据字符串，该值作为参数sign的值。签名部分参考Python代码，扩展API接口「验证方式」：
# 参数
d = {
'version': '1.0',
'access_key': accessKey,
'method': method,
'args': json.dumps(list(args)),
'nonce': int(time.time() * 1000),
}
# 计算sign签名
d['sign'] = md5.md5(('%s|%s|%s|%d|%s' % (d['version'], d['method'], d['args'], d['nonce'], secretKey)).encode('utf-8')).hexdigest()
{
"code":0,
"data":{
"result":null,
"error":"Params length incorrect"
}
}
```JSON
{
"code": 0,
"data": {
"result": {
"all": 1,
"nodes": [{
"build": "3.7",
"city": "...",
"created": "2024-10-10 22:58:30",
"date": "2024-11-25 13:30:50",
"forward": "...",
"guid": "...",
"host": "node.youquant.com:9902",
"id": 123,
"ip": "...",
"is_owner": true,
"loaded": 1,
"name": "linux",
"online": true,
"os": "linux/amd64",
"peer": "...",
"public": 0,
"region": "...",
"tunnel": false,
"version": "...",
"wd": 0
}]
},
"error": null
}
}
返回值字段说明（字面意思较明显的不再赘述）：
- all: 当前账户关联的托管者数量。
- nodes: 记录托管者节点详细信息。
- build: 版本号。
- city: 所在城市。
- is_owner: true表示是私有托管者，false表示是公共托管者。
- loaded: 负载，搭载策略实例的个数。
- public: 0表示私有托管者，1表示公共托管者。
- region: 地理位置。
- version: 托管者详细版本信息。
- wd: 是否开启离线报警，0表示未开启。
一键部署的托管者包含一些额外信息，字段以ecs_、unit_前缀开头，记录了一键部署托管者服务器的相关信息（运营商名称、配置、状态等），计费周期、价格等信息，不再赘述。
无参数
```JSON
{
"code":0,
"data":{
"result":{
"items":[{
"id":2426,
"name":"C++实盘"
}]
},
"error":null
}
}
无参数
### GetPlatformList
```GetPlatformList```方法用于获取请求中的```API KEY```对应的优宽量化交易平台账号下的已添加的交易所列表。
```JSON
{
"code": 0,
"data": {
"result": {
"all": 1,
"platforms": [{
"category": "商品期货",
"date": "2024-04-23 13:38:24",
"eid": "Futures_CTP",
"id": 123,
"label": "期货主席(看穿式监管)",
"logo": "...",
"name": "CTP协议",
"profiles": "...",
"stocks": ["FUTURES"],
"website": "http://www.sfit.com.cn/"
}]
},
"error": null
}
}
eid。无参数
```JSON
{
"code": 0,
"data": {
"result": {
"all": 1,
"concurrent": 0,
"robots": [{
"charge_time": 1729561129,
"date": "2024-09-26 21:34:28",
"end_time": "2024-10-22 09:12:47",
"fixed_id": 1666928,
"id": 473200,
"is_sandbox": 0,
"name": "测试",
"node_guid": "0a77f717c15843910863a4c1b2867ca2",
"node_id": 1666928,
"node_public": 0,
"profit": 123,
"public": 0,
"refresh": 1729559554000,
"start_time": "2024-10-11 13:38:49",
"status": 4,
"strategy_id": 399872,
"strategy_isowner": true,
"strategy_language": 0,
"strategy_name": "测试",
"strategy_public": 0,
"uid": "0a77f717c15843910863a4c1b2867ca2",
"wd": 0
}]
},
"error": null
}
}
group_id字段。分页查询偏移设置。
offset
false
number
分页查询长度设置。
length
false
number
指定所要查询的实盘状态，参考扩展API接口「实盘状态码」，传-1代表获取全部实盘。
robotStatus
false
number
指定所要查询的实盘自定义标签，可以筛选出这个标签的所有实盘。
label
false
string
查询关键字。
keyWord
false
string
以Python语言的扩展API接口「验证方式」为例：
```print(api('GetRobotList', 'member2'))```：把自定义标签为member2的实盘信息全部打印出来。
```print(api('GetRobotList', 0, 5, -1, 'member2'))```：分页从0到5列出来最多5个标签为member2的实盘。
### CommandRobot
```CommandRobot```方法用于向请求中的```API KEY```对应的优宽量化交易平台账号下的实盘发送交互命令，接收交互命令的实盘Id为```robotId```参数指定的实盘Id，交互命令由策略中调用的```GetCommand()```函数捕获返回。
```JSON
{
"code":0,
"data":{
"result":false,
"error":null
}
}
robotId
true
number
```cmd```参数是发送给实盘的交互指令，在实盘策略中的```GetCommand()```函数会捕获到该交互命令，触发策略的交互逻辑。在策略代码中具体实现交互逻辑，可以参看[优宽量化交易平台API手册](https://www.youquant.com/syntax-guide#fun_getcommand)中的```GetCommand()```函数。
cmd
true
string
实盘策略，假设这个策略实盘处于运行中，实盘Id为123：
```js
function main() {
while (true) {
var cmd = GetCommand()
if (cmd) {
Log(cmd)
}
Sleep(2000)
}
}
如果使用本章节的Python测试脚本，访问优宽量化交易平台的扩展API：api("CommandRobot", 123, "test command")。Id为123的实盘会收到交互指令：test command，然后通过Log函数输出打印出来。
```JSON
{
"code":0,
"data":{
"result":4,
"error":null
}
}
robotId
true
number
### RestartRobot
```RestartRobot```方法用于重启请求中的```API KEY```对应的优宽量化交易平台账号下的实盘，重启的实盘Id为```robotId```参数指定的实盘Id。
```JSON
{
"code":0,
"data":{
"result":1,
"error":null
}
}
robotId
true
number
实盘配置参数，```settings```参数格式如下：
```JSON
{
"appid":"test",
"args":[],
"exchanges":[
{"pair":"FUTURES","pid":123}
],
"name":"测试",
"node":123,
"period":60,
"strategy":123
}
Interval，重启策略时希望Interval设置为500，则args中包含：["Interval", 500]，即："args": [["Interval", 500]]。pid配置：{"pair":"FUTURES","pid":123}；pid可以通过GetPlatformList接口查询，返回的数据中id字段即为交易所pid。eid配置：{"eid":"Futures_CTP","meta":{},"pair":"FUTURES_CTP"}；传入的配置信息，优宽量化交易平台是不储存的。这些数据直接转发给托管者程序，所以每次创建或者重启实盘时必须配置该信息。meta具体格式参看：GetExchangeList接口返回的数据中的meta字段内容。
CTP协议为例，配置华安期货的信息，meta字段结构如下："meta":{
"AppID":"xxx",
"AuthCode":"xxx",
"BrokerId":"6020",
"ClientVer":"BT_T_V001",
"MDFront":"...",
"Name":"华安期货(看穿式监管)",
"Password":"xxx",
"TDFront":"...",
"Username":"xxx",
"V2":true
}
GetExchangeList接口返回的数据中required为真的配置项，在配置mata时不可为空。required为假的配置项在配置mata时可为空。例如上例中的AuthCode、Name。
Username: 资金账号。
Password: 资金账号的密码。GetStrategyList方法获取到。settings false JSON对象
如果是使用扩展API接口创建出的实盘，重启必须使用扩展API接口RestartRobot进行重启，并且必须传入settings参数。在平台页面上创建的实盘，可以通过扩展API接口重启或者点击实盘页面上的按钮重启，可以传settings参数或者不传settings参数，只传robotId这个参数，如果只传robotId参数，则按照当前实盘的设置启动实盘运行。
```JSON
{
"code": 0,
"data": {
"result": {
"robot": {
"charge_time": 1732520672,
"charged": 1184400,
"consumed": 87500000,
"date": "2021-10-29 16:14:56",
"debug": "{\"Nano\":1732518261405924960,\"Stderr\":\"\",\"Stdout\":\"\"}",
"end_time": "2024-11-25 15:04:21",
"favorite": {
"added": false,
"type": "R"
},
"fixed_id": 123,
"hits": 0,
"id": 123,
"is_deleted": 0,
"is_manager": true,
"is_sandbox": 0,
"name": "测试",
"node_id": 123,
"pexchanges": {
"-100": "Futures_CTP"
},
"phash": {},
"plabels": {
"-100": "Futures_CTP"
},
"priority": 0,
"profit": 0,
"public": 0,
"refresh": 1732518244000,
"robot_args": "[]",
"start_time": "2024-11-25 15:03:38",
"status": 4,
"strategy_args": "...",
"strategy_exchange_pairs": "[60,[-100],[\"FUTURES_CTP\"]]",
"strategy_id": 123,
"strategy_last_modified": "2024-10-10 18:09:05",
"strategy_name": "测试",
"strategy_public": "0",
"summary": "...",
"uid": "03dd49e1de9c29f7a02ae015c65ef136",
"username": "...",
"wd": 0
}
},
"error": null
}
}
{"-100":"Futures_CTP","-101":"Futures_CTP"}。
robotId
true
number
```strategy_exchange_pairs```属性说明，用以下数据为例：
```plaintext
[86400,[123456],["FUTURES"]]
其中第一个数据86400，代表实盘设置的默认K线周期为1天，即86400秒。
```["FUTURES"]```为实盘配置的交易所对象设置的交易对（按添加顺序与```eid```一一对应），```[86400,[123456],["FUTURES"]]```对应```[K线周期，交易所对象id列表，交易对列表]```。
### GetAccount
```GetAccount```方法用于获取请求中的```API KEY```对应的优宽量化交易平台账号的账户信息。
```JSON
{
"code":0,
"data":{
"result":{
"balance":52437600,
"concurrent":0,
"consumed":200647562400,
"currency":"CNY",
"email":"...",
"openai":false,
"settings":null,
"sns":{},
"uid":"...",
"username":"..."
},
"error":null
}
}
```isSummary```参数为```false```时，返回的数据：
```JSON
{
"code": 0,
"data": {
"result": {
"exchanges": [{
"category": "商品期货",
"eid": "Futures_CTP",
"id": 123,
"logo": "/upload/asset/236192b0caaca5fadf948.svg",
"meta": "...",
"name": "CTP协议",
"priority": 10,
"profiles": "...",
"stocks": "FUTURES",
"website": "http://www.sfit.com.cn/"
}]
},
"error": null
}
}
```JSON
{
"code": 0,
"data": {
"result": {
"exchanges": [{
"category": "商品期货",
"eid": "Futures_CTP",
"id": 123,
"logo": "/upload/asset/236192b0caaca5fadf948.svg",
"name": "CTP协议",
"priority": 10,
"website": "http://www.sfit.com.cn/"
}]
},
"error": null
}
}
isSummary
true
bool
### DeleteNode
```DeleteNode```方法用于删除请求中的```API KEY```对应的优宽量化交易平台账号的托管者节点，删除的托管者节点Id为```nid```参数指定的托管者Id。
```JSON
{
"code":0,
"data":{
"result":true,
"error":null
}
}
nid
true
number
### DeleteRobot
```DeleteRobot```方法用于删除请求中的```API KEY```对应的优宽量化交易平台账号下的实盘，删除的实盘Id为```robotId```参数指定的实盘Id。
```JSON
{
"code":0,
"data":{
"result":0,
"error":null
}
}
robotId
true
number
```deleteLogs```参数用于设置是否要删除实盘日志，如果传入真值（例如：```true```）即删除实盘日志。
deleteLogs
true
bool
### GetStrategyList
```GetStrategyList```方法用于获取平台策略信息。
```JSON
{
"code": 0,
"data": {
"result": {
"all": 1784,
"strategies": [{
"category": 1,
"date": "2024-11-24 00:36:01",
"description": "...",
"forked": 0,
"hits": 0,
"id": 401124,
"is_buy": false,
"is_owner": false,
"language": 2,
"last_modified": "2024-11-24 00:36:01",
"name": "C++商品期货高频交易策略Penny Jump|C++ CTP Penny Jump (Copy)",
"profile": {
"avatar": "...",
"nickname": "eway",
"uid": "cc381d795af0912b4fbe4a1bfe00583e"
},
"public": 0,
"tags": "",
"uid": "cc381d795af0912b4fbe4a1bfe00583e",
"username": "eway"
}]
},
"error": null
}
}
offset
true
number
```length```参数用于设置查询时的长度。
length
true
number
```strategyType```参数用于设置所要查询的策略类型。
- ```strategyType```参数设置```0```: 所有策略。
- ```strategyType```参数设置```1```: 已公开策略。
- ```strategyType```参数设置```2```: 待审核策略。
strategyType
true
number
```category```参数用于设置所要查询的策略种类。
- ```category```参数设置```-1```: 所有策略。
- ```category```参数设置```0```: 通用策略。
category
true
number
```needArgs```参数用于设置所要查询的策略是否有参数。
- ```needArgs```参数设置```0```: 所有策略。
needArgs
true
number
```language```参数用于设置所要查询的策略的编程语言。
- ```language```参数设置```0```: JavaScript语言。
- ```language```参数设置```1```: Python语言。
- ```language```参数设置```2```: C++语言。
- ```language```参数设置```3```: 可视化策略。
- ```language```参数设置```4```: My语言。
- ```language```参数设置```5```: PINE语言。
language
true
number
```kw```参数用于设置所要查询的策略的关键字。
- 设置空字符串即不使用关键字筛选。
kw
true
string
### NewRobot
```NewRobot```方法用于创建一个请求中的```API KEY```对应的优宽量化交易平台账号下的实盘。
```JSON
{
"code":0,
"data":{
"result":473823,
"error":null
}
}
实盘配置参数，settings参数格式如下：
{
"appid":"test",
"args":[],
"exchanges":[{"pair":"FUTURES","pid":123}],
"name":"测试",
"group":123,
"node":123,
"period":60,
"strategy":123
}
RestartRobot接口。settings true JSON对象
使用eid配置时，{"eid":"Futures_CTP","meta":{},"pair":"FUTURES_CTP"}；配置的敏感信息优宽量化交易平台是不储存的。这些数据直接转发给托管者程序，所以每次创建或者重启实盘时必须配置该信息。meta具体格式参看：GetExchangeList接口返回的数据中的meta字段内容。
以CTP协议为例，配置华安期货的信息，meta字段结构如下：
"meta":{
"AppID":"xxx",
"AuthCode":"xxx",
"BrokerId":"6020",
"ClientVer":"BT_T_V001",
"MDFront":"...",
"Name":"华安期货(看穿式监管)",
"Password":"xxx",
"TDFront":"...",
"Username":"xxx",
"V2":true
}
### PluginRun
```PluginRun```方法用于调用优宽量化交易平台的**调试工具**功能；仅支持JavaScript语言。
```JSON
{
"code":0,
"data":{
"result":"{\"logs\":[{\"PlatformId\":\"\",\"OrderId\":\"0\",\"LogType\":6,\"Price\":0,\"Amount\":0,\"Extra\":\"\",\"Currency\":\"\",\"Instrument\":\"\",\"Direction\":\"\",\"Time\":1732525620326},{\"PlatformId\":\"\",\"OrderId\":\"0\",\"LogType\":5,\"Price\":0,\"Amount\":0,\"Extra\":\"Hello FMZ\",\"Currency\":\"\",\"Instrument\":\"\",\"Direction\":\"\",\"Time\":1732525620330}],\"result\":\"\"}",
"error":null
}
}
调试工具中的设置参数，settings配置中包括了测试代码，在source属性中。settings参数格式如下：
{
"exchanges":[{"pair":"FUTURES","pid":123}],
"node":123,
"period":60,
"source":"function main() {Log(\"Hello FMZ\")}"
}
RestartRobot接口。settings true JSON对象
{"pid": 1234, "pair": "FUTURES"}
{"pid": 1223, "pair": "FUTURES"}
对于settings中的exchanges属性来说，在调用PluginRun方法时只用设置一个（在调试工具页面使用时也只支持一个交易所对象）。在settings里设置2个交易所对象不会引起报错，但是在代码中如果访问第二个交易所对象就会报错。
```JSON
{
"code": 0,
"data": {
"result": {
"chart": "",
"chartTime": 0,
"logs": [{
"Total": 8,
"Max": 94,
"Min": 87,
"Arr": []
}, {
"Total": 0,
"Max": 0,
"Min": 0,
"Arr": []
}, {
"Total": 0,
"Max": 0,
"Min": 0,
"Arr": []
}],
"node_id": 123,
"online": true,
"refresh": 1732520711000,
"status": 4,
"summary": "...",
"updateTime": 1732520715044,
"wd": 0
},
"error": null
}
}
robotId
true
number
```logMinId```参数用于指定Log日志的最小Id。
logMinId
true
number
```logMaxId```参数用于指定Log日志的最大Id。
logMaxId
true
number
```logOffset```参数用于设置偏移，由```logMinId```和```logMaxId```确定范围后，根据```logOffset```偏移（跳过多少条记录），开始作为获取数据的起始位置。
logOffset
true
number
```logLimit```参数用于设置确定起始位置后，选取的数据记录条数。
logLimit
true
number
```profitMinId```参数用于设置收益日志的最小Id。
profitMinId
true
number
```profitMaxId```参数用于设置收益日志的最大Id。
profitMaxId
true
number
```profitOffset```参数用于设置偏移（跳过多少条记录），作为起始位置。
profitOffset
true
number
```profitLimit```参数用于设置确定起始位置后，选取的数据记录条数。
profitLimit
true
number
```chartMinId```参数用于设置图表数据记录的最小Id。
chartMinId
true
number
```chartMaxId```参数用于设置图表数据记录的最大Id。
chartMaxId
true
number
```chartOffset```参数用于设置偏移。
chartOffset
true
number
```chartLimit```参数用于设置获取的记录条数。
chartLimit
true
number
```chartUpdateBaseId```参数用于设置查询更新后的基础Id。
chartUpdateBaseId
true
number
```chartUpdateDate```参数用于设置数据记录更新时间戳，会筛选出比这个时间戳大的记录。
chartUpdateDate
true
number
```summaryLimit```参数用于设置查询的状态栏数据字节数。查询实盘的状态栏数据，该参数类型为整型。设置0表示不需要查询状态栏信息，设置为非0表示需要查询的状态栏信息字节数（该接口不限制数据量，可以指定一个较大的summaryLimit参数来获取所有状态栏信息），状态栏数据储存在返回的数据的```summary```字段中。
summaryLimit
true
number
- 数据库中的策略日志表
返回数据中```logs```的属性值（数组结构）的第一个元素中（日志数据）```Arr```属性值描述如下：
```plaintext
'Arr': [
[12, 5, '', '', 0, 0, '[]', 1635495362912, '', ''],
[11, 3, 'Futures_Futu', '', 0, 0, 'Buy(1826.08, 1000): TrdMarket_CN: 缺少必要的参数: secMarket', 1635495362904, '', '']
]
|id|logType|eid|orderId|price|amount|extra|date|contractType|direction| |-|-|-|-|-|-|-|-|-|-| |12|5|“|”|0|0|‘[]’|1635495362912|“|”| |11|3|‘Futures_Futu’|“|0|0|‘Buy(1826.08, 1000): TrdMarket_CN: 缺少必要的参数: secMarket’|1635495362904|”|“|
```logType```值具体代表的日志类型描述如下：
| logType: | 0 | 1 | 2 | 3 | 4 | 5 | 6 |
| - | - | - | - | - | - | - | - |
| logType意义: | BUY | SALE | RETRACT | ERROR | PROFIT | MESSAGE | RESTART |
| 中文意义 | 买单类型日志 | 卖单类型日志 | 撤销 | 错误 | 收益 | 日志 | 重启 |
- 数据库中的收益图表日志表
该图表日志表数据与策略日志表中的收益日志一致。
```plaintext
"Arr": [
[202, 2515.44, 1575896700315],
[201, 1415.44, 1575896341568]
]
以其中一条日志数据为例：
[202, 2515.44, 1575896700315]
- 数据库中的图表日志表
```plaintext
"Arr": [
[23637, 0, "{\"close\":648,\"high\":650.5,\"low\":647,\"open\":650,\"x\":1575960300000}"],
[23636, 5, "{\"x\":1575960300000,\"y\":3.0735}"]
]
以其中一条日志数据为例：
[23637, 0, "{\"close\":648,\"high\":650.5,\"low\":647,\"open\":650,\"x\":1575960300000}"],
23637为日志Id，0为图表数据系列索引，最后的数据"{\"close\":648,\"high\":650.5,\"low\":647,\"open\":650,\"x\":1575960300000}"为日志数据，这条数据为图表上的K线数据。