Trade

Endpoint

Get Risk Unit Force Liquidation Record (USER_DATA)

Get institutional loan risk unit force liquidation records. This endpoint is accessible only with the credit account API key.

GET

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

https://api.binance.com

Get Risk Unit Force Liquidation Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Risk Unit Force Liquidation Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Get Risk Unit Force Liquidation Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Risk Unit Force Liquidation Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request.

Example: 1770736694138

groupId

integer · int64

Risk unit unique identifier

Example: 6

startTime

integer · int64

Start time in milliseconds.

Example: 1748381716906

endTime

integer · int64

End time in milliseconds.

Example: 1748525848742

current

integer · int64

Current page number. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of records per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Get Risk Unit Force Liquidation Record (USER_DATA) › Responses

200

Risk Unit Force Liquidation Records

total

integer · int64

Total risk unit number

Example: 2

object[]

groupId

integer · int64

Risk unit unique identifier.

Example: 6

startLtv

integer · int64

The initial LTV for the risk unit

Example: 1

endLtv

integer · int64

The current LTV for the risk unit

Example: 0

liquidationStartTime

integer · int64

Liquidation start timestamp (milliseconds)

Example: 1748381716906

liquidationEndTime

integer · int64

Liquidation end timestamp (milliseconds)

Example: 1748525848742

totalNetEquity

string

∑Equity in all PM sub account + ( ∑Collateral Value - ∑(Liability + Interest) in all Cross Margin account + Free accepted tokens in spot

Example: 16671.5507973

totalMaintenanceMargin

string

Aggregated Maintenance Margin

Example: 0

totalLiability

string

Outstanding Loan Principal + Outstanding Loan Interest

Example: 16667.926

object

object[]

subEmail

string

Sub account registered email

Example: 1000255973134@test.com

memberType

string

member type, "CREDIT" or "COLLATERAL"

Example: CREDIT

walletType

string

SPOT or PORTFOLIO MARGIN or CROSS MARGIN ACCOUNT

Example: PORTFOLIO_MARGIN

netEquity

string

account net equity

Example: 12671.05079731

maintainMargin

string

maintenance margin

Example: 0E-8

object[]

assetName

string

asset name

Example: USDT

principal

string

outstanding principal

Example: 11667.92600000

interest

string

outstanding interest

Example: 5000.00000000

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

curl --request GET \
  --url 'https://api.binance.com/sapi/v1/margin/loan-group/force-liquidation?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "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"
          }
        ],
        "liabilities": [
          {
            "assetName": "USDT",
            "principal": "11667.92600000",
            "interest": "5000.00000000"
          }
        ]
      }
    }
  ]
}

json

application/json

Get Risk Unit Force Liquidation Record (USER_DATA)

Get institutional loan risk unit force liquidation records. This endpoint is accessible only with the credit account API key.

GET

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

https://api.binance.com

Get Risk Unit Force Liquidation Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Risk Unit Force Liquidation Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Get Risk Unit Force Liquidation Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Risk Unit Force Liquidation Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request.

Example: 1770736694138

groupId

integer · int64

Risk unit unique identifier

Example: 6

startTime

integer · int64

Start time in milliseconds.

Example: 1748381716906

endTime

integer · int64

End time in milliseconds.

Example: 1748525848742

current

integer · int64

Current page number. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of records per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Get Risk Unit Force Liquidation Record (USER_DATA) › Responses

200

Risk Unit Force Liquidation Records

total

integer · int64

Total risk unit number

Example: 2

object[]

groupId

integer · int64

Risk unit unique identifier.

Example: 6

startLtv

integer · int64

The initial LTV for the risk unit

Example: 1

endLtv

integer · int64

The current LTV for the risk unit

Example: 0

liquidationStartTime

integer · int64

Liquidation start timestamp (milliseconds)

Example: 1748381716906

liquidationEndTime

integer · int64

Liquidation end timestamp (milliseconds)

Example: 1748525848742

totalNetEquity

string

∑Equity in all PM sub account + ( ∑Collateral Value - ∑(Liability + Interest) in all Cross Margin account + Free accepted tokens in spot

Example: 16671.5507973

totalMaintenanceMargin

string

Aggregated Maintenance Margin

Example: 0

totalLiability

string

Outstanding Loan Principal + Outstanding Loan Interest

Example: 16667.926

object

object[]

subEmail

string

Sub account registered email

Example: 1000255973134@test.com

memberType

string

member type, "CREDIT" or "COLLATERAL"

Example: CREDIT

walletType

string

SPOT or PORTFOLIO MARGIN or CROSS MARGIN ACCOUNT

Example: PORTFOLIO_MARGIN

netEquity

string

account net equity

Example: 12671.05079731

maintainMargin

string

maintenance margin

Example: 0E-8

object[]

assetName

string

asset name

Example: USDT

principal

string

outstanding principal

Example: 11667.92600000

interest

string

outstanding interest

Example: 5000.00000000