Position.md

Position

Properties

Name	Type	Description	Notes
user	number	User ID	[optional] [readonly] [default to undefined]
contract	string	Futures contract	[optional] [readonly] [default to undefined]
size	string	Position size	[optional] [readonly] [default to undefined]
hedgeStatus	string	The hedging status of the position under the Delta-neutral strategy. Including: - `partial_hedged`: partially hedged - `full_hedged`: fully hedged	[optional] [readonly] [default to undefined]
hedgedSize	string	The hedged position size under the Delta-neutral strategy.	[optional] [readonly] [default to undefined]
unhedgedSize	string	The unhedged position size under the Delta-neutral strategy, calculated as `max(abs(size) - abs(hedged_size), 0)`.	[optional] [readonly] [default to undefined]
leverage	string	leverage for isolated margin. 0 means cross margin. For leverage of cross margin, please refer to `cross_leverage_limit`.	[optional] [default to undefined]
riskLimit	string	Position risk limit	[optional] [default to undefined]
leverageMax	string	the maximum permissible leverage given to the current positon value: the higher positon value, the lower maximum permissible leverage	[optional] [readonly] [default to undefined]
maintenanceRate	string	The maintenance margin requirement for the risk limit at which the current position size is located.Since the maintenance margin for the position has been calculated using a tiered system, the actual maintenance margin rate required for this position is based on `average_maintenance_rate`.	[optional] [readonly] [default to undefined]
value	string	Position value calculated in settlement currency	[optional] [readonly] [default to undefined]
margin	string	Margin	[optional] [default to undefined]
entryPrice	string	Entry price	[optional] [readonly] [default to undefined]
liqPrice	string	Estimated liquidation price, for reference only. The actual liquidation trigger is based on the position mmr or the account maintenance margin level.	[optional] [readonly] [default to undefined]
markPrice	string	Current mark price	[optional] [readonly] [default to undefined]
initialMargin	string	Initial margin of postions	[optional] [readonly] [default to undefined]
maintenanceMargin	string	Maintencance margin of postions	[optional] [readonly] [default to undefined]
unrealisedPnl	string	Unrealized PNL	[optional] [readonly] [default to undefined]
realisedPnl	string	Realised PnL, the sum of all cash flows generated by this position, including settlement of closing positions, settlement of funding fees, and transaction fee expenses.	[optional] [readonly] [default to undefined]
pnlPnl	string	settled pnl when closing postion	[optional] [readonly] [default to undefined]
pnlFund	string	funding fees	[optional] [readonly] [default to undefined]
pnlFee	string	trading fees	[optional] [readonly] [default to undefined]
historyPnl	string	Total realized PnL from closed positions	[optional] [readonly] [default to undefined]
lastClosePnl	string	PNL of last position close	[optional] [readonly] [default to undefined]
realisedPoint	string	Realized POINT PNL	[optional] [readonly] [default to undefined]
historyPoint	string	History realized POINT PNL	[optional] [readonly] [default to undefined]
adlRanking	number	Ranking of auto deleveraging, a total of 1-5 grades, `1` is the highest, `5` is the lowest, and `6` is the special case when there is no position held or in liquidation	[optional] [readonly] [default to undefined]
pendingOrders	number	Current pending order quantity	[optional] [readonly] [default to undefined]
closeOrder	PositionCloseOrder		[optional] [default to undefined]
mode	string	Position mode, including: - `single`: One-way Mode - `dual_long`: Long position in Hedge Mode - `dual_short`: Short position in Hedge Mode	[optional] [default to undefined]
crossLeverageLimit	string	leverage for cross margin	[optional] [default to undefined]
updateTime	number	Last update time	[optional] [readonly] [default to undefined]
updateId	number	Update ID. The value increments by 1 each time the position is updated	[optional] [readonly] [default to undefined]
openTime	number	First Open Time	[optional] [default to undefined]
riskLimitTable	string	Risk limit table ID	[optional] [readonly] [default to undefined]
averageMaintenanceRate	string	Average maintenance margin rate	[optional] [readonly] [default to undefined]
pid	number	Sub-account position ID	[optional] [readonly] [default to undefined]
posMarginMode	string	Position Margin Mode isolated - Isolated Margin, cross - Cross Margin	[optional] [default to undefined]
lever	string	Indicates the current leverage of the position, applicable to both isolated and cross margin, gradually replacing the current leverage and cross_leverage_limit	[optional] [default to undefined]

Enum: Position.HedgeStatus

• PartialHedged (value: 'partial_hedged')

• FullHedged (value: 'full_hedged')

Enum: Position.Mode

• Single (value: 'single')

• DualLong (value: 'dual_long')

• DualShort (value: 'dual_short')