rebase to fork origin

README.md

@@ -5,11 +5,9 @@ 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/learn/spot-trading-with-jupyter-notebook
-- Derivative trading: https://www.okx.com/learn/derivatives-trading-with-jupyter-notebook
+- 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
 
 Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5/log_en/) for new features and bug fixes.
 

okx/Account.py

@@ -1,11 +1,12 @@
-from .client import Client
 from .consts import *
+from .okxclient import OkxClient
 
 
-class AccountAPI(Client):
+class AccountAPI(OkxClient):
 
-    def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=False, flag='1', domain = 'https://www.okx.com',debug = True):
-        Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain,debug)
+    def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=None, flag='1',
+                 domain='https://www.okx.com', debug=False, proxy=None):
+        OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug, proxy)
 
     # Get Positions
     def get_position_risk(self, instType=''):
@@ -26,18 +27,36 @@ def get_positions(self, instType='', instId=''):
         params = {'instType': instType, 'instId': instId}
         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):
+        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
+        if greeksType is not None:
+            params['greksType'] = greeksType
+        if simPos is not None:
+            params['simPos'] = simPos
+        if simAsset is not None:
+            params['simAsset'] = simAsset
+        return self._request_with_params(POST, POSITION_BUILDER, params)
+
     # Get Bills Details (recent 7 days)
     def get_account_bills(self, instType='', ccy='', mgnMode='', ctType='', type='', subType='', after='', before='',
-                         limit=''):
+                          limit=''):
         params = {'instType': instType, 'ccy': ccy, 'mgnMode': mgnMode, 'ctType': ctType, 'type': type,
                   'subType': subType, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, BILLS_DETAIL, params)
 
     # Get Bills Details (recent 3 months)
-    def get_account_bills_archive(self, instType='', ccy='', mgnMode='', ctType='', type='', subType='', after='', before='',
-                          limit=''):
+    def get_account_bills_archive(self, instType='', ccy='', mgnMode='', ctType='', type='', subType='', after='',
+                                  before='',
+                                  limit='', begin='', end=''):
         params = {'instType': instType, 'ccy': ccy, 'mgnMode': mgnMode, 'ctType': ctType, 'type': type,
-                  'subType': subType, 'after': after, 'before': before, 'limit': limit}
+                  'subType': subType, 'after': after, 'before': before, 'limit': limit, 'begin': begin, 'end': end}
         return self._request_with_params(GET, BILLS_ARCHIVE, params)
 
     # Get Account Configuration
@@ -66,23 +85,28 @@ def get_max_avail_size(self, instId, tdMode, ccy='', reduceOnly='', unSpotOffset
         return self._request_with_params(GET, MAX_AVAIL_SIZE, params)
 
     # Increase / Decrease margin
-    def adjustment_margin(self, instId, posSide, type, amt,loanTrans=''):
-        params = {'instId': instId, 'posSide': posSide, 'type': type, 'amt': amt,'loanTrans':loanTrans}
+    def adjustment_margin(self, instId, posSide, type, amt, loanTrans=''):
+        params = {'instId': instId, 'posSide': posSide, 'type': type, 'amt': amt, 'loanTrans': loanTrans}
         return self._request_with_params(POST, ADJUSTMENT_MARGIN, params)
 
     # Get Leverage
-    def get_leverage(self, instId, mgnMode):
-        params = {'instId': instId, 'mgnMode': mgnMode}
+    def get_leverage(self, mgnMode, ccy='', instId=''):
+        params = {'instId': instId, 'mgnMode': mgnMode, 'ccy': ccy}
         return self._request_with_params(GET, GET_LEVERAGE, params)
 
+    # Get instruments
+    def get_instruments(self, instType='', ugly='', instFamily='', instId=''):
+        params = {'instType': instType, 'ugly': ugly, 'instFamily': instFamily, 'instId': instId}
+        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=''):
         params = {'instId': instId, 'mgnMode': mgnMode, 'mgnCcy': mgnCcy}
         return self._request_with_params(GET, MAX_LOAN, params)
 
     # Get Fee Rates
