Uses of Package
io.gate.gateapi.models

Packages that use io.gate.gateapi.models

Package	Description
io.gate.gateapi.api
io.gate.gateapi.models

Classes in io.gate.gateapi.models used by io.gate.gateapi.api

Class and Description
AutoRepaySetting AutoRepaySetting
BatchOrder Batch order details
CancelOrder Info of order to be cancelled
CancelOrderResult Order cancellation result
Contract Contract detail.
ContractStat ContractStat
Currency Currency
CurrencyPair Spot currency pair
DeliveryContract Futures contract details
DeliverySettlement DeliverySettlement
DepositAddress DepositAddress
FundingAccount FundingAccount
FundingBookItem FundingBookItem
FundingRateRecord FundingRateRecord
FuturesAccount FuturesAccount
FuturesAccountBook FuturesAccountBook
FuturesCandlestick data point in every timestamp
FuturesLiquidate FuturesLiquidate
FuturesOrder Futures order details
FuturesOrderBook FuturesOrderBook
FuturesPriceTriggeredOrder Futures order details
FuturesTicker FuturesTicker
FuturesTrade FuturesTrade
InsuranceRecord InsuranceRecord
LedgerRecord LedgerRecord
Loan Margin loan details
LoanPatch LoanPatch
LoanRecord Margin loaned record details
MarginAccount Margin account detail.
MarginAccountBook MarginAccountBook
MarginCurrencyPair MarginCurrencyPair
MyFuturesTrade MyFuturesTrade
OpenOrders OpenOrders
Order Spot order details
OrderBook OrderBook
Position Futures position details
PositionClose PositionClose
Repayment Repayment
RepayRequest RepayRequest
SpotAccount SpotAccount
SpotPriceTriggeredOrder Spot order detail
SubAccountBalance SubAccountBalance
SubAccountTransfer SubAccountTransfer
Ticker Ticker
Trade Trade
TradeFee TradeFee
Transfer Accounts available to transfer: - `spot`: spot account - `margin`: margin account - `futures`: perpetual futures account - `delivery`: delivery futures account
TriggerOrderResponse TriggerOrderResponse
WithdrawStatus WithdrawStatus

Classes in io.gate.gateapi.models used by io.gate.gateapi.models

Class and Description
AutoRepaySetting AutoRepaySetting
AutoRepaySetting.StatusEnum Auto repayment status.
BatchOrder Batch order details
BatchOrder.AccountEnum Account type.
BatchOrder.SideEnum Order side
BatchOrder.StatusEnum Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
BatchOrder.TimeInForceEnum Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee
BatchOrder.TypeEnum Order type.
CancelOrder Info of order to be cancelled
CancelOrderResult Order cancellation result
Contract Contract detail.
Contract.MarkTypeEnum Mark price type, internal - based on internal trading, index - based on external index price
Contract.TypeEnum Futures contract type
ContractStat ContractStat
Currency Currency
CurrencyPair Spot currency pair
CurrencyPair.TradeStatusEnum How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: can be bought or sold
DeliveryContract Futures contract details
DeliveryContract.CycleEnum Cycle type, e.g.
DeliveryContract.MarkTypeEnum Mark price type, internal - based on internal trading, index - based on external index price
DeliveryContract.TypeEnum Futures contract type
DepositAddress DepositAddress
FundingAccount FundingAccount
FundingBookItem FundingBookItem
FundingRateRecord FundingRateRecord
FuturesAccount FuturesAccount
FuturesAccountBook FuturesAccountBook
FuturesAccountBook.TypeEnum Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate
FuturesCandlestick data point in every timestamp
FuturesInitialOrder FuturesInitialOrder
FuturesInitialOrder.TifEnum Time in force.
FuturesOrder Futures order details
FuturesOrder.FinishAsEnum How the order is finished.
FuturesOrder.StatusEnum Order status - `open`: waiting to be traded - `finished`: finished
FuturesOrder.TifEnum Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, reduce-only
FuturesOrderBook FuturesOrderBook
FuturesOrderBookItem FuturesOrderBookItem
FuturesPriceTrigger FuturesPriceTrigger
FuturesPriceTrigger.PriceTypeEnum Price type.
FuturesPriceTrigger.RuleEnum Trigger condition type - `1`: calculated price based on `strategy_type` and `price_type` >= `price` - `2`: calculated price based on `strategy_type` and `price_type` <= `price`
FuturesPriceTrigger.StrategyTypeEnum How the order will be triggered - `0`: by price, which means order will be triggered on price condition satisfied - `1`: by price gap, which means order will be triggered on gap of recent two prices of specified `price_type` satisfied.
FuturesPriceTriggeredOrder Futures order details
FuturesPriceTriggeredOrder.FinishAsEnum How order is finished
FuturesPriceTriggeredOrder.StatusEnum Order status.
FuturesTicker FuturesTicker
FuturesTrade FuturesTrade
InsuranceRecord InsuranceRecord
LedgerRecord LedgerRecord
LedgerRecord.StatusEnum Record status.
Loan Margin loan details
Loan.SideEnum Loan side
Loan.StatusEnum Loan status open - not fully loaned loaned - all loaned out for lending loan; loaned in for borrowing side finished - loan is finished, either being all repaid or cancelled by the lender auto_repaid - automatically repaid by the system
LoanPatch LoanPatch
LoanPatch.SideEnum Loan side.
LoanRecord Margin loaned record details
LoanRecord.StatusEnum Loan record status
MarginAccount Margin account detail.
MarginAccountBook MarginAccountBook
MarginAccountCurrency Account currency detail
MarginCurrencyPair MarginCurrencyPair
MultiChainAddressItem MultiChainAddressItem
MyFuturesTrade MyFuturesTrade
MyFuturesTrade.RoleEnum Trade role.
OpenOrders OpenOrders
Order Spot order details
Order.AccountEnum Account type.
Order.SideEnum Order side
Order.StatusEnum Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
Order.TimeInForceEnum Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee
Order.TypeEnum Order type.
OrderBook OrderBook
Position Futures position details
Position.ModeEnum Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode
PositionClose.SideEnum Position side, long or short
PositionCloseOrder Current close order if any, or `null`
Repayment Repayment
RepayRequest RepayRequest
RepayRequest.ModeEnum Repay mode.
SpotAccount SpotAccount
SpotPricePutOrder SpotPricePutOrder
SpotPricePutOrder.AccountEnum Trading type - normal: spot trading - margin: margin trading
SpotPricePutOrder.SideEnum Order side - buy: buy side - sell: sell side
SpotPricePutOrder.TimeInForceEnum time_in_force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only
SpotPriceTrigger SpotPriceTrigger
SpotPriceTrigger.RuleEnum Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field
SpotPriceTriggeredOrder Spot order detail
SubAccountBalance SubAccountBalance
SubAccountTransfer SubAccountTransfer
SubAccountTransfer.DirectionEnum Transfer direction.
SubAccountTransfer.SubAccountTypeEnum Target sub user's account.
Ticker Ticker
Trade Trade
Trade.RoleEnum Trade role
Trade.SideEnum Order side
TradeFee TradeFee
Transfer Accounts available to transfer: - `spot`: spot account - `margin`: margin account - `futures`: perpetual futures account - `delivery`: delivery futures account
Transfer.FromEnum Account transferred from
Transfer.ToEnum Account transferred to
TriggerOrderResponse TriggerOrderResponse
WithdrawStatus WithdrawStatus