跳到主要内容

账户和交易接口

[账户和交易接口]模块下的API接口需要身份验证

获取用户所有资产信息

响应示例

{
"success": true,
"code": 0,
"data": [
{
"currency": "USDT",
"positionMargin": 0,
"availableBalance": 32.80984793658,
"cashBalance": 32.80984793,
"frozenBalance": 0,
"equity": 32.80984793,
"unrealized": 0,
"bonus": 0,
"availableCash": 32.80984793658,
"availableOpen": 32.80984793658,
"debtAmount": 0,
"contributeMarginAmount": 0,
"vcoinId": "128f589271cb4951b03e71e6323eb7be"
}
]
}
  • GET api/v1/private/account/assets

需要权限: 读取账户信息

请求参数:

响应参数:

参数名类型说明
currencystring币种
positionMargindecimal仓位保证金
frozenBalancedecimal冻结余额
availableBalancedecimal当前可用余额
cashBalancedecimal可提现余额
equitydecimal总权益
unrealizeddecimal未实现盈亏
bonusdecimal体验金
bonusExpireTimelong体验金过期时间(毫秒)
availableCashdecimal可划转金额
availableOpendecimal可用金额
debtAmountdecimal负债金额
contributeMarginAmountdecimal贡献有效保证金
vcoinIdstring币种ID号

获取用户单个币种资产信息

响应示例

{
"success": true,
"code": 0,
"data": {
"currency": "MX",
"positionMargin": 0,
"availableBalance": 0.99647149597724856,
"cashBalance": 0.99647149,
"frozenBalance": 0,
"equity": 0.99647149,
"unrealized": 0,
"bonus": 0,
"availableCash": 0.99647149597724856,
"availableOpen": 0.99647149597724856,
"debtAmount": 0,
"contributeMarginAmount": 0,
"vcoinId": "8c1e92655f9a4064808ce03ec1a48d38"
}
}
  • GET api/v1/private/account/asset/{currency}

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
currencystringtrue币种

响应参数:

参数名类型说明
currencystring币种
positionMargindecimal仓位保证金
frozenBalancedecimal冻结余额
availableBalancedecimal当前可用余额
cashBalancedecimal可提现余额
equitydecimal总权益
unrealizeddecimal未实现盈亏
bonusdecimal体验金
bonusExpireTimelong体验金过期时间(毫秒)
availableCashdecimal可划转金额
availableOpendecimal可用金额
debtAmountdecimal负债金额
contributeMarginAmountdecimal贡献有效保证金
vcoinIdstring币种ID号

获取用户资产划转记录

响应示例

{
"success": true,
"code": 0,
"data": {
"pageSize": 20,
"totalCount": 1,
"totalPage": 1,
"currentPage": 1,
"resultList": [
{
"id": 303381159,
"txid": "86f334f8850346e89ce4d0ba52b7aa87",
"currency": "USDT",
"amount": 1,
"type": "IN",
"state": "SUCCESS",
"createTime": 1760537642000,
"updateTime": 1760537641000
}
]
}
}
  • GET api/v1/private/account/transfer_record

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
currencystringfalse币种
statestringfalse状态:WAIT 、SUCCESS 、FAILED
typestringfalse类型:IN 、OUT
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
idlongid
txidstring流水号
currencystring币种
amountdecimal转账金额
typestring类型:IN 、OUT
statestring状态:WAIT 、SUCCESS 、FAILED
createTimelong创建时间
updateTimelong修改时间

获取用户历史持仓信息

响应示例

{
"success": true,
"code": 0,
"data": [
{
"positionId": 1027177055,
"symbol": "BTC_USDT",
"positionType": 1,
"openType": 1,
"state": 3,
"holdVol": 0,
"frozenVol": 0,
"closeVol": 2,
"holdAvgPrice": 112449.5,
"holdAvgPriceFullyScale": "112449.5",
"openAvgPrice": 112449.5,
"openAvgPriceFullyScale": "112449.5",
"closeAvgPrice": 113572.3,
"liquidatePrice": 56314.7,
"oim": 0,
"im": 0,
"holdFee": 0,
"realised": 0.2155,
"leverage": 2,
"createTime": 1757506663000,
"updateTime": 1757509217000,
"autoAddIm": false,
"version": 3,
"profitRatio": 0.0191,
"newOpenAvgPrice": 112449.5,
"newCloseAvgPrice": 113572.3,
"closeProfitLoss": 0.2245,
"fee": -0.009,
"positionShowStatus": "CLOSED",
"deductFeeList": [],
"totalFee": 0.009,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0.009
},
{
"positionId": 980739233,
"symbol": "BTC_USDT",
"positionType": 1,
"openType": 1,
"state": 3,
"holdVol": 0,
"frozenVol": 0,
"closeVol": 5,
"holdAvgPrice": 118272.2,
"holdAvgPriceFullyScale": "118272.2",
"openAvgPrice": 118272.2,
"openAvgPriceFullyScale": "118272.2",
"closeAvgPrice": 118669.1,
"liquidatePrice": 112474.5,
"oim": 0,
"im": 0,
"holdFee": 0,
"realised": 0.1747,
"leverage": 20,
"createTime": 1754827319000,
"updateTime": 1754835661000,
"autoAddIm": false,
"version": 3,
"profitRatio": 0.0586,
"newOpenAvgPrice": 118272.2,
"newCloseAvgPrice": 118669.1,
"closeProfitLoss": 0.1984,
"fee": -0.0236,
"positionShowStatus": "CLOSED",
"deductFeeList": [],
"totalFee": 0.0236,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0.0236
}
]
}
  • GET api/v1/private/position/list/history_positions

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
typeintfalse仓位类型, 1多 2空
start_timelongfalse开始时间
end_timelongfalse结束时间
position_typeintfalse仓位类型, 1多 2空
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
positionIdlong持仓id
symbolstring合约名
holdVoldecimal持仓数量
positionTypeint仓位类型, 1多 2空
openTypeint开仓类型, 1逐仓 2全仓
stateint仓位状态,1持仓中2系统代持3已平仓
frozenVoldecimal冻结量
closeVoldecimal平仓量
holdAvgPricedecimal持仓均价
holdAvgPriceFullyScaledecimal全精度持仓均价
closeAvgPricedecimal平仓均价
openAvgPricedecimal开仓均价
openAvgPriceFullyScaledecimal全精度开仓均价
liquidatePricedecimal逐仓时的爆仓价
oimdecimal原始初始保证金
imdecimal初始保证金, 逐仓时可以加减此项以调节爆仓价
holdFeedecimal资金费, 正数表示得到,负数表示支出
realiseddecimal已实现盈亏
leverageint杠杆倍数
marginRatiodecimal当前仓位保证金率
autoAddImboolean是否支持自动追加保证金
profitRatiodecimal收益率 已实现盈亏/仓位起始保证金
newOpenAvgPricedecimal开仓均价,与原有开仓均价不一样
newCloseAvgPricedecimal平仓均价,与原有平仓均价不一样
closeProfitLossdecimal平仓盈亏(不考虑手续费)
feedecimal手续费(不考虑抵扣)
totalFeedecimal累积手续费
createTimedate创建时间
updateTimedate修改时间

获取用户当前持仓

响应示例

{
"success": true,
"code": 0,
"data": [
{
"positionId": 1109973831,
"symbol": "BTC_USDT",
"positionType": 1,
"openType": 1,
"state": 1,
"holdVol": 5,
"frozenVol": 0,
"closeVol": 0,
"holdAvgPrice": 109777.5,
"holdAvgPriceFullyScale": "109777.5",
"openAvgPrice": 109777.5,
"openAvgPriceFullyScale": "109777.5",
"closeAvgPrice": 0,
"liquidatePrice": 55020.5,
"oim": 27.444375,
"im": 27.444375,
"holdFee": 0,
"realised": 0,
"leverage": 2,
"marginRatio": 0.0027,
"createTime": 1761887133854,
"updateTime": 1761887133854,
"autoAddIm": false,
"version": 1,
"profitRatio": 0,
"newOpenAvgPrice": 109777.5,
"newCloseAvgPrice": 0,
"closeProfitLoss": 0,
"fee": 0,
"deductFeeList": [],
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0.0301,
"zeroTradeTotalFeeBinance": 0.0301
}
]
}
  • GET api/v1/private/position/open_positions

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
positionIdlongfalse仓位ID

响应参数:

参数名类型说明
positionIdlong持仓id
symbolstring合约名
holdVoldecimal持仓数量
positionTypeint仓位类型, 1多 2空
openTypeint开仓类型, 1逐仓 2全仓
stateint仓位状态,1持仓中2系统代持3已平仓
frozenVoldecimal冻结量
closeVoldecimal平仓量
holdAvgPricedecimal持仓均价
holdAvgPriceFullyScaledecimal全精度持仓均价
closeAvgPricedecimal平仓均价
openAvgPricedecimal开仓均价
openAvgPriceFullyScaledecimal全精度开仓均价
liquidatePricedecimal逐仓时的爆仓价
oimdecimal原始初始保证金
adlLevelintadl减仓等级,取值为 1-5,为空时需等待刷新
imdecimal初始保证金, 逐仓时可以加减此项以调节爆仓价
holdFeedecimal资金费, 正数表示得到,负数表示支出
realiseddecimal已实现盈亏
leverageint杠杆倍数
marginRatiodecimal当前仓位保证金率
autoAddImboolean是否支持自动追加保证金
profitRatiodecimal收益率 已实现盈亏/仓位起始保证金
newOpenAvgPricedecimal开仓均价,与原有开仓均价不一样
newCloseAvgPricedecimal平仓均价,与原有平仓均价不一样
closeProfitLossdecimal平仓盈亏(不考虑手续费)
feedecimal手续费(不考虑抵扣)
totalFeedecimal累积手续费
createTimedate创建时间
updateTimedate修改时间

