io.gate.gateapi.models

Class Contract

java.lang.Object

io.gate.gateapi.models.Contract

public class Contract
extends Object

Contract detail. USD value per contract: - USDT settled contracts： `quanto_multiplier x token price` - BTC settled contracts：`quanto_multiplier x BTC price x token price`

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Contract.MarkTypeEnum Mark price type, internal - based on internal trading, index - based on external index price
static class	Contract.TypeEnum Futures contract type

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CONFIG_CHANGE_TIME
static String	SERIALIZED_NAME_FUNDING_INTERVAL
static String	SERIALIZED_NAME_FUNDING_NEXT_APPLY
static String	SERIALIZED_NAME_FUNDING_RATE
static String	SERIALIZED_NAME_IN_DELISTING
static String	SERIALIZED_NAME_INDEX_PRICE
static String	SERIALIZED_NAME_LAST_PRICE
static String	SERIALIZED_NAME_LEVERAGE_MAX
static String	SERIALIZED_NAME_LEVERAGE_MIN
static String	SERIALIZED_NAME_MAINTENANCE_RATE
static String	SERIALIZED_NAME_MAKER_FEE_RATE
static String	SERIALIZED_NAME_MARK_PRICE
static String	SERIALIZED_NAME_MARK_PRICE_ROUND
static String	SERIALIZED_NAME_MARK_TYPE
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_QUANTO_MULTIPLIER
static String	SERIALIZED_NAME_REF_DISCOUNT_RATE
static String	SERIALIZED_NAME_REF_REBATE_RATE
static String	SERIALIZED_NAME_RISK_LIMIT_BASE
static String	SERIALIZED_NAME_RISK_LIMIT_MAX
static String	SERIALIZED_NAME_RISK_LIMIT_STEP
static String	SERIALIZED_NAME_TAKER_FEE_RATE
static String	SERIALIZED_NAME_TRADE_ID
static String	SERIALIZED_NAME_TRADE_SIZE
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
Contract()

Method Summary

