IconCreated with Sketch.

YAPI 接口文档

YApi
  • 钱包接口
    • 查询资金账户资产
  • 币币行情接口
    • 查询24小时行情数据
    • 查询24小时行情列表
    • 查询K线数据
    • 查询市场合并深度
    • 查询市场深度
    • 查询市场成交
    • 查询支持交易对列表
    • 查询交易对精度
  • 币币交易接口
    • 查询交易费率
    • 委托挂单
    • 撤销委托
    • 查询当前委托
    • 查询历史委托
    • 查询委托详情
    • 查询委托成交
  • 合约行情
    • 查询合约kline
    • 查询合约24小时行情列表
    • 查询合约24小时行情
    • 查询合约市场合并深度
    • 查询合约市场成交
    • 查询合约市场深度
    • 获取标记价
    • 合约交易对精度
    • 查询合约交易对
    • 查询合约总持仓量
  • 合约交易
    • 合约委托挂单
    • 撤销合约当前委托
    • 查询合约当前委托
    • 查询合约当前计划
    • 查询合约成交详情
    • 查询历史委托详情
    • 合约委托详情
    • 查询合约历史委托
    • 查询合约历史计划
    • 合约一键全平
    • 查询合约当前持仓
    • 查询合约逐仓资金
    • 查询合约全仓资金

交易所开放接口

公共信息

交易所接口文档

文档版本: 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\);

token:

用户令牌,请在“个人中心 - 开放接口”查看。

Nonce:

随机数,客户端每次请求随机生成字符。生成规则,时间戳_5位随机字母或数字。如:1534927978_ab43c
注意:时间误差不能超过60秒,相同随机数只能被使用一次。

Signature:

签名,使用$token,$secret_key,$nonce,$_POST,$_GET计算得出,服务端验证签名以确定请求是否来自用户。

生成Signature的Python示例代码:

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()

生成Signature的PHP示例代码:

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;
}

生成Signature的Java示例代码:

        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

错误码

HTTP状态码

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访问也要加上签名,否则限频会更严格),请合理使用访问额度。

python2 demo

#!/usr/bin/env python2
#encoding=utf8

