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

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​

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

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
  • RPI features:
    • Exclusive Matching: Only match non-algorithmic users; no execution against orders from Open API.
    • Post-Only Mechanism: Act as maker orders, adding liquidity
    • Lower Priority: Execute after non-RPI orders at the same price level.
    • Limited Access: Initially for select market makers across multiple pairs.
    • Order Book Updates: Excluded from API but displayed on the GUI.

createType​

  • CreateByUser
  • CreateByFutureSpread Spread order
  • CreateByAdminClosing
  • CreateBySettle USDC Futures delivery; position closed as a result of the delisting of a contract. This is recorded as a trade but not an order.
  • 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
  • CreateByTrailingProfit Futures trailing take profit 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
  • CreateByChaseOrder Chase limit order
  • CreateByFGridBot Order created via grid bot
  • CloseByFGridBot Order closed via grid bot
  • CreateByTWAP Order created by TWAP
  • CreateByMartingaleBot Order created by Martingale bot
  • CloseByMartingaleBot Order closed by Martingale bot
  • CreateByIceBerg Order created by Ice berg strategy
  • CreateByBboOrder BBO order
  • CreateByClosing The close order placed via web or app position area - web/app
  • CreateByTVSignal Order created by TV webhook - web/app
  • CreateByMmRateClose Order created by Mm rate close function - 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 USDT futures delivery; Position closed due to delisting
  • Settle Inverse futures settlement
  • BlockTrade
  • MovePosition
  • FutureSpread Spread leg execution
  • ForwardSplitSettle Forward stock split fractional share settlement
  • ReverseSplitSettle Reverse stock split fractional share settlement
  • Dividend Dividend distribution
  • 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 a maker could not be found to fill your order
  • EC_PerCancelRequest
  • EC_MarketOrderCannotBePostOnly
  • EC_PostOnlyWillTakeLiquidity your post only order would have executed as a taker, and so was rejected
  • 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 order cancelled as its remaining value is zero
  • EC_CancelByMatchValueZero order cancelled as the order it matched with has a remaining value of zero
  • EC_ReachMarketPriceLimit

accountType​

  • UNIFIED Unified Trading Account
  • FUND Funding Account

assetCategory​

  • Easy Earn Earn account sub-category
  • Futures Grid Bot Trading Bot account sub-category
  • Futures Combo Bot Trading Bot account sub-category
  • Futures Martingale Bot Trading Bot account sub-category
  • Copy Trading Classic Copy Trading account sub-category
  • Copy Trading TradFi Copy Trading account sub-category
  • Copy Trading Pro Copy Trading account sub-category
  • trade Alpha account sub-category — spot alpha token holdings
  • farm Alpha account sub-category — spot alpha farming positions
  • Predication Predication account sub-category

assetAccountType​

  • FundingAccount Funding Account
  • UnifiedTradingAccount Unified Trading Account
  • Earn Earn Account
  • TradingBot Trading Bot Account
  • CopyTrading Copy Trading Account
  • CryptoLoans Crypto Loans Account
  • CryptoLoans_legacy Crypto Loans Account (Legacy)
  • PayLater Bybit Pay Later Account
  • Launchpool Launchpool Account
  • TradFi TradFi Account
  • MarginStakedSOL Margin Staked SOL Account
  • Alpha Alpha Account

transferStatus​

  • SUCCESS
  • PENDING
  • FAILED

depositStatus​

  • 0 unknown
  • 1 toBeConfirmed
  • 2 processing
  • 3 success (this is final status reflected by the finalized deposit status. If a blockchain rollback occurs, the deposit will be assigned a 7XXXX status, which represents the finalized outcome of that rollback case.)
  • 4 deposit failed
  • 7 Rollback processing: A blockchain rollback occurred after the deposit had already been credited.
  • 70011 Deposit rolled back: A blockchain rollback occurred, and the deposit has been reversed. The credited funds have been deducted, and no final credit remains.
  • 70012 Deposit remains successful after rollback review: Although a blockchain rollback occurred, the deposit remains valid. After review, it was determined that no clawback or deduction is required.
  • 70013 Deposit rollback faill: The deposit was initially credited, but the backend system failed to process the blockchain rollback automatically. The case is pending manual review.
  • 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