Modifier and Type	Method and Description
Contract	configChangeTime(Double configChangeTime)
boolean	equals(Object o)
Contract	fundingInterval(Integer fundingInterval)
Contract	fundingNextApply(Double fundingNextApply)
Contract	fundingRate(String fundingRate)
Double	getConfigChangeTime() Configuration's last changed time
Integer	getFundingInterval() Funding application interval, unit in seconds
Double	getFundingNextApply() Next funding time
String	getFundingRate() Current funding rate
Boolean	getInDelisting() Contract is delisting
String	getIndexPrice() Current index price
String	getLastPrice() Last trading price
String	getLeverageMax() Maximum leverage
String	getLeverageMin() Minimum leverage
String	getMaintenanceRate() Maintenance rate of margin
String	getMakerFeeRate() Maker fee rate, where negative means rebate
String	getMarkPrice() Current mark price
String	getMarkPriceRound() Minimum mark price increment
Contract.MarkTypeEnum	getMarkType() Mark price type, internal - based on internal trading, index - based on external index price
String	getName() Futures contract
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	getQuantoMultiplier() Multiplier used in converting from invoicing to settlement currency
String	getRefDiscountRate() Referral fee rate discount
String	getRefRebateRate() Referrer commission rate
String	getRiskLimitBase() Risk limit base
String	getRiskLimitMax() Maximum risk limit the contract allowed
String	getRiskLimitStep() Step of adjusting risk limit
String	getTakerFeeRate() Taker fee rate
Long	getTradeId() Current trade ID
Long	getTradeSize() Historical accumulation trade size
Contract.TypeEnum	getType() Futures contract type
int	hashCode()
Contract	inDelisting(Boolean inDelisting)
Contract	indexPrice(String indexPrice)
Contract	lastPrice(String lastPrice)
Contract	leverageMax(String leverageMax)
Contract	leverageMin(String leverageMin)
Contract	maintenanceRate(String maintenanceRate)
Contract	makerFeeRate(String makerFeeRate)
Contract	markPrice(String markPrice)
Contract	markPriceRound(String markPriceRound)
Contract	markType(Contract.MarkTypeEnum markType)
Contract	name(String name)
Contract	orderbookId(Long orderbookId)
Contract	orderPriceDeviate(String orderPriceDeviate)
Contract	orderPriceRound(String orderPriceRound)
Contract	orderSizeMax(Long orderSizeMax)
Contract	orderSizeMin(Long orderSizeMin)
Contract	ordersLimit(Integer ordersLimit)
Contract	positionSize(Long positionSize)
Contract	quantoMultiplier(String quantoMultiplier)
Contract	refDiscountRate(String refDiscountRate)
Contract	refRebateRate(String refRebateRate)
Contract	riskLimitBase(String riskLimitBase)
Contract	riskLimitMax(String riskLimitMax)
Contract	riskLimitStep(String riskLimitStep)
void	setConfigChangeTime(Double configChangeTime)
void	setFundingInterval(Integer fundingInterval)
void	setFundingNextApply(Double fundingNextApply)
void	setFundingRate(String fundingRate)
void	setInDelisting(Boolean inDelisting)
void	setIndexPrice(String indexPrice)
void	setLastPrice(String lastPrice)
void	setLeverageMax(String leverageMax)
void	setLeverageMin(String leverageMin)
void	setMaintenanceRate(String maintenanceRate)
void	setMakerFeeRate(String makerFeeRate)
void	setMarkPrice(String markPrice)
void	setMarkPriceRound(String markPriceRound)
void	setMarkType(Contract.MarkTypeEnum markType)
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	setQuantoMultiplier(String quantoMultiplier)
void	setRefDiscountRate(String refDiscountRate)
void	setRefRebateRate(String refRebateRate)
void	setRiskLimitBase(String riskLimitBase)
void	setRiskLimitMax(String riskLimitMax)
void	setRiskLimitStep(String riskLimitStep)
void	setTakerFeeRate(String takerFeeRate)
void	setTradeId(Long tradeId)
void	setTradeSize(Long tradeSize)
void	setType(Contract.TypeEnum type)
Contract	takerFeeRate(String takerFeeRate)
String	toString()
Contract	tradeId(Long tradeId)
Contract	tradeSize(Long tradeSize)
Contract	type(Contract.TypeEnum type)

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_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_QUANTO_MULTIPLIER

public static final String SERIALIZED_NAME_QUANTO_MULTIPLIER

See Also:

Constant Field Values

SERIALIZED_NAME_LEVERAGE_MIN

public static final String SERIALIZED_NAME_LEVERAGE_MIN

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_MARK_TYPE

public static final String SERIALIZED_NAME_MARK_TYPE

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_LAST_PRICE

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

public static final String SERIALIZED_NAME_FUNDING_RATE

See Also:

Constant Field Values

SERIALIZED_NAME_FUNDING_INTERVAL

public static final String SERIALIZED_NAME_FUNDING_INTERVAL

See Also:

Constant Field Values

SERIALIZED_NAME_FUNDING_NEXT_APPLY

public static final String SERIALIZED_NAME_FUNDING_NEXT_APPLY

See Also:

Constant Field Values

SERIALIZED_NAME_RISK_LIMIT_BASE

public static final String SERIALIZED_NAME_RISK_LIMIT_BASE

See Also:

Constant Field Values

SERIALIZED_NAME_RISK_LIMIT_STEP

public static final String SERIALIZED_NAME_RISK_LIMIT_STEP

See Also:

Constant Field Values

SERIALIZED_NAME_RISK_LIMIT_MAX

public static final String SERIALIZED_NAME_RISK_LIMIT_MAX

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_CONFIG_CHANGE_TIME

public static final String SERIALIZED_NAME_CONFIG_CHANGE_TIME

See Also:

Constant Field Values

SERIALIZED_NAME_IN_DELISTING

