Skip to main content

Query Trade Instrument

Interface Description

  • Function description: Query the information of traded symbol.

  • Applicable objects: Customers who integrate into Webull through Webull OpenAPI.

  • Request URL:: /trade/instrument

  • Request method:: GET

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

Request Parameters

ParameterTypeRequired fieldsDescriptionExample value
instrument_idStringYesSymbol ID913256135

Response Parameter

ParameterTypeDescriptionExample value
symbolStringSTOCK codeAAPL
instrument_typeStringTickerTypeSTOCK
trade_policyStringTrading Policies: referring to TradePolicy in the data dictionaryALL
margin_ratioStringFinancing ratio0
can_marginStringYes Or No, Marginable or NotYES

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.US.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

{
"instrument_id": "913256135",
"symbol":"AAPL",
"instrument_type":"STOCK",
"trade_policy":"ALL",
"margin_ratio":"0.0949",
"can_margin":"YES"
}

Exception Example

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