BatchOrder (gate-api 6.45.0 API)

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

```
public class BatchOrder
extends Object
```
Batch order details

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BatchOrder.AccountEnum` Account type.
`static class`	`BatchOrder.FinishAsEnum` How the order was finished.
`static class`	`BatchOrder.SideEnum` Order side
`static class`	`BatchOrder.StatusEnum` Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
`static class`	`BatchOrder.StpActEnum` Self-Trading Prevention Action.
`static class`	`BatchOrder.TimeInForceEnum` 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
`static class`	`BatchOrder.TypeEnum` Order Type - limit : Limit Order - market : Market Order

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_AUTO_BORROW`
`static String`	`SERIALIZED_NAME_AUTO_REPAY`
`static String`	`SERIALIZED_NAME_CREATE_TIME`
`static String`	`SERIALIZED_NAME_CREATE_TIME_MS`
`static String`	`SERIALIZED_NAME_CURRENCY_PAIR`
`static String`	`SERIALIZED_NAME_FEE`
`static String`	`SERIALIZED_NAME_FEE_CURRENCY`
`static String`	`SERIALIZED_NAME_FILL_PRICE`
`static String`	`SERIALIZED_NAME_FILLED_TOTAL`
`static String`	`SERIALIZED_NAME_FINISH_AS`
`static String`	`SERIALIZED_NAME_GT_DISCOUNT`
`static String`	`SERIALIZED_NAME_GT_FEE`
`static String`	`SERIALIZED_NAME_ICEBERG`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_LABEL`
`static String`	`SERIALIZED_NAME_LEFT`
`static String`	`SERIALIZED_NAME_MESSAGE`
`static String`	`SERIALIZED_NAME_POINT_FEE`
`static String`	`SERIALIZED_NAME_PRICE`
`static String`	`SERIALIZED_NAME_REBATED_FEE`
`static String`	`SERIALIZED_NAME_REBATED_FEE_CURRENCY`
`static String`	`SERIALIZED_NAME_SIDE`
`static String`	`SERIALIZED_NAME_STATUS`
`static String`	`SERIALIZED_NAME_STP_ACT`
`static String`	`SERIALIZED_NAME_STP_ID`
`static String`	`SERIALIZED_NAME_SUCCEEDED`
`static String`	`SERIALIZED_NAME_TEXT`
`static String`	`SERIALIZED_NAME_TIME_IN_FORCE`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_UPDATE_TIME`
`static String`	`SERIALIZED_NAME_UPDATE_TIME_MS`

Constructor Summary

Constructors
Constructor and Description

BatchOrder()

