Trading API Application

The Trading API is a direct trading interface designated for natural persons. Based on the user's operational identity, the application process is divided into two distinct modes:

Retail Individual Mode

Applicable to direct account holders. Should you require the use of Trading API to trade accounts registered under your own name, please initiate the application independently.

Institutional Trader Mode

Applicable to institutional traders. Should you require the use of Trading API to operate authorized institutional proprietary accounts, please contact the institutional administrator (Admin) to complete the authorization application.

Retail Individual Mode Application Process

Prod

1. Open Webull 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).
2. You can click [Developer Tool] on the avatar in the upper right corner to jump to the Developer Management Center. If you don't have an account, "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 [OpenAPI Management] -> [My Application] to apply for API.

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.

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 official website-openapi, as shown below:

Obtain API Key Application

1. After the API application is approved, you can start registering the application in [API Management] -> [API Keys Management].Enter your application name and click the box " I have read and accept the agreement" to register the application.
2. After the registration is complete, you need to click [Generate Key] to generate the key. The following is an example after the key is generated, including the App Key, App Secret.
3. you can click [Reset Key] to reset the App keys. Upon reset, the new key takes effect immediately, and the old key will be invalidated immediately.

Sandbox

1. Open Webull 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).
2. You can click [Developer Tool] on the avatar in the upper right corner to jump to the Developer Management Center.
3. After opening an account, click [My Application]. You will see the [Using OpenAPI service in Paper Trading] button.
4. Click the button to go to the Sandbox Trading page, then navigate to [API Management] -> [My Application] to apply for the Sandbox Trading API.

caution

The Sandbox Trading API application is approved automatically and typically completes within a few minutes

Obtain API Key Application (Sandbox Environment)

1. After the Sandbox Trading API application is approved, you can start registering the application in [API Management] -> [API Keys Management].
2. After the registration is complete, you need to click [Generate Key] to generate the key. The following is an example after the key is generated, including the App Key, App Secret.
3. You can click [Reset Key] to reset the App keys. Upon reset, the new key takes effect immediately, and the old key will be invalidated immediately.

Institutional Trader Mode 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 app secret (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 the official website's Developer Tools Center to create api keys application and, following the page instructions, create your personal Open API Keys application in the Developer Center.

Apply for OpenAPI

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. Make sure your account is opened, click [Open API] -> [Open API 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 [Open API] -> [Open API 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.)

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.

2. Make sure your account is opened, click [Open API] -> [Open API 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 [Open API] -> [Open API Application] in the Webull Portal Sandbox, as shown below:

Authorize Traders for Open API Access

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.

Obtain API Key

As an Authorized Open API Trader，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 [Open API] -> [My OpenAPI Access]. If you do not have OpenAPI access rights, the [My OpenAPI Access] page will display as follows:

note

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

2. click the [API Keys Management], go to [API Keys Management] in the Developer Tools Center, then reference the Obtain API Key Application to manage your API key.