import sys
reload(sys)
sys.setdefaultencoding('utf-8')
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 (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

python3 demo

#!/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:需要,不传则有资产的才有)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ availablestring非必须可用
├─ currencystring非必须币种
├─ frozenstring非必须冻结

币币行情接口

查询24小时行情数据

基本信息

Path: /openApi/market/detail

Method: GET

接口描述:

查询现货24小时行情

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ amountstring非必须以基础币种计量的交易量
├─ closestring非必须24小时收盘价
├─ countinteger非必须24小时成交笔数
├─ highstring非必须24小时最高价
├─ idinteger非必须id
├─ lowstring非必须24小时最低价
├─ openstring非必须24小时开盘价
├─ volstring非必须以结算币种计量的交易量

查询24小时行情列表

基本信息

Path: /openApi/market/24kline

Method: GET

接口描述:

查询现货24小时行情列表

请求参数

Query

参数名称 是否必须 示例 备注
symbol 否 交易对,多个交易对使用","分割,不传获取所有交易对行情

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ dataobject非必须
├─ amountstring非必须以基础币种计量的交易量
├─ closestring非必须24小时收盘价
├─ countinteger非必须24小时成交笔数
├─ highstring非必须24小时最高价
├─ idinteger非必须id
├─ lowstring非必须24小时最低价
├─ openstring非必须24小时开盘价
├─ volstring非必须以结算币种计量的交易量
├─ symbolstring非必须

查询K线数据

基本信息

Path: /openApi/market/kline

Method: GET

接口描述:

查询现货kline

请求参数

Query

参数名称 是否必须 示例 备注
period 是 K线类型:1min, 5min, 15min, 30min, 1hour, 6hour, 12hour, 1day, 1week
size 是 获取数量,范围:[1,2000]
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ dataobject []非必须

item 类型: object

├─ amountstring非必须以基础币种计量的交易量
├─ closestring非必须24小时收盘价
├─ countinteger非必须24小时成交笔数
├─ highstring非必须24小时最高价
├─ idinteger非必须id
├─ lowstring非必须24小时最低价
├─ openstring非必须24小时开盘价
├─ volstring非必须以结算币种计量的交易量
├─ periodstring非必须
├─ symbolstring非必须
├─ tsinteger非必须

查询市场合并深度

基本信息

Path: /openApi/market/gears_depth

Method: GET

接口描述:

查询现货市场合并深度

请求参数

Query

参数名称 是否必须 示例 备注
depth 否 深度(0.0001,0.00001,0.000001)
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ asksobject []非必须卖盘

item 类型: object

├─ gearstring非必须档位
├─ numberstring非必须数量
├─ pricestring非必须价格
├─ bidsobject []非必须买盘

item 类型: object

├─ gearstring非必须档位
├─ numberstring非必须数量
├─ pricestring非必须价格
├─ symbolstring非必须
├─ tsinteger非必须

查询市场深度

基本信息

Path: /openApi/market/depth

Method: GET

接口描述:

查询现货市场深度

请求参数

Query

参数名称 是否必须 示例 备注
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ asksarray []非必须卖盘 [price, amount]

item 类型: array

├─ 非必须
├─ 非必须
├─ bidsarray []非必须买盘 [price, amount]

item 类型: array

├─ 非必须
├─ 非必须
├─ symbolstring非必须
├─ tsinteger非必须

查询市场成交

基本信息

Path: /openApi/market/trade

Method: GET

接口描述:

查询现货市场成交

请求参数

Query

参数名称 是否必须 示例 备注
size 否 获取数量,范围:[1,2000]
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ dataobject []非必须

item 类型: object

├─ amountstring非必须成交价
├─ directionstring非必须主动成交方向

枚举: buy,sell

├─ idinteger非必须成交id
├─ pricestring非必须成交量
├─ tsinteger非必须成交时间
├─ symbolstring非必须
├─ tsinteger非必须

查询支持交易对列表

基本信息

Path: /openApi/market/symbols

Method: GET

接口描述:

查询现货交易对

请求参数

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ base_currencystring非必须交易货币币种
├─ idinteger非必须交易对id
├─ maker_feenumber非必须挂单手续费,取值范围0~1之间,如(0.1为10%)
├─ max_pricenumber非必须最大交易价格
├─ max_sizenumber非必须最大交易数量
├─ min_pricenumber非必须最小交易价格
├─ min_sizenumber非必须最小交易数量
├─ quote_currencystring非必须计价货币币种
├─ symbolstring非必须交易对名称
├─ taker_feenumber非必须吃单手续费,取值范围0~1之间,如(0.01为1%)

查询交易对精度

基本信息

Path: /openApi/market/precision

Method: GET

接口描述:

现货交易对精度

请求参数

Query

参数名称 是否必须 示例 备注
symbol 否 交易对,非必填,不填时返回所有交易对精度

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须

币币交易接口

查询交易费率

基本信息

Path: /openApi/entrust/rate

Method: GET

接口描述:

查询现货交易费率

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ fromFeestring非必须吃单费率
├─ toFeestring非必须挂单费率

委托挂单

基本信息

Path: /openApi/entrust/add

Method: POST

接口描述:

现货委托挂单

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Body

名称类型是否必须默认值备注其他信息
amountnumber必须限价单表示下单数量,市价买单时表示买多少钱(usdt),市价卖单时表示卖多少币(btc)
pricenumber非必须下单价格,市价单不传该参数
symbolstring必须交易对
typestring必须订单类型:buy-market:市价买, sell-market:市价卖, buy-limit:限价买, sell-limit:限价卖

枚举: buy-market,sell-market,buy-limit,sell-limit

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ order_snstring非必须

撤销委托

基本信息

Path: /openApi/entrust/cancel

Method: POST

接口描述:

撤销现货当前委托

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Body

名称类型是否必须默认值备注其他信息
order_idsstring非必须订单编号
symbolstring非必须交易对

返回数据

名称类型是否必须默认值备注其他信息
errnonumber非必须
errmsgstring非必须
resultobject非必须
├─ order_snstring非必须

查询当前委托

基本信息

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 否 交易对(当前交易对必传,全部交易对不传)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ ctimestring非必须委托时间
├─ deal_numberstring非必须已成交数量
├─ deal_pricestring非必须已成交均价
├─ numberstring非必须委托数量:市价买入(type=1,side=buy)时为0
├─ order_idinteger非必须订单id
├─ order_snstring非必须订单编号
├─ pricestring非必须价格:市价(type=1)时为0
├─ sidestring非必须委托方向:buy/sell

枚举: buy,sell

├─ statusinteger非必须状态:1=挂单中,2=部分成交,4=撤销中

枚举: 1,2,4

├─ symbolstring非必须交易对
├─ total_pricestring非必须委托总额:市价卖出(type=1,side=sell)时为0
├─ typeinteger非必须委托类型: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 否 交易对(当前交易对必传,全部交易对不传)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ ctimestring非必须委托时间
├─ deal_numberstring非必须已成交数量
├─ deal_pricestring非必须已成交均价
├─ numberstring非必须委托数量:市价买入(type=1,side=buy)时为0
├─ order_snstring非必须订单编号
├─ pricestring非必须价格:市价(type=1)时为0
├─ sidestring非必须委托方向:buy/sell

枚举: buy,sell

├─ statusinteger非必须状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销

枚举: 1,2,4

├─ symbolstring非必须交易对
├─ total_pricestring非必须委托总额:市价卖出(type=1,side=sell)时为0
├─ typeinteger非必须委托类型:1=市价,2=限价

枚举: 1,2

查询委托详情

基本信息

Path: /openApi/entrust/status

Method: GET

接口描述:

查询现货委托详情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
order_sn 是 订单号

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ ctimestring非必须委托时间
├─ deal_numberstring非必须已成交数量
├─ deal_pricestring非必须已成交均价
├─ numberstring非必须委托数量:市价买入(type=1,side=buy)时为0
├─ order_snstring非必须订单编号
├─ pricestring非必须价格:市价(type=1)时为0
├─ sidestring非必须委托方向:buy/sell

枚举: buy,sell

├─ statusinteger非必须状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销

枚举: 1,2,4

├─ symbolstring非必须交易对
├─ total_pricestring非必须委托总额:市价卖出(type=1,side=sell)时为0
├─ typeinteger非必须委托类型:1=市价,2=限价

枚举: 1,2

查询委托成交

基本信息

Path: /openApi/entrust/deal

Method: GET

接口描述:

查询现货成交列表,dealId不自增,弃用

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
orderSn 是 订单编号

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ deal_idinteger非必须成交id
├─ deal_timeinteger非必须成交时间
├─ feestring非必须手续费
├─ identitystring非必须maker/taker
├─ numberstring非必须成交数量
├─ order_snstring非必须订单编号
├─ pricestring非必须成交价格
├─ sidestring非必须buy/sell
├─ symbolstring非必须交易对
├─ total_pricestring非必须成交总额

合约行情

查询合约kline

基本信息

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 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ dataobject []非必须

item 类型: object

├─ amountstring非必须以基础币种计量的交易量
├─ closestring非必须收盘价
├─ countinteger非必须成交笔数
├─ highstring非必须最高价
├─ idinteger非必须id
├─ lowstring非必须最低价
├─ openstring非必须开盘价
├─ volstring非必须以结算币种计量的交易量
├─ periodstring非必须
├─ symbolstring非必须
├─ tsinteger非必须

查询合约24小时行情列表

基本信息

Path: /openApi/contract/24kline

Method: GET

接口描述:

查询合约24小时行情列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 否 交易对,多个交易对使用","分割,不传获取所有交易对行情

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ dataobject非必须
├─ amountstring非必须以基础币种计量的交易量
├─ closestring非必须24小时收盘价
├─ countinteger非必须24小时成交笔数
├─ highstring非必须24小时最高价
├─ idinteger非必须id
├─ lowstring非必须24小时最低价
├─ openstring非必须24小时开盘价
├─ volstring非必须以结算币种计量的交易量
├─ symbolstring非必须

查询合约24小时行情

基本信息

Path: /openApi/contract/market

Method: GET

接口描述:

查询合约24小时行情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ amountstring非必须以基础币种计量的交易量
├─ closestring非必须24小时收盘价
├─ countinteger非必须24小时成交笔数
├─ highstring非必须24小时最高价
├─ idinteger非必须id
├─ lowstring非必须24小时最低价
├─ openstring非必须24小时开盘价
├─ volstring非必须以结算币种计量的交易量

查询合约市场合并深度

基本信息

Path: /openApi/contract/gears_depth

Method: GET

接口描述:

查询合约市场合并深度

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
depth 是 深度(0.0001,0.00001,0.000001)
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ asksobject []非必须卖盘

item 类型: object

├─ gearstring非必须档位
├─ numberstring非必须数量
├─ pricestring非必须价格
├─ bidsobject []非必须买盘

item 类型: object

├─ gearstring非必须档位
├─ numberstring非必须数量
├─ pricestring非必须价格
├─ symbolstring非必须
├─ tsinteger非必须

查询合约市场成交

基本信息

Path: /openApi/contract/trade

Method: GET

接口描述:

查询合约市场成交

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
size 否 获取数量,范围:[1,2000]
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ dataobject []非必须

item 类型: object

├─ amountstring非必须成交价
├─ directionstring非必须主动成交方向

枚举: buy,sell

├─ idinteger非必须成交id
├─ pricestring非必须成交量
├─ tsinteger非必须成交时间
├─ symbolstring非必须
├─ tsinteger非必须

查询合约市场深度

基本信息

Path: /openApi/contract/depth

Method: GET

接口描述:

查询合约市场深度

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 是 交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ asksarray []非必须卖盘 [price, amount]

item 类型: array

├─ 非必须
├─ 非必须
├─ bidsarray []非必须买盘 [price, amount]

item 类型: array

├─ 非必须
├─ 非必须
├─ symbolstring非必须
├─ tsinteger非必须

获取标记价

基本信息

Path: /openApi/contract/index

Method: GET

接口描述:

查询合约kline

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 否 交易对,不传查全部

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ pricestring非必须标记价
├─ symbolstring非必须交易对
├─ tsinteger非必须时间

合约交易对精度

基本信息

Path: /openApi/contract/precision

Method: GET

接口描述:

合约交易对精度

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 否 交易对,非必填,不填时返回所有交易对精度

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须

查询合约交易对

基本信息

Path: /openApi/contract/symbols

Method: GET

接口描述:

查询合约交易对

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 否 BTC-USDT 交易对名称

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ base_currencystring非必须交易货币币种
├─ contract_sizestring非必须合约面值,1张合约对应多少USDT
├─ idinteger非必须交易对id
├─ maker_feestring非必须挂单手续费,取值范围0~1之间,如(0.1为10%)
├─ max_pricestring非必须最大交易价格
├─ max_sizestring非必须最大交易数量
├─ min_pricestring非必须最小交易价格
├─ min_sizestring非必须最小交易数量
├─ quote_currencystring非必须计价货币币种
├─ symbolstring非必须交易对名称
├─ taker_feestring非必须吃单手续费,取值范围0~1之间,如(0.01为1%)
├─ max_holdstring非必须最大持仓量

查询合约总持仓量

基本信息

Path: /openApi/contract/hold

Method: GET

接口描述:

查询合约总持仓量

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 是 交易对,不传查全部

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ symbolstring非必须交易对
├─ tsinteger非必须时间
├─ volumeinteger非必须持仓量,张

合约交易

合约委托挂单

基本信息

Path: /openApi/contract/add

Method: POST

接口描述:

合约委托挂单

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Body

名称类型是否必须默认值备注其他信息
amountnumber必须张数
contract_typestring必须类型 open开仓 close平仓

枚举: open,close

is_fullstring非必须模式 1逐仓 2全仓 默认1

枚举: 1,2

lever_rateinteger必须杠杆倍数(开仓必填,策略委托必填,平仓不填)
pricenumber非必须委托价
stop_loss_pricestring非必须止损价格
stop_profit_pricestring非必须止盈价格
symbolstring必须合约交易对名称
trigger_pricestring非必须触发价格 计划委托策略委托必传
typestring必须委托类型 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

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultstring非必须

撤销合约当前委托

基本信息

Path: /openApi/contract/cancel

Method: POST

接口描述:

撤销合约当前委托

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Body

名称类型是否必须默认值备注其他信息
order_idsstring非必须订单编号,多个时英文逗号隔开
symbolstring非必须交易对

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ failedstring []非必须

item 类型: string

├─ 非必须
├─ successstring []非必须

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 否 交易对(当前交易对必传,全部交易对不传)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ amountstring非必须委托数量
├─ contract_typestring非必须open开仓 close平仓
├─ ctimeinteger非必须委托时间
├─ deal_amountstring非必须成交数量
├─ lever_rateinteger非必须杠杆倍数
├─ order_idstring非必须订单号
├─ pricestring非必须委托价
├─ price_avgstring非必须成交均价
├─ statusinteger非必须1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销
├─ stop_loss_pricestring非必须止损价格
├─ stop_profit_pricestring非必须止盈价格
├─ symbolstring非必须交易对
├─ trigger_pricestring非必须触发价
├─ typestring非必须委托类型

查询合约当前计划

基本信息

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 否 交易对(当前交易对必传,全部交易对不传)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ amountstring非必须委托数量
├─ ctimeinteger非必须委托时间
├─ lever_rateinteger非必须杠杆倍数
├─ order_idstring非必须订单号
├─ pricestring非必须委托价
├─ stop_loss_pricestring非必须止损价格
├─ stop_profit_pricestring非必须止盈价格
├─ symbolstring非必须交易对
├─ trigger_pricestring非必须触发价
├─ trigger_signstring非必须触发条件 1大于等于 2小于等于
├─ trigger_statusstring非必须触发状态 0未触发 1已触发
├─ typestring非必须委托类型

查询合约成交详情

基本信息

Path: /openApi/contract/detail

Method: GET

接口描述:

查询合约成交详情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
order_id 是 订单编号

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ amountstring非必须成交数量
├─ boodstring非必须保证金
├─ ctimeinteger非必须成交时间
├─ feestring非必须手续费
├─ order_idstring非必须订单id
├─ pricestring非必须成交价格
├─ profitstring非必须盈亏
├─ symbolstring非必须交易对

查询历史委托详情

基本信息

Path: /openApi/contract/entrustDetail

Method: GET

接口描述:

合约止盈止损关联订单

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
order_id 是

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ amountstring非必须委托数量
├─ close_ordersstring []非必须开仓时对应止盈止损平仓单

item 类型: string

├─ 非必须
├─ contract_typestring非必须open开仓 close平仓
├─ ctimeinteger非必须委托时间
├─ deal_amountstring非必须成交数量
├─ lever_rateinteger非必须杠杆倍数
├─ order_idstring非必须订单号
├─ pricestring非必须委托价
├─ price_avgstring非必须成交均价
├─ profitstring非必须总盈亏
├─ statusinteger非必须1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销
├─ symbolstring非必须交易对
├─ typestring非必须委托类型

合约委托详情

基本信息

Path: /openApi/contract/getOrderDetail

Method: GET

接口描述:

合约委托详情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
order_id 是

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ amountstring非必须委托数量
├─ contract_typestring非必须open开仓 close平仓
├─ ctimeinteger非必须委托时间
├─ deal_amountstring非必须成交数量
├─ lever_rateinteger非必须杠杆倍数
├─ order_idstring非必须订单号
├─ pricestring非必须委托价
├─ price_avgstring非必须成交均价
├─ profitstring非必须总盈亏
├─ statusinteger非必须1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销
├─ symbolstring非必须交易对
├─ typestring非必须委托类型

查询合约历史委托

基本信息

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 否 交易对(当前交易对必传,全部交易对不传)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ amountstring非必须委托数量
├─ contract_typestring非必须open开仓 close平仓
├─ ctimeinteger非必须委托时间
├─ deal_amountstring非必须成交数量
├─ lever_rateinteger非必须杠杆倍数
├─ order_idstring非必须订单号
├─ pricestring非必须委托价
├─ price_avgstring非必须成交均价
├─ profitstring非必须总盈亏
├─ statusinteger非必须1,状态:1=挂单中,2=部分成交,3=已成交,4=撤销中,5=部分撤销,6=已撤销
├─ symbolstring非必须交易对
├─ typestring非必须委托类型

查询合约历史计划

基本信息

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 否 交易对(当前交易对必传,全部交易对不传)

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ amountstring非必须委托数量
├─ ctimeinteger非必须委托时间
├─ implement_statusinteger非必须执行状态 0:待执行 1:挂单中 2:部分执行 3:全部执行 4:执行失败 5:已撤销
├─ lever_rateinteger非必须杠杆倍数
├─ order_idstring非必须订单号
├─ pricestring非必须委托价
├─ stop_loss_pricestring非必须止损价格
├─ stop_profit_pricestring非必须止盈价格
├─ symbolstring非必须交易对
├─ tactics_dealinteger非必须已执行数量
├─ trigger_pricestring非必须触发价
├─ trigger_signstring非必须触发条件 1大于等于 2小于等于
├─ trigger_statusstring非必须触发状态 0未触发 1已触发
├─ typestring非必须委托类型

合约一键全平

基本信息

Path: /openApi/contract/onekeyClose

Method: POST

接口描述:

合约一键全平

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Body

名称类型是否必须默认值备注其他信息
is_fullstring非必须模式 1逐仓 2全仓 不传为全部

枚举: 1,2

symbolstring非必须交易对 不传为全部

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject非必须
├─ failedinteger非必须失败
├─ successinteger非必须成功

查询合约当前持仓

基本信息

Path: /openApi/contract/position

Method: GET

接口描述:
查询合约当前持仓

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
is_full 否 1逐仓 2全仓
symbol 否 交易对 不传即查全部

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ amountstring非必须持有数量
├─ availstring非必须可用(usdt)
├─ avail_amountstring非必须可平数量(张数)
├─ boodstring非必须冻结保证金(usdt)
├─ contract_frozenstring非必须委托冻结(张数)
├─ equitystring非必须账户权益(usdt)
├─ lever_rateinteger非必须杠杆倍数
├─ liquidation_pricestring非必须强平价
├─ open_price_avgstring非必须开仓均价
├─ profitstring非必须已实现盈亏
├─ risk_ratestring非必须风险率
├─ settle_ratestring非必须当期资金结算费用
├─ symbolstring非必须交易对
├─ typeinteger非必须1多仓 2空仓

枚举: 1,2

├─ un_profitstring非必须未实现盈亏

查询合约逐仓资金

基本信息

Path: /openApi/contract/walletList

Method: GET

接口描述:
查询合约逐仓资金

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
symbol 否 交易对,不传查全部

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ availstring非必须可用
├─ frozenstring非必须委托冻结保证金
├─ holdstring非必须持仓保证金
├─ symbolstring非必须交易对

查询合约全仓资金

基本信息

Path: /openApi/contract/walletList/full

Method: GET

接口描述:
查询合约全仓资金

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 API key access key
Nonce 是 加签随机数
Signature 是 签名

Query

参数名称 是否必须 示例 备注
trade_area 否 交易区, 默认USDT

返回数据

名称类型是否必须默认值备注其他信息
errmsgstring非必须
errnointeger非必须
resultobject []非必须

item 类型: object

├─ availstring非必须可用
├─ frozenstring非必须委托冻结保证金
├─ holdstring非必须持仓保证金
├─ trade_areastring非必须交易区

Build by YMFE.