Constructors
Constructor and Description
`BatchOrder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchOrder`	`account(BatchOrder.AccountEnum account)`
`BatchOrder`	`amount(String amount)`
`BatchOrder`	`autoBorrow(Boolean autoBorrow)`
`BatchOrder`	`autoRepay(Boolean autoRepay)`
`BatchOrder`	`currencyPair(String currencyPair)`
`boolean`	`equals(Object o)`
`BatchOrder.AccountEnum`	`getAccount()` Account type.
`String`	`getAmount()` Trade amount
`Boolean`	`getAutoBorrow()` Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough.
`Boolean`	`getAutoRepay()` Enable or disable automatic repayment for automatic borrow loan generated by cross margin order.
`String`	`getCreateTime()` Creation time of order
`Long`	`getCreateTimeMs()` Creation time of order (in milliseconds)
`String`	`getCurrencyPair()` Currency pair
`String`	`getFee()` Fee deducted
`String`	`getFeeCurrency()` Fee currency unit
`String`	`getFilledTotal()` Total filled in quote currency
`String`	`getFillPrice()` Total filled in quote currency.
`BatchOrder.FinishAsEnum`	`getFinishAs()` How the order was finished.
`Boolean`	`getGtDiscount()` Whether GT fee discount is used
`String`	`getGtFee()` GT used to deduct fee
`String`	`getIceberg()` Amount to display for the iceberg order.
`String`	`getId()` Order ID
`String`	`getLabel()` Error label, if any, otherwise an empty string
`String`	`getLeft()` Amount left to fill
`String`	`getMessage()` Detailed error message, if any, otherwise an empty string
`String`	`getPointFee()` Points used to deduct fee
`String`	`getPrice()` Order price
`String`	`getRebatedFee()` Rebated fee
`String`	`getRebatedFeeCurrency()` Rebated fee currency unit
`BatchOrder.SideEnum`	`getSide()` Order side
`BatchOrder.StatusEnum`	`getStatus()` Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
`BatchOrder.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.
`Boolean`	`getSucceeded()` Whether the batch of orders succeeded
`String`	`getText()` User defined information.
`BatchOrder.TimeInForceEnum`	`getTimeInForce()` 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
`BatchOrder.TypeEnum`	`getType()` Order Type - limit : Limit Order - market : Market Order
`String`	`getUpdateTime()` Last modification time of order
`Long`	`getUpdateTimeMs()` Last modification time of order (in milliseconds)
`int`	`hashCode()`
`BatchOrder`	`iceberg(String iceberg)`
`BatchOrder`	`label(String label)`
`BatchOrder`	`message(String message)`
`BatchOrder`	`price(String price)`
`void`	`setAccount(BatchOrder.AccountEnum account)`
`void`	`setAmount(String amount)`
`void`	`setAutoBorrow(Boolean autoBorrow)`
`void`	`setAutoRepay(Boolean autoRepay)`
`void`	`setCurrencyPair(String currencyPair)`
`void`	`setIceberg(String iceberg)`
`void`	`setLabel(String label)`
`void`	`setMessage(String message)`
`void`	`setPrice(String price)`
`void`	`setSide(BatchOrder.SideEnum side)`
`void`	`setStpAct(BatchOrder.StpActEnum stpAct)`
`void`	`setSucceeded(Boolean succeeded)`
`void`	`setText(String text)`
`void`	`setTimeInForce(BatchOrder.TimeInForceEnum timeInForce)`
`void`	`setType(BatchOrder.TypeEnum type)`
`BatchOrder`	`side(BatchOrder.SideEnum side)`
`BatchOrder`	`stpAct(BatchOrder.StpActEnum stpAct)`
`BatchOrder`	`succeeded(Boolean succeeded)`
`BatchOrder`	`text(String text)`
`BatchOrder`	`timeInForce(BatchOrder.TimeInForceEnum timeInForce)`
`String`	`toString()`
`BatchOrder`	`type(BatchOrder.TypeEnum type)`

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

- Field Detail
  - SERIALIZED_NAME_TEXT
```
public static final String SERIALIZED_NAME_TEXT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUCCEEDED
```
public static final String SERIALIZED_NAME_SUCCEEDED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LABEL
```
public static final String SERIALIZED_NAME_LABEL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MESSAGE
```
public static final String SERIALIZED_NAME_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATE_TIME
```
public static final String SERIALIZED_NAME_CREATE_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UPDATE_TIME
```
public static final String SERIALIZED_NAME_UPDATE_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATE_TIME_MS
```
public static final String SERIALIZED_NAME_CREATE_TIME_MS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UPDATE_TIME_MS
```
public static final String SERIALIZED_NAME_UPDATE_TIME_MS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CURRENCY_PAIR
```
public static final String SERIALIZED_NAME_CURRENCY_PAIR
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT
```
public static final String SERIALIZED_NAME_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SIDE
```
public static final String SERIALIZED_NAME_SIDE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRICE
```
public static final String SERIALIZED_NAME_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TIME_IN_FORCE
```
public static final String SERIALIZED_NAME_TIME_IN_FORCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ICEBERG
```
public static final String SERIALIZED_NAME_ICEBERG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AUTO_BORROW
```
public static final String SERIALIZED_NAME_AUTO_BORROW
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AUTO_REPAY
```
public static final String SERIALIZED_NAME_AUTO_REPAY
```
    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_FILLED_TOTAL
```
public static final String SERIALIZED_NAME_FILLED_TOTAL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FEE
```
public static final String SERIALIZED_NAME_FEE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FEE_CURRENCY
```
public static final String SERIALIZED_NAME_FEE_CURRENCY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_POINT_FEE
```
public static final String SERIALIZED_NAME_POINT_FEE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GT_FEE
```
public static final String SERIALIZED_NAME_GT_FEE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GT_DISCOUNT
```
public static final String SERIALIZED_NAME_GT_DISCOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REBATED_FEE
```
public static final String SERIALIZED_NAME_REBATED_FEE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REBATED_FEE_CURRENCY
```
public static final String SERIALIZED_NAME_REBATED_FEE_CURRENCY
```
    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_FINISH_AS
```
public static final String SERIALIZED_NAME_FINISH_AS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BatchOrder
```
public BatchOrder()
```
- Method Detail
  - text
