Get LTV

Get your loan-to-value (LTV) ratio.

important

• In cases where an institutional user makes frequent transfers, LTV calculations may become inaccurate, and this endpoint will return retCode = 100016, retMsg = "Transfers within your risk unit are too frequent. Please reduce the transfer frequency and try again."
• If you encounter this error, it is recommended to reduce the transfer frequency first and retry
• During periods of extreme market volatility, this interface may experience increased latency or temporary delays in data delivery
• When a user is in a state such as liquidation, transfer, or manual repayment, LTV is not calculated. We have added a new liqStatus to represent these states. When liqStatus != 0, ltvInfo returns empty strings for ltv, unpaidAmount and balance, and unpaidInfo and balanceInfo return empty arrays.

HTTP Request

GET /v5/ins-loan/ltv-convert

Request Parameters

None

Response Parameters

Parameter	Type	Comments
ltvInfo	array	Object
> ltv	string	Risk rate ltv is calculated in real time If you have an INS loan, it is highly recommended to query this data every second. Liquidation occurs when it reachs 0.9 (90%) . When liqStatus != 0, empty string is returned.
> rst	string	Remaining liquidation time (UTC time in seconds). When it is not triggered, it is displayed as an empty string. When liqStatus != 0, empty string is returned.
> parentUid	string	The designated Risk Unit ID that was used to bind with the INS loan
> subAccountUids	array	Bound user ID
> unpaidAmount	string	Total debt(USDT). When liqStatus != 0, empty string is returned.
> unpaidInfo	array	Debt details. When liqStatus != 0, empty array is returned.
>> token	string	coin
>> unpaidQty	string	Unpaid principle
>> unpaidInterest	string	Useless field, please ignore this for now
> balance	string	Total asset (margin coins converted to USDT). Please read here to understand the calculation. When liqStatus != 0, empty string is returned.
> balanceInfo	array	Asset details. When liqStatus != 0, empty array is returned.
>> token	string	Margin coin
>> price	string	Margin coin price
>> qty	string	Margin coin quantity
>> convertedAmount	string	Margin conversion amount
> liqStatus	integer	Liquidation status. 0: Normal 1: Under liquidation 2: Manual repayment in progress 3: Transfer in progress
liqStatus	integer	Liquidation status. 0: Normal 1: Under liquidation 2: Manual repayment in progress 3: Transfer in progress

Request Example

HTTP

GET /v5/ins-loan/ltv-convert HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1686638165351
X-BAPI-RECV-WINDOW: 5000
X-BAPI-SIGN: XXXXX

Python

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
)
print(session.get_ltv())

Node.js

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
  testnet: true,
  key: 'xxxxxxxxxxxxxxxxxx',
  secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
});

client
  .getInstitutionalLendingLTVWithLadderConversionRate()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(error);
  });

Response Example

{
    "retCode": 0,
    "retMsg": "",
    "result": {
        "ltvInfo": [
            {
                "ltv": "0.75",
                "rst": "",
                "parentUid": "xxxxx",
                "subAccountUids": [
                    "60568258"
                ],
                "unpaidAmount": "30",
                "unpaidInfo": [
                    {
                        "token": "USDT",
                        "unpaidQty": "30",
                        "unpaidInterest": "0"
                    }
                ],
                "balance": "40",
                "balanceInfo": [
                    {
                        "token": "USDT",
                        "price": "1",
                        "qty": "40",
                        "convertedAmount": "40"
                    }
                ]
            }
        ]
    },
    "retExtInfo": {},
    "time": 1686638166323
}

When `liqStatus` != 0:
{
    "retCode": 0,
    "retMsg": "",
    "result": {
        "ltvInfo": [
            {
                "ltv": "",
                "parentUid": "100331354",
                "subAccountUids": [
                    "100334094",
                    "100334098"
                ],
                "unpaidAmount": "",
                "unpaidInfo": [],
                "balance": "",
                "balanceInfo": [],
                "rst": "",
                "liqStatus": 3
            }
        ],
        "liqStatus": 3
    },
    "retExtInfo": {},
    "time": 1766462020703
}