python-okx 0.3.9__py3-none-any.whl → 0.4.1__py3-none-any.whl

okx/Account.py

@@ -23,25 +23,27 @@ class AccountAPI(OkxClient):
         return self._request_with_params(GET, ACCOUNT_INFO, params)
 
     # Get Positions
-    def get_positions(self, instType='', instId=''):
-        params = {'instType': instType, 'instId': instId}
+    def get_positions(self, instType='', instId='', posId=''):
+        params = {'instType': instType, 'instId': instId, 'posId': posId}
         return self._request_with_params(GET, POSITION_INFO, params)
 
-    def position_builder(self, acctLv=None,inclRealPosAndEq=False, lever=None, greeksType=None, simPos=None,
-                         simAsset=None):
+    def position_builder(self, acctLv=None, inclRealPosAndEq=None, lever=None, greeksType=None, simPos=None,
+                         simAsset=None, idxVol=None):
         params = {}
         if acctLv is not None:
             params['acctLv'] = acctLv
         if inclRealPosAndEq is not None:
             params['inclRealPosAndEq'] = inclRealPosAndEq
         if lever is not None:
-            params['spotOffsetType'] = lever
+            params['lever'] = lever
         if greeksType is not None:
-            params['greksType'] = greeksType
+            params['greeksType'] = greeksType
         if simPos is not None:
             params['simPos'] = simPos
         if simAsset is not None:
             params['simAsset'] = simAsset
+        if idxVol is not None:
+            params['idxVol'] = idxVol
         return self._request_with_params(POST, POSITION_BUILDER, params)
 
     # Get Bills Details (recent 7 days)
@@ -74,14 +76,18 @@ class AccountAPI(OkxClient):
         return self._request_with_params(POST, SET_LEVERAGE, params)
 
     # Get Maximum Tradable Size For Instrument
-    def get_max_order_size(self, instId, tdMode, ccy='', px=''):
+    def get_max_order_size(self, instId, tdMode, ccy='', px='', tradeQuoteCcy=None):
         params = {'instId': instId, 'tdMode': tdMode, 'ccy': ccy, 'px': px}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(GET, MAX_TRADE_SIZE, params)
 
     # Get Maximum Available Tradable Amount
-    def get_max_avail_size(self, instId, tdMode, ccy='', reduceOnly='', unSpotOffset='', quickMgnType=''):
+    def get_max_avail_size(self, instId, tdMode, ccy='', reduceOnly='', unSpotOffset='', quickMgnType='', tradeQuoteCcy=None):
         params = {'instId': instId, 'tdMode': tdMode, 'ccy': ccy, 'reduceOnly': reduceOnly,
                   'unSpotOffset': unSpotOffset, 'quickMgnType': quickMgnType}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(GET, MAX_AVAIL_SIZE, params)
 
     # Increase / Decrease margin
@@ -100,8 +106,10 @@ class AccountAPI(OkxClient):
         return self._request_with_params(GET, GET_INSTRUMENTS, params)
 
     # Get the maximum loan of isolated MARGIN
-    def get_max_loan(self, instId, mgnMode, mgnCcy=''):
+    def get_max_loan(self, instId, mgnMode, mgnCcy='', tradeQuoteCcy=None):
         params = {'instId': instId, 'mgnMode': mgnMode, 'mgnCcy': mgnCcy}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(GET, MAX_LOAN, params)
 
     # Get Fee Rates
@@ -323,3 +331,9 @@ class AccountAPI(OkxClient):
     def spot_borrow_repay_history(self, ccy='', type='', after='', before='', limit=''):
         params = {'ccy': ccy, 'type': type, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, GET_BORROW_REPAY_HISTORY, params)
+
+    def set_auto_earn(self, ccy, action, earnType=None):
+        params = {'ccy': ccy, 'action': action}
+        if earnType is not None:
+            params['earnType'] = earnType
+        return self._request_with_params(POST, SET_AUTO_EARN, params)

okx/Finance/SolStaking.py

@@ -46,3 +46,6 @@ class SolStakingAPI(OkxClient):
             'days': days,
         }
         return self._request_with_params(GET, STACK_SOL_APY_HISTORY, params)
+
+    def sol_product_info(self):
+        return self._request_without_params(GET, STACK_SOL_PRODUCT_INFO)

okx/Funding.py

@@ -35,9 +35,11 @@ class FundingAPI(OkxClient):
         return self._request_with_params(POST, FUNDS_TRANSFER, params)
 
     # Withdrawal
-    def withdrawal(self, ccy, amt, dest, toAddr, chain='', areaCode='', clientId=''):
+    def withdrawal(self, ccy, amt, dest, toAddr, chain='', areaCode='', clientId='', toAddrType=None):
         params = {'ccy': ccy, 'amt': amt, 'dest': dest, 'toAddr': toAddr, 'chain': chain,
                   'areaCode': areaCode, 'clientId': clientId}
+        if toAddrType is not None:
+            params['toAddrType'] = toAddrType
         return self._request_with_params(POST, WITHDRAWAL_COIN, params)
 
     # Get Deposit History
@@ -46,10 +48,7 @@ class FundingAPI(OkxClient):
                   'depId': depId, 'fromWdId': fromWdId}
         return self._request_with_params(GET, DEPOSIT_HISTORY, params)
 
