FuturesOrder (gate-api 6.45.0 API)

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

public class FuturesOrder
extends Object

Futures order details

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FuturesOrder.AutoSizeEnum` Set side to close dual-mode position.
`static class`	`FuturesOrder.FinishAsEnum` How the order was finished.
`static class`	`FuturesOrder.StatusEnum` Order status - `open`: waiting to be traded - `finished`: finished
`static class`	`FuturesOrder.StpActEnum` Self-Trading Prevention Action.
`static class`	`FuturesOrder.TifEnum` Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_AMEND_TEXT`
`static String`	`SERIALIZED_NAME_AUTO_SIZE`
`static String`	`SERIALIZED_NAME_CLOSE`
`static String`	`SERIALIZED_NAME_CONTRACT`
`static String`	`SERIALIZED_NAME_CREATE_TIME`
`static String`	`SERIALIZED_NAME_FILL_PRICE`
`static String`	`SERIALIZED_NAME_FINISH_AS`
`static String`	`SERIALIZED_NAME_FINISH_TIME`
`static String`	`SERIALIZED_NAME_ICEBERG`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_IS_CLOSE`
`static String`	`SERIALIZED_NAME_IS_LIQ`
`static String`	`SERIALIZED_NAME_IS_REDUCE_ONLY`
`static String`	`SERIALIZED_NAME_LEFT`
`static String`	`SERIALIZED_NAME_MKFR`
`static String`	`SERIALIZED_NAME_PRICE`
`static String`	`SERIALIZED_NAME_REDUCE_ONLY`
`static String`	`SERIALIZED_NAME_REFU`
`static String`	`SERIALIZED_NAME_SIZE`
`static String`	`SERIALIZED_NAME_STATUS`
`static String`	`SERIALIZED_NAME_STP_ACT`
`static String`	`SERIALIZED_NAME_STP_ID`
`static String`	`SERIALIZED_NAME_TEXT`
`static String`	`SERIALIZED_NAME_TIF`
`static String`	`SERIALIZED_NAME_TKFR`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

FuturesOrder()

Constructors
Constructor and Description
`FuturesOrder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FuturesOrder`	`autoSize(FuturesOrder.AutoSizeEnum autoSize)`
`FuturesOrder`	`close(Boolean close)`
`FuturesOrder`	`contract(String contract)`
`boolean`	`equals(Object o)`
`String`	`getAmendText()` The custom data that the user remarked when amending the order
`FuturesOrder.AutoSizeEnum`	`getAutoSize()` Set side to close dual-mode position.
`Boolean`	`getClose()` Set as `true` to close the position, with `size` set to 0
`String`	`getContract()` Futures contract
`Double`	`getCreateTime()` Creation time of order
`String`	`getFillPrice()` Fill price of the order
`FuturesOrder.FinishAsEnum`	`getFinishAs()` How the order was finished.
`Double`	`getFinishTime()` Order finished time.
`Long`	`getIceberg()` Display size for iceberg order.
`Long`	`getId()` Futures order ID
`Boolean`	`getIsClose()` Is the order to close position
`Boolean`	`getIsLiq()` Is the order for liquidation
`Boolean`	`getIsReduceOnly()` Is the order reduce-only
`Long`	`getLeft()` Size left to be traded
`String`	`getMkfr()` Maker fee
`String`	`getPrice()` Order price.
`Boolean`	`getReduceOnly()` Set as `true` to be reduce-only order
`Integer`	`getRefu()` Reference user ID
`Long`	`getSize()` Order size.
`FuturesOrder.StatusEnum`	`getStatus()` Order status - `open`: waiting to be traded - `finished`: finished
`FuturesOrder.StpActEnum`	`getStpAct()` Self-Trading Prevention Action.
`Integer`	`getStpId()` Orders between users in the same `stp_id` group are not allowed to be self-traded 1.
`String`	`getText()` User defined information.
`FuturesOrder.TifEnum`	`getTif()` Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none
`String`	`getTkfr()` Taker fee
`Integer`	`getUser()` User ID
`int`	`hashCode()`
`FuturesOrder`	`iceberg(Long iceberg)`
`FuturesOrder`	`price(String price)`
`FuturesOrder`	`reduceOnly(Boolean reduceOnly)`
`void`	`setAutoSize(FuturesOrder.AutoSizeEnum autoSize)`
`void`	`setClose(Boolean close)`
`void`	`setContract(String contract)`
`void`	`setIceberg(Long iceberg)`
`void`	`setPrice(String price)`
`void`	`setReduceOnly(Boolean reduceOnly)`
`void`	`setSize(Long size)`
`void`	`setStpAct(FuturesOrder.StpActEnum stpAct)`
`void`	`setText(String text)`
`void`	`setTif(FuturesOrder.TifEnum tif)`
`FuturesOrder`	`size(Long size)`
`FuturesOrder`	`stpAct(FuturesOrder.StpActEnum stpAct)`
`FuturesOrder`	`text(String text)`
`FuturesOrder`	`tif(FuturesOrder.TifEnum tif)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATE_TIME
```
public static final String SERIALIZED_NAME_CREATE_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FINISH_TIME
```
public static final String SERIALIZED_NAME_FINISH_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FINISH_AS
```
public static final String SERIALIZED_NAME_FINISH_AS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    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_ICEBERG
```
public static final String SERIALIZED_NAME_ICEBERG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRICE
```
public static final String SERIALIZED_NAME_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLOSE
```
public static final String SERIALIZED_NAME_CLOSE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_CLOSE
```
public static final String SERIALIZED_NAME_IS_CLOSE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REDUCE_ONLY
```
public static final String SERIALIZED_NAME_REDUCE_ONLY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_REDUCE_ONLY
```
public static final String SERIALIZED_NAME_IS_REDUCE_ONLY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_LIQ
```
public static final String SERIALIZED_NAME_IS_LIQ
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TIF
```
public static final String SERIALIZED_NAME_TIF
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LEFT
```
public static final String SERIALIZED_NAME_LEFT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILL_PRICE
```
public static final String SERIALIZED_NAME_FILL_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEXT
```
public static final String SERIALIZED_NAME_TEXT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TKFR
```
public static final String SERIALIZED_NAME_TKFR
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MKFR
```
public static final String SERIALIZED_NAME_MKFR
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REFU
```
public static final String SERIALIZED_NAME_REFU
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AUTO_SIZE
```
public static final String SERIALIZED_NAME_AUTO_SIZE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STP_ID
```
public static final String SERIALIZED_NAME_STP_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STP_ACT
```
public static final String SERIALIZED_NAME_STP_ACT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMEND_TEXT
```
public static final String SERIALIZED_NAME_AMEND_TEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FuturesOrder
```
public FuturesOrder()
```
- Method Detail
  - getId
```
@Nullable
public Long getId()
```
    Futures order ID
    
    Returns:
    
    id
  - getUser
```
@Nullable
public Integer getUser()
```
    User ID
    
    Returns:
    
    user
  - getCreateTime
```
@Nullable
public Double getCreateTime()
```
    Creation time of order
    
    Returns:
    
    createTime
  - getFinishTime
```
@Nullable
public Double getFinishTime()
```
    Order finished time. Not returned if order is open
    
    Returns:
    
    finishTime
  - getFinishAs
```
@Nullable
public FuturesOrder.FinishAsEnum getFinishAs()
```
    How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - stp: cancelled because self trade prevention
    
    Returns:
    
    finishAs
  - getStatus
```
@Nullable
public FuturesOrder.StatusEnum getStatus()
```
    Order status - `open`: waiting to be traded - `finished`: finished
    
    Returns:
    
    status
  - contract
```
public FuturesOrder contract(String contract)
```
  - getContract
```
public String getContract()
```
    Futures contract
    
    Returns:
    
    contract
  - setContract
```
public void setContract(String contract)
```
  - size
```
public FuturesOrder size(Long size)
```
  - getSize
```
public Long getSize()
```
    Order size. Specify positive number to make a bid, and negative number to ask
    
    Returns:
    
    size
  - setSize
```
public void setSize(Long size)
```
  - iceberg
```
public FuturesOrder iceberg(Long iceberg)
```
  - getIceberg
```
@Nullable
public Long getIceberg()
```
    Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size
    
    Returns:
    
    iceberg
  - setIceberg
```
public void setIceberg(Long iceberg)
```
  - price
```
public FuturesOrder price(String price)
```
  - getPrice
```
@Nullable
public String getPrice()
```
    Order price. 0 for market order with `tif` set as `ioc`
    
    Returns:
    
    price
  - setPrice
```
public void setPrice(String price)
```
  - close
```
public FuturesOrder close(Boolean close)
```
  - getClose
```
@Nullable
public Boolean getClose()
```
    Set as `true` to close the position, with `size` set to 0
    
    Returns:
    
    close
  - setClose
```
public void setClose(Boolean close)
```
  - getIsClose
```
@Nullable
public Boolean getIsClose()
```
    Is the order to close position
    
    Returns:
    
    isClose
  - reduceOnly
```
public FuturesOrder reduceOnly(Boolean reduceOnly)
```
  - getReduceOnly
```
@Nullable
public Boolean getReduceOnly()
```
    Set as `true` to be reduce-only order
    
    Returns:
    
    reduceOnly
  - setReduceOnly
```
public void setReduceOnly(Boolean reduceOnly)
```
  - getIsReduceOnly
```
@Nullable
public Boolean getIsReduceOnly()
```
    Is the order reduce-only
    
    Returns:
    
    isReduceOnly
  - getIsLiq
```
@Nullable
public Boolean getIsLiq()
```
    Is the order for liquidation
    
    Returns:
    
    isLiq
  - tif
```
public FuturesOrder tif(FuturesOrder.TifEnum tif)
```
  - getTif
```
@Nullable
public FuturesOrder.TifEnum getTif()
```
    Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none
    
    Returns:
    
    tif
  - setTif
```
public void setTif(FuturesOrder.TifEnum tif)
```
  - getLeft
```
@Nullable
public Long getLeft()
```
    Size left to be traded
    
    Returns:
    
    left
  - getFillPrice
```
@Nullable
public String getFillPrice()
```
    Fill price of the order
    
    Returns:
    
    fillPrice
  - text
```
public FuturesOrder text(String text)
```
  - getText
```
@Nullable
public String getText()
```
    User defined information. If not empty, must follow the rules below: 1. prefixed with `t-` 2. no longer than 28 bytes without `t-` prefix 3. can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance
    
    Returns:
    
    text
  - setText
```
public void setText(String text)
```
  - getTkfr
```
@Nullable
public String getTkfr()
```
    Taker fee
    
    Returns:
    
    tkfr
  - getMkfr
```
@Nullable
public String getMkfr()
```
    Maker fee
    
    Returns:
    
    mkfr
  - getRefu
```
@Nullable
public Integer getRefu()
```
    Reference user ID
    
    Returns:
    
    refu
  - autoSize
```
public FuturesOrder autoSize(FuturesOrder.AutoSizeEnum autoSize)
```
  - getAutoSize
```
@Nullable
public FuturesOrder.AutoSizeEnum getAutoSize()
```
    Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0
    
    Returns:
    
    autoSize
  - setAutoSize
```
public void setAutoSize(FuturesOrder.AutoSizeEnum autoSize)
```
  - getStpId
```
@Nullable
public Integer getStpId()
```
    Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`
    
    Returns:
    
    stpId
  - stpAct