extra status for Bybit Turkey​

  • HighValueReviewPending
  • HighValueReviewEDDSubmission
  • HighValueReviewRejected
  • HighValueReviewRejectedRfunding
  • HighValueReviewRejectedRefunded

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
  • CancelByDCP cancelled by DCP triggering
  • CancelByRebalance Spread trading: the order price of a single leg order is outside the limit price range.
  • CancelByOCOTpCanceledBySlTriggered The take profit order was canceled due to the triggering of the stop loss
  • CancelByOCOSlCanceledByTpTriggered The stop loss order was canceled due to the triggering of the take profit

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 USDT/USDC Futures
  • InverseFutures

status​

  • PreLaunch linear: pre-market contract
  • PendingOpen Futures only: a contract that is not yet open for trading
  • Trading
  • Delivering
  • Closed

symbolType​

  • innovation linear
  • adventure spot
  • xstocks spot
  • commodity linear
  • stock linear
  • forex linear Foreign exchange
  • ETF linear ETF
  • mstocks spot

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, Event Contract settlement
  • LIQUIDATION
  • ADL Auto-Deleveraging
  • AIRDROP
  • BONUS Bonus claimed
  • BONUS_RECOLLECT Bonus expired
  • BONUS_TRANSFER_IN
  • BONUS_TRANSFER_OUT
  • 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)
  • SPOT_REPAYMENT_SELL One-click repayment currency sell
  • SPOT_REPAYMENT_BUY One-click repayment currency buy
  • DIVIDEND_SETTLEMENT Stock perps dividend
  • FORWARD_SPLIT_SETTLE Forward stock split fractional share settlement
  • REVERSE_SPLIT_SETTLE Reverse stock split fractional share settlement
  • BORROW Manual loan borrow and auto loan borrow
  • REPAY Manual loan repay and auto loan repay
  • CONVERT Currency convert repayment
  • EARNING_REDEMPTION_SELL force sell when liquidation
  • EARNING_REDEMPTION_BUY force buy when liquidation
  • FLOATING_TO_FIXED_BORROW
  • FLOATING_TO_FIXED_REPAY
  • 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
  • FIXED_SAVING_PRINCIPAL_REDEMPTION Bycustody fixed saving redemption
  • FLEXIBLE_STAKING_SUBSCRIPTION Byfi flexible stake subscription
  • FLEXIBLE_STAKING_REDEMPTION Byfi flexible stake redemption
  • FIXED_STAKING_SUBSCRIPTION Byfi fixed stake subscription
  • FLEXIBLE_STAKING_REFUND Byfi flexiable stake refund
  • FIXED_STAKING_REFUND Byfi fixed stake refund
  • PEF_TRANSFER_IN
  • PEF_TRANSFER_OUT
  • PEF_PROFIT_SHARE
  • ONCHAINEARN_SUBSCRIPTION tranfer out for on chain earn
  • ONCHAINEARN_REDEMPTION tranfer in for on chain earn
  • ONCHAINEARN_REFUND tranfer in for on chain earn failed
  • STRUCTURE_PRODUCT_SUBSCRIPTION tranfer out for structure product
  • STRUCTURE_PRODUCT_REFUND tranfer in for structure product
  • CLASSIC_WEALTH_MANAGEMENT_SUBSCRIPTION tranfer out for classic wealth management
  • PREMIMUM_WEALTH_MANAGEMENT_SUBSCRIPTION tranfer in for classic wealth management
  • PREMIMUM_WEALTH_MANAGEMENT_REFUND tranfer in for classic wealth management refund
  • LIQUIDITY_MINING_SUBSCRIPTION tranfer out for liquidity mining
  • LIQUIDITY_MINING_REFUND tranfer in for liquidity mining
  • PWM_SUBSCRIPTION tranfer out for PWM
  • PWM_REFUND tranfer in for PWM
  • BYUSDT_MINT BYUSDT mint
  • BYUSDT_REDEMPTION BYUSDT redemption
  • BYUSDT_INTEREST BYUSDT interest
  • PRINCIPAL_REPAYMENT_INS_LOAN Repay the principal of the institution loan
  • INSTITUTION_LOAN_TRANSFER_OUT Repay with currency convert (liquidation)
  • INSTITUTION_LOAN_WITHOUT_WITHDRAW Repay without currency convert (liquidation)

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)

convertAccountType​

  • eb_convert_uta Unified Trading Account
  • eb_convert_funding Funding Account

symbol​