-    # Get Withdrawal History
-    def get_withdrawal_history(self, ccy='', wdId='', state='', after='', before='', limit='',txId=''):
-        params = {'ccy': ccy, 'wdId': wdId, 'state': state, 'after': after, 'before': before, 'limit': limit,'txId':txId}
-        return self._request_with_params(GET, WITHDRAWAL_HISTORY, params)
+
 
     # Get Currencies
     def get_currencies(self, ccy=''):
@@ -113,7 +112,9 @@ class FundingAPI(OkxClient):
         return self._request_with_params(GET, GET_DEPOSIT_WITHDrAW_STATUS, params)
 
     #Get withdrawal history
-    def get_withdrawal_history(self, ccy='', wdId='', clientId='', txId='', type='', state='', after='', before	='', limit=''):
+    def get_withdrawal_history(self, ccy='', wdId='', clientId='', txId='', type='', state='', after='', before='', limit='', toAddrType=None):
         params = {'ccy': ccy, 'wdId': wdId, 'clientId': clientId, 'txId': txId, 'type': type, 'state': state, 'after': after, 'before': before, 'limit': limit}
+        if toAddrType is not None:
+            params['toAddrType'] = toAddrType
         return self._request_with_params(GET, GET_WITHDRAWAL_HISTORY, params)
 

okx/Grid.py

@@ -7,11 +7,13 @@ class GridAPI(OkxClient):
         OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug, proxy)
 
     def grid_order_algo(self, instId='', algoOrdType='', maxPx='', minPx='', gridNum='', runType='', tpTriggerPx='',
-                        slTriggerPx='', tag='', quoteSz='', baseSz='', sz='', direction='', lever='', basePos=''):
+                        slTriggerPx='', tag='', quoteSz='', baseSz='', sz='', direction='', lever='', basePos='', tradeQuoteCcy=None):
         params = {'instId': instId, 'algoOrdType': algoOrdType, 'maxPx': maxPx, 'minPx': minPx, 'gridNum': gridNum,
                   'runType': runType, 'tpTriggerPx': tpTriggerPx, 'slTriggerPx': slTriggerPx, 'tag': tag,
                   'quoteSz': quoteSz, 'baseSz': baseSz, 'sz': sz, 'direction': direction, 'lever': lever,
                   'basePos': basePos}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(POST, GRID_ORDER_ALGO, params)
 
     def grid_amend_order_algo(self, algoId='', instId='', slTriggerPx='', tpTriggerPx=''):
@@ -79,11 +81,13 @@ class GridAPI(OkxClient):
 
     # - Place recurring buy order
     def place_recurring_buy_order(self, stgyName='', recurringList=[], period='', recurringDay='', recurringTime='',
-                                  timeZone='', amt='', investmentCcy='', tdMode='', algoClOrdId='', tag=''):
+                                  timeZone='', amt='', investmentCcy='', tdMode='', algoClOrdId='', tag='', tradeQuoteCcy=None):
         params = {'stgyName': stgyName, 'recurringList': recurringList, 'period': period, 'recurringDay': recurringDay,
                   'recurringTime': recurringTime,
                   'timeZone': timeZone, 'amt': amt, 'investmentCcy': investmentCcy, 'tdMode': tdMode,
                   'algoClOrdId': algoClOrdId, 'tag': tag}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(POST, PLACE_RECURRING_BUY_ORDER, params)
 
     # - Amend recurring buy order

okx/PublicData.py

@@ -122,3 +122,18 @@ class PublicAPI(OkxClient):
             'optType': optType
         }
         return self._request_with_params(GET, GET_OPTION_TRADES, params)
+
+    # Get historical market data
+    def get_market_data_history(self, module, instType, dateAggrType, begin, end, instIdList=None, instFamilyList=None):
+        params = {
+            'module': module,
+            'instType': instType,
+            'dateAggrType': dateAggrType,
+            'begin': begin,
+            'end': end
+        }
+        if instIdList is not None:
+            params['instIdList'] = instIdList
+        if instFamilyList is not None:
+            params['instFamilyList'] = instFamilyList
+        return self._request_with_params(GET, MARKET_DATA_HISTORY, params)

okx/Trade.py

@@ -12,10 +12,14 @@ class TradeAPI(OkxClient):
 
     # Place Order
     def place_order(self, instId, tdMode, side, ordType, sz, ccy='', clOrdId='', tag='', posSide='', px='',
-                    reduceOnly='', tgtCcy='', stpMode='', attachAlgoOrds=None, pxUsd='', pxVol='', banAmend=''):
+                    reduceOnly='', tgtCcy='', stpMode='', attachAlgoOrds=None, pxUsd='', pxVol='', banAmend='', tradeQuoteCcy=None, pxAmendType=None):
         params = {'instId': instId, 'tdMode': tdMode, 'side': side, 'ordType': ordType, 'sz': sz, 'ccy': ccy,
                   'clOrdId': clOrdId, 'tag': tag, 'posSide': posSide, 'px': px, 'reduceOnly': reduceOnly,
                   'tgtCcy': tgtCcy, 'stpMode': stpMode, 'pxUsd': pxUsd, 'pxVol': pxVol, 'banAmend': banAmend}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
+        if pxAmendType is not None:
+            params['pxAmendType'] = pxAmendType
         params['attachAlgoOrds'] = attachAlgoOrds
         return self._request_with_params(POST, PLACR_ORDER, params)
 
