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

okxv5/Market_api.py

@@ -3,295 +3,131 @@ from .consts import *
 
 
 class MarketAPI(Client):
-    """
-    市场行情API接口类，继承自Client
-    """
 
     def __init__(self, api_key, api_secret_key, passphrase, use_server_time=False, flag='1'):
-        """
-        构造函数
-        :param api_key: API Key
-        :param api_secret_key: API Secret Key
-        :param passphrase: 密码
-        :param use_server_time: 是否使用服务器时间 (默认为False)
-        :param flag: 请求类型 (默认为'1')
-        """
         Client.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag)
 
-    # Get Tickers 获取所有产品行情信息
+    # Get Tickers
     def get_tickers(self, instType, uly='',instFamily=''):
-        """
-        获取所有产品行情信息
-        :param instType: 产品类型
-        :param uly: 标的指数 (可选)
-        :param instFamily: 交易品种 (可选)
-        :return: 产品行情信息
-        """
         if uly:
             params = {'instType': instType, 'uly': uly}
         else:
             params = {'instType': instType}
         return self._request_with_params(GET, TICKERS_INFO, params)
 
-    # Get Ticker 获取单个产品行情信息
+    # Get Ticker
     def get_ticker(self, instId):
-        """
-        获取单个产品行情信息
-        :param instId: 产品ID
-        :return: 单个产品行情信息
-        """
         params = {'instId': instId}
         return self._request_with_params(GET, TICKER_INFO, params)
 
-    # Get Index Tickers 获取指数行情信息
+    # Get Index Tickers
     def get_index_ticker(self, quoteCcy='', instId=''):
-        """
-        获取指数行情信息
-        :param quoteCcy: 计价币种 (可选)
-        :param instId: 产品ID (可选)
-        :return: 指数行情信息
-        """
         params = {'quoteCcy': quoteCcy, 'instId': instId}
         return self._request_with_params(GET, INDEX_TICKERS, params)
 
-    # Get Order Book 获取产品深度信息
+    # Get Order Book
     def get_orderbook(self, instId, sz=''):
-        """
-        获取产品深度信息
-        :param instId: 产品ID
-        :param sz: 深度档位 (可选)
-        :return: 产品深度信息
-        """
         params = {'instId': instId, 'sz': sz}
         return self._request_with_params(GET, ORDER_BOOKS, params)
 
-    # Get Candlesticks 获取K线数据
+    # Get Candlesticks
     def get_candlesticks(self, instId, after='', before='', bar='', limit=''):
-        """
-        获取K线数据
-        :param instId: 产品ID
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param bar: 时间粒度 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: K线数据
-        """
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}
         return self._request_with_params(GET, MARKET_CANDLES, params)
 
-    # GGet Candlesticks History（top currencies only）获取K线数据历史 (仅适用于主流币种)
+    # GGet Candlesticks History（top currencies only）
     def get_history_candlesticks(self, instId, after='', before='', bar='', limit=''):
-        """
-        获取K线数据历史 (仅适用于主流币种)
-        :param instId: 产品ID
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param bar: 时间粒度 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: K线数据历史
-        """
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}
         return self._request_with_params(GET, HISTORY_CANDLES, params)
 
-    # Get Index Candlesticks 获取指数K线数据
+    # Get Index Candlesticks
     def get_index_candlesticks(self, instId, after='', before='', bar='', limit=''):
-        """
-        获取指数K线数据
-        :param instId: 产品ID
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param bar: 时间粒度 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: 指数K线数据
-        """
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}
         return self._request_with_params(GET, INDEX_CANSLES, params)
 
-    # Get Mark Price Candlesticks 获取标记价格K线数据
+    # Get Mark Price Candlesticks
     def get_markprice_candlesticks(self, instId, after='', before='', bar='', limit=''):
-        """
-        获取标记价格K线数据
-        :param instId: 产品ID
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param bar: 时间粒度 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: 标记价格K线数据
-        """
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}
         return self._request_with_params(GET, MARKPRICE_CANDLES, params)
 
-    # Get Index Candlesticks 获取成交明细
+    # Get Index Candlesticks
     def get_trades(self, instId, limit=''):
-        """
-        获取成交明细
-        :param instId: 产品ID
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: 成交明细
-        """
         params = {'instId': instId, 'limit': limit}
         return self._request_with_params(GET, MARKET_TRADES, params)
 
