API Reference

Query Portfolio History Position

Rate Limit: 3 requests per 10 seconds

Request

NameTypeMandatoryDescription
symStringNTrading pair unique identifier, example: BINANCE_PERP_BTC_USDT, OKX_PERP_BTC_USDT
exchangeStringNexchange
beginStringNStart time, default is to query data that is up to 90 days ago
endStringNEnd time
pageStringNCurrent page (Default 1)
pageSizeStringNPage size(Default 1000, max 1000)

Respone

FieldTypeRemark
positionIdStringPosition Id
portfolioIdStringPortfolio Id
portfolioNameStringPortfolio name
symStringTrading pair unique identifier
closedTypeStringPARTIAL_CLOSED , COMPLETE_CLOSED ,LIQUIDATION
closedPnlStringClosed pnl
closedPnlRatioStringClosed pnl ratio
closedAvgPriceStringClosed average price
maxPositionQtyStringMax position quantity, the unit for OKX is piece, for BINANCE is coin
closedQtyStringClosed quantity, the unit for OKX is piece, for BINANCE is coin
liqFeeStringLiquidation fee
fundingFeeStringFunding fee
feeStringTrading fee
leverageStringLeverage
openAvgPriceStringOpen average price
positionHistorySideStringPosition side
createAtStringCreate time
updateAtStringUpdate time
Language