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
Parameter | Type | Required fields | Description | Example value |
---|---|---|---|---|
instrument_id | String | Yes | Symbol ID | 913256135 |
Response Parameter
Parameter | Type | Description | Example value |
---|---|---|---|
symbol | String | STOCK code | AAPL |
instrument_type | String | TickerType | STOCK |
trade_policy | String | Trading Policies: referring to TradePolicy in the data dictionary | ALL |
margin_ratio | String | Financing ratio | 0 |
can_margin | String | Yes Or No, Marginable or Not | YES |
Request Example
- Python
- Java
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()
HttpApiConfig apiConfig = HttpApiConfig.builder()
.appKey(Env.APP_KEY)
.appSecret(Env.APP_SECRET)
.regionId(Region.us.name())
.build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);
InstrumentInfo instrumentInfo = apiService.getTradeInstrument(instrumentId);
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"
}