Skip to main content

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

ParameterTypeRequired fieldsDescriptionExample value
instrument_idStringYesSymbol ID13467788

Response Parameter

ParameterTypeDescriptionExample value
instrument_idStringSymbol ID913257048
symbolStringEquity code00831
instrument_typeStringType of underlying equity: STOCKSTOCK
short_nameStringEquity abbreviation
buy_unitStringPlace an order to buy the smallest unit2000
trade_policyStringTrading Policies: referring to TradePolicy in the data dictionaryALL
margin_ratioStringFinancing ratio0

Request Example

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()

Response Example

Exception Example