USDT Perpetual:

  • BTCUSDT
  • ETHUSDT

USDT Futures:

  • BTCUSDT-21FEB25
  • ETHUSDT-14FEB25
    The types of USDT Futures contracts offered by Bybit include: Weekly, Bi-Weekly, Tri-Weekly, Monthly, Bi-Monthly, Quarterly, Bi-Quarterly, Tri-Quarterly

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

Option:

  • BTC-13FEB25-89000-P-USDT USDT Option
  • ETH-28FEB25-2800-C USDC Option

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
  • PRO-6

adlRankIndicator​

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

smpType​

  • default: None
  • CancelMaker
  • CancelTaker
  • CancelBoth

extraFees.feeType​

  • UNKNOWN
  • TAX Government tax. Only for Indonesian site
  • CFX Indonesian foreign exchange tax. Only for Indonesian site
  • WHT EU withholding tax. Only for EU site
  • GST Indian GST tax. Only for kyc=Indian users
  • VAT ARE VAT tax. Only for kyc=ARE users

extraFees.subFeeType​

  • UNKNOWN
  • TAX_PNN Tax fee, fiat currency to digital currency. Only for Indonesian site
  • TAX_PPH Tax fee, digital currency to fiat currency. Only for Indonesian site
  • CFX_FIEE CFX fee, fiat currency to digital currency. Only for Indonesian site
  • AUT_WITHHOLDING_TAX EU site withholding tax. Only for EU site
  • IND_GST Indian GST tax. Only for kyc=Indian users
  • ARE_VAT ARE VAT tax. Only for kyc=ARE users

predictionSide (Prediction Market — Trade Direction)​

  • 1 YES / BUY — buy outcome token shares
  • 2 NO / SELL — sell outcome token shares

predictionOrderType (Prediction Market — Order Type)​

  • 1 FOK (Fill-or-Kill) — must be fully filled or entirely cancelled. Phase 1 only

predictionOrderStatus (Prediction Market — Order Status)​

  • 1 PENDING
  • 2 FILLED
  • 3 PARTIALLY_FILLED
  • 4 CANCELLED
  • 5 REJECTED

predictionPositionResult (Prediction Market — Position Result)​

  • 1 WIN — event resolved in favour of this token
  • 2 LOSE — event resolved against this token
  • 3 MANUAL_CLOSE — position closed by user before resolution

predictionMatchStatus (Prediction Market — Match Status)​

  • 1 Live — match is in progress
  • 2 Upcoming — match has not yet started
  • 3 Ended — match has concluded

predictionMarketType (Prediction Market — Market Type)​

  • 1 YES/NO binary market — two outcome tokens (YES and NO)
  • 2 Multi-outcome market — more than two outcome tokens

predictionSortBy (Prediction Market — Sort Field)​

  • volume Sort by 24-hour trading volume descending
  • liquidity Sort by available liquidity descending
  • endDate Sort by resolution date ascending

predictionPriceInterval (Prediction Market — Price Interval)​

  • 1H 1 hour
  • 6H 6 hours
  • 1D 1 day
  • 1W 1 week
  • 1M 1 month
  • ALL Full history

predictionStageCode (Prediction Market — Stage Code)​

  • Groups Group stage
  • R32 Round of 32
  • R16 Round of 16
  • QF Quarter-Finals
  • SF Semi-Finals
  • Final Final

predictionEventType (Prediction Market — Event Type)​

  • 1 FIFA_2026 — 2026 FIFA World Cup

predictionTimelineStatus (Prediction Market — Timeline Status)​

  • 1 Done — stage has completed
  • 2 Active — stage is currently in progress
  • 3 Upcoming — stage has not yet started

state​

  • scheduled
  • ongoing
  • completed
  • canceled

serviceTypes​

  • 1 Trading service
  • 2 Trading service via http request
  • 3 Trading service via websocket
  • 4 Private websocket stream
  • 5 Market data service

product​

  • 1 Futures
  • 2 Spot
  • 3 Option
  • 4 Spread

maintainType​

  • 1 Planned maintenance
  • 2 Temporary maintenance
  • 3 Incident

env​

  • 1 Production
  • 2 Production Demo service

bizType​

  • SPOT
  • DERIVATIVES
  • OPTIONS