public static final String SERIALIZED_NAME_IN_DELISTING

See Also:

Constant Field Values

SERIALIZED_NAME_ORDERS_LIMIT

public static final String SERIALIZED_NAME_ORDERS_LIMIT

See Also:

Constant Field Values

Constructor Detail

Contract

public Contract()

Method Detail

name

public Contract name(String name)

getName

@Nullable
public String getName()

Futures contract

Returns:

name

setName

public void setName(String name)

type

public Contract type(Contract.TypeEnum type)

getType

@Nullable
public Contract.TypeEnum getType()

Futures contract type

Returns:

type

setType

public void setType(Contract.TypeEnum type)

quantoMultiplier

public Contract quantoMultiplier(String quantoMultiplier)

getQuantoMultiplier

@Nullable
public String getQuantoMultiplier()

Multiplier used in converting from invoicing to settlement currency

Returns:

quantoMultiplier

setQuantoMultiplier

public void setQuantoMultiplier(String quantoMultiplier)

leverageMin

public Contract leverageMin(String leverageMin)

getLeverageMin

@Nullable
public String getLeverageMin()

Minimum leverage

Returns:

leverageMin

setLeverageMin

public void setLeverageMin(String leverageMin)

leverageMax

public Contract leverageMax(String leverageMax)

getLeverageMax

@Nullable
public String getLeverageMax()

Maximum leverage

Returns:

leverageMax

setLeverageMax

public void setLeverageMax(String leverageMax)

maintenanceRate

public Contract maintenanceRate(String maintenanceRate)

getMaintenanceRate

@Nullable
public String getMaintenanceRate()

Maintenance rate of margin

Returns:

maintenanceRate

setMaintenanceRate

public void setMaintenanceRate(String maintenanceRate)

markType

public Contract markType(Contract.MarkTypeEnum markType)

getMarkType

@Nullable
public Contract.MarkTypeEnum getMarkType()

Mark price type, internal - based on internal trading, index - based on external index price

Returns:

markType

setMarkType

public void setMarkType(Contract.MarkTypeEnum markType)

markPrice

public Contract markPrice(String markPrice)

getMarkPrice

@Nullable
public String getMarkPrice()

Current mark price

Returns:

markPrice

setMarkPrice

public void setMarkPrice(String markPrice)

indexPrice

public Contract indexPrice(String indexPrice)

getIndexPrice

@Nullable
public String getIndexPrice()

Current index price

Returns:

indexPrice

setIndexPrice

public void setIndexPrice(String indexPrice)

lastPrice

public Contract lastPrice(String lastPrice)

getLastPrice

@Nullable
public String getLastPrice()

Last trading price

Returns:

lastPrice

setLastPrice

public void setLastPrice(String lastPrice)

makerFeeRate

public Contract 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 Contract takerFeeRate(String takerFeeRate)

getTakerFeeRate

@Nullable
public String getTakerFeeRate()

Taker fee rate

Returns:

takerFeeRate

setTakerFeeRate

public void setTakerFeeRate(String takerFeeRate)

orderPriceRound

public Contract orderPriceRound(String orderPriceRound)

getOrderPriceRound

@Nullable
public String getOrderPriceRound()

Minimum order price increment

Returns:

orderPriceRound

setOrderPriceRound

public void setOrderPriceRound(String orderPriceRound)

markPriceRound

public Contract markPriceRound(String markPriceRound)

getMarkPriceRound

@Nullable
public String getMarkPriceRound()

Minimum mark price increment

Returns:

markPriceRound

setMarkPriceRound

public void setMarkPriceRound(String markPriceRound)

fundingRate

public Contract fundingRate(String fundingRate)

getFundingRate

@Nullable
public String getFundingRate()

Current funding rate

Returns:

fundingRate

setFundingRate

public void setFundingRate(String fundingRate)

fundingInterval

public Contract fundingInterval(Integer fundingInterval)

getFundingInterval

@Nullable
public Integer getFundingInterval()

