Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
Websocket
Public
    Tickers ChannelCandlestick ChannelDepth ChannelPublic Trades ChannelRPI Depth ChannelLiquidation ChannelInstruments ChannelOpen Interest Limit ChannelPosition Tier ChannelFunding Rate ChannelMargin Loan ChannelMargin Coins Channel
Private
Reality
SBE
Public

Instruments Channel

Description

Push trading parameter and trading pair status changes for a product. When trading parameters change (e.g. limit price ratio, price protection, order price/quantity precision, etc.) or the trading pair status changes (e.g. listed, online, maintenance, etc.), this channel pushes a message containing the new values.

After subscribing, messages are pushed only when trading parameters change. It is recommended to first fetch the full information via REST, then subscribe to this channel to receive subsequent changes.

Code
{ "op": "subscribe", "args": [ { "instType": "usdt-futures", "topic": "instruments" } ] }

Request Parameters

ParametersTypeRequiredDescription
opStringYesOperation
subscribe Subscribe
unsubscribe Unsubscribe
argsList<Object>YesSubscribed channel
> instTypeStringYesProduct type
spot Spot trading
usdt-futures USDT futures
coin-futures Coin-M futures
usdc-futures USDC futures
> topicStringYesTopic
instruments Instruments channel
Code
{ "event": "subscribe", "arg": { "instType": "usdt-futures", "topic": "instruments" }, "connId": "xxxxxxxxxx" }

Response Parameters

ParametersTypeDescription
eventStringEvent
argObjectSubscribed channel
> instTypeStringProduct type
spot Spot trading
usdt-futures USDT futures
coin-futures Coin-M futures
usdc-futures USDC futures
> topicStringTopic
instruments Instruments channel
codeStringError code
msgStringError message
connIdStringConnection ID
Code
{ "data": [ { "baseCoin": "BTC", "quoteCoin": "USDT", "buyLimitPriceRatio": "0.05", "sellLimitPriceRatio": "0.05", "marketPriceRatio": "0.05", "priceProtectThreshold": "0.1", "feeRateUpRatio": "0.01", "openCostUpRatio": "0.01", "minOrderQty": "0.001", "maxOrderQty": "1000", "minOrderAmount": "5", "maxMarketOrderQty": "500", "pricePrecision": "2", "quantityPrecision": "3", "quotePrecision": "4", "priceMultiplier": "0.01", "quantityMultiplier": "0.001", "type": "perpetual", "status": "online", "openTime": "1700000000000", "offTime": "", "limitOpenTime": "" } ], "arg": { "instType": "usdt-futures", "topic": "instruments" }, "action": "snapshot", "ts": 1736371332162 }

Push Parameters

ParametersParameter TypeDescription
argObjectSubscribed channel
> instTypeStringProduct type
spot Spot trading
usdt-futures USDT futures
coin-futures Coin-M futures
usdc-futures USDC futures
> topicStringTopic
instruments Instruments channel
actionStringData push action
snapshot Full data
update Incremental data
dataList<Object>Subscribed data
> baseCoinStringBase coin
e.g. BTC in BTCUSDT
> quoteCoinStringQuote coin
e.g. USDT in BTCUSDT
> buyLimitPriceRatioStringBuy limit price ratio
The ratio of the buy limit price to the market price, determining the highest allowed price for a buy order
> sellLimitPriceRatioStringSell limit price ratio
The ratio of the sell limit price to the market price, determining the lowest allowed price for a sell order
> marketPriceRatioStringMarket order price ratio
The ratio of the buy/sell market order price to the market price, determining the price range for market orders
> priceProtectThresholdStringTake-profit/stop-loss price protection threshold
The maximum allowed deviation between the TP/SL trigger price and the latest/mark price
Returned in decimal form, e.g. 0.1 represents 10%
> feeRateUpRatioStringFee rate markup ratio
The percentage increase of the actual fee relative to the base fee
> openCostUpRatioStringOpening cost markup ratio
The percentage increase of the position opening cost relative to the base/standard cost
> minOrderQtyStringMinimum limit order quantity
The minimum order quantity allowed, denominated in the base coin
> maxOrderQtyStringMaximum limit order quantity
The maximum order quantity allowed, denominated in the base coin
0 means no limit
> minOrderAmountStringMinimum limit order amount
The minimum order amount allowed, denominated in the quote coin
> maxMarketOrderQtyStringMaximum market order quantity
The maximum order quantity allowed for market orders, denominated in the base coin
> pricePrecisionStringPrice precision
The number of decimal places allowed for price
The order price must be an integer multiple of the price precision
> quantityPrecisionStringQuantity precision
The number of decimal places allowed for quantity
The order quantity must be an integer multiple of the quantity precision
> quotePrecisionStringQuote order precision
The number of decimal places allowed for the quote coin price
> priceMultiplierStringPrice multiplier
Used together with pricePrecision. For example, if pricePrecision=2 and priceMultiplier=0.01, the order price must be a multiple of priceMultiplier with 2 decimal places
> quantityMultiplierStringQuantity multiplier
Used for futures orders together with quantityPrecision. For example, if quantityPrecision=2 and quantityMultiplier=0.01, the order quantity must be a multiple of quantityMultiplier with 2 decimal places
> typeStringContract type
perpetual Perpetual
delivery Delivery
> statusStringTrading pair status
listed Listed (not yet open)
online Trading normally/open
limit_open Opening disabled
limit_close Closing disabled for futures, trading halted for spot
offline Delisted/under maintenance
> openTimeStringOpening time
Unix millisecond timestamp
> offTimeStringTrading halt time
Returns "" when not configured
Futures only
> limitOpenTimeStringOpening restriction time
A non-empty value indicates the symbol is or will be under maintenance, and trading will be disabled after this time
Returns "" when not configured
Liquidation ChannelOpen Interest Limit Channel
JSON
JSON
JSON