获取用户资金费用明细

响应示例

{
"success": true,
"code": 0,
"data": {
"symbol": "BTC_USDT",
"fundingRate": -0.000019,
"maxFundingRate": 0.0018,
"minFundingRate": -0.0018,
"collectCycle": 8,
"nextSettleTime": 1761897600000,
"timestamp": 1761887166142
}
}
  • GET api/v1/private/position/funding_records

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
position_idintfalse仓位id
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100
position_typeinttrue仓位类型, 1多 2空
start_timelongtrue开始时间
end_timelongtrue结束时间

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
idlongid
symbolstring合约名
positionTypeint1:多仓,2:空仓
positionValuedecimal仓位价值
fundingdecimal费用
ratedecimal资金费率
settleTimedate清算时间

根据外部号查询订单

响应示例

{
"success": true,
"code": 0,
"data": {
"orderId": "739106551624717312",
"symbol": "BTC_USDT",
"positionId": 1109973831,
"price": 109777.5,
"priceStr": "109777.500000000000000000",
"vol": 5,
"leverage": 2,
"side": 1,
"category": 1,
"orderType": 5,
"dealAvgPrice": 109777.5,
"dealAvgPriceStr": "109777.500000000000000000",
"dealVol": 5,
"orderMargin": 27.444375,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 3,
"externalOid": "_m_903a9f81cc1148be99ac9ece15981374",
"errorCode": 0,
"usedMargin": 27.444375,
"createTime": 1761887134000,
"updateTime": 1761887134000,
"positionMode": 1,
"version": 2,
"showCancelReason": 0,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0
}
}
  • GET api/v1/private/order/external/{symbol}/{external_oid}

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
external_oidstringtrue外部订单号

响应参数:

参数名类型说明
orderIdlong订单id
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1开多,2平空,3开空,4平多
categoryint订单类别:1限价委托,2强平代管委托,3代管平仓委托,4ADL减仓
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1逐仓,2全仓
stateint订单状态,1:待报,2未完成,3已完成,4已撤销,5无效
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间

根据订单号获取订单信息

响应示例

{
"success": true,
"code": 0,
"data": {
"orderId": "739106551624717312",
"symbol": "BTC_USDT",
"positionId": 1109973831,
"price": 109777.5,
"priceStr": "109777.500000000000000000",
"vol": 5,
"leverage": 2,
"side": 1,
"category": 1,
"orderType": 5,
"dealAvgPrice": 109777.5,
"dealAvgPriceStr": "109777.500000000000000000",
"dealVol": 5,
"orderMargin": 27.444375,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 3,
"externalOid": "_m_903a9f81cc1148be99ac9ece15981374",
"errorCode": 0,
"usedMargin": 27.444375,
"createTime": 1761887134000,
"updateTime": 1761887134000,
"positionMode": 1,
"version": 2,
"showCancelReason": 0,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0
}
}
  • GET api/v1/private/order/get/{orderId}

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
orderIdstringtrue订单ID号

响应参数:

参数名类型说明
orderIdlong订单ID号
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1:开多,2:平空,3:开空,4:平多
categoryint订单类别:1:限价委托,2:强平代管委托,3:代管平仓委托,4:ADL减仓
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1:逐仓,2:全仓
stateint订单状态,1:待报,2:未完成,3:已完成,4:已撤销,5:无效
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间
bboTypeNumint限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5;
lossTrendint止损价格类型;1:最新价;2:合理价;3:指数价
profitTrendint止盈价格类型;
takeProfitPricedecimal止盈价
stopLossPricedecimal止损价
priceProtectint价差保护 1:开启;0:关闭
positionModeint仓位模式;1:双向持仓;2:单向持仓

获取用户当前未结束订单

响应示例

{
"success": true,
"code": 0,
"data": {
"pageSize": 20,
"totalCount": 1,
"totalPage": 1,
"currentPage": 1,
"resultList": [
{
"orderId": "739112440414947358",
"symbol": "BTC_USDT",
"positionId": 0,
"price": 108000,
"priceStr": "108000",
"vol": 1,
"leverage": 2,
"side": 1,
"category": 1,
"orderType": 1,
"dealAvgPrice": 0,
"dealAvgPriceStr": "0",
"dealVol": 0,
"orderMargin": 5.4,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 2,
"externalOid": "_m_a01b688e13fb47ab88c973d80dbfe2b6",
"errorCode": 0,
"usedMargin": 0,
"createTime": 1761888537775,
"updateTime": 1761888537851,
"positionMode": 1,
"version": 1,
"showCancelReason": 0,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0
}
]
}
}
  • GET api/v1/private/order/open_orders/{symbol}

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名,不传返回所有
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
orderIdlong页面大小
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1开多,2平空,3开空,4平多
categoryint订单类别:1限价委托,2强平代管委托,3代管平仓委托,4ADL减仓
orderTypeint1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
usedMargindecimal已经使用的保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1逐仓,2全仓
stateint订单状态,1:待报,2未完成,3已完成,4已撤销,5无效
errorCodeint错误code,0:正常,1:参数错误,2:账户余额不足,3:仓位不存在,4:仓位可用持仓不足,5:多仓时,委托价小于了强平价,空仓时,委托价大于了强平价,6:开多时,强平价大于合理价,开空时,强平价小于合理价,7:超过风险限额限制
externalOidstring外部订单号
stopLossPricedecimal止损价
takeProfitPricedecimal止盈价
createTimedate创建时间
updateTimedate修改时间
bboTypeNumint限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5
lossTrendint止损价格类型;1:最新价;2:合理价;3:指数价
profitTrendint止盈价格类型;
takeProfitPricedecimal止盈价
stopLossPricedecimal止损价
priceProtectint价差保护 1:开启;0:关闭
positionModeint仓位模式;1:双向持仓;2:单向持仓

获取用户已关闭订单

已完成,已取消,无效订单

响应示例

{
"success": true,
"code": 0,
"data": [
{
"orderId": "739113577038255616",
"symbol": "DOGE_USDT",
"positionId": 1109997350,
"price": 0.18537,
"priceStr": "0.185370000000000000",
"vol": 1,
"leverage": 20,
"side": 3,
"category": 1,
"orderType": 5,
"dealAvgPrice": 0.18537,
"dealAvgPriceStr": "0.185370000000000000",
"dealVol": 1,
"orderMargin": 0.92685,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 3,
"externalOid": "_m_5adebccaaf58438185c1e5a56bd8330c",
"errorCode": 0,
"usedMargin": 0.92685,
"createTime": 1761888809000,
"updateTime": 1761888809000,
"positionMode": 1,
"version": 2,
"showCancelReason": 1,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0
}
]
}
  • GET api/v1/private/order/close_orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
categoryintfalse订单类别,1:限价委托,2:强平代管委托,3:代管平仓委托,4:ADL减仓
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
orderIdlong页面大小
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1开多,2平空,3开空,4平多
categoryint订单类别:1限价委托,2强平代管委托,3代管平仓委托,4ADL减仓
orderTypeint1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
usedMargindecimal已经使用的保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1逐仓,2全仓
stateint订单状态,1:待报,2未完成,3已完成,4已撤销,5无效
errorCodeint错误code,0:正常,1:参数错误,2:账户余额不足,3:仓位不存在,4:仓位可用持仓不足,5:多仓时, 委托价小于了强平价,空仓时, 委托价大于了强平价,6:开多时, 强平价大于了合理价,开空时, 强平价小于了合理价 ,7:超过风险限额限制
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间

根据订单号批量查询订单

  • GET /api/v1/private/order/batch_query

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
order_idslongtrue订单号数组,可使用逗号隔开例如:order_ids = 1,2,3(最大50个订单):

响应参数:

参数名类型说明
orderIdlong订单ID号
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1:开多,2:平空,3:开空,4:平多
categoryint订单类别:1:限价委托,2:强平代管委托,3:代管平仓委托,4:ADL减仓
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1:逐仓,2:全仓
stateint订单状态,1:待报,2:未完成,3:已完成,4:已撤销,5:无效
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间
bboTypeNumint限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5;
lossTrendint止损价格类型;1:最新价;2:合理价;3:指数价
profitTrendint止盈价格类型;
takeProfitPricedecimal止盈价
stopLossPricedecimal止损价
priceProtectint价差保护 1:开启;0:关闭
positionModeint仓位模式;1:双向持仓;2:单向持仓

根据订单号获取订单成交明细

响应示例

{
"success": true,
"code": 0,
"data": [
{
"id": "9463051796",
"symbol": "BTC_USDT",
"side": 1,
"vol": 5,
"price": 109777.5,
"fee": 0,
"feeCurrency": "USDT",
"profit": 0,
"category": 1,
"orderId": "739106551624717312",
"timestamp": 1761887134000,
"positionMode": 1,
"taker": true
}
]
}
  • GET api/v1/private/order/deal_details/{order_id}

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
order_idlongtrue订单id

响应参数:

参数名类型说明
idlong成交id
symbolstring合约名
sideint订单方向 1开多,2平空,3开空,4平多
voldecimal成交数量
pricedecimal成交价格
feedecimal手续费
feeCurrencystring收费币种
timestamplong修改时间