-    def get_fee_rates(self, instType, instId='', uly='', category='',instFamily = ''):
-        params = {'instType': instType, 'instId': instId, 'uly': uly, 'category': category,'instFamily':instFamily}
+    def get_fee_rates(self, instType, instId='', uly='', category='', instFamily=''):
+        params = {'instType': instType, 'instId': instId, 'uly': uly, 'category': category, 'instFamily': instFamily}
         return self._request_with_params(GET, FEE_RATES, params)
 
     # Get interest-accrued
@@ -101,8 +125,8 @@ def set_greeks(self, greeksType):
         return self._request_with_params(POST, SET_GREEKS, params)
 
     # Set Isolated Mode
-    def set_isolated_mode(self, isoMode,type):
-        params = {'isoMode': isoMode, 'type':type}
+    def set_isolated_mode(self, isoMode, type):
+        params = {'isoMode': isoMode, 'type': type}
         return self._request_with_params(POST, ISOLATED_MODE, params)
 
     # Get Maximum Withdrawals
@@ -117,11 +141,11 @@ def borrow_repay(self, ccy='', side='', amt='', ordId=''):
 
     # Get borrow repay history
     def get_borrow_repay_history(self, ccy='', after='', before='', limit=''):
-        params = {'ccy': ccy, 'after': after, 'before': before, 'limit':limit}
+        params = {'ccy': ccy, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, BORROW_REPAY_HISTORY, params)
 
     # Get Obtain borrowing rate and limit
-    def get_interest_limits(self, type='',ccy=''):
+    def get_interest_limits(self, type='', ccy=''):
         params = {'type': type, 'ccy': ccy}
         return self._request_with_params(GET, INTEREST_LIMITS, params)
 
@@ -135,57 +159,58 @@ def get_greeks(self, ccy=''):
         params = {'ccy': ccy}
         return self._request_with_params(GET, GREEKS, params)
 
-    #GET /api/v5/account/risk-state
+    # GET /api/v5/account/risk-state
     def get_account_position_risk(self):
         return self._request_without_params(GET, ACCOUNT_RISK)
 
-    #GET /api/v5/account/positions-history
-    def get_positions_history(self,instType = '', instId = '',mgnMode = '',type = '',posId = '',after = '',before ='',limit = ''):
+    # GET /api/v5/account/positions-history
+    def get_positions_history(self, instType='', instId='', mgnMode='', type='', posId='', after='', before='',
+                              limit=''):
         params = {
-            'instType':instType,
-            'instId':instId,
-            'mgnMode':mgnMode,
-            'type':type,
-            'posId':posId,
-            'after':after,
-            'before':before,
-            'limit':limit
+            'instType': instType,
+            'instId': instId,
+            'mgnMode': mgnMode,
+            'type': type,
+            'posId': posId,
+            'after': after,
+            'before': before,
+            'limit': limit
         }
-        return self._request_with_params(GET,POSITIONS_HISTORY,params)
+        return self._request_with_params(GET, POSITIONS_HISTORY, params)
 
-    #GET /api/v5/account/position-tiers
-    def get_account_position_tiers(self,instType = '', uly = '',instFamily = ''):
+    # GET /api/v5/account/position-tiers
+    def get_account_position_tiers(self, instType='', uly='', instFamily=''):
         params = {
-            'instType':instType,
-            'uly':uly,
-            'instFamily':instFamily
+            'instType': instType,
+            'uly': uly,
+            'instFamily': instFamily
         }
-        return self._request_with_params(GET,GET_PM_LIMIT,params)
+        return self._request_with_params(GET, GET_PM_LIMIT, params)
 
-    #- Get VIP interest accrued data
+    # - Get VIP interest accrued data
     def get_VIP_interest_accrued_data(self, ccy='', ordId='', after='', before='', limit=''):
         params = {'ccy': ccy, 'ordId': ordId, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, GET_VIP_INTEREST_ACCRUED_DATA, params)
 