```
public BatchOrder 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(.)
    
    Returns:
    
    text
  - setText
```
public void setText(String text)
```
  - succeeded
```
public BatchOrder succeeded(Boolean succeeded)
```
  - getSucceeded
```
@Nullable
public Boolean getSucceeded()
```
    Whether the batch of orders succeeded
    
    Returns:
    
    succeeded
  - setSucceeded
```
public void setSucceeded(Boolean succeeded)
```
  - label
```
public BatchOrder label(String label)
```
  - getLabel
```
@Nullable
public String getLabel()
```
    Error label, if any, otherwise an empty string
    
    Returns:
    
    label
  - setLabel
```
public void setLabel(String label)
```
  - message
```
public BatchOrder message(String message)
```
  - getMessage
```
@Nullable
public String getMessage()
```
    Detailed error message, if any, otherwise an empty string
    
    Returns:
    
    message
  - setMessage
```
public void setMessage(String message)
```
  - getId
```
@Nullable
public String getId()
```
    Order ID
    
    Returns:
    
    id
  - getCreateTime
```
@Nullable
public String getCreateTime()
```
    Creation time of order
    
    Returns:
    
    createTime
  - getUpdateTime
```
@Nullable
public String getUpdateTime()
```
    Last modification time of order
    
    Returns:
    
    updateTime
  - getCreateTimeMs
```
@Nullable
public Long getCreateTimeMs()
```
    Creation time of order (in milliseconds)
    
    Returns:
    
    createTimeMs
  - getUpdateTimeMs
```
@Nullable
public Long getUpdateTimeMs()
```
    Last modification time of order (in milliseconds)
    
    Returns:
    
    updateTimeMs
  - getStatus
```
@Nullable
public BatchOrder.StatusEnum getStatus()
```
    Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
    
    Returns:
    
    status
  - currencyPair
```
public BatchOrder currencyPair(String currencyPair)
```
  - getCurrencyPair
```
@Nullable
public String getCurrencyPair()
```
    Currency pair
    
    Returns:
    
    currencyPair
  - setCurrencyPair
```
public void setCurrencyPair(String currencyPair)
```
  - type
```
public BatchOrder type(BatchOrder.TypeEnum type)
```
  - getType
```
@Nullable
public BatchOrder.TypeEnum getType()
```
    Order Type - limit : Limit Order - market : Market Order
    
    Returns:
    
    type
  - setType
```
public void setType(BatchOrder.TypeEnum type)
```
  - account
```
public BatchOrder account(BatchOrder.AccountEnum account)
```
  - getAccount
```
@Nullable
public BatchOrder.AccountEnum getAccount()
```
    Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account
    
    Returns:
    
    account
  - setAccount
```
public void setAccount(BatchOrder.AccountEnum account)
```
  - side
```
public BatchOrder side(BatchOrder.SideEnum side)
```
  - getSide
```
@Nullable
public BatchOrder.SideEnum getSide()
```
    Order side
    
    Returns:
    
    side
  - setSide
```
public void setSide(BatchOrder.SideEnum side)
```
  - amount
```
public BatchOrder amount(String amount)
```
  - getAmount
```
@Nullable
public String getAmount()
```
    Trade amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(String amount)
```
  - price
```
public BatchOrder price(String price)
```
  - getPrice
```
@Nullable
public String getPrice()
```
    Order price
    
    Returns:
    
    price
  - setPrice
```
public void setPrice(String price)
```
  - timeInForce
```
public BatchOrder timeInForce(BatchOrder.TimeInForceEnum timeInForce)
```
  - getTimeInForce
```
@Nullable
public BatchOrder.TimeInForceEnum getTimeInForce()
```
    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:
    
    timeInForce
  - setTimeInForce
```
public void setTimeInForce(BatchOrder.TimeInForceEnum timeInForce)
```
  - iceberg
```
public BatchOrder iceberg(String iceberg)
```
  - getIceberg
```
@Nullable
public String getIceberg()
```
    Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported.
    
    Returns:
    
    iceberg
  - setIceberg
```
public void setIceberg(String iceberg)
```
  - autoBorrow
```
public BatchOrder autoBorrow(Boolean autoBorrow)
```
  - getAutoBorrow
