command.instrument.disable

Disable an instrument for trading.

Method

command.instrument.disable

Description

Disables a trading instrument. Disabled instruments cannot be used for order submission. Existing subscriptions will continue until unsubscribed.

Parameters

Field	Type	Required	Description
instrumentId	string	Yes	Instrument ID (e.g., "BINANCE:BTC/USDT")

Result

Returns the updated instrument object.

Instrument Object

Field	Type	Description
instrumentId	string	Unique identifier
venue	string	Exchange venue
symbol	string	Trading symbol
status	string	Updated status (DISABLED)
...	...	Other instrument fields

Usage

result = await client.rpc("command.instrument.disable", {
    "instrumentId": "BINANCE:BTC/USDT"
})

Example Response

{
  "instrumentId": "BINANCE:BTC/USDT",
  "venue": "BINANCE",
  "symbol": "BTC/USDT",
  "externalSymbol": "BTCUSDT",
  "instrumentType": "SPOT",
  "status": "DISABLED",
  "baseAsset": "BTC",
  "quoteAsset": "USDT"
}