Skip to main content

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.

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 two protocols, HTTP / GRPC, to support functions and features like trading, subscriptions for changes of order status.

ProtocolDescription
HTTPIt mainly provides interface services for data such as tradings, accounts, candlestick charts, snapshots, etc.
GRPCProvide real-time push messages for order status changes.

How to Activate

  1. First, you must sign up and register Webull App, and then you need to open a ウィブル証券口座.

  2. After you have a ウィブル証券口座, click the link, and then you need to click [マイアプリケーション] under the [OpenAPI利用申請] to apply for API services.

  3. After the API service audit is completed, you need to go to [OpenAPI登録] to create an application. After the application is created, you need to click [API Keyの生成] to generate a key. The default validity period of the key is 45 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.

Market Supported

U.S. stocks and ETFs.

tip

Note: It ultimately depends on your trading authority. Transaction/quote permissions can be viewed on the 申請管理.

Pricing

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 U.S Stocks Shares - Webull