webull-openapi-python-sdk 2.0.7__tar.gz → 2.0.9__tar.gz

{webull_openapi_python_sdk-2.0.7 → webull_openapi_python_sdk-2.0.9}/PKG-INFO

@@ -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.9/samples/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.0.9'

{webull_openapi_python_sdk-2.0.7 → webull_openapi_python_sdk-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())

{webull_openapi_python_sdk-2.0.7 → webull_openapi_python_sdk-2.0.9}/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_openapi_python_sdk-2.0.9/webull/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.0.9'

{webull_openapi_python_sdk-2.0.7 → webull_openapi_python_sdk-2.0.9}/webull/core/__init__.py

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

{webull_openapi_python_sdk-2.0.7 → webull_openapi_python_sdk-2.0.9}/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_openapi_python_sdk-2.0.9/webull/core/data/endpoints.json

@@ -0,0 +1,46 @@
+{
+    "default_region": "us",
+    "regions": ["us", "hk", "jp", "sg", "th", "au", "my", "uk"],
+    "region_mapping": {
+        "us": {
+            "api": "api.webull.com",
+            "quotes-api": "data-api.webull.com",
+            "events-api": "events-api.webull.com"
+        },
+        "hk": {
+            "api": "api.webull.hk",
+            "quotes-api": "data-api.webull.hk",
+            "events-api": "events-api.webull.hk"
+        },
+        "jp": {
+            "api": "api.webull.co.jp",
+            "quotes-api": "data-api.webull.co.jp",
+            "events-api": "events-api.webull.co.jp"
+        },
+        "sg": {
+            "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_openapi_python_sdk-2.0.9/webull/data/__init__.py

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

{webull_openapi_python_sdk-2.0.7 → webull_openapi_python_sdk-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_openapi_python_sdk-2.0.9/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_openapi_python_sdk-2.0.9/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_openapi_python_sdk-2.0.9/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)