Query Portfolio Position

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 Parameters

FieldTypeNecessaryDescription
symStringNTrading pair unique identifier. e.g. BINANCE_PERP_BTC_USDT, OKX_PERP_BTC_USDT, EDX_PERP_ETH_USDT. If omitted, all pairs are returned.
exchangeStringNExchange filter. e.g. BINANCE, OKX, EDX.

Response Fields

FieldTypeDescription
positionIdStringUnique identifier for the position.
portfolioIdStringUnique identifier for the portfolio.
symStringTrading pair unique identifier.
positionSideStringSide of the position: LONG, SHORT, or NONE.
positionMarginStringPosition margin.
positionMMStringPosition maintenance margin.
positionQtyStringPosition quantity. Positive indicates long, negative indicates short. Units vary by exchange: contracts for OKX, base currency for BINANCE.
positionValueStringPosition value.
unrealizedPNLStringUnrealized PNL.
unrealizedPNLRateStringUnrealized PNL percentage.
avgPriceStringAverage entry price.
markPriceStringMark price.
leverageStringCurrent leverage.
maxLeverageStringMaximum allowed leverage.
riskLevelStringRisk level. See Trading Rules for detail.
feeStringTrading fee.
fundingFeeStringFunding fee.
createAtStringCreation timestamp in milliseconds.
updateAtStringLast update timestamp in milliseconds.
liqPriceStringEstimated liquidation price. Returns a numeric string (e.g. "913.006664676013") when calculable; null if position size is too small to trigger liquidation.
tpslOrderArrayList of associated Take-Profit / Stop-Loss orders.
Query Params
string
string
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json