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

Requires an API key with read permission. No trading or writing permission required.

Rate Limit

300 requests per 60 seconds.

Request

FieldTypeNecessaryDescription
symStringNTrading pair unique identifier. Example: BINANCE_PERP_BTC_USDT, OKX_PERP_BTC_USDT, EDX_PERP_ETH_USDT. If omitted, all pairs are returned.
exchangeStringNexchange, example: BINANCE, OKX, EDX

Respone

FieldTypeDescription
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)
liqPriceStringEstimated liquidation price. Returns a numeric string (e.g., "913.006664676013") if the position is active and calculable; returns null if the position size is too small to trigger liquidation.
tpslOrderArrayList of associated Take-Profit/Stop-Loss orders
Language