msg​

  • API limit updated successfully
  • Requested limit exceeds maximum allowed per user
  • No permission to operate these UIDs
  • API cap configuration not found
  • API cap configuration not found for bizType
  • Requested limit would exceed institutional quota

groupId​

  • 1 Major Coins
  • 5 Altcoin
  • 6 Innovation Zone
  • 7 Pre-Listing
  • 9 TradeFi Perps

groupName​

  • G1(Major Coins) Major Coins
  • Altcoin  Altcoin
  • G9(Stock & Commodity Tradfi Perp) TradeFi Perps
  • Innovation-Zone Innovation Zone
  • Pre-listing Pre-listing

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)

sbe-orderStatus​

  • 5 Rejected
  • 6 New
  • 7 Cancelled
  • 8 PartiallyFilled
  • 9 Filled
  • 0 Others

sbe-rejectReason​

  • 0 EC_NoError
  • 1 EC_Others
  • 2 EC_UnknownMessageType
  • 3 EC_MissingClOrdID
  • 4 EC_OrderNotExist
  • 5 EC_MissingOrigClOrdID
  • 6 EC_ClOrdIDOrigClOrdIDAreTheSame
  • 7 EC_OrigClOrdIDDoesNotExist
  • 8 EC_TooLateToCancel
  • 9 EC_UnknownOrderType
  • 10 EC_UnknownSide
  • 11 EC_UnknownTimeInForce
  • 12 EC_WronglyRouted
  • 13 EC_MarketOrderPriceIsNotZero
  • 14 EC_LimitOrderInvalidPrice
  • 15 EC_NoEnoughQtyToFill
  • 16 EC_NoImmediateQtyToFill
  • 17 EC_QtyCannotBeZero
  • 18 EC_PerCancelRequest
  • 19 EC_MarketOrderCannotBePostOnly
  • 20 EC_PostOnlyWillTakeLiquidity
  • 21 EC_CancelReplaceOrder
  • 22 EC_InvalidSymbolStatus
  • 23 EC_MarketOrderNoSupportTIF
  • 24 EC_ReachMaxTradeNum
  • 25 EC_InvalidPriceScale
  • 28 EC_BySelfMatch
  • 29 EC_InvalidSmpType
  • 30 EC_CancelByMMP
  • 31 EC_InCallAuctionStatus
  • 34 EC_InvalidUserType
  • 35 EC_InvalidMirrorOid
  • 36 EC_InvalidMirrorUid
  • 100 EC_EcInvalidQty
  • 101 EC_InvalidAmount
  • 102 EC_LoadOrderCancel
  • 103 EC_CancelForNoFullFill
  • 104 EC_MarketQuoteNoSuppSell
  • 105 EC_DisorderOrderID
  • 106 EC_InvalidBaseValue
  • 107 EC_LoadOrderCanMatch
  • 108 EC_SecurityStatusFail
  • 110 EC_ReachRiskPriceLimit
  • 111 EC_CancelByOrderValueZero
  • 112 EC_CancelByMatchValueZero
  • 113 EC_CancelByMatchValueZero
  • 200 EC_ReachMarketPriceLimit

Advanced-Earn-category​

  • DualAssets

Advanced-Earn-Product-Status​

  • Available
  • NotAvailable

Advanced-Earn-Position-Status​

  • Active
  • Redeeming

Advanced-Earn-Order-Status​

  • Pending
  • Success
  • Settled
  • Fail

stocks​

stocks-side​

  • BUY Buy
  • SELL Sell

stocks-type​

  • MARKET Market order. Uses notional (USDC amount) when BUY; uses qty (shares) when SELL
  • LIMIT Limit order. Requires qty and limitPrice
  • STOP Stop order. Requires qty and stopPrice. Executes as market after the trigger
  • STOP_LIMIT Stop-limit order. Requires qty, stopPrice and limitPrice. Places a limit order after the trigger

stocks-timeInForce​

  • DAY Day order. Auto-cancelled at the main US market close
  • GTC Good Till Cancelled
  • IOC Immediate or Cancel. Any unfilled portion is cancelled immediately

Note: SELL only supports DAY and GTC. IOC is supported but constrained to LIMIT + whole-share + RTH.

stocks-tradingSession​

  • RTH Regular Trading Hours (default)
  • 24H 24-hour session, including pre-market, post-market and overnight. Non-RTH sessions accept LIMIT orders only

