webull-openapi-python-sdk 2.0.7__py3-none-any.whl → 2.0.9__py3-none-any.whl

samples/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.7'
+__version__ = '2.0.9'

samples/data/data_client.py

@@ -24,6 +24,7 @@ optional_api_endpoint = "<api_endpoint>"
 your_app_key = "<your_app_key>"
 your_app_secret = "<your_app_secret>"
 region_id = "<region_id>"
+
 # The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
 # Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
 # If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
@@ -145,3 +146,21 @@ if __name__ == '__main__':
     res = data_client.market_data.get_noii_snapshot("AAPL", Category.US_STOCK.name, "PRE_CLOSE")
     if res.status_code == 200:
         print('get_noii_snapshot (closing):', res.json())
+
+    # Option market data - Historical bars
+    # Rate limit: 1 request per second per App Key
+    res = data_client.option_market_data.get_option_history_bars('AAPL260522C00300000', Category.US_OPTION.name, Timespan.M1.name)
+    if res.status_code == 200:
+        print('get_option_history_bars:', res.json())
+
+    # Option market data - Tick
+    # Rate limit: 60 requests per minute
+    res = data_client.option_market_data.get_option_tick("AAPL260522C00300000", Category.US_OPTION.name, count=30)
+    if res.status_code == 200:
+        print('get_option_tick:', res.json())
+
+    # Option market data - Snapshot
+    # Rate limit: 60 requests per minute
+    res = data_client.option_market_data.get_option_snapshot("AAPL260522C00300000", Category.US_OPTION.name)
+    if res.status_code == 200:
+        print('get_option_snapshot:', res.json())

samples/trade/trade_client_v3.py

@@ -529,3 +529,331 @@ if __name__ == '__main__':
     res = trade_client.order_v3.get_order_detail(account_id, alog_client_order_id)
     if res.status_code == 200:
         print('get order detail res:', res.json())
