文档版本: v1.2.2_23-05-30
接口协议: http/https
报文格式: json
报文编码: utf-8
币币接口地址: https://oapi.websea.com/
合约接口地址: https://coapi.websea.com/
关于token、secret-key申请和修改,请在“个人中心 - 开放接口”页面进行相关操作。
客户端请求交易接口,header均要带上Nonce,token,Signature参数。例如:
$header[] = 'Nonce: 1534927978_ab43c';
$header[] = 'Token: 57ba172a6be125cca2f449826f9980ca';
$header[] = 'Signature: v490hupi0s0bckcp6ivb69p921';
curl\_setopt\($ch\, CURLOPT\_HTTPHEADER\, $header\);
用户令牌,请在“个人中心 - 开放接口”查看。
随机数,客户端每次请求随机生成字符。生成规则,时间戳_5位随机字母或数字。如:1534927978_ab43c
注意:时间误差不能超过60秒,相同随机数只能被使用一次。
签名,使用$token,$secret_key,$nonce,$_POST,$_GET计算得出,服务端验证签名以确定请求是否来自用户。
def sign(Nonce,data=dict()):
tmp = list()
tmp.append(TOKEN)
tmp.append(SECRET)
tmp.append(Nonce)
for d,x in data.items():
tmp.append(str(d) + "=" + str(x))
return hashlib.sha1(''.join(sorted(tmp))).hexdigest()
private function signature($nonce)
{
$token = TOKEN;
$secret_key = SECRET-KEY;
$tmpArr = array($api_key,$secret_key,$nonce);
foreach($_GET as $k=>$v){
$tmpArr[] = $k."=".$v;
}
foreach($_POST as $k=>$v){
$tmpArr[] = $k."=".$v;
}
sort($tmpArr, SORT_STRING);
$tmpStr = implode( $tmpArr );
$signature = sha1( $tmpStr );
return $signature;
}
List paramArr = new ArrayList<>();
String token = "57ba172a6be125c";
String nonce = "1534927978_ab43c";
String secretKey = "ca2f449826f9980ca";
paramArr.add(token);
paramArr.add(secretKey);
paramArr.add(nonce);
//获取所有请求参数
Enumeration enu=request.getParameterNames();
while(enu.hasMoreElements()){
String paramKv = "";
String paramName=(String)enu.nextElement();
String paramVal=request.getParameter(paramName);
paramKv += paramName;
paramKv += "=";
paramKv += paramVal;
paramArr.add(paramKv);
}
Collections.sort(paramArr, new Comparator() {
@Override
public int compare(String o1, String o2) {
String str1=(String) o1;
String str2=(String) o2;
if (str1.compareToIgnoreCase(str2)<0){
return -1;
}
return 1;
}
});
//转连接字符串
String paramStr = String.join("", paramArr);
String signature =DigestUtils.sha1Hex(paramStr);
#假设:
$token = "57ba172a6be125c";
$secret_key = "ca2f449826f9980ca";
$nonce = "1534927978_ab43c";
#请求接口地址
/openApi/entrust/currentList
#提交参数
symbol = "BTC-USDT";
type = "1"
#排序后的字符串
1534927978_ab43c57ba172a6be125cca2f449826f9980casymbol=BTC-USDTtype=1
#sha1计算后:
$signature 为 731faa3d170bb746a767cea58ae563830594e1fe
errno | errmsg | 说明 |
---|---|---|
200 | ok | 请求成功 |
301 | Moved Permanently | 永久跳转 |
302 | Found | 临时跳转 |
304 | Not Modified | 文件已经存在。 |
403 | Forbidden | 拒绝访问。 |
404 | Not Found | 文件或接口不存在。 |
503 | Service Unavailable | 超过了访问次数限制。 |
errno | errmsg | 说明 |
---|---|---|
0 | success | 请求成功 |
20001 | request failure | 请求失败 |
20401 | no permission | 无权限 |
20500 | system error | 系统错误 |
20501 | base symbol error | 交易对不存在 |
20502 | base currency error | 币种不存在 |
20503 | base date error | 错误的日期格式 |
20504 | account frozen balance insufficient error | 余额不足 |
20505 | bad argument | 无效参数 |
20506 | api signature not valid | API签名错误 |
20507 | gateway internal error | 系统繁忙,请稍后再试 |
20508 | ad ethereum addresss | 请输入有效的以太坊地址 |
20509 | order accountbalance error | 账户余额不足 |
20510 | order limitorder price error | 限价单下单价格超出限制 |
20511 | order limitorder amount error | 限价单下单数量超出限制 |
20512 | order orderprice precision error | 下单价格超出精度限制 |
20513 | order orderamount precision error | 下单数量超过精度限制 |
20514 | order marketorder amount error | 市价下单数量超出限制 |
20515 | order queryorder invalid | 查询不到此条订单 |
20516 | order orderstate error | 订单状态错误 |
20517 | order datelimit error | 查询超出时间限制 |
50518 | order update error | 订单更新出错 |
20519 | the nonce has been used | 该nonce已使用过 |
20520 | nonce expires, please verify server time | nonce过期,请校验服务器时间 |
20521 | incomplete header parameters | header参数不全 |
20522 | not getting the current user | 未获取到当前用户 |
20523 | please authenticate | 请认证 |
20524 | btc account lockout | 账户锁定 |
20525 | get API Key error | 获取apikey出错 |
20526 | no query permission | 没有查询权限 |
20527 | no deal permission | 没有交易权限 |
20528 | no withdrawal permission | 没有提币权限 |
20529 | API Key expired | 该Api key已过期,请重新生成 |
20530 | no permission | 没有权限 |
#限频规则
接口名称 | 接口地址 | 限制频率 |
---|---|---|
查询24小时行情数据 | /openApi/market/detail | 100次/10s |
查询交易对精度 | /openApi/market/precision | 100次/10s |
查询24小时行情列表 | /openApi/market/24kline | 100次/10s |
查询kline | /openApi/market/kline | 100次/10s |
查询市场深度 | /openApi/market/depth | 100次/10s |
查询市场合并深度 | /openApi/market/gears_depth | 100次/10s |
查询市场成交 | /openApi/market/trade | 100次/10s |
查询系统支持交易对 | /openApi/market/symbols | 100次/10s |
我的资产 | /openApi/wallet/list | 100次/10s |
我的交易费率 | /openApi/entrust/rate | 100次/10s |
委托挂单 | /openApi/entrust/add | 100次/10s |
委托撤单 | /openApi/entrust/cancel | 100次/10s |
我的当前委托 | /openApi/entrust/currentList | 100次/10s |
我的历史委托 | /openApi/entrust/historyList | 100次/10s |
委托成交详情 | /openApi/entrust/detail | 100次/10s |
注:以上是每个接口最大访问频率,开放接口全局限制:10秒100次,(单个APIKEY维度限制,建议行情API访问也要加上签名,否则限频会更严格),请合理使用访问额度。
#!/usr/bin/env python2 #encoding=utf8import sys
reload(sys)
sys.setdefaultencoding('utf-8')
import json
import time
import hashlib
import requests
import random
import stringTOKEN = "5c9dc98fb92e2"
SECRET = "hkyavn13ybc1qunp4rpb"
HOST = "http://api.xxx.com""""
request用法说明args = dict()
args['url'] = 'http://blog.csdn.net/iloveyin/article/details/21444613'
args['method'] = 'GET'
args['cookies'] = {}
args['data'] = {}
args['header'] = {"user-agent":"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)"}
args['proxy'] = '10.0.0.5'
args['timeout'] = 30
args['encoding'] = 'gbk'result = request(args)
result['code']
result['content']"""
#http请求方法
def request(args):if not (args.has_key('timeout')): args['timeout'] = 60 #代理设置proxy if not (args.has_key('proxy')): proxies = None else: if not args.has_key('proxy') == '': if not args.has_key('proxy_type'): args['proxy_type'] = 'http' if args['proxy_type'] == 'http': proxies = {"http":"http://"+args['proxy'],"https":"http://"+args['proxy']} elif args['proxy_type'] == 'socks': proxies = {"http":"socks5://"+args['proxy'],"https":"socks5://"+args['proxy']} else: proxies = None if not (args.has_key('method')): args['method'] = 'GET' else: args['method'] = args['method'].upper() #header设置 if not (args.has_key('headers')): args['headers'] = {} if not args['headers'].has_key('user-agent'): args['headers']['user-agent'] = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36" #Cookies cookies = {} if args.has_key('cookies'): cookies = args['cookies'] if not args.has_key('data'): args['data'] = {} args['headers'].update(mkHeader(args['data'])) if args['method'] == 'GET': r = requests.get(args['url'], params=args['data'],cookies=cookies,headers=args['headers'],timeout=int(args['timeout']), proxies=proxies, verify=False) elif args['method'] == 'POST': r = requests.post(args['url'], data=args['data'],cookies=cookies,headers=args['headers'],timeout=int(args['timeout']), proxies=proxies, verify=False) result = {} result['code'] = r.status_code ck = {} for cookie in r.cookies: ck.update({cookie.name : cookie.value}) result['cookies'] = ck result['headers'] = r.headers result['content'] = r.content return result
#http 带签名的header生成方法
def mkHeader(data=dict()):
ran_str = ''.join(random.sample(string.ascii_letters + string.digits, 5))
Nonce = "%d_%s" % (int(time.time()),ran_str)
header=dict()
header['Token'] = TOKEN
header['Nonce'] = Nonce
header['Signature'] = sign(Nonce,data)return header
#签名生成方法
def sign(Nonce,data=dict()):tmp = list() tmp.append(TOKEN) tmp.append(SECRET) tmp.append(Nonce) for d,x in data.items(): tmp.append(str(d) + "=" + str(x)) return hashlib.sha1(''.join(sorted(tmp))).hexdigest()
if name == 'main':
#获取K线 args = dict() args['url'] = HOST + '/openApi/market/kline' args['method'] = 'GET' args['data'] = dict() args['data']['symbol'] = "BTC-USDT" args['data']['period'] = "1min" args['data']['size'] = 2000 result = request(args) if result['code']==200: print result['content'] else: print result print '-'*100 #查询我的资产 args = dict() args['url'] = HOST + '/openApi/wallet/list' args['method'] = 'GET' args['data'] = dict() args['data']['currency'] = "BTC" result = request(args) if result['code']==200: print result['content'] else: print result print '-'*100 #委托挂单 args = dict() args['url'] = HOST + '/openApi/entrust/add' args['method'] = 'POST' args['data'] = dict() args['data']['symbol'] = "BTC-USDT" args['data']['type'] = "buy-limit" args['data']['amount'] = 1.343432 args['data']['price'] = 500.323214 result = request(args) if result['code']==200: print result['content'] else: print result
#!/usr/bin/env python
#encoding=utf8
import sys
import json
import time
import hashlib
import requests
import random
import string
TOKEN = "5c9dc98fb92e2"
SECRET = "hkyavn13ybc1qunp4rpb"
HOST = "http://api.xxx.com"
"""
request用法说明
args = dict()
args['url'] = 'http://blog.csdn.net/iloveyin/article/details/21444613'
args['method'] = 'GET'
args['cookies'] = {}
args['data'] = {}
args['header'] = {"user-agent":"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)"}
args['proxy'] = '10.0.0.5'
args['timeout'] = 30
args['encoding'] = 'gbk'
result = request(args)
result['code']
result['content']
"""
#http请求方法
def request(args):
if not 'timeout' in args:
args['timeout'] = 60
if not 'method' in args:
args['method'] = 'GET'
else:
args['method'] = args['method'].upper()
#header设置
if not 'headers' in args:
args['headers'] = {}
if not 'user-agent' in args['headers']:
args['headers']['user-agent'] = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36"
#Cookies
cookies = {}
if 'cookies' in args:
cookies = args['cookies']
if not 'data' in args:
args['data'] = {}
args['headers'].update(mkHeader(args['data']))
if args['method'] == 'GET':
r = requests.get(args['url'], params=args['data'],cookies=cookies,headers=args['headers'],timeout=int(args['timeout']), verify=False)
elif args['method'] == 'POST':
r = requests.post(args['url'], data=args['data'],cookies=cookies,headers=args['headers'],timeout=int(args['timeout']), verify=False)
result = {}
result['code'] = r.status_code
ck = {}
for cookie in r.cookies:
ck.update({cookie.name : cookie.value})
result['cookies'] = ck
result['headers'] = r.headers
result['content'] = r.content
return result
#http 带签名的header生成方法
def mkHeader(data=dict()):
ran_str = ''.join(random.sample(string.ascii_letters + string.digits, 5))
Nonce = "%d_%s" % (int(time.time()),ran_str)
header=dict()
header['Token'] = TOKEN
header['Nonce'] = Nonce
header['Signature'] = sign(Nonce,data)
return header
#签名生成方法
def sign(Nonce,data=dict()):
tmp = list()
tmp.append(TOKEN)
tmp.append(SECRET)
tmp.append(Nonce)
for d,x in data.items():
tmp.append(str(d) + "=" + str(x))
return hashlib.sha1(''.join(sorted(tmp)).encode("utf8")).hexdigest()
if name == 'main':
#获取K线
args = dict()
args['url'] = HOST + '/openApi/market/kline'
args['method'] = 'GET'
args['data'] = dict()
args['data']['symbol'] = "BTC-USDT"
args['data']['period'] = "1min"
args['data']['size'] = 2000
result = request(args)
if result['code']==200:
print(result['content'])
else:
print(result)
print('-'*100)
#查询我的资产
args = dict()
args['url'] = HOST + '/openApi/wallet/list'
args['method'] = 'GET'
args['data'] = dict()
args['data']['currency'] = "BTC"
result = request(args)
if result['code']==200:
print(result['content'])
else:
print(result)
print('-'*100)
#委托挂单
args = dict()
args['url'] = HOST + '/openApi/entrust/add'
args['method'] = 'POST'
args['data'] = dict()
args['data']['symbol'] = "BTC-USDT"
args['data']['type'] = "buy-limit"
args['data']['amount'] = 1.343432
args['data']['price'] = 500.323214
result = request(args)
if result['code']==200:
print(result['content'].decode("utf8"))
else:
print(result)
Path: /openApi/wallet/list
Method: GET
接口描述:
查询资金账户资产
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
currency | 否 | 查询指定的币种,不传则查全部 | |
show_all | 否 | 是否需要全部币种(1:需要,不传则有资产的才有) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ available | string | 非必须 | 可用 | ||
├─ currency | string | 非必须 | 币种 | ||
├─ frozen | string | 非必须 | 冻结 |
Path: /openApi/market/detail
Method: GET
接口描述:
查询现货24小时行情
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ amount | string | 非必须 | 以基础币种计量的交易量 | ||
├─ close | string | 非必须 | 24小时收盘价 | ||
├─ count | integer | 非必须 | 24小时成交笔数 | ||
├─ high | string | 非必须 | 24小时最高价 | ||
├─ id | integer | 非必须 | id | ||
├─ low | string | 非必须 | 24小时最低价 | ||
├─ open | string | 非必须 | 24小时开盘价 | ||
├─ vol | string | 非必须 | 以结算币种计量的交易量 |
Path: /openApi/market/24kline
Method: GET
接口描述:
查询现货24小时行情列表
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | 交易对,多个交易对使用","分割,不传获取所有交易对行情 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ data | object | 非必须 | |||
├─ amount | string | 非必须 | 以基础币种计量的交易量 | ||
├─ close | string | 非必须 | 24小时收盘价 | ||
├─ count | integer | 非必须 | 24小时成交笔数 | ||
├─ high | string | 非必须 | 24小时最高价 | ||
├─ id | integer | 非必须 | id | ||
├─ low | string | 非必须 | 24小时最低价 | ||
├─ open | string | 非必须 | 24小时开盘价 | ||
├─ vol | string | 非必须 | 以结算币种计量的交易量 | ||
├─ symbol | string | 非必须 |
Path: /openApi/market/kline
Method: GET
接口描述:
查询现货kline
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
period | 是 | K线类型:1min, 5min, 15min, 30min, 1hour, 6hour, 12hour, 1day, 1week | |
size | 是 | 获取数量,范围:[1,2000] | |
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 以基础币种计量的交易量 | ||
├─ close | string | 非必须 | 24小时收盘价 | ||
├─ count | integer | 非必须 | 24小时成交笔数 | ||
├─ high | string | 非必须 | 24小时最高价 | ||
├─ id | integer | 非必须 | id | ||
├─ low | string | 非必须 | 24小时最低价 | ||
├─ open | string | 非必须 | 24小时开盘价 | ||
├─ vol | string | 非必须 | 以结算币种计量的交易量 | ||
├─ period | string | 非必须 | |||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/market/gears_depth
Method: GET
接口描述:
查询现货市场合并深度
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
depth | 否 | 深度(0.0001,0.00001,0.000001) | |
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ asks | object [] | 非必须 | 卖盘 | item 类型: object | |
├─ gear | string | 非必须 | 档位 | ||
├─ number | string | 非必须 | 数量 | ||
├─ price | string | 非必须 | 价格 | ||
├─ bids | object [] | 非必须 | 买盘 | item 类型: object | |
├─ gear | string | 非必须 | 档位 | ||
├─ number | string | 非必须 | 数量 | ||
├─ price | string | 非必须 | 价格 | ||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/market/depth
Method: GET
接口描述:
查询现货市场深度
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ asks | array [] | 非必须 | 卖盘 [price, amount] | item 类型: array | |
├─ | 非必须 | ||||
├─ | 非必须 | ||||
├─ bids | array [] | 非必须 | 买盘 [price, amount] | item 类型: array | |
├─ | 非必须 | ||||
├─ | 非必须 | ||||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/market/trade
Method: GET
接口描述:
查询现货市场成交
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
size | 否 | 获取数量,范围:[1,2000] | |
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 成交价 | ||
├─ direction | string | 非必须 | 主动成交方向 | 枚举: buy,sell | |
├─ id | integer | 非必须 | 成交id | ||
├─ price | string | 非必须 | 成交量 | ||
├─ ts | integer | 非必须 | 成交时间 | ||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/market/symbols
Method: GET
接口描述:
查询现货交易对
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ base_currency | string | 非必须 | 交易货币币种 | ||
├─ id | integer | 非必须 | 交易对id | ||
├─ maker_fee | number | 非必须 | 挂单手续费,取值范围0~1之间,如(0.1为10%) | ||
├─ max_price | number | 非必须 | 最大交易价格 | ||
├─ max_size | number | 非必须 | 最大交易数量 | ||
├─ min_price | number | 非必须 | 最小交易价格 | ||
├─ min_size | number | 非必须 | 最小交易数量 | ||
├─ quote_currency | string | 非必须 | 计价货币币种 | ||
├─ symbol | string | 非必须 | 交易对名称 | ||
├─ taker_fee | number | 非必须 | 吃单手续费,取值范围0~1之间,如(0.01为1%) |
Path: /openApi/market/precision
Method: GET
接口描述:
现货交易对精度
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | 交易对,非必填,不填时返回所有交易对精度 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 |
Path: /openApi/entrust/rate
Method: GET
接口描述:
查询现货交易费率
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ fromFee | string | 非必须 | 吃单费率 | ||
├─ toFee | string | 非必须 | 挂单费率 |
Path: /openApi/entrust/add
Method: POST
接口描述:
现货委托挂单
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
amount | number | 必须 | 限价单表示下单数量,市价买单时表示买多少钱(usdt),市价卖单时表示卖多少币(btc) | ||
price | number | 非必须 | 下单价格,市价单不传该参数 | ||
symbol | string | 必须 | 交易对 | ||
type | string | 必须 | 订单类型:buy-market:市价买, sell-market:市价卖, buy-limit:限价买, sell-limit:限价卖 | 枚举: buy-market,sell-market,buy-limit,sell-limit |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ order_sn | string | 非必须 |
Path: /openApi/entrust/cancel
Method: POST
接口描述:
撤销现货当前委托
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
order_ids | string | 非必须 | 订单编号 | ||
symbol | string | 非必须 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errno | number | 非必须 | |||
errmsg | string | 非必须 | |||
result | object | 非必须 | |||
├─ order_sn | string | 非必须 |
Path: /openApi/entrust/currentList
Method: GET
接口描述:
查询现货当前委托
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
direct | 否 | 查询方向(默认 prev),prev 向前,时间(或 ID)倒序;next 向后,时间(或 ID)正序)。(举例一列数:1,2,3,4,5。from=4,prev有3,2,1;next只有5) | |
from | 否 | 查询起始order_sn | |
limit | 否 | 分页返回的结果集数量,默认为20,最大为100 | |
symbol | 否 | 交易对(当前交易对必传,全部交易对不传) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ ctime | string | 非必须 | 委托时间 | ||
├─ deal_number | string | 非必须 | 已成交数量 | ||
├─ deal_price | string | 非必须 | 已成交均价 | ||
├─ number | string | 非必须 | 委托数量:市价买入(type=1,side=buy)时为0 | ||
├─ order_id | integer | 非必须 | 订单id | ||
├─ order_sn | string | 非必须 | 订单编号 | ||
├─ price | string | 非必须 | 价格:市价(type=1)时为0 | ||
├─ side | string | 非必须 | 委托方向:buy/sell | 枚举: buy,sell | |
├─ status | integer | 非必须 | 状态:1=挂单中,2=部分成交,4=撤销中 | 枚举: 1,2,4 | |
├─ symbol | string | 非必须 | 交易对 | ||
├─ total_price | string | 非必须 | 委托总额:市价卖出(type=1,side=sell)时为0 | ||
├─ type | integer | 非必须 | 委托类型:1=市价,2=限价 | 枚举: 1,2 |
Path: /openApi/entrust/historyList
Method: GET
接口描述:
查询现货历史委托
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
direct | 否 | 查询方向(默认 prev),prev 向前,时间(或 ID)倒序;next 向后,时间(或 ID)正序)。(举例一列数:1,2,3,4,5。from=4,prev有3,2,1;next只有5) | |
from | 否 | 查询起始order_sn | |
limit | 否 | 分页返回的结果集数量,默认为20,最大为100 | |
symbol | 否 | 交易对(当前交易对必传,全部交易对不传) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ ctime | string | 非必须 | 委托时间 | ||
├─ deal_number | string | 非必须 | 已成交数量 | ||
├─ deal_price | string | 非必须 | 已成交均价 | ||
├─ number | string | 非必须 | 委托数量:市价买入(type=1,side=buy)时为0 | ||
├─ order_sn | string | 非必须 | 订单编号 | ||
├─ price | string | 非必须 | 价格:市价(type=1)时为0 | ||
├─ side | string | 非必须 | 委托方向:buy/sell | 枚举: buy,sell | |
├─ status | integer | 非必须 | 状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销 | 枚举: 1,2,4 | |
├─ symbol | string | 非必须 | 交易对 | ||
├─ total_price | string | 非必须 | 委托总额:市价卖出(type=1,side=sell)时为0 | ||
├─ type | integer | 非必须 | 委托类型:1=市价,2=限价 | 枚举: 1,2 |
Path: /openApi/entrust/status
Method: GET
接口描述:
查询现货委托详情
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
order_sn | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ ctime | string | 非必须 | 委托时间 | ||
├─ deal_number | string | 非必须 | 已成交数量 | ||
├─ deal_price | string | 非必须 | 已成交均价 | ||
├─ number | string | 非必须 | 委托数量:市价买入(type=1,side=buy)时为0 | ||
├─ order_sn | string | 非必须 | 订单编号 | ||
├─ price | string | 非必须 | 价格:市价(type=1)时为0 | ||
├─ side | string | 非必须 | 委托方向:buy/sell | 枚举: buy,sell | |
├─ status | integer | 非必须 | 状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销 | 枚举: 1,2,4 | |
├─ symbol | string | 非必须 | 交易对 | ||
├─ total_price | string | 非必须 | 委托总额:市价卖出(type=1,side=sell)时为0 | ||
├─ type | integer | 非必须 | 委托类型:1=市价,2=限价 | 枚举: 1,2 |
Path: /openApi/entrust/deal
Method: GET
接口描述:
查询现货成交列表,dealId不自增,弃用
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
orderSn | 是 | 订单编号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ deal_id | integer | 非必须 | 成交id | ||
├─ deal_time | integer | 非必须 | 成交时间 | ||
├─ fee | string | 非必须 | 手续费 | ||
├─ identity | string | 非必须 | maker/taker | ||
├─ number | string | 非必须 | 成交数量 | ||
├─ order_sn | string | 非必须 | 订单编号 | ||
├─ price | string | 非必须 | 成交价格 | ||
├─ side | string | 非必须 | buy/sell | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ total_price | string | 非必须 | 成交总额 |
Path: /openApi/contract/kline
Method: GET
接口描述:
查询合约kline
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
end | 否 | 结束时间 | |
period | 是 | K线类型:1min, 5min, 15min, 30min, 1hour, 6hour, 12hour, 1day, 1week | |
size | 是 | 获取数量,范围:[1,2000] | |
start | 否 | 开始时间 | |
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 以基础币种计量的交易量 | ||
├─ close | string | 非必须 | 收盘价 | ||
├─ count | integer | 非必须 | 成交笔数 | ||
├─ high | string | 非必须 | 最高价 | ||
├─ id | integer | 非必须 | id | ||
├─ low | string | 非必须 | 最低价 | ||
├─ open | string | 非必须 | 开盘价 | ||
├─ vol | string | 非必须 | 以结算币种计量的交易量 | ||
├─ period | string | 非必须 | |||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/contract/24kline
Method: GET
接口描述:
查询合约24小时行情列表
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | 交易对,多个交易对使用","分割,不传获取所有交易对行情 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ data | object | 非必须 | |||
├─ amount | string | 非必须 | 以基础币种计量的交易量 | ||
├─ close | string | 非必须 | 24小时收盘价 | ||
├─ count | integer | 非必须 | 24小时成交笔数 | ||
├─ high | string | 非必须 | 24小时最高价 | ||
├─ id | integer | 非必须 | id | ||
├─ low | string | 非必须 | 24小时最低价 | ||
├─ open | string | 非必须 | 24小时开盘价 | ||
├─ vol | string | 非必须 | 以结算币种计量的交易量 | ||
├─ symbol | string | 非必须 |
Path: /openApi/contract/market
Method: GET
接口描述:
查询合约24小时行情
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ amount | string | 非必须 | 以基础币种计量的交易量 | ||
├─ close | string | 非必须 | 24小时收盘价 | ||
├─ count | integer | 非必须 | 24小时成交笔数 | ||
├─ high | string | 非必须 | 24小时最高价 | ||
├─ id | integer | 非必须 | id | ||
├─ low | string | 非必须 | 24小时最低价 | ||
├─ open | string | 非必须 | 24小时开盘价 | ||
├─ vol | string | 非必须 | 以结算币种计量的交易量 |
Path: /openApi/contract/gears_depth
Method: GET
接口描述:
查询合约市场合并深度
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
depth | 是 | 深度(0.0001,0.00001,0.000001) | |
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ asks | object [] | 非必须 | 卖盘 | item 类型: object | |
├─ gear | string | 非必须 | 档位 | ||
├─ number | string | 非必须 | 数量 | ||
├─ price | string | 非必须 | 价格 | ||
├─ bids | object [] | 非必须 | 买盘 | item 类型: object | |
├─ gear | string | 非必须 | 档位 | ||
├─ number | string | 非必须 | 数量 | ||
├─ price | string | 非必须 | 价格 | ||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/contract/trade
Method: GET
接口描述:
查询合约市场成交
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
size | 否 | 获取数量,范围:[1,2000] | |
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 成交价 | ||
├─ direction | string | 非必须 | 主动成交方向 | 枚举: buy,sell | |
├─ id | integer | 非必须 | 成交id | ||
├─ price | string | 非必须 | 成交量 | ||
├─ ts | integer | 非必须 | 成交时间 | ||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/contract/depth
Method: GET
接口描述:
查询合约市场深度
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 是 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ asks | array [] | 非必须 | 卖盘 [price, amount] | item 类型: array | |
├─ | 非必须 | ||||
├─ | 非必须 | ||||
├─ bids | array [] | 非必须 | 买盘 [price, amount] | item 类型: array | |
├─ | 非必须 | ||||
├─ | 非必须 | ||||
├─ symbol | string | 非必须 | |||
├─ ts | integer | 非必须 |
Path: /openApi/contract/index
Method: GET
接口描述:
查询合约kline
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | 交易对,不传查全部 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ price | string | 非必须 | 标记价 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ ts | integer | 非必须 | 时间 |
Path: /openApi/contract/precision
Method: GET
接口描述:
合约交易对精度
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | 交易对,非必填,不填时返回所有交易对精度 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 |
Path: /openApi/contract/symbols
Method: GET
接口描述:
查询合约交易对
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | BTC-USDT | 交易对名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ base_currency | string | 非必须 | 交易货币币种 | ||
├─ contract_size | string | 非必须 | 合约面值,1张合约对应多少USDT | ||
├─ id | integer | 非必须 | 交易对id | ||
├─ maker_fee | string | 非必须 | 挂单手续费,取值范围0~1之间,如(0.1为10%) | ||
├─ max_price | string | 非必须 | 最大交易价格 | ||
├─ max_size | string | 非必须 | 最大交易数量 | ||
├─ min_price | string | 非必须 | 最小交易价格 | ||
├─ min_size | string | 非必须 | 最小交易数量 | ||
├─ quote_currency | string | 非必须 | 计价货币币种 | ||
├─ symbol | string | 非必须 | 交易对名称 | ||
├─ taker_fee | string | 非必须 | 吃单手续费,取值范围0~1之间,如(0.01为1%) | ||
├─ max_hold | string | 非必须 | 最大持仓量 |
Path: /openApi/contract/hold
Method: GET
接口描述:
查询合约总持仓量
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 是 | 交易对,不传查全部 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ ts | integer | 非必须 | 时间 | ||
├─ volume | integer | 非必须 | 持仓量,张 |
Path: /openApi/contract/add
Method: POST
接口描述:
合约委托挂单
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
amount | number | 必须 | 张数 | ||
contract_type | string | 必须 | 类型 open开仓 close平仓 | 枚举: open,close | |
is_full | string | 非必须 | 模式 1逐仓 2全仓 默认1 | 枚举: 1,2 | |
lever_rate | integer | 必须 | 杠杆倍数(开仓必填,策略委托必填,平仓不填) | ||
price | number | 非必须 | 委托价 | ||
stop_loss_price | string | 非必须 | 止损价格 | ||
stop_profit_price | string | 非必须 | 止盈价格 | ||
symbol | string | 必须 | 合约交易对名称 | ||
trigger_price | string | 非必须 | 触发价格 计划委托策略委托必传 | ||
type | string | 必须 | 委托类型 buy-limit(普通买单)sell-limit(普通卖单)buy-market(市场买单)sell-market(市场卖单)buy-tactics(策略买单)sell-tactics(策略卖单)buy-market-tactic(策略市价买单)sell-market-tactics(策略市价卖单) | 枚举: buy-limit,sell-limit,buy-market,sell-market,buy-tactics,sell-tactics,buy-market-tactic,sell-market-tactics |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | string | 非必须 |
Path: /openApi/contract/cancel
Method: POST
接口描述:
撤销合约当前委托
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
order_ids | string | 非必须 | 订单编号,多个时英文逗号隔开 | ||
symbol | string | 非必须 | 交易对 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ failed | string [] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
├─ success | string [] | 非必须 | item 类型: string | ||
├─ | 非必须 |
Path: /openApi/contract/currentList
Method: GET
接口描述:
查询合约当前委托
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
direct | 否 | 查询方向(默认 prev),prev 向前,时间(或 ID)倒序;next 向后,时间(或 ID)正序)。(举例一列数:1,2,3,4,5。from=4,prev有3,2,1;next只有5) | |
from | 否 | 查询起始order_sn | |
is_full | 否 | 模式 1逐仓 2全仓 默认1 | |
limit | 否 | 分页返回的结果集数量,默认为20,最大为100 | |
symbol | 否 | 交易对(当前交易对必传,全部交易对不传) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 委托数量 | ||
├─ contract_type | string | 非必须 | open开仓 close平仓 | ||
├─ ctime | integer | 非必须 | 委托时间 | ||
├─ deal_amount | string | 非必须 | 成交数量 | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ order_id | string | 非必须 | 订单号 | ||
├─ price | string | 非必须 | 委托价 | ||
├─ price_avg | string | 非必须 | 成交均价 | ||
├─ status | integer | 非必须 | 1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销 | ||
├─ stop_loss_price | string | 非必须 | 止损价格 | ||
├─ stop_profit_price | string | 非必须 | 止盈价格 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ trigger_price | string | 非必须 | 触发价 | ||
├─ type | string | 非必须 | 委托类型 |
Path: /openApi/contract/currentTactics
Method: GET
接口描述:
查询合约当前策略
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
direct | 否 | 查询方向(默认 prev),prev 向前,时间(或 ID)倒序;next 向后,时间(或 ID)正序)。(举例一列数:1,2,3,4,5。from=4,prev有3,2,1;next只有5) | |
from | 否 | 查询起始order_sn | |
is_full | 否 | 模式 1逐仓 2全仓 默认1 | |
limit | 否 | 分页返回的结果集数量,默认为20,最大为100 | |
symbol | 否 | 交易对(当前交易对必传,全部交易对不传) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 委托数量 | ||
├─ ctime | integer | 非必须 | 委托时间 | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ order_id | string | 非必须 | 订单号 | ||
├─ price | string | 非必须 | 委托价 | ||
├─ stop_loss_price | string | 非必须 | 止损价格 | ||
├─ stop_profit_price | string | 非必须 | 止盈价格 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ trigger_price | string | 非必须 | 触发价 | ||
├─ trigger_sign | string | 非必须 | 触发条件 1大于等于 2小于等于 | ||
├─ trigger_status | string | 非必须 | 触发状态 0未触发 1已触发 | ||
├─ type | string | 非必须 | 委托类型 |
Path: /openApi/contract/detail
Method: GET
接口描述:
查询合约成交详情
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
order_id | 是 | 订单编号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 成交数量 | ||
├─ bood | string | 非必须 | 保证金 | ||
├─ ctime | integer | 非必须 | 成交时间 | ||
├─ fee | string | 非必须 | 手续费 | ||
├─ order_id | string | 非必须 | 订单id | ||
├─ price | string | 非必须 | 成交价格 | ||
├─ profit | string | 非必须 | 盈亏 | ||
├─ symbol | string | 非必须 | 交易对 |
Path: /openApi/contract/entrustDetail
Method: GET
接口描述:
合约止盈止损关联订单
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
order_id | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ amount | string | 非必须 | 委托数量 | ||
├─ close_orders | string [] | 非必须 | 开仓时对应止盈止损平仓单 | item 类型: string | |
├─ | 非必须 | ||||
├─ contract_type | string | 非必须 | open开仓 close平仓 | ||
├─ ctime | integer | 非必须 | 委托时间 | ||
├─ deal_amount | string | 非必须 | 成交数量 | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ order_id | string | 非必须 | 订单号 | ||
├─ price | string | 非必须 | 委托价 | ||
├─ price_avg | string | 非必须 | 成交均价 | ||
├─ profit | string | 非必须 | 总盈亏 | ||
├─ status | integer | 非必须 | 1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ type | string | 非必须 | 委托类型 |
Path: /openApi/contract/getOrderDetail
Method: GET
接口描述:
合约委托详情
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
order_id | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ amount | string | 非必须 | 委托数量 | ||
├─ contract_type | string | 非必须 | open开仓 close平仓 | ||
├─ ctime | integer | 非必须 | 委托时间 | ||
├─ deal_amount | string | 非必须 | 成交数量 | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ order_id | string | 非必须 | 订单号 | ||
├─ price | string | 非必须 | 委托价 | ||
├─ price_avg | string | 非必须 | 成交均价 | ||
├─ profit | string | 非必须 | 总盈亏 | ||
├─ status | integer | 非必须 | 1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ type | string | 非必须 | 委托类型 |
Path: /openApi/contract/historyList
Method: GET
接口描述:
查询合约历史委托
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
direct | 否 | 查询方向(默认 prev),prev 向前,时间(或 ID)倒序;next 向后,时间(或 ID)正序)。(举例一列数:1,2,3,4,5。from=4,prev有3,2,1;next只有5) | |
from | 否 | 查询起始order_sn | |
is_full | 否 | 模式 1逐仓 2全仓 默认1 | |
limit | 否 | 分页返回的结果集数量,默认为20,最大为100 | |
symbol | 否 | 交易对(当前交易对必传,全部交易对不传) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 委托数量 | ||
├─ contract_type | string | 非必须 | open开仓 close平仓 | ||
├─ ctime | integer | 非必须 | 委托时间 | ||
├─ deal_amount | string | 非必须 | 成交数量 | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ order_id | string | 非必须 | 订单号 | ||
├─ price | string | 非必须 | 委托价 | ||
├─ price_avg | string | 非必须 | 成交均价 | ||
├─ profit | string | 非必须 | 总盈亏 | ||
├─ status | integer | 非必须 | 1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ type | string | 非必须 | 委托类型 |
Path: /openApi/contract/historyTactics
Method: GET
接口描述:
查询合约历史策略
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
direct | 否 | 查询方向(默认 prev),prev 向前,时间(或 ID)倒序;next 向后,时间(或 ID)正序)。(举例一列数:1,2,3,4,5。from=4,prev有3,2,1;next只有5) | |
from | 否 | 查询起始order_sn | |
is_full | 否 | 模式 1逐仓 2全仓 默认1 | |
limit | 否 | 分页返回的结果集数量,默认为20,最大为100 | |
symbol | 否 | 交易对(当前交易对必传,全部交易对不传) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 委托数量 | ||
├─ ctime | integer | 非必须 | 委托时间 | ||
├─ implement_status | integer | 非必须 | 执行状态 0:待执行 1:挂单中 2:部分执行 3:全部执行 4:执行失败 5:已撤销 | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ order_id | string | 非必须 | 订单号 | ||
├─ price | string | 非必须 | 委托价 | ||
├─ stop_loss_price | string | 非必须 | 止损价格 | ||
├─ stop_profit_price | string | 非必须 | 止盈价格 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ tactics_deal | integer | 非必须 | 已执行数量 | ||
├─ trigger_price | string | 非必须 | 触发价 | ||
├─ trigger_sign | string | 非必须 | 触发条件 1大于等于 2小于等于 | ||
├─ trigger_status | string | 非必须 | 触发状态 0未触发 1已触发 | ||
├─ type | string | 非必须 | 委托类型 |
Path: /openApi/contract/onekeyClose
Method: POST
接口描述:
合约一键全平
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
is_full | string | 非必须 | 模式 1逐仓 2全仓 不传为全部 | 枚举: 1,2 | |
symbol | string | 非必须 | 交易对 不传为全部 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object | 非必须 | |||
├─ failed | integer | 非必须 | 失败 | ||
├─ success | integer | 非必须 | 成功 |
Path: /openApi/contract/position
Method: GET
接口描述:
查询合约当前持仓
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
is_full | 否 | 1逐仓 2全仓 | |
symbol | 否 | 交易对 不传即查全部 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ amount | string | 非必须 | 持有数量 | ||
├─ avail | string | 非必须 | 可用(usdt) | ||
├─ avail_amount | string | 非必须 | 可平数量(张数) | ||
├─ bood | string | 非必须 | 冻结保证金(usdt) | ||
├─ contract_frozen | string | 非必须 | 委托冻结(张数) | ||
├─ equity | string | 非必须 | 账户权益(usdt) | ||
├─ lever_rate | integer | 非必须 | 杠杆倍数 | ||
├─ liquidation_price | string | 非必须 | 强平价 | ||
├─ open_price_avg | string | 非必须 | 开仓均价 | ||
├─ profit | string | 非必须 | 已实现盈亏 | ||
├─ risk_rate | string | 非必须 | 风险率 | ||
├─ settle_rate | string | 非必须 | 当期资金结算费用 | ||
├─ symbol | string | 非必须 | 交易对 | ||
├─ type | integer | 非必须 | 1多仓 2空仓 | 枚举: 1,2 | |
├─ un_profit | string | 非必须 | 未实现盈亏 |
Path: /openApi/contract/walletList
Method: GET
接口描述:
查询合约逐仓资金
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
symbol | 否 | 交易对,不传查全部 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ avail | string | 非必须 | 可用 | ||
├─ frozen | string | 非必须 | 委托冻结保证金 | ||
├─ hold | string | 非必须 | 持仓保证金 | ||
├─ symbol | string | 非必须 | 交易对 |
Path: /openApi/contract/walletList/full
Method: GET
接口描述:
查询合约全仓资金
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
token | 是 | API key access key | ||
Nonce | 是 | 加签随机数 | ||
Signature | 是 | 签名 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
trade_area | 否 | 交易区, 默认USDT |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
errmsg | string | 非必须 | |||
errno | integer | 非必须 | |||
result | object [] | 非必须 | item 类型: object | ||
├─ avail | string | 非必须 | 可用 | ||
├─ frozen | string | 非必须 | 委托冻结保证金 | ||
├─ hold | string | 非必须 | 持仓保证金 | ||
├─ trade_area | string | 非必须 | 交易区 |