Introduction to OpenAPI
Brief Introduction
Webull OpenAPI aims to provide quantitative trading investors with convenient, fast and secure services. Webull aims to help every quant traders achieve flexible and changeable trading or market strategies.
The main function:
Trading management: create, modify, cancel orders, etc.
Market information: You can query stocks/ETFs and other related market information through the HTTP interface.
Account information: Query account balance and position information.
Subscription to real-time information: Subscribe to order status changes, market information, etc.
User Oriented
Webull OpenAPI is mainly for investors who are capable of coding and quantitative trading.
Interface Protocol
The bottom layer of Webull OpenAPI provides three protocols, HTTP / GRPC / MQTT, to support functions and features like trading, subscriptions for changes of order status and real-time market quotes.
| Protocol | Description |
|---|---|
| HTTP | It mainly provides interface services for data such as tradings, accounts, candlestick charts, snapshots, etc. |
| GRPC | 1. Provide real-time push messages for order status changes. 2. Provide data query support for the market interface. |
| MQTT | Provides data services for real-time market conditions. |
How to Activate
First, you must sign up and register Webull App or on the Webull Hong Kong official website, and then you need to open a Webull Hong Kong brokerage account.
After you have a Webull Hong Kong brokerage account, you need to click [My Application] under the [API Management] of the account center on the Webull Hong Kong official website (users click the avatar in the upper right corner after logging in) to apply for API services.。
After the API service audit is completed, you need to go to [Application Management] to create an application. After the application is created, you need to click [Generate Key] to generate a key. The default validity period of the key is 24 hours. If you need to modify the validity period of the key, you need to click [Modify] to modify the validity period on the modification page.
caution
Note: The modification of the validity period will be applied to the next reset of the key. It cannot exceed
3times a day for modifying information, generating keys, and resetting keys.
Market Supported
Trading: U.S Stocks, Equities in Hong Kong (including stocks, ETFs), China-connect Stocks.
Quotes: Hong Kong stocks, China Connect stocks.
tip
Note: It ultimately depends on your trading authority. Transaction/quote permissions can be viewed on the Webull Hong Kong official website [Application Management].
Pricing
Quotes:
| Market | Categories | Quote Right Acquisition（Please purchase from Quote Market on Webull APP ） |
|---|---|---|
| HK Market | Stocks, ETFs | Get free BMP quotes. Purchase HK exchange Level 2 （Global）for LV2 market quotes. Note： Only one device is available to use LV2 at one time, please refer to restrictions for Quote Right Acquisition |
| Mainland Market | A shares (China Connect) | Get a free LV1 quote (real-time in mainland China, 15-minute delay in other regions) |
Trading:
For trading through Webull OpenAPI, there is no additional charge for the time being. The trading fee is the same as the APP trading fee. The specific charging scheme is as follows:
List of Pricings for Hong Kong Stocks and A-connect Shares - Webull