stocks-orderStatus​

  • PENDING Order accepted and queued for execution. Returned as the initial status by Place Order
  • queued Queued — order submitted, waiting for market open to execute
  • active Active — order is live and waiting for fill conditions
  • filled Filled — order fully filled
  • partial_filled Cancelled after partial fill — order was cancelled/failed with some prior fills
  • cancelled Cancelled — order was cancelled/failed with no fills

stocks-convertType​

  • MINT Underlying → mStocks Token
  • REDEEM mStocks Token → Underlying

stocks-convertStatus​

  • PENDING Processing
  • SUCCESS Completed
  • FAILED Failed

stocks-accountType​

  • all Auto-select account (default)
  • uta Route into the Unified Trading Account (UTA)
  • fund Route into the Funding Account

stocks-flow​

  • CEX Centralized exchange flow. Both Mint and Burn are processed through the Bybit main site
  • DEX Decentralized flow. Mint to the specified contract address; Burn flow depends on burnScene

stocks-burnScene​

  • DEP Burn through the Bybit main site (Deposit)
  • NDP Burn without going through the main site (Non-Deposit)

stocks-symbolType​

  • US_STOCK US stock. Currently the only supported instrument type

stocks-statusCode​

  • 1 Pre-market (04:00–09:30 ET, XNYS/XNAS only)
  • 2 Regular hours (09:30–16:00 ET, XNYS/XNAS)
  • 3 Post-market (16:00–20:00 ET, XNYS/XNAS only)
  • 4 Overnight session (20:00 ET–next day 04:00 ET, OCEA)
  • 5 Closed (weekends, holidays, off-hours)

stocks-tradingHolidayType​

  • HOLIDAY Statutory holiday. Market closed all day
  • EARLY_CLOSE Early close. endTime is the actual close time of that day

tm-onchain-appealType​

  • TM_Onchain On-chain transaction monitoring appeal
  • TM_Onchain_KYB On-chain transaction monitoring KYB appeal

tm-onchain-resultStatus​

  • PENDING Materials pending submission (non-terminal)
  • COMMITTED Submitted, under review (non-terminal)
  • REJECTED Materials rejected, need to resubmit (non-terminal)
  • PASS Approved (terminal)
  • REFUSE Rejected (terminal)
  • DISUSED Appeal disused (terminal)

tm-onchain-triggerType​

  • Auto-approve
  • Auto-create-Initial
  • Manual

tm-onchain-direction​

  • deposit
  • withdraw

tm-onchain-fundStatus​

  • Empty string No fund action
  • Deposit Intercepted
  • Refund
  • Guilty
  • Recharge

tm-onchain-styleBox​

  • UPLOAD Upload image (jpg/png) or PDF. Submit via itemsData[].resources[]
  • MIXUPLOAD Upload media (image / audio / video / PDF). Submit via itemsData[].resources[]
  • INPUT Multi-line text. Submit via itemsData[].content
  • SINGLEINPUT Single-line text. Submit via itemsData[].content
  • SELECT Single-select dropdown. Submit via itemsData[].content (option value)
  • RADIO Radio button group. Submit via itemsData[].content (option value)
  • CHECKBOX Multi-select. Submit via itemsData[].mulContent[] (list of option values)
  • COUNTRYNAME Country dropdown. Submit via itemsData[].content (English full name, e.g. Australia)
  • DATEPICKER Date picker. Submit via itemsData[].content (date string)
  • COMMENT Display-only, no submission

tm-onchain-banDescription​

Values that may appear in accountRestriction.ban / unban, mapped from the backend ban_tag_value:

ban_tag_valuedescription
loginAccount Ban
all_withdrawWithdraw Ban
non-principalWithdraw Ban (Allow to Withdraw Deposited)
all_tradeTrading Ban (All)
lighten_upTrading Ban (Allow to Close Position)
transfer_service_userTransfer Ban (User)
bybitcard_serviceBybit Card Ban (All)
fiat_serviceFiat Ban (All)
card_service_buyFiat Bank Card Ban (Buy)
fiat_exchangeFiat Deposit and Withdrawal Ban
fiat_exchange_rechargeFiat Deposit Ban
fiat_exchange_extractFiat Withdrawal Ban
p2p_serviceP2P Ban (All)

tm-onchain-fileType​

  • fiat-image Image (jpg / png)
  • fiat-pdf PDF
  • fiat-video Video (mp4, etc.)