合约账户接口

查询所有合约账户信息

限速规则:1次/s

HTTP请求 查询所有合约账户信息

  • GET /api/swap/v3/account/accounts

返回数据:

[ 
  {
   "symbol":"cmt_btcusdt", //合约名称
   "equity":"0.00000000",  //账户权益
   "fixed_balance":"0.00000000",//废弃字段
   "total_avail_balance":"0.00000000", //可用余额
   "margin":"0", //已用保证金
   "realized_pnl":"0", //已实现盈亏
   "unrealized_pnl":"0", //未实现盈亏
   "longMarginRatio":"0",//逐仓多仓保证金率
   "shortMarginRatio": "0",//逐仓空仓保证金率
   "marginRatio": "0",//全仓保证金率
   "margin_frozen":"0", //开仓冻结保证金
   "timestamp":"1658098718494", //创建时间
   "margin_mode":"fixed", //仓位模式 fixed逐仓模式 crossed全仓模式
   "forwardContractFlag":true //是否是正向合约
 }
]

返回值说明

返回字段
字段说明

symbol

合约名称

equity

账户权益

fixed_balance

逐仓可用余额

total_avail_balance

可用余额

margin

已用保证金

realized_pnl

已实现盈亏

unrealized_pnl

未实现盈亏

longMarginRatio

逐仓多仓保证金率

shortMarginRatio

逐仓空仓保证金率

marginRatio

全仓保证金率

margin_frozen

开仓冻结保证金

timestamp

创建时间

margin_mode

仓位模式 fixed逐仓模式 crossed全仓模式

forwardContractFlag

是否是正向合约

单个合约账户信息

限速规则:5次/s

HTTP请求 单个合约账户信息

  • GET /api/swap/v3/account/account

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "equity":"0.00000000", //账户权益
   "fixed_balance":"0.00000000", //废弃字段
   "total_avail_balance":"0.00000000", //可用余额
   "margin":"0", //已用保证金
   "realized_pnl":"0", //已实现盈亏
   "unrealized_pnl":"0", //未实现盈亏
   "longMarginRatio":"0",//逐仓多仓保证金率
   "shortMarginRatio": "0",//逐仓空仓保证金率
   "marginRatio": "0",//全仓保证金率
   "margin_frozen":"0", //开仓冻结保证金
   "timestamp":"1658098718494", //创建时间
   "margin_mode":"fixed", //仓位模式 fixed逐仓模式 crossed全仓模式
   "forwardContractFlag":true //是否是正向合约
 }

返回值说明

返回字段
字段说明

symbol

合约名称

equity

账户权益

fixed_balance

逐仓可用余额

total_avail_balance

可用余额

margin

已用保证金

realized_pnl

已实现盈亏

unrealized_pnl

未实现盈亏

longMarginRatio

逐仓多仓保证金率

shortMarginRatio

逐仓空仓保证金率

marginRatio

全仓保证金率

margin_frozen

开仓冻结保证金

timestamp

创建时间

margin_mode

仓位模式 fixed逐仓模式 crossed全仓模式

forwardContractFlag

是否是正向合约

获取单个合约的用户配置

限速规则:5次/s

HTTP请求 获取单个合约的用户配置

  • GET /api/swap/v3/account/settings

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

返回数据:

 {
   "symbol":"cmt_btcusdt", //合约名称
   "long_leverage":"100", //多仓杠杆
   "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
   "short_leverage":"2", //空仓杠杆
   "forwardContractFlag":true //是否是正向合约
 }

返回值说明

返回字段
字段说明

symbol

合约名称

long_leverage

多仓杠杆

margin_mode

持仓模式 fixed逐仓模式 crossed全仓模式

short_leverage

空仓杠杆

forwardContractFlag

是否是正向合约

调整杠杆

限速规则:5次/s

HTTP请求 调整杠杆

  • POST /api/swap/v3/account/leverage

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

leverage

Integer

杠杆倍数,可填写1-100之间的整数

side

Integer

持仓方向(1-多仓,2-空仓)

holdSide

Integer

持仓方向 (1-多仓,2-空仓) 全仓时此字段可以不传值

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "long_leverage":"100", //多仓杠杆
   "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
   "short_leverage":"2", //空仓杠杆
   "forwardContractFlag":true //是否是正向合约
 }

返回值说明

返回字段
字段说明

symbol

合约名称

long_leverage

多仓杠杆

margin_mode

持仓模式 fixed逐仓模式 crossed全仓模式

short_leverage

空仓杠杆

forwardContractFlag

是否是正向合约

调整保证金

限速规则:20次/2s

HTTP请求 调整保证金

  • POST /api/swap/v3/account/adjustMargin

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

amount

String

数量

positionType

