About Webull OpenAPI
Introduction
Webull OpenAPI is designed to provide convenient, fast, and secure quantitative trading services to quantitative trading investors. It helps every client with quantitative trading needs to implement flexible and diverse trading or market data strategies.
Main Features:
- Trade Management: Create, modify, and cancel orders, etc.
- Market Data: Query stock/ETF and related market information via HTTP interface.
- Account Information: Query account balance and position information.
- Real-time Information Subscription: Subscribe to order status changes, market data, etc.
Target Users
Webull OpenAPI is mainly aimed at investors who have certain coding abilities and a reasonable understanding of quantitative trading.
Interface Protocols
Webull OpenAPI provides HTTP and MQTT protocols at the underlying level to support functions such as trading and real-time market data subscriptions, and also offers gRPC to support order status change subscriptions.
| Protocol | Description |
|---|---|
| HTTP | Mainly provides interface services for trading, account, market candlestick bars, snapshot, and other data. |
| gRPC | Provides real-time message push for order status changes. |
| MQTT | Provides data streaming services for real-time market data. |
How to Activate
First, you must register as a Webull user on the Webull Portal, and then you need to open a Webull Hong Kong institutional securities account.
After obtaining a Webull Hong Kong brokerage account, you need to go to the Webull Portal under the OpenAPI Management section, click on My Applications, and apply for API services.
Once your API service application is approved, go to App Management to create an application. After the application is created, you will need to click Generate Key to generate an API key.
Modifying information, generating keys, or resetting keys cannot be performed more than 3 times per day.
Supported Markets
Trading: US equity products (stocks, options—excluding index options), Hong Kong brokerage (including stocks, ETFs, warrants, CBBCs), and Stock Connect stocks.
Market Data: Hong Kong stocks, A-shares, US stocks, and the US overnight session.
Note: Your final access is subject to your trading permissions. You can check your trading and market data permissions under App Management in the Webull Portal.
Usage Fees
Market Data:
| Market | Category | Permission Acquisition (Please purchase paid data subscriptions in the Webull Portal) |
|---|---|---|
| US Market | Securities Products (Stocks, ETFs, Night Session) | To obtain permission to access U.S. stock market data, please purchase Level 1 and Level 2 market data for U.S. stock.
Note: Only one device may access LV1 and LV2 at any one time. please refer to restrictions for Quote Right Acquisition |
| Hong Kong Market | Securities products (Stocks, ETFs) | Free access to HK stock market LV1 data. To obtain LV2 data, please purchase HKEX Level 2 (Global Edition).
Note: Only one device is available to use LV2 at one time, please refer to restrictions for Quote Right Acquisition |
| Mainland China Market | A-shares (Stock Connect) | Free access to LV1 data (Not supported in Mainland China, 15-minute delay in other regions) |