Skip to main content

V5

2024-04-15

REST API

2024-04-11

REST API

2024-04-03

REST API

2024-04-01

REST API

Websocket API

2024-03-28

Websocket API

2024-03-22

  • Integration Guidance [UPDATE]

    • To obey the compliance rule, two new domains are added for Netherland users and Hong Kong users repectively.
  • Create Internal Transfer [UPDATE]

    • API rate limit is increase from 20req/min to 60req/min

2024-03-21

  • Get Orderbook [UPDATE]
    • linear & inverse supports up to limit=500
    • linear & inverse, field u is matched with the u in ws 500 level

2024-03-13

REST API

2024-03-12

REST API

  • Set Risk Limit [DEPRECIATE]
    • Since auto risk limit has been launched, it is meaningless to use this API

2024-03-11

REST API

  • Get Order History [UPDATE]
    • UTA(spot, linear, option) can only query last 24 hours full cancelled orders records

2024-03-06

REST API

2024-03-05

REST API

  • Get Position Info [UPDATE]
    • Add new response field sessionAvgPrice for USDC contracts
    • Add new response field curRealisedPnl for Perps, Futures and Option
    • cumRealisedPnl is depreciated for Option
    • Add new response fields delta, vega, theta, gamma for Option

Websocket API

  • Position [UPDATE]
    • Add new response field sessionAvgPrice for USDC contracts
    • Add new response field curRealisedPnl for Perps, Futures and Option
    • cumRealisedPnl is depreciated for Option
    • Add new response fields delta, vega, theta, gamma for Option

2024-03-04

REST API

Websocket API

  • Trade
    • Add new stream fields for Option only. mP, iP, mIv, iv

2024-03-01

REST API

2024-02-29

REST API

  • Get Borrow History [UPDATE]

    • startTime & endTime are restricted to 30 days time range
    • Support getting up to 2 years data
  • Get Delivery Record [UPDATE]

    • Add query parameter startTime & endTime, and 30 days times range per request
    • Support getting up to 2 years data
  • Get USDC Session Settlement [UPDATE]

    • Add query parameter startTime & endTime, and 30 days times range per request
    • Support getting up to 2 years data
  • Get Orderbook [UPDATE]

    • Add a new response field seq for linear, inverse & spot

2024-02-28

REST API

2024-02-21

REST API

  • Get Instruments Info [Futures]
    • Add response fields maxMktOrderQty
    • postOnlyMaxOrderQty is useless, use maxOrderQty for Limit and PostOnly order

2024-02-06

REST API

2024-02-05

REST API

  • Get Order History [UPDATE]
    • UTA (linear,spot,option) does not support querying open status orders any more
    • Add a new error code: "181017", error message: "OrderStatus must be final status"

2024-01-18

REST API

2024-01-16

REST API

2024-01-15

REST API

  • Place Order [UPDATE]

    • Spot(UTA) can use takeProfit, stopLoss, tpLimitPrice, slLimitPrice, tpOrderType, slOrderType to set Market TPSL or Limit TPSL when creating Spot limit order.
  • Amend Order [UPDATE]

    • Spot(UTA) can amend takeProfit, stopLoss, tpLimitPrice, slLimitPrice if the original order has related attributes
  • Cancel All Orders [UPDATE]

    • Add new enums "OcoOrder", "BidirectionalTpslOrder" for orderFilter. You can only cancel all untriggered "BidirectionalTpslOrder"
  • Get Open Orders [UPDATE]

    • Add new enum "BidirectionalTpslOrder" for orderFilter
    • Add new enum "BidirectionalTpslOrder" for stopOrderType
  • Get Order History [UPDATE]

    • Add new enum "BidirectionalTpslOrder" for orderFilter
    • Add new enum "BidirectionalTpslOrder" for stopOrderType

Websocket API

  • Order [UPDATE]
    • Add new enum "BidirectionalTpslOrder" for stopOrderType

2024-01-11

REST API

  • Get Transaction Log [UPDATE]
    • new type enums FLEXIBLE_STAKING_SUBSCRIPTION, FLEXIBLE_STAKING_REDEMPTION, FIXED_STAKING_SUBSCRIPTION

2024-01-09