-    #- Get VIP interest deducted data
+    # - Get VIP interest deducted data
     def get_VIP_interest_deducted_data(self, ccy='', ordId='', after='', before='', limit=''):
         params = {'ccy': ccy, 'ordId': ordId, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, GET_VIP_INTEREST_DEDUCTED_DATA, params)
 
     # - Get VIP loan order list
-    def get_VIP_loan_order_list(self, ordId='',state='', ccy='', after='', before='', limit=''):
-        params = {'ordId': ordId, 'state': state, 'ccy': ccy,'after': after, 'before': before, 'limit': limit}
+    def get_VIP_loan_order_list(self, ordId='', state='', ccy='', after='', before='', limit=''):
+        params = {'ordId': ordId, 'state': state, 'ccy': ccy, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, GET_VIP_LOAN_ORDER_LIST, params)
 
-    #- Get VIP loan order detail
+    # - Get VIP loan order detail
     def get_VIP_loan_order_detail(self, ccy='', ordId='', after='', before='', limit=''):
         params = {'ccy': ccy, 'ordId': ordId, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, GET_VIP_LOAN_ORDER_DETAIL, params)
 
-    #- Set risk offset type
+    # - Set risk offset type
     def set_risk_offset_typel(self, type=''):
         params = {'type': type}
-        return self._request_with_params(POST, SET_RISK_OFFSET_TYPE,params)
+        return self._request_with_params(POST, SET_RISK_OFFSET_TYPE, params)
 
     # - Set auto loan
     def set_auto_loan(self, autoLoan=''):
@@ -194,6 +219,107 @@ def set_auto_loan(self, autoLoan=''):
         }
         return self._request_with_params(POST, SET_AUTO_LOAN, params)
 
-    #- Activate option
+    # - Set auto loan
+    def set_account_level(self, acctLv):
+        params = {
+            'acctLv': acctLv
+        }
+        return self._request_with_params(POST, SET_ACCOUNT_LEVEL, params)
+
+    # - Activate option
     def activate_option(self):
         return self._request_without_params(POST, ACTIVSTE_OPTION)
+
+    def get_fix_loan_borrowing_limit(self):
+        return self._request_without_params(GET, BORROWING_LIMIT)
+
+    def get_fix_loan_borrowing_quote(self, type=None, ccy=None, amt=None, maxRate=None, term=None, ordId=None):
+        params = {}
+        if type is not None:
+            params['type'] = type
+        if ccy is not None:
+            params['ccy'] =ccy
+        if amt is not None:
+            params['amt'] = amt
+        if maxRate is not None:
+            params['maxRate'] = maxRate
+        if term is not None:
+            params['term'] = term
+        if ordId is not None:
+            params['ordId'] = ordId
+        return self._request_with_params(GET, BORROWING_QUOTE, params)
+
+    def place_fix_loan_borrowing_order(self, ccy=None, amt=None, maxRate=None, term=None, reborrow=False, reborrowRate=None):
+        params = {}
+        if ccy is not None:
+            params['ccy'] =ccy
+        if amt is not None:
+            params['amt'] = amt
+        if maxRate is not None:
+            params['maxRate'] = maxRate
+        if term is not None:
+            params['term'] = term
+        if reborrow is not None:
+            params['reborrow'] = reborrow
+        if reborrowRate is not None:
+            params['reborrowRate'] = reborrowRate
+        return self._request_with_params(POST, PLACE_BORROWING_ORDER, params)
+
+    def amend_fix_loan_borrowing_order(self, ordId=None, reborrow=None, renewMaxRate=None):
+        params = {}
+        if ordId is not None:
+            params['ordId'] = ordId
+        if reborrow is not None:
+            params['reborrow'] = reborrow
+        if renewMaxRate is not None:
+            params['renewMaxRate'] = renewMaxRate
+        return self._request_with_params(POST, AMEND_BORROWING_ORDER, params)
+
+    def fix_loan_manual_reborrow(self, ordId=None, maxRate=None):
+        params = {}
+        if ordId is not None:
+            params['ordId'] = ordId
+        if maxRate is not None:
+            params['maxRate'] = maxRate
+        return self._request_with_params(POST, MANUAL_REBORROW, params)
+
+    def repay_fix_loan_borrowing_order(self, ordId=None):
+        params = {}
+        if ordId is not None:
+            params['ordId'] = ordId
+        return self._request_with_params(POST, REPAY_BORROWING_ORDER, params)
+    def get_fix_loan_borrowing_orders_list(self, ordId=None, ccy=None, state=None, after=None, before=None, limit=None):
+        params = {}
+        if ordId is not None:
+            params['ordId'] = ordId
+        if ccy is not None:
+            params['ccy'] =ccy
+        if state is not None:
+            params['state'] = state
+        if after is not None:
+            params['after'] = after
+        if before is not None:
+            params['before'] = before
+        if limit is not None:
+            params['limit'] = limit
+        return self._request_with_params(GET, BORROWING_ORDERS_LIST, params)
+
+    def spot_manual_borrow_repay(self, ccy=None, side=None, amt=None):
+        params = {}
+        if ccy is not None:
+            params['ccy'] = ccy
+        if side is not None:
+            params['side'] = side
+        if amt is not None:
+            params['amt'] = amt
+        return self._request_with_params(POST, MANUAL_REBORROW_REPAY, params)
+
+    def set_auto_repay(self, autoRepay=False):
+        params = {}
+        if autoRepay is not None:
+            params['autoRepay'] = autoRepay
+        return self._request_with_params(POST, SET_AUTO_REPAY, params)
+
+    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)

