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
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| op | String | Yes | Operation subscribe Subscribe unsubscribe Unsubscribe |
| args | List<Object> | Yes | Subscribed channel |
| > instType | String | Yes | Product typespot Spot tradingusdt-futures USDT futures coin-futures Coin-M futures usdc-futures USDC futures |
| > topic | String | Yes | Topic instruments Instruments channel |
Code
Response Parameters
| Parameters | Type | Description |
|---|---|---|
| event | String | Event |
| arg | Object | Subscribed channel |
| > instType | String | Product typespot Spot tradingusdt-futures USDT futures coin-futures Coin-M futures usdc-futures USDC futures |
| > topic | String | Topic instruments Instruments channel |
| code | String | Error code |
| msg | String | Error message |
| connId | String | Connection ID |
Code
Push Parameters
| Parameters | Parameter Type | Description |
|---|---|---|
| arg | Object | Subscribed channel |
| > instType | String | Product typespot Spot tradingusdt-futures USDT futures coin-futures Coin-M futures usdc-futures USDC futures |
| > topic | String | Topic instruments Instruments channel |
| action | String | Data push action snapshot Full data update Incremental data |
| data | List<Object> | Subscribed data |
| > baseCoin | String | Base coin e.g. BTC in BTCUSDT |
| > quoteCoin | String | Quote coin e.g. USDT in BTCUSDT |
| > buyLimitPriceRatio | String | Buy limit price ratio The ratio of the buy limit price to the market price, determining the highest allowed price for a buy order |
| > sellLimitPriceRatio | String | Sell limit price ratio The ratio of the sell limit price to the market price, determining the lowest allowed price for a sell order |
| > marketPriceRatio | String | Market order price ratio The ratio of the buy/sell market order price to the market price, determining the price range for market orders |
| > priceProtectThreshold | String | Take-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% |
| > feeRateUpRatio | String | Fee rate markup ratio The percentage increase of the actual fee relative to the base fee |
| > openCostUpRatio | String | Opening cost markup ratio The percentage increase of the position opening cost relative to the base/standard cost |
| > minOrderQty | String | Minimum limit order quantity The minimum order quantity allowed, denominated in the base coin |
| > maxOrderQty | String | Maximum limit order quantity The maximum order quantity allowed, denominated in the base coin 0 means no limit |
| > minOrderAmount | String | Minimum limit order amount The minimum order amount allowed, denominated in the quote coin |
| > maxMarketOrderQty | String | Maximum market order quantity The maximum order quantity allowed for market orders, denominated in the base coin |
| > pricePrecision | String | Price precision The number of decimal places allowed for price The order price must be an integer multiple of the price precision |
| > quantityPrecision | String | Quantity precision The number of decimal places allowed for quantity The order quantity must be an integer multiple of the quantity precision |
| > quotePrecision | String | Quote order precision The number of decimal places allowed for the quote coin price |
| > priceMultiplier | String | Price 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 |
| > quantityMultiplier | String | Quantity 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 |
| > type | String | Contract type perpetual Perpetual delivery Delivery |
| > status | String | Trading 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 |
| > openTime | String | Opening time Unix millisecond timestamp |
| > offTime | String | Trading halt time Returns "" when not configured Futures only |
| > limitOpenTime | String | Opening 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 |
