Skip to main content

Get Loan Account Info

HTTP Request

GET /spot/v3/private/cross-margin-account

Request Parameters

None

Response Parameters

ParameterTypeComments
acctBalanceSumstringTotal equity (BTC)
debtBalanceSumstringTotal liability (BTC)
loanAccountListarrayObject
> freestringAvailable balance
> intereststringOutstanding interest
> loanstringOutstanding principle
> remainAmountstringRemaining debt = interest + loan
> lockedstringLocked amount
> tokenIdstringCoin name
> totalstringTotal
riskRatestringRisk rate
statusintegerLoan account status
  • 1: normal
  • 2: withdrawal/transfer restricted
  • 3: liquidation alert triggered
  • 4: liquidated
switchStatusinteger0: margin trade off, 1: margin trade on

Request Example

GET /spot/v3/private/cross-margin-account HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-API-KEY: XXXXXX
X-BAPI-TIMESTAMP: 1677751305868
X-BAPI-RECV-WINDOW: 5000
X-BAPI-SIGN: XXXXXX

Response Example

{
"retCode": 0,
"retMsg": "success",
"result": {
"acctBalanceSum": "0.455189592150138021",
"debtBalanceSum": "0",
"loanAccountList": [
{
"free": "0.01444",
"interest": "0",
"loan": "0",
"locked": "0",
"remainAmount": "0",
"tokenId": "BTC",
"total": "0.01444"
},
{
"free": "0.21147048",
"interest": "0",
"loan": "0",
"locked": "0",
"remainAmount": "0",
"tokenId": "ETH",
"total": "0.21147048"
},
{
"free": "7963.58978991849",
"interest": "0",
"loan": "0",
"locked": "0",
"remainAmount": "0",
"tokenId": "USDT",
"total": "7963.58978991849"
},
{
"free": "1380.28832",
"interest": "0",
"loan": "0",
"locked": "0",
"remainAmount": "0",
"tokenId": "USDC",
"total": "1380.28832"
}
],
"riskRate": "0",
"status": 1,
"switchStatus": 1
},
"retExtInfo": {},
"time": 1677751306287
}