Get Risk Unit Force Liquidation Record(USER_DATA)

API Description

Get Institution Loan Risk Unit Force Liquidation Record. This endpoint is accessible only with the credit account API key.

HTTP Request

GET /sapi/v1/margin/loan-group/force-liquidation

Request Weight

1(IP)

Request Parameters

Name	Type	Mandatory	Description
groupId	LONG	NO	Risk unit unique identifier
startTime	LONG	NO
endTime	LONG	NO
current	LONG	NO	The currently querying page. Start from 1. Default:1
size	LONG	NO	Default:10 Max:100
recvWindow	LONG	NO	The value cannot be greater than 60000
timestamp	LONG	YES

• Credit account may query currently activated and closed risk unit based on the parameter groupId. If groupId is empty, only currently activated risk units will be returned.
• Responses are returned in descending order.
• If startTime and endTime are not provided, data from the last 7 days will be returned by default.
• If startTime is omitted, it defaults to endTime minus 7 days.
• If endTime is omitted, it defaults to the current time.
• The time span between startTime and endTime must not exceed 100 days; otherwise, an error will be returned with no records.

Response Example

{
  "total": 2,
  "rows": [
    {
      "groupId": 6,
      "startLtv": 1,
      "endLtv": 0,
      "liquidationStartTime": 1748381716906,
      "liquidationEndTime": 1748525848742,
      "totalNetEquity": 16671.5507973,
      "totalMaintenanceMargin": 0,
      "totalLiability": 16667.926,
      "liquidationSnapshot": {
        "snapshots": [
          {
            "subEmail": "1000255973134@test.com",
            "memberType": "CREDIT",
            "walletType": "PORTFOLIO_MARGIN",
            "netEquity": "12671.05079731",
            "maintainMargin": "0E-8"
          },
          {
            "subEmail": "1000255973134@test.com",
            "memberType": "CREDIT",
            "walletType": "SPOT",
            "netEquity": "0E-8",
            "maintainMargin": "0E-8"
          },
          {
            "subEmail": "1000255973138@test.com",
            "memberType": "COLLATERAL",
            "walletType": "PORTFOLIO_MARGIN",
            "netEquity": "1000.25333000",
            "maintainMargin": "0E-8"
          },
          {
            "subEmail": "1000255973137@test.com",
            "memberType": "COLLATERAL",
            "walletType": "PORTFOLIO_MARGIN",
            "netEquity": "1000.24667000",
            "maintainMargin": "0E-8"
          },
          {
            "subEmail": "1000255973135@test.com",
            "memberType": "COLLATERAL",
            "walletType": "CROSS_MARGIN",
            "netEquity": "1000.00000000",
            "maintainMargin": "0E-8"
          },
          {
            "subEmail": "1000255973136@test.com",
            "memberType": "COLLATERAL",
            "walletType": "CROSS_MARGIN",
            "netEquity": "1000.00000000",
            "maintainMargin": "0E-8"
          }
        ],
        "liabilities": 
          {"assetName": "USDT",
            "principal": "11667.92600000",
            "interest": "5000.00000000"
          }
      }
    }
  ]
}

Response detail description:

Parameter	Type	Description
total	LONG	Total risk unit number
rows	OBJECT ARRAY
→ groupId	Long	Risk unit unique identifier
→ startLtv	LONG	The initial LTV for the risk unit
→ endLtv	LONG	The current LTV for the risk unit
→ liquidationStartTime	Long	Liquidation start timestamp (milliseconds)
→ liquidationEndTime	Long	Liquidation end timestamp (milliseconds)
→ totalNetEquity	String	∑Equity in all PM sub account + ( ∑Collateral Value - ∑(Liability + Interest) in all Cross Margin account + Free accepted tokens in spot
→totalMaintenanceMargin	String	Aggregated Maintenance Margin
→ totalLiability	String	Outstanding Loan Principal + Outstanding Loan Interest
liquidationSnapshot	OBJECT ARRAY
snapshots	OBJECT ARRAY
→ subEmail	String	Sub account registered email
→ memberType	String	memberType can be "CREDIT" or "COLLATERAL"
→ walletType	String	Account type for sub account . It can be "PORTFOLIO_MARGIN", "SPOT" or "CROSS_MARGIN"
→ netEquity	String	Net equity in wallet
→ maintainMargin	String	Maintenance margin required
liabilities	OBJECT ARRAY
→ assetName	String	Asset name
→ principal	String	Outstanding loan principal amount
→ interest	String	Outstanding loan interest