query.instrument.list

List trading instruments.

Method

query.instrument.list

Description

Returns a paginated list of trading instruments available on specified venues. Filter by venue, symbol, security type, or instrument status.

Parameters

Field	Type	Required	Description
venue	string	No	Filter by venue (e.g., "BINANCE")
symbols	string[]	No	Filter by symbols (e.g., ["BTC/USDT", "ETH/USDT"])
securityType	string	No	Filter by security type (SPOT, PERPETUAL, FUTURE, OPTION)
status	string	No	Filter by status (ENABLED, DISABLED)
limit	integer	No	Maximum results (default: 100)
offset	integer	No	Pagination offset

Result

Returns an array of instrument objects.

Instrument Object

Field	Type	Description
instrumentId	string	Unique identifier ({venue}:{symbol})
venue	string	Exchange venue
symbol	string	Human-readable symbol (e.g., "BTC/USDT")
externalSymbol	string	Exchange symbol format (e.g., "BTCUSDT")
description	string	Instrument description
instrumentType	string	Type: SPOT, PERPETUAL, FUTURE, OPTION
status	string	Status: ENABLED, DISABLED
baseAsset	string	Base asset (e.g., "BTC")
quoteAsset	string	Quote asset (e.g., "USDT")
baseSecurityType	string	Base asset security type
quoteSecurityType	string	Quote asset security type
basePrecision	integer	Base asset decimal precision
quotePrecision	integer	Quote asset decimal precision
lotSize	string	Minimum quantity increment
pipSize	string	Minimum price increment
minQuantity	string	Minimum order quantity
maxQuantity	string	Maximum order quantity
minNotional	string	Minimum notional value
orderTypes	string[]	Supported order types
timeInForceOptions	string[]	Supported time-in-force options

Usage

# List all instruments on Binance
result = await client.rpc("query.instrument.list", {"venue": "BINANCE"})

# List specific symbols
result = await client.rpc("query.instrument.list", {
    "symbols": ["BTC/USDT", "ETH/USDT"],
    "limit": 50
})

Example Response

{
  "data": [
    {
      "instrumentId": "BINANCE:BTC/USDT",
      "venue": "BINANCE",
      "symbol": "BTC/USDT",
      "externalSymbol": "BTCUSDT",
      "instrumentType": "SPOT",
      "status": "ENABLED",
      "baseAsset": "BTC",
      "quoteAsset": "USDT",
      "basePrecision": 8,
      "quotePrecision": 8,
      "lotSize": "0.00001",
      "pipSize": "0.01",
      "minQuantity": "0.00001",
      "maxQuantity": "9000",
      "minNotional": "10",
      "orderTypes": ["MARKET", "LIMIT", "STOP_LIMIT"],
      "timeInForceOptions": ["GTC", "IOC", "FOK"]
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 100,
    "total": 1500
  }
}