Enums Definitions

category

Contract

• linear Linear Contract, including USDT Perpetual
• inverse Inverse Contract, including Inverse Perpetual, Inverse Futures

Unified Margin

• linear Linear Contract, including USDT Perpetual, USDC Perpetual
• option

symbol

USDT Perpetual:

• BTCUSDT
• ETHUSDT

USDC Perpetual:

• BTCPERP
• ETHPERP

Inverse Perpetual:

• BTCUSD
• ETHUSD

Inverse Futures:

• BTCUSDH23 H: First quarter; 23: 2023
• BTCUSDM23 M: Second quarter; 23: 2023
• BTCUSDU23 U: Third quarter; 23: 2023
• BTCUSDZ23 Z: Fourth quarter; 23: 2023

positionIdx

• 0 one-way mode
• 1 Buy side of hedge-mode
• 2 Sell side of hedge-mode

positionStatus

• Normal
• Liq in the liquidation progress
• Adl in the auto-deleverage progress

interval

• 1 3 5 15 30 60 120 240 360 720 minute
• D day
• W week
• M month

triggerBy

• LastPrice
• MarkPrice
• IndexPrice

timeInForce

• GoodTillCancel
• ImmediateOrCancel
• FillOrKlii
• PostOnly

orderFilter

• Order active order
• StopOrder conditional order

orderStatus

• Created
• New
• Rejected
• PartiallyFilled
• Filled
• PendingCancel
• Cancelled
• Untriggered
• Triggered
• Deactivated
• Active

cancelType

• CancelByUser
• CancelByReduceOnly
• CancelByPrepareLiq CancelAllBeforeLiq
• CancelByPrepareAdl CancelAllBeforeAdl
• CancelByAdmin
• CancelByTpSlTsClear
• CancelByPzSideCh
• CancelBySmp

Options:

• CancelByUser
• CancelByReduceOnly
• CancelAllBeforeLiq Cancelled due to liquidation
• CancelAllBeforeAdl Cancelled due to ADL
• CancelBySettle
• CancelByCannotAffordOrderCost
• CancelByPmTrialMmOverEquity
• CancelByAccountBlocking
• CancelByDelivery
• CancelByMmpTriggered
• CancelByCrossSelfMuch
• CancelByCrossReachMaxTradeNum
• CancelByDCP

stopOrderType

• TakeProfit
• StopLoss
• TrailingStop
• Stop
• PartialTakeProfit
• PartialStopLoss

rejectReason

• EC_NoError
• EC_Others
• EC_UnknownMessageType
• EC_MissingClOrdID
• EC_MissingOrigClOrdID
• EC_ClOrdIDOrigClOrdIDAreTheSame
• EC_DuplicatedClOrdID
• EC_OrigClOrdIDDoesNotExist
• EC_TooLateToCancel
• EC_UnknownOrderType
• EC_UnknownSide
• EC_UnknownTimeInForce
• EC_WronglyRouted
• EC_MarketOrderPriceIsNotZero
• EC_LimitOrderInvalidPrice
• EC_NoEnoughQtyToFill
• EC_NoImmediateQtyToFill
• EC_PerCancelRequest
• EC_MarketOrderCannotBePostOnly
• EC_PostOnlyWillTakeLiquidity
• EC_CancelReplaceOrder
• EC_InvalidSymbolStatus

positionMode

• 0 One-Way Mode
• 3 Hedge Mode

execType

• Trade
• AdlTrade Auto-Deleveraging
• Funding Funding fee
• BustTrade Liquidation
• Settle

lastLiquidityInd

Unified Margin

• TAKER
• MAKER

Contract

• AddedLiquidity add liquidity
• RemovedLiquidity take liquidity

walletFundType

• Deposit
• Withdraw
• RealisedPNL
• Commission
• Refund
• Prize
• ExchangeOrderWithdraw
• ExchangeOrderDeposit
• ReturnServiceCash Refund of handling fee bonus
• Insurance Insurance account transfer
• SubMember Main-Sub account transfer
• Coupon Coupon interest
• AccountTransfer Account transfer
• CashBack Cash back

type

• TRANSFER_IN
• TRANSFER_OUT
• TRADE
• SETTLEMENT
• DELIVERY
• LIQUIDATION
• BONUS
• FEE_REFUND
• INTEREST
• CURRENCY_BUY
• CURRENCY_SELL

adlRankIndicator

• 0 default value of empty position
• 1
• 2
• 3
• 4
• 5

tickDirection

It indicates price fluctuation relative to the last trade.

• PlusTick price rise
• ZeroPlusTick trade occurs at the same price as the previous trade, which occurred at a price higher than that for the trade preceding it
• MinusTick price drop
• ZeroMinusTick trade occurs at the same price as the previous trade, which occurred at a price lower than that for the trade preceding it

smpType

• default: None
• CancelMaker
• CancelTaker
• CancelBoth

unifiedMarginStatus

• 1 Regular account
• 2 Unified margin account, it only trades linear perpetual and options.
• 3 Unified trade account, it can trade linear perpetual, options and spot