Query ADL Rank

Description

Query the Auto-Deleveraging (ADL) rank of your open positions.

  • If sym is not provided, the API returns ADL ranks for all symbols where your position size is non-zero.
  • If sym is provided, only the ADL rank(s) for that specific symbol are returned.

This endpoint is useful for monitoring your liquidation / ADL priority on different venues and symbols.

Rate Limit

10 requests per 60 seconds

Permission

RapidX API key with read-only permission is sufficient. No trading / write permission is required.

Request

FieldTypeRequiredDescription
symStringNUnified symbol identifier (e.g. BINANCE_PERP_BTC_USDT). If omitted, return ADL ranks for all symbols where the user’s position size is non-zero.

Response

FieldTypeDescription
codeIntegerBusiness status code. 200000 indicates success.
msgStringHuman-readable message, e.g. "success".
dataObjectResponse payload.

data.adlRanks[] Item

Each object in adlRanks represents the ADL information for one position (per symbol & side).

FieldTypeDescription
symStringUnified symbol identifier, e.g. BINANCE_PERP_BTC_USDT.
adlRankStringADL rank / priority for this position on the venue. Bigger values usually indicate higher ADL priority (more likely to be auto-deleveraged).
positionIdStringBiggerInternal position ID for this symbol and side within the portfolio.
positionSideStringPosition side, e.g. LONG or SHORT.
Language
Credentials
OAuth2