Skip to main content

Enums Definitions

locale​

  • de-DE
  • en-US
  • es-AR
  • es-ES
  • es-MX
  • fr-FR
  • kk-KZ
  • id-ID
  • uk-UA
  • ja-JP
  • ru-RU
  • th-TH
  • pt-BR
  • tr-TR
  • vi-VN
  • zh-TW
  • ar-SA
  • hi-IN
  • fil-PH

category​

Normal Account

  • linear USDT perp
  • inverse Inverse contract, including Inverse perp, Inverse futures

orderStatus​

  • Created order has been accepted by the system but not yet put through the matching engine
  • New order has been placed successfully
  • Rejected
  • PartiallyFilled
  • Filled
  • Cancelled In derivatives, orders with this status may have an executed qty
  • Untriggered
  • Triggered
  • Deactivated
  • Active order has been triggered and the new active order has been successfully placed. Is the final state of a successful conditional order

timeInForce​

  • GTC GoodTillCancel
  • IOC ImmediateOrCancel
  • FOK FillOrKill
  • PostOnly

execType​

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

stopOrderType​

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

tickDirection​

  • 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

interval​

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

positionIdx​

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

positionStatus​

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

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

accountType​

  • CONTRACT Derivatives Account
  • SPOT Spot Account
  • FUND Funding Account
  • COPYTRADING Copy trade Account

transferStatus​

  • SUCCESS
  • PENDING
  • FAILED

depositStatus​

  • 0 unknown
  • 1 toBeConfirmed
  • 2 processing
  • 3 success
  • 4 deposit failed

withdrawStatus​

  • Pending Review
  • Pending Transfer
  • Rejected
  • Transferred successfully
  • Cancelled
  • Fail

triggerBy​

  • LastPrice
  • IndexPrice
  • MarkPrice

cancelType​

  • CancelByUser
  • CancelByReduceOnly
  • CancelByPrepareLiq CancelAllBeforeLiq Cancelled due to liquidation
  • CancelByPrepareAdl CancelAllBeforeAdl Cancelled due to ADL
  • CancelByAdmin
  • CancelByTpSlTsClear
  • CancelByPzSideCh
  • CancelBySmp

period​

  • BTC: 7,14,21,30,60,90,180,270days
  • ETH: 7,14,21,30,60,90,180,270days
  • SOL: 7,14,21,30,60,90days

contractType​

  • InversePerpetual
  • LinearPerpetual

status​

  • PreLaunch
  • Trading
  • Settling
  • Closed

type​

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

unifiedMarginStatus​

  • 1 Regular account

ltStatus​

  • 1 LT can be purchased and redeemed
  • 2 LT can be purchased, but not redeemed
  • 3 LT can be redeemed, but not purchased
  • 4 LT cannot be purchased nor redeemed
  • 5 Adjusting position

symbol​

USDT Perpetual:

  • BTCUSDT
  • ETHUSDT

Inverse Perpetual:

  • BTCUSD
  • ETHUSD

vipLevel​

  • No VIP
  • PRO-1
  • PRO-2
  • PRO-3
  • VIP-1
  • VIP-2
  • VIP-3
  • MM-1
  • MM-2
  • MM-3

adlRankIndicator​

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