Position (gate-api 6.45.0 API)

java.lang.Object
- io.gate.gateapi.models.Position

```
public class Position
extends Object
```
Futures position details

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Position.ModeEnum` Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ADL_RANKING`
`static String`	`SERIALIZED_NAME_CLOSE_ORDER`
`static String`	`SERIALIZED_NAME_CONTRACT`
`static String`	`SERIALIZED_NAME_CROSS_LEVERAGE_LIMIT`
`static String`	`SERIALIZED_NAME_ENTRY_PRICE`
`static String`	`SERIALIZED_NAME_HISTORY_PNL`
`static String`	`SERIALIZED_NAME_HISTORY_POINT`
`static String`	`SERIALIZED_NAME_INITIAL_MARGIN`
`static String`	`SERIALIZED_NAME_LAST_CLOSE_PNL`
`static String`	`SERIALIZED_NAME_LEVERAGE`
`static String`	`SERIALIZED_NAME_LEVERAGE_MAX`
`static String`	`SERIALIZED_NAME_LIQ_PRICE`
`static String`	`SERIALIZED_NAME_MAINTENANCE_MARGIN`
`static String`	`SERIALIZED_NAME_MAINTENANCE_RATE`
`static String`	`SERIALIZED_NAME_MARGIN`
`static String`	`SERIALIZED_NAME_MARK_PRICE`
`static String`	`SERIALIZED_NAME_MODE`
`static String`	`SERIALIZED_NAME_PENDING_ORDERS`
`static String`	`SERIALIZED_NAME_REALISED_PNL`
`static String`	`SERIALIZED_NAME_REALISED_POINT`
`static String`	`SERIALIZED_NAME_RISK_LIMIT`
`static String`	`SERIALIZED_NAME_SIZE`
`static String`	`SERIALIZED_NAME_UNREALISED_PNL`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_VALUE`

Constructor Summary

Constructors
Constructor and Description

Position()

Constructors
Constructor and Description
`Position()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Position`	`closeOrder(PositionCloseOrder closeOrder)`
`Position`	`crossLeverageLimit(String crossLeverageLimit)`
`boolean`	`equals(Object o)`
`Integer`	`getAdlRanking()` 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
`PositionCloseOrder`	`getCloseOrder()` Get closeOrder
`String`	`getContract()` Futures contract
`String`	`getCrossLeverageLimit()` Cross margin leverage(valid only when `leverage` is 0)
`String`	`getEntryPrice()` Entry price
`String`	`getHistoryPnl()` History realized PNL
`String`	`getHistoryPoint()` History realized POINT PNL
`String`	`getInitialMargin()` The initial margin occupied by the position, applicable to the portfolio margin account
`String`	`getLastClosePnl()` PNL of last position close
`String`	`getLeverage()` Position leverage.
`String`	`getLeverageMax()` Maximum leverage under current risk limit
`String`	`getLiqPrice()` Liquidation price
`String`	`getMaintenanceMargin()` Maintenance margin required for the position, applicable to portfolio margin account
`String`	`getMaintenanceRate()` Maintenance rate under current risk limit
`String`	`getMargin()` Position margin
`String`	`getMarkPrice()` Current mark price
`Position.ModeEnum`	`getMode()` Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode
`Integer`	`getPendingOrders()` Current open orders
`String`	`getRealisedPnl()` Realized PNL
`String`	`getRealisedPoint()` Realized POINT PNL
`String`	`getRiskLimit()` Position risk limit
`Long`	`getSize()` Position size
`String`	`getUnrealisedPnl()` Unrealized PNL
`Long`	`getUser()` User ID
`String`	`getValue()` Position value calculated in settlement currency
`int`	`hashCode()`
`Position`	`leverage(String leverage)`
`Position`	`margin(String margin)`
`Position`	`mode(Position.ModeEnum mode)`
`Position`	`riskLimit(String riskLimit)`
`void`	`setCloseOrder(PositionCloseOrder closeOrder)`
`void`	`setCrossLeverageLimit(String crossLeverageLimit)`
`void`	`setLeverage(String leverage)`
`void`	`setMargin(String margin)`
`void`	`setMode(Position.ModeEnum mode)`
`void`	`setRiskLimit(String riskLimit)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CONTRACT
```
public static final String SERIALIZED_NAME_CONTRACT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SIZE
```
public static final String SERIALIZED_NAME_SIZE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LEVERAGE
```
public static final String SERIALIZED_NAME_LEVERAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RISK_LIMIT
```
public static final String SERIALIZED_NAME_RISK_LIMIT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LEVERAGE_MAX
```
public static final String SERIALIZED_NAME_LEVERAGE_MAX
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MAINTENANCE_RATE
```
public static final String SERIALIZED_NAME_MAINTENANCE_RATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VALUE
```
public static final String SERIALIZED_NAME_VALUE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MARGIN
```
public static final String SERIALIZED_NAME_MARGIN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENTRY_PRICE
```
public static final String SERIALIZED_NAME_ENTRY_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LIQ_PRICE
```
public static final String SERIALIZED_NAME_LIQ_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MARK_PRICE
```
public static final String SERIALIZED_NAME_MARK_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INITIAL_MARGIN
```
public static final String SERIALIZED_NAME_INITIAL_MARGIN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MAINTENANCE_MARGIN
```
public static final String SERIALIZED_NAME_MAINTENANCE_MARGIN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UNREALISED_PNL
```
public static final String SERIALIZED_NAME_UNREALISED_PNL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REALISED_PNL
```
public static final String SERIALIZED_NAME_REALISED_PNL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HISTORY_PNL
```
public static final String SERIALIZED_NAME_HISTORY_PNL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LAST_CLOSE_PNL
```
public static final String SERIALIZED_NAME_LAST_CLOSE_PNL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REALISED_POINT
```
public static final String SERIALIZED_NAME_REALISED_POINT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HISTORY_POINT
```
public static final String SERIALIZED_NAME_HISTORY_POINT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ADL_RANKING
```
public static final String SERIALIZED_NAME_ADL_RANKING
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PENDING_ORDERS
```
public static final String SERIALIZED_NAME_PENDING_ORDERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLOSE_ORDER
```
public static final String SERIALIZED_NAME_CLOSE_ORDER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MODE
```
public static final String SERIALIZED_NAME_MODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CROSS_LEVERAGE_LIMIT
```
public static final String SERIALIZED_NAME_CROSS_LEVERAGE_LIMIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Position
```
public Position()
```
- Method Detail
  - getUser
