Institution Application Process

Note

For administrators, you need to complete the Open API Services application, then grant Open API Access to users within your organization, allowing them to create their own app keys and secret keys (AK/SK) and manage accounts through API.

For non-administrator users, you must first contact an administrator to enable Open API Access, then go to create api keys application and, following the page instructions, create your personal Open API Keys application in the Developer Center.

Apply for Open API Services

Prod

1. Open the Webull Portal Prod. Log in using your Webull registered account. (If you do not have a Webull account yet, please click the Register button to sign up first.)
2. After logging in, the My Account >> Asset Information page is shown below: If you have not opened an account, click the [Open Account] button and follow the instructions to submit your account opening information. You will need to wait until the account opening is completed before you can apply for the API.
3. Once your account is opened, click [openAPI Mgmt] -> [My Application] to apply for the API.
   Note

   After submitting your API application, it will be reviewed by Webull operations staff. The review is expected to take 1 to 2 business days at the fastest.

   Once your application is approved, an email will be sent to the email address you provided during account registration. You can also view the status under [openAPI Mgmt] -> [My Application] in the Webull Portal, as shown below:

Sandbox

1. Open the Webull Portal Sandbox. Log in using your Webull registered account. (If you do not have a Webull account yet, please click the Register button to sign up first.)

2. After logging in, the My Account >> Asset Information page is shown below: If you have not opened an account, click the [Open Account] button and follow the instructions to submit your account opening information. You will need to wait until the account opening is completed before you can apply for the API.

   Note

   Select the institution's licensing status — recommend "Yes" for this option. For sandbox account opening, follow the above recommendation; for production, fill in per actual circumstances.

   Choosing "Yes" reduces sandbox account opening data entry and speeds up the process. Sandbox data does not sync to production — the two environments are fully isolated.

3. Once your account is opened, click [openAPI Mgmt] -> [My Application] to apply for the API.

   Note

   After submitting your API application, it will be reviewed by Webull operations staff. The review is expected to take 1 to 2 business days at the fastest.

   Once your application is approved, an email will be sent to the email address you provided during account registration. You can also view the status under [openAPI Mgmt] -> [My Application] in the Webull Portal Sandbox, as shown below:

Open API Access Authorization

1. The admin can go to [User Management] to grant Open API Access to users in your organization. Once authorized, users can generate their own API keys and perform operations with them.

note

Authorize with caution—authorized users can access all accounts in the portal via their keys. Support for aligning key permissions with user permissions is coming soon.

Create API Keys Application

Below is an example after key generation, which includes your Permissions, and the IP whitelist you have set.

1. After you receive an invitation from the institution administrator, you can start registering your application under [openAPI Mgmt] -> [My OpenAPI]. If you do not have OpenAPI access rights, the [My OpenAPI] page will display as follows:

   note

   You can contact the institution administrator to grant access rights to OpenAPI.

2. Enter your application name and check "I have read and accept the API Agreement and Webull Securities (Hong Kong) Disclaimer" to register your application.

3. After registration is complete, click [Generate Key] to create your app key. During the key generation process, you will need to complete SMS verification and trading password verification.

4. When you need to reset your Secret, you can click [Reset Key] to reset your App Key.