Skip to main content

API Application

API Application

  1. Open Webull Hong Kong official website. Click the login button in the upper right corner to log in as a user (if you don't have a Webull user number, please click the login button next to register first). img.png

  2. After logging in, the page will automatically jump to the account center. If there is no active jump, you can also click [My Account] on the avatar in the upper right corner to jump to the account center. img.png The account center page is as follows: img.png If there is no account, the left side of the account center will only appear My Account, API Management, and Security Center, as shown in the following screenshots: img.png If you don't have an account, click [API Management] -> [My Application], and "Open an Account Now" button will appear. Click to "Open an Account Now" and follow the instructions to submit the account opening information. You need to complete the account opening before you can apply for the API.

  3. After opening an account, click [API Management] -> [My Application] to apply for API. img.png

    caution

    After the API application, Webull needs to review the application. It is estimated that the process will take 1 to 2 working days at the earliest.

  4. After the application is completed, an email will be sent to the email address you filled in when opening an account. You can also view it in [API Management] -> [My Application] on the Webull Hong Kong official website, as shown below: img.png

Register an API Application

  1. After the API application is approved, you can start registering the application in [API Management] -> [Application Management]. img.png
  2. Enter your application name and click the box " I have read and accept the agreement" to register the application. img.png
  3. After the registration is complete, you need to click [Generate Key] to generate the key. During the key generation process, SMS verification code and transaction password verification are required.
    tip

    The default validity period of key generation is 1 day.

    img.png The following is an example after the key is generated, including the App Key, App Secret, and the remaining valid time of the App Secret. img.png
  4. After the App Secret expires, you can click [Reset Key] to reset the App Secret. img.png Before resetting, you can click [Modify] to modify the validity period of the key. The maximum validity period can be selected for 7 days.
    caution

    Note: The modification of the validity period will be applied to the next reset of the key. It cannot exceed 3 times a day for modifying information, generating keys, and resetting keys.

    img.png