@@ -35,11 +39,13 @@ class TradeAPI(OkxClient):
     # Amend Order
     def amend_order(self, instId, cxlOnFail='', ordId='', clOrdId='', reqId='', newSz='', newPx='', newTpTriggerPx='',
                     newTpOrdPx='', newSlTriggerPx='', newSlOrdPx='', newTpTriggerPxType='', newSlTriggerPxType='',
-                    attachAlgoOrds='', newTriggerPx='', newOrdPx=''):
+                    attachAlgoOrds='', newTriggerPx='', newOrdPx='', pxAmendType=None):
         params = {'instId': instId, 'cxlOnFail': cxlOnFail, 'ordId': ordId, 'clOrdId': clOrdId, 'reqId': reqId,
                   'newSz': newSz, 'newPx': newPx, 'newTpTriggerPx': newTpTriggerPx, 'newTpOrdPx': newTpOrdPx,
                   'newSlTriggerPx': newSlTriggerPx, 'newSlOrdPx': newSlOrdPx, 'newTpTriggerPxType': newTpTriggerPxType,
                   'newSlTriggerPxType': newSlTriggerPxType, 'newTriggerPx': newTriggerPx, 'newOrdPx': newOrdPx}
+        if pxAmendType is not None:
+            params['pxAmendType'] = pxAmendType
         params['attachAlgoOrds'] = attachAlgoOrds
         return self._request_with_params(POST, AMEND_ORDER, params)
 
@@ -95,7 +101,8 @@ class TradeAPI(OkxClient):
                          pxSpread='',
                          szLimit='', pxLimit='', timeInterval='', tpTriggerPxType='', slTriggerPxType='',
                          callbackRatio='', callbackSpread='', activePx='', tag='', triggerPxType='', closeFraction=''
-                         , quickMgnType='', algoClOrdId=''):
+                         , quickMgnType='', algoClOrdId='', tradeQuoteCcy=None, tpOrdKind='', cxlOnClosePos=''
+                         , chaseType='', chaseVal='', maxChaseType='', maxChaseVal='', attachAlgoOrds=[], pxAmendType=None):
         params = {'instId': instId, 'tdMode': tdMode, 'side': side, 'ordType': ordType, 'sz': sz, 'ccy': ccy,
                   'posSide': posSide, 'reduceOnly': reduceOnly, 'tpTriggerPx': tpTriggerPx, 'tpOrdPx': tpOrdPx,
                   'slTriggerPx': slTriggerPx, 'slOrdPx': slOrdPx, 'triggerPx': triggerPx, 'orderPx': orderPx,
@@ -104,7 +111,13 @@ class TradeAPI(OkxClient):
                   'pxSpread': pxSpread, 'tpTriggerPxType': tpTriggerPxType, 'slTriggerPxType': slTriggerPxType,
                   'callbackRatio': callbackRatio, 'callbackSpread': callbackSpread, 'activePx': activePx,
                   'tag': tag, 'triggerPxType': triggerPxType, 'closeFraction': closeFraction,
-                  'quickMgnType': quickMgnType, 'algoClOrdId': algoClOrdId}
+                  'quickMgnType': quickMgnType, 'algoClOrdId': algoClOrdId,
+                  'tpOrdKind': tpOrdKind, 'cxlOnClosePos': cxlOnClosePos, 'chaseType': chaseType, 'chaseVal': chaseVal,
+                  'maxChaseType': maxChaseType, 'maxChaseVal': maxChaseVal, 'attachAlgoOrds': attachAlgoOrds}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
+        if pxAmendType is not None:
+            params['pxAmendType'] = pxAmendType
         return self._request_with_params(POST, PLACE_ALGO_ORDER, params)
 
     # Cancel Algo Order
@@ -174,11 +187,11 @@ class TradeAPI(OkxClient):
         return self._request_with_params(GET, GET_ALGO_ORDER_DETAILS, params)
 
     # Amend algo order
