跳到主要內容

合約帳戶餘額訂閱

資訊
  • 此功能使用前需要呼叫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
}