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
AccountDetail Account detail
AgencyCommissionHistory AgencyCommissionHistory
AgencyTransactionHistory AgencyTransactionHistory
AutoRepaySetting AutoRepaySetting
BatchFuturesOrder Futures order details
BatchOrder Batch order details
CancelOrder Info of order to be cancelled
CancelOrderResult Order cancellation result
Contract Futures contract details
ContractStat ContractStat
CountdownCancelAllFuturesTask Countdown cancel task detail
CountdownCancelAllSpotTask Countdown cancel task detail
CreateUniLend Lend or redeem
CreateUniLoan Borrow or repay
CrossMarginAccount CrossMarginAccount
CrossMarginAccountBook CrossMarginAccountBook
CrossMarginBorrowable CrossMarginBorrowable
CrossMarginCurrency CrossMarginCurrency
CrossMarginLoan CrossMarginLoan
CrossMarginRepayment CrossMarginRepayment
CrossMarginRepayRequest CrossMarginRepayRequest
CrossMarginTransferable CrossMarginTransferable
Currency Currency
CurrencyChain CurrencyChain
CurrencyPair Spot currency pair
DeliveryContract Futures contract details
DeliverySettlement DeliverySettlement
DepositAddress DepositAddress
FlashSwapCurrency Currencies supported in flash swap
FlashSwapOrder Flash swap order
FlashSwapOrderPreview Initiate a flash swap order preview
FlashSwapOrderRequest Parameters of flash swap order creation
FlashSwapPreviewRequest Parameters of flash swap order creation
FundingAccount FundingAccount
FundingBookItem FundingBookItem
FundingRateRecord FundingRateRecord
FuturesAccount FuturesAccount
FuturesAccountBook FuturesAccountBook
FuturesAutoDeleverage FuturesAutoDeleverage
FuturesCandlestick data point in every timestamp
FuturesIndexConstituents FuturesIndexConstituents
FuturesLiquidate FuturesLiquidate
FuturesOrder Futures order details
FuturesOrderAmendment FuturesOrderAmendment
FuturesOrderBook FuturesOrderBook
FuturesPremiumIndex data point in every timestamp
FuturesPriceTriggeredOrder Futures order details
FuturesTicker FuturesTicker
FuturesTrade FuturesTrade
InsuranceRecord InsuranceRecord
LedgerRecord LedgerRecord
LiquidateOrder Liquidate Order detail
Loan Margin loan details
LoanPatch LoanPatch
LoanRecord Margin loaned record details
MarginAccount Margin account detail.
MarginAccountBook MarginAccountBook
MarginBorrowable MarginBorrowable
MarginCurrencyPair MarginCurrencyPair
MarginTransferable MarginTransferable
MaxUniBorrowable MaxUniBorrowable
MyFuturesTrade MyFuturesTrade
MyFuturesTradeTimeRange MyFuturesTradeTimeRange
OpenOrders OpenOrders
OptionsAccount OptionsAccount
OptionsAccountBook OptionsAccountBook
OptionsCandlestick data point in every timestamp
OptionsContract Options contract detail
OptionsMySettlements OptionsMySettlements
OptionsMyTrade OptionsMyTrade
OptionsOrder Options order detail
OptionsPosition Options position information
OptionsPositionClose OptionsPositionClose
OptionsSettlement OptionsSettlement
OptionsTicker Options contract detail
OptionsUnderlying OptionsUnderlying
OptionsUnderlyingTicker Options underlying detail
Order Spot order details
OrderBook OrderBook
OrderPatch Spot order details
PatchUniLend PatchUniLend
Position Futures position details
PositionClose PositionClose
Repayment Repayment
RepayRequest RepayRequest
SavedAddress SavedAddress
SpotAccount SpotAccount
SpotFee SpotFee
SpotPriceTriggeredOrder Spot order detail
SubAccount SubAccount
SubAccountBalance SubAccountBalance
SubAccountCrossMarginBalance SubAccountCrossMarginBalance
SubAccountFuturesBalance SubAccountFuturesBalance
SubAccountKey SubAccountKey
SubAccountMarginBalance SubAccountMarginBalance
SubAccountToSubAccount SubAccountToSubAccount
SubAccountTransfer SubAccountTransfer
SystemTime SystemTime
Ticker Ticker
TotalBalance User's balance in all accounts
Trade Trade
TradeFee TradeFee
TransactionID TransactionID
Transfer Accounts available to transfer: - `spot`: spot account - `margin`: margin account - `futures`: perpetual futures account - `delivery`: delivery futures account - `cross_margin`: cross margin account - `options`: options account
TriggerOrderResponse TriggerOrderResponse
TriggerTime TriggerTime
UniCurrency Currency detail
UniCurrencyPair Currency pair of the loan
UniInterestRecord Interest Record
UniLend Loan record
UniLendInterest UniLendInterest
UniLendRecord Interest Record
UniLoan Loan
UniLoanInterestRecord Interest record
UniLoanRecord Loan record
WithdrawStatus WithdrawStatus

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

