Merge branch 'main_merge_260718' into 'main'

[OpenAPI&FIX-260718 version]: 【Trading API】支持期权合约档案接口

See merge request webull/webull-openapi-python-sdk!37

Author: 方佳

README.md

@@ -32,7 +32,7 @@ Subscription to real-time information: Subscribe to order status changes, market
 | Webull MX | https://www.webull.com.mx/open-api-management   |
 | Webull ZA | https://www.webull.co.za/open-api-management    |
 | Webull EU | https://www.webull.eu/open-api-management       |
-- Requires Python 3.8 through 3.13.
+- Requires Python 3.8 through 3.14.
 
 ## Interface Protocol
 

samples/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.13'
+__version__ = '2.0.14'

samples/data/data_client.py

@@ -265,6 +265,11 @@
     if res.status_code == 200:
         print('get_forecast_eps:', res.json())
 
+    # Option Instrument - Query option contracts by underlying symbol and filters
+    res = data_client.instrument.get_option_contracts(Category.US_OPTION.name,"AAPL")
+    if res.status_code == 200:
+        print('get_option_contracts:', res.json())
+
     # Screener - Market Sectors
     res = data_client.screener.get_market_sectors(Category.US_STOCK.name)
     if res.status_code == 200:

setup.py

@@ -24,25 +24,28 @@
 
     # cryptography
     "cryptography>=3.4,<42; python_version<'3.12'",
-    "cryptography>=41.0,<43; python_version>='3.12'",
+    "cryptography>=41.0,<43; python_version>='3.12' and python_version<'3.14'",
+    "cryptography>=43.0,<55; python_version>='3.14'",
 
     # protobuf
     "protobuf>=4.21.12,<5; python_version<'3.12'",
     "protobuf>=4.25.0,<6; python_version>='3.12'",
 
     # grpc
     "grpcio>=1.51.1,<1.60; python_version<'3.12'",