REST API

2024-01-08

REST API

  • Get Trade History [UPDATE]
    • Add a new response field feeCurrency for UTA Spot trading fee currency

2024-01-02

REST API

New error codeDescription
131231Transfers into this account are not supported
131232Transfers out this account are not supported

2023-12-28

REST API

  • Get Loan Orders [UPDATE]

    • Add a new response param deferredLiquidationLine, deferredLiquidationTime
  • Get LTV [UPDATE]

    • Add a new response param rst.
  • Get Product Info [UPDATE]

    • Add a new response param deferredLiquidationLine, deferredLiquidationTime

2023-12-22

REST API

  • Place Order [UPDATE]

    • Add a new request param marketUnit, the value are baseCoin, quoteCoin. It can be used to select qty unit for Spot market order (Unified account)
  • Get Open Orders [UPDATE]

    • Add a new response param marketUnit
  • Get Order History [UPDATE]

    • Add a new response param marketUnit

Websocket API

  • Order [UPDATE]
    • Add a new response param marketUnit

2023-12-20

REST API

2023-12-14

Websocket API

2023-12-12

REST API

Websocket API

  • Order [UPDATE]

    • Add a response field createType
  • Execution [UPDATE]

    • Add a response field createType

2023-12-07

REST API

  • Repay Liability [NEW]
    • Add a new endpoint to repay the liability of Unified Account

2023-12-04

REST API

2023-11-16

REST API

Websocket API

  • Wallet [UPDATE]
    • Add a new response field spotHedgingQty

2023-11-14

REST API

  • Withdraw [UPDATE]
    • The rate limit is changed from 10 req/min to 1 req/s

2023-11-09

REST API

  • Get Open Orders [UPDATE]

    • Classic account Spot can use orderFilter="OcoOrder"
  • Get Order History [UPDATE]

    • Add the time range limitation for startTime and endTime request params
    • Classic account Spot can use orderFilter="OcoOrder"
  • Get Trade History [UPDATE]

    • Add the time range limitation for startTime and endTime request params
  • Get Closed PnL [UPDATE]

    • Add the time range limitation for startTime and endTime request params
    • Classic account data is sort by updatedTime
  • Get Transaction Log [UPDATE]

    • Add the time range limitation for startTime and endTime request params
  • Get Pre-upgrade Order History [UPDATE]

    • Add the time range limitation for startTime and endTime request params
  • Get Pre-upgrade Trade History [UPDATE]

    • Add the time range limitation for startTime and endTime request params
  • Get Pre-upgrade Closed PnL [UPDATE]

    • Add the time range limitation for startTime and endTime request params
    • Classic account data is sort by updatedTime
  • Get Pre-upgrade Transaction Log [UPDATE]

    • Add the time range limitation for startTime and endTime request params
  • Get Sub Account All API Keys [NEW]

    • Add new endpoint for master account to query all api keys of a sub UID

2023-11-08

REST API

2023-11-02

REST API

  • Amend Order [UPDATE]

    • Add tpslMode in the request parameter
  • Batch Amend Order [UPDATE]

    • Add tpslMode in the request parameter
  • Get Borrow Quota (Spot) [UPDATE]

    • Add new response fields spotMaxTradeQty, spotMaxTradeAmount
  • Withdraw [UPDATE]

    • Add new enum value for forceChain parameter. You can withdraw between Bybit main accounts via inputting UID
  • Delete Sub UID [NEW]

    • Add new endpoint to delete sub account

2023-11-01

REST API

  • Amend Order [UPDATE]
    • Spot supports amending order, category=spot

2023-10-26

REST API

  • Get Trade History [UPDATE]

    • UTA Spot: stopOrderType, "" for normal order, tpslOrder for TP/SL order, Stop for conditional order, OcoOrder for OCO order
  • Get Open Orders [UPDATE]

    • UTA Spot: add new response field ocoTriggerBy, and the value can be OcoTriggerByUnknown, OcoTriggerByTp, OcoTriggerBySl
  • Get Order History [UPDATE]

    • UTA Spot: add new response field ocoTriggerBy, and the value can be OcoTriggerByUnknown, OcoTriggerByTp, OcoTriggerBySl

