io.gate.gateapi.models

Class OptionsContract

java.lang.Object

io.gate.gateapi.models.OptionsContract

public class OptionsContract
extends Object

Options contract detail

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CREATE_TIME
static String	SERIALIZED_NAME_EXPIRATION_TIME
static String	SERIALIZED_NAME_INDEX_PRICE
static String	SERIALIZED_NAME_IS_CALL
static String	SERIALIZED_NAME_LAST_PRICE
static String	SERIALIZED_NAME_MAKER_FEE_RATE
static String	SERIALIZED_NAME_MARK_PRICE
static String	SERIALIZED_NAME_MARK_PRICE_ROUND
static String	SERIALIZED_NAME_MULTIPLIER
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_ORDER_PRICE_DEVIATE
static String	SERIALIZED_NAME_ORDER_PRICE_ROUND
static String	SERIALIZED_NAME_ORDER_SIZE_MAX
static String	SERIALIZED_NAME_ORDER_SIZE_MIN
static String	SERIALIZED_NAME_ORDERBOOK_ID
static String	SERIALIZED_NAME_ORDERS_LIMIT
static String	SERIALIZED_NAME_POSITION_SIZE
static String	SERIALIZED_NAME_REF_DISCOUNT_RATE
static String	SERIALIZED_NAME_REF_REBATE_RATE
static String	SERIALIZED_NAME_TAG
static String	SERIALIZED_NAME_TAKER_FEE_RATE
static String	SERIALIZED_NAME_TRADE_ID
static String	SERIALIZED_NAME_TRADE_SIZE
static String	SERIALIZED_NAME_UNDERLYING
static String	SERIALIZED_NAME_UNDERLYING_PRICE

Constructor Summary

Constructors

Constructor and Description
OptionsContract()

Method Summary

Modifier and Type	Method and Description
OptionsContract	createTime(Double createTime)
boolean	equals(Object o)
OptionsContract	expirationTime(Double expirationTime)
Double	getCreateTime() Creation time
Double	getExpirationTime() Expiration time
String	getIndexPrice() Current index price (quote currency)
Boolean	getIsCall() `true` means call options, while `false` is put options
String	getLastPrice() Last trading price
String	getMakerFeeRate() Maker fee rate, where negative means rebate
String	getMarkPrice() Current mark price (quote currency)
String	getMarkPriceRound() Minimum mark price increment
String	getMultiplier() Multiplier used in converting from invoicing to settlement currency
String	getName() Options contract name
Long	getOrderbookId() Current orderbook ID
String	getOrderPriceDeviate() deviation between order price and current index price.
String	getOrderPriceRound() Minimum order price increment
Long	getOrderSizeMax() Maximum order size the contract allowed
Long	getOrderSizeMin() Minimum order size the contract allowed
Integer	getOrdersLimit() Maximum number of open orders
Long	getPositionSize() Current total long position size
String	getRefDiscountRate() Referral fee rate discount
String	getRefRebateRate() Referrer commission rate
String	getTag() tag
String	getTakerFeeRate() Taker fee rate
Long	getTradeId() Current trade ID
Long	getTradeSize() Historical accumulated trade size
String	getUnderlying() Underlying
String	getUnderlyingPrice() Underlying price (quote currency)
int	hashCode()
OptionsContract	indexPrice(String indexPrice)
OptionsContract	isCall(Boolean isCall)
OptionsContract	lastPrice(String lastPrice)
OptionsContract	makerFeeRate(String makerFeeRate)
OptionsContract	markPrice(String markPrice)
OptionsContract	markPriceRound(String markPriceRound)
OptionsContract	multiplier(String multiplier)
OptionsContract	name(String name)
OptionsContract	orderbookId(Long orderbookId)
OptionsContract	orderPriceDeviate(String orderPriceDeviate)
OptionsContract	orderPriceRound(String orderPriceRound)
OptionsContract	orderSizeMax(Long orderSizeMax)
OptionsContract	orderSizeMin(Long orderSizeMin)
OptionsContract	ordersLimit(Integer ordersLimit)
OptionsContract	positionSize(Long positionSize)
OptionsContract	refDiscountRate(String refDiscountRate)
OptionsContract	refRebateRate(String refRebateRate)
void	setCreateTime(Double createTime)
void	setExpirationTime(Double expirationTime)
void	setIndexPrice(String indexPrice)
void	setIsCall(Boolean isCall)
void	setLastPrice(String lastPrice)
void	setMakerFeeRate(String makerFeeRate)
void	setMarkPrice(String markPrice)
void	setMarkPriceRound(String markPriceRound)
void	setMultiplier(String multiplier)
void	setName(String name)
void	setOrderbookId(Long orderbookId)
void	setOrderPriceDeviate(String orderPriceDeviate)
void	setOrderPriceRound(String orderPriceRound)
void	setOrderSizeMax(Long orderSizeMax)
void	setOrderSizeMin(Long orderSizeMin)
void	setOrdersLimit(Integer ordersLimit)
void	setPositionSize(Long positionSize)
void	setRefDiscountRate(String refDiscountRate)
void	setRefRebateRate(String refRebateRate)
void	setTag(String tag)
void	setTakerFeeRate(String takerFeeRate)
void	setTradeId(Long tradeId)
void	setTradeSize(Long tradeSize)
void	setUnderlying(String underlying)
void	setUnderlyingPrice(String underlyingPrice)
OptionsContract	tag(String tag)
OptionsContract	takerFeeRate(String takerFeeRate)
String	toString()
OptionsContract	tradeId(Long tradeId)
OptionsContract	tradeSize(Long tradeSize)
OptionsContract	underlying(String underlying)
OptionsContract	underlyingPrice(String underlyingPrice)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_TAG

