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

announcementType

• new_crypto
• latest_bybit_news
• delistings
• latest_activities
• product_updates
• maintenance_updates
• new_fiat_listings
• other

announcementTag

• Spot
• Derivatives
• Spot Listings
• BTC
• ETH
• Trading Bots
• USDC
• Leveraged Tokens
• USDT
• Margin Trading
• Partnerships
• Launchpad
• Upgrades
• ByVotes
• Delistings
• VIP
• Futures
• Institutions
• Options
• WEB3
• Copy Trading
• Earn
• Bybit Savings
• Dual Asset
• Liquidity Mining
• Shark Fin
• Launchpool
• NFT GrabPic
• Buy Crypto
• P2P Trading
• Fiat Deposit
• Crypto Deposit
• Спот
• Спот лістинги
• Торгові боти
• Токени з кредитним плечем
• Маржинальна торгівля
• Партнерство
• Оновлення
• Делістинги
• Ф'ючерси
• Опціони
• Копітрейдинг
• Bybit Накопичення
• Бівалютні інвестиції
• Майнінг ліквідності
• Купівля криптовалюти
• P2P торгівля
• Фіатні депозити
• Криптодепозити
• Копитрейдинг
• Торговые боты
• Деривативы
• P2P
• Спот листинги
• Деривативи
• MT4
• Lucky Draw
• Unified Trading Account
• Єдиний торговий акаунт
• Единый торговый аккаунт
• Институциональный трейдинг
• Інституціональний трейдинг
• Делистинг

category

Unified Account

• spot
• linear USDT perpetual, and USDC contract, including USDC perp, USDC futures
• inverse Inverse contract, including Inverse perp, Inverse futures
• option

Classic Account

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

orderStatus

open status

• New order has been placed successfully
• PartiallyFilled
• Untriggered Conditional orders are created

closed status

• Rejected
• PartiallyFilledCanceled Only spot has this order status
• Filled
• Cancelled In derivatives, orders with this status may have an executed qty
• Triggered instantaneous state for conditional orders from Untriggered to New
• Deactivated UTA: Spot tp/sl order, conditional order, OCO order are cancelled before they are triggered

timeInForce

• GTC GoodTillCancel
• IOC ImmediateOrCancel
• FOK FillOrKill
• PostOnly

createType

• CreateByUser
• CreateByAdminClosing
• CreateBySettle USDC Futures delivery; Position closed by contract delisted
• CreateByStopOrder Futures conditional order
• CreateByTakeProfit Futures take profit order
• CreateByPartialTakeProfit Futures partial take profit order
• CreateByStopLoss Futures stop loss order
• CreateByPartialStopLoss Futures partial stop loss order
• CreateByTrailingStop Futures trailing stop order
• CreateByLiq Laddered liquidation to reduce the required maintenance margin
• CreateByTakeOver_PassThroughIf the position is still subject to liquidation (i.e., does not meet the required maintenance margin level), the position shall be taken over by the liquidation engine and closed at the bankruptcy price.
• CreateByAdl_PassThrough Auto-Deleveraging(ADL)
• CreateByBlock_PassThrough Order placed via Paradigm
• CreateByBlockTradeMovePosition_PassThrough Order created by move position
• CreateByClosing The close order placed via web or app position area - web/app
• CreateByFGridBot Order created via grid bot - web/app
• CloseByFGridBot Order closed via grid bot - web/app
• CreateByTWAP Order created by TWAP - web/app
• CreateByTVSignal Order created by TV webhook - web/app
• CreateByMmRateClose Order created by Mm rate close function - web/app
• CreateByMartingaleBot Order created by Martingale bot - web/app
• CloseByMartingaleBot Order closed by Martingale bot - web/app
• CreateByIceBerg Order created by Ice berg strategy - web/app
• CreateByArbitrage Order created by arbitrage - web/app
• CreateByDdh Option dynamic delta hedge order - web/app

execType

• Trade
• AdlTrade Auto-Deleveraging
• Funding Funding fee
• BustTrade Takeover liquidation
• Delivery USDC futures delivery; Position closed by contract delisted
• Settle Inverse futures settlement; Position closed due to delisting
• BlockTrade
• MovePosition
• UNKNOWN May be returned by a classic account. Cannot query by this type

orderType

• Market
• Limit
• UNKNOWN is not a valid request parameter value. Is only used in some responses. Mainly, it is used when execType is Funding.

stopOrderType

• TakeProfit
• StopLoss
• TrailingStop
• Stop
• PartialTakeProfit
• PartialStopLoss
• tpslOrder spot TP/SL order
• OcoOrder spot Oco order
• MmRateClose On web or app can set MMR to close position
• BidirectionalTpslOrder Spot bidirectional tpsl order

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

intervalTime

