快速入門
資訊
本指南以 Trading API 為例，幫助您快速上手。
本頁面將引導您從零開始完成第一次成功的 API 呼叫。每個步驟都連結到相關頁面的詳細說明，按順序操作即可快速上手。
步驟 1：申請 API 存取權限
使用 Webull OpenAPI 前，您需要申請存取權限並獲得憑證審批。
- 透過 Webull 官網申請。參閱 Trading API 申請流程。
警告
審核流程通常需要 1–2 個工作日。等待期間您可以繼續進行步驟 2。
步驟 2：安裝 SDK
安裝您所使用語言的官方 Webull SDK。SDK 會自動處理認證、簽名生成和協議細節。
| 語言 | 安裝命令 |
|---|---|
| Python | pip3 install --upgrade webull-openapi-python-sdk |
| Java | 在 Maven 依賴中添加 webull-openapi-java-sdk |
完整的安裝說明和環境設定，請參閱 SDK 和工具。
步驟 3：獲取憑證
申請通過後，從 Webull 官網或 Portal 生成您的 App Key 和 App Secret。
想立即開始編碼？使用共享的測試帳戶，沙盒環境無需申請即可使用。
步驟 4：發起第一次 API 呼叫
SDK 安裝完成且憑證就緒後，即可發起第一次呼叫。以下是使用沙盒環境的快速範例：
- Python
- Java
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.get_account_list()
print(res.json())
import com.webull.openapi.core.http.HttpApiConfig;
import com.webull.openapi.trade.TradeClient;
HttpApiConfig config = HttpApiConfig.builder()
.appKey("<your_app_key>")
.appSecret("<your_app_secret>")
.regionId("hk")
.endpoint("api.sandbox.webull.hk")
.build();
TradeClient client = new TradeClient(config);
System.out.println("Accounts: " + client.getAccountList());
如果看到帳戶列表返回，表示一切就緒。
API 端點
- 正式環境：
api.webull.hk - 沙盒環境：
api.sandbox.webull.hk
步驟 5：探索 API
連接成功後，深入了解適合您需求的 API：
| API | 適用場景 | 指南 |
|---|---|---|
| Trading API | 下單、管理持倉和帳戶 | Trading API 快速入門 |
| Market Data API | 即時和歷史行情數據 | Market Data API 快速入門 |