跳到主要内容

合约账户余额订阅

信息
  • 该功能使用之前需要调用server.sign方法进行签名鉴权，具体签名规则请参阅认证
  • 该接口推送延迟为：50~100ms

资产余额订阅​

  • 方法: balance.subscribe
  • 参数:
参数名是否必须类型说明
ccy_listtrue[]string资产名列表
  • 订阅示例:
// 订阅单个资产余额
{
    "method": "balance.subscribe",
    "params": {"ccy_list": ["USDT"]},
    "id": 1
}

// 订阅多个资产余额
{
    "method": "balance.subscribe",
    "params": {"ccy_list": ["BTC", "ETH"]},
    "id": 1
}

// 订阅所有资产余额
{
    "method": "balance.subscribe",
    "params": {"ccy_list": []},
    "id": 1
}

资产余额推送​

  • 方法: balance.update
  • 参数:
参数名类型说明
balance_list[n].ccystring资产名
balance_list[n].account_balancestring账户余额。
账户余额=全仓余额+逐仓余额=账户转入金额-账户转出金额+已实现盈亏
balance_list[n].cross_balancestring全仓余额。
全仓余额=账户余额-逐仓余额=账户余额-逐仓占用保证金
balance_list[n].isolated_balancestring逐仓余额，即所有逐仓仓位占用的保证金。
逐仓余额=逐仓占用保证金=账户余额-全仓余额
balance_list[n].availablestring待废弃字段。当前含义同isolated_margin_avbl，即逐仓可用保证金
balance_list[n].frozenstring冻结余额
balance_list[n].marginstring仓位保证金。
仓位保证金=逐仓占用保证金。全仓占用保证金没有实际划转占用，不计入该字段
balance_list[n].cross_margin_avblstring全仓可用保证金。
全仓可用保证金=Max（0，全仓余额+所有全仓未实现盈亏-所有全仓占用保证金-冻结保证金）
balance_list[n].isolated_margin_avblstring逐仓可用保证金。
全仓理论可转=Max（0，全仓余额+Min（0，所有全仓未实现盈亏）-所有全仓初始保证金-冻结保证金）
全仓风控可转=Max（0，全仓仓位保证金-全仓维持保证金-N*全仓仓位价值）
逐仓可用保证金=Min（全仓理论可转，全仓风控可转）
N值暂定为1.5%
balance_list[n].transferrablestring合约账户可转金额，当前值等于isolated_margin_avbl，即逐仓可用保证金
balance_list[n].unrealized_pnlstring未实现收益
balance_list[n].equitystring账户权益
  • 示例:
{
    "method": "balance.update",
    "data": {
        "balance_list": [
            {
                "ccy": "USDT",
                "account_balance": "98.53913682756335000001",
                "cross_balance": "97.92470982756335000001",
                "isolated_balance": "0.61442700000000000000",
                "available": "0.61442700000000000000",
                "frozen": "0.00000000000000000000",
                "margin": "0.61442700000000000000",
                "cross_margin_avbl": "0.00000000000000000000",
                "isolated_margin_avbl": "0.61442700000000000000",
                "transferrable": "0.61442700000000000000",
                "unrealized_pnl": "-0.00807000000000000000",
                "equity": "97.92470982756335000001"
            },
            {
                "ccy": "BTC",
                "account_balance": "98.53913682756335000001",
                "cross_balance": "97.92470982756335000001",
                "isolated_balance": "0.61442700000000000000",
                "available": "0.61442700000000000000",
                "frozen": "0.00000000000000000000",
                "margin": "0.61442700000000000000",
                "cross_margin_avbl": "0.00000000000000000000",
                "isolated_margin_avbl": "0.61442700000000000000",
                "transferrable": "0.61442700000000000000",
                "unrealized_pnl": "-0.00807000000000000000",
                "equity": "97.92470982756335000001"
            }
        ]
    },
    "id": null
}

取消资产余额订阅​

  • 方法: balance.unsubscribe
  • 参数:
参数名是否必须类型说明
ccy_listtrue[]string资产名列表
  • 示例:
// 取消单个资产余额订阅
{
    "method": "balance.unsubscribe",
    "params": {"ccy_list": ["USDT"]},
    "id": 1
}

// 取消多个资产余额订阅
{
    "method": "balance.unsubscribe",
    "params": {"ccy_list": ["BTC", "ETH"]},
    "id": 1
}

// 取消所有资产余额订阅
{
    "method": "balance.unsubscribe",
    "params": {"ccy_list": []},
    "id": 1
}