• 5min 15min 30min minute
• 1h 4h hour
• 1d day

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
• EC_CancelForNoFullFill
• EC_BySelfMatch
• EC_InCallAuctionStatus used for pre-market order operation, e.g., during 2nd phase of call auction, cancel order is not allowed, when the cancel request is failed to be rejected by trading server, the request will be rejected by matching box finally
• EC_QtyCannotBeZero
• EC_MarketOrderNoSupportTIF
• EC_ReachMaxTradeNum
• EC_InvalidPriceScale
• EC_BitIndexInvalid
• EC_StopBySelfMatch
• EC_InvalidSmpType
• EC_CancelByMMP
• EC_InvalidUserType
• EC_InvalidMirrorOid
• EC_InvalidMirrorUid
• EC_EcInvalidQty
• EC_InvalidAmount
• EC_LoadOrderCancel
• EC_MarketQuoteNoSuppSell
• EC_DisorderOrderID
• EC_InvalidBaseValue
• EC_LoadOrderCanMatch
• EC_SecurityStatusFail
• EC_ReachRiskPriceLimit
• EC_OrderNotExist
• EC_CancelByOrderValueZero
• EC_CancelByMatchValueZero
• EC_ReachMarketPriceLimit

accountType

UTA2.0

• UNIFIED Unified Trading Account
• FUND Funding Account

UTA1.0

• CONTRACT Inverse Derivatives Account (no UDST in this wallet))
• UNIFIED Unified Trading Account
• FUND Funding Account

Classic account

Also known as the "standard account".

• SPOT Spot Account
• CONTRACT Derivatives Account (contain USDT in this wallet)
• FUND Funding Account

transferStatus

• SUCCESS
• PENDING
• FAILED

depositStatus

• 0 unknown
• 1 toBeConfirmed
• 2 processing
• 3 success (finalised status of a success deposit)
• 4 deposit failed
• 10011 pending to be credited to funding pool
• 10012 Credited to funding pool successfully

withdrawStatus

• SecurityCheck
• Pending
• success
• CancelByUser
• Reject
• Fail
• BlockchainConfirmed
• MoreInformationRequired
• Unknown a rare status

triggerBy

• LastPrice
• IndexPrice
• MarkPrice

cancelType

• CancelByUser
• CancelByReduceOnly cancelled by reduceOnly
• CancelByPrepareLiq CancelAllBeforeLiq cancelled in order to attempt liquidation prevention by freeing up margin
• CancelByPrepareAdl CancelAllBeforeAdl cancelled due to ADL
• CancelByAdmin
• CancelBySettle cancelled due to delisting contract
• CancelByTpSlTsClear TP/SL order cancelled when the position is cleared
• CancelBySmp cancelled by SMP

Options:

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

optionPeriod

• 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

dataRecordingPeriod

• 5min 15min 30min minute
• 1h 4h hour
• 4d day

contractType

• InversePerpetual
• LinearPerpetual
• LinearFutures USDC Futures
• InverseFutures

status

• PreLaunch
• Trading
• Delivering
• Closed

curAuctionPhase

• NotStarted Pre-market trading is not started
• Finished Pre-market trading is finished
  • After the auction, if the pre-market contract fails to enter continues trading phase, it will be delisted and phase="Finished"
  • After the continuous trading, if the pre-market contract fails to be converted to official contract, it will be delisted and phase="Finished"
• CallAuction Auction phase of pre-market trading
  • only timeInForce=GTC, orderType=Limit order is allowed to submit
  • TP/SL are not supported; Conditional orders are not supported
  • cannot modify the order at this stage
  • order price range: [preOpenPrice x 0.5, maxPrice]
• CallAuctionNoCancel Auction no cancel phase of pre-market trading
  • only timeInForce=GTC, orderType=Limit order is allowed to submit
  • TP/SL are not supported; Conditional orders are not supported
  • cannot modify and cancel the order at this stage
  • order price range: Buy [lastPrice x 0.5, markPrice x 1.1], Sell [markPrice x 0.9, maxPrice]
• CrossMatching cross matching phase
  • cannot create, modify and cancel the order at this stage
  • Candle data is released from this stage
• ContinuousTrading Continuous trading phase
  • There is no restriction to create, amend, cancel orders
  • orderbook, public trade data is released from this stage

marginTrading

• none Regardless of normal account or UTA account, this trading pair does not support margin trading
• both For both normal account and UTA account, this trading pair supports margin trading
• utaOnly Only for UTA account,this trading pair supports margin trading
• normalSpotOnly Only for normal account, this trading pair supports margin trading

copyTrading

• none Regardless of normal account or UTA account, this trading pair does not support copy trading
• both For both normal account and UTA account, this trading pair supports copy trading
• utaOnly Only for UTA account,this trading pair supports copy trading
• normalOnly Only for normal account, this trading pair supports copy trading

type(uta-translog)

