Merge branch 'main_merge_260725' into 'main'

feat:Add option event subscribe

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

Author: 方佳

.github/workflows/pypi-ci.yml

@@ -1,12 +1,12 @@
 name: PyPI-CI
 
-# 点击star即可构建
+# star build
 
 # on:
 #   watch:
 #     types: started
 
-# push 到main分支才会构建，忽略docs/**和LICENSE等目录
+# push to main branch for build, ignore docs/** and LICENSE dir
 on:
  push:
    branches:

.kiro/steering/sdk-development.md

@@ -0,0 +1,55 @@
+# Webull SDK Development Specification
+
+## New API Interface Development Process
+
+When adding a new API interface, the following steps must be completed:
+
+### 1. Request Class (Request)
+- File path: `webull/data/request/` or `webull/trade/request/`
+- Inherit from `ApiRequest`
+- Define the API path, version, and HTTP method in `__init__`
+- **Must specify the `version='v2'` parameter**
+- Provide `set_xxx()` methods to set parameters
+- Use `add_query_param()` for GET requests
+- Use `add_body_params()` for POST requests
+
+#### Request Class Example
+```python
+class GetExampleRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/xxx/example", version="v2", method="GET", query_params={})
+```
+
+### 2. Business Implementation Class
+- File path: `webull/data/quotes/` or `webull/trade/trade/`
+- Accept `api_client` as a constructor parameter
+- Each method corresponds to one API interface
+- Create the corresponding Request object, set its parameters, and call `self.client.get_response(request)`
+- Write detailed docstring documentation
+
+### 3. Client Registration
+- Register the new business class in `DataClient` or `TradeClient`
+- Add the corresponding import statement
+
+### 4. Sample Code (Required)
+- File path: the corresponding module folder under `samples/`
+- Include a complete usage example
+- Include necessary comments and explanations
+
+### 5. Commit Code (Required)
+- After completing all the steps above, the code must be committed as a git commit
+- The commit message must be written in English
+
+## Code Style
+
+- Use the Apache 2.0 license header
+- `# coding=utf-8` encoding declaration
+- Detailed docstring documentation
+- Perform parameter validation in the set methods
+- **Code comments must be in English; Chinese comments are not allowed**
+
+## Module Organization Principles
+
+- Related interfaces should be placed in the same business class
+- Different types of interfaces (e.g., news, quotes, trading) should be managed separately
+- When creating a new module, also create the corresponding sample code directory

samples/__init__.py

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

samples/trade/activities_client.py

@@ -15,7 +15,7 @@
 import logging
 
 from webull.trade.events.types import ORDER_STATUS_CHANGED, EVENT_TYPE_ORDER, EVENT_TYPE_POSITION, \
-    POSITION_STATUS_CHANGED
+    POSITION_STATUS_CHANGED, EVENT_TYPE_OPTION, OPTION_STATUS_CHANGED
 from webull.trade.trade_events_client import TradeEventsClient
 
 your_app_key = "<your_app_key>"
@@ -35,6 +35,8 @@ def my_on_events_message(event_type, subscribe_type, payload, raw_message):
         print(payload)
     if EVENT_TYPE_POSITION == event_type and POSITION_STATUS_CHANGED == subscribe_type:
         print('event payload:%s' % payload)
+    if EVENT_TYPE_OPTION == event_type and OPTION_STATUS_CHANGED == subscribe_type:
+        print('option payload:%s' % payload)
 
 if __name__ == '__main__':
 

samples/trade/trade_event_client.py

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

webull/__init__.py

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

webull/core/__init__.py

@@ -21,11 +21,9 @@ def desensitize_token(token, keep_length=6, mask_length=6):
 
     total_length = len(token)
 
-    # 如果字符串长度不足需要保留长度的两倍，则返回全部内容
     if total_length <= keep_length * 2:
         return token
 
-    # 提取前保留部分、后保留部分，并用星号连接
     front_part = token[:keep_length]
     rear_part = token[-keep_length:] if keep_length > 0 else ''
     mask = '*' * mask_length

webull/core/utils/desensitize.py

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

webull/data/__init__.py

@@ -27,7 +27,7 @@ def subscribe(self, session_id, symbols, category, sub_types, depth=None, overni
        :param session_id: Create the sessionId used for the connection
        :param symbols: Such as: [AAPL,TSLA]
        :param category: Security type, enumeration
-       :param sub_types: Unsubscribe data type, such as: [SNAPSHOT]、SubType Required when unsubscribe_all is empty
+       :param sub_types: Unsubscribe data type, such as: [SNAPSHOT] SubType Required when unsubscribe_all is empty
         or not true
        :param depth: Level 2 subscription levels.
         10 levels by default, up to 50 levels for U.S. stocks.
@@ -51,7 +51,7 @@ def unsubscribe(self, session_id, symbols=None, category=None, sub_types=None, u
         :param session_id: Create the sessionId used for the connection
         :param symbols: Such as: [AAPL,TSLA]
         :param category: Security type, enumeration
-        :param sub_types: Unsubscribe data type, such as: [SNAPSHOT]、SubType Required when unsubscribe_all is empty
+        :param sub_types: Unsubscribe data type, such as: [SNAPSHOT] SubType Required when unsubscribe_all is empty
          or not true
         :param unsubscribe_all: boolean false (true means canceling all real-time market subscriptions.
          When unsubscribe_all is true, symbols, category, sub_types can be empty)