根据订单ID号获取成交记录

响应示例

{
"success": true,
"code": 0,
"data": [
{
"id": "159274416",
"symbol": "ETH_USDT",
"side": 2,
"vol": 1,
"price": 1208.35,
"feeCurrency": "USDT",
"fee": 0.0072501,
"timestamp": 1609992674000,
"profit": 0,
"category": 1,
"orderId": "102015012431820288",
"taker": true
}
]
}
  • GET api/v1/private/order/deal_details/{orderId}

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
orderIdlongtrue订单ID号

响应参数:

参数名类型说明
idlong成交订单ID号
symbolstring交易对
sideint订单方向;1:开多,2:平空,3:开空,4:平多
voldecimal成交数量
pricedecimal价格
feedecimal手续费, 正数表示用户付出, 负数表示用户获得
feeCurrencystring手续费币种
profitdecimal盈利
isTakerboolean是否是taker
categoryint订单类别:1限价委托,2强平代管委托,3代管平仓委托,4ADL减仓
orderIdlong订单ID号
timestampdate成交时间

获取用户所有历史订单

响应示例

{
"success": true,
"code": 0,
"data": [
{
"orderId": "739211854408619008",
"symbol": "DOGE_USDT",
"positionId": 1110417836,
"price": 0.18695,
"priceStr": "0.186950000000000000",
"vol": 1,
"leverage": 20,
"side": 3,
"category": 1,
"orderType": 5,
"dealAvgPrice": 0.18695,
"dealAvgPriceStr": "0.186950000000000000",
"dealVol": 1,
"orderMargin": 0.93475,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 3,
"externalOid": "test00002",
"errorCode": 0,
"usedMargin": 0.93475,
"createTime": 1761912240000,
"updateTime": 1761912240000,
"positionMode": 1,
"version": 2,
"showCancelReason": 1,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0.0102,
"zeroTradeTotalFeeBinance": 0.0102
},
{
"orderId": "739211257974395392",
"symbol": "DOGE_USDT",
"positionId": 1110417836,
"price": 0.18645,
"priceStr": "0.186450000000000000",
"vol": 1,
"leverage": 20,
"side": 3,
"category": 1,
"orderType": 5,
"dealAvgPrice": 0.18645,
"dealAvgPriceStr": "0.186450000000000000",
"dealVol": 1,
"orderMargin": 0.93225,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 3,
"externalOid": "test00001",
"errorCode": 0,
"usedMargin": 0.93225,
"createTime": 1761912098000,
"updateTime": 1761912098000,
"positionMode": 1,
"version": 2,
"showCancelReason": 1,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0.0102,
"zeroTradeTotalFeeBinance": 0.0102
}
]
}
  • GET api/v1/private/order/list/history_orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
statesstringfalse订单状态,1:待报,2未完成,3已完成,4已撤销,5无效;多个用 ',' 隔开
categoryintfalse订单类别,1:限价委托,2:强平代管委托,3:代管平仓委托,4:ADL减仓
startTimelongfalse开始时间
endTimelongfalse结束时间
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100
orderIdlongfalse订单ID号

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
orderIdlong页面大小
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1开多,2平空,3开空,4平多
categoryint订单类别:1限价委托,2强平代管委托,3代管平仓委托,4ADL减仓
orderTypeint1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
usedMargindecimal已经使用的保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1逐仓,2全仓
stateint订单状态,1:待报,2未完成,3已完成,4已撤销,5无效
errorCodeint错误code,0:正常,1:参数错误,2:账户余额不足,3:仓位不存在,4:仓位可用持仓不足,5:多仓时,委托价小于了强平价,空仓时,委托价大于了强平价,6:开多时,强平价大于合理价,开空时,强平价小于合理价
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间
bboTypeNumint限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5
lossTrendint止损价格类型;1:最新价;2:合理价;3:指数价
profitTrendint止盈价格类型;
takeProfitPricedecimal止盈价
stopLossPricedecimal止损价
priceProtectint价差保护 1:开启;0:关闭
positionModeint仓位模式;1:双向持仓;2:单向持仓

注意:本接口返回的price为平台接管成交价格,若想查询强平订单的强平价格可通过获取用户当前持仓接口查询,发生强平的订单,该价格为平台的接管价格,与强平价或会出现差异,具体可参考:强平与风险限制

获取历史订单成交明细

响应示例

{
"success": true,
"code": 0,
"data": [
{
"id": "9466823344",
"symbol": "DOGE_USDT",
"side": 3,
"vol": 1,
"price": 0.18695,
"fee": 0,
"feeCurrency": "USDT",
"profit": 0,
"category": 1,
"orderId": "739211854408619008",
"timestamp": 1761912240000,
"positionMode": 1,
"taker": true
},
{
"id": "9466784116",
"symbol": "DOGE_USDT",
"side": 3,
"vol": 1,
"price": 0.18645,
"fee": 0,
"feeCurrency": "USDT",
"profit": 0,
"category": 1,
"orderId": "739211257974395392",
"timestamp": 1761912098000,
"positionMode": 1,
"taker": true
}
]
}
  • GET api/v1/private/order/list/order_deals/v3

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringtrue交易对
start_timelongfalse开始时间
end_timelongfalse结束时间
page_numinttrue查询的页数;默认为1
page_sizeinttrue每页大小;默认为20;最大值不能超过1000

响应参数:

参数名类型说明
pageSizeint页面大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
resultListlist数据结果集
idlong成交订单id
symbolstring合约名
sideint订单方向 1开多,2平空,3开空,4平多
voldecimal成交数量
pricedecimal成交价格
feedecimal手续费
feeCurrencystring收费币种
timestamplong修改时间

查询历史订单

响应示例

{
"success": true,
"code": 0,
"data": [
{
"orderId": "739211854408619008",
"symbol": "DOGE_USDT",
"positionId": 1110417836,
"price": 0.18695,
"priceStr": "0.186950000000000000",
"vol": 1,
"leverage": 20,
"side": 3,
"category": 1,
"orderType": 5,
"dealAvgPrice": 0.18695,
"dealAvgPriceStr": "0.186950000000000000",
"dealVol": 1,
"orderMargin": 0.93475,
"takerFee": 0,
"makerFee": 0,
"profit": 0,
"feeCurrency": "USDT",
"openType": 1,
"state": 3,
"externalOid": "test00002",
"errorCode": 0,
"usedMargin": 0.93475,
"createTime": 1761912240000,
"updateTime": 1761912240000,
"positionMode": 1,
"version": 2,
"showCancelReason": 1,
"showProfitRateShare": 0,
"bboTypeNum": 0,
"totalFee": 0,
"zeroSaveTotalFeeBinance": 0,
"zeroTradeTotalFeeBinance": 0
}
]
}
  • GET api/v1/private/order/list/close_orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringtrue交易对
start_timelongfalse开始时间
end_timelongfalse结束时间
page_numintfalse查询的页数;默认为1
page_sizeintfalse每页大小;默认为20;最大值不能超过1000

响应参数:

参数名类型说明
pageSizeint每页大小
totalCountint总条数
totalPageint总页数
currentPageint当前页
orderIdlong订单ID号
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向;1:开多,2:平空,3:开空,4:平多
categoryint订单类别;1:限价委托,2:强平代管委托,3:代管平仓委托,4:ADL减仓;5:交割订单;6:强平对冲
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1:逐仓,2:全仓
stateint订单状态,1:待报,2:未完成,3:已完成,4:已撤销,5:无效
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间
bboTypeNumint限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5;
lossTrendint止损价格类型;1:最新价;2:合理价;3:指数价
profitTrendint止盈价格类型;
takeProfitPricedecimal止盈价
stopLossPricedecimal止损价
priceProtectint价差保护 1:开启;0:关闭
positionModeint仓位模式;1:双向持仓;2:单向持仓

获取计划委托订单列表

响应示例

{
"success": true,
"code": 0,
"data": [
{
"id": "739114860879304259",
"symbol": "DOGE_USD",
"leverage": 2,
"side": 1,
"triggerPrice": 0.00001,
"price": 0.00001,
"vol": 1,
"openType": 1,
"triggerType": 2,
"state": 1,
"executeCycle": 87600,
"trend": 1,
"orderType": 1,
"errorCode": 0,
"priceProtect": 0,
"createTime": 1761889115000,
"updateTime": 1761889115000,
"positionMode": 1,
"lossTrend": 1,
"profitTrend": 1,
"reduceOnly": false
}
]
}
  • GET api/v1/private/planorder/list/orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
statesstringfalse状态,1:未触发,2:已取消,3:已执行,4:已失效,5:执行失败;多个用 ',' 隔开
sideintfalse订单方向,1:开多,2:平空,3:开空,4:平多
start_timelongtrue开始时间,13位时间戳
end_timelongtrue结束时间,13位时间戳
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100

响应参数:

参数名类型说明
idint订单id
symbolstring合约名
leveragedecimal杠杆倍数
sidestring订单方向, 1开多,3开空
triggerPricedecimal触发价
pricedecimal执行价格
voldecimal下单数量
openTypeint开仓类型,1:逐仓,2:全仓
triggerTypeint触发类型,1:大于等于,2:小于等于
stateint状态,1:未触发,2:已取消,3:已执行,4:已失效,5:执行失败
executeCycleint执行周期,单位:小时
trendint触发价格类型,1:最新价,2:合理价,3:指数价
errorCodeint执行失败时错误码,0:正常
orderIdlong订单id,执行成功时返回
orderTypeint订单类型,1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消,5:市价单
createTimelong创建时间
updateTimelong修改时间
priceProtectint价差保护 1开启0关闭
positionModeint用户设置持仓类型 默认0:历史订单无记录 2:单向 1:双向
lossTrendint止损参考价格类型 1 最新价 2合理价 3 指数价
profitTrendint止盈参考价格类型 1 最新价 2合理价 3 指数价
stopLossPricedecimal止损价
takeProfitPricedecimal止盈价
reduceOnlyboolean只减仓