-    def amend_algo_order(self, instId='', algoId='', algoClOrdId='', cxlOnFail='', reqId='', newSz='',
+    def amend_algo_order(self, instId='', algoId='', algoClOrdId='', cxlOnFail='', reqId='', newSz='', newTriggerPx='', newOrdPx='',
                          newTpTriggerPx='', newTpOrdPx='', newSlTriggerPx='', newSlOrdPx='', newTpTriggerPxType='',
                          newSlTriggerPxType=''):
         params = {'instId': instId, 'algoId': algoId, 'algoClOrdId': algoClOrdId, 'cxlOnFail': cxlOnFail,
-                  'reqId': reqId, 'newSz': newSz, 'newTpTriggerPx': newTpTriggerPx, 'newTpOrdPx': newTpOrdPx,
+                  'reqId': reqId, 'newSz': newSz, 'newTriggerPx': newTriggerPx, 'newOrdPx': newOrdPx, 'newTpTriggerPx': newTpTriggerPx, 'newTpOrdPx': newTpOrdPx,
                   'newSlTriggerPx': newSlTriggerPx, 'newSlOrdPx': newSlOrdPx,
                   'newTpTriggerPxType': newTpTriggerPxType, 'newSlTriggerPxType': newSlTriggerPxType}
         return self._request_with_params(POST, AMEND_ALGO_ORDER, params)

okx/TradingData.py

@@ -47,6 +47,31 @@ class TradingDataAPI(OkxClient):
         params = {'ccy': ccy, 'period': period}
         return self._request_with_params(GET, TAKER_FLOW, params)
 
+    def get_open_interest_history(self, instId, period=None, begin=None, end=None, limit=None):
+        """
+        Get contract open interest history
+        Retrieve the contract open interest statistics of futures and perp.
+        Rate limit: 10 requests per 2 seconds
+        Rate limit rule: IP + Instrument ID
+        
+        :param instId: Instrument ID, e.g. BTC-USDT-SWAP. Only applicable to FUTURES, SWAP
+        :param period: Bar size, the default is 5m, e.g. [5m/15m/30m/1H/2H/4H]
+        :param begin: Return records newer than the requested ts
+        :param end: Pagination of data to return records earlier than the requested ts
+        :param limit: Number of results per request. The maximum is 100. The default is 100
+        :return: API response
+        """
+        params = {'instId': instId}
+        if period is not None:
+            params['period'] = period
+        if begin is not None:
+            params['begin'] = begin
+        if end is not None:
+            params['end'] = end
+        if limit is not None:
+            params['limit'] = limit
+        return self._request_with_params(GET, CONTRACTS_OPEN_INTEREST_HISTORY, params)
+
 
 
 

okx/__init__.py

@@ -2,4 +2,4 @@
 Python SDK for the OKX API v5
 
 """
-__version__="0.3.9"
+__version__="0.4.1"

okx/consts.py

@@ -66,6 +66,7 @@ BORROWING_ORDERS_LIST='/api/v5/account/fixed-loan/borrowing-orders-list'
 MANUAL_REBORROW_REPAY = '/api/v5/account/spot-manual-borrow-repay'
 SET_AUTO_REPAY='/api/v5/account/set-auto-repay'
 GET_BORROW_REPAY_HISTORY='/api/v5/account/spot-borrow-repay-history'
+SET_AUTO_EARN='/api/v5/account/set-auto-earn'
 
 # Funding
 NON_TRADABLE_ASSETS = '/api/v5/asset/non-tradable-assets'
@@ -81,7 +82,6 @@ BILLS_INFO = '/api/v5/asset/bills'
 DEPOSIT_LIGHTNING = '/api/v5/asset/deposit-lightning'
 WITHDRAWAL_LIGHTNING = '/api/v5/asset/withdrawal-lightning'
 CANCEL_WITHDRAWAL = '/api/v5/asset/cancel-withdrawal'
-WITHDRAWAL_HISTORY = '/api/v5/asset/withdrawal-history'
 CONVERT_DUST_ASSETS = '/api/v5/asset/convert-dust-assets'
 ASSET_VALUATION = '/api/v5/asset/asset-valuation'
 GET_WITHDRAWAL_HISTORY = '/api/v5/asset/withdrawal-history'
@@ -130,6 +130,7 @@ INSURANCE_FUND = '/api/v5/public/insurance-fund'
 CONVERT_CONTRACT_COIN = '/api/v5/public/convert-contract-coin'
 GET_OPTION_TICKBANDS = '/api/v5/public/instrument-tick-bands'
 GET_OPTION_TRADES = '/api/v5/public/option-trades'
+MARKET_DATA_HISTORY = '/api/v5/public/market-data-history'
 
 # Trading data
 SUPPORT_COIN = '/api/v5/rubik/stat/trading-data/support-coin'
@@ -142,6 +143,7 @@ PUT_CALL_RATIO = '/api/v5/rubik/stat/option/open-interest-volume-ratio'
 OPEN_INTEREST_VOLUME_EXPIRY = '/api/v5/rubik/stat/option/open-interest-volume-expiry'
 INTEREST_VOLUME_STRIKE = '/api/v5/rubik/stat/option/open-interest-volume-strike'
 TAKER_FLOW = '/api/v5/rubik/stat/option/taker-block-volume'
+CONTRACTS_OPEN_INTEREST_HISTORY = '/api/v5/rubik/stat/contracts/open-interest-history'
 
 # Trade
 PLACR_ORDER = '/api/v5/trade/order'
@@ -261,6 +263,7 @@ STACK_SOL_REDEEM = '/api/v5/finance/staking-defi/sol/redeem'
 STACK_SOL_BALANCE = '/api/v5/finance/staking-defi/sol/balance'
 STACK_SOL_PURCHASE_REDEEM_HISTORY = '/api/v5/finance/staking-defi/sol/purchase-redeem-history'
 STACK_SOL_APY_HISTORY = '/api/v5/finance/staking-defi/sol/apy-history'
+STACK_SOL_PRODUCT_INFO = '/api/v5/finance/staking-defi/sol/product-info'
 
 # Status
 STATUS = '/api/v5/system/status'

okx/okxclient.py

@@ -14,7 +14,16 @@ from . import consts as c, utils, exceptions
 class OkxClient(Client):
 
     def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=None, flag='1',base_api=c.API_URL, debug=False, proxy=None):
-        super().__init__(base_url=base_api, http2=True, proxy=proxy)
+        # Compatible with different versions of httpx
+        # New versions (0.24.0+) use proxy, older versions use proxies
+        try:
+            super().__init__(base_url=base_api, http2=True, proxy=proxy)
+        except TypeError:
+            # Older versions of httpx use proxies parameter
+            if proxy:
+                super().__init__(base_url=base_api, http2=True, proxies={'http://': proxy, 'https://': proxy})
+            else:
+                super().__init__(base_url=base_api, http2=True)
         self.API_KEY = api_key
         self.API_SECRET_KEY = api_secret_key
         self.PASSPHRASE = passphrase

okx/utils.py

@@ -42,7 +42,7 @@ def get_header_no_sign(flag,debug = True):
 def parse_params_to_str(params):
     url = '?'
     for key, value in params.items():
-        if(value != ''):
+        if value is not None and value != '':
             url = url + str(key) + '=' + str(value) + '&'
     url = url[0:-1]
     return url

okx/websocket/WsPrivateAsync.py

@@ -1,6 +1,7 @@
 import asyncio
 import json
 import logging
+import warnings
 
 from okx.websocket import WsUtils
 from okx.websocket.WebSocketFactory import WebSocketFactory
@@ -9,7 +10,7 @@ logger = logging.getLogger(__name__)
 
 
 class WsPrivateAsync:
-    def __init__(self, apiKey, passphrase, secretKey, url, useServerTime):
+    def __init__(self, apiKey, passphrase, secretKey, url, useServerTime=None, debug=False):
         self.url = url
         self.subscriptions = set()
         self.callback = None
@@ -18,27 +19,43 @@ class WsPrivateAsync:
         self.apiKey = apiKey
         self.passphrase = passphrase
         self.secretKey = secretKey
-        self.useServerTime = useServerTime
+        self.useServerTime = False
+        self.websocket = None
+        self.debug = debug
+
+        # Set log level
+        if debug:
+            logger.setLevel(logging.DEBUG)
+
+        # Deprecation warning for useServerTime parameter
+        if useServerTime is not None:
+            warnings.warn("useServerTime parameter is deprecated. Please remove it.", DeprecationWarning)
 
     async def connect(self):
         self.websocket = await self.factory.connect()
 
     async def consume(self):
         async for message in self.websocket:
-            logger.debug("Received message: {%s}", message)
+            if self.debug:
+                logger.debug("Received message: {%s}", message)
             if self.callback:
                 self.callback(message)
 
-    async def subscribe(self, params: list, callback):
+    async def subscribe(self, params: list, callback, id: str = None):
         self.callback = callback
 
         logRes = await self.login()
         await asyncio.sleep(5)
         if logRes:
-            payload = json.dumps({
+            payload_dict = {
                 "op": "subscribe",
                 "args": params
-            })
+            }
+            if id is not None:
+                payload_dict["id"] = id
+            payload = json.dumps(payload_dict)
+            if self.debug:
+                logger.debug(f"subscribe: {payload}")
             await self.websocket.send(payload)
         # await self.consume()
 
@@ -49,28 +66,139 @@ class WsPrivateAsync:
             passphrase=self.passphrase,
             secretKey=self.secretKey
         )
+        if self.debug:
+            logger.debug(f"login: {loginPayload}")
         await self.websocket.send(loginPayload)
         return True
 
-    async def unsubscribe(self, params: list, callback):
+    async def unsubscribe(self, params: list, callback, id: str = None):
         self.callback = callback
-        payload = json.dumps({
+        payload_dict = {
             "op": "unsubscribe",
             "args": params
-        })
-        logger.info(f"unsubscribe: {payload}")
+        }
+        if id is not None:
+            payload_dict["id"] = id
+        payload = json.dumps(payload_dict)
+        if self.debug:
+            logger.debug(f"unsubscribe: {payload}")
+        else:
+            logger.info(f"unsubscribe: {payload}")
+        await self.websocket.send(payload)
+
+    async def send(self, op: str, args: list, callback=None, id: str = None):
+        """
+        Generic send method
+        :param op: Operation type
+        :param args: Parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        payload_dict = {
+            "op": op,
+            "args": args
+        }
+        if id is not None:
+            payload_dict["id"] = id
+        payload = json.dumps(payload_dict)
+        if self.debug:
+            logger.debug(f"send: {payload}")
         await self.websocket.send(payload)
-        # for param in params:
-        #     self.subscriptions.discard(param)
+
+    async def place_order(self, args: list, callback=None, id: str = None):
+        """
+        Place order
+        :param args: Order parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("order", args, id=id)
+
+    async def batch_orders(self, args: list, callback=None, id: str = None):
+        """
+        Batch place orders
+        :param args: Batch order parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("batch-orders", args, id=id)
+
+    async def cancel_order(self, args: list, callback=None, id: str = None):
+        """
+        Cancel order
+        :param args: Cancel order parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("cancel-order", args, id=id)
+
+    async def batch_cancel_orders(self, args: list, callback=None, id: str = None):
+        """
+        Batch cancel orders
+        :param args: Batch cancel order parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("batch-cancel-orders", args, id=id)
+
+    async def amend_order(self, args: list, callback=None, id: str = None):
+        """
+        Amend order
+        :param args: Amend order parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("amend-order", args, id=id)
+
+    async def batch_amend_orders(self, args: list, callback=None, id: str = None):
+        """
+        Batch amend orders
+        :param args: Batch amend order parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("batch-amend-orders", args, id=id)
+
+    async def mass_cancel(self, args: list, callback=None, id: str = None):
+        """
+        Mass cancel orders
+        Note: This method is for /ws/v5/business channel, rate limit: 1 request/second
+        :param args: Cancel parameter list, contains instType and instFamily
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        await self.send("mass-cancel", args, id=id)
 
     async def stop(self):
         await self.factory.close()
-        self.loop.stop()
 
     async def start(self):
-        logger.info("Connecting to WebSocket...")
+        if self.debug:
+            logger.debug("Connecting to WebSocket...")
+        else:
+            logger.info("Connecting to WebSocket...")
         await self.connect()
         self.loop.create_task(self.consume())
 
     def stop_sync(self):
-        self.loop.run_until_complete(self.stop())
+        if self.loop.is_running():
+            future = asyncio.run_coroutine_threadsafe(self.stop(), self.loop)
+            future.result(timeout=10)
+        else:
+            self.loop.run_until_complete(self.stop())

okx/websocket/WsPublicAsync.py

@@ -2,54 +2,124 @@ import asyncio
 import json
 import logging
 
+from okx.websocket import WsUtils
 from okx.websocket.WebSocketFactory import WebSocketFactory
 
 logger = logging.getLogger(__name__)
 
 
 class WsPublicAsync:
-    def __init__(self, url):
+    def __init__(self, url, apiKey='', passphrase='', secretKey='', debug=False):
         self.url = url
         self.subscriptions = set()
         self.callback = None
         self.loop = asyncio.get_event_loop()
         self.factory = WebSocketFactory(url)
+        self.websocket = None
+        self.debug = debug
+        # Credentials for business channel login
+        self.apiKey = apiKey
+        self.passphrase = passphrase
+        self.secretKey = secretKey
+        self.isLoggedIn = False
+
+        # Set log level
+        if debug:
+            logger.setLevel(logging.DEBUG)
 
     async def connect(self):
         self.websocket = await self.factory.connect()
 
     async def consume(self):
         async for message in self.websocket:
-            logger.debug("Received message: {%s}", message)
+            if self.debug:
+                logger.debug("Received message: {%s}", message)
             if self.callback:
                 self.callback(message)
 
-    async def subscribe(self, params: list, callback):
+    async def login(self):
+        """
+        Login method for business channel that requires authentication (e.g. /ws/v5/business)
+        """
+        if not self.apiKey or not self.secretKey or not self.passphrase:
+            raise ValueError("apiKey, secretKey and passphrase are required for login")
+
+        loginPayload = WsUtils.initLoginParams(
+            useServerTime=False,
+            apiKey=self.apiKey,
+            passphrase=self.passphrase,
+            secretKey=self.secretKey
+        )
+        if self.debug:
+            logger.debug(f"login: {loginPayload}")
+        await self.websocket.send(loginPayload)
+        self.isLoggedIn = True
+        return True
+
+    async def subscribe(self, params: list, callback, id: str = None):
         self.callback = callback
-        payload = json.dumps({
+        payload_dict = {
             "op": "subscribe",
             "args": params
-        })
+        }
+        if id is not None:
+            payload_dict["id"] = id
+        payload = json.dumps(payload_dict)
+        if self.debug:
+            logger.debug(f"subscribe: {payload}")
         await self.websocket.send(payload)
         # await self.consume()
 
-    async def unsubscribe(self, params: list, callback):
+    async def unsubscribe(self, params: list, callback, id: str = None):
         self.callback = callback
-        payload = json.dumps({
+        payload_dict = {
             "op": "unsubscribe",
             "args": params
-        })
-        logger.info(f"unsubscribe: {payload}")
+        }
+        if id is not None:
+            payload_dict["id"] = id
+        payload = json.dumps(payload_dict)
+        if self.debug:
+            logger.debug(f"unsubscribe: {payload}")
+        else:
+            logger.info(f"unsubscribe: {payload}")
+        await self.websocket.send(payload)
+
+    async def send(self, op: str, args: list, callback=None, id: str = None):
+        """
+        Generic send method
+        :param op: Operation type
+        :param args: Parameter list
+        :param callback: Callback function
+        :param id: Optional request ID
+        """
+        if callback:
+            self.callback = callback
+        payload_dict = {
+            "op": op,
+            "args": args
+        }
+        if id is not None:
+            payload_dict["id"] = id
+        payload = json.dumps(payload_dict)
+        if self.debug:
+            logger.debug(f"send: {payload}")
         await self.websocket.send(payload)
 
     async def stop(self):
         await self.factory.close()
-        self.loop.stop()
 
     async def start(self):
-        logger.info("Connecting to WebSocket...")
+        if self.debug:
+            logger.debug("Connecting to WebSocket...")
+        else:
+            logger.info("Connecting to WebSocket...")
         await self.connect()
         self.loop.create_task(self.consume())
 
     def stop_sync(self):
-        self.loop.run_until_complete(self.stop())
+        if self.loop.is_running():
+            future = asyncio.run_coroutine_threadsafe(self.stop(), self.loop)
+            future.result(timeout=10)
+        else:
+            self.loop.run_until_complete(self.stop())

{python_okx-0.3.9.dist-info → python_okx-0.4.1.dist-info}/METADATA

@@ -1,21 +1,35 @@
 Metadata-Version: 2.1
 Name: python-okx
-Version: 0.3.9
+Version: 0.4.1
 Summary: Python SDK for OKX
 Home-page: https://okx.com/docs-v5/
 Author: okxv5api
 Author-email: api@okg.com
+License: UNKNOWN
+Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-Requires-Dist: importlib-metadata
-Requires-Dist: httpx[http2]
-Requires-Dist: keyring
-Requires-Dist: loguru
-Requires-Dist: requests
-Requires-Dist: Twisted
-Requires-Dist: pyOpenSSL
+Requires-Dist: httpx[http2]>=0.24.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: websockets>=10.0
+Requires-Dist: certifi>=2021.0.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pytest>=7.0.0
+Requires-Dist: pytest-asyncio>=0.21.0
+Requires-Dist: pytest-cov>=4.0.0
+Requires-Dist: ruff>=0.1.0
+Requires-Dist: build>=1.0.0
+Requires-Dist: twine>=4.0.0
 
 ### Overview
 This is an unofficial Python wrapper for the [OKX exchange v5 API](https://www.okx.com/okx-api)
@@ -24,8 +38,6 @@ If you came here looking to purchase cryptocurrencies from the OKX exchange, ple
 
 #### Source code
 https://github.com/okxapi/python-okx
-#### OKX API Telegram
-https://t.me/OKXAPI
 #### API trading tutorials
 - Spot trading: https://www.okx.com/help/how-can-i-do-spot-trading-with-the-jupyter-notebook
 - Derivative trading: https://www.okx.com/help/how-can-i-do-derivatives-trading-with-the-jupyter-notebook
@@ -41,20 +53,80 @@ Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5
 ### Quick start
 #### Prerequisites
 
-`python version：>=3.9`
+`python version：>=3.7`
 
-`WebSocketAPI： websockets package advise version 6.0`
-
-#### Step 1: register an account on OKX and apply for an API key
+#### Step 1: Register an account on OKX and apply for an API key
 - Register for an account: https://www.okx.com/account/register
 - Apply for an API key: https://www.okx.com/account/users/myApi
 
-#### Step 2: install python-okx
+#### Step 2: Install python-okx
 
-```python
+```bash
 pip install python-okx
 ```
 
+### API Credentials
+
+#### Option 1: Hardcoded credentials
+
+```python
+from okx import Account
+
+account = Account.AccountAPI(
+    api_key="your-api-key-here",
+    api_secret_key="your-api-secret-here",
+    passphrase="your-passphrase-here",
+    flag="1",  # 0 = live trading, 1 = demo trading
+    debug=False
+)
+```
+
+#### Option 2: Using `.env` file (recommended)
+
+Create a `.env` file in your project root:
+
+```bash
+OKX_API_KEY=your-api-key-here
+OKX_API_SECRET=your-api-secret-here
+OKX_PASSPHRASE=your-passphrase-here
+OKX_FLAG=1
+```
+
+Then load it in your code:
+
+```python
+import os
+from dotenv import load_dotenv
+from okx import Account
+
+load_dotenv()
+
+account = Account.AccountAPI(
+    api_key=os.getenv('OKX_API_KEY'),
+    api_secret_key=os.getenv('OKX_API_SECRET'),
+    passphrase=os.getenv('OKX_PASSPHRASE'),
+    flag=os.getenv('OKX_FLAG', '1'),
+    debug=False
+)
+```
+
+### Development Setup
+
+For contributors or local development:
+
+```bash
+# Clone the repository
+git clone https://github.com/okxapi/python-okx.git
+cd python-okx
+
+# Install dependencies
+pip install -r requirements.txt
+pip install -e .
+
+# Run tests
+pytest test/unit/ -v
+```
+
 #### Step 3: Run examples
 
 - Fill in API credentials in the corresponding examples
@@ -95,3 +167,5 @@ Note
     https://github.com/Rapptz/discord.py/issues/1996
     https://github.com/aaugustin/websockets/issues/587
     ```
+
+

{python_okx-0.3.9.dist-info → python_okx-0.4.1.dist-info}/RECORD

@@ -1,34 +1,34 @@
-okx/Account.py,sha256=GK31nIOcVfjskr1QT4FM3b3dMuPp8NbKkQViHtJ0ekI,14134
+okx/Account.py,sha256=ms9eNwuKHmYi2Oun4X6LQJ9OcazUPdEn8NfoLtYyFoA,14815
 okx/BlockTrading.py,sha256=A4OcuLuEHucAIhc8doPGr2o6dsCjVbv-a6YiTlzwdEw,4128
 okx/Convert.py,sha256=xEB2pwEUpc-k23hA3mYIe3EKB5szIXlEe96JFiRSPpc,1575
 okx/CopyTrading.py,sha256=Mso5GE9UQTJVrL4V3jIyU1QWBtzr-m32edrGDoRHk84,2751
 okx/FDBroker.py,sha256=nUpcR_XtUcKa1Jk_B1OUZCjiv9ifQnxGRsLNHDxdGno,788
-okx/Funding.py,sha256=JN6A7-uUJ83Y-AtqmBr7JUVHOa0lJtABQTS_lQ-6H7g,5173
-okx/Grid.py,sha256=r8cZidY2okqrb-zpyTsFJrecPzw2s25ySH3tOBDnDtA,6691
+okx/Funding.py,sha256=lQcx1JUyebhbQGd978K_LuJUTi52Wi1GjrnI40i9Xrc,5040
+okx/Grid.py,sha256=8rPEjojbyZ_kJdzvHMHVkVTp-xrdUC0SCQ2rmY35rPA,6911
 okx/MarketData.py,sha256=4GO8Vdkh02GQFJeqC0k4ej3w49wkZroEOoVJ407_ju4,4827
-okx/PublicData.py,sha256=HEq4cNCk5P1mhLaMewJhVJTvHm0I2bdrL8Z6pH3yYn0,5136
+okx/PublicData.py,sha256=UIBX9fQRRsOpEa7OMoZbSGy9bPEHCMI3YhGk7pzYlt4,5726
 okx/SpreadTrading.py,sha256=Dy7VZ8WK4HyxhMvLY1G5RukRHI_T3d0fnrHZifv9Uyw,3227
 okx/Status.py,sha256=hGnn-tw302xXCDWly7LssaG3-29HcHZRhrBFUuGrSS0,495
 okx/SubAccount.py,sha256=BcwEzi_Y63k-rS9IffFKAJ2ywVl7o9J0U9sBzg87Lpw,3264
-okx/Trade.py,sha256=p1vJcwHZvuYfgKXmaTYZKwtJQ9YtvSZ0arOd8GGAufI,11006
-okx/TradingData.py,sha256=ig9Y3f-CH_nyBvoZCF4M9z2_wQXF-r0On7p9EMMuDMo,2331
-okx/__init__.py,sha256=aCopTb9QU6OqHWoGo05pHw8Qe-kOja2kjDzFeuEeWg8,58
-okx/consts.py,sha256=gUTC2PkhH34Ekct-HA428hJAARPLvcVa5JnAiHkjUGQ,14632
+okx/Trade.py,sha256=FHNxkHWf046YuDpXS94DgA8OWXMJgdPMOEHYxB7GFOE,11981
+okx/TradingData.py,sha256=T_55BXEcEXj7Ti5eO1hfRo6fgdg5i2VxXYl4G3acgnE,3498
+okx/__init__.py,sha256=UP-NPa-t7tXwbtG7kEnTlQZu2HPH1DKmRM_hiYP1mvo,58
+okx/consts.py,sha256=KrI7d7wEmJ0VkVeVQiB_iqNf9bebbBP37_LXJ0MsvSI,14841
 okx/exceptions.py,sha256=ERuCnvnudJNBNACh3LNE3km5GJy0BGC5C3OKjgHXFaU,1182
-okx/okxclient.py,sha256=wJD8gTyHs92WjLffANbWLCgfX4Mnxh-IKnnJ2nUYHsI,2597
-okx/utils.py,sha256=FTXSW73yXV6Hc4-9O22WFmkhayASYo7WQHIc_bTyc6g,1858
+okx/okxclient.py,sha256=wywtgB73QelIlsQHFkOcRQsichdpm1n8AlYizB9S_rI,3040
+okx/utils.py,sha256=yMlqB3OF6NDBrz7P6rEmD8PWe2xeqh0Gw8lceUFWy0A,1879
 okx/Finance/EthStaking.py,sha256=hOl_i4VOBjejeyBboG1-37rhVnlSoOZ44e-Jzger-bQ,1612
 okx/Finance/FlexibleLoan.py,sha256=L-j1O73fEIIiM_h8NvCT6NocUv6KAx2WEQU6F9GRzIw,2351
 okx/Finance/Savings.py,sha256=qZbv-KzgGt_me8RZePDSUiRCI1mbz692EK2ZhfYiH8c,1999
-okx/Finance/SolStaking.py,sha256=XuGFFonpRpMQkrhNlpyOb644EApb3joQ74PRabN0PTs,1502
+okx/Finance/SolStaking.py,sha256=VcEU4ukbU5bO8qe00DDfFJ0DUIZZS9ZO_-A2evJz5e0,1608
 okx/Finance/StakingDefi.py,sha256=eWyAAmMDht4B4N5VWf3bj3FxSBETMXaay-Luu4GN3ls,2250
 okx/Finance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 okx/websocket/WebSocketFactory.py,sha256=ba0ZNUggghZ_YlWYB7g8UCv6MewqVr9wn75YOtIU5kE,845
-okx/websocket/WsPrivateAsync.py,sha256=zmZuInowW9_YWpQoZoicbbff-UwWvWxOluKclomNcXA,2240
-okx/websocket/WsPublicAsync.py,sha256=yDk_2jkgM4M_sq6zSL6i-KfdoSOaSd5KsmA1wqbIx3E,1520
+okx/websocket/WsPrivateAsync.py,sha256=jq5Imy3hiM3pA7i-uUisGi2R_t9J4h_UOu78mWCv6do,6643
+okx/websocket/WsPublicAsync.py,sha256=e5UXLP0y5ypcdV9YXk39FZqDVvA76H-VS1xWAKXREDs,3920
 okx/websocket/WsUtils.py,sha256=ynkCtfvkrwBUiCi-_yqp1xTn3hhVd_o5ITIhD1xLdBo,2199
 okx/websocket/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_okx-0.3.9.dist-info/METADATA,sha256=6JjQsztHk5jx5GuNQPngvWPs7J_3jbZUKYcBTtctSbU,3145
-python_okx-0.3.9.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-python_okx-0.3.9.dist-info/top_level.txt,sha256=rrbhHZwiw4YlhG1LWWaAODvRxyZr3onxFnqwsHdikDc,4
-python_okx-0.3.9.dist-info/RECORD,,
+python_okx-0.4.1.dist-info/METADATA,sha256=Cu772omzS6r2A7RbtDJMPGXTJU8hgcTcbQgbDHqswrY,4751
+python_okx-0.4.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+python_okx-0.4.1.dist-info/top_level.txt,sha256=rrbhHZwiw4YlhG1LWWaAODvRxyZr3onxFnqwsHdikDc,4
+python_okx-0.4.1.dist-info/RECORD,,

{python_okx-0.3.9.dist-info → python_okx-0.4.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any