```
public FuturesOrder stpAct(FuturesOrder.StpActEnum stpAct)
```
  - getStpAct
```
@Nullable
public FuturesOrder.StpActEnum getStpAct()
```
    Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled
    
    Returns:
    
    stpAct
  - setStpAct
```
public void setStpAct(FuturesOrder.StpActEnum stpAct)
```
  - getAmendText
```
@Nullable
public String getAmendText()
```
    The custom data that the user remarked when amending the order
    
    Returns:
    
    amendText
  - 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 FuturesOrder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_USER

SERIALIZED_NAME_CREATE_TIME

SERIALIZED_NAME_FINISH_TIME

SERIALIZED_NAME_FINISH_AS

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_CONTRACT

SERIALIZED_NAME_SIZE

SERIALIZED_NAME_ICEBERG

SERIALIZED_NAME_PRICE

SERIALIZED_NAME_CLOSE

SERIALIZED_NAME_IS_CLOSE

SERIALIZED_NAME_REDUCE_ONLY

SERIALIZED_NAME_IS_REDUCE_ONLY

SERIALIZED_NAME_IS_LIQ

SERIALIZED_NAME_TIF

SERIALIZED_NAME_LEFT

SERIALIZED_NAME_FILL_PRICE

SERIALIZED_NAME_TEXT

SERIALIZED_NAME_TKFR

SERIALIZED_NAME_MKFR

SERIALIZED_NAME_REFU

SERIALIZED_NAME_AUTO_SIZE

SERIALIZED_NAME_STP_ID

SERIALIZED_NAME_STP_ACT

SERIALIZED_NAME_AMEND_TEXT

Constructor Detail

FuturesOrder

Method Detail

getId

getUser

getCreateTime

getFinishTime

getFinishAs

getStatus

contract

getContract

setContract

size

getSize

setSize

iceberg

getIceberg

setIceberg

price

getPrice

setPrice

close

getClose

setClose

getIsClose

reduceOnly

getReduceOnly

setReduceOnly

getIsReduceOnly

getIsLiq

tif

getTif

setTif

getLeft

getFillPrice

text

getText

setText

getTkfr

getMkfr

getRefu

autoSize

getAutoSize

setAutoSize

getStpId

stpAct

getStpAct