okxv5 1.8.11__py3-none-any.whl → 1.8.13__py3-none-any.whl

okxv5/exceptions.py

@@ -2,76 +2,43 @@
 
 
 class OkxAPIException(Exception):
-    """
-    OKX API异常类，用于处理从OKX API返回的错误响应。
-    """
+
     def __init__(self, response):
-        """
-        构造函数，初始化API异常。
-        :param response: HTTP响应对象，通常包含错误信息。
-        """
-        # 打印响应文本和状态码
         print(response.text + ', ' + str(response.status_code))
-        self.code = 0  # 错误码初始化
+        self.code = 0
         try:
-            json_res = response.json()  # 尝试将响应解析为JSON
+            json_res = response.json()
         except ValueError:
-            # 如果解析失败，则消息为无效JSON格式
             self.message = 'Invalid JSON error message from Okx: {}'.format(response.text)
         else:
-            # 如果JSON解析成功，检查是否包含'code'和'msg'字段
             if "code" in json_res.keys() and "msg" in json_res.keys():
-                self.code = json_res['code']  # 提取错误码
-                self.message = json_res['msg']  # 提取错误消息
+                self.code = json_res['code']
+                self.message = json_res['msg']
             else:
-                self.code = 'None'  # 如果没有'code'和'msg'，则为系统错误
+                self.code = 'None'
                 self.message = 'System error'
 
-        self.status_code = response.status_code  # HTTP状态码
-        self.response = response  # 原始HTTP响应
-        self.request = getattr(response, 'request', None)  # 原始HTTP请求
+        self.status_code = response.status_code
+        self.response = response
+        self.request = getattr(response, 'request', None)
 
     def __str__(self):  # pragma: no cover
-        """
-        返回此异常的字符串表示。
-        :return: 包含错误码和消息的字符串。
-        """
         return 'API Request Error(code=%s): %s' % (self.code, self.message)
 
 
 class OkxRequestException(Exception):
-    """
-    OKX 请求异常类，用于处理在发送请求时发生的错误（例如网络问题）。
-    """
+
     def __init__(self, message):
-        """
-        构造函数，初始化请求异常。
-        :param message: 异常消息。
-        """
         self.message = message
 
     def __str__(self):
-        """
-        返回此异常的字符串表示。
-        :return: 包含请求异常消息的字符串。
-        """
         return 'OkxRequestException: %s' % self.message
 
 
 class OkxParamsException(Exception):
-    """
-    OKX 参数异常类，用于处理由于参数错误导致的问题。
-    """
+
     def __init__(self, message):
-        """
-        构造函数，初始化参数异常。
-        :param message: 异常消息。
-        """
         self.message = message
 
     def __str__(self):
-        """
-        返回此异常的字符串表示。
-        :return: 包含参数异常消息的字符串。
-        """
         return 'OkxParamsException: %s' % self.message

okxv5/status_api.py

@@ -1,35 +1,21 @@
-# 从当前包导入Client类
 from .client import Client
-# 从当前包导入所有常量
 from .consts import *
 
 
-# StatusAPI类继承自Client类
 class StatusAPI(Client):
-    # 构造函数
     def __init__(self, api_key, api_secret_key, passphrase, use_server_time=False, flag='1'):
-        # 调用父类Client的构造函数
         Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag)
 
-    # 获取系统状态
     def status(self, state=''):
-        # 构建请求参数字典，'state' 为状态参数
         params = {'state': state}
-        # 调用父类的_request_with_params方法发送GET请求，获取状态信息
         return self._request_with_params(GET, STATUS, params)
 
     # GET /api/v5/support/announcements
-    # 获取公告列表
     def get_announcements(self, annType = '', page = ''):
-        # 构建请求参数字典，'annType' 为公告类型，'page' 为页码
         params = {'annType': annType, 'page': page}
-        # 调用父类的_request_with_params方法发送GET请求，获取公告信息
         return self._request_with_params(GET, GET_ANNOUNCEMENTS, params)
 
     # GET /api/v5/support/announcement-types
-    # 获取公告类型
     def get_announcements_types(self):
-        # 构建空的请求参数字典
         params = {}
-        # 调用父类的_request_with_params方法发送GET请求，获取公告类型信息
         return self._request_with_params(GET, GET_ANNOUNCEMENTS_TYPES, params)

okxv5/subAccount_api.py

@@ -3,232 +3,61 @@ from .consts import *
 
 
 class SubAccountAPI(Client):
