Position

View as Markdown

Note

Position endpoints require trade permission.

Set Leverage

POST /v1/private/position/leverage
Content-Type: application/json

Request body:

{
"symbol": "BTCUSDT",
"leverage": 20
}

Response fields:

FieldTypeDescription
symbolstringSymbol
leverageint32Leverage
timestampint64Timestamp

Set Margin Mode

POST /v1/private/position/margin-mode
Content-Type: application/json

Request body:

{
"symbol": "BTCUSDT",
"marginMode": 1
}

marginMode: 1 cross, 2 isolated.

Position Settings

GET /v1/private/position/settings?symbol=BTCUSDT

Response fields:

FieldTypeDescription
symbolstringSymbol
marginModeint321 cross, 2 isolated
leverageint32Leverage

Current Positions

GET /v1/private/position/positions?symbol=BTCUSDT

Request parameters:

ParameterTypeRequiredDescription
symbolstringNoSymbol

Response fields:

FieldTypeDescription
positions[].symbolstringSymbol
positions[].marginModestringMargin mode
positions[].positionSidestringPosition side
positions[].leverageint32Leverage
positions[].quantitystringPosition quantity
positions[].entryPricestringEntry price
positions[].breakEvenPricestringBreak-even price
positions[].liqPricestringLiquidation price
positions[].marginRatiostringMargin ratio
positions[].unrealizedPnlstringUnrealized PnL
positions[].roestringReturn on equity
positions[].nextFundingFeestringEstimated next funding fee
positions[].fundingFeeAccumstringAccumulated funding fee
positions[].tpPricestringTake-profit price
positions[].slPricestringStop-loss price

Position History

GET /v1/private/position/history?symbol=BTCUSDT&page=1&pageSize=20

Request parameters:

ParameterTypeRequiredDescription
symbolstringNoSymbol
sidestringNolong / short
startTimeint64NoStart time
endTimeint64NoEnd time
pageint64NoPage number, default 1
pageSizeint64NoItems per page, default 20

Response fields:

FieldTypeDescription
list[].symbolstringSymbol
list[].positionSidestringPosition side
list[].leverageint32Leverage
list[].maxQuantitystringMaximum position quantity
list[].entryPricestringEntry price
list[].closePricestringClose price
list[].pnlstringRealized PnL
list[].roestringReturn on equity
list[].marginModestringMargin mode
list[].triggerModeint32Close trigger mode
list[].fundingFeeAccumstringAccumulated funding fee
list[].openedAtint64Open time
list[].closedAtint64Close time
totalint64Total count