public static final String SERIALIZED_NAME_TAG

See Also:

Constant Field Values

SERIALIZED_NAME_CREATE_TIME

public static final String SERIALIZED_NAME_CREATE_TIME

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRATION_TIME

public static final String SERIALIZED_NAME_EXPIRATION_TIME

See Also:

Constant Field Values

SERIALIZED_NAME_IS_CALL

public static final String SERIALIZED_NAME_IS_CALL

See Also:

Constant Field Values

SERIALIZED_NAME_MULTIPLIER

public static final String SERIALIZED_NAME_MULTIPLIER

See Also:

Constant Field Values

SERIALIZED_NAME_UNDERLYING

public static final String SERIALIZED_NAME_UNDERLYING

See Also:

Constant Field Values

SERIALIZED_NAME_UNDERLYING_PRICE

public static final String SERIALIZED_NAME_UNDERLYING_PRICE

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_PRICE

public static final String SERIALIZED_NAME_LAST_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_INDEX_PRICE

public static final String SERIALIZED_NAME_INDEX_PRICE

See Also:

Constant Field Values

SERIALIZED_NAME_MAKER_FEE_RATE

public static final String SERIALIZED_NAME_MAKER_FEE_RATE

See Also:

Constant Field Values

SERIALIZED_NAME_TAKER_FEE_RATE

public static final String SERIALIZED_NAME_TAKER_FEE_RATE

See Also:

Constant Field Values

SERIALIZED_NAME_ORDER_PRICE_ROUND

public static final String SERIALIZED_NAME_ORDER_PRICE_ROUND

See Also:

Constant Field Values

SERIALIZED_NAME_MARK_PRICE_ROUND

public static final String SERIALIZED_NAME_MARK_PRICE_ROUND

See Also:

Constant Field Values

SERIALIZED_NAME_ORDER_SIZE_MIN

public static final String SERIALIZED_NAME_ORDER_SIZE_MIN

See Also:

Constant Field Values

SERIALIZED_NAME_ORDER_SIZE_MAX

