跳至主要内容

快速入門指南

本快速指南將協助您透過API進行交易，內容涵蓋：安裝Webull SDK、取得API金鑰，以及查詢帳戶資訊的方法

1. 安裝 Webull Client SDK​

系統需求​

在開始之前，您需要先產生 app key and app secret.

  • 個人用戶請參考 這裡。
  • 機構用戶請參考 這裡。

需要 Python 版本 3.8 至 3.11

SDK 安裝​

Install via pip

pip3 install --upgrade webull_openapi_python_sdk

2. 生成 API 金鑰並進行驗證​

每次 API 呼叫都需基於 App Key 進行驗證，並使用 secret key 生成簽名。 客戶端必須在 HTTP 請求標頭中分別提供 App Key 和簽名，對應的欄位名稱分別為 x-app-key 及 x-signature。

關於如何根據 secret key 生成簽名的規則，請參考簽名規則。

Note

根據香港的安全與合規要求，OpenAPI 不僅依賴於 App Key 及密碼簽名（secret signature）進行身份驗證，還需要進行 Token 驗證 有關 Token 的產生與校驗，請參閱：Token 產生與驗證

3. 透過 SDK 使用交易 API​

完成 SDK 安裝並取得 API 金鑰後，即可開始使用交易 API。以下範例說明如何查詢帳戶列表，更多操作請參考交易 API 相關文件。

3.1 取得帳戶列表​

import json

from webull.core.client import ApiClient
from webull.data.common.category import Category
from webull.trade.trade_client import TradeClient

# 生產環境: events-api.webull.hk
# 測試環境: events-api.sandbox.webull.hk
optional_api_endpoint = "<api_endpoint>"
your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"
region_id = "hk"
account_id = "<your_account_id>"
api_client = ApiClient(your_app_key, your_app_secret, region_id)
api_client.add_endpoint(region_id, optional_api_endpoint)

if __name__ == '__main__':
    trade_client = TradeClient(api_client)
    res = trade_client.account_v2.get_account_list()
    if res.status_code == 200:
        print("account_list=" + json.dumps(res.json(), indent=4))

3.2 交易 API 調用範例​

本壓縮包提供基於官方 Python SDK 的 Trading API 調用範例，涵蓋账户、下單、持倉查詢等核心功能。適用於快速驗證交易邏輯與本地除錯。

下載webull-openapi-demo-py.zip

遇到問題？聯繫Webull支持​

  1. 在Webull 幫助中心中提交工单
  2. 通过Webull API服務郵箱地址聯繫我們的技術支援人員：webull-api-support@webull.com
  3. 官方WhatsApp群组
Example banner