Get Instruments

Interface Description

• Function description: Query the underlying information according to the security symbol list and security type.

• Request URL: /instrument/list

• Request method: GET

• Frequency limit: The calling frequency of each AppId is limited to 60 times per minute.

Request parameters

Parameter	Type	Required fields	Description
symbols	String	Yes	Securities symbol, such as: AAPL,GOOG. Multiple symbols should be separated by ,. A single query supports up to 100 symbols.
category	String	Yes	Security type. Reference: Category, Currently only US_STOCK and US_ETF are supported.

Response parameter

Field	Type	Description
name	String	Name
symbol	String	Security symbol, such as AAPL
instrument_id	String	Unique identifier for the security
exchange_code	String	Exchange code, reference: ExchangeCode
currency	String	Currency, reference: Currency

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.JP.value)
api = API(api_client)
response = api.instrument.get_instrument(symbols, category)
if response.status_code == 200:
    instruments = response.json()

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.jp.name())
        .build();
try (QuotesApiClient quotesApiClient = new HttpQuotesApiClient(apiConfig)) {
    List<Instrument> instruments = quotesApiClient.getInstruments(symbols, category);
}

Response example