-    # Get Volume 获取公共基础信息 (交易量)
+    # Get Volume
     def get_volume(self):
-        """
-        获取公共基础信息 (交易量)
-        :return: 交易量信息
-        """
         return self._request_without_params(GET, VOLUMNE)
 
-    # Get Oracle 获取链上最新成交价
+    # Get Oracle
     def get_oracle(self):
-        """
-        获取链上最新成交价
-        :return: 链上最新成交价
-        """
         return self._request_without_params(GET, ORACLE)
 
-    # Get Index Components 获取指数成分
+    # Get Index Components
     def get_index_components(self, index):
-        """
-        获取指数成分
-        :param index: 指数ID
-        :return: 指数成分信息
-        """
         params = {'index': index}
         return self._request_with_params(GET, Components, params)
 
-    # Get Tier 获取杠杆利率和借币限额
+    # Get Tier
     def get_tier(self, instType='', tdMode='', uly='', instId='', ccy='', tier=''):
-        """
-        获取杠杆利率和借币限额
-        :param instType: 产品类型 (可选)
-        :param tdMode: 交易模式 (可选)
-        :param uly: 标的指数 (可选)
-        :param instId: 产品ID (可选)
-        :param ccy: 币种 (可选)
-        :param tier: 档位 (可选)
-        :return: 杠杆利率和借币限额
-        """
         params = {'instType': instType, 'tdMode': tdMode, 'uly': uly, 'instId': instId, 'ccy': ccy, 'tier': tier}
         return self._request_with_params(GET, TIER, params)
 
-    # Get exchange rate 获取法币汇率
+    # Get exchange rate
     def get_exchange_rate(self):
-        """
-        获取法币汇率
-        :return: 法币汇率
-        """
         params = {}
         return self._request_with_params(GET, BORROW_REPAY, params)
 
-    # Get history trades 获取历史成交明细
+    # Get history trades
     def get_history_trades(self, instId = '', after = '', before = '', limit = ''):
-        """
-        获取历史成交明细
-        :param instId: 产品ID (可选)
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: 历史成交明细
-        """
         params = {'instId':instId, 'after':after, 'before':before, 'limit':limit}
         return self._request_with_params(GET, HISTORY_TRADES, params)
 
-    # Get block history tickers 获取大宗交易产品行情列表
+    # Get block history tickers
     def get_block_tickers(self, instType = '', uly = '',instFamily =''):
-        """
-        获取大宗交易产品行情列表
-        :param instType: 产品类型 (可选)
-        :param uly: 标的指数 (可选)
-        :param instFamily: 交易品种 (可选)
-        :return: 大宗交易产品行情列表
-        """
         params = {'instType':instType, 'uly':uly,'instFamily':instFamily}
         return self._request_with_params(GET, BLOCK_TICKERS, params)
 
-    # Get block history ticker 获取大宗交易产品行情
+    # Get block history ticker
     def get_block_ticker(self, instId = ''):
-        """
-        获取大宗交易产品行情
-        :param instId: 产品ID (可选)
-        :return: 大宗交易产品行情
-        """
         params = {'instId':instId}
         return self._request_with_params(GET, BLOCK_TICKER, params)
 
-    # Get block trades 获取大宗交易公共成交数据
+    # Get block trades
     def get_block_trades(self, instId = ''):
-        """
-        获取大宗交易公共成交数据
-        :param instId: 产品ID (可选)
-        :return: 大宗交易公共成交数据
-        """
         params = {'instId':instId}
         return self._request_with_params(GET, BLOCK_TRADES, params)
 
-    # Get history index candlesticks 获取历史指数K线数据
+    # Get history index candlesticks
     def get_history_index_candlesticks(self, instId ='', after='', before='', bar='', limit=''):
-        """
-        获取历史指数K线数据
-        :param instId: 产品ID (可选)
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param bar: 时间粒度 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: 历史指数K线数据
-        """
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}
         return self._request_with_params(GET, HISTORY_INDEX_CANDLES, params)
 
-    # Get history mark price candlesticks 获取历史标记价格K线数据
+    # Get history mark price candlesticks
     def get_history_markprice_candlesticks(self, instId ='', after='', before='', bar='', limit=''):