Funding application interval, unit in seconds

Returns:

fundingInterval

setFundingInterval

public void setFundingInterval(Integer fundingInterval)

fundingNextApply

public Contract fundingNextApply(Double fundingNextApply)

getFundingNextApply

@Nullable
public Double getFundingNextApply()

Next funding time

Returns:

fundingNextApply

setFundingNextApply

public void setFundingNextApply(Double fundingNextApply)

riskLimitBase

public Contract riskLimitBase(String riskLimitBase)

getRiskLimitBase

@Nullable
public String getRiskLimitBase()

Risk limit base

Returns:

riskLimitBase

setRiskLimitBase

public void setRiskLimitBase(String riskLimitBase)

riskLimitStep

public Contract riskLimitStep(String riskLimitStep)

getRiskLimitStep

@Nullable
public String getRiskLimitStep()

Step of adjusting risk limit

Returns:

riskLimitStep

setRiskLimitStep

public void setRiskLimitStep(String riskLimitStep)

riskLimitMax

public Contract riskLimitMax(String riskLimitMax)

getRiskLimitMax

@Nullable
public String getRiskLimitMax()

Maximum risk limit the contract allowed

Returns:

riskLimitMax

setRiskLimitMax

public void setRiskLimitMax(String riskLimitMax)

orderSizeMin

public Contract orderSizeMin(Long orderSizeMin)

getOrderSizeMin

@Nullable
public Long getOrderSizeMin()

Minimum order size the contract allowed

Returns:

orderSizeMin

setOrderSizeMin

public void setOrderSizeMin(Long orderSizeMin)

orderSizeMax

public Contract orderSizeMax(Long orderSizeMax)

getOrderSizeMax

@Nullable
public Long getOrderSizeMax()

Maximum order size the contract allowed

Returns:

orderSizeMax

setOrderSizeMax

public void setOrderSizeMax(Long orderSizeMax)

orderPriceDeviate

public Contract 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 Contract refDiscountRate(String refDiscountRate)

getRefDiscountRate

@Nullable
public String getRefDiscountRate()

Referral fee rate discount

Returns:

refDiscountRate

setRefDiscountRate

public void setRefDiscountRate(String refDiscountRate)

refRebateRate

public Contract refRebateRate(String refRebateRate)

getRefRebateRate

@Nullable
public String getRefRebateRate()

Referrer commission rate

Returns:

refRebateRate

setRefRebateRate

public void setRefRebateRate(String refRebateRate)

orderbookId

public Contract orderbookId(Long orderbookId)

getOrderbookId

@Nullable
public Long getOrderbookId()

Current orderbook ID

Returns:

orderbookId

setOrderbookId

public void setOrderbookId(Long orderbookId)

tradeId

public Contract tradeId(Long tradeId)

getTradeId

@Nullable
public Long getTradeId()

Current trade ID

Returns:

tradeId

setTradeId

public void setTradeId(Long tradeId)

tradeSize

public Contract tradeSize(Long tradeSize)

getTradeSize

@Nullable
public Long getTradeSize()

Historical accumulation trade size

Returns:

tradeSize

setTradeSize

public void setTradeSize(Long tradeSize)

positionSize

public Contract positionSize(Long positionSize)

getPositionSize

@Nullable
public Long getPositionSize()

Current total long position size

Returns:

positionSize

setPositionSize

public void setPositionSize(Long positionSize)

configChangeTime

public Contract configChangeTime(Double configChangeTime)

getConfigChangeTime

@Nullable
public Double getConfigChangeTime()

Configuration's last changed time

Returns:

configChangeTime

setConfigChangeTime

public void setConfigChangeTime(Double configChangeTime)

inDelisting

public Contract inDelisting(Boolean inDelisting)

getInDelisting

@Nullable
public Boolean getInDelisting()

Contract is delisting

Returns:

inDelisting

setInDelisting

public void setInDelisting(Boolean inDelisting)

ordersLimit

public Contract 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