command.instrument.sync

Synchronize instruments from exchange.

Method

command.instrument.sync

Description

Fetches the latest instrument definitions from a specified exchange and updates the local instrument database. Use this to refresh instrument metadata, trading rules, and precision settings.

Parameters

Field	Type	Required	Description
venue	string	Yes	Target venue (e.g., "BINANCE")
symbols	string[]	No	Specific symbols to sync (syncs all if omitted)

Result

Field	Type	Description
synced	integer	Number of instruments synced
venue	string	Venue that was synced

Usage

# Sync all instruments from Binance
result = await client.rpc("command.instrument.sync", {"venue": "BINANCE"})

# Sync specific instruments
result = await client.rpc("command.instrument.sync", {
    "venue": "BINANCE",
    "symbols": ["BTC/USDT", "ETH/USDT"]
})

Example Response

{
  "synced": 1523,
  "venue": "BINANCE"
}

Notes

• Sync operations may take several seconds for venues with many instruments
• New instruments are automatically set to DISABLED status
• Use command.instrument.enable to activate specific instruments for trading