```
@Nullable
public Boolean getAutoBorrow()
```
    Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough.
    
    Returns:
    
    autoBorrow
  - setAutoBorrow
```
public void setAutoBorrow(Boolean autoBorrow)
```
  - autoRepay
```
public BatchOrder autoRepay(Boolean autoRepay)
```
  - getAutoRepay
```
@Nullable
public Boolean getAutoRepay()
```
    Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` cannot be both set to true in one order.
    
    Returns:
    
    autoRepay
  - setAutoRepay
```
public void setAutoRepay(Boolean autoRepay)
```
  - getLeft
```
@Nullable
public String getLeft()
```
    Amount left to fill
    
    Returns:
    
    left
  - getFillPrice
```
@Nullable
public String getFillPrice()
```
    Total filled in quote currency. Deprecated in favor of `filled_total`
    
    Returns:
    
    fillPrice
  - getFilledTotal
```
@Nullable
public String getFilledTotal()
```
    Total filled in quote currency
    
    Returns:
    
    filledTotal
  - getFee
```
@Nullable
public String getFee()
```
    Fee deducted
    
    Returns:
    
    fee
  - getFeeCurrency
```
@Nullable
public String getFeeCurrency()
```
    Fee currency unit
    
    Returns:
    
    feeCurrency
  - getPointFee
```
@Nullable
public String getPointFee()
```
    Points used to deduct fee
    
    Returns:
    
    pointFee
  - getGtFee
```
@Nullable
public String getGtFee()
```
    GT used to deduct fee
    
    Returns:
    
    gtFee
  - getGtDiscount
```
@Nullable
public Boolean getGtDiscount()
```
    Whether GT fee discount is used
    
    Returns:
    
    gtDiscount
  - getRebatedFee
```
@Nullable
public String getRebatedFee()
```
    Rebated fee
    
    Returns:
    
    rebatedFee
  - getRebatedFeeCurrency
```
@Nullable
public String getRebatedFeeCurrency()
```
    Rebated fee currency unit
    
    Returns:
    
    rebatedFeeCurrency
  - 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 BatchOrder stpAct(BatchOrder.StpActEnum stpAct)
```
  - getStpAct
```
@Nullable
public BatchOrder.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(BatchOrder.StpActEnum stpAct)
```
  - getFinishAs
```
@Nullable
public BatchOrder.FinishAsEnum getFinishAs()
```
    How the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention
    
    Returns:
    
    finishAs
  - 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 BatchOrder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_TEXT

SERIALIZED_NAME_SUCCEEDED

SERIALIZED_NAME_LABEL

SERIALIZED_NAME_MESSAGE

SERIALIZED_NAME_ID

SERIALIZED_NAME_CREATE_TIME

SERIALIZED_NAME_UPDATE_TIME

SERIALIZED_NAME_CREATE_TIME_MS

SERIALIZED_NAME_UPDATE_TIME_MS

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_CURRENCY_PAIR

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_ACCOUNT

SERIALIZED_NAME_SIDE

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_PRICE

SERIALIZED_NAME_TIME_IN_FORCE

SERIALIZED_NAME_ICEBERG

SERIALIZED_NAME_AUTO_BORROW

SERIALIZED_NAME_AUTO_REPAY

SERIALIZED_NAME_LEFT

SERIALIZED_NAME_FILL_PRICE

SERIALIZED_NAME_FILLED_TOTAL

SERIALIZED_NAME_FEE

SERIALIZED_NAME_FEE_CURRENCY

SERIALIZED_NAME_POINT_FEE

SERIALIZED_NAME_GT_FEE

SERIALIZED_NAME_GT_DISCOUNT

SERIALIZED_NAME_REBATED_FEE

SERIALIZED_NAME_REBATED_FEE_CURRENCY

SERIALIZED_NAME_STP_ID

SERIALIZED_NAME_STP_ACT

SERIALIZED_NAME_FINISH_AS

Constructor Detail

BatchOrder

Method Detail

text

getText

setText

succeeded

getSucceeded

setSucceeded

label

getLabel

setLabel

message

getMessage

setMessage

getId

getCreateTime

getUpdateTime

getCreateTimeMs

getUpdateTimeMs

getStatus

currencyPair

getCurrencyPair

setCurrencyPair

type

getType

setType

account

getAccount

setAccount

side

getSide

setSide

amount

getAmount

setAmount

price

getPrice

setPrice

timeInForce