Websocket API

  • Order [UPDATE]
    • UTA Spot: add new response field ocoTriggerBy, and the value can be OcoTriggerByUnknown, OcoTriggerByTp, OcoTriggerBySl

2023-10-25

REST API

Websocket API

  • Position [UPDATE]
    • Add response field isReduceOnly, mmrSysUpdatedTime, leverageSysUpdatedTime

2023-10-17

REST API

2023-10-09

Websocket API

  • Orderbook [Spot]
    • Add a new level 200 data with frequency 200ms

2023-09-28

REST API

2023-09-25

REST API

  • Get Open Orders [UPDATE]

    • stopOrderType has new enumeration value: OcoOrder, used to indicate the Spot OCO Order (Unified Trading Account)
  • Get Order History [UPDATE]

    • stopOrderType has new enumeration value: OcoOrder, used to indicate the Spot OCO Order (Unified Trading Account)
  • Get Trade History [UPDATE]

    • execType has new enumeration value: MovePosition, used to indicate the position movement execution (Unified Trading Account)
  • Get Transaction Log [UPDATE]

    • type has new enumeration values: TRANSFER_IN_INS_LOAN, TRANSFER_OUT_INS_LOAN (Unified Trading Account)
  • Get Transaction Log [UPDATE]

    • type has new enumeration values: SPOT_REPAYMENT_SELL, SPOT_REPAYMENT_BUY (Unified Trading Account)

Websocket API

  • Order [UPDATE]
    • stopOrderType has new enumeration value: OcoOrder, used to indicate the Spot OCO Order (Unified Trading Account)

2023-09-21

REST API

  • Get Trade History [UPDATE]
    • Add response field seq
  • Get Position Info [UPDATE]
    • Add response field seq
  • Get Collateral Info [UPDATE]
    • Added "freeBorrowAmount" field: This field represents the amount of borrowing within your total borrowing amount that is exempt from interest charges
    • Depreciated "freeBorrowingAmount" field: The value of this field has been migrated to "freeBorrowingLimit", and it keeps empty string.
    • Added "freeBorrowingLimit" field: This field indicates the maximum limit for interest-free borrowing. If the unrealized loss portion exceeds this limit, all borrowings will be subject to interest.

WebSocket API

  • Position [UPDATE]
    • Add response field seq
    • Can subscribe specific category position
  • Execution [UPDATE]
    • Add response field seq
    • Can subscribe specific category position
  • Order [UPDATE]
    • Can subscribe specific category position

2023-09-18

REST API

  • Create Sub UID API Key [UPDATE]
    • Request parameter ips is actually string type. array can be used, but string is more explicit
    • Request parameter Derivatives has been depreciated due to auto identification by system
  • Modify Master API Key [UPDATE]
    • Request parameter ips is actually string type. array can be used, but string is more explicit
    • Request parameter Derivatives has been depreciated due to auto identification by system
  • Modify Sub API Key [UPDATE]
    • Add a new request param apikey, which can be used for Master account to manage sub account api key
    • Request parameter ips is actually string type. array can be used, but string is more explicit
    • Request parameter Derivatives has been depreciated due to auto identification by system
  • Delete Sub API Key [UPDATE]
    • Add a new request param apikey, which can be used for Master account to delete sub account api key

2023-09-14

REST API

  • Get Product Info [UPDATE]
    • Add a new response field spotMarginTrading
    • You can use api key and secret to call this endpoint to get your private data if you are eligible.
  • Get Margin Coin Info [UPDATE]
    • You can use api key and secret to call this endpoint to get your private data if you are eligible.
  • Get Loan Orders [UPDATE]
    • Add a new response field spotMarginTrading
    • The meaning of parentUid is changed. After the change, it represents the uid that bound with OTC loan product
  • Get LTV [NEW]
    • The meaning of parentUid is changed. After the change, it represents the uid that bound with OTC loan product

2023-09-07

REST API

  • Get Open Orders [UPDATE]
    • By /v5/order/realtime?category=inverse, you can get all inverse contracts opening orders
  • Get Position Info [UPDATE]
    • By /v5/position/list?category=inverse, you can get all inverse contracts holding positions
    • symbol supports multiple values for category=inverse