修改计划委托订单(维护中)

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/planorder/change_price

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
orderIdlongtrue订单ID号
triggerPricedecimaltrue触发价
pricedecimaltrue执行价格
orderTypeinttrue订单类型,1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消,5:市价单
triggerTypeinttrue触发类型,1:大于等于,2:小于等于
trendinttrue触发价格类型,1:最新价,2:合理价,3:指数价
frominttrue接口来源 1-交易列表修改 2-列表修改 为空时kline拖拽修改订单价格

响应参数:

公共参数,success: true成功,false失败

修改计划委托订单上的止盈止损(维护中)

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/planorder/change_stop_order

需要权限: 交易下单

特殊说明:

当满足 (stopLossPrice != null && stopLossPrice > 0) 时, 表示设置了止损价格, 止损价格触发类型字段 (lossTrend) 必传 且 必须是枚举值[1, 2, 3], 否则报错(errorcode: 3001, 价格类型错误); 当满足 (takeProfitPrice != null && takeProfitPrice > 0) 时, 表示设置了止盈价格, 止盈价格触发类型字段 (profitTrend) 必传 且 必须是枚举值[1, 2, 3], 否则报错(errorcode: 3001, 价格类型错误); 当 stopLossPrice == null || stopLossPrice == 0 时, 表示取消止损设置; 当 takeProfitPrice == null || takeProfitPrice == 0 时, 表示取消止盈设置; 当 stopLossPrice 和 takeProfitPrice 都不传, 或者都传 0 时, 表示取消止盈止损设置; lossTrend / profitTrend 取值 :不传,默认按 1 处理(最新价) ;传值,必须是枚举值[1, 2, 3], 否则报错(errorcode: 3001, 价格类型错误)

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
orderIdlongtrue订单ID号
lossTrendintfalse止损参考价格类型 1 最新价 2合理价 3 指数价
profitTrendintfalse止盈参考价格类型 1 最新价 2合理价 3 指数价
stopLossPricedecimalfalse止损价
takeProfitPricedecimalfalse止盈价

响应参数:

公共参数,success: true成功,false失败

获取止盈止损订单列表

响应示例

{
"success": false,
"code": 0,
"message": "",
"data": [{
"id": 0,
"orderId": 0,
"symbol": "",
"positionId": 0,
"stopLossPrice": 0.0,
"takeProfitPrice": 0.0,
"state": 0,
"triggerSide": 0,
"positionType": 0,
"vol": 0.0,
"realityVol": 0.0,
"placeOrderId": 0,
"errorCode": 0,
"version": 0,
"isFinished": 0,
"createTime": "",
"updateTime": ""
}]
}
  • GET api/v1/private/stoporder/list/orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
is_finishedintfalse终态标识:0:未完成,1:已完成
stateintfalse状态:1未触发2已取消3已执行4已失效5执行失败
typeintfalse仓位类型,1:多仓,2:空仓
start_timelongfalse开始时间,13位时间戳
end_timelongfalse结束时间,13位时间戳
page_numinttrue当前页数,默认为1
page_sizeinttrue每页大小,默认20,最大100

响应参数:

参数名类型说明
idlong止盈止损委托单id
symbolstring合约名
orderIdlong限价订单id,如果是根据仓位下的,该值为0
positionIdlong仓位id
lossTrendint止损类型:1最新价2合理价3指数价
profitTrendint止盈类型:1最新价2合理价3指数价
stopLossPricedecimal止损价
takeProfitPricedecimal止盈价
stateint状态,1:未触发,2:已取消,3:已执行,4:已失效,5:执行失败
triggerSideint触发方向,0:未触发,1:止盈,2:止损
positionTypeint仓位类型,1:多仓,2:空仓
voldecimal委托数量
realityVoldecimal实际下单数量
placeOrderIdlong委托成功后订单id
errorCodeint错误码,0:正常,其他见错误码详情
isFinishedint订单状态是否为终态标识(用于查询),0.非终态,1.终态
versionint版本号
priceProtectint触发保护:"1","0"
profitLossVolTypestring止盈止损数量类型(SAME: 数量相同;SEPARATE:数量不同)
takeProfitVoldecimal止盈数量 (profitLossVolType == SEPARATE时处理)
stopLossVoldecimal止损数量 (profitLossVolType == SEPARATE时处理)
createTimelong创建时间
updateTimelong修改时间
volTypeint数量类型1、分批止盈止损2、仓位止盈止
takeProfitReverseint止盈反手:1是2否
stopLossReverseint止损反手:1是2否
takeProfitTypeint止盈类型 0-市价止盈 1-限价止盈
takeProfitOrderPricedecimal限价止盈委托价格
stopLossTypelong止损类型 0-市价止损 1-限价止损
stopLossOrderPricedecimal限价止损 委托价格

获取当前止盈止损订单列表

响应示例

{
"success": true,
"code": 0,
"data": [
{
"id": 357859177,
"orderId": "720733527158642176",
"symbol": "BTC_USDT",
"positionId": "1027177055",
"lossTrend": 1,
"profitTrend": 1,
"stopLossPrice": 111325,
"takeProfitPrice": 113573.9,
"state": 3,
"triggerSide": 2,
"positionType": 1,
"vol": 2,
"realityVol": 2,
"placeOrderId": "720744238723187712",
"errorCode": 0,
"version": 2,
"isFinished": 1,
"priceProtect": 0,
"profitLossVolType": "SEPARATE",
"takeProfitVol": 2,
"stopLossVol": 2,
"createTime": 1757506663000,
"updateTime": 1757509217000,
"volType": 1,
"takeProfitReverse": 2,
"stopLossReverse": 2,
"closeTryTimes": 0,
"reverseTryTimes": 0,
"reverseErrorCode": 0,
"takeProfitType": 0,
"profit_LOSS_VOL_TYPE_SAME": "SAME",
"profit_LOSS_VOL_TYPE_DIFFERENT": "SEPARATE"
}
]
}
  • GET api/v1/private/stoporder/open_orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名

响应参数:

参数名类型说明
idlong止盈止损委托单id
symbolstring合约名
orderIdlong限价订单id,如果是根据仓位下的,该值为0
positionIdlong仓位id
lossTrendint止损类型:1最新价2合理价3指数价
profitTrendint止盈类型:1最新价2合理价3指数价
stopLossPricedecimal止损价
takeProfitPricedecimal止盈价
stateint状态,1:未触发,2:已取消,3:已执行,4:已失效,5:执行失败
triggerSideint触发方向,0:未触发,1:止盈,2:止损
positionTypeint仓位类型,1:多仓,2:空仓
voldecimal委托数量
realityVoldecimal实际下单数量
placeOrderIdlong委托成功后订单id
errorCodeint错误码,0:正常,其他见错误码详情
isFinishedint订单状态是否为终态标识(用于查询),0.非终态,1.终态
versionint版本号
priceProtectint触发保护:"1","0"
profitLossVolTypestring止盈止损数量类型(SAME: 数量相同;SEPARATE:数量不同)
takeProfitVoldecimal止盈数量 (profitLossVolType == SEPARATE时处理)
stopLossVoldecimal止损数量 (profitLossVolType == SEPARATE时处理)
createTimelong创建时间
updateTimelong修改时间
volTypeint数量类型1、分批止盈止损2、仓位止盈止
takeProfitReverseint止盈反手:1是2否
stopLossReverseint止损反手:1是2否
takeProfitTypeint止盈类型 0-市价止盈 1-限价止盈
takeProfitOrderPricedecimal限价止盈委托价格
stopLossTypelong止损类型 0-市价止损 1-限价止损
stopLossOrderPricedecimal限价止损 委托价格

获取风险限额

响应示例

{
"success": true,
"code": 0,
"data": {
"BTC_USDT": [
{
"level": 6,
"maxVol": 4500000,
"mmr": 0.05,
"imr": 0.1,
"maxLeverage": 500,
"symbol": "BTC_USDT",
"positionType": 2,
"openType": 1,
"leverage": 2,
"limitBySys": false,
"currentMmr": 0.05
},
{
"level": 1,
"maxVol": 50000,
"mmr": 0.001,
"imr": 0.002,
"maxLeverage": 500,
"symbol": "BTC_USDT",
"positionType": 1,
"openType": 1,
"leverage": 2,
"limitBySys": false
}
]
}
}
  • GET api/v1/private/account/risk_limit

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名,不传返回所有

响应参数:

参数名类型说明
symbolstring合约名
positionTypeint持仓类型 1:多仓,2:空仓
levelint当前强平风险等级,返回的是min(杠杆风险等级,仓位风险等级)
maxVoldecimal最大可持仓数量,如果合约配置成按仓位价值限制,会根据当前其合理价格,转换成张数
maxLeverageint最大杠杆倍数
mmrdecimal强平风险等级对应维持保证金率 ,如需计算开仓保证金,需根据当前用户的杠杆信息接口,获取维持保证金率
imrdecimal强平风险等级对应初始保证金率

获取手续费详情

响应示例