Integer

方向0多仓 1空仓

type

Integer

类型1增加 2减少

返回数据:

 {
    "result":true, //结果
    "orderNo":"527252921197264814" //订单号
 }

返回值说明

返回字段
字段说明

result

结果

orderNo

订单号

自动追加保证金

限速规则:5次/s

HTTP请求 自动追加保证金

  • POST /api/swap/v3/account/modifyAutoAppendMargin

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

side

Integer

持仓方向 1多仓 2空仓 标注废弃

holdSide

Integer

持仓方向 1多仓 2空仓

append_type

Integer

追加保证金类型 0 不自动追加 1 自动追加

返回数据:

 {
     "result":true, //设置结果
     "append_type":1 //当前设置状态:0表示不自动追加,1表示自动追加
 }

返回值说明

返回字段
字段说明

result

设置结果

append_type

当前设置状态:0表示不自动追加,1表示自动追加

获取全部合约仓位信息

限速规则:5次/s

HTTP请求 获取全部合约仓位信息

  • GET /api/swap/v3/position/allPosition

返回数据:

 [
 {
    "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
    "holding":[
           {
              "symbol":"cmt_btcusdt",  //合约名称
              "liquidation_price":"0.00", //预估爆仓价
              "position":"0", //持仓数量
              "avail_position":"0", //可平数量
              "avg_cost":"0.00", //开仓平均价
              "leverage":"2", //杠杆
              "realized_pnl":"0.00000000", //已实现盈亏
              "keepMarginRate":"0.005",   //维持保证金率
              "side":"1", //持仓方向  标注废弃
              "holdSide": "1",// 持仓方向
              "timestamp":"1557571623963", //系统时间戳
              "margin":"0.0000000000000000", //已用保证金
              "unrealized_pnl":"0.00000000" //未实现盈亏
       }
     ]
 }
]

返回值说明

返回字段
字段说明

margin_mode

持仓模式 fixed逐仓模式 crossed全仓模式

symbol

合约名称

liquidation_price

预估爆仓价

position

持仓数量

avail_position

可平数量

avg_cost

开仓平均价

leverage

杠杆

realized_pnl

已实现盈亏

keepMarginRate

维持保证金率

side

方向

holdSide

持仓方向

timestamp

系统时间戳

margin

已用保证金

unrealized_pnl

未实现盈亏

获取单个合约仓位信息

限速规则:10次/s

HTTP请求 获取单个合约仓位信息

  • GET /api/swap/v3/position/singlePosition

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

返回数据:

{
    "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
    "holding":[
           {
              "symbol":"cmt_btcusdt", //合约名称
              "liquidation_price":"0.00", //预估爆仓价
              "position":"0", //持仓数量
              "avail_position":"0", //可平数量
              "avg_cost":"0.00", //开仓平均价
              "leverage":"2", //杠杆
              "realized_pnl":"0.00000000", //已实现盈亏
              "keepMarginRate":"0.005",   //维持保证金率
              "side":"1", //持仓方向    标注废弃
              "holdSide": "1",// 持仓方向
              "timestamp":"1557571623963", //系统时间戳
              "margin":"0.0000000000000000", //已用保证金
              "unrealized_pnl":"0.00000000" //未实现盈亏
       }
     ]
 }

返回值说明

返回字段
字段说明

margin_mode

持仓模式 fixed逐仓模式 crossed全仓模式

symbol

合约名称

liquidation_price

预估爆仓价

position

持仓数量

avail_position

可平数量

avg_cost

开仓平均价

leverage

杠杆

realized_pnl

已实现盈亏

keepMarginRate

维持保证金率

side

方向

holdSide

持仓方向

timestamp

系统时间戳

margin

已用保证金

unrealized_pnl

未实现盈亏

修改用户账户模式

限速规则:20次/s

HTTP请求 修改用户账户模式

  • POST /api/swap/v3/position/changeHoldModel

请求参数

参数名
参数类型
是否必须
描述

symbol

String

合约名称

holdModel

Integer

账户模式(1 逐仓 2 全仓)

返回数据:

 {
    "symbol":"cmt_btcusdt",     //合约名称
    "resultHoldMode":1,        //返回账户模式 1 逐仓 2 全仓
    "switchSuccess":true,      //是否修改成功  true 成功  false 失败
    "longLeverage":20,         //多仓杠杆
    "shortLeverage":20,       //空仓杠杆
    "userId":111             //uid
}

返回值说明

返回字段
字段说明

symbol

合约名称

resultHoldMode

返回账户模式 1 逐仓 2 全仓

longLeverage

多仓杠杆

shortLeverage

空仓杠杆

userId

用户id

switchSuccess

是否修改成功 true 成功 false 失败

Last updated