|
1 | | -# Webull OpenAPI Python SDK |
2 | | - |
3 | | -Note: This is the new version of the Webull SDK, currently applicable only to Webull Hong Kong, Webull US, or Webull JP customers. |
4 | | - |
5 | | -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. |
6 | | - |
7 | | -The main function: |
8 | | - |
9 | | -Trading management: create, modify, cancel orders, etc. |
10 | | - |
11 | | -Market information: You can query stocks/ETFs and other related market information through the HTTP interface. |
12 | | - |
13 | | -Account Information: Query account balance and position information. |
14 | | - |
15 | | -Subscription to real-time information: Subscribe to order status changes, market information, etc. |
16 | | - |
17 | | -## Requirements |
18 | | - |
19 | | -- Please first generate the app key and app secret on the Webull official website. |
20 | | - |
21 | | -| Broker | Link | |
22 | | -|-----------|-------------------------------------------------| |
23 | | -| Webull HK | https://www.webull.hk/open-api | |
24 | | -| Webull US | https://www.webull.com/center#openApiManagement | |
25 | | -| Webull JP | https://www.webull.co.jp/center/openapi/manage | |
26 | | - |
27 | | -- Requires Python 3.7 through 3.11. |
28 | | - |
29 | | -## Interface Protocol |
30 | | - |
31 | | -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. |
32 | | - |
33 | | -| Protocol | Description | |
34 | | -|----------|----------------------------------------------------------------------------------------------------------------| |
35 | | -| HTTP | It mainly provides interface services for data such as tradings, accounts, candlestick charts, snapshots, etc. | |
36 | | -| GRPC | 1. Provide real-time push messages for order status changes. | |
37 | | -| MQTT | Provides data services for real-time market conditions. | |
38 | | - |
39 | | -## Developer documentation |
40 | | - |
41 | | -| Broker | Link | |
42 | | -|-----------|------------------------------------------| |
43 | | -| Webull HK | https://developer.webull.hk/apis/docs | |
44 | | -| Webull US | https://developer.webull.com/apis/docs | |
45 | | -| Webull JP | https://developer.webull.co.jp/apis/docs | |
0 commit comments