2023-09-04

REST API

  • Batch Place Order [UPDATE]
    • UTA Pro: support USDT perp, USDC perp & USDC Futures batch place orders
  • Batch Amend Order [UPDATE]
    • UTA Pro: support USDT perp, USDC perp & USDC Futures batch amend orders
  • Batch Cancel Order [UPDATE]
    • UTA Pro: support USDT perp, USDC perp & USDC Futures batch cancel orders

2023-08-31

REST API

  • Cancel All Orders [UPDATE]
    • add new request params stopOrderType
    • enumerations Order and StopOrder for orderFilter support linear and inverse product types
  • Get Deposit Records (on chain) [UPDATE]
    • Add a new response field depositType. You can process deposit assets when the deposit has daily deposit limit or abnormal deposit issue.
  • Get Sub Deposit Records (on chain) [UPDATE]
    • Add a new response field depositType. You can process deposit assets when the deposit has daily deposit limit or abnormal deposit issue.

2023-08-30

REST API

2023-08-25

REST API

2023-08-24

REST API

Old error codeNew error codeMsg
110075182021Cannot enable spot margin while in isolated margin mode. Please switch to cross margin mode or portfolio margin mode to trade spot with margin.

2023-08-22

REST API

  • Get Transaction Log [UPDATE]
    • Add a new response field id, which is a unique id for each transaction log
  • Get Status And Leverage [NEW]
    • Add a new endpoint to query margin trade status and leverage of Unified account

2023-08-17

REST API

2023-08-15

REST API

  • Get VIP Margin Data [NEW]
    • Add new endpoint used to query margin data for different VIP levels (Classic Account)

2023-08-11

REST API

  • Get Wallet Balance [UPDATE]
    • availableToBorrow always returns "" because main-sub uids share borrow quota
  • Get Collateral Info [UPDATE]
    • Add new response field borrowUsageRate
    • availableToBorrow is a shared value across main-sub uids

Websocket API

  • Wallet [UPDATE]
    • availableToBorrow always returns "" because main-sub uids share borrow quota

2023-08-10

REST API

  • Set Collateral Coin [NEW]
    • Add a new endpoint to set collateral coin in the Unified account
  • Get Account Info [UPDATE]
    • Add a new response field isMasterTrader to indicate if the account is master trader (copytrading)

2023-08-08

REST API

2023-08-07

REST API

  • Place Order [UPDATE]
    • Spot supports conditional order, orderFilter adds a new enum value StopOrder
  • Cancel Order [UPDATE]
    • Spot supports conditional order, orderFilter adds a new enum value StopOrder
  • Cancel All Orders [UPDATE]
    • Spot supports conditional order, orderFilter adds a new enum value StopOrder
  • Get Open Orders [UPDATE]
    • Spot supports conditional order, orderFilter adds a new enum value StopOrder, stopOrderType reuses Stop for Futures and Spot conditional order
  • Get Order History [UPDATE]
    • Spot supports conditional order, orderFilter adds a new enum value StopOrder, stopOrderType reuses Stop for Futures and Spot conditional order

Websocket API

  • Order [UPDATE]
    • stopOrderType reuses Stop for Futures and Spot conditional order
    • Add new field feeCurrency, which is used to identify Spot trading fee asset
    • updatedTime has value for classic account Spot trading

2023-07-31

REST API

WebSocket API

  • Position
    • Adjust liqPrice value logic. It only has value when minPrice < liqPrice < maxPrice, otherwise it is always ""
  • Wallet
    • Add new response field collateralSwitch

2023-07-24

REST API

  • Get Product Info
    • Add new Response fields: USDTPerpetualOpenLine``USDCContractOpenLine, USDCOptionsOpenLine, USDTPerpetualCloseLine, USDCContractCloseLine, USDCOptionsCloseLine, USDCContractSymbols, USDCOptionsSymbols, marginLeverage, USDTPerpetualLeverage, symbol, leverage, USDCContractLeverage
  • Get Loan Orders
    • Add new Response fields: USDTPerpetualOpenLine, USDCContractOpenLine, USDCOptionsOpenLine, USDTPerpetualCloseLine, USDCContractCloseLine, USDCOptionsCloseLine, USDCContractSymbols, USDCOptionsSymbols, marginLeverage, USDTPerpetualLeverage, symbol, leverage, USDCContractLeverage
  • Get Single Coin Balance
    • Add new request param: toAccountType, toMemberId, withLtvTransferSafeAmount
    • Add new response field: ltvTransferSafeAmount
  • Add error codes for UTA with OTC loan when trade Spot, Futures and Option