Class and Description
AccountBalance Total balances calculated with specified currency unit
AccountBalance.CurrencyEnum Currency
AccountDetail Account detail
AgencyCommission AgencyCommission
AgencyCommissionHistory AgencyCommissionHistory
AgencyTransaction AgencyTransaction
AgencyTransactionHistory AgencyTransactionHistory
ApiV4KeyPerm ApiV4KeyPerm
ApiV4KeyPerm.NameEnum Permission name (all permissions will be removed if no value is passed) - wallet: wallet - spot: spot/margin - futures: perpetual contract - delivery: delivery - earn: earn - options: options
AutoRepaySetting AutoRepaySetting
AutoRepaySetting.StatusEnum Auto repayment status.
BatchFuturesOrder Futures order details
BatchFuturesOrder.AutoSizeEnum Set side to close dual-mode position.
BatchFuturesOrder.FinishAsEnum How the order was finished.
BatchFuturesOrder.StatusEnum Order status - `open`: waiting to be traded - `finished`: finished
BatchFuturesOrder.StpActEnum Self-Trading Prevention Action.
BatchFuturesOrder.TifEnum 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 Batch order details
BatchOrder.AccountEnum Account type.
BatchOrder.FinishAsEnum How the order was finished.
BatchOrder.SideEnum Order side
BatchOrder.StatusEnum Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
BatchOrder.StpActEnum Self-Trading Prevention Action.
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
BatchOrder.TypeEnum Order Type - limit : Limit Order - market : Market Order
CancelOrder Info of order to be cancelled
CancelOrderResult Order cancellation result
Contract Futures contract details
Contract.MarkTypeEnum Mark price type, internal - based on internal trading, index - based on external index price
Contract.TypeEnum Futures contract type
ContractStat ContractStat
CountdownCancelAllFuturesTask Countdown cancel task detail
CountdownCancelAllSpotTask Countdown cancel task detail
CreateUniLend Lend or redeem
CreateUniLend.TypeEnum type: lend - lend, redeem - redeem
CreateUniLoan Borrow or repay
CreateUniLoan.TypeEnum type: borrow - borrow, repay - repay
CrossMarginAccount CrossMarginAccount
CrossMarginAccountBook CrossMarginAccountBook
CrossMarginAccountBook.TypeEnum Account change type, including: - in: transferals into cross margin account - out: transferals out from cross margin account - repay: loan repayment - borrow: borrowed loan - interest: interest - new_order: new order locked - order_fill: order fills - referral_fee: fee refund from referrals - order_fee: order fee generated from fills - futures_in: transfer into futures account - futures_out: transfer out of futures account - unknown: unknown type
CrossMarginBalance CrossMarginBalance
CrossMarginBalance1 CrossMarginBalance1
CrossMarginBorrowable CrossMarginBorrowable
CrossMarginCurrency CrossMarginCurrency
CrossMarginLoan CrossMarginLoan
CrossMarginLoan.StatusEnum Borrow loan status, which includes: - 1: failed to borrow - 2: borrowed but not repaid - 3: repayment complete
CrossMarginRepayment CrossMarginRepayment
CrossMarginRepayRequest CrossMarginRepayRequest
CrossMarginTransferable CrossMarginTransferable
Currency Currency
CurrencyChain CurrencyChain
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
FlashSwapOrderPreview Initiate a flash swap order preview
FlashSwapOrderRequest Parameters of flash swap order creation
FlashSwapPreviewRequest Parameters of flash swap order creation
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
FuturesAccountHistory Statistical data
FuturesCandlestick data point in every timestamp
FuturesInitialOrder FuturesInitialOrder
FuturesInitialOrder.TifEnum Time in force.
FuturesOrder Futures order details
FuturesOrder.AutoSizeEnum Set side to close dual-mode position.
FuturesOrder.FinishAsEnum How the order was finished.
FuturesOrder.StatusEnum Order status - `open`: waiting to be traded - `finished`: finished
FuturesOrder.StpActEnum Self-Trading Prevention Action.
FuturesOrder.TifEnum 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
FuturesOrderAmendment FuturesOrderAmendment
FuturesOrderBook FuturesOrderBook
FuturesOrderBookItem FuturesOrderBookItem
FuturesPremiumIndex data point in every timestamp
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 the order will be triggered if price condition is satisfied - `1`: by price gap, which means the order will be triggered if gap of recent two prices of specified `price_type` are satisfied.
FuturesPriceTriggeredOrder Futures order details
FuturesPriceTriggeredOrder.FinishAsEnum How order is finished
FuturesPriceTriggeredOrder.StatusEnum Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order
FuturesTicker FuturesTicker
FuturesTrade FuturesTrade
IndexConstituent IndexConstituent
InsuranceRecord InsuranceRecord
LedgerRecord LedgerRecord
LedgerRecord.StatusEnum Record status.
LiquidateOrder Liquidate Order detail
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 details
MarginBorrowable MarginBorrowable
MarginCurrencyPair MarginCurrencyPair
MarginTransferable MarginTransferable
MultiChainAddressItem MultiChainAddressItem
MyFuturesTrade MyFuturesTrade
MyFuturesTrade.RoleEnum Trade role.
MyFuturesTradeTimeRange MyFuturesTradeTimeRange
MyFuturesTradeTimeRange.RoleEnum Trade role.
OpenOrders OpenOrders
OptionsAccount OptionsAccount
OptionsAccountBook OptionsAccountBook
OptionsCandlestick data point in every timestamp
OptionsContract Options contract detail
OptionsMySettlements OptionsMySettlements
OptionsMyTrade OptionsMyTrade
OptionsMyTrade.RoleEnum Trade role.
OptionsOrder Options order detail
OptionsOrder.FinishAsEnum How the order was finished.
OptionsOrder.StatusEnum Order status - `open`: waiting to be traded - `finished`: finished
OptionsOrder.TifEnum Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee
OptionsPosition Options position information
OptionsPositionClose.SideEnum Position side, long or short
OptionsPositionCloseOrder Current close order if any, or `null`
OptionsSettlement OptionsSettlement
OptionsTicker Options contract detail
OptionsUnderlying OptionsUnderlying
OptionsUnderlyingTicker Options underlying detail
Order Spot order details
Order.AccountEnum Account type.
Order.FinishAsEnum How the order was finished.
Order.SideEnum Order side
Order.StatusEnum Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled
Order.StpActEnum Self-Trading Prevention Action.
Order.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 Only `ioc` and `fok` are supported when `type`=`market`
Order.TypeEnum Order Type - limit : Limit Order - market : Market Order
OrderBook OrderBook
OrderPatch Spot order details
PatchUniLend PatchUniLend
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.
SavedAddress SavedAddress
SpotAccount SpotAccount
SpotFee SpotFee
SpotPricePutOrder SpotPricePutOrder
SpotPricePutOrder.AccountEnum Trading account type.
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
SubAccount SubAccount
SubAccountBalance SubAccountBalance
SubAccountCrossMarginBalance SubAccountCrossMarginBalance
SubAccountFuturesBalance SubAccountFuturesBalance
SubAccountKey SubAccountKey
SubAccountMarginBalance SubAccountMarginBalance
SubAccountToSubAccount SubAccountToSubAccount
SubAccountToSubAccount.SubAccountFromTypeEnum Transfer from the account.
SubAccountToSubAccount.SubAccountToTypeEnum Transfer to the account.
SubAccountTransfer SubAccountTransfer
SubAccountTransfer.DirectionEnum Transfer direction.
SubAccountTransfer.SubAccountTypeEnum Target sub user's account.
SubCrossMarginAccount SubCrossMarginAccount
SystemTime SystemTime
Ticker Ticker
TotalBalance User's balance in all accounts
Trade Trade
Trade.RoleEnum Trade role.
Trade.SideEnum Order side
TradeFee TradeFee
TransactionID TransactionID
Transfer Accounts available to transfer: - `spot`: spot account - `margin`: margin account - `futures`: perpetual futures account - `delivery`: delivery futures account - `cross_margin`: cross margin account - `options`: options account
Transfer.FromEnum Account to transfer from
Transfer.ToEnum Account to transfer to
TriggerOrderResponse TriggerOrderResponse
TriggerTime TriggerTime
WithdrawStatus WithdrawStatus