Query Portfolio Position

Description

Retrieves the current holding details for a specific trading pair within a portfolio. This includes critical financial data such as position size, margin requirements, unrealized profit and loss (PNL), and leverage settings.

Permission

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

Rate Limit

300 requests per 60 seconds.

Request

Field nameTypeNecessaryRemarks
symStringNTrading pair unique identifier, example: BINANCE_PERP_BTC_USDT, OKX_PERP_BTC_USDT, EDX_PEPR_ETH_USDT
exchangeStringNexchange, example: BINANCE, OKX, EDX

Respone

FieldTypeRemark
positionIdStringUnique identifier for the position
portfolioIdStringUnique identifier for the portfolio
symStringTrading pair unique identifier
positionSideStringSide of the position (e.g., LONG, SHORT, NONE)
positionMarginStringPosition margin
positionMMStringPosition maintenance margin
positionQtyStringPosition quantity. Positive indicates long positions, negative indicates short positions. Units vary by exchange: contracts for OKX, base currency for BINANCE.
positionValueStringPosition value
unrealizedPNLStringUnrealized PNL
unrealizedPNLRateStringUnrealized PNL percentage
avgPriceStringAverage entry price
markPriceStringMark price
leverageStringLeverage
maxLeverageStringMax leverage
riskLevelStringRisk level. More detail in Trading Rules
feeStringTrading fee
fundingFeeStringFunding fee
createAtStringCreation timestamp (millisecond)
updateAtStringLast update timestamp (millisecond)
tpslOrderArrayList of associated Take-Profit/Stop-Loss orders
Language
Credentials
OAuth2