Enums Definitions
locale
de-DEen-USes-ARes-ESes-MXfr-FRkk-KZid-IDuk-UAja-JPru-RUth-THpt-BRtr-TRvi-VNzh-TWar-SAhi-INfil-PH
announcementType
new_cryptolatest_bybit_newsdelistingslatest_activitiesproduct_updatesmaintenance_updatesnew_fiat_listingsother
announcementTag
SpotDerivativesSpot ListingsBTCETHTrading BotsUSDCLeveraged TokensUSDTMargin TradingPartnershipsLaunchpadUpgradesByVotesDelistingsVIPFuturesInstitutionsOptionsWEB3Copy TradingEarnBybit SavingsDual AssetLiquidity MiningShark FinLaunchpoolNFT GrabPicBuy CryptoP2P TradingFiat DepositCrypto DepositСпотСпот лістингиТоргові ботиТокени з кредитним плечемМаржинальна торгівляПартнерствоОновленняДелістингиФ'ючерсиОпціониКопітрейдингBybit НакопиченняБівалютні інвестиціїМайнінг ліквідностіКупівля криптовалютиP2P торгівляФіатні депозитиКриптодепозитиКопитрейдингТорговые ботыДеривативыP2PСпот листингиДеривативиMT4Lucky DrawUnified Trading AccountЄдиний торговий акаунтЕдиный торговый аккаунтИнституциональный трейдингІнституціональний трейдингДелистинг
category
Unified Account
spotlinearUSDT perpetual, USDT Futures and USDC contract, including USDC perp, USDC futuresinverseInverse contract, including Inverse perp, Inverse futuresoption
Classic Account
linearUSDT perpinverseInverse contract, including Inverse perp, Inverse futuresspot
orderStatus
open status
Neworder has been placed successfullyPartiallyFilledUntriggeredConditional orders are created
closed status
RejectedPartiallyFilledCanceledOnly spot has this order statusFilledCancelledIn derivatives, orders with this status may have an executed qtyTriggeredinstantaneous state for conditional orders from Untriggered to NewDeactivatedUTA: Spot tp/sl order, conditional order, OCO order are cancelled before they are triggered
timeInForce
GTCGoodTillCancelIOCImmediateOrCancelFOKFillOrKill- 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
CreateByUserCreateByFutureSpreadSpread orderCreateByAdminClosingCreateBySettleUSDC Futures delivery; position closed as a result of the delisting of a contract. This is recorded as a trade but not an order.CreateByStopOrderFutures conditional orderCreateByTakeProfitFutures take profit orderCreateByPartialTakeProfitFutures partial take profit orderCreateByStopLossFutures stop loss orderCreateByPartialStopLossFutures partial stop loss orderCreateByTrailingStopFutures trailing stop orderCreateByTrailingProfitFutures trailing take profit orderCreateByLiqLaddered liquidation to reduce the required maintenance marginCreateByTakeOver_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_PassThroughAuto-Deleveraging(ADL)CreateByBlock_PassThroughOrder placed via ParadigmCreateByBlockTradeMovePosition_PassThroughOrder created by move positionCreateByClosingThe close order placed via web or app position area - web/appCreateByFGridBotOrder created via grid bot - web/appCloseByFGridBotOrder closed via grid bot - web/appCreateByTWAPOrder created by TWAP - web/appCreateByTVSignalOrder created by TV webhook - web/appCreateByMmRateCloseOrder created by Mm rate close function - web/appCreateByMartingaleBotOrder created by Martingale bot - web/appCloseByMartingaleBotOrder closed by Martingale bot - web/appCreateByIceBergOrder created by Ice berg strategy - web/appCreateByArbitrageOrder created by arbitrage - web/appCreateByDdhOption dynamic delta hedge order - web/appCreateByBboOrderBBO order
execType
TradeAdlTradeAuto-DeleveragingFundingFunding feeBustTradeTakeover liquidationDeliveryUSDC futures delivery; Position closed by contract delistedSettleInverse futures settlement; Position closed due to delistingBlockTradeMovePositionFutureSpreadSpread leg executionUNKNOWNMay be returned by a classic account. Cannot query by this type
orderType
MarketLimitUNKNOWNis not a valid request parameter value. Is only used in some responses. Mainly, it is used whenexecTypeisFunding.
stopOrderType
TakeProfitStopLossTrailingStopStopPartialTakeProfitPartialStopLosstpslOrderspot TP/SL orderOcoOrderspot Oco orderMmRateCloseOn web or app can set MMR to close positionBidirectionalTpslOrderSpot bidirectional tpsl order
tickDirection
PlusTickprice riseZeroPlusTicktrade occurs at the same price as the previous trade, which occurred at a price higher than that for the trade preceding itMinusTickprice dropZeroMinusTicktrade occurs at the same price as the previous trade, which occurred at a price lower than that for the trade preceding it
interval
135153060120240360720minuteDdayWweekMmonth
intervalTime
5min15min30minminute1h4hhour1dday
positionIdx
0one-way mode position1Buy side of hedge-mode position2Sell side of hedge-mode position
positionStatus
NormalLiqin the liquidation progressAdlin the auto-deleverage progress
rejectReason
EC_NoErrorEC_OthersEC_UnknownMessageTypeEC_MissingClOrdIDEC_MissingOrigClOrdIDEC_ClOrdIDOrigClOrdIDAreTheSameEC_DuplicatedClOrdIDEC_OrigClOrdIDDoesNotExistEC_TooLateToCancelEC_UnknownOrderTypeEC_UnknownSideEC_UnknownTimeInForceEC_WronglyRoutedEC_MarketOrderPriceIsNotZeroEC_LimitOrderInvalidPriceEC_NoEnoughQtyToFillEC_NoImmediateQtyToFillEC_PerCancelRequestEC_MarketOrderCannotBePostOnlyEC_PostOnlyWillTakeLiquidityEC_CancelReplaceOrderEC_InvalidSymbolStatusEC_CancelForNoFullFillEC_BySelfMatchEC_InCallAuctionStatusused 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 finallyEC_QtyCannotBeZeroEC_MarketOrderNoSupportTIFEC_ReachMaxTradeNumEC_InvalidPriceScaleEC_BitIndexInvalidEC_StopBySelfMatchEC_InvalidSmpTypeEC_CancelByMMPEC_InvalidUserTypeEC_InvalidMirrorOidEC_InvalidMirrorUidEC_EcInvalidQtyEC_InvalidAmountEC_LoadOrderCancelEC_MarketQuoteNoSuppSellEC_DisorderOrderIDEC_InvalidBaseValueEC_LoadOrderCanMatchEC_SecurityStatusFailEC_ReachRiskPriceLimitEC_OrderNotExistEC_CancelByOrderValueZeroEC_CancelByMatchValueZeroEC_ReachMarketPriceLimit
accountType
UTA2.0
UNIFIEDUnified Trading AccountFUNDFunding Account
UTA1.0
CONTRACTInverse Derivatives Account (no UDST in this wallet))UNIFIEDUnified Trading AccountFUNDFunding Account
Classic account
Also known as the "standard account".
SPOTSpot AccountCONTRACTDerivatives Account (contain USDT in this wallet)FUNDFunding Account
transferStatus
SUCCESSPENDINGFAILED
depositStatus
0unknown1toBeConfirmed2processing3success (finalised status of a success deposit)4deposit failed10011pending to be credited to funding pool10012Credited to funding pool successfully
withdrawStatus
SecurityCheckPendingsuccessCancelByUserRejectFailBlockchainConfirmedMoreInformationRequiredUnknowna rare status
triggerBy
LastPriceIndexPriceMarkPrice
cancelType
CancelByUserCancelByReduceOnlycancelled by reduceOnlyCancelByPrepareLiqCancelAllBeforeLiqcancelled in order to attempt liquidation prevention by freeing up marginCancelByPrepareAdlCancelAllBeforeAdlcancelled due to ADLCancelByAdminCancelBySettlecancelled due to delisting contractCancelByTpSlTsClearTP/SL order cancelled when the position is clearedCancelBySmpcancelled by SMPCancelByDCPcancelled by DCP triggeringCancelByRebalanceSpread trading: the order price of a single leg order is outside the limit price range.CancelByOCOTpCanceledBySlTriggeredThe take profit order was canceled due to the triggering of the stop lossCancelByOCOSlCanceledByTpTriggeredThe stop loss order was canceled due to the triggering of the take profit
Options:
CancelByUserCancelByReduceOnlyCancelAllBeforeLiqcancelled due to liquidationCancelAllBeforeAdlcancelled due to ADLCancelBySettleCancelByCannotAffordOrderCostCancelByPmTrialMmOverEquityCancelByAccountBlockingCancelByDeliveryCancelByMmpTriggeredCancelByCrossSelfMuchCancelByCrossReachMaxTradeNumCancelByDCPCancelBySmp
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
5min15min30minminute1h4hhour4dday
contractType
InversePerpetualLinearPerpetualLinearFuturesUSDT/USDC FuturesInverseFutures
status
PreLaunchTradingDeliveringClosed
symbolType
innovationadventurexstocks
curAuctionPhase
NotStartedPre-market trading is not startedFinishedPre-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"
 