```
@Nullable
public Long getUser()
```
    User ID
    
    Returns:
    
    user
  - getContract
```
@Nullable
public String getContract()
```
    Futures contract
    
    Returns:
    
    contract
  - getSize
```
@Nullable
public Long getSize()
```
    Position size
    
    Returns:
    
    size
  - leverage
```
public Position leverage(String leverage)
```
  - getLeverage
```
@Nullable
public String getLeverage()
```
    Position leverage. 0 means cross margin; positive number means isolated margin
    
    Returns:
    
    leverage
  - setLeverage
```
public void setLeverage(String leverage)
```
  - riskLimit
```
public Position riskLimit(String riskLimit)
```
  - getRiskLimit
```
@Nullable
public String getRiskLimit()
```
    Position risk limit
    
    Returns:
    
    riskLimit
  - setRiskLimit
```
public void setRiskLimit(String riskLimit)
```
  - getLeverageMax
```
@Nullable
public String getLeverageMax()
```
    Maximum leverage under current risk limit
    
    Returns:
    
    leverageMax
  - getMaintenanceRate
```
@Nullable
public String getMaintenanceRate()
```
    Maintenance rate under current risk limit
    
    Returns:
    
    maintenanceRate
  - getValue
```
@Nullable
public String getValue()
```
    Position value calculated in settlement currency
    
    Returns:
    
    value
  - margin
```
public Position margin(String margin)
```
  - getMargin
```
@Nullable
public String getMargin()
```
    Position margin
    
    Returns:
    
    margin
  - setMargin
```
public void setMargin(String margin)
```
  - getEntryPrice
```
@Nullable
public String getEntryPrice()
```
    Entry price
    
    Returns:
    
    entryPrice
  - getLiqPrice
```
@Nullable
public String getLiqPrice()
```
    Liquidation price
    
    Returns:
    
    liqPrice
  - getMarkPrice
```
@Nullable
public String getMarkPrice()
```
    Current mark price
    
    Returns:
    
    markPrice
  - getInitialMargin
```
@Nullable
public String getInitialMargin()
```
    The initial margin occupied by the position, applicable to the portfolio margin account
    
    Returns:
    
    initialMargin
  - getMaintenanceMargin
