io.gate.gateapi.models

Class Order

java.lang.Object

io.gate.gateapi.models.Order

public class Order
extends Object

Spot order details

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Order.AccountEnum Account type.
static class	Order.SideEnum Order side
static class	Order.StatusEnum Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
static class	Order.TimeInForceEnum Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee
static class	Order.TypeEnum Order type.

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_CREATE_TIME
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_GT_DISCOUNT
static String	SERIALIZED_NAME_GT_FEE
static String	SERIALIZED_NAME_ICEBERG
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_LEFT
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_TEXT
static String	SERIALIZED_NAME_TIME_IN_FORCE
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_UPDATE_TIME

Constructor Summary

Constructors

Constructor and Description
Order()

Method Summary

Modifier and Type	Method and Description
Order	account(Order.AccountEnum account)
Order	amount(String amount)
Order	autoBorrow(Boolean autoBorrow)
Order	currencyPair(String currencyPair)
boolean	equals(Object o)
Order.AccountEnum	getAccount() Account type.
String	getAmount() Trade amount
Boolean	getAutoBorrow() Used in margin trading(i.e.
String	getCreateTime() Order creation time
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.
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	getLeft() Amount left to fill
String	getPointFee() Point used to deduct fee
String	getPrice() Order price
String	getRebatedFee() Rebated fee
String	getRebatedFeeCurrency() Rebated fee currency unit
Order.SideEnum	getSide() Order side
Order.StatusEnum	getStatus() Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
String	getText() User defined information.
Order.TimeInForceEnum	getTimeInForce() Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee
Order.TypeEnum	getType() Order type.
String	getUpdateTime() Order last modification time
int	hashCode()
Order	iceberg(String iceberg)
Order	price(String price)
void	setAccount(Order.AccountEnum account)
void	setAmount(String amount)
void	setAutoBorrow(Boolean autoBorrow)
void	setCurrencyPair(String currencyPair)
void	setIceberg(String iceberg)
void	setPrice(String price)
void	setSide(Order.SideEnum side)
void	setText(String text)
void	setTimeInForce(Order.TimeInForceEnum timeInForce)
void	setType(Order.TypeEnum type)
Order	side(Order.SideEnum side)
Order	text(String text)
Order	timeInForce(Order.TimeInForceEnum timeInForce)
String	toString()
Order	type(Order.TypeEnum type)

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_TEXT

public static final String SERIALIZED_NAME_TEXT

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_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_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

Constructor Detail

Order

public Order()

Method Detail

getId

@Nullable
public String getId()

Order ID

Returns:

id

text

public Order 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)

getCreateTime

@Nullable
public String getCreateTime()

Order creation time

Returns:

createTime

getUpdateTime

@Nullable
public String getUpdateTime()

Order last modification time

Returns:

updateTime

getStatus

@Nullable
public Order.StatusEnum getStatus()

Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled

Returns:

status

currencyPair

public Order currencyPair(String currencyPair)

getCurrencyPair

public String getCurrencyPair()

Currency pair

Returns:

currencyPair

setCurrencyPair

public void setCurrencyPair(String currencyPair)

type

public Order type(Order.TypeEnum type)

getType

@Nullable
public Order.TypeEnum getType()

Order type. limit - limit order

Returns:

type

setType

public void setType(Order.TypeEnum type)

account

public Order account(Order.AccountEnum account)

getAccount

@Nullable
public Order.AccountEnum getAccount()

Account type. spot - use spot account; margin - use margin account

Returns:

account

setAccount

public void setAccount(Order.AccountEnum account)

side

public Order side(Order.SideEnum side)

getSide

public Order.SideEnum getSide()

Order side

Returns:

side

setSide

public void setSide(Order.SideEnum side)

amount

public Order amount(String amount)

getAmount

public String getAmount()

Trade amount

Returns:

amount

setAmount

public void setAmount(String amount)

price

public Order price(String price)

getPrice

public String getPrice()

Order price

Returns:

price

setPrice

public void setPrice(String price)

timeInForce

public Order timeInForce(Order.TimeInForceEnum timeInForce)

getTimeInForce

@Nullable
public Order.TimeInForceEnum getTimeInForce()

Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee

Returns:

timeInForce

setTimeInForce

public void setTimeInForce(Order.TimeInForceEnum timeInForce)

iceberg

public Order iceberg(String iceberg)

getIceberg

@Nullable
public String getIceberg()

Amount to display for the iceberg order. Null or 0 for normal orders. Set to -1 to hide the amount totally

Returns:

iceberg

setIceberg

public void setIceberg(String iceberg)

autoBorrow

public Order autoBorrow(Boolean autoBorrow)

getAutoBorrow

@Nullable
public Boolean getAutoBorrow()

Used in margin trading(i.e. `account` is `margin`) to allow automatic loan of insufficient part if balance is not enough.

Returns:

autoBorrow

setAutoBorrow

public void setAutoBorrow(Boolean autoBorrow)

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()

Point 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

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