-        """
-        获取历史标记价格K线数据
-        :param instId: 产品ID (可选)
-        :param after: 请求此时间戳之前（更旧）的数据 (可选)
-        :param before: 请求此时间戳之后（更新）的数据 (可选)
-        :param bar: 时间粒度 (可选)
-        :param limit: 返回结果的数量，默认100，最大300 (可选)
-        :return: 历史标记价格K线数据
-        """
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}
         return self._request_with_params(GET, HISTORY_MARK_PRICE_CANDLES, params)
 
-    # GET /api/v5/market/option/instrument-family-trades 获取期权交易品种最新成交
+    # GET /api/v5/market/option/instrument-family-trades
     def instrument_family_trades(self, instFamily = ''):
-        """
-        获取期权交易品种最新成交
-        :param instFamily: 交易品种 (可选)
-        :return: 期权交易品种最新成交数据
-        """
         params = {'instFamily':instFamily}
         return self._request_with_params(GET, INSTRUMENT_FAMILY_TRADES, params)
 
-    # GET /api/v5/market/books-lite 获取轻量级深度数据
+    # GET /api/v5/market/books-lite
     def get_books_lite(self, instId=''):
-        """
-        获取轻量级深度数据
-        :param instId: 产品ID (可选)
-        :return: 轻量级深度数据
-        """
         params = {'instId': instId}
         return self._request_with_params(GET, GET_BOOKS_LITE, params)
 
-    # books_full 获取全量深度数据
+
     def books_full(self, instId='',sz=''):
-        """
-        获取全量深度数据
-        :param instId: 产品ID (可选)
-        :param sz: 深度档位 (可选)
-        :return: 全量深度数据
-        """
         params = {'instId': instId,'sz':sz}
         return self._request_with_params(GET, BOOKS_FULL, params)
 
-    # GET /api/v5/market/call-auction-details 获取集合竞价信息
+    # GET /api/v5/market/call-auction-details
     def get_call_auction_details(self, instId=''):
-        """
-        获取集合竞价信息
-        :param instId: 产品ID (可选)
-        :return: 集合竞价信息
-        """
         params = {'instId': instId}
-        return self._request_with_params(GET, GET_CALL_AUCTION_DETAILS, params)
+        return self._request_with_params(GET, GET_CALL_AUCTION_DETAILS, params)
+
+
+
+

okxv5/Public_api.py

@@ -1,151 +1,107 @@
-# 从 .client 模块导入 Client 类
 from .client import Client
-# 从 .consts 模块导入所有常量
 from .consts import *
 
 
-# PublicAPI 类继承自 Client 类
 class PublicAPI(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)
 
-    # 获取交易产品列表
+    # Get Instruments
     def get_instruments(self, instType = 'FUTURES', uly = 'BTC-USDT', instFamily = '', instId = ''):
-        # 构造请求参数
         params = {'instType': instType, 'uly': uly, 'instId': instId, 'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, INSTRUMENT_INFO, params)
 
-    # 获取交割/行权历史
+    # Get Delivery/Exercise History
     def get_deliver_history(self, instType, uly, after='', before='', limit=''):
-        # 构造请求参数
         params = {'instType': instType, 'uly': uly, 'after': after, 'before': before, 'limit': limit}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, DELIVERY_EXERCISE, params)
 
-    # 获取持仓量
+    # Get Open Interest
     def get_open_interest(self, instType, uly='', instId='',instFamily=''):
-        # 构造请求参数
         params = {'instType': instType, 'uly': uly, 'instId': instId,'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, OPEN_INTEREST, params)
 
-    # 获取资金费率
+    # Get Funding Rate
     def get_funding_rate(self, instId):
-        # 构造请求参数
         params = {'instId': instId}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, FUNDING_RATE, params)
 
-    # 获取资金费率历史
+    # Get Funding Rate History
     def funding_rate_history(self, instId, after='', before='', limit=''):
-        # 构造请求参数
         params = {'instId': instId, 'after': after, 'before': before, 'limit': limit}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, FUNDING_RATE_HISTORY, params)
 
-    # 获取限价
+    # Get Limit Price
     def get_price_limit(self, instId):
-        # 构造请求参数
         params = {'instId': instId}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, PRICE_LIMIT, params)
 