{
"success": true,
"code": 0,
"data": {
"symbol": "BTC_USDT",
"joinDiscount": true,
"enjoyDiscount": true,
"discountRate": 0.5,
"joinDeduct": true,
"enjoyDeduct": true,
"deductRate": 0.8,
"originalMakerFee": 0,
"originalTakerFee": 0,
"realMakerFee": 0,
"realTakerFee": 0,
"dealAmount": 0,
"walletBalance": 35.10272884,
"inviterKyc": "",
"level": 9999,
"feeType": 1,
"agentFee": false,
"feeRateMode": "TIERED",
"leverageFeeRates": [],
"tieredFeeRates": [
{
"takerFeeRate": 0,
"makerFeeRate": 0,
"minTieredDealAmount": 0,
"maxTieredDealAmount": 10000000,
"realTakerFee": 0,
"realMakerFee": 0
},
{
"takerFeeRate": 0.0004,
"makerFeeRate": 0.0001,
"minTieredDealAmount": 10000001,
"realTakerFee": 0.0002,
"realMakerFee": 0.00005
}
],
"tieredDealAmount": 54,
"tieredEffectiveDay": 0,
"tieredAppointContract": true,
"tieredExcludeContractId": true,
"tieredContractIds": [
10,
77,
1104
],
"tieredExcludeZeroFee": false,
"statisticType": "FIXED",
"fixedStartTime": 1760544000000,
"fixedEndTime": 1763049600000
}
}
  • GET api/v1/private/account/tiered_fee_rate/v2

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名,传入symbol时查询该合约名下费率信息

响应参数:

参数名类型说明
originalMakerFeedecimal原始maker 手续费
originalTakerFeedecimal原始taker 手续费
joinDiscountboolean是否参加折扣
enjoyDiscountboolean是否享受折扣 true享受折扣 false 不享受折扣
joinDeductboolean是否参加抵扣
enjoyDeductboolean是否享受抵扣
realMakerFeedecimal实际maker 手续费
realTakerFeedecimal实际taker 手续费
discountRatedecimal折扣比例
deductRatedecimal抵扣比例
dealAmountdecimal近三十天交易量
walletBalancedecimal昨日钱包余额
inviterKycstring费率组配置邀请人kyc限制
feeRateModestring费率模式NORMAL:普通费率LEVERAGE:杠杆费率。TIERED:阶梯费率
tieredFeeRateslist阶梯费率配置列表信息, feeRateMode为TIERED此字段才有值
tieredDealAmountdecimal交易金额
tieredEffectiveDayint有效天数
tieredAppointContractboolean是否指定合约;false:不指定;true:指定
tieredExcludeContractIdbooleanfalse:不包含,true:包含
tieredContractIdsstring合约ID号,例[10,11]
tieredExcludeZeroFeebooleanfalse:不排出,true:排出;是否排出0费率交易额
leverageFeeRateslist杠杆费率配置列表信息, feeRateMode为LEVERAGE此字段才有值
statisticTypestring阶梯费率交易额统计维度ROLLING 滚动 FIXED 固定
fixedStartTimelong固定模式 开始时间(毫秒)
fixedEndTimelong固定模式 结束时间(毫秒)

修改仓位保证金(维护中)

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/position/change_margin

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
positionIdlongtrue仓位id
amountdecimaltrue金额
typestringtrue类型,ADD:增加,SUB:减少

响应参数:

公共参数,success: true成功,false失败

开启或关闭自动追加保证金(维护中)

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/position/change_auto_add_im

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
positionIdlongtrue仓位id
isEnabledbooleantrue是否开启

响应参数:

公共参数,success: true成功,false失败

获取持仓杠杆倍数

响应示例

{
"success": true,
"code": 0,
"data": [
{
"level": 6,
"maxVol": 4500000,
"mmr": 0.05,
"imr": 0.1,
"positionType": 1,
"openType": 1,
"leverage": 2,
"limitBySys": false,
"currentMmr": 0.001,
"maxLeverageView": 500
},
{
"level": 6,
"maxVol": 4500000,
"mmr": 0.05,
"imr": 0.1,
"positionType": 2,
"openType": 1,
"leverage": 2,
"limitBySys": false,
"currentMmr": 0.001,
"maxLeverageView": 500
}
]
}
  • GET api/v1/private/position/leverage

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名称

响应参数:

参数名类型说明
symbolstring合约名
positionTypeint仓位类型, 1多 2空
openTypeint开仓类型,1:逐仓,2:全仓
leverageint杠杆倍数
maxLeverageViewint最大杠杆倍数
currentMmrdecimal维持保证金率

修改杠杆倍数(维护中)

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/position/change_leverage

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
positionIdlongfalse仓位id,当存在仓位时,传入
leverageinttrue杠杆倍数
openTypeintfalse当不存在仓位时必需,开仓类型,1:逐仓,2:全仓
symbolstringfalse当不存在仓位时必需,合约名称
positionTypeintfalse当不存在仓位时必需, 仓位类型, 1多 2空
leverageModeintfalse杠杆模式1:高级模式 2:简约模式
marginSelectedbooleanfalse调整全部合约保证金模式标识-是否选中
leverageSelectedbooleanfalse调整全部合约杠杆模式标识-是否选中

响应参数:

公共参数,success: true成功,false失败

获取用户仓位模式

响应示例

{
"success": true,
"code": 0,
"data": [
{
"level": 6,
"maxVol": 4500000,
"mmr": 0.05,
"imr": 0.1,
"positionType": 1,
"openType": 1,
"leverage": 2,
"limitBySys": false,
"currentMmr": 0.001,
"maxLeverageView": 500
},
{
"level": 6,
"maxVol": 4500000,
"mmr": 0.05,
"imr": 0.1,
"positionType": 2,
"openType": 1,
"leverage": 2,
"limitBySys": false,
"currentMmr": 0.001,
"maxLeverageView": 500
}
]
}
  • GET api/v1/private/position/position_mode

需要权限: 读取订单信息

请求参数:

响应参数:

参数名类型说明
positionModeinttrue

修改用户仓位模式(维护中)

{
"success": true,
"code": 0
}
  • POST api/v1/private/position/change_position_mode

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
positionModeinttrue1:双向,2:单向,修改仓位模式必须保证没有活跃订单、计划委托单、未完成仓位,否则无法修改。双向切换单向模式时,风险限额等级会重置为等级1,如需更改调用接口修改

响应参数:

公共参数,success: true成功,false失败

反手开仓(维护中)

{
"success": true,
"code": 0
}
  • POST api/v1/private/position/reverse

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
positionIdlongtrue仓位id
voldecimaltrue数量

响应参数:

一键平仓(维护中)

{
"success": true,
"code": 0,
"data": []
}
  • POST api/v1/private/position/close_all

需要权限: 交易下单

请求参数:

响应参数:

公共参数,success: true成功,false失败

下单(维护中)

响应示例

{
"success": true,
"code": 0,
"data": {
"orderId": "739113577038255616",
"ts": 1761888808839
}
}
  • POST api/v1/private/order/create

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
pricedecimaltrue价格
voldecimaltrue数量
leverageintfalse杠杆倍数,开仓的时候杠杆倍数必须传入
sideinttrue订单方向 1开多,2平空,3开空,4平多
typeinttrue订单类型,1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消,5:市价单
openTypeinttrue开仓类型,1:逐仓,2:全仓
externalOidstringfalse外部订单号
stopLossPricedecimalfalse止损价
takeProfitPricedecimalfalse止盈价
lossTrendintfalse止损价格类型;1:最新价(默认值);2:合理价;3:指数价
profitTrendintfalse止盈价格类型;1:最新价(默认值);2:合理价;3:指数价
priceProtectintfalse条件单触发保护:"1","0",默认"0"不开启。 仅 计划委托/止盈止损下单时需要此参数
positionModeintfalse仓位模式,默认为双向持仓;2:单向;1:双向
reduceOnlybooleanfalse只减仓,只有在单向持仓时才受理
marketCeilingbooleanfalse市价百分百开仓
flashClosebooleanfalse是否闪电平仓
bboTypeNumintfalse限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5;

响应参数:

成功时,success =true,data值为订单id,success =false,失败data=null

根据仓位下止盈止损订单(维护中)

响应示例

{
"success": false,
"code": 0,
"message": "",
"data": [{
"id": 0,
"symbol": "",
"leverage": 0,
"side": 0,
"triggerPrice": 0.0,
"price": 0.0,
"vol": 0.0,
"openType": 0,
"triggerType": 0,
"state": 0,
"executeCycle": 0,
"trend": 0,
"orderType": 0,
"orderId": 0,
"errorCode": 0,
"createTime": "",
"updateTime": ""
}

]
}
  • POST api/v1/private/stoporder/place

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
lossTrendinttrue止损类型:1最新价2合理价3指数价
profitTrendinttrue止盈类型:1最新价2合理价3指数价
positionIdlongtrue仓位id
voldecimaltrue委托数量,必须在合约对允许的下单范围之内,委托数量加上已有的止盈止损委托数量必须小于可平仓的数量,不会对仓位数量进行冻结,但是需要判断
stopLossPricedecimalfalse止损价,和止盈价至少有一个不为空,且必须大于0
takeProfitPricedecimalfalse止盈价,和止损价至少有一个不为空,且必须大于0
priceProtectintfalse触发保护:"1","0"
profitLossVolTypestringfalse止盈止损数量类型(SAME: 数量相同;SEPARATE:数量不同)
takeProfitVoldecimalfalse止盈数量 (profitLossVolType == SEPARATE时处理)
stopLossVoldecimalfalse止损数量 (profitLossVolType == SEPARATE时处理)
volTypeintfalse数量类型1、分批止盈止损2、仓位止盈止
takeProfitReverseintfalse止盈反手:1是2否
stopLossReverseintfalse止损反手:1是2否
mtokenstringfalseweb端设备id
takeProfitTypeintfalse止盈类型 0-市价止盈 1-限价止盈
takeProfitOrderPricedecimaltrue限价止盈委托价格
stopLossTypelongtrue止损类型 0-市价止损 1-限价止损
stopLossOrderPricedecimaltrue限价止损 委托价格

