Merge branch 'main_merge_251212_01' into 'main'

feat: Optimize the request parameters

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

Author: 方佳

webull/data/quotes/instrument.py

@@ -23,28 +23,28 @@ class Instrument:
     def __init__(self, api_client):
         self.client = api_client
 
-    def get_instrument(self, symbols, category=Category.US_STOCK.name, status=None, last_instrument_id=None,
-                       count=1000):
+    def get_instrument(self, symbols=None, category=Category.US_STOCK.name, status=None, last_instrument_id=None,
+                       page_size=1000):
         """
          Query the underlying information according to the security symbol list and security type.
 
         :param symbols: Securities symbol, such as: 00700,00981.
         :param category: Security type, enumeration.
         :param status: Tradable status.
         :param last_instrument_id: Last instrument id for pagination.
-        :param count: Page size, default 1000.
+        :param page_size: Page size, default 1000.
         """
         instruments_request = GetInstrumentsRequest()
         instruments_request.set_symbols(symbols)
         instruments_request.set_category(category)
         instruments_request.set_status(status)
         instruments_request.set_last_instrument_id(last_instrument_id)
-        instruments_request.set_count(count)
+        instruments_request.set_page_size(page_size)
         response = self.client.get_response(instruments_request)
         return response
 
     def get_crypto_instrument(self, symbols=None, status=None, last_instrument_id=None,
-                              category=Category.US_CRYPTO.name, count=1000):
+                              category=Category.US_CRYPTO.name, page_size=1000):
         """
          Query the crypto underlying information according to the security symbol.
         :param symbols: Securities symbol, such as: BTCUSD,ETHUSD.
@@ -53,14 +53,14 @@ def get_crypto_instrument(self, symbols=None, status=None, last_instrument_id=No
         :param category: (str, required) Instrument type.
                      Possible values: ["US_CRYPTO"]
                      Example: "US_CRYPTO"
-        :param count: Page size, default 1000.
+        :param page_size: Page size, default 1000.
         """
         crypto_instruments_request = GetCryptoInstrumentsRequest()
         crypto_instruments_request.set_symbols(symbols)
         crypto_instruments_request.set_category(category)
         crypto_instruments_request.set_status(status)
         crypto_instruments_request.set_last_instrument_id(last_instrument_id)
-        crypto_instruments_request.set_count(count)
+        crypto_instruments_request.set_page_size(page_size)
         response = self.client.get_response(crypto_instruments_request)
         return response
 

webull/data/request/get_crypto_instruments_request.py

@@ -39,6 +39,6 @@ def set_last_instrument_id(self, last_instrument_id):
         if last_instrument_id:
             self.add_query_param("last_instrument_id", last_instrument_id)
 
-    def set_count(self, count):
-        if count:
-            self.add_query_param("count", count)
+    def set_page_size(self, page_size):
+        if page_size:
+            self.add_query_param("page_size", page_size)

webull/data/request/get_instruments_request.py

@@ -37,6 +37,6 @@ def set_last_instrument_id(self, last_instrument_id):
         if last_instrument_id:
             self.add_query_param("last_instrument_id", last_instrument_id)
 
-    def set_count(self, count):
-        if count:
-            self.add_query_param("count", count)
+    def set_page_size(self, page_size):
+        if page_size:
+            self.add_query_param("page_size", page_size)