public static final String SERIALIZED_NAME_ORDER_SIZE_MAX

See Also:

Constant Field Values

SERIALIZED_NAME_ORDER_PRICE_DEVIATE

public static final String SERIALIZED_NAME_ORDER_PRICE_DEVIATE

See Also:

Constant Field Values

SERIALIZED_NAME_REF_DISCOUNT_RATE

public static final String SERIALIZED_NAME_REF_DISCOUNT_RATE

See Also:

Constant Field Values

SERIALIZED_NAME_REF_REBATE_RATE

public static final String SERIALIZED_NAME_REF_REBATE_RATE

See Also:

Constant Field Values

SERIALIZED_NAME_ORDERBOOK_ID

public static final String SERIALIZED_NAME_ORDERBOOK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TRADE_ID

public static final String SERIALIZED_NAME_TRADE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TRADE_SIZE

public static final String SERIALIZED_NAME_TRADE_SIZE

See Also:

Constant Field Values

SERIALIZED_NAME_POSITION_SIZE

public static final String SERIALIZED_NAME_POSITION_SIZE

See Also:

Constant Field Values

SERIALIZED_NAME_ORDERS_LIMIT

public static final String SERIALIZED_NAME_ORDERS_LIMIT

See Also:

Constant Field Values

Constructor Detail

OptionsContract

public OptionsContract()

Method Detail

name

public OptionsContract name(String name)

getName

@Nullable
public String getName()

Options contract name

Returns:

name

setName

public void setName(String name)

tag

public OptionsContract tag(String tag)

getTag

@Nullable
public String getTag()

tag

Returns:

tag

setTag

public void setTag(String tag)

createTime

public OptionsContract createTime(Double createTime)

getCreateTime

@Nullable
public Double getCreateTime()

Creation time

Returns:

createTime

setCreateTime

public void setCreateTime(Double createTime)

expirationTime

public OptionsContract expirationTime(Double expirationTime)

getExpirationTime

@Nullable
public Double getExpirationTime()

Expiration time

Returns:

expirationTime

setExpirationTime

public void setExpirationTime(Double expirationTime)

isCall

public OptionsContract isCall(Boolean isCall)

getIsCall

@Nullable
public Boolean getIsCall()

`true` means call options, while `false` is put options

Returns:

isCall

setIsCall

public void setIsCall(Boolean isCall)

multiplier

public OptionsContract multiplier(String multiplier)

getMultiplier

@Nullable
public String getMultiplier()

Multiplier used in converting from invoicing to settlement currency

Returns:

multiplier

setMultiplier

public void setMultiplier(String multiplier)

underlying

public OptionsContract underlying(String underlying)

getUnderlying

@Nullable
public String getUnderlying()

Underlying

Returns:

underlying

setUnderlying

public void setUnderlying(String underlying)

underlyingPrice

public OptionsContract underlyingPrice(String underlyingPrice)

getUnderlyingPrice

@Nullable
public String getUnderlyingPrice()

Underlying price (quote currency)

Returns:

underlyingPrice

setUnderlyingPrice

public void setUnderlyingPrice(String underlyingPrice)

lastPrice

public OptionsContract lastPrice(String lastPrice)

getLastPrice

@Nullable
public String getLastPrice()

Last trading price

Returns:

lastPrice

setLastPrice

public void setLastPrice(String lastPrice)

markPrice

public OptionsContract markPrice(String markPrice)

getMarkPrice

@Nullable
public String getMarkPrice()

Current mark price (quote currency)

Returns:

markPrice

setMarkPrice

public void setMarkPrice(String markPrice)

indexPrice

public OptionsContract indexPrice(String indexPrice)

getIndexPrice

@Nullable
public String getIndexPrice()

Current index price (quote currency)

Returns:

indexPrice

setIndexPrice

public void setIndexPrice(String indexPrice)

makerFeeRate

public OptionsContract makerFeeRate(String makerFeeRate)

getMakerFeeRate