New error codeDescription
30133USDT Perp: When the trading pair is not in the whitelist
30134USDC Contract: When the trading pair is not in the whitelist
30135USDT Perp: When you try to change a leverage higher than the maximum leverage in OTC loan
30136USDC Contract: When you try to change a leverage higher than the maximum leverage in OTC loan
3200316Option: restrict to trade
3200317Option: restrict to buy
170709Spot: When the trading pair is not in the whitelist
170215Spot: restrict to buy
170216Spot: margin leverage exceeded
170220Spot: restrict to trade

2023-07-13

REST API

2023-07-04

REST API

2023-06-26

WebSocket API

  • Orderbook [Spot]
    • Improve the push frequency from 100ms to 20ms of level 50

2023-06-24

REST API

  • Get Instruments Info [UPDATE]
    • When category=linear, add a new response params copyTrading to indicate this trading pair supporting copy trade or not for UTA and normal account

2023-06-15

REST API

2023-06-14

REST API

2023-06-08

REST API

  • Get Fee Rate [UPDATE]
    • Support to get USDC perp & USDC futures trading fee rate

2023-06-07

REST API

  • Withdraw [UPDATE]
    • Add new request param feeType, which is used to select the withdrawal fee operation type when withdraw

2023-06-02

REST API

  • Get Affiliate User Info [New]
    • A brand new endpoint, which is used for affiliate to check the basic information of their users

2023-06-01

REST API

  • Set Margin Mode [UPDATE]
    • UTA account supports isolated margin, a new enum ISOLATED_MARGIN for request param "setMarginMode"
  • Switch Position Mode [UPDATE]
    • UTA account supports Hedge mode for USDT Perp when it is isolated margin or cross margin mode
  • Get Position Info [UPDATE]
    • Add new response field positionBalance
  • Get Account Info [UPDATE]
    • "marginTrade" field has a new enum value - ISOLATED_MARGIN
  • Set Auto Add Margin [UPDATE]
    • add category enum linear for UTA
  • Add Or Reduce Margin [UPDATE]
    • A brand new endpoint is used to add or reduce specific margin you want

WebSocket API

  • Position [UPDATE]
    • Add new response param positionBalance

2023-05-30

REST API

  • Get Instruments Info [UPDATE]
    • When category=spot, add a new response params marginTrading to indicate this trading pair supporting margin trade or not for UTA and normal account

2023-05-23

REST API

  • Place Order [UPDATE]
    • Add new request params for new TP/SL tpslMode, tpLimitPrice, slLimitPrice, tpOrderType, slOrderType
  • Amend Order [UPDATE]
    • Add new request params for new TP/SL tpLimitPrice, slLimitPrice
  • Get Open Orders [UPDATE]
    • Add new response params for new TP/SL tpslMode, tpLimitPrice, slLimitPrice
  • Get Order History [UPDATE]
    • Add new response params for new TP/SL tpslMode, tpLimitPrice, slLimitPrice
  • Get Position Info [UPDATE]
    • tpslMode in the position is depreciated
  • Set Trading Stop [UPDATE]
    • Add new request params for new TP/SL tpslMode, tpLimitPrice, slLimitPrice, tpOrderType, slOrderType

WebSocket API

  • Position [UPDATE]
    • tpslMode in the position is depreciated
  • Order [UPDATE]
    • Add new response params for new TP/SL tpslMode, tpLimitPrice, slLimitPrice

2023-05-10

REST API

Old error codeNew error codeMsg
10001110075RiskId is not modified

2023-05-05

REST API

2023-05-04

REST API

  • Get Trade History [UPDATE]
    • symbol is no longer mandatory for normal account when get derivatives
  • Get Closed PnL [UPDATE]
    • symbol is no longer mandatory for normal account when get derivatives

