Skip to main content

Position Tools

Tools for position management.

Read-only

get_positions

Query real-time position data.

Parameters:

NameTypeRequiredDescription
categorystringYeslinear, inverse, option
symbolstringNoTrading pair
baseCoinstringNoBase coin
settleCoinstringNoSettle coin
limitintNoMax 200, default 20
cursorstringNoPagination cursor

Example prompt: "Show my open positions"


get_closed_pnl

Query closed profit and loss records.

Parameters:

NameTypeRequiredDescription
categorystringYeslinear, inverse
symbolstringNoTrading pair
startTimeintNoStart timestamp (ms)
endTimeintNoEnd timestamp (ms)
limitintNoMax 100, default 50
cursorstringNoPagination cursor

Write (requires trade mode)

set_leverage

Set leverage for a symbol. HIGH risk — requires confirmation.

Parameters:

NameTypeRequiredDescription
categorystringYeslinear, inverse
symbolstringYesTrading pair
buyLeveragestringYesBuy side leverage
sellLeveragestringYesSell side leverage
warning

Changing leverage affects margin requirements for existing positions.


set_trading_stop

Set take profit, stop loss, or trailing stop for a position. MEDIUM risk.

Parameters:

NameTypeRequiredDescription
categorystringYeslinear, inverse
symbolstringYesTrading pair
takeProfitstringNoTP price
stopLossstringNoSL price
trailingStopstringNoTrailing stop distance
tpTriggerBystringNoLastPrice, MarkPrice, IndexPrice
slTriggerBystringNoSL trigger price type
tpSizestringNoTP order quantity
slSizestringNoSL order quantity
positionIdxintNo0: one-way, 1: hedge buy, 2: hedge sell

set_auto_add_margin

Turn on/off auto-add-margin for isolated margin position. MEDIUM risk.

Parameters:

NameTypeRequiredDescription
categorystringYeslinear
symbolstringYesTrading pair
autoAddMarginintYes0 = off, 1 = on
positionIdxintNo0: one-way, 1: hedge buy, 2: hedge sell