```
@Nullable
public String getMaintenanceMargin()
```
    Maintenance margin required for the position, applicable to portfolio margin account
    
    Returns:
    
    maintenanceMargin
  - getUnrealisedPnl
```
@Nullable
public String getUnrealisedPnl()
```
    Unrealized PNL
    
    Returns:
    
    unrealisedPnl
  - getRealisedPnl
```
@Nullable
public String getRealisedPnl()
```
    Realized PNL
    
    Returns:
    
    realisedPnl
  - getHistoryPnl
```
@Nullable
public String getHistoryPnl()
```
    History realized PNL
    
    Returns:
    
    historyPnl
  - getLastClosePnl
```
@Nullable
public String getLastClosePnl()
```
    PNL of last position close
    
    Returns:
    
    lastClosePnl
  - getRealisedPoint
```
@Nullable
public String getRealisedPoint()
```
    Realized POINT PNL
    
    Returns:
    
    realisedPoint
  - getHistoryPoint
```
@Nullable
public String getHistoryPoint()
```
    History realized POINT PNL
    
    Returns:
    
    historyPoint
  - getAdlRanking
```
@Nullable
public Integer getAdlRanking()
```
    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
    
    Returns:
    
    adlRanking
  - getPendingOrders
```
@Nullable
public Integer getPendingOrders()
```
    Current open orders
    
    Returns:
    
    pendingOrders
  - closeOrder
```
public Position closeOrder(PositionCloseOrder closeOrder)
```
  - getCloseOrder
```
@Nullable
public PositionCloseOrder getCloseOrder()
```
    Get closeOrder
    
    Returns:
    
    closeOrder
  - setCloseOrder
```
public void setCloseOrder(PositionCloseOrder closeOrder)
```
  - mode
```
public Position mode(Position.ModeEnum mode)
```
  - getMode
```
@Nullable
public Position.ModeEnum getMode()
```
    Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode
    
    Returns:
    
    mode
  - setMode
```
public void setMode(Position.ModeEnum mode)
```
  - crossLeverageLimit
```
public Position crossLeverageLimit(String crossLeverageLimit)
```
  - getCrossLeverageLimit
```
@Nullable
public String getCrossLeverageLimit()
```
    Cross margin leverage(valid only when `leverage` is 0)
    
    Returns:
    
    crossLeverageLimit
  - setCrossLeverageLimit
```
public void setCrossLeverageLimit(String crossLeverageLimit)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Position

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_USER

SERIALIZED_NAME_CONTRACT

SERIALIZED_NAME_SIZE

SERIALIZED_NAME_LEVERAGE

SERIALIZED_NAME_RISK_LIMIT

SERIALIZED_NAME_LEVERAGE_MAX

SERIALIZED_NAME_MAINTENANCE_RATE

SERIALIZED_NAME_VALUE

SERIALIZED_NAME_MARGIN

SERIALIZED_NAME_ENTRY_PRICE

SERIALIZED_NAME_LIQ_PRICE

SERIALIZED_NAME_MARK_PRICE

SERIALIZED_NAME_INITIAL_MARGIN

SERIALIZED_NAME_MAINTENANCE_MARGIN

SERIALIZED_NAME_UNREALISED_PNL

SERIALIZED_NAME_REALISED_PNL

SERIALIZED_NAME_HISTORY_PNL

SERIALIZED_NAME_LAST_CLOSE_PNL

SERIALIZED_NAME_REALISED_POINT

SERIALIZED_NAME_HISTORY_POINT

SERIALIZED_NAME_ADL_RANKING

SERIALIZED_NAME_PENDING_ORDERS

SERIALIZED_NAME_CLOSE_ORDER

SERIALIZED_NAME_MODE

SERIALIZED_NAME_CROSS_LEVERAGE_LIMIT

Constructor Detail

Position

Method Detail

getUser

getContract

getSize

leverage

getLeverage

setLeverage

riskLimit

getRiskLimit

setRiskLimit

getLeverageMax

getMaintenanceRate

getValue

margin

getMargin

setMargin

getEntryPrice

getLiqPrice

getMarkPrice

getInitialMargin

getMaintenanceMargin

getUnrealisedPnl

getRealisedPnl

getHistoryPnl

getLastClosePnl

getRealisedPoint

getHistoryPoint

getAdlRanking

getPendingOrders

closeOrder

getCloseOrder

setCloseOrder

mode

getMode

setMode

crossLeverageLimit

getCrossLeverageLimit

setCrossLeverageLimit

equals

hashCode

toString