Query Tradable Instruments

Tradable Instruments

• Function description: Paging query tradable instruments.

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

• Request URL: /trade/instrument/tradable/list

• Request method:: GET

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

Request parameters

Parameter	Type	Required fields	Description	Example value
last_security_id	String	No	Pagination-specific id, if not passed, the first page will be searched by default	901517074194
page_size	Integer	No	Number of entries per page: default value is 10, and the maximum value is 100 with integers being filled.	10

Response parameter

Parameter	Type	Description	Example value
hasNext	Boolean	Is there a next page	true
instruments	[ ]TradableInstrument	Tradable instrument list	Reference sample code

TradableInstrument:

Parameter	Type	Description	Example value
security_id	String	Pagination-specific id	901517075475
name	String	Name	iShares U.S. Technology ETF
symbol	String	Securities code	IYW
instrument_id	String	Unique identifier for the security	913243051
exchange_code	String	Exchange code, reference: ExchangeCode	NYSE
currency	String	Currency, reference: Currency	USD
sector	String	Primary Classification	Consumer Cyclicals

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.trade_instrument.get_tradeable_instruments()
if response.status_code == 200:
    print('tradeable instruments:', res.json())

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.jp.name())
        .build();
        TradeApiService apiService = new TradeHttpApiService(apiConfig);
TradableInstruments tradableInstruments = apiService.getTradeableInstruments(lastSecurityId, pageSize);

Response example

Exception example