• TRANSFER_IN Assets that transferred into Unified wallet
• TRANSFER_OUT Assets that transferred out from Unified wallet
• TRADE
• SETTLEMENT USDT Perp funding settlement, and USDC Perp funding settlement + USDC 8-hour session settlement
• DELIVERY USDC Futures, Option delivery
• LIQUIDATION
• ADL Auto-Deleveraging
• AIRDROP
• BONUS Bonus claimed
• BONUS_RECOLLECT Bonus expired
• FEE_REFUND Trading fee refunded
• INTEREST Interest occurred due to borrowing
• CURRENCY_BUY Currency convert, and the liquidation for borrowing asset(UTA loan)
• CURRENCY_SELL Currency convert, and the liquidation for borrowing asset(UTA loan)
• BORROWED_AMOUNT_INS_LOAN
• PRINCIPLE_REPAYMENT_INS_LOAN
• INTEREST_REPAYMENT_INS_LOAN
• AUTO_SOLD_COLLATERAL_INS_LOAN the liquidation for borrowing asset(INS loan)
• AUTO_BUY_LIABILITY_INS_LOAN the liquidation for borrowing asset(INS loan)
• AUTO_PRINCIPLE_REPAYMENT_INS_LOAN
• AUTO_INTEREST_REPAYMENT_INS_LOAN
• TRANSFER_IN_INS_LOAN Transfer In when in the liquidation of OTC loan
• TRANSFER_OUT_INS_LOAN Transfer Out when in the liquidation of OTC loan
• SPOT_REPAYMENT_SELL One-click repayment currency sell
• SPOT_REPAYMENT_BUY One-click repayment currency buy
• TOKENS_SUBSCRIPTION Spot leverage token subscription
• TOKENS_REDEMPTION Spot leverage token redemption
• AUTO_DEDUCTION Asset auto deducted by system (roll back)
• FLEXIBLE_STAKING_SUBSCRIPTION Byfi flexible stake subscription
• FLEXIBLE_STAKING_REDEMPTION Byfi flexible stake redemption
• FIXED_STAKING_SUBSCRIPTION Byfi fixed stake subscription
• PREMARKET_TRANSFER_OUT
• PREMARKET_DELIVERY_SELL_NEW_COIN
• PREMARKET_DELIVERY_BUY_NEW_COIN
• PREMARKET_DELIVERY_PLEDGE_PAY_SELLER
• PREMARKET_DELIVERY_PLEDGE_BACK
• PREMARKET_ROLLBACK_PLEDGE_BACK
• PREMARKET_ROLLBACK_PLEDGE_PENALTY_TO_BUYER
• CUSTODY_NETWORK_FEE fireblocks business
• CUSTODY_SETTLE_FEE fireblocks business
• CUSTODY_LOCK fireblocks / copper business
• CUSTODY_UNLOCK fireblocks business
• CUSTODY_UNLOCK_REFUND fireblocks business
• LOANS_BORROW_FUNDS crypto loan
• LOANS_PLEDGE_ASSET crypto loan repayment
• BONUS_TRANSFER_IN
• BONUS_TRANSFER_OUT

type(contract-translog)

• TRANSFER_IN Assets that transferred into (inverse) derivatives wallet
• TRANSFER_OUT Assets that transferred out from (inverse) derivatives wallet
• TRADE
• SETTLEMENT USDT / Inverse Perp funding settlement
• DELIVERY Inverse Futures delivery
• LIQUIDATION
• ADL Auto-Deleveraging
• AIRDROP
• BONUS Bonus claimed
• BONUS_RECOLLECT Bonus expired
• FEE_REFUND Trading fee refunded
• CURRENCY_BUY Currency convert
• CURRENCY_SELL Currency convert
• AUTO_DEDUCTION Asset auto deducted by system (roll back)
• Others

unifiedMarginStatus

• 1 Classic account
• 3 Unified trading account 1.0
• 4 Unified trading account 1.0 (pro version)
• 5 Unified trading account 2.0
• 6 Unified trading account 2.0 (pro version)

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

convertAccountType

Check the value of unifiedMarginStatus

UTA2.0

• eb_convert_uta Unified Trading Account
• eb_convert_funding Funding Account

UTA1.0

• eb_convert_inverse Inverse Derivatives Account (no USDT in this wallet))
• eb_convert_uta Unified Trading Account
• eb_convert_funding Funding Account

Classic account

Also known as the "standard account"

• eb_convert_spot Spot Account
• eb_convert_contract Derivatives Account (contain USDT in this wallet)
• eb_convert_funding Funding Account

symbol

USDT Perpetual:

• BTCUSDT
• ETHUSDT

USDC Perpetual:

• BTCPERP
• ETHPERP

USDC Futures:

• BTC-24MAR23

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

Spot:

• BTCUSDT
• ETHUSDC

vipLevel

• No VIP
• VIP-1
• VIP-2
• VIP-3
• VIP-4
• VIP-5
• VIP-Supreme
• PRO-1
• PRO-2
• PRO-3
• PRO-4
• PRO-5

adlRankIndicator

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

smpType

• default: None
• CancelMaker
• CancelTaker
• CancelBoth

Spot Fee Currency Instruction

with the example of BTCUSDT:

• Is makerFeeRate positive?
  • TRUE
    • Side = Buy -> base currency (BTC)
    • Side = Sell -> quote currency (USDT)
  • FALSE
    • IsMakerOrder = TRUE
      • Side = Buy -> quote currency (USDT)
      • Side = Sell -> base currency (BTC)
    • IsMakerOrder = FALSE
      • Side = Buy -> base currency (BTC)
      • Side = Sell -> quote currency (USDT)