| Enum | Description |
|---|---|
| AccountBalance.CurrencyEnum |
Currency
|
| 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.StatusEnum |
Auto repayment status.
|
| 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.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
|
| Contract.MarkTypeEnum |
Mark price type, internal - based on internal trading, index - based on external index price
|
| Contract.TypeEnum |
Futures contract type
|
| CreateUniLend.TypeEnum |
type: lend - lend, redeem - redeem
|
| CreateUniLoan.TypeEnum |
type: borrow - borrow, repay - repay
|
| 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
|
| CrossMarginLoan.StatusEnum |
Borrow loan status, which includes: - 1: failed to borrow - 2: borrowed but not repaid - 3: repayment complete
|
| 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.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
|
| 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
|
| FuturesInitialOrder.TifEnum |
Time in force.
|
| 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
|
| 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.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
|
| LedgerRecord.StatusEnum |
Record status.
|
| 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.SideEnum |
Loan side.
|
| LoanRecord.StatusEnum |
Loan record status
|
| MyFuturesTrade.RoleEnum |
Trade role.
|
| MyFuturesTradeTimeRange.RoleEnum |
Trade role.
|
| OptionsMyTrade.RoleEnum |
Trade role.
|
| 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
|
| OptionsPositionClose.SideEnum |
Position side, long or short
|
| 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
|
| 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
|
| RepayRequest.ModeEnum |
Repay mode.
|
| 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.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
|
| SubAccountToSubAccount.SubAccountFromTypeEnum |
Transfer from the account.
|
| SubAccountToSubAccount.SubAccountToTypeEnum |
Transfer to the account.
|
| SubAccountTransfer.DirectionEnum |
Transfer direction.
|
| SubAccountTransfer.SubAccountTypeEnum |
Target sub user's account.
|
| Trade.RoleEnum |
Trade role.
|
| Trade.SideEnum |
Order side
|
| Transfer.FromEnum |
Account to transfer from
|
| Transfer.ToEnum |
Account to transfer to
|
Copyright © 2023. All rights reserved.