-    """
-    子账户API类，继承自Client，用于与子账户相关的操作。
-    """
     def __init__(self, api_key, api_secret_key, passphrase, use_server_time=False, flag='1'):
-        """
-        初始化SubAccountAPI实例。
-
-        参数:
-            api_key (str): API密钥。
-            api_secret_key (str): API私钥。
-            passphrase (str): 密码。
-            use_server_time (bool, optional): 是否使用服务器时间，默认为False。
-            flag (str, optional): 区域标识，'1'为真实环境，'0'为模拟盘。
-        """
         Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag)
 
     def balances(self, subAcct):
-        """
-        获取子账户资产余额。
-
-        参数:
-            subAcct (str): 子账户名称。
-
-        返回:
-            dict: 包含子账户余额信息的响应。
-        """
         params = {"subAcct": subAcct}
         return self._request_with_params(GET, BALANCE, params)
 
     def bills(self, ccy='', type='', subAcct='', after='', before='', limit=''):
-        """
-        获取子账户账单记录。
-
-        参数:
-            ccy (str, optional): 币种，如“BTC”，默认为空。
-            type (str, optional): 账单类型，默认为空。
-            subAcct (str, optional): 子账户名称，默认为空。
-            after (str, optional): 查询起始ID，默认为空。
-            before (str, optional): 查询结束ID，默认为空。
-            limit (str, optional): 返回结果的数量，默认为空。
-
-        返回:
-            dict: 包含子账户账单记录的响应。
-        """
         params = {"ccy": ccy, 'type': type, 'subAcct': subAcct, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, BILLs, params)
     # 移除此接口
     def delete(self, pwd, subAcct, apiKey):
-        """
-        删除子账户（此接口已移除）。
-
-        参数:
-            pwd (str): 密码。
-            subAcct (str): 子账户名称。
-            apiKey (str): API密钥。
-
-        返回:
-            dict: 删除子账户的响应。
-        """
         params = {'pwd': pwd, 'subAcct': subAcct, 'apiKey': apiKey}
         return self._request_with_params(POST, DELETE, params)
     # 移除此接口
     def reset(self, pwd, subAcct, label, apiKey, perm, ip=''):
-        """
-        重置子账户API密钥（此接口已移除）。
-
-        参数:
-            pwd (str): 密码。
-            subAcct (str): 子账户名称。
-            label (str): API密钥标签。
-            apiKey (str): API密钥。
-            perm (str): 权限。
-            ip (str, optional): IP地址，默认为空。
-
-        返回:
-            dict: 重置API密钥的响应。
-        """
         params = {'pwd': pwd, 'subAcct': subAcct, 'label': label, 'apiKey': apiKey, 'perm': perm, 'ip': ip}
         return self._request_with_params(POST, RESET, params)
     # 移除此接口
     def create(self, pwd, subAcct, label, Passphrase, perm='', ip=''):
-        """
-        创建子账户（此接口已移除）。
-
-        参数:
-            pwd (str): 密码。
-            subAcct (str): 子账户名称。
-            label (str): API密钥标签。
-            Passphrase (str): 密码。
-            perm (str, optional): 权限，默认为空。
-            ip (str, optional): IP地址，默认为空。
-
-        返回:
-            dict: 创建子账户的响应。
-        """
         params = {'pwd': pwd, 'subAcct': subAcct, 'label': label, 'Passphrase': Passphrase, 'perm': perm, 'ip': ip}
         return self._request_with_params(POST, CREATE, params)
     # 移除此接口
     def watch(self, subAcct,apiKey=''):
-        """
-        监控子账户（此接口已移除）。
-
-        参数:
-            subAcct (str): 子账户名称。
-            apiKey (str, optional): API密钥，默认为空。
-
-        返回:
-            dict: 监控子账户的响应。
-        """
         params = {'subAcct': subAcct,'apiKey':apiKey}
         return self._request_with_params(GET, WATCH, params)
 
     def view_list(self, enable='', subAcct='', after='', before='', limit='',uid=''):
-        """
-        查看子账户列表。
-
-        参数:
-            enable (str, optional): 是否启用，默认为空。
-            subAcct (str, optional): 子账户名称，默认为空。
-            after (str, optional): 查询起始ID，默认为空。
-            before (str, optional): 查询结束ID，默认为空。
-            limit (str, optional): 返回结果的数量，默认为空。
-            uid (str, optional): 用户ID，默认为空。
-
-        返回:
-            dict: 包含子账户列表的响应。
-        """
         params = {'enable': enable, 'subAcct': subAcct, 'after': after,
                   'before': before, 'limit': limit,'uid':uid}
         return self._request_with_params(GET, VIEW_LIST, params)
 
     def subAccount_transfer(self, ccy, amt, froms, to, fromSubAccount,toSubAccount,loanTrans='',omitPosRisk=''):
