Query trading instruments based on symbol and other information.

Interface Description

• Function description: Query trading instrument information based on criteria such as symbol, markets, instrument_super_type.

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

• Request URL:: /trade/security

• 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
symbol	String	Yes	Equity code	SPX
market	String	Yes	Market，Markets	HK
instrument_super_type	String	Yes	Asset Class	EQUITY；OPTION
instrument_type	String	No	Type of underlying equity，required when querying for options information.	CALL_OPTION-看涨期权；PUT_OPTION-看跌期权
strike_price	String	No	Option Strike Price, required when querying for options information.	3400
init_exp_date	String	No	Option Expiration Date, Format: yyyy-MM-dd, required when querying for options information.	2024-12-20

Response Parameter

Parameter	Type	Description	Example value
instrument_id	String	Symbol ID	913257048
symbol	String	Equity code	AAPL
instrument_super_type	String	Asset Class: EQUITY	EQUITY
instrument_type	String	Type of underlying equity: STOCK	STOCK
short_name	String	Equity abbreviation	APPLE INC
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
market	String	Market: referring to Markets in the data dictionary	US
cusip	String	Cusip code	037833100
exchange_code	String	Exchange code, reference: ExchangeCode	NSQ
listStatus	String	List status	LISTING - Listed; DELISTING - Delisted; OTHER - Other.
currency	String	Currency, reference: Currency	HKD
marginable	String	Margin Financing Availability.	Y - Marginable; N - Non-marginable.
shortable	String	Short Selling Allowed.	Y - Shortable; N - Non-Shortable.
fractionalTrading	String	Fractional Shares Trading Supported	Y - Supports Fractional Shares Trading; N - Does Not Support Fractional Shares Trading.

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_security_detail(symbol, market, instrument_super_type, instrument_type, strike_price, init_exp_date)
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 securityInfo = apiService.getSecurityInfo(symbol, market, instrumentSuperType, instrumentType, strikePrice, initExpDate);

Response Example

Exception Example