Accounts

Webull's Account API allows developers to query account information via the HTTP protocol. For details, please refer to the API Reference.

Before calling the Account API, you need to have an App Key and App Secret.

• For individual users, please see here.
• For institutional users, please see here.

Note

Due to security and regulatory requirements in Hong Kong, in addition to authentication via App Key and Secret signature, OpenAPI also requires Token authentication. For details on Token creation and verification, please refer to Token Creation and Verification.

1. Base URLs

• Production Environment: https://api.webull.hk/
• Sandbox Environment: https://api.sandbox.webull.hk

2. Code Example

Python

from webull.core.client import ApiClient
from webull.trade.trade_client import TradeClient

optional_api_endpoint = "<webull_api_host>" # //PRD env host: api.webull.hk. Test env host: api.sanbox.webull.hk
your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"
region_id = "hk"
api_client = ApiClient(your_app_key, your_app_secret, region_id)
api_client.add_endpoint(region_id, optional_api_endpoint)


if __name__ == '__main__':
    trade_client = TradeClient(api_client)

    res = trade_client.account_v2.get_account_list()
    if res.status_code == 200:
        print('get account list:', res.json())

Java

public class AccountList {
    private static final Logger logger = LoggerFactory.getLogger(AccountList.class);

    public static void main(String[] args) throws InterruptedException {
        HttpApiConfig apiConfig = HttpApiConfig.builder()
                .appKey("<your_app_key>")                // <your_app_key>
                .appSecret("<your_app_secret>")          //<your_app_secret>
                .regionId("hk")                          //<your_region_id> @see com.webull.openapi.core.common.Region
                .endpoint("<webull_api_host>")           //PRD env host: api.webull.hk. Test env host: api.sanbox.webull.hk
                .build();
        
        com.webull.openapi.trade.TradeClientV2 apiService = new com.webull.openapi.trade.TradeClientV2(apiConfig);

        // get account list
        List<Account> accounts = apiService.listAccount();
        logger.info("Accounts: {}", accounts);
    }
}