Get Instruments

Interface Description

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

• URL: /instrument/list

• Method: GET

• Rate limit: The calling frequency of each App ID is limited to 30 times per minute.

Request Parameters

Parameter	Type	Required fields	Description
symbols	String	Yes	Securities symbol, such as: BTCUSD,ETHUSD. Multiple symbols should be separated by ",". A single query supports up to 100 symbols.
category	String	Yes	Security type, enumeration. Reference: Category,Currently only CRYPTO is supported.

Response Parameter

Field	Type	Description
name	String	Name
symbol	String	Security symbol, such as BTCUSD
instrument_id	String	Unique identifier for the security
currency	String	Currency, reference: Currency

Request Example

Python

from webullpaysdktrade.api import API
from webullpaysdkcore.client import ApiClient
from webullpaysdkcore.common.region import Region

your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"

api_client = ApiClient(your_app_key, your_app_secret, Region.US.value)
api = API(api_client)
response = api.instrument.get_instrument("BTCUSD,ETHUSD", "CRYPTO")
if response.status_code == 200:
    instruments = response.json()
    print(instruments)

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey("<your_app_key>")
        .appSecret("<your_app_secret>")
        .regionId(Region.us.name())
        .build();
try (QuotesApiClient quotesApiClient = new HttpQuotesApiClient(apiConfig)) {
    //get instruments
    Set<String> symbols = new HashSet<>();
    symbols.add("BTCUSD");
    symbols.add("ETHUSD");
    List<Instrument> instruments = quotesApiClient.getInstruments(symbols, Category.CRYPTO.name());
    //print
    System.out.println(JsonSerializer.toJson(instruments, SerializeConfig.builder().underscoresToCamel(true).build()));
}

Response Example

[
  {
    "name": "Bitcoin",
    "symbol": "BTCUSD",
    "instrument_id": "950160802",
    "currency": "USD"
  },
  {
    "name": "Ethereum",
    "symbol": "ETHUSD",
    "instrument_id": "950160804",
    "currency": "USD"
  }
]