CallAuctionAuction 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]
 
CallAuctionNoCancelAuction no cancel phase of pre-market tradingCrossMatchingcross matching phase- cannot create, modify and cancel the order at this stage
 - Candle data is released from this stage
 
ContinuousTradingContinuous trading phase- There is no restriction to create, amend, cancel orders
 - orderbook, public trade data is released from this stage
 
marginTrading
noneRegardless of normal account or UTA account, this trading pair does not support margin tradingbothFor both normal account and UTA account, this trading pair supports margin tradingutaOnlyOnly for UTA account,this trading pair supports margin tradingnormalSpotOnlyOnly for normal account, this trading pair supports margin trading
copyTrading
noneRegardless of normal account or UTA account, this trading pair does not support copy tradingbothFor both normal account and UTA account, this trading pair supports copy tradingutaOnlyOnly for UTA account,this trading pair supports copy tradingnormalOnlyOnly for normal account, this trading pair supports copy trading
type(uta-translog)
TRANSFER_INAssets that transferred into Unified walletTRANSFER_OUTAssets that transferred out from Unified walletTRADESETTLEMENTUSDT Perp funding settlement, and USDC Perp funding settlement + USDC 8-hour session settlementDELIVERYUSDC Futures, Option deliveryLIQUIDATIONADLAuto-DeleveragingAIRDROPBONUSBonus claimedBONUS_RECOLLECTBonus expiredFEE_REFUNDTrading fee refundedINTERESTInterest occurred due to borrowingCURRENCY_BUYCurrency convert, and the liquidation for borrowing asset(UTA loan)CURRENCY_SELLCurrency convert, and the liquidation for borrowing asset(UTA loan)BORROWED_AMOUNT_INS_LOANPRINCIPLE_REPAYMENT_INS_LOANINTEREST_REPAYMENT_INS_LOANAUTO_SOLD_COLLATERAL_INS_LOANthe liquidation for borrowing asset(INS loan)AUTO_BUY_LIABILITY_INS_LOANthe liquidation for borrowing asset(INS loan)AUTO_PRINCIPLE_REPAYMENT_INS_LOANAUTO_INTEREST_REPAYMENT_INS_LOANTRANSFER_IN_INS_LOANTransfer In when in the liquidation of OTC loanTRANSFER_OUT_INS_LOANTransfer Out when in the liquidation of OTC loanSPOT_REPAYMENT_SELLOne-click repayment currency sellSPOT_REPAYMENT_BUYOne-click repayment currency buyTOKENS_SUBSCRIPTIONSpot leverage token subscriptionTOKENS_REDEMPTIONSpot leverage token redemptionAUTO_DEDUCTIONAsset auto deducted by system (roll back)FLEXIBLE_STAKING_SUBSCRIPTIONByfi flexible stake subscriptionFLEXIBLE_STAKING_REDEMPTIONByfi flexible stake redemptionFIXED_STAKING_SUBSCRIPTIONByfi fixed stake subscriptionFLEXIBLE_STAKING_REFUNDByfi flexiable stake refundFIXED_STAKING_REFUNDByfi fixed stake refundPREMARKET_TRANSFER_OUTPREMARKET_DELIVERY_SELL_NEW_COINPREMARKET_DELIVERY_BUY_NEW_COINPREMARKET_DELIVERY_PLEDGE_PAY_SELLERPREMARKET_DELIVERY_PLEDGE_BACKPREMARKET_ROLLBACK_PLEDGE_BACKPREMARKET_ROLLBACK_PLEDGE_PENALTY_TO_BUYERCUSTODY_NETWORK_FEEfireblocks businessCUSTODY_SETTLE_FEEfireblocks businessCUSTODY_LOCKfireblocks / copper businessCUSTODY_UNLOCKfireblocks businessCUSTODY_UNLOCK_REFUNDfireblocks businessLOANS_BORROW_FUNDScrypto loanLOANS_PLEDGE_ASSETcrypto loan repaymentBONUS_TRANSFER_INBONUS_TRANSFER_OUTPEF_TRANSFER_INPEF_TRANSFER_OUTPEF_PROFIT_SHAREONCHAINEARN_SUBSCRIPTIONtranfer out for on chain earnONCHAINEARN_REDEMPTIONtranfer in for on chain earnONCHAINEARN_REFUNDtranfer in for on chain earn failedSTRUCTURE_PRODUCT_SUBSCRIPTIONtranfer out for structure productSTRUCTURE_PRODUCT_REFUNDtranfer in for structure productCLASSIC_WEALTH_MANAGEMENT_SUBSCRIPTIONtranfer out for classic wealth managementPREMIMUM_WEALTH_MANAGEMENT_SUBSCRIPTIONtranfer in for classic wealth managementPREMIMUM_WEALTH_MANAGEMENT_REFUNDtranfer in for classic wealth management refundLIQUIDITY_MINING_SUBSCRIPTIONtranfer out for liquidity miningLIQUIDITY_MINING_REFUNDtranfer in for liquidity miningPWM_SUBSCRIPTIONtranfer out for PWMPWM_REFUNDtranfer in for PWMDEFI_INVESTMENT_SUBSCRIPTIONtranfer out for DEFI subscriptionDEFI_INVESTMENT_REFUNDtransfer in for DEFI refundDEFI_INVESTMENT_REDEMPTIONtranfer in for DEFI redemptionINSTITUTION_LOAN_INBorrowed Amount (INS Loan)INSTITUTION_PAYBACK_PRINCIPAL_OUTPrincipal Repayment (INS Loan)INSTITUTION_PAYBACK_INTEREST_OUTInterest Repayment (INS Loan)INSTITUTION_EXCHANGE_SELLAuto Sold Collateral (INS Loan)INSTITUTION_EXCHANGE_BUYAuto Buy Liability (INS Loan)INSTITUTION_LIQ_PRINCIPAL_OUTAuto Principal Repayment (INS Loan)INSTITUTION_LIQ_INTEREST_OUTAuto Interest Repayment (INS Loan)INSTITUTION_LOAN_TRANSFER_INTransfer in (INS Loan)INSTITUTION_LOAN_TRANSFER_OUTTransfer out (INS Loan)INSTITUTION_LOAN_WITHOUT_WITHDRAWTransfer out (INS Loan)INSTITUTION_LOAN_RESERVE_INReserve Fund In (INS Loan)INSTITUTION_LOAN_RESERVE_OUTReserve Fund Out (INS Loan)SPREAD_FEE_OUTSpread fee for EU BrokerPLATFORM_TOKEN_MNT_LIQRECALLEDMMNTRecall MNTPLATFORM_TOKEN_MNT_LIQRETURNEDMNTReturn MNTMANUAL_LOANS_BORROWManual BorrowMANUAL_LOANS_REPAYManual RepayAUTO_LOANS_BORROWAuto BorrowAUTO_LOANS_REPAYAuto Repay
type(contract-translog)
TRANSFER_INAssets that transferred into (inverse) derivatives walletTRANSFER_OUTAssets that transferred out from (inverse) derivatives walletTRADESETTLEMENTUSDT / Inverse Perp funding settlementDELIVERYInverse Futures deliveryLIQUIDATIONADLAuto-DeleveragingAIRDROPBONUSBonus claimedBONUS_RECOLLECTBonus expiredFEE_REFUNDTrading fee refundedCURRENCY_BUYCurrency convertCURRENCY_SELLCurrency convertAUTO_DEDUCTIONAsset auto deducted by system (roll back)Others
unifiedMarginStatus
1Classic account3Unified trading account 1.04Unified trading account 1.0 (pro version)5Unified trading account 2.06Unified trading account 2.0 (pro version)
ltStatus
1LT can be purchased and redeemed2LT can be purchased, but not redeemed3LT can be redeemed, but not purchased4LT cannot be purchased nor redeemed5Adjusting position
convertAccountType
Check the value of unifiedMarginStatus
UTA2.0
eb_convert_utaUnified Trading Accounteb_convert_fundingFunding Account
UTA1.0
eb_convert_inverseInverse Derivatives Account (no USDT in this wallet))eb_convert_utaUnified Trading Accounteb_convert_fundingFunding Account
Classic account
Also known as the "standard account"
eb_convert_spotSpot Accounteb_convert_contractDerivatives Account (contain USDT in this wallet)eb_convert_fundingFunding Account
symbol
USDT Perpetual:
BTCUSDTETHUSDT
USDT Futures:
BTCUSDT-21FEB25ETHUSDT-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:
BTCPERPETHPERP
USDC Futures:
BTC-24MAR23
Inverse Perpetual:
BTCUSDETHUSD
Inverse Futures:
BTCUSDH23H: First quarter; 23: 2023BTCUSDM23M: Second quarter; 23: 2023BTCUSDU23U: Third quarter; 23: 2023BTCUSDZ23Z: Fourth quarter; 23: 2023
Spot:
BTCUSDTETHUSDC
Option:
BTC-13FEB25-89000-P-USDTUSDT OptionETH-28FEB25-2800-CUSDC 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
0default value of empty position12345
smpType
- default: 
None CancelMakerCancelTakerCancelBoth
extraFees.feeType
UNKNOWNTAXGovernment tax. Only for Indonesian siteCFXIndonesian foreign exchange tax. Only for Indonesian siteWHTEU withholding tax. Only for EU siteGSTIndian GST tax. Only for kyc=Indian usersVATARE VAT tax. Only for kyc=ARE users
extraFees.subFeeType
UNKNOWNTAX_PNNTax fee, fiat currency to digital currency. Only for Indonesian siteTAX_PPHTax fee, digital currency to fiat currency. Only for Indonesian siteCFX_FIEECFX fee, fiat currency to digital currency. Only for Indonesian siteAUT_WITHHOLDING_TAXEU site withholding tax. Only for EU siteIND_GSTIndian GST tax. Only for kyc=Indian usersARE_VATARE VAT tax. Only for kyc=ARE users
state
scheduledongoingcompletedcanceled
serviceTypes
1Trading service2Trading service via http request3Trading service via websocket4Private websocket stream5Market data service
product
1Futures2Spot3Option4Spread
maintainType
1Planned maintenance2Temporary maintenance3Incident
env
1Production2Production Demo service
bizType
SPOTDERIVATIVESOPTIONS
msg
API limit updated successfullyRequested limit exceeds maximum allowed per userNo permission to operate these UIDsAPI cap configuration not foundAPI cap configuration not found for bizTypeRequested limit would exceed institutional quota
groupId
1Major Coins2High Growth3Mid-Tier Liquidity4Mid-Tier Activation5Long Tail6Innovation Zone7Pre-Listing
groupName
G1(Major Coins)Major CoinsG2(High Growth)High GrowthG3(Mid-Tier Liquidity)Mid-Tier LiquidityG4(Mid-Tier Activation)Mid-Tier ActivationG5(Long Tail)Long TailInnovation-ZoneInnovation ZonePre-listingPre-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)
 
 
 - IsMakerOrder = TRUE
 
 - TRUE