响应参数:

成功时,success =true,data值为订单id,success =false,失败data=null,如果存在相同止盈止损价格且非终态的委托单,则返回之前的id,并异步更新之前委托单的数量

修改订单价格&&数量(维护中)

响应示例

{
"success": true,
"code": 0,
"data": "739204819784386560"
}
  • POST api/v1/private/order/change_limit_order

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
orderIdlongtrue订单ID号
pricedecimaltrue价格
voldecimaltrue数量

响应参数:

成功时,success =true,data值为订单id,success =false,失败data=null

查询在途订单数量

响应示例

{
"success": true,
"code": 0,
"data": {
"sumCount": 1,
"limitOrderCount": 1,
"stopOrderCount": 0,
"planOrderCount": 0,
"trackOrderCount": 0
}
}
  • POST api/v1/private/order/open_order_total_count

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
orderIdlongtrue订单ID号
pricedecimaltrue价格
voldecimaltrue数量

响应参数:

成功时,success =true,data值为订单id,success =false,失败data=null

追单(将订单价格修改为对应的一档价格)(维护中)

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/order/chase_limit_order

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
orderIdlongtrue订单ID号

响应参数:

成功时,success =true,data值为订单id,success =false,失败data=null

计划委托下单(维护中)

响应示例

{
"success": true,
"code": 0,
"data": "739206374277809664"
}
  • POST api/v1/private/planorder/place/v2

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
pricedecimalfalse执行价,市价时可不传
voldecimaltrue数量
leverageinttrue杠杆倍数,开仓必传
sideinttrue1开多,2平空,3开空,4平多
openTypeinttrue订单方向 1开多,2平空,3开空,4平多
triggerPricedecimaltrue触发价
triggerTypeinttrue触发类型,1:大于等于,2:小于等于
executeCycleinttrue执行周期,1: 24小时,2: 7天
orderTypeinttrue订单类型,1:限价单,2:Post Only只做Maker,3:立即成交或立即取消,4:全部成交或者全部取消,5:市价单
trendinttrue触发价格类型,1:最新价,2:合理价,3:指数价
priceProtectintfalse条件单触发保护:"1","0", 默认"0"不开启。 仅 计划委托/止盈止损下单时需要此参数
positionModeintfalse用户设置持仓类型 默认0:历史订单无记录 2:单向 1:双向
lossTrendintfalse止损参考价格类型 1 最新价 2合理价 3 指数价
profitTrendintfalse止盈参考价格类型 1 最新价 2合理价 3 指数价
stopLossPricedecimalfalse止损价
takeProfitPricedecimalfalse止盈价
reduceOnlybooleanfalse只减仓

响应参数:

成功时,success =true,data值为订单id,success =false,失败data=null

取消订单(维护中)

响应示例

{
"success":true,
"code":0,
"data":[
{
"orderId":101716841474621953,
"errorCode":2040,
"errorMsg":"order not exist"
},
{
"orderId":108885377779302912,
"errorCode":2041,
"errorMsg":"order state cannot be cancelled"
},
{
"orderId":108886241042563584,
"errorCode":0,
"errorMsg":"success"
}
]
}

撤销之前下的未完成订单,每次最多可撤50个单。

  • POST api/v1/private/order/cancel

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
List<Long>true订单id列表,最大50条

响应参数:

公共参数,success: true成功,false失败

根据外部订单号列表批量撤销订单(维护中)

响应示例

{
"success":true,
"code":0,
"data":[
{
"orderId":101716841474621953,
"errorCode":2040,
"errorMsg":"order not exist"
},
{
"orderId":108885377779302912,
"errorCode":2041,
"errorMsg":"order state cannot be cancelled"
},
{
"orderId":108886241042563584,
"errorCode":0,
"errorMsg":"success"
}
]
}
  • POST api/v1/private/order/batch_cancel_with_external

需要权限: 交易下单

请求参数: list集合;例:[{"symbol":"BTC_USDT", "externalOid":"ext_11"}]

参数名类型是否必填说明
symbolstringtrue交易对
externalOidstringtrue外部订单号

响应参数:

参数名类型说明
orderIdlong订单ID号
errorCodeint错误编码
errorMsgstring错误原因

根据外部订单号取消订单(维护中)

响应示例

{
"success":true,
"code":0,
"data":[
{
"orderId":101716841474621953,
"errorCode":2040,
"errorMsg":"order not exist"
},
{
"orderId":108885377779302912,
"errorCode":2041,
"errorMsg":"order state cannot be cancelled"
},
{
"orderId":108886241042563584,
"errorCode":0,
"errorMsg":"success"
}
]
}
  • POST api/v1/private/order/cancel_with_external

需要权限: 交易下单

请求参数: list集合;例:[{"symbol":"BTC_USDT", "externalOid":"ext_11"}]

参数名类型是否必填说明
symbolstringtrue合约名
externalOidstringtrue外部订单号

响应参数:

参数名类型说明
orderIdlong订单ID号
errorCodeint错误编码
errorMsgstring错误原因

取消某合约下所有订单(维护中)

响应示例

{
"success": true,
"code": 0
}

撤销某个合约下的所有未完成订单。

  • POST api/v1/private/order/cancel_all

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名,传入symbol只取消该合约下的订单,不传取消所有合约下的订单

响应参数:

公共参数,success: true成功,false失败

批量查询-通过外部订单号获取订单

响应示例

{
"success": true,
"code": 0
}
  • POST api/v1/private/order/batch_query_with_external

需要权限: 读取订单信息

请求参数: list集合

参数名类型是否必填说明
symbolstringtrue合约名
externalOidstringtrue外部订单号

响应参数:

参数名类型说明
orderIdlong订单ID号
symbolstring合约名
positionIdlong持仓id
pricedecimal委托价格
voldecimal委托数量
leveragelong杠杆倍数
sideint订单方向 1:开多,2:平空,3:开空,4:平多
categoryint订单类别:1:限价委托,2:强平代管委托,3:代管平仓委托,4:ADL减仓
dealAvgPricedecimal成交均价
dealVoldecimal成交数量
orderMargindecimal委托保证金
takerFeedecimal买单手续费
makerFeedecimal卖单手续费
profitdecimal平仓盈亏
feeCurrencystring收费币种
openTypeint开仓类型,1:逐仓,2:全仓
stateint订单状态,1:待报,2:未完成,3:已完成,4:已撤销,5:无效
externalOidstring外部订单号
createTimedate创建时间
updateTimedate修改时间
bboTypeNumint限价订单类型-BBO类型订单; 0:不是BBO订单;1:对手价1;2:对手价5;3:同向价1;4:同向价5;
lossTrendint止损价格类型;1:最新价;2:合理价;3:指数价
profitTrendint止盈价格类型;
takeProfitPricedecimal止盈价
stopLossPricedecimal止损价
priceProtectint价差保护 1:开启;0:关闭
positionModeint仓位模式;1:双向持仓;2:单向持仓

修改风险等级(维护中)

响应示例

{
"success": true,
"code": 0
}

- POST api/v1/private/account/change_risk_level

需要权限: 交易下单

- 已禁用 调用是返回错误码 8817 提示信息:风险限制功能已升级,详情请前往web端查看

取消计划委托订单(维护中)

响应示例:

{
"success": true,
"code": 0
}
  • POST api/v1/private/planorder/cancel

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
List<CancelOrderRequest>true取消订单列表,最大50条

CancelOrderRequest:

参数示例:

[{"symbol":"BTC_USDT","orderId":1},{"symbol":"ETH_USDT","orderId":2}]

参数名类型是否必填说明
symbolstringtrue合约名
orderIdstringtrue订单id

响应参数:

公共参数,success: true成功,false失败

取消所有计划委托订单(维护中)

响应示例:

{
"success": true,
"code": 0
}
  • POST api/v1/private/planorder/cancel_all

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名,传入symbol只取消该合约下的订单,不传取消所有合约下的订单

响应参数:

公共参数,success: true成功,false失败

取消止盈止损委托单(维护中)

响应示例:

{
"success": true,
"code": 0
}
  • POST api/v1/private/stoporder/cancel

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
List<CancelOrderRequest>true取消订单列表,最大50条

CancelOrderRequest:

参数示例:

[{"stopPlanOrderId":1},{"stopPlanOrderId":2}]

参数名类型是否必填说明
stopPlanOrderIdlongtrue止盈止损委托单id

响应参数:

公共参数,success: true成功,false失败

取消所有止盈止损委托单(维护中)

响应示例:

{
"success": true,
"code": 0
}
  • POST api/v1/private/stoporder/cancel_all

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
positionIdlongfalse仓位id,传入positionId,只取消对应仓位的委托单,不传则判断symbol
symbolstringfalse合约名,传入symbol只取消该合约下的委托单,不传取消所有合约下的委托单

响应参数:

公共参数,success: true成功,false失败