@Nullable
public String getMakerFeeRate()

Maker fee rate, where negative means rebate

Returns:

makerFeeRate

setMakerFeeRate

public void setMakerFeeRate(String makerFeeRate)

takerFeeRate

public OptionsContract takerFeeRate(String takerFeeRate)

getTakerFeeRate

@Nullable
public String getTakerFeeRate()

Taker fee rate

Returns:

takerFeeRate

setTakerFeeRate

public void setTakerFeeRate(String takerFeeRate)

orderPriceRound

public OptionsContract orderPriceRound(String orderPriceRound)

getOrderPriceRound

@Nullable
public String getOrderPriceRound()

Minimum order price increment

Returns:

orderPriceRound

setOrderPriceRound

public void setOrderPriceRound(String orderPriceRound)

markPriceRound

public OptionsContract markPriceRound(String markPriceRound)

getMarkPriceRound

@Nullable
public String getMarkPriceRound()

Minimum mark price increment

Returns:

markPriceRound

setMarkPriceRound

public void setMarkPriceRound(String markPriceRound)

orderSizeMin

public OptionsContract orderSizeMin(Long orderSizeMin)

getOrderSizeMin

@Nullable
public Long getOrderSizeMin()

Minimum order size the contract allowed

Returns:

orderSizeMin

setOrderSizeMin

public void setOrderSizeMin(Long orderSizeMin)

orderSizeMax

public OptionsContract orderSizeMax(Long orderSizeMax)

getOrderSizeMax

@Nullable
public Long getOrderSizeMax()

Maximum order size the contract allowed

Returns:

orderSizeMax

setOrderSizeMax

public void setOrderSizeMax(Long orderSizeMax)

orderPriceDeviate

public OptionsContract orderPriceDeviate(String orderPriceDeviate)

getOrderPriceDeviate

@Nullable
public String getOrderPriceDeviate()

deviation between order price and current index price. If price of an order is denoted as order_price, it must meet the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate

Returns:

orderPriceDeviate

setOrderPriceDeviate

public void setOrderPriceDeviate(String orderPriceDeviate)

refDiscountRate

public OptionsContract refDiscountRate(String refDiscountRate)

getRefDiscountRate

@Nullable
public String getRefDiscountRate()

Referral fee rate discount

Returns:

refDiscountRate

setRefDiscountRate

public void setRefDiscountRate(String refDiscountRate)

refRebateRate

public OptionsContract refRebateRate(String refRebateRate)

getRefRebateRate

@Nullable
public String getRefRebateRate()

Referrer commission rate

Returns:

refRebateRate

setRefRebateRate

public void setRefRebateRate(String refRebateRate)

orderbookId

public OptionsContract orderbookId(Long orderbookId)

getOrderbookId

@Nullable
public Long getOrderbookId()

Current orderbook ID

Returns:

orderbookId

setOrderbookId

public void setOrderbookId(Long orderbookId)

tradeId

public OptionsContract tradeId(Long tradeId)

getTradeId

@Nullable
public Long getTradeId()

Current trade ID

Returns:

tradeId

setTradeId

public void setTradeId(Long tradeId)

tradeSize

public OptionsContract tradeSize(Long tradeSize)

getTradeSize

@Nullable
public Long getTradeSize()

Historical accumulated trade size

Returns:

tradeSize

setTradeSize

public void setTradeSize(Long tradeSize)

positionSize

public OptionsContract positionSize(Long positionSize)

getPositionSize

@Nullable
public Long getPositionSize()

Current total long position size

Returns:

positionSize

setPositionSize

public void setPositionSize(Long positionSize)

ordersLimit

public OptionsContract ordersLimit(Integer ordersLimit)

getOrdersLimit

@Nullable
public Integer getOrdersLimit()

Maximum number of open orders

Returns:

ordersLimit

setOrdersLimit

public void setOrdersLimit(Integer ordersLimit)

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