-        """
-        子账户资金划转。
-
-        参数:
-            ccy (str): 币种。
-            amt (str): 划转数量。
-            froms (str): 转出方。
-            to (str): 转入方。
-            fromSubAccount (str): 转出子账户名称。
-            toSubAccount (str): 转入子账户名称。
-            loanTrans (str, optional): 借贷划转类型，默认为空。
-            omitPosRisk (str, optional): 是否忽略持仓风险，默认为空。
-
-        返回:
-            dict: 子账户资金划转的响应。
-        """
         params = {'ccy': ccy, 'amt': amt, 'from': froms, 'to': to, 'fromSubAccount': fromSubAccount, 'toSubAccount': toSubAccount,'loanTrans':loanTrans,'omitPosRisk':omitPosRisk}
         return self._request_with_params(POST, SUBACCOUNT_TRANSFER, params)
 
     def entrust_subaccount_list(self, subAcct):
-        """
-        查询托管子账户列表。
-
-        参数:
-            subAcct (str): 子账户名称。
-
-        返回:
-            dict: 包含托管子账户列表的响应。
-        """
         params = {'subAcct': subAcct}
         return self._request_with_params(GET, ENTRUST_SUBACCOUNT_LIST, params)
 
     def modify_apikey(self, subAcct, apiKey, label, perm, ip):
-        """
-        修改子账户API密钥。
-
-        参数:
-            subAcct (str): 子账户名称。
-            apiKey (str): API密钥。
-            label (str): API密钥标签。
-            perm (str): 权限。
-            ip (str): IP地址。
-
-        返回:
-            dict: 修改API密钥的响应。
-        """
         params = {'subAcct': subAcct, 'apiKey': apiKey, 'label': label, 'perm': perm, 'ip': ip}
         return self._request_with_params(POST, MODIFY_APIKEY, params)
 
     def partner_if_rebate(self, apiKey = ''):
-        """
-        查询合伙人返佣信息。
-
-        参数:
-            apiKey (str, optional): API密钥，默认为空。
-
-        返回:
-            dict: 包含合伙人返佣信息的响应。
-        """
         params = {'apiKey': apiKey}
         return self._request_with_params(GET, PARTNER_IF_REBATE, params)
 
     # 获取子账户最大可转余额 max-withdrawal
     def max_withdrawal(self, subAcct, ccy = ''):
-        """
-        获取子账户最大可划转余额。
-
-        参数:
-            subAcct (str): 子账户名称。
-            ccy (str, optional): 币种，默认为空。
-
-        返回:
-            dict: 包含最大可划转余额的响应。
-        """
         params = {'subAcct': subAcct,'ccy': ccy,}
         return self._request_with_params(GET, MAX_WITHDRAW, params)
 
     # 查询托管子账户转账记录 managed-subaccount-bills
     def managed_subaccount_bills(self,ccy='',type='',subAcct='',subUid='',after='',before='',limit=''):
-        """
-        查询托管子账户转账记录。
-
-        参数:
-            ccy (str, optional): 币种，默认为空。
-            type (str, optional): 账单类型，默认为空。
-            subAcct (str, optional): 子账户名称，默认为空。
-            subUid (str, optional): 子账户UID，默认为空。
-            after (str, optional): 查询起始ID，默认为空。
-            before (str, optional): 查询结束ID，默认为空。
-            limit (str, optional): 返回结果的数量，默认为空。
-
-        返回:
-            dict: 包含托管子账户转账记录的响应。
-        """
         params = {'ccy': ccy,'type': type,'subAcct': subAcct,'subUid': subUid,'after': after,'before': before,
                   'limit': limit,}
-        return self._request_with_params(GET,SUB_BILLS,params)
+        return self._request_with_params(GET,SUB_BILLS,params)

okxv5/utils.py

@@ -6,98 +6,45 @@ from . import consts as c
 
 
 def sign(message, secretKey):