okx/BlockTrading.py

@@ -1,10 +1,10 @@
-from .client import Client
+from .okxclient import OkxClient
 from .consts import *
 
 
-class BlockTradingAPI(Client):
-    def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=False, flag='1', domain = 'https://www.okx.com',debug = True):
-        Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain,debug)
+class BlockTradingAPI(OkxClient):
+    def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=None, flag='1', domain = 'https://www.okx.com',debug = False, proxy=None):
+        OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug, proxy)
 
     def counterparties(self):
         params = {}

okx/Convert.py

@@ -1,10 +1,10 @@
-from .client import Client
+from .okxclient import OkxClient
 from .consts import *
 
 
-class ConvertAPI(Client):
-    def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=False, flag='1', domain = 'https://www.okx.com',debug = True):
-        Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain,debug)
+class ConvertAPI(OkxClient):
+    def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=None, flag='1', domain = 'https://www.okx.com',debug = False,proxy = None):
+        OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug, proxy)
 
     def get_currencies(self):
         params = {}

okx/CopyTrading.py

@@ -1,11 +1,12 @@
-from .client import Client
+from .okxclient import OkxClient
 from .consts import *
 
 
-class CopyTradingAPI(Client):
+class CopyTradingAPI(OkxClient):
     def __init__(self, api_key='-1', api_secret_key='-1', passphrase='-1', use_server_time=False, flag='1',
-                 domain='https://www.okx.com', debug=True):
-        Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug)
+                 domain='https://www.okx.com', debug=False, proxy=None):
+        OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug,
+                           proxy=proxy)
 
     # Get existing leading positions
     def get_existing_leading_positions(self, instId=''):
@@ -25,7 +26,8 @@ def get_leading_position_history(self, instId='', after='', before='', limit='')
         return self._request_with_params(GET, GET_LEADING_POSITIONS_HISTORY, params)
 
     # Place leading stop order
-    def place_leading_stop_order(self, subPosId='', tpTriggerPx='', slTriggerPx='', tpTriggerPxType='', slTriggerPxType=''):
+    def place_leading_stop_order(self, subPosId='', tpTriggerPx='', slTriggerPx='', tpTriggerPxType='',
+                                 slTriggerPxType=''):
         params = {
             'subPosId': subPosId,
             'tpTriggerPx': tpTriggerPx,