+
+    # ============================================================
+    # Stop Loss Order Example (HK Market)
+    # ============================================================
+    stop_loss_client_order_id = uuid.uuid4().hex
+    print('stop loss client order id:', stop_loss_client_order_id)
+    new_stop_loss_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": stop_loss_client_order_id,
+            "symbol": "00700",
+            "instrument_type": "EQUITY",
+            "market": "HK",
+            "order_type": "STOP_LOSS",
+            "quantity": "200",
+            "stop_price": "560.35",
+            "support_trading_session": "CORE",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_stop_loss_orders)
+    if res.status_code == 200:
+        print('place stop loss order res:', res.json())
+    sleep(5)
+
+    replace_stop_loss_orders = [
+        {
+            "client_order_id": stop_loss_client_order_id,
+            "stop_price": "560.37",
+            "quantity": "200"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_stop_loss_orders)
+    if res.status_code == 200:
+        print('replace stop loss order res:', res.json())
+    sleep(5)
+
+    res = trade_client.order_v3.cancel_order(account_id, stop_loss_client_order_id)
+    if res.status_code == 200:
+        print('cancel stop loss order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, stop_loss_client_order_id)
+    if res.status_code == 200:
+        print('get stop loss order detail res:', res.json())
+
+    # ============================================================
+    # Stop Loss Limit Order Example (HK Market)
+    # ============================================================
+    stop_loss_limit_client_order_id = uuid.uuid4().hex
+    print('stop loss limit client order id:', stop_loss_limit_client_order_id)
+    new_stop_loss_limit_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": stop_loss_limit_client_order_id,
+            "symbol": "00700",
+            "instrument_type": "EQUITY",
+            "market": "HK",
+            "order_type": "STOP_LOSS_LIMIT",
+            "quantity": "200",
+            "stop_price": "560.35",
+            "limit_price": "562.21",
+            "support_trading_session": "CORE",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_stop_loss_limit_orders)
+    if res.status_code == 200:
+        print('place stop loss limit order res:', res.json())
+    sleep(5)
+
+    replace_stop_loss_limit_orders = [
+        {
+            "client_order_id": stop_loss_limit_client_order_id,
+            "stop_price": "560.39",
+            "limit_price": "562.69",
+            "quantity": "200"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_stop_loss_limit_orders)
+    if res.status_code == 200:
+        print('replace stop loss limit order res:', res.json())
+    sleep(5)
+
+    res = trade_client.order_v3.cancel_order(account_id, stop_loss_limit_client_order_id)
+    if res.status_code == 200:
+        print('cancel stop loss limit order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, stop_loss_limit_client_order_id)
+    if res.status_code == 200:
+        print('get stop loss limit order detail res:', res.json())
+
+    # ============================================================
+    # Touch (Market) Order Example (HK Market)
+    # ============================================================
+    touch_mkt_client_order_id = uuid.uuid4().hex
+    print('touch mkt client order id:', touch_mkt_client_order_id)
+    new_touch_mkt_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": touch_mkt_client_order_id,
+            "symbol": "00700",
+            "instrument_type": "EQUITY",
+            "market": "HK",
+            "order_type": "TOUCH_MKT",
+            "quantity": "200",
+            "stop_price": "540.35",
+            "support_trading_session": "CORE",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_touch_mkt_orders)
+    if res.status_code == 200:
+        print('place touch mkt order res:', res.json())
+    sleep(5)
+
+    replace_touch_mkt_orders = [
+        {
+            "client_order_id": touch_mkt_client_order_id,
+            "stop_price": "540.67",
+            "quantity": "200",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_touch_mkt_orders)
+    if res.status_code == 200:
+        print('replace touch mkt order res:', res.json())
+    sleep(5)
+
+    res = trade_client.order_v3.cancel_order(account_id, touch_mkt_client_order_id)
+    if res.status_code == 200:
+        print('cancel touch mkt order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, touch_mkt_client_order_id)
+    if res.status_code == 200:
+        print('get touch mkt order detail res:', res.json())
+
+    # ============================================================
+    # Touch Limit Order Example (HK Market)
+    # ============================================================
+    touch_limit_client_order_id = uuid.uuid4().hex
+    print('touch limit client order id:', touch_limit_client_order_id)
+    new_touch_limit_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": touch_limit_client_order_id,
+            "symbol": "00700",
+            "instrument_type": "EQUITY",
+            "market": "HK",
+            "order_type": "TOUCH_MKT",
+            "quantity": "200",
+            "stop_price": "540.35",
+            "limit_price": "535.35",
+            "support_trading_session": "CORE",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_touch_limit_orders)
+    if res.status_code == 200:
+        print('place touch limit order res:', res.json())
+    sleep(5)
+
+    replace_touch_limit_orders = [
+        {
+            "client_order_id": touch_limit_client_order_id,
+            "stop_price": "540.67",
+            "limit_price": "536.67",
+            "quantity": "200",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_touch_limit_orders)
+    if res.status_code == 200:
+        print('replace touch limit order res:', res.json())
+    sleep(5)
+
+    res = trade_client.order_v3.cancel_order(account_id, touch_limit_client_order_id)
+    if res.status_code == 200:
+        print('cancel touch limit order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, touch_limit_client_order_id)
+    if res.status_code == 200:
+        print('get touch limit order detail res:', res.json())
+
+    # ============================================================
+    # Trailing Stop Loss Order Example (HK Market)
+    # ============================================================
+    trailing_stop_loss_client_order_id = uuid.uuid4().hex
+    print('trailing stop loss client order id:', trailing_stop_loss_client_order_id)
+    new_trailing_stop_loss_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": trailing_stop_loss_client_order_id,
+            "symbol": "00700",
+            "instrument_type": "EQUITY",
+            "market": "HK",
+            "order_type": "TRAILING_STOP_LOSS",
+            "quantity": "200",
+            "trailing_stop_step": "0.1",
+            "trailing_type": "PERCENTAGE",
+            "support_trading_session": "CORE",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_trailing_stop_loss_orders)
+    if res.status_code == 200:
+        print('place trailing stop loss order res:', res.json())
+    sleep(5)
+
+    replace_trailing_stop_loss_orders = [
+        {
+            "client_order_id": trailing_stop_loss_client_order_id,
+            "stop_price": "560.47",
+            "quantity": "200",
+            "trailing_stop_step": "0.15",
+            "trailing_type": "PERCENTAGE",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_trailing_stop_loss_orders)
+    if res.status_code == 200:
+        print('replace trailing stop loss order res:', res.json())
+    sleep(5)
+
+    res = trade_client.order_v3.cancel_order(account_id, trailing_stop_loss_client_order_id)
+    if res.status_code == 200:
+        print('cancel trailing stop loss order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, trailing_stop_loss_client_order_id)
+    if res.status_code == 200:
+        print('get trailing stop loss order detail res:', res.json())
+
+    # ============================================================
+    # Trailing Stop Loss Limit Order Example (HK Market)
+    # ============================================================
+    trailing_stop_loss_limit_client_order_id = uuid.uuid4().hex
+    print('trailing stop loss limit client order id:', trailing_stop_loss_limit_client_order_id)
+    new_trailing_stop_loss_limit_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": trailing_stop_loss_limit_client_order_id,
+            "symbol": "00700",
+            "instrument_type": "EQUITY",
+            "market": "HK",
+            "order_type": "TRAILING_STOP_LOSS_LIMIT",
+            "quantity": "200",
+            "trailing_stop_step": "0.1",
+            "trailing_limit_price": "580",
+            "trailing_type": "PERCENTAGE",
+            "support_trading_session": "CORE",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_trailing_stop_loss_limit_orders)
+    if res.status_code == 200:
+        print('place trailing stop loss limit order res:', res.json())
+    sleep(5)
+
+    replace_trailing_stop_loss_limit_orders = [
+        {
+            "client_order_id": trailing_stop_loss_limit_client_order_id,
+            "stop_price": "560.77",
+            "quantity": "200",
+            "trailing_stop_step": "0.15",
+            "trailing_limit_price": "581",
+            "trailing_type": "PERCENTAGE",
+            "trigger_price_type": "PRICE"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_trailing_stop_loss_limit_orders)
+    if res.status_code == 200:
+        print('replace trailing stop loss limit order res:', res.json())
+    sleep(5)
+
+    res = trade_client.order_v3.cancel_order(account_id, trailing_stop_loss_limit_client_order_id)
+    if res.status_code == 200:
+        print('cancel trailing stop loss limit order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, trailing_stop_loss_limit_client_order_id)
+    if res.status_code == 200:
+        print('get trailing stop loss limit order detail res:', res.json())

webull/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.7'
+__version__ = '2.0.9'

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.0.7'
+__version__ = '2.0.9'
 
 import logging
 

webull/core/common/region.py

@@ -6,3 +6,7 @@ class Region(Enum):
     HK = 'hk'
     JP = 'jp'
     SG = 'sg'
+    TH = 'th'
+    AU = 'au'
+    MY = 'my'
+    UK = 'uk'

webull/core/data/endpoints.json

@@ -1,6 +1,6 @@
 {
     "default_region": "us",
-    "regions": ["us", "hk", "jp","sg"],
+    "regions": ["us", "hk", "jp", "sg", "th", "au", "my", "uk"],
     "region_mapping": {
         "us": {
             "api": "api.webull.com",
@@ -21,7 +21,26 @@
             "api": "api.webull.com.sg",
             "quotes-api": "data-api.webull.com.sg",
             "events-api": "events-api.webull.com.sg"
+        },
+        "th": {
+            "api": "api.webull.co.th",
+            "quotes-api": "data-api.webull.co.th",
+            "events-api": "events-api.webull.co.th"
+        },
+        "au": {
+            "api": "api.webull.com.au",
+            "quotes-api": "data-api.webull.com.au",
+            "events-api": "events-api.webull.com.au"
+        },
+        "my": {
+            "api": "api.webull.com.my",
+            "quotes-api": "data-api.webull.com.my",
+            "events-api": "events-api.webull.com.my"
+        },
+        "uk": {
+            "api": "api.webull-uk.com",
+            "quotes-api": "data-api.webull-uk.com",
+            "events-api": "events-api.webull-uk.com"
         }
     }
 }
-

webull/data/__init__.py

@@ -1,3 +1,3 @@
 # coding=utf-8
 
-__version__ = '2.0.7'
+__version__ = '2.0.9'

webull/data/data_client.py

@@ -23,6 +23,7 @@ from webull.data.quotes.event_market_data import EventMarketData
 from webull.data.quotes.futures_market_data import FuturesMarketData
 from webull.data.quotes.instrument import Instrument
 from webull.data.quotes.market_data import MarketData
+from webull.data.quotes.option_market_data import OptionMarketData
 from webull.data.quotes.screener import Screener
 from webull.data.quotes.watchlist import Watchlist
 
@@ -35,6 +36,7 @@ class DataClient:
         self.market_data = MarketData(api_client)
         self.crypto_market_data = CryptoMarketData(api_client)
         self.futures_market_data = FuturesMarketData(api_client)
+        self.option_market_data = OptionMarketData(api_client)
         self.event_market_data = EventMarketData(api_client)
         self.screener = Screener(api_client)
         self.watchlist = Watchlist(api_client)

webull/data/quotes/option_market_data.py

@@ -0,0 +1,71 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from webull.data.request.get_option_bars_request import GetOptionBarsRequest
+from webull.data.request.get_option_snapshot_request import GetOptionSnapshotRequest
+from webull.data.request.get_option_tick_request import GetOptionTickRequest
+
+
+class OptionMarketData:
+    def __init__(self, api_client):
+        self.client = api_client
+
+    def get_option_history_bars(self, symbols, category, timespan, count='200', real_time_required=None):
+        """
+        Batch query K-line data for multiple option symbols, returning aggregated data within the window.
+        According to the last N K-lines of the option code, it supports various granularity K-lines such as m1 and m5.
+
+        :param symbols: List of option security codes
+        :param category: Security type, enumeration
+        :param timespan: K-line interval
+        :param count: Number of K-lines to return, default is 200, maximum is 1200
+        :param real_time_required: Returns the latest trade quote data. By default, the most recent market data is returned.
+        """
+        history_bar_request = GetOptionBarsRequest()
+        history_bar_request.set_symbols(symbols)
+        history_bar_request.set_category(category)
+        history_bar_request.set_timespan(timespan)
+        history_bar_request.set_count(count)
+        history_bar_request.set_real_time_required(real_time_required)
+        response = self.client.get_response(history_bar_request)
+        return response
+
+    def get_option_tick(self, symbol, category, count='30'):
+        """
+        Query tick-by-tick transaction of options according to the option code list.
+
+        :param symbol: Option securities code
+        :param category: Security type, enumeration.
+        :param count: The number of lines: the default is 30, and the maximum limit is 1200
+        """
+        tick_request = GetOptionTickRequest()
+        tick_request.set_symbol(symbol)
+        tick_request.set_category(category)
+        tick_request.set_count(count)
+        response = self.client.get_response(tick_request)
+        return response
+
+    def get_option_snapshot(self, symbols, category):
+        """
+        Query the latest option market snapshots in batches according to the option code list.
+
+        :param symbols: List of option security codes; for example: single: AAPL260522C00300000 multiple: AAPL260522C00300000,TSLA251219C00450000;
+        For each request,up to 20 symbols can be subscribed
+        :param category: Security type, enumeration.
+        """
+        snapshot_request = GetOptionSnapshotRequest()
+        snapshot_request.set_symbols(symbols)
+        snapshot_request.set_category(category)
+        response = self.client.get_response(snapshot_request)
+        return response

webull/data/request/get_option_bars_request.py

@@ -0,0 +1,73 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+
+class GetOptionBarsRequest(ApiRequest):
+    """
+    Request class for querying historical bars for options.
+    Batch query interface to retrieve the last N bars based on option codes, 
+    time granularity, and type. Supports various granularities like M1, M5, etc.
+    """
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/option/bars", version='v2', method="GET", query_params={})
+
+    def set_symbols(self, symbols):
+        """
+        Set option symbols.
+        
+        :param symbols: List of option symbols, separated by commas; maximum 20 symbols per query.
+                       Example: "AAPL,TSLA" or ["AAPL", "TSLA"]
+        """
+        if isinstance(symbols, str):
+            self.add_query_param("symbols", symbols)
+        elif isinstance(symbols, list):
+            self.add_query_param("symbols", ",".join(symbols))
+
+    def set_category(self, category):
+        """
+        Set security type.
+        
+        :param category: Security type. Currently only US_OPTION is supported.
+        """
+        self.add_query_param("category", category)
+
+    def set_timespan(self, timespan):
+        """
+        Set bar time granularity.
+        
+        :param timespan: Bar time granularity, e.g., M1, M5, M15, M30, M60, M120, M240, D, W, M, Y
+        """
+        self.add_query_param("timespan", timespan)
+
+    def set_count(self, count='200'):
+        """
+        Set number of bars to return.
+        
+        :param count: Number of bars, default is 200, maximum is 1200.
+        """
+        self.add_query_param("count", count)
+
+    def set_real_time_required(self, real_time_required):
+        """
+        Set whether to include the latest data.
+        
+        :param real_time_required: Whether to include the latest data, default is false.
+        """
+        if real_time_required is not None:
+            self.add_query_param("real_time_required", real_time_required)

webull/data/request/get_option_snapshot_request.py

@@ -0,0 +1,48 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+
+class GetOptionSnapshotRequest(ApiRequest):
+    """
+    Request class for querying real-time quote snapshots for options.
+    Returns key market indicators for specified options, including the latest price,
+    price change percentage, trading volume, turnover rate, and best bid/ask quotes.
+    """
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/option/snapshot", version='v2', method="GET", query_params={})
+
+    def set_symbols(self, symbols):
+        """
+        Set option symbols.
+        
+        :param symbols: List of option symbols, separated by commas; maximum 20 symbols per query.
+                       Example: "AAPL260522C00300000,TSLA251219C00450000" or ["AAPL260522C00300000", "TSLA251219C00450000"]
+        """
+        if isinstance(symbols, str):
+            self.add_query_param("symbols", symbols)
+        elif isinstance(symbols, list):
+            self.add_query_param("symbols", ",".join(symbols))
+
+    def set_category(self, category):
+        """
+        Set security type.
+        
+        :param category: Security type. Currently only US_OPTION is supported.
+        """
+        self.add_query_param("category", category)

webull/data/request/get_option_tick_request.py

@@ -0,0 +1,52 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+
+class GetOptionTickRequest(ApiRequest):
+    """
+    Request class for querying option tick data.
+    Returns detailed tick-by-tick trade records for a specified option code,
+    including trade time, price, volume, and trade direction.
+    """
+
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/market-data/option/tick", version='v2', method="GET", query_params={})
+
+    def set_symbol(self, symbol):
+        """
+        Set option symbol.
+        
+        :param symbol: Option symbol.
+        """
+        self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        """
+        Set security type.
+        
+        :param category: Security type. Currently only US_OPTION is supported.
+        """
+        self.add_query_param("category", category)
+
+    def set_count(self, count='30'):
+        """
+        Set number of ticks to return.
+        
+        :param count: Number of ticks, default is 30, maximum is 1200.
+        """
+        self.add_query_param("count", count)

webull/trade/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.7'
+__version__ = '2.0.9'

webull/trade/trade/v2/account_info_v2.py

@@ -25,7 +25,7 @@ class AccountV2:
 
     def get_account_list(self):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         account_list = GetAccountListRequest()
@@ -34,7 +34,7 @@ class AccountV2:
 
     def get_account_balance(self, account_id):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         account_balance_request = AccountBalanceRequest()
@@ -44,7 +44,7 @@ class AccountV2:
 
     def get_account_position(self, account_id):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         account_positions_request = AccountPositionsRequest()

webull/trade/trade/v3/order_opration_v3.py

@@ -28,7 +28,7 @@ class OrderOperationV3:
 
     def preview_order(self, account_id, preview_orders, client_combo_order_id=None):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         preview_order_request = PreviewOrderRequest()
@@ -40,7 +40,7 @@ class OrderOperationV3:
 
     def place_order(self, account_id, new_orders, client_combo_order_id=None):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         place_order_request = PlaceOrderRequest()
@@ -65,7 +65,7 @@ class OrderOperationV3:
 
     def replace_order(self, account_id, modify_orders, client_combo_order_id=None):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         replace_order_request = ReplaceOrderRequest()
@@ -77,7 +77,7 @@ class OrderOperationV3:
 
     def cancel_order(self, account_id, client_order_id):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         cancel_order_request = CancelOrderRequest()
@@ -88,7 +88,7 @@ class OrderOperationV3:
 
     def get_order_detail(self, account_id, client_order_id):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
         """
         order_detail_request = OrderDetailRequest()
@@ -99,7 +99,7 @@ class OrderOperationV3:
 
     def get_order_history(self, account_id, page_size=None, start_date=None, end_date=None, last_client_order_id=None):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
 
         Historical orders. If they are group orders, will be returned together,
@@ -127,7 +127,7 @@ class OrderOperationV3:
 
     def get_order_open(self, account_id, page_size=None, last_client_order_id=None):
         """
-        This interface is currently supported only for Webull HK, Webull US, and Webull JP, and Webull SG, and Webull SG.
+        This interface is currently supported only for Webull HK, Webull US, Webull JP, Webull SG, Webull TH, Webull AU, Webull MY, Webull UK.
         Support for other regions will be available in future updates.
 
         Paging query pending orders.

{webull_openapi_python_sdk-2.0.7.dist-info → webull_openapi_python_sdk-2.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webull-openapi-python-sdk
-Version: 2.0.7
+Version: 2.0.9
 Summary: Webull Python SDK.
 Home-page: 
 Author: Webull

{webull_openapi_python_sdk-2.0.7.dist-info → webull_openapi_python_sdk-2.0.9.dist-info}/RECORD

@@ -1,10 +1,10 @@
-samples/__init__.py,sha256=Eqd_jrp6aA0AOwkbRY6r2MSGXmOOkqUkdUqKDmktZJM,22
+samples/__init__.py,sha256=YHfSoqxCUyNphrTJsW3Ed3e2IVM5_H1IYKii1J5IND4,22
 samples/account/__init__.py,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 samples/account/account_client.py,sha256=vwh-nI_JnjwcIeOr1sQPMzG8pAqZwliUusE49ZmYE3s,1796
 samples/assets/__init__.py,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 samples/assets/assets_client.py,sha256=p9LS2Td3gbUMkHn4LD_9RMCFuaQRUbsKvG4PhZBGJDc,1974
 samples/data/__init__.py,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
-samples/data/data_client.py,sha256=7H1uGWKXeU1DHC1X6XYpf1SaaykbbLJBvr7psI6PlKs,6672
+samples/data/data_client.py,sha256=nvKj5zQ9vd1gNkwRV0MMP_J2-QK1TP_7BlGeHRok79w,7518
 samples/data/data_client_event.py,sha256=u6Bebo2hTE0Ri1bQHa8nhFEe-fBbdxfNwLpTZh3E1WY,3046
 samples/data/data_streaming_client.py,sha256=2da21SE_Mneo7zbM_l1rkpdBBbI4avrpnSPMxsZIalw,4085
 samples/data/data_streaming_client_async.py,sha256=o_u1ch8JdbcYnLCvDCCUzO-Z1IG7BUKncu_GB_kCbOs,4443
@@ -17,13 +17,13 @@ samples/screener/screener_client.py,sha256=NGwjY7YaG_3l9c-QePpmpPG4Gtk_BZaM7-jQb
 samples/trade/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 samples/trade/trade_client.py,sha256=LyWSvZJH4ByCkRORqP9WdkXfx65A2b6fhc9_GzL8DOM,6258
 samples/trade/trade_client_v2.py,sha256=IO-zmRiUnCmIetTdiYunPh8jVK2VaPrOR77Dwvz1auY,10771
-samples/trade/trade_client_v3.py,sha256=WYGL3f0V-bDqeT0z5Qg0xbzCQtCdiHn7dM589DiEhfc,19386
+samples/trade/trade_client_v3.py,sha256=YT9MUkxHttLmI_mCTK1olAIbWC48oi0DUF1Ig2EoFBI,31909
 samples/trade/trade_client_v3_event.py,sha256=91HlT04KlK8Q5gUnsB8F5ErCFdJRnpDABKkBfYRc-YE,3932
 samples/trade/trade_event_client.py,sha256=BWdD1L41LXmDlaig6ku9T3t3fSCCZEdj5nxH1xI1AZA,2653
 samples/watchlist/__init__.py,sha256=rtV5s4_CJgDAT4DGEJa_pNLJU71Wdr5OLz_IQ1EajFQ,567
 samples/watchlist/watchlist_client.py,sha256=lpzJs7SXuSka2KKkJ0u9s83A9iHta5qrjvIdkbfNcwg,3246
-webull/__init__.py,sha256=Eqd_jrp6aA0AOwkbRY6r2MSGXmOOkqUkdUqKDmktZJM,22
-webull/core/__init__.py,sha256=P6HyssmMpnvnyiBdmTTmwJ4Hvu3pmR6nn9bxyi7CNG4,225
+webull/__init__.py,sha256=YHfSoqxCUyNphrTJsW3Ed3e2IVM5_H1IYKii1J5IND4,22
+webull/core/__init__.py,sha256=zyQxIey4b1weHFMUbMDgFE9DW_WcYZC6lHL7ke1hQCo,225
 webull/core/client.py,sha256=zxSBiII9KDxc5tHpTerJfV_PKPt8E9e3oTOpiakAtJw,16758
 webull/core/compat.py,sha256=_r6Y_f3vTo_DoxOaCvLjnvOo1KRkD2Z9kXSh8OijEIA,3088
 webull/core/headers.py,sha256=Wj2zev1XYyYsy2b9YKnoK3GqjVsXZO_o2WziMmuVBTw,2061
@@ -44,10 +44,10 @@ webull/core/cache/__init__.py,sha256=_dME59dRIinH4PXhB3ZOtlN-3J57mFfhegzuFKVedWs
 webull/core/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 webull/core/common/api_type.py,sha256=rXYvwiJs71AX7exvD_szbXcv3UW50V7_ve8ModpkAiM,643
 webull/core/common/easy_enum.py,sha256=3PorEZPQgBT7uFwtNplpwZ9oi76CCwgKIZ0jRiybZYw,1047
-webull/core/common/region.py,sha256=CwUurkJVnUWRD50aVZoDNdRBGLecv68179KkexiYaec,100
+webull/core/common/region.py,sha256=36Y4jB6im219SPo94PmQIFXK_ek2e3JdGH5VK_gyzU0,156
 webull/core/context/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 webull/core/context/request_context_holder.py,sha256=41aSKMtOkS0yHVvMMmP2vjsMg3WHvDPe3_njT0hwi_4,1148
-webull/core/data/endpoints.json,sha256=Ln5awMOVWtpFqsfD-ggshg6wD8M-ZYmrIu0APF-daeo,766
+webull/core/data/endpoints.json,sha256=ABcCEFypqUlh6A80AuSaxH-Ikrj2yV49BZAmIkezY00,1475
 webull/core/data/retry_config.json,sha256=aRKrBfZyLrXt_58LCt7VvunQoxXS_qGon4JGGZnB644,304
 webull/core/endpoint/__init__.py,sha256=hC_6UsVc7NGxD21gMT4i42Crm2zN4K-IAU4zxkLysVo,153
 webull/core/endpoint/chained_endpoint_resolver.py,sha256=YQ-K7w9P3UolgiH0UdXiKsG4ALSManebWlZHeZjxSjY,2256
@@ -89,8 +89,8 @@ webull/core/utils/common.py,sha256=T5VVcYQVhA9fhiUHZN9gBuoh0uzVgbCM01o1qK08NAE,2
 webull/core/utils/data.py,sha256=YUyoWY68_2RkKanh3jsDscgGx__FIPh5VNEGXr1Qotc,852
 webull/core/utils/desensitize.py,sha256=f8_ps9BrG3WfXD8ZAw873-_YoGeke1Q55CeDwRmYkqA,1104
 webull/core/utils/validation.py,sha256=gJcIrHYtgo48yVJ0q6O-f5buTYWOcr6ShhDIBhTp-Yg,1957
-webull/data/__init__.py,sha256=E0G1HBxSnLY_6pVD-FW8RwpEJMoXIAB9ub-e38-q0IY,38
-webull/data/data_client.py,sha256=5lMvWswwnL3gwjGKGWo5MYjJGzfmDlOoyS_wq5sZRKQ,2189
+webull/data/__init__.py,sha256=tbVcOxrB2y05ELvQkUB_Wb5L014BZpLDyROxiUxu5FY,38
+webull/data/data_client.py,sha256=tH0HrjRkP1sKEZ5Q8w1wCE2XaEqdy0_4EEvm60h4r28,2319
 webull/data/data_streaming_client.py,sha256=TQBAilvOLCbcMqacByrniXGr9VjSwjym-4-LUOiqKx8,4456
 webull/data/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 webull/data/common/category.py,sha256=8mtq9J9aiNan1CkwgfqRnggdH0tENyhJBJ2HI3EkUHE,978
@@ -118,6 +118,7 @@ webull/data/quotes/futures_market_data.py,sha256=fc9giYNy1LcdLHOJV31zMbPBKtWDH8k
 webull/data/quotes/instrument.py,sha256=BHQ4INg3ct2b0E22E6IHMtYz47q8hA3HIf1wzbw6Ns4,12665
 webull/data/quotes/market_data.py,sha256=L7f5V5tmG01lev9-IJU3w6up7EnX42WfI7GtW2mEcw8,14748
 webull/data/quotes/market_streaming_data.py,sha256=cI9xxGpKV_KDS8cgh9azHifBji0yeSuKmH7Jxaqij38,3139
+webull/data/quotes/option_market_data.py,sha256=4fW_GI3u1T-5dluhLRQ60Gbb2bsnhWkSrILYJq-96pw,3305
 webull/data/quotes/screener.py,sha256=PkSQzu3nq26Vkob2IhZH2VvHswqyHcYMxELoP1Yb1N0,5289
 webull/data/quotes/watchlist.py,sha256=RkuPV7OwC6e4NEpeldTUNWEsYAqGQbVqyOHs9edMuhE,6344
 webull/data/quotes/subscribe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -171,6 +172,9 @@ webull/data/request/get_historical_bars_request.py,sha256=xClCvnUyzfj9DeCxxOGzs0
 webull/data/request/get_instruments_request.py,sha256=PmDXrv9hUTHNtwppjV6GMQqTcNPFFVG_LAbW2Ub4cvw,1520
 webull/data/request/get_noii_bars_request.py,sha256=_ubNykIQCCDg9cRgeR49FVloF21s2REWlp_KTnUlYEg,1845
 webull/data/request/get_noii_snapshot_request.py,sha256=IQ2HrAyyO2GzC8HEsjz4S0Owc0Zk25d-1ULjTqThmZU,2057
+webull/data/request/get_option_bars_request.py,sha256=ObE4blYHZ_OcKG8Cp6St7ujDTIFIZyBP4MGhx8k9X6k,2556
+webull/data/request/get_option_snapshot_request.py,sha256=XHmtHKN8fF6-rIWfstFr_bLFtgEIx-u61H6Y7WnOrlE,1816
+webull/data/request/get_option_tick_request.py,sha256=MuSFYnM8m1UwOJ2NjzhOJYlWhbYDyiqPbNkKoPQUupI,1648
 webull/data/request/get_quotes_request.py,sha256=g4J7lAQZBqoeM67Xm2E-Y2pwNxsqkrECf_r5DTTrS5M,1244
 webull/data/request/get_snapshot_request.py,sha256=OD2PiaxmBCboFDaU8DFTwvfNd2zObYSnPfl1fa49DIs,1471
 webull/data/request/get_tick_request.py,sha256=rUHhQgC8Z_6ensLyCkg3DDK55SlEi0Bc_dhpCIIspDs,1366
@@ -188,7 +192,7 @@ webull/data/request/watchlist/get_watchlist_request.py,sha256=XxzS4gxFbdQSajpFSm
 webull/data/request/watchlist/remove_watchlist_instruments_request.py,sha256=qOtQYDBp-PSawAgljnLmtfUce8dAblWI_zB0nnIv3G0,1451
 webull/data/request/watchlist/update_watchlist_instruments_request.py,sha256=KoihfB8MszsAooQGUUMjFmnid_a7xk4YSdEMDO1gh-k,1493
 webull/data/request/watchlist/update_watchlist_request.py,sha256=0s3ftkxiz9hjtXhLORrIUphyDIldRA8pJ4mP5zfbsyU,1466
-webull/trade/__init__.py,sha256=XrDu8k_IxSYdWR9fdENgQaVLDoDnh9VjrAmupbj-Ozw,21
+webull/trade/__init__.py,sha256=Fz9FyyzdwMvsPPrB8DkVnD9wNalmr9HSvhN897_GWPc,21
 webull/trade/trade_client.py,sha256=_6lH4KO-jKgKWU28fWNsc9-KEHto-WvaP0gT96BJ_dw,2184
 webull/trade/trade_events_client.py,sha256=G9ovuxrnQh8iA1so2Ar-41jWRzDCYQYSHTkQLGlwhhA,9983
 webull/trade/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -266,13 +270,13 @@ webull/trade/trade/order_operation.py,sha256=QrL4Da87RTOSupiAbuXtZigo9602Byp14DQ
 webull/trade/trade/trade_calendar.py,sha256=rGSiR5GZggQnZOmmpbC-06trgPQgFTvdpUzGMpw2ycw,1415
 webull/trade/trade/trade_instrument.py,sha256=293IaiLnhw0mAc1IuF3LSgwgve_XZ1Dyf1VeFtmClc8,3474
 webull/trade/trade/v2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webull/trade/trade/v2/account_info_v2.py,sha256=YXDEejg7spwg4j2wd25SQdVyHWMqasO4J9QDP56rY8s,3036
+webull/trade/trade/v2/account_info_v2.py,sha256=rLjNipJgF0lyqPafPjtQK1gItyye7tT5AJ3vGGtWuMU,3144
 webull/trade/trade/v2/order_operation_v2.py,sha256=m54RH2j45CBBWEnqe4KxrsltAF44XKtPMT4kv8t7djQ,12745
 webull/trade/trade/v3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webull/trade/trade/v3/order_opration_v3.py,sha256=ZWxlIkoD5Dk8G-gRD04UeCrLQHbFQZL-8H5yOEdIIR4,7730
-webull_openapi_python_sdk-2.0.7.dist-info/licenses/LICENSE,sha256=ALOnsLtb1aHxmDJg3-oMi0BO-i-cjfyZaOBfnnavKMc,11359
-webull_openapi_python_sdk-2.0.7.dist-info/licenses/NOTICE,sha256=X5TApte6CPV10b96Cb70IRLusXmiRmK_R-dB-1tQM_I,2018
-webull_openapi_python_sdk-2.0.7.dist-info/METADATA,sha256=GAbdm1NDSHxawBt9_8FEz3xGFuN_JRLMgEwz2NGBceM,1032
-webull_openapi_python_sdk-2.0.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-webull_openapi_python_sdk-2.0.7.dist-info/top_level.txt,sha256=h8pEjNDGWS2ZUZ2vYFpUShoMQT0ZRIQaD57QJWD8_aI,15
-webull_openapi_python_sdk-2.0.7.dist-info/RECORD,,
+webull/trade/trade/v3/order_opration_v3.py,sha256=1msk2tG9XBBPwFTlYEPpQ2feu0Pq6T7AlnO5n9uQ87M,7967
+webull_openapi_python_sdk-2.0.9.dist-info/licenses/LICENSE,sha256=ALOnsLtb1aHxmDJg3-oMi0BO-i-cjfyZaOBfnnavKMc,11359
+webull_openapi_python_sdk-2.0.9.dist-info/licenses/NOTICE,sha256=X5TApte6CPV10b96Cb70IRLusXmiRmK_R-dB-1tQM_I,2018
+webull_openapi_python_sdk-2.0.9.dist-info/METADATA,sha256=BKHNU_5dIOz0oA24le9nKhnDf3hZ4IJD-xwlTxogghg,1032
+webull_openapi_python_sdk-2.0.9.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+webull_openapi_python_sdk-2.0.9.dist-info/top_level.txt,sha256=h8pEjNDGWS2ZUZ2vYFpUShoMQT0ZRIQaD57QJWD8_aI,15
+webull_openapi_python_sdk-2.0.9.dist-info/RECORD,,