修改限价单止盈止损价格(维护中)

响应示例:

{
"success": true,
"code": 0
}
  • POST api/v1/private/stoporder/change_price

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
lossTrendintfalse止损类型:1最新价2合理价3指数价
profitTrendintfalse止盈类型:1最新价2合理价3指数价
orderIdlongtrue限价单订单id
stopLossPricedecimalfalse止损价,止盈价和止损价同时为空或者同时为0时,则表示取消订单的止盈止损
takeProfitPricedecimalfalse止盈价,止盈价和止损价同时为空或者同时为0时,则表示取消订单的止盈止损
takeProfitReverseintfalse止盈反手:1是2否
stopLossReverseintfalse止损反手:1是2否

响应参数:

公共参数,success: true成功,false失败

修改止盈止损委托单止盈止损价格(维护中)

响应示例:

{
"success": true,
"code": 0
}
  • POST api/v1/private/stoporder/change_plan_price

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
lossTrendintfalse止损类型:1最新价2合理价3指数价
profitTrendintfalse止盈类型:1最新价2合理价3指数价
stopPlanOrderIdlongtrue止盈止损委托单订单id
stopLossPricedecimalfalse止损价,和止盈价至少有一个不为空,且必须大于0
takeProfitPricedecimalfalse止盈价,和止损价至少有一个不为空,且必须大于0
takeProfitReverseintfalse止盈反手:1是2否
stopLossReverseintfalse止损反手:1是2否

响应参数:

公共参数,success: true成功,false失败

跟踪委托下单(维护中)

响应示例:

{
"success": true,
"code": 0,
"data": "739218627261666816"
}
  • POST api/v1/private/trackorder/place

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
leverageinttrue杠杆倍数
sideinttrue1开多,2平空,3开空,4平多
voldecimaltrue委托数量
openTypeinttrue开仓类型,1:逐仓,2:全仓
trendinttrue价格类型:1最新价2合理价3指数价
activePricedecimalfalse激活价格
backTypeinttrue回调类型1回调百分比2回调幅度值
backValuedecimaltrue回调幅度
positionModeinttrue持仓类型 默认0:历史订单无记录 1:双向 2:单向
reduceOnlybooleanfalse只减仓

响应参数:

公共参数,success: true成功,false失败

跟踪委托撤销(维护中)

{
"success": true,
"code": 0
}
  • POST api/v1/private/trackorder/cancel

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
trackOrderIdintfalse跟踪委托id

响应参数:

公共参数,success: true成功,false失败

跟踪委托修改(维护中)

{
"success": true,
"code": 0
}
  • POST api/v1/private/trackorder/change_order

需要权限: 交易下单

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
trackOrderIdlongtrue委托订单ID
trendinttrue价格类型:1最新价2合理价3指数价
activePricedecimalfalse激活价格
backTypeinttrue回调类型1回调百分比2回调幅度值
backValuedecimaltrue回调幅度
voldecimaltrue委托数量

响应参数:

公共参数,success: true成功,false失败

跟踪委托列表查询

{
"success": true,
"code": 0,
"data": [
{
"id": "739628779353703936",
"symbol": "DOGE_USDT",
"leverage": 2,
"side": 1,
"vol": 100,
"openType": 1,
"trend": 1,
"activePrice": 0,
"markPrice": 0.18657,
"backType": 1,
"backValue": 0.02,
"triggerPrice": 0.1903,
"orderId": 0,
"errorCode": 0,
"state": 1,
"createTime": 1762011642623,
"updateTime": 1762011642623,
"positionMode": 1,
"reduceOnly": false,
"triggerType": 1
}
]
}
  • GET api/v1/private/trackorder/list/orders

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse合约名
statesList<int>true订单状态:0未激活1已激活2触发成功3触发失败4已取消
sideintfalse订单方向 1开多,2平空,3开空,4平多
start_timelongfalse查询开始时间
end_timelongfalse查询结束时间
pageIndexintfalse页码
pageSizeintfalse每页数量

响应参数:

参数名类型说明
idlong订单id
symbolstring合约名
leverageint杠杆倍数
sideint1开多,2平空,3开空,4平多
voldecimal委托数量
openTypeint开仓类型,1:逐仓,2:全仓
trendint价格类型:1最新价2合理价3指数价
activePricedecimal激活价格
markPricedecimal对标价格(激活后的最高价或者最低价)
backTypeint回调类型1回调百分比2回调幅度值
backValuedecimal回调幅度
triggerPricedecimal触发价格(随对标价格更新而更新)
orderIddecimal触发成功后的委托单id
errorCodedecimal触发失败的错误码
statedecimal当前跟踪委托单状态(0未激活 1 已激活 2 执行成功 3 执行失败 4 已取消)
createTimelong创建时间
updateTimelong更新时间
positionModeint持仓类型 默认0:历史订单无记录 1:双向 2:单向
reduceOnlyboolean只减仓
triggerTypeint触发条件 1-大于等于 2-小于等于

查看个人盈利率

{
"success": true,
"code": 0,
"data": {
"ranking": 0,
"profitRate": 0,
"statisticTime": 1666612800000
}
}
  • GET api/v1/private/account/profit_rate/{type}

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
typeinttrue类型;1:天,2:周

响应参数:

参数名类型说明
profitRatedecimal盈利率
statisticTimelong统计时间(毫秒)

资产分析

{
"success": true,
"code": 0,
"data": {
"historyDailyData": {
"timeList": [],
"accumPnlList": [],
"accumPnlRateList": [],
"dailyPnlList": [],
"dailyPnlRateList": [],
"dailyEquityList": [],
"dailyIndexPriceRiseFallRateList": []
},
"todayPnl": 0,
"todayPnlRate": 0,
"totalPnl": 0,
"totalEquity": 0,
"winRate": 0
}
}
  • GET api/v1/private/account/asset/analysis/{type}

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
startTimelongfalse开始时间(毫秒)
endTimelongfalse结束时间(毫秒)
currencystringtrue币种
typeinttrue类型;1: 本周 2:本月 3:全部 4:自定义时间范围

响应参数:

参数名类型说明
todayPnldecimal今日盈亏额
todayPnlRatedecimal今日盈亏率
totalPnldecimal总盈亏额
totalEquitydecimal总权益
winRatedecimal胜率
historyDailyDataobject历史每日数据

抵扣配置信息

{
"success": true,
"code": 0,
"data": [
{
"deductCoin": "MX",
"settleCoin": "USDT",
"discountRatio": 0.8
},
{
"deductCoin": "MXPOINT",
"settleCoin": "USDT",
"discountRatio": 1
}
]
}
  • GET api/v1/private/account/feeDeductConfigs

需要权限: 读取账户信息

请求参数:

响应参数:

参数名类型说明
deductCoinstring抵扣币种
settleCoinstring结算币种
discountRatiodecimal折扣比例

昨日收益

{
"success": true,
"code": 0,
"data": 0.23697
}
  • POST api/v1/private/account/asset/analysis/yesterday_pnl

需要权限: 读取账户信息

请求参数:

响应参数:

成功时,success =true,data值为盈亏(单位USDT),success =false,失败data=null

用户资产分析接口

{
"success": true,
"code": 0,
"data": {
"historyDailyData": {
"timeList": [
1666540800000
],
"accumPnlList": [
0
],
"accumPnlRateList": [
0
],
"dailyPnlList": [
0
],
"dailyEquityList": [
0
]
},
"todayPnl": -0.1672566436,
"todayPnlRate": -0.00333611,
"totalEquity": 49.967886076096049341976,
"recentPnl": -84.83699744258,
"recentPnlRate": -0.627705,
"recentPnl30": -84.83699744258,
"recentPnlRate30": -0.62609353,
"accurate": true,
"timestamp": 1762243513793,
"todayPnlFinished": true
}
}
  • POST api/v1/private/account/asset/analysis/v3

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
startTimelongtrue查询开始时间(毫秒)
endTimelongtrue查询截止时间(毫秒)
reverseintfalse合约类型:0:全部;1:U本位;2: 币本位; 3:usdc本位
includeUnrealisedPnlintfalse包含未实现盈亏:0:不包含;1:包含;
symbolstringfalse交易对

响应参数:

参数名类型说明
todayPnldecimal今日盈亏额
todayPnlRatedecimal今日盈亏率
totalPnldecimal总盈亏额
recentPnldecimal7日累计盈亏额
recentPnlRatedecimal7日累计盈亏率
recentPnl30decimal30日累计盈亏额
recentPnlRate30decimal30日累计盈亏率
timestamplong时间戳(毫秒)
historyDailyDataobject历史每日数据

用户资产日历分析接口

{
"success": true,
"code": 0,
"data": {
"dailyTimeList": [
1666540800000
],
"dailyPnlList": [
0
],
"todayPnlFinished": true
}
}
  • POST api/v1/private/account/asset/analysis/calendar/daily/v3

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
startTimelongtrue查询开始时间(毫秒)
endTimelongtrue查询截止时间(毫秒)
reverseintfalse合约类型:0:全部;1:U本位;2: 币本位; 3:usdc本位
includeUnrealisedPnlintfalse包含未实现盈亏:0:不包含;1:包含;

响应参数:

参数名类型说明
dailyTimeListlist每日列表
dailyPnlListlist每日盈利列表

用户资产月日历分析接口