2023-04-20

REST API

  • Place Order [UPDATE]
    • add new request param smpType used to select SMP execution type
  • Get Open Orders [UPDATE]
    • add new response fields smpType, smpOrderId, smpGroup
    • add new enum cancelBySmp of cancelType
  • Get Order History [UPDATE]
    • add new response fields smpType, smpOrderId, smpGroup
    • add new enum cancelBySmp of cancelType
  • Get Account Info [UPDATE]
    • add new response fields dcpStatus, timeWindow, smpGroup

WebSocket API

  • Order [UPDATE]
    • add new response fields smpType, smpOrderId, smpGroup
    • add new enum cancelBySmp of cancelType

2023-04-06

REST API

2023-04-04

REST API

  • Get Instruments Info [UPDATE]
    • add request param startTime endTime, effective for UTA mode
    • add response param placeType, used for option

2023-04-04

REST API

WebSocket API

  • Position [UPDATE]
    • add response param adlRankIndicator
    • category field is added to UTA stream
  • Order [UPDATE]
    • add response param placeType, used for option
  • Execution [UPDATE]
    • add response param closedSize

2023-03-24

REST API

2023-03-23

REST API

WebSocket API

  • Wallet [UPDATE]
    • Add a new response field accountLTV

2023-03-22

REST API

2023-03-15

REST API

  • Get Single Coin Balance [UPDATE]
    • Add a new request param withTransferSafeAmount and a new response field transferSafeAmount

2023-03-10

REST API

  • Get Instruments Info [UPDATE]
    • Unify the enums of status for Spot, Derivatives and Options. Use Trading, Closed, Settling, PreLaunch, Deliverying
    • Remove duplicate category field in the Options response
  • Get Fee Rate [UPDATE]
    • Support to get Options trading fee rate

2023-03-09

REST API

  • Set Leverage [UPDATE]
    • UTA user can set up to 10X for margin trade
  • Get Wallet Balance [UPDATE]
    • Before adjustment: normal account gets error code and message when call accountType=UNIFIED.
      After adjustment: normal account gets http code 400 when call accountType=UNIFIED

2023-02-28

REST API

WebSocket API

  • Wallet [UPDATE]
    • Add a new field bonus

2023-02-20

REST API

2023-02-15

REST API

  • User [NEW]
    • Add a set of user & api key related endpoints for V5

2023-02-14

REST API

  • Get Fee Rate (Derivatives) [NEW]
    • Get the trading fee rate for derivatives
  • Withdraw [UPDATE]
    • Select the wallet to be withdrawn from
    • The default withdrawn wallet is Spot wallet
Req paramRequiredTypeComments
accountTypefalsestringSelect the wallet to be withdrawn from
  • SPOT:spot wallet (default)
  • FUND:Funding wallet

2023-02-09

REST API

2023-01-19

REST API

  • Set Margin Mode [UPDATE]
    • Portfolio margin mode supports USDT Perpetual
  • Get Position Info [UPDATE]
    • For portfolio margin mode, positionIM, positionMM, leverage, riskLimitValue returns "", riskId returns 0
  • Get Wallet Balance [UPDATE]
    • For portfolio margin mode, totalOrderIM, totalPositionIM, totoalPositionMM returns ""

WebSocket API

  • Position [UPDATE]
    • For portfolio margin mode, positionIM, positionMM, leverage, riskLimitValue returns "", riskId returns 0
  • Wallet [UPDATE]
    • For portfolio margin mode, totalOrderIM, totalPositionIM, totoalPositionMM returns ""

2023-01-16

REST API

  • Get Tickers [spot]
    • usdIndexPrice has been added to response. It means USD index price, which can be empty.

WebSocket API

  • Tickers [spot]
    • usdIndexPrice has been added to stream. It means USD index price, which can be empty.
  • Orderbook [linear contract & inverse contract]
    • Add 500 level depth, push frequency is 100ms

2023-01-09

WebSocket API

  • Tickers [linear contract & inverse contract]
    • nextFundingTime has been changed from dataTime 2023-01-05T08:00:00Z to timestamp (ms) 1672905600000
    • predicatedFundingRate has been removed from stream