SDK 和工具
Webull 提供官方 SDK，幫助您快速整合 OpenAPI 平台。SDK 封裝了 REST 和串流 API，讓您專注於構建應用程式，無需處理底層細節。
SDK 為您處理以下工作：
- 認證 — 自動生成簽名和管理 Token
- 交易 — 下單、修改和取消股票、ETF、期權、窩輪和牛熊證訂單
- 行情數據 — 透過 HTTP 獲取歷史數據，透過 MQTT 訂閱即時串流
- 訂單事件 — 透過 gRPC 訂閱即時訂單狀態更新
官方 SDK
- Python
- Java
要求： JDK 8+
<dependency>
<groupId>com.webull.openapi</groupId>
<artifactId>webull-openapi-java-sdk</artifactId>
<version>1.0.3</version> <!-- 請查看 https://central.sonatype.com/artifact/com.webull.openapi/webull-openapi-java-sdk 獲取最新版本 -->
</dependency>
API 環境
Webull 提供兩個環境。使用沙盒環境進行開發和整合測試，準備就緒後切換至正式環境。
正式環境
| 服務 | 地址 |
|---|---|
| HTTP API | api.webull.hk |
| 交易事件（gRPC） | events-api.webull.hk |
| 行情數據串流（MQTT） | data-api.webull.hk |
沙盒環境
| 服務 | 地址 |
|---|---|
| HTTP API | api.sandbox.webull.hk |
| 交易事件（gRPC） | events-api.sandbox.webull.hk |
| 行情數據串流（MQTT） | data-api.sandbox.webull.hk |
提示
切換環境只需在初始化 SDK 客戶端時更改端點地址，無需修改其他程式碼。
測試帳戶
使用以下共享憑證即可立即開始開發 — 沙盒環境無需申請。
| 編號 | 帳戶 ID | App Key | App Secret |
|---|---|---|---|
| 1 | V4H6R3L4VRI33UQ4TGR2NM1VI9 | 4b2b7acd2bf0d30d8aea173fceefa238 | 840b4353a6a31ce3ab91e2f99a510272 |
| 2 | OGG4RRLC6EDE98HI920KRBVSKB | 42bd186fb65ea76de309d69cf12f024e | 29feb64b59d6b1b6b2d2aa8cea8a1b8d |
| 3 | 2DHSQ9B1DMPBFPMPFU2R5SDPB8 | 64fc722617af8b5ebb746f50a910e91f | a268416fc681d438533f9e9316bab576 |
警告
這些帳戶為公開共用。訂單與持倉可能隨時發生變動。若涉及交易，功能不受影響；若涉及行情API，目前僅支援存取 AAPL（包含即時串流）。如需專屬測試帳戶，請聯絡我們的 支援團隊。
驗證設定
安裝 SDK 後，執行以下快速檢查以確認一切正常：
- Python
- Java
import json
from webull.core.client import ApiClient
from webull.trade.trade_client import TradeClient
api_client = ApiClient("<your_app_key>", "<your_app_secret>", "hk")
api_client.add_endpoint("hk", "api.sandbox.webull.hk")
trade_client = TradeClient(api_client)
res = trade_client.account_v2.get_account_list()
if res.status_code == 200:
print("Success!", json.dumps(res.json(), indent=2))
else:
print("Error:", res.status_code, res.text)
import com.webull.openapi.core.http.HttpApiConfig;
import com.webull.openapi.trade.TradeClientV2;
public class VerifySetup {
public static void main(String[] args) {
HttpApiConfig config = HttpApiConfig.builder()
.appKey("<your_app_key>")
.appSecret("<your_app_secret>")
.regionId("hk")
.endpoint("api.sandbox.webull.hk")
.build();
TradeClientV2 client = new TradeClientV2(config);
System.out.println("Account list: " + client.getAccountList());
}
}
如果看到帳戶列表返回，表示設定完成。
管理工具
Webull 提供網頁工具用於管理 API 憑證和帳戶：
| 工具 | 適用對象 | 說明 |
|---|---|---|
| Webull 官方網站 | 個人客戶 | 管理 API 密鑰、查看帳戶資訊和存取交易服務 |
| 機構 Portal | 機構客戶 | 透過安全登入管理帳戶資金、持倉和訂單 |