{
"success": true,
"code": 0,
"data": {
"monthlyTimeList": [
1730390400000,
1732982400000,
1735660800000,
1738339200000,
1740758400000,
1743436800000,
1746028800000,
1748707200000,
1751299200000,
1753977600000,
1756656000000,
1759248000000,
1761926400000
],
"monthlyPnlList": [
0,
0,
0,
0.59240408538617361076,
0,
-0.08440522,
1.01141136563,
1.48665238855,
0.443981802,
-5.07385427096,
0.215519128,
0.23697,
-85.07396744258
],
"todayPnlFinished": true
}
}
  • POST api/v1/private/account/asset/analysis/calendar/monthly/v3

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
reverseintfalse合约类型:0:全部;1:U本位;2: 币本位; 3:usdc本位
includeUnrealisedPnlintfalse包含未实现盈亏:0:不包含;1:包含;

响应参数:

参数名类型说明
monthlyTimeListlist月列表
monthlyPnlListlist月盈利列表

用户资产最近分析接口

{
"success": true,
"code": 0,
"data": {
"recentPnl60": -84.62147831458,
"recentPnlRate60": -0.62568913,
"recentPnl90": -84.44672244458,
"recentPnlRate90": -0.62697083,
"recentPnl120": -89.25135078354,
"recentPnlRate120": -0.6389013,
"recentPnl150": -87.83298114164,
"recentPnlRate150": -0.35204645,
"recentPnl180": -87.45807323443,
"recentPnlRate180": -0.3509743,
"recentPnl360": -86.24528816397382638924,
"recentPnlRate360": -0.22856267,
"todayPnlFinished": true
}
}
  • POST api/v1/private/account/asset/analysis/recent/v3

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
reverseintfalse合约类型:0:全部;1:U本位;2: 币本位; 3:usdc本位
includeUnrealisedPnlintfalse包含未实现盈亏:0:不包含;1:包含;
symbolstringfalse交易对

响应参数:

参数名类型说明
recentPnl60decimal近60天盈利
recentPnlRate60decimal近60天盈利率
recentPnl90decimal近90天盈利
recentPnlRate90decimal近90天盈利率
recentPnl120decimal近120天盈利
recentPnlRate120decimal近120天盈利率
recentPnl150decimal近150天盈利
recentPnlRate150decimal近150天盈利率
recentPnl180decimal近180天盈利
recentPnlRate180decimal近180天盈利率
recentPnl360decimal近360天盈利
recentPnlRate360decimal近360天盈利率

用户今日资产分析接口

{
"success": true,
"code": 0,
"data": {
"todayPnl": -0.26538358229,
"todayPnlRate": -0.0019614,
"todayPnlFinished": true
}
}
  • GET api/v1/private/account/asset/analysis/today_pnl

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
reverseintfalse合约类型:0:全部;1:U本位;2: 币本位; 3:usdc本位
includeUnrealisedPnlintfalse包含未实现盈亏:0:不包含;1:包含;

响应参数:

参数名类型说明
todayPnldecimal今日盈亏额
todayPnlRatedecimal今日盈亏率

查询所有现货优惠折扣配置信息

{
"success": true,
"code": 200,
"message": "success",
"data": [
{
"id": 1,
"currency": "MX",
"state": "ENABLED",
"discountConfig": "[{\"day\":1,\"discount\":0.5,\"level\":1,\"volMax\":2147483647,\"volMin\":500}]",
"ineffectiveDiscountConfig": "",
"operator": "",
"createTime": 1699775818000,
"updateTime": 1732982217000,
"enabled": true
}
]
}
  • GET api/v1/private/account/config/contractFeeDiscountConfig

需要权限: 读取账户信息

请求参数:

响应参数:

参数名类型说明
currencystring抵扣币种
statestring状态:ENABLED,DISABLED
discountConfigstring折扣配置,JSON:[{"level":1,"volMin":0, "volMax":12,"day":7,"discount":0.8}]
blackContractIdSetlist不能参与折扣合约ID号列表

查询合约手续费抵扣详情

{
"success": true,
"code": 0,
"data": [
{
"id": 54236193,
"orderId": 739132568196170240,
"feeCurrency": "USDT",
"fee": 0.0906990372,
"deductType": 2,
"deductFeeCurrency": "USDT",
"deductFee": 0.0906990372,
"timestamp": 1761893337000
},
{
"id": 52060733,
"orderId": 735908917455962624,
"feeCurrency": "USDT",
"fee": 0.297936756,
"deductType": 0,
"timestamp": 1761124758000
}
]
}
  • GET api/v1/private/order/fee_details

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringtrue合约名
idslongfalse成交id,批量最多可传20个
start_timelongfalse开始时间,不传默认为向前推7天的时间,传了时间,最大跨度为90天
end_timelongfalse结束时间,开始和结束时间的跨度为90天
page_numintfalse当前页数,默认为1
page_sizeintfalse每页大小,默认20,最大100

响应参数:

参数名类型说明
idlong成交id
symbolstring合约名
orderIdlong订单id
feeCurrencystring收费币种
feedecimal手续费
deductTypestring抵扣类型:0=未抵扣,1=MXPOINT抵扣,2=赠金抵扣
deductFeeCurrencystring抵扣手续费币种
deductFeedecimal抵扣手续费
timestamplong成交时间

用户享受的优惠信息查询

有现货费率优惠折扣,则享受现货折扣配置,若有合约mx持仓则享受mx抵扣

{
"success": true,
"code": 0,
"data": {
"useFeeDiscount": true,
"useFeeDeduct": false
}
}
  • GET api/v1/private/account/discountType

需要权限: 读取账户信息

请求参数:

响应参数:

参数名类型说明
useFeeDiscountboolean使用现货优惠折扣费率
useFeeDeductboolean使用合约抵扣费率

盈亏分析导出

  • GET api/v1/private/account/asset/analysis/export

需要权限: 读取账户信息

Header请求参数:

参数名类型是否必填说明
timezone-loginstringtrue时区;例:UTC+08:00

请求参数:

参数名类型说明
startTimelong导出开始时间(毫秒)
endTimelong导出结束时间
reverseint合约类型:0:全部;1:U本位;2: 币本位;
includeUnrealisedPnlint包含未实现盈亏:0:不包含;1:包含;
symbolstring交易对
fileTypeint导出文件类型 1-EXCEL 2-PDF
languagestring语言;例:zh-CN

响应参数:

30天内手续费统计

{
"success": true,
"code": 0,
"data": {
"totalFee": 0,
"saveFee": 0
}
}
  • GET api/v1/private/account/asset_book/order_deal_fee/total

需要权限: 读取账户信息

请求参数:

响应参数:

参数名类型说明
totalFeedecimal总手续费(小数点后保留4位) 默认是0
saveFeedecimal已节约(小数点后保留4位) 默认是0

指定合约下的手续费详情

{
"success": true,
"code": 0,
"data": [
{
"contractId": 10,
"symbol": "BTC_USDT",
"isMaxLeverage": true,
"isZeroFeeRate": true,
"maxLeverage": 500,
"countryConfigContractMaxLeverage": 0,
"takerFeeRate": 0,
"makerFeeRate": 0,
"feeRateMode": "TIERED",
"leverageFeeRates": [],
"tieredFeeRates": [
{
"takerFeeRate": 0,
"makerFeeRate": 0,
"minTieredDealAmount": 0,
"maxTieredDealAmount": 10000000
},
{
"takerFeeRate": 0.0004,
"makerFeeRate": 0.0001,
"minTieredDealAmount": 10000001
}
],
"tieredDealAmount": 164,
"tieredEffectiveDay": 0,
"tieredAppointContract": true,
"tieredExcludeContractId": true,
"tieredContractIds": [
10,
77,
1104
],
"tieredExcludeZeroFee": false,
"statisticType": "FIXED",
"fixedStartTime": 1760544000000,
"fixedEndTime": 1763049600000,
"agentFee": false
}
]
}
  • GET api/v1/private/account/contract/fee_rate

需要权限: 读取账户信息

请求参数:

参数名类型是否必填说明
symbolstringfalse交易对

响应参数:

参数名类型说明
isZeroFeeRateboolean零费率标签 true 零费率标签 false 不是零费率标签
contractIdint合约id
symbolstring交易对
maxLeverageint最大杠杆倍数
feeRateModestring费率模式;LEVERAGE:杠杆费率 NORMAL:普通费率;TIERED:阶梯费率模式
takerFeeRatedecimaltaker费
makerFeeRatedecimalmaker费
leverageFeeRateslist杠杆费率;当feeRateMode为LEVERAGE时,当字段才会有值
tieredFeeRateslist阶梯费率;当feeRateMode为TIERED时,当字段才会有值
tieredDealAmountdecimal交易金额
tieredEffectiveDayint有效天数
tieredAppointContractboolean是否指定合约;false:不指定;true:指定
tieredExcludeContractIdbooleanfalse:不包含,true:包含
tieredContractIdsstring合约ID号,例[10,11]
tieredExcludeZeroFeeboolean是否排出0费率交易额;false:不排出,true:排出
statisticTypestring阶梯费率交易额统计维度ROLLING 滚动 FIXED 固定
fixedStartTimelong固定模式 开始时间
fixedEndTimelong固定模式 结束时间

0费率交易对

{
"success": true,
"code": 0,
"data": {
"contracts": [
{
"contractId": 10,
"ifHotTag": false
}
],
"hotRecs": []
}
}
  • GET api/v1/private/account/contract/zero_fee_rate

需要权限: 读取订单信息

请求参数:

参数名类型是否必填说明
symbolstringfalse交易对

响应参数:

参数名类型说明
contractslist0费率交易对列表;[{"contractId":合约id}]