-    """
-    使用 HMAC-SHA256 算法对消息进行签名。
-    :param message: 要签名的消息。
-    :param secretKey: 密钥。
-    :return: 经过 base64 编码的签名。
-    """
-    # 使用 secretKey 作为密钥，对 message 进行 HMAC-SHA256 加密
     mac = hmac.new(bytes(secretKey, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod='sha256')
-    d = mac.digest()  # 获取摘要
-    return base64.b64encode(d)  # 对摘要进行 base64 编码
+    d = mac.digest()
+    return base64.b64encode(d)
 
 
 def pre_hash(timestamp, method, request_path, body):
-    """
-    生成预哈希字符串，用于构建签名消息。
-    :param timestamp: 时间戳。
-    :param method: HTTP 请求方法 (GET, POST 等)。
-    :param request_path: 请求路径。
-    :param body: 请求体。
-    :return: 拼接后的字符串。
-    """
-    # 拼接时间戳、大写的请求方法、请求路径和请求体
     return str(timestamp) + str.upper(method) + request_path + body
 
 
 def get_header(api_key, sign, timestamp, passphrase, flag):
-    """
-    生成 HTTP 请求头。
-    :param api_key: API 密钥。
-    :param sign: 签名。
-    :param timestamp: 时间戳。
-    :param passphrase: 密码。
-    :param flag: 模拟交易标志。
-    :return: 包含所有必要信息的字典形式的请求头。
-    """
     header = dict()
-    header[c.CONTENT_TYPE] = c.APPLICATION_JSON  # 设置内容类型为 JSON
-    header[c.OK_ACCESS_KEY] = api_key  # 设置 API 密钥
-    header[c.OK_ACCESS_SIGN] = sign  # 设置签名
-    header[c.OK_ACCESS_TIMESTAMP] = str(timestamp)  # 设置时间戳
-    header[c.OK_ACCESS_PASSPHRASE] = passphrase  # 设置密码
-
-    # OKX API: 'x-simulated-trading': '1' for simulated, '0' for real
-    # Our 'flag' parameter: '1' for real, '0' for simulated
-    # 所以，如果我们的 flag 是 '0' (模拟盘)，x-simulated-trading 设置为 '1'。
-    # 如果我们的 flag 是 '1' (实盘)，x-simulated-trading 设置为 '0'。
-    header['x-simulated-trading'] = '1' if flag == '0' else '0'
-
+    header[c.CONTENT_TYPE] = c.APPLICATION_JSON
+    header[c.OK_ACCESS_KEY] = api_key
+    header[c.OK_ACCESS_SIGN] = sign
+    header[c.OK_ACCESS_TIMESTAMP] = str(timestamp)
+    header[c.OK_ACCESS_PASSPHRASE] = passphrase
+    header['x-simulated-trading'] = flag
     return header
 
 
 def parse_params_to_str(params):
-    """
-    将字典形式的参数解析为 URL 查询字符串。
-    :param params: 字典形式的参数。
-    :return: URL 查询字符串。
-    """
     url = '?'
-    # 遍历参数字典，将键值对拼接成 URL 查询字符串
     for key, value in params.items():
         url = url + str(key) + '=' + str(value) + '&'
-    return url[0:-1]  # 去掉最后一个 '&'
+    return url[0:-1]
 
 
 def get_timestamp():
-    """
-    获取 UTC 时间戳，格式为 ISO 8601，带毫秒和 'Z'。
-    :return: UTC 时间戳字符串。
-    """
-    now = datetime.datetime.utcnow()  # 获取当前 UTC 时间
-    t = now.isoformat("T", "milliseconds")  # 格式化为 ISO 8601 字符串，包含毫秒
-    return t + "Z"  # 添加 'Z' 表示 UTC
+    now = datetime.datetime.utcnow()
+    t = now.isoformat("T", "milliseconds")
+    return t + "Z"
 
 
 def signature(timestamp, method, request_path, body, secret_key):
-    """
-    生成完整的签名。
-    :param timestamp: 时间戳。
-    :param method: HTTP 请求方法 (GET, POST 等)。
-    :param request_path: 请求路径。
-    :param body: 请求体。
-    :param secret_key: 密钥。
-    :return: 经过 base64 编码的签名。
-    """
-    # 如果请求体为空字典或 None，则将其设置为空字符串
     if str(body) == '{}' or str(body) == 'None':
         body = ''
-    # 拼接时间戳、大写的请求方法、请求路径和请求体，形成待签名的消息
     message = str(timestamp) + str.upper(method) + request_path + str(body)
 
-    # 使用 secret_key 作为密钥，对 message 进行 HMAC-SHA256 加密
     mac = hmac.new(bytes(secret_key, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod='sha256')
-    d = mac.digest()  # 获取摘要
+    d = mac.digest()
 
-    return base64.b64encode(d)  # 对摘要进行 base64 编码
+    return base64.b64encode(d)