-    # 获取期权市场数据
+    # Get Option Market Data
     def get_opt_summary(self, uly, expTime=''):
-        # 构造请求参数
         params = {'uly': uly, 'expTime': expTime}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, OPT_SUMMARY, params)
 
-    # 获取预估交割/行权价格
+    # Get Estimated Delivery/Excercise Price
     def get_estimated_price(self, instId):
-        # 构造请求参数
         params = {'instId': instId}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, ESTIMATED_PRICE, params)
 
-    # 获取折扣率和免息额度
+    # Get Discount Rate And Interest-Free Quota
     def discount_interest_free_quota(self, ccy=''):
-        # 构造请求参数
         params = {'ccy': ccy}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, DICCOUNT_INTETEST_INFO, params)
 
-    # 获取系统时间
+    # Get System Time
     def get_system_time(self):
-        # 发送不带参数的 GET 请求
         return self._request_without_params(GET, SYSTEM_TIME)
 
-    # 获取爆仓订单
+    # Get Liquidation Orders
     def get_liquidation_orders(self, instType, mgnMode='', instId='', ccy='', uly='', alias='', state='', before='',
                                after='', limit='',instFamily = ''):
-        # 构造请求参数
         params = {'instType': instType, 'mgnMode': mgnMode, 'instId': instId, 'ccy': ccy, 'uly': uly,
                   'alias': alias, 'state': state, 'before': before, 'after': after, 'limit': limit,'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, LIQUIDATION_ORDERS, params)
 
-    # 获取标记价格
+    # Get Mark Price
     def get_mark_price(self, instType, uly='', instId='',instFamily=''):
-        # 构造请求参数
         params = {'instType': instType, 'uly': uly, 'instId': instId,'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, MARK_PRICE, params)
 
-    # 获取等级费率
+    # Get Tier
     def get_tier(self, instType, tdMode, uly='', instId='', ccy='', tier='',instFamily=''):
-        # 构造请求参数
         params = {'instType': instType, 'tdMode': tdMode, 'uly': uly, 'instId': instId, 'ccy': ccy, 'tier': tier,'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, TIER, params)
 
-    # 获取利率和借贷额度
+    # Get Interest Rate and Loan Quota
     def get_interest_loan(self):
-        # 发送不带参数的 GET 请求
         return self._request_without_params(GET, INTEREST_LOAN)
 
-    # 获取标的指数
+    # Get underlying
+
     def get_underlying(self, instType):
-        # 构造请求参数
         params = {'instType': instType}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, UNDERLYING, params)
 
-    # 获取 VIP 利率借贷额度
+    # GET Obtain the privileged currency borrowing leverage rate and currency borrowing limit
     def get_vip_interest_rate_loan_quota(self):
-        # 构造空参数
         params = {}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, VIP_INTEREST_RATE_LOAN_QUOTA, params)
 
-    # 获取保险基金数据
     def get_insurance_fund(self,instType = '', type = '', uly = '', ccy = '', before = '', after = '', limit = '',instFamily=''):
-        # 构造请求参数
         params = {'instType':instType, 'type':type, 'uly':uly, 'ccy':ccy, 'before':before, 'after':after, 'limit':limit,'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, INSURANCE_FUND, params)
 
-    # 转换合约币种
     def convert_contract_coin(self, type = '', instId = '', sz = '', px = '', unit = '', opType=''):
-        # 构造请求参数
         params = {'type':type, 'instId':instId, 'sz':sz, 'px':px, 'unit':unit, 'opType':opType}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, CONVERT_CONTRACT_COIN, params)
 
-    # 获取交易产品最小变动档位
+    # GET /api/v5/public/instrument-tick-bands
     def instrument_tick_bands(self, instType = '', instFamily = ''):
-        # 构造请求参数
         params = {'instType':instType, 'instFamily':instFamily}
-        # 发送带参数的 GET 请求
         return self._request_with_params(GET, INSTRUMENT_TICK_BANDS, params)
 
-    # 获取期权最新成交
+    # GET /api/v5/public/option-trades
     def option_trades(self, instId = '', instFamily = '', optType = ''):
-        # 构造请求参数
         params = {'instId':instId, 'instFamily':instFamily, 'optType':optType}
-        # 发送带参数的 GET 请求
-        return self._request_with_params(GET, OPTION_TRADES, params)
+        return self._request_with_params(GET, OPTION_TRADES, params)

okxv5/Recurring_api.py

@@ -4,96 +4,39 @@ from .consts import *
 
 class RecurringAPI(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)
 
     # POST /api/v5/tradingBot/recurring/order-algo
     def recurring_order_algo(self, stgyName = '', recurringList = [], period = '', recurringDay = '', recurringTime = '', timeZone = '', amt = '', investmentCcy = '', tdMode = '', algoClOrdId = '', tag = ''):
-        """
-        创建定投策略订单
-        参数:
-            stgyName: 策略名称
-            recurringList: 定投列表，包含定投币种和比例等信息
-            period: 定投周期类型
-            recurringDay: 定投日 (period 为 weekly 或 monthly 时必填)
-            recurringTime: 定投时间 (HH:MM)
-            timeZone: 时区
-            amt: 每期定投金额
-            investmentCcy: 投资币种
-            tdMode: 交易模式
-            algoClOrdId: 用户自定义的策略订单 ID
-            tag: 自定义标签
-        """
         params = {'stgyName': stgyName, 'recurringList': recurringList, 'period': period, 'recurringDay':recurringDay, 'recurringTime': recurringTime,
         'timeZone': timeZone,'amt': amt,'investmentCcy': investmentCcy,'tdMode': tdMode,'algoClOrdId': algoClOrdId,'tag': tag}
         return self._request_with_params(POST, RECURRING_ORDER_ALGO, params)
 
     # POST /api/v5/tradingBot/recurring/amend-order-algo
     def recurring_amend_order_algo(self, algoId = '', stgyName = ''):
-        """
-        修改定投策略订单
-        参数:
-            algoId: 策略 ID
-            stgyName: 策略名称 (修改后的名称)
-        """
         params = {'algoId': algoId, 'stgyName': stgyName}
         return self._request_with_params(POST, RECURRING_AMEND_ORDER_ALGO, params)
 
     # POST /api/v5/tradingBot/recurring/stop-order-algo
     def recurring_stop_order_algo(self, orders_data):
-        """
-        停止定投策略订单
-        参数:
-            orders_data: 包含要停止的策略 ID 的数据列表
-        """
         return self._request_with_params(POST, RECURRING_STOP_ORDER_ALGO, orders_data)
 
     # GET /api/v5/tradingBot/recurring/orders-algo-pending
     def recurring_orders_algo_pending(self, algoId = '', after = '', before = '', limit = ''):
-        """
-        获取定投策略待处理订单列表
-        参数:
-            algoId: 策略 ID
-            after: 查询此 ID 之后的数据
-            before: 查询此 ID 之前的数据
-            limit: 返回结果的数量，默认 100，最大 100
-        """
         params = {'algoId': algoId, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, RECURRING_ORDER_ALGO_PENDING, params)
 
     # GET /api/v5/tradingBot/recurring/orders-algo-history
     def recurring_orders_algo_history(self, algoId = '', after = '', before = '', limit = ''):
-        """
-        获取定投策略历史订单列表
-        参数:
-            algoId: 策略 ID
-            after: 查询此 ID 之后的数据
-            before: 查询此 ID 之前的数据
-            limit: 返回结果的数量，默认 100，最大 100
-        """
         params = {'algoId': algoId, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, RECURRING_ORDER_ALGO_HISTORY, params)
 
     # GET /api/v5/tradingBot/recurring/orders-algo-details
     def recurring_orders_algo_details(self, algoId = ''):
-        """
-        获取定投策略订单详情
-        参数:
-            algoId: 策略 ID (必填)
-        """
         params = {'algoId': algoId}
         return self._request_with_params(GET, RECURRING_ORDER_ALGO_DETAILS, params)
 
     # GET /api/v5/tradingBot/recurring/sub-orders
     def recurring_sub_orders(self, algoId = '', ordId = '', after = '', before = '', limit = ''):
-        """
-        获取定投子订单列表
-        参数:
-            algoId: 策略 ID
-            ordId: 子订单 ID
-            after: 查询此 ID 之后的数据
-            before: 查询此 ID 之前的数据
-            limit: 返回结果的数量，默认 100，最大 100
-        """
         params = {'algoId': algoId, 'ordId': ordId, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, RECURRING_SUB_ORDERS, params)