# 賬戶介面
# 1. 查詢賬戶信息
查詢當前賬戶下永續合約資產的相關信息。
HTTP請求
# Request
POST api/v1/user/getBalance
請求方式
POST
請求參數
參數名 | 參數類型 | 必填 | 欄位描述 | 描述 |
---|---|---|---|---|
apiKey | String | 是 | 介面秘鑰 | |
timestamp | String | 是 | 發起請求的時間戳,單位為毫秒 | |
currency | String | 是 | 合約資產 |
返回值說明
參數名 | 參數類型 | 描述 |
---|---|---|
code | Int64 | 錯誤碼,0表示成功,不為0表示異常失敗 |
msg | String | 錯誤信息提示 |
userId | String | 用戶ID |
currency | String | 用戶資產 |
balance | Float64 | 資產餘額 |
equity | Float64 | 資產凈值 |
unrealisedPNL | Float64 | 未實現盈虧 |
realisedPNL | Float64 | 已實現盈虧 |
availableMargin | Float64 | 可用保證金 |
usedMargin | Float64 | 已用保證金 |
freezedMargin | Float64 | 凍結保證金 |
longLeverage | Float64 | 做多槓桿 |
shortLeverage | Float64 | 做空槓桿 |
# Response
{
"code": 0,
"msg": "",
"data": {
"userId": "123",
"currency": "USDT",
"balance": 123.33,
"equity": 128.99,
"unrealisedPNL": 1.22,
"realisedPNL": 8.1,
"availableMargin": 123.33,
"usedMargin": 2.2,
"freezedMargin": 3.3,
"longLeverage": 10,
"shortLeverage": 10,
}
}
# 2. 查詢持倉信息
查詢當前賬戶下永續合約的持倉信息與盈虧情況。
HTTP請求
# Request
POST api/v1/user/getPositions
請求方式
POST
請求參數
參數名 | 參數類型 | 必填 | 欄位描述 |
---|---|---|---|
symbol | String | 是 | 合約名稱中需有"-",如BTC-USDT,為空則表示全部都返回 |
apiKey | String | 是 | |
timestamp | String | 是 | 發起請求的時間戳,單位為毫秒 |
返回值說明
參數名 | 參數類型 | 描述 |
---|---|---|
code | Int64 | 錯誤碼,0表示成功,不為0表示異常失敗 |
msg | String | 錯誤信息提示 |
symbol | String | 合約品種 |
currency | String | 資產類型 |
positionId | String | 倉位ID |
positionSide | String | 倉位方向 Long/Short 多/空 |
marginMode | String | 保證金模式 Cross/Isolated 全倉/逐倉 |
volume | Float64 | 持倉數量 |
availableVolume | Float64 | 可平倉數量 |
unrealisedPNL | Float64 | 未實現盈虧 |
realisedPNL | Float64 | 已實現盈虧 |
margin | Float64 | 保證金 |
avgPrice | Float64 | 開倉均價 |
liquidatedPrice | Float64 | 預估強平價 |
leverage | Float64 | 槓桿 |
# Response
{
"code": 0,
"msg": "",
"data": {
"positions": [
{
"symbol": "BTC-USDT",
"positionId": "12345678",
"currency": "USDT",
"positionSide": "Long",
"marginMode": "Cross",
"volume": 123.33,
"availableVolume": 128.99,
"unrealisedPNL": 1.22,
"realisedPNL": 8.1,
"margin": 123.33,
"avgPrice": 2.2,
"liquidatedPrice": 2.2,
"leverage": 10,
},
{
"symbol": "ETH-USDT",
"currency": "USDT",
"positionSide": "Short",
"marginMode": "Isolated",
"volume": 123.33,
"availableVolume": 128.99,
"unrealisedPNL": 1.22,
"realisedPNL": 8.1,
"margin": 123.33,
"avgPrice": 2.2,
"liquidatedPrice": 2.2,
"leverage": 10,
},
]
}
}