Skip to main content

Introduction to OpenAPI

Brief Introduction​

Webull Pay OpenAPI aims to provide quantitative traders with convenient, fast and secure services. Webull Pay aims to help quant traders achieve flexible and changeable market traders strategies.

The Main Function:

Trade Management: create, cancel orders, etc.

Market information: You can query crypto 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 Pay’s Open API is mainly for traders who are capable of coding and quantitative traders.

Interface Protocol​

The bottom layer of the Webull Pay OpenAPI provides two protocols, HTTP / GRPC , to support functions and features like trading, changes to order status and real-time market quotes.

ProtocolDescription
HTTPProvides interface services for data such as trades, accounts, candlestick charts, snapshots, etc.
GRPCProvides real-time push messages for order status changes.

How to Activate​

  1. To get started, you need to have an active Webull Pay account. You can register via mobile app or through our official website.

  2. After you have a Webull Pay account, you will need to click on the API tab under the Account tab on the Webull Pay official website (users click the avatar in the upper right corner after logging in) to apply for API services.

  3. After the API service audit is completed, you will need to go to API tab to create an application. After the application is created, click the Generate button to generate a key. The key is valid for 7 days. If you need an extension, please click the extension tab.

    caution

    Note: Changes to the validity period will take effect with the next key reset. You can modify information, generate keys, and reset keys up to 3 times per day.

Market Supported​

traders: CRYPTO Quotes: CRYPTO

tip

Note: View your transaction and quote permissions on the Webull Pay official website [API].