Query Trade Instrument

Interface Description

• Function description: Query the information of traded symbol.

• Applicable objects: Customers who connect to webull through the OpenApi development platform.

• Request URL:: /trade/instrument

• Request method:: GET

• Frequency limit: The calling frequency of each AppId is limited to 10 times in 30 seconds.

Request Parameters

Parameter	Type	Required fields	Description	Example value
instrument_id	String	Yes	Symbol ID	13467788

Response Parameter

Parameter	Type	Description	Example value
instrument_id	String	Symbol ID	913257048
symbol	String	Equity code	00831
instrument_type	String	Type of underlying equity: STOCK	STOCK
short_name	String	Equity abbreviation
buy_unit	String	Place an order to buy the smallest unit	2000
trade_policy	String	Trading Policies: referring to TradePolicy in the data dictionary	ALL
margin_ratio	String	Financing ratio	0

Request Example

Python

from webullsdktrade.api import API
from webullsdkcore.client import ApiClient
from webullsdkcore.common.region import Region

api_client = ApiClient(your_app_key, your_app_secret, Region.HK.value)
api = API(api_client)
response = api.trade_instrument.get_trade_instrument_detail(instrument_id)
if response.status_code == 200:
    trade_instrument_detail = response.json()

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.hk.name())
        .build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);
InstrumentInfo instrumentInfo = apiService.getTradeInstrument(instrumentId);

Response Example

{
  "instrument_id": "913256409",
  "symbol": "00700",
  "instrument_type": "STOCK",
  "short_name": "Tencent Holdings",
  "buy_unit": "100",
  "trade_policy": "ALL",
  "margin_ratio": "0.7500000000"
}

Exception Example

{
  "error_code": "SYSTEM_ERROR",
  "message": "Required Integer parameter 'instrument_id' is not present"
}