-    "grpcio>=1.60.0,<1.70; python_version>='3.12'"
+    "grpcio>=1.60.0,<1.70; python_version>='3.12' and python_version<'3.14'",
+    "grpcio>=1.75.1,<2; python_version>='3.14'"
 ]
 
 extras_require = {
     "dev": [
-        "grpcio-tools>=1.60,<1.70",
+        "grpcio-tools>=1.60,<1.70; python_version<'3.14'",
+        "grpcio-tools>=1.75.1,<2; python_version>='3.14'",
     ]
 }
 
 setup_args = {
-    'python_requires':'>=3.8,<3.14',
+    'python_requires':'>=3.8,<3.15',
     'version': VERSION,
     'author': AUTHOR,
     'author_email': AUTHOR_EMAIL,

webull/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.13'
+__version__ = '2.0.14'

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.0.13'
+__version__ = '2.0.14'
 
 import logging
 

webull/core/auth/composer/default_signature_composer.py

@@ -59,10 +59,7 @@ def _refresh_sign_headers(host, headers, app_key_id, signer_spec):
     sign_headers[hd.APP_KEY] = app_key_id
     sign_headers[hd.TIMESTAMP] = common.get_iso_8601_date()
 
-    if common.is_not_upgrade_api_host(host):
-        signer_spec = sha_hmac256_new
-    else:
-        signer_spec = sha_hmac1
+    signer_spec = sha_hmac256_new
 
     sign_headers[hd.SIGN_VERSION] = signer_spec.get_signer_version()
     sign_headers[hd.SIGN_ALGORITHM] = signer_spec.get_signer_name()

webull/core/utils/common.py

@@ -16,7 +16,7 @@
 import base64
 import hashlib
 import socket
-from datetime import datetime
+from datetime import datetime, timezone
 import uuid
 import json
 from webull.core.compat import ensure_bytes, ensure_string
@@ -33,21 +33,21 @@ def get_uuid():
 def get_iso_8601_date(dt_as_utc=None):
     if dt_as_utc:
         return dt_as_utc.strftime(FORMAT_ISO_8601)
-    d = datetime.utcnow()
+    d = datetime.now(timezone.utc)
     return d.strftime(FORMAT_ISO_8601)
 
 def get_iso_8601_date_with_millis(dt_as_utc=None):
     if dt_as_utc:
         d = dt_as_utc
     else:
-        d = datetime.utcnow()
+        d = datetime.now(timezone.utc)
     ret = d.strftime(FORMAT_ISO_8601_MILLIS)
     if len(ret) != 27:
         raise RuntimeError("failed to convent timestamp, result: %s" % ret)
     return ret[:-4] + ret[-1:]
 
 def parse_timestamp_to_dt(timestamp_of_millis):
-    return datetime.utcfromtimestamp(timestamp_of_millis / 1000.0)
+    return datetime.fromtimestamp(timestamp_of_millis / 1000.0, tz=timezone.utc).replace(tzinfo=None)
 
 def md5_sum(content):
     content_bytes = ensure_bytes(content)
@@ -63,17 +63,4 @@ def sha256_hex(content):
     return hashlib.sha256(content_bytes).hexdigest()
 
 def json_dumps_compact(content):
-    return json.dumps(content, ensure_ascii=False, separators=(',', ':'))
-
-def is_not_upgrade_api_host(host):
-    upgrade_hosts = {
-        "api.webull.com","events-api.webull.com",
-        "api.webull.hk","events-api.webull.hk",
-        "pre-openapi-us-alb.webullbroker.com","pre-openapi-us-events.webullbroker.com",
-        "pre-openapi-alb.webullbroker.com","pre-openapi-events.webullbroker.com",
-        "us-openapi-alb.uat.webullbroker.com","us-openapi-events.uat.webullbroker.com",
-        "hk-openapi.uat.webullbroker.com", "hk-openapi-events-api.uat.webullbroker.com",
-        "api.sandbox.webull.hk", "events-api.sandbox.webull.hk"
-
-    }
-    return host not in upgrade_hosts
+    return json.dumps(content, ensure_ascii=False, separators=(',', ':'))

webull/data/__init__.py

@@ -1,3 +1,3 @@
 # coding=utf-8
 
-__version__ = '2.0.13'
+__version__ = '2.0.14'

webull/data/quotes/instrument.py

@@ -25,6 +25,7 @@
 from webull.data.request.get_futures_products_request import GetFuturesProductsRequest
 from webull.data.request.get_futures_instruments_by_code_request import GetFuturesInstrumentsByCodeRequest
 from webull.data.request.get_futures_product_class import GetFuturesProductClassRequest
+from webull.data.request.get_option_contracts_request import GetOptionContractsRequest
 
 
 class Instrument:
@@ -218,6 +219,48 @@ def get_event_instrument(self, series_symbol, event_symbol=None, symbols=None, e
         response = self.client.get_response(event_instrument_request)
         return response
 
+    def get_option_contracts(self, category=Category.US_OPTION.name, underlying_symbols=None, status=None,
+                               start_date=None, end_date=None, root_symbol=None, option_symbol=None,
+                               option_type=None, style=None, strike_price_gte=None, strike_price_lte=None,
+                               ppind=None, show_deliverables=None, page_size=10, last_instrument_id=None):
+        """
+        Query option contracts list by conditions such as underlying_symbols, status, expiration date, etc.
+
+        :param category: Market category. Value: US_OPTION.
+        :param underlying_symbols: Underlying symbol(s), comma-separated for multiple, e.g. AAPL,MSFT.
+        :param status: Contract status: LISTING (default), DELISTING.
+        :param start_date: Exact expiration date, format YYYY-MM-DD.
+        :param end_date: Expiration date lower bound (inclusive), format YYYY-MM-DD.
+        :param root_symbol: Root symbol filter (series symbol, e.g. SPXW), mainly for index options and non-standard contracts after CA.
+        :param option_symbol: Option symbol, e.g. AAPL250620C00150000.
+        :param option_type: Contract type: CALL / PUT.
+        :param style: Exercise style: AMERICAN / EUROPEAN.
+        :param strike_price_gte: Strike price lower bound (inclusive).
+        :param strike_price_lte: Strike price upper bound (inclusive).
+        :param ppind: Penny Program Indicator: true = Penny Pilot, false = non-Penny Pilot.
+        :param show_deliverables: Whether to return deliverables array in response: true / false, default false.
+        :param page_size: Page size, default 10, max 1000.
+        :param last_instrument_id: Last instrument_id from previous page for pagination.
+        """
+        request = GetOptionContractsRequest()
+        request.set_category(category)
+        request.set_underlying_symbols(underlying_symbols)
+        request.set_status(status)
+        request.set_start_date(start_date)
+        request.set_end_date(end_date)
+        request.set_root_symbol(root_symbol)
+        request.set_option_symbol(option_symbol)
+        request.set_option_type(option_type)
+        request.set_style(style)
+        request.set_strike_price_gte(strike_price_gte)
+        request.set_strike_price_lte(strike_price_lte)
+        request.set_ppind(ppind)
+        request.set_show_deliverables(show_deliverables)
+        request.set_page_size(page_size)
+        request.set_last_instrument_id(last_instrument_id)
+        response = self.client.get_response(request)
+        return response
+
     def get_company_profile(self, symbol, category=Category.US_STOCK.name):
         """
         Get company profile for one instrument.