Package: okx-api
okx_api 说明文档1 okx_api设计目的目前没有交易所承认的官方Rest Api Python Sdk，只有推荐的第三方项目，虽然也很好但是对于官方接口更新的维护较慢，我需要最新的底层接口支持。关于Okx，我开发了比较多的功能框架，例如获取实时行情数据的okx_candle，实盘现货交易框架：okx_spot，实盘永续合约交易框架：okx_swap，Okx的综合功能框架：okx（项目名就叫okx，pip install okx），所以公用的稳定底层十分重要。okx_api是对交易所接口的底层封装，并非高级封装，对于熟悉Okx量化交易者来说仅需很少的学习成本。2 下载okx_apiGITHUB：https://github.com/pyted/okx_apipip3installokx_api3 使用okx_api的例子fromokx_apiimportMarket# 导入行情数据frompprintimportpprintif__name__=='__main__':# 行情数据无需添加key、secret与passphrasekey=''secret=''passphrase=''flag='0'# flag = '0' 实盘 flag = '1' 模拟盘market=Market()# 获取现货交易BTC-USDT的行情信息result=market.get_ticker(instId='BTC-USDT')pprint(result)输出：>> {'code': '0',
>>  'data': [{'askPx': '23352.5',
>>            'askSz': '1.26608653',
>>            'bidPx': '23352.4',
>>            'bidSz': '0.46033212',
>>            'high24h': '23722.5',
>>            'instId': 'BTC-USDT',
>>            'instType': 'SPOT',
>>            'last': '23352.5',
>>            'lastSz': '0.01734077',
>>            'low24h': '23211',
>>            'open24h': '23463.6',
>>            'sodUtc0': '23431.3',
>>            'sodUtc8': '23603.6',
>>            'ts': '1675510037012',
>>            'vol24h': '5108.83404369',
>>            'volCcy24h': '119705529.10438071'}],
>>  'msg': ''}4 okx_api的说明okx_api是对REST API接口的封装，不包含WebSocket API。okx_api的请求参数和返回结果与官方一致okx_api服务器网络问题时，会尝试重新请求，重新请求的状态码有：50001 服务暂时不可用，请稍后重试50004 接口请求超时（不代表请求成功或者失败，请检查请求结果）50011 用户请求频率过快，超过该接口允许的限额。请参考 API 文档并限制请求50013 当前系统繁忙，请稍后重试50026 系统错误，请稍后重试okx_api包含功能：接口种类类名称是否需要秘钥交易okx_api.Trade是资金okx_api.Funding是闪兑okx_api.Convert是账户okx_api.Account是子账户okx_api.SubAccount是网格交易okx_api.Grid是赚币okx_api.Staking是跟单接口okx_api.CopyTrading是行情数据okx_api.Market否公共数据okx_api.Public否交易大数据okx_api.Rubik否Status（系统状态）okx_api.System否全部功能类的实例化都包含4个参数：key，默认值：''secret，默认值：''passphrase，默认值：''flag，默认值：'1''0' 实盘'1' 模拟盘个人测试发现模拟盘的数据接口功能并不完善，对于待上线项目，建议直接采用小金额实盘接口测试。6. 交易模块 Trade6.1 交易接口总览接口名称函数名称下单set_order批量下单set_batch_orders撤单set_cancel_order批量撤单set_cancel_batch_orders修改订单set_amend_order批量修改订单set_amend_batch_orders市价仓位全平set_close_position获取订单信息get_order获取未成交订单列表get_orders_pending获取历史订单记录（近七天）get_orders_history获取历史订单记录（近三个月）get_orders_history_archive获取成交明细（近三天）get_fills获取成交明细（近三个月）get_fills_history策略委托下单set_order_algo撤销策略委托订单set_cancel_algos撤销高级策略委托订单set_cancel_advance_algos获取未完成策略委托单列表get_orders_algo_pending获取历史策略委托单列表get_orders_algo_history获取一键兑换主流币币种列表get_easy_convert_currency_list一键兑换主流币交易set_easy_convert获取一键兑换主流币历史记录get_easy_convert_history获取一键还债币种列表get_one_click_repay_currency_list一键还债交易set_one_click_repay获取一键还债历史记录get_one_click_repay_history6.2 交易接口介绍6.2.1 下单 set_order请求路径：/api/v5/trade/order 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-190927-5000-CtdModeString是交易模式保证金模式：isolated：逐仓 ；cross：全仓非保证金模式：cash：非保证金sideString是订单方向buy：买，sell：卖ordTypeString是订单类型market：市价单limit：限价单post_only：只做maker单fok：全部成交或立即取消ioc：立即成交并取消剩余optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）szString是委托数量ccyString否保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单clOrdIdString否客户自定义订单ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。tagString否订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。posSideString可选持仓方向在双向持仓模式下必填，且仅可选择long或short。 仅适用交割、永续。pxString可选委托价格，仅适用于limit、post_only、fok、ioc类型的订单reduceOnlyBoolean否是否只减仓，true或false，默认false仅适用于币币杠杆，以及买卖模式下的交割/永续仅适用于单币种保证金模式和跨币种保证金模式tgtCcyString否市价单委托数量sz的单位，仅适用于币币市价订单base_ccy: 交易货币 ；quote_ccy：计价货币买单默认quote_ccy， 卖单默认base_ccybanAmendBoolean否是否禁止币币市价改单，true 或 false，默认false为true时，余额不足时，系统不会改单，下单会失败，仅适用于币币市价单tpTriggerPxString否止盈触发价，如果填写此参数，必须填写 止盈委托价tpOrdPxString否止盈委托价，如果填写此参数，必须填写 止盈触发价委托价格为-1时，执行市价止盈slTriggerPxString否止损触发价，如果填写此参数，必须填写 止损委托价slOrdPxString否止损委托价，如果填写此参数，必须填写 止损触发价委托价格为-1时，执行市价止损tpTriggerPxTypeString否止盈触发价类型last：最新价格index：指数价格mark：标记价格默认为lastslTriggerPxTypeString否止损触发价类型last：最新价格index：指数价格mark：标记价格默认为lastquickMgnTypeString否一键借币类型，仅适用于杠杆逐仓的一键借币模式：manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币默认是manual：手动6.2.2 批量下单 set_batch_orders请求路径：/api/v5/trade/batch-orders 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-190927-5000-CtdModeString是交易模式保证金模式：isolated：逐仓 ；cross：全仓非保证金模式：cash：非保证金sideString是订单方向buy：买，sell：卖ordTypeString是订单类型market：市价单limit：限价单post_only：只做maker单fok：全部成交或立即取消ioc：立即成交并取消剩余optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）szString是委托数量ccyString否保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单clOrdIdString否客户自定义订单ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。tagString否订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-16位之间。posSideString可选持仓方向在双向持仓模式下必填，且仅可选择long或short。 仅适用交割、永续。pxString否委托价格，仅适用于limit、post_only、fok、ioc类型的订单reduceOnlyBoolean否是否只减仓，true或false，默认false仅适用于币币杠杆，以及买卖模式下的交割/永续仅适用于单币种保证金模式和跨币种保证金模式tgtCcyString否市价单委托数量sz的单位，仅适用于币币市价订单base_ccy: 交易货币 ；quote_ccy：计价货币买单默认quote_ccy， 卖单默认base_ccybanAmendBoolean否是否禁止币币市价改单，true 或 false，默认false为true时，余额不足时，系统不会改单，下单会失败，仅适用于币币市价单tpTriggerPxString否止盈触发价，如果填写此参数，必须填写 止盈委托价tpOrdPxString否止盈委托价，如果填写此参数，必须填写 止盈触发价委托价格为-1时，执行市价止盈slTriggerPxString否止损触发价，如果填写此参数，必须填写 止损委托价slOrdPxString否止损委托价，如果填写此参数，必须填写 止损触发价委托价格为-1时，执行市价止损tpTriggerPxTypeString否止盈触发价类型last：最新价格index：指数价格mark：标记价格默认为lastslTriggerPxTypeString否止损触发价类型last：最新价格index：指数价格mark：标记价格默认为lastquickMgnTypeString否一键借币类型，仅适用于杠杆逐仓的一键借币模式：manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币默认是manual：手动6.2.3 撤单 set_cancel_order请求路径：/api/v5/trade/cancel-order 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-190927ordIdString可选订单ID，ordId和clOrdId必须传一个，若传两个，以ordId为主clOrdIdString可选用户自定义ID6.2.4 批量撤单 set_cancel_batch_orders请求路径：/api/v5/trade/cancel-batch-orders 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-190927ordIdString可选订单ID，ordId和clOrdId必须传一个，若传两个，以ordId为主clOrdIdString可选用户自定义ID6.2.5 修改订单 set_amend_order请求路径：/api/v5/trade/amend-order 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品IDcxlOnFailBoolean否false：不自动撤单true：自动撤单 当订单修改失败时，该订单是否需要自动撤销。默认为falseordIdString可选订单ID，ordId和clOrdId必须传一个，若传两个，以ordId为主clOrdIdString可选用户自定义order IDreqIdString否用户自定义修改事件ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。newSzString可选修改的新数量，newSz和newPx不可同时为空。对于部分成交订单，该数量应包含已成交数量。newPxString可选修改的新价格6.2.6 批量修改订单 set_amend_batch_orders请求路径：/api/v5/trade/amend-batch-orders 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品IDcxlOnFailBoolean否false：不自动撤单true：自动撤单 当订单修改失败时，该订单是否需要自动撤销，默认为falseordIdString可选订单ID，ordId和clOrdId必须传一个，若传两个，以ordId为主clOrdIdString可选用户自定义order IDreqIdString否用户自定义修改事件ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。newSzString可选修改的新数量，newSz和newPx不可同时为空。对于部分成交订单，该数量应包含已成交数量。newPxString可选修改的新价格6.2.7 市价仓位全平 set_close_position请求路径：/api/v5/trade/close-position 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品IDmgnModeString是保证金模式cross：全仓 ；isolated：逐仓posSideString可选持仓方向单向持仓模式下：可不填写此参数，默认值net，如果填写，仅可以填写net双向持仓模式下： 必须填写此参数，且仅可以填写long：平多 ，short：平空ccyString可选保证金币种，单币种保证金模式的全仓币币杠杆平仓必填autoCxlBoolean否当市价全平时，平仓单是否需要自动撤销,默认为false.false：不自动撤单true：自动撤单clOrdIdString否客户自定义ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。tagString否订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。6.2.8 获取订单信息 get_order请求路径：/api/v5/trade/order 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID ，如BTC-USD-190927ordIdString可选订单ID ，ordId和clOrdId必须传一个，若传两个，以ordId为主clOrdIdString可选用户自定义ID6.2.9 获取未成交订单列表 get_orders_pending请求路径：/api/v5/trade/orders-pending 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数instFamilyString否交易品种适用于交割/永续/期权instIdString否产品ID，如BTC-USD-200927ordTypeString否订单类型market：市价单limit：限价单post_only：只做maker单fok：全部成交或立即取消ioc：立即成交并取消剩余optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）stateString否订单状态live：等待成交partially_filled：部分成交afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordIdlimitString否返回结果的数量，最大为100，默认100条6.2.10 获取历史订单记录（近七天） get_orders_history请求路径：/api/v5/trade/orders-history 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数instFamilyString否交易品种适用于交割/永续/期权instIdString否产品ID，如BTC-USD-190927ordTypeString否订单类型market：市价单limit：限价单post_only：只做maker单fok：全部成交或立即取消ioc：立即成交并取消剩余optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）stateString否订单状态canceled：撤单成功filled：完全成交categoryString否订单种类twap：TWAP自动换币adl：ADL自动减仓full_liquidation：强制平仓partial_liquidation：强制减仓delivery：交割ddh：对冲减仓类型订单afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否返回结果的数量，最大为100，默认100条6.2.11 获取历史订单记录（近三个月） get_orders_history_archive请求路径：/api/v5/trade/orders-history-archive 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数instFamilyString否交易品种适用于交割/永续/期权instIdString否产品ID，如BTC-USD-200927ordTypeString否订单类型market：市价单limit：限价单post_only：只做maker单fok：全部成交或立即取消ioc：立即成交并取消剩余optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）stateString否订单状态canceled：撤单成功filled：完全成交categoryString否订单种类twap：TWAP自动换币adl：ADL自动减仓full_liquidation：强制平仓partial_liquidation：强制减仓delivery：交割ddh：对冲减仓类型订单afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否返回结果的数量，最大为100，默认100条6.2.12 获取成交明细（近三天） get_fills请求路径：/api/v5/trade/fills 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数instFamilyString否交易品种适用于交割/永续/期权instIdString否产品 ID，如BTC-USD-190927ordIdString否订单 IDafterString否请求此 ID 之前（更旧的数据）的分页内容，传的值为对应接口的billIdbeforeString否请求此 ID 之后（更新的数据）的分页内容，传的值为对应接口的billIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否返回结果的数量，最大为100，默认100条6.2.13 获取成交明细（近三个月） get_fills_history请求路径：/api/v5/trade/fills-history 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数instFamilyString否交易品种适用于交割/永续/期权instIdString否产品 ID，如BTC-USD-190927ordIdString否订单 IDafterString否请求此 ID 之前（更旧的数据）的分页内容，传的值为对应接口的billIdbeforeString否请求此 ID 之后（更新的数据）的分页内容，传的值为对应接口的billIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否返回结果的数量，最大为100，默认100条6.2.14 策略委托下单 set_order_algo请求路径：/api/v5/trade/order-algo 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-190927-5000-CtdModeString是交易模式保证金模式isolated：逐仓，cross：全仓非保证金模式cash：非保证金sideString是订单方向buy：买sell：卖ordTypeString是订单类型conditional：单向止盈止损oco：双向止盈止损trigger：计划委托move_order_stop：移动止盈止损iceberg：冰山委托twap：时间加权委托ccyString否保证金币种仅适用于单币种保证金模式下的全仓杠杆订单posSideString可选持仓方向在双向持仓模式下必填，且仅可选择long或shortszString可选委托数量sz和closeFraction必填且只能填其一tagString否订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间tgtCcyString否委托数量的类型base_ccy: 交易货币 ；quote_ccy：计价货币仅适用于币币单向止盈止损市价买单默认买为计价货币，卖为交易货币reduceOnlyBoolean否是否只减仓，true或false，默认false仅适用于币币杠杆，以及买卖模式下的交割/永续仅适用于单币种保证金模式和跨币种保证金模式clOrdIdString否客户自定义订单ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间closeFractionString可选策略委托触发时，平仓的百分比。1 代表100%现在系统只支持全部平仓，唯一接受参数为1仅适用于交割或永续仅适用于买卖模式posSide=net仅适用于减仓订单reduceOnly=true仅适用于止盈止损ordType=conditional或oco仅适用于止盈止损市价订单sz和closeFraction必填且只能填其一quickMgnTypeString否一键借币类型，仅适用于杠杆逐仓的一键借币模式：manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币默认是manual：手动6.2.15 撤销策略委托订单 set_cancel_algos请求路径：/api/v5/trade/cancel-algos 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略委托单IDinstIdString是产品ID 如BTC-USDT6.2.16 撤销高级策略委托订单 set_cancel_advance_algos请求路径：/api/v5/trade/cancel-advance-algos 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略委托单IDinstIdString是产品ID 如BTC-USDT6.2.17 获取未完成策略委托单列表 get_orders_algo_pending请求路径：/api/v5/trade/orders-algo-pending 请求方法：GET请求参数：参数名类型是否必须描述ordTypeString是订单类型conditional：单向止盈止损oco：双向止盈止损trigger：计划委托move_order_stop：移动止盈止损iceberg：冰山委托twap：时间加权委托algoIdString否策略委托单IDinstTypeString否产品类型SPOT：币币SWAP：永续合约FUTURES：交割合约MARGIN：杠杆instIdString否产品ID，BTC-USD-190927afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoIdlimitString否返回结果的数量，最大为100，默认100条clOrdIdString否客户自定义订单ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。6.2.18 获取历史策略委托单列表 get_orders_algo_history请求路径：/api/v5/trade/orders-algo-history 请求方法：GET请求参数：参数名类型是否必须描述ordTypeString是订单类型conditional：单向止盈止损oco：双向止盈止损trigger：计划委托move_order_stop：移动止盈止损iceberg：冰山委托twap：时间加权委托stateString可选订单状态effective：已生效canceled：已经撤销order_failed：委托失败【state和algoId必填且只能填其一】algoIdString可选策略委托单ID 【state和algoId必填且只能填其一】instTypeString否产品类型SPOT：币币SWAP：永续合约FUTURES：交割合约MARGIN：杠杆instIdString否产品ID，BTC-USD-190927afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoIdlimitString否返回结果的数量，最大为100，默认100条6.2.19 获取一键兑换主流币币种列表 get_easy_convert_currency_list请求路径：/api/v5/trade/easy-convert-currency-list 请求方法：GET请求参数：无6.2.20 一键兑换主流币交易 set_easy_convert请求路径：/api/v5/trade/easy-convert 请求方法：POST请求参数：参数名类型是否必须描述fromCcyArray是小币支付币种单次最多同时选择5个币种，如有多个币种则用逗号隔开toCcyString是兑换的主流币只选择一个币种，且不能和小币支付币种重复6.2.21 获取一键兑换主流币历史记录 get_easy_convert_history请求路径：/api/v5/trade/easy-convert-history 请求方法：GET请求参数：参数名类型是否必须描述afterString否查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式，如1597026383085beforeString否查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式，如1597026383085limitString否返回的结果集数量，默认为100，最大为1006.2.22 获取一键还债币种列表 get_one_click_repay_currency_list请求路径：/api/v5/trade/one-click-repay-currency-list 请求方法：GET请求参数：参数名类型是否必须描述debtTypeString否负债类型cross: 全仓负债isolated: 逐仓负债6.2.23 一键还债交易 set_one_click_repay请求路径：/api/v5/trade/one-click-repay 请求方法：POST请求参数：参数名类型是否必须描述debtCcyArray是负债币种单次最多同时选择5个币种，如有多个币种则用逗号隔开repayCcyString是偿还币种只选择一个币种，且不能和负债币种重复6.2.24 获取一键还债历史记录 get_one_click_repay_history请求路径：/api/v5/trade/one-click-repay-history 请求方法：GET请求参数：参数名类型是否必须描述afterString否查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式，如1597026383085beforeString否查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式，如1597026383085limitString否返回的结果集数量，默认为100，最大为1006.3 例子交易模块必须填写秘钥fromokx_apiimportTradefrompprintimportpprintif__name__=='__main__':# 交易模块需要秘钥key='****'secret='****'passphrase='****'flag='0'trade=Trade(key,secret,passphrase,flag)# 限价单购买BTC-USDT现货，数量2，价格1result=trade.set_order(instId='BTC-USDT',tdMode='cash',side='buy',ordType='limit',px='1',sz='2',)pprint(result)输出：>> {'code': '0',
>>  'data': [{'clOrdId': '',
>>            'ordId': '542313757641707520',
>>            'sCode': '0',
>>            'sMsg': 'Order placed',
>>            'tag': ''}],
>>  'msg': ''}7 资金 Funding7.1  资金接口总览接口名称函数名称获取币种列表get_currencies获取资金账户余额get_balances获取不可交易资产get_non_tradable_assets获取账户资产估值get_asset_valuation资金划转set_transfer获取资金划转状态get_transfer_state获取资金流水get_bills闪电网络充币get_deposit_lightning获取充值地址信息get_deposit_address获取充值记录get_deposit_history提币set_withdrawal闪电网络提币set_withdrawal_lightning撤销提币set_cancel_withdrawal获取提币记录get_withdrawal_history获取充值/提现的详细状态get_deposit_withdraw_status小额资产兑换set_convert_dust_assets获取余币宝余额get_saving_balance余币宝申购/赎回set_purchase_redempt设置余币宝借贷利率set_set_lending_rate获取余币宝出借明细get_lending_history获取市场借贷信息（公共）get_lending_rate_summary获取市场借贷历史（公共）get_lending_rate_history7.2  资金接口介绍7.2.1 获取币种列表 get_currencies请求路径：/api/v5/asset/currencies 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC支持多币种查询（不超过20个），币种之间半角逗号分隔7.2.2 获取资金账户余额 get_balances请求路径：/api/v5/asset/balances 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC支持多币种查询（不超过20个），币种之间半角逗号分隔7.2.3 获取不可交易资产 get_non_tradable_assets请求路径：/api/v5/asset/non-tradable-assets 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC支持多币种查询（不超过20个），币种之间半角逗号分隔7.2.4 获取账户资产估值 get_asset_valuation请求路径：/api/v5/asset/asset-valuation 请求方法：GET请求参数：参数名类型是否必须描述ccyString否资产估值对应的单位BTC 、USDTUSD 、CNY 、JPY、KRW、RUB、EURVND 、IDR 、INR、PHP、THB、TRYAUD 、SGD 、ARS、SAR、AED、IQD默认为  BTC 为单位的估值7.2.5 资金划转 set_transfer请求路径：/api/v5/asset/transfer 请求方法：POST请求参数：参数名类型是否必须描述ccyString是币种，如USDTamtString是划转数量fromString是转出账户6：资金账户18：交易账户toString是转入账户6：资金账户18：交易账户subAcctString可选子账户名称，type 为1，2或4：subAcct 为必填项typeString否划转类型0：账户内划转1：母账户转子账户(仅适用于母账户APIKey)2：子账户转母账户(仅适用于母账户APIKey)3：子账户转母账户(仅适用于子账户APIKey)4：子账户转子账户(仅适用于子账户APIKey，且目标账户需要是同一母账户下的其他子账户)默认是0loanTransBoolean否是否支持跨币种保证金模式或组合保证金模式下的借币转入/转出true 或 false，默认falseclientIdString否客户自定义ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。omitPosRiskString否是否忽略仓位风险默认为false仅适用于组合保证金模式7.2.6 获取资金划转状态 get_transfer_state请求路径：/api/v5/asset/transfer-state 请求方法：GET请求参数：参数名类型是否必须描述transIdString可选划转IDtransId和clientId必须传一个，若传两个，以transId为主clientIdString可选客户自定义IDtypeString否划转类型0：账户内划转1：母账户转子账户(仅适用于母账户APIKey)2：子账户转母账户(仅适用于母账户APIKey)3：子账户转母账户(仅适用于子账户APIKey)4：子账户转子账户(仅适用于子账户APIKey，且目标账户需要是同一母账户下的其他子账户)默认是07.2.7 获取资金流水 get_bills请求路径：/api/v5/asset/bills 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种typeString否账单类型1：充值2：提现13：撤销提现20：转出至子账户（主体是母账户）21：从子账户转入（主体是母账户）22：转出到母账户（主体是子账户）23：母账户转入（主体是子账户）28：领取47：系统冲正48：活动得到49：活动送出50：预约得到51：预约扣除52：发红包53：抢红包54：红包退还61：兑换68：领取卡券权益69：发送卡券权益72：收币73：送币74：送币退还75：申购余币宝76：赎回余币宝77：派发78：锁定79：节点投票80：锁仓挖矿81：投票赎回82：锁仓赎回83：锁仓挖矿收益84：违约金85：算力挖矿收益86：云算力支付87：云算力收益88：补贴收益89：存币收益90：挖矿申购91：挖矿赎回92：补充质押物93：赎回质押物94：投资95：借款人借款96：投资本金转入97：借款人借款转出98：借款人借款利息转出99：投资人投资利息转入102：提前还款违约金转入103：提前还款违约金转出104：抵押借贷手续费转入105：抵押借贷手续费转出106：逾期手续费转入107：逾期手续费转出108：逾期利息转出109：借款还款逾期利息转入110：平仓质押物转入到系统账号111：平仓质押物转出到系统账号112：爆仓质押物转入到系统账号113：爆仓质押物转出到系统账号114：风险准备金转入115：风险准备金转出116：创建订单117：完成订单118：取消订单119：商家解冻保证金120：商家添加保证金121：FiatGateway 创建订单122：FiatGateway 取消订单123：FiatGateway 完成订单124：Jumpstart 解锁125：手动注入126：利息注入127：投资手续费转入128：投资手续费转出129：奖励转入130：从交易账户转入131：转出至交易账户132：客服冻结133：客服解冻134：客服转交135：跨链兑换136：兑换137：ETH2.0申购138：ETH2.0兑换139：ETH2.0收益143：系统退款145：系统回收146：客户回馈147：sushi 增发收益150：节点返佣151：邀请奖励152：经纪商返佣153：新手奖励154：拆盲盒奖励155：福利中心提现156：返佣卡返佣157：红包160：双币赢申购161：双币赢回款162：双币赢收益163：双币赢退款169：2022春节红包172：助力人返佣173：手续费返现174：支付175：锁定质押物176：借款转入177：添加质押物178：减少质押物179：还款180：释放质押物181：偿还空投糖果182：反馈奖励183：邀请好友奖励184：瓜分奖池奖励185：经纪商闪兑返佣186：0元领ETH187：闪兑划转188：插槽竞拍兑换189：盲盒奖励193：卡支付购买195：不可交易资产提币196：不可交易资产提币撤销197：不可交易资产充值198：无效资产减少199：有效资产增加200：买入202：价格锁定申购203：价格锁定回款204：价格锁定收益205：价格锁定退款207：双币赢精简版申购208：双币赢精简版回款209：双币赢精简版收益210：双币赢精简版退款211：投聪夺币中奖212：多币种借贷锁定质押物213：多币种质押物转出用户帐户214：多币种质押物返还用户215：多币种借贷释放质押物216：多币种借贷划转到用户帐户217：多币种借贷借款转入218：多币种借贷还款219：多币种还款由用户帐户转入220：已下架数字货币221：提币手续费支出222：提币手续费退款223：带单分润224：服务费225：鲨鱼鳍申购226：鲨鱼鳍回款227：鲨鱼鳍收益228：鲨鱼鳍退款229：空投发放230：换币完成232：利息补贴已入账233：经纪商佣金补偿clientIdString否转账或提币的客户自定义ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。afterString否查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085beforeString否查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为 100，不填默认返回 100 条7.2.8 闪电网络充币 get_deposit_lightning请求路径：/api/v5/asset/deposit-lightning 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种，仅支持BTCamtString是充值数量，推荐在0.000001〜0.1之间toString否资金充值到账账户6: 资金账户18: 交易账户不填写此参数，默认到账资金账户7.2.9 获取充值地址信息 get_deposit_address请求路径：/api/v5/asset/deposit-address 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种，如BTC7.2.10 获取充值记录 get_deposit_history请求路径：/api/v5/asset/deposit-history 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种名称，如BTCdepIdString否充值记录 IDfromWdIdString否内部转账发起者提币申请 ID如果该笔充值来自于内部转账，则该字段展示内部转账发起者的提币IDtxIdString否区块转账哈希记录typeString否充值方式3：内部转账4：链上充值stateString否充值状态0：等待确认1：确认到账2：充值成功8：因该币种暂停充值而未到账，恢复充值后自动到账11：命中地址黑名单12：账户或充值被冻结13：子账户充值拦截afterString否查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1654041600000beforeString否查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1656633600000limitstring否返回的结果集数量，默认为100，最大为100，不填默认返回100条7.2.11 提币 set_withdrawal请求路径：/api/v5/asset/withdrawal 请求方法：POST请求参数：参数名类型是否必须描述ccyString是币种，如USDTamtString是数量destString是提币方式3：内部转账4：链上提币toAddrString是如果选择链上提币，toAddr必须是认证过的数字货币地址。某些数字货币地址格式为地址:标签，如ARDOR-7JF3-8F2E-QUWZ-CAN7F:123456如果选择内部转账，toAddr必须是接收方地址，可以是邮箱、手机或者账户名。feeString是网络手续费≥0，提币到数字货币地址所需网络手续费可通过获取币种列表接口查询chainString可选币种链信息如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链如果没有不填此参数，则默认为主链areaCodeString可选手机区号当toAddr为手机号时，该参数必填clientIdString否客户自定义ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。7.2.12 闪电网络提币 set_withdrawal_lightning请求路径：/api/v5/asset/withdrawal-lightning 请求方法：POST请求参数：参数名类型是否必须描述ccyString是币种，如BTCinvoiceString是invoice 号码memoString否闪电网络提币的备注7.2.13 撤销提币 set_cancel_withdrawal请求路径：/api/v5/asset/cancel-withdrawal 请求方法：POST请求参数：参数名类型是否必须描述wdIdString是提币申请ID7.2.14 获取提币记录 get_withdrawal_history请求路径：/api/v5/asset/withdrawal-history 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种名称，如BTCwdIdString否提币申请IDclientIdString否客户自定义ID字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。txIdString否区块转账哈希记录typeString否提币方式3：内部转账4：链上提币stateString否提币状态-3：撤销中-2：已撤销-1：失败0：等待提币1：提币中2：提币成功7: 审核通过10: 等待划转4,5,6,8,9,12: 等待客服审核afterString否查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1654041600000beforeString否查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1656633600000limitstring否返回的结果集数量，默认为100，最大为100，不填默认返回100条7.2.15 获取充值/提现的详细状态 get_deposit_withdraw_status请求路径：/api/v5/asset/deposit-withdraw-status 请求方法：GET请求参数：参数名类型是否必须描述wdIdString可选提币申请ID，用于查询资金提现wdId与txId必传其一也仅可传其一txIdString可选区块转账哈希记录ID，用于查询资金充值wdId与txId必传其一也仅可传其一ccyString可选币种，如USDT查询充值时必填，需要与txId一并提供toString可选资金充值到账账户地址查询充值时必填，需要与txId一并提供chainString可选币种链信息，例如 USDT-ERC20查询充值时必填，需要与txId一并提供7.2.16 小额资产兑换 set_convert_dust_assets请求路径：/api/v5/asset/convert-dust-assets 请求方法：POST请求参数：参数名类型是否必须描述ccyArray是需要转换的币种资产7.2.17 获取余币宝余额 get_saving_balance请求路径：/api/v5/asset/saving-balance 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC7.2.18 余币宝申购/赎回 set_purchase_redempt请求路径：/api/v5/asset/purchase_redempt 请求方法：POST请求参数：参数名类型是否必须描述ccyString是币种名称，如BTCamtString是申购/赎回 数量sideString是操作类型purchase：申购redempt：赎回rateString是申购年利率仅适用于申购，新申购的利率会覆盖上次申购的利率参数取值范围在1%到365%之间7.2.19 设置余币宝借贷利率 set_set_lending_rate请求路径：/api/v5/asset/set-lending-rate 请求方法：POST请求参数：参数名类型是否必须描述ccyString是币种名称，如BTCrateString是贷出利率参数取值范围在1%到365%之间7.2.20 获取余币宝出借明细 get_lending_history请求路径：/api/v5/asset/lending-history 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTCafterString否查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085beforeString否查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为 100，不填默认返回 100 条7.2.21 获取市场借贷信息（公共） get_lending_rate_summary请求路径：/api/v5/asset/lending-rate-summary 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC7.2.22 获取市场借贷历史（公共） get_lending_rate_history请求路径：/api/v5/asset/lending-rate-history 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTCafterString否查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085beforeString否查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条7.3 例子资金模块需要秘钥fromokx_apiimportFundingfrompprintimportpprintif__name__=='__main__':# 资金模块需要秘钥key='****'secret='****'passphrase='****'flag='0'funding=Funding(key,secret,passphrase,flag)# 获取资金账户余额result=funding.get_balances(ccy='USDT')pprint(result)输出：>> {'code': '0',
>>  'data': [{'availBal': '124812.0771248455630674',
>>            'bal': '124812.0771248455630674',
>>            'ccy': 'USDT',
>>            'frozenBal': '0'}],
>>  'msg': ''}8 Convert 闪兑8.1 闪兑接口总览接口名称函数名称获取闪兑币种列表get_currencies获取闪兑币对信息get_currency_pair闪兑预估询价set_estimate_quote闪兑交易set_trade获取闪兑交易历史get_history8.2 闪兑接口介绍8.2.1 获取闪兑币种列表 get_currencies请求路径：/api/v5/asset/convert/currencies 请求方法：GET请求参数：无8.2.2 获取闪兑币对信息 get_currency_pair请求路径：/api/v5/asset/convert/currency-pair 请求方法：GET请求参数：参数名类型是否必须描述fromCcyString是消耗币种，如USDTtoCcyString是获取币种，如BTC8.2.3 闪兑预估询价 set_estimate_quote请求路径：/api/v5/asset/convert/estimate-quote 请求方法：POST请求参数：参数名类型是否必须描述baseCcyString是交易货币币种，如BTC-USDT中的BTCquoteCcyString是计价货币币种，如BTC-USDT中的USDTsideString是交易方向买：buy卖：sell描述的是对于baseCcy的交易方向rfqSzString是询价数量rfqSzCcyString是询价币种clQReqIdString否客户端自定义的订单标识字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。tagString否订单标签适用于broker用户8.2.4 闪兑交易 set_trade请求路径：/api/v5/asset/convert/trade 请求方法：POST请求参数：参数名类型是否必须描述quoteIdString是报价IDbaseCcyString是交易货币币种，如BTC-USDT中的BTCquoteCcyString是计价货币币种，如BTC-USDT中的USDTsideString是交易方向买：buy卖：sell描述的是对于baseCcy的交易方向szString是用户报价数量报价数量应不大于预估询价中的询价数量szCcyString是用户报价币种clTReqIdString否用户自定义的订单标识字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。tagString否订单标签适用于broker用户8.2.5 获取闪兑交易历史 get_history请求路径：/api/v5/asset/convert/history 请求方法：GET请求参数：参数名类型是否必须描述afterString否查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式，如1597026383085beforeString否查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式，如1597026383085limitString否返回的结果集数量，默认为100，最大为100tagString否订单标签适用于broker用户8.3 例子闪兑模块需要秘钥fromokx_apiimportConvertfrompprintimportpprintif__name__=='__main__':# 闪兑模块需要秘钥key='****'secret='****'passphrase='****'flag='0'convert=Convert(key,secret,passphrase,flag)# 获取闪兑币种列表result=convert.get_currencies()pprint(result)输出：>> {'code': '0',
>>  'data': [{'ccy': 'BTC', 'max': '', 'min': ''},
>>           {'ccy': 'ETH', 'max': '', 'min': ''},
>>           ... ...
>>  'msg': ''}9 Account 账户9.1 账户接口总览接口名称函数名称查看账户余额get_balance查看持仓信息get_positions查看历史持仓信息get_positions_history查看账户持仓风险get_account_position_risk账单流水查询（近七天）get_bills账单流水查询（近三月）get_bills_archive查看账户配置get_config设置持仓模式set_set_position_mode设置杠杆倍数set_set_leverage获取最大可买卖/开仓数量get_max_size获取最大可用数量get_max_avail_size调整保证金set_margin_balance获取杠杆倍数get_leverage_info获取交易产品最大可借get_max_loan获取当前账户交易手续费费率get_trade_fee获取计息记录get_interest_accrued获取用户当前杠杆借币利率get_interest_rate期权greeks的PA/BS切换set_set_greeks逐仓交易设置set_set_isolated_mode查看账户最大可转余额get_max_withdrawal查看账户特定风险状态get_risk_state一键借币模式手动借币还币set_quick_margin_borrow_repay获取一键借币还币历史get_quick_margin_borrow_repay_history尊享借币还币set_borrow_repay获取尊享借币还币历史get_borrow_repay_history获取尊享借币计息记录get_vip_interest_accrued获取尊享借币扣息记录get_vip_interest_deducted尊享借币订单列表get_vip_loan_order_list尊享借币订单详情get_vip_loan_order_detail获取借币利率与限额get_interest_limits组合保证金的虚拟持仓保证金计算set_simulated_margin查看账户Greeksget_greeks获取组合保证金模式全仓限制get_position_tiers设置组合保证金账户风险对冲模式set_set_riskOffset_type开通期权交易set_activate_option9.2 账户接口介绍9.2.1 查看账户余额 get_balance请求路径：/api/v5/account/balance 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC支持多币种查询（不超过20个），币种之间半角逗号分隔9.2.2 查看持仓信息 get_positions请求路径：/api/v5/account/positions 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权instType和instId同时传入的时候会校验instId与instType是否一致。instIdString否交易产品ID，如：BTC-USD-190927-5000-C支持多个instId查询（不超过10个），半角逗号分隔posIdString否持仓ID支持多个posId查询（不超过20个），半角逗号分割9.2.3 查看历史持仓信息 get_positions_history请求路径：/api/v5/account/positions-history 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权instIdString否交易产品ID，如：BTC-USD-SWAPmgnModeString否保证金模式cross：全仓，isolated：逐仓typeString否平仓类型1：部分平仓;2：完全平仓;3：强平;4：强减;5：ADL自动减仓;状态叠加时，以最新的平仓类型为准状态为准。posIdString否持仓IDafterString否查询仓位更新 (uTime) 之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085beforeString否查询仓位更新 (uTime) 之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如1597026383085limitString否分页返回结果的数量，最大为100，默认100条9.2.4 查看账户持仓风险 get_account_position_risk请求路径：/api/v5/account/account-position-risk 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权9.2.5 账单流水查询（近七天） get_bills请求路径：/api/v5/account/bills 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ccyString否账单币种mgnModeString否仓位类型isolated：逐仓cross：全仓ctTypeString否linear： 正向合约inverse： 反向合约仅交割/永续有效typeString否账单类型1：划转2：交易3：交割4：自动换币5：强平6：保证金划转7：扣息8：资金费9：自动减仓10：穿仓补偿11：系统换币12：策略划拨13：对冲减仓14: 大宗交易15: 一键借币18: 分润22: 一键还债subTypeString否账单子类型1：买入2：卖出3：开多4：开空5：平多6：平空9：市场借币扣息11：转入12：转出14：尊享借币扣息160：手动追加保证金161：手动减少保证金162：自动追加保证金114：自动换币买入115：自动换币卖出118：系统换币转入119：系统换币转出100：强减平多101：强减平空102：强减买入103：强减卖出104：强平平多105：强平平空106：强平买入107：强平卖出110：强平换币转入111：强平换币转出125：自动减仓平多126：自动减仓平空127：自动减仓买入128：自动减仓卖出131：对冲买入132：对冲卖出170：到期行权171：到期被行权172：到期作废112：交割平多113：交割平空117：交割/期权穿仓补偿173：资金费支出174：资金费收入200:系统转入201:手动转入202:系统转出203:手动转出204: 大宗交易买205: 大宗交易卖206: 大宗交易开多207: 大宗交易开空208: 大宗交易平多209: 大宗交易平空210: 手动借币211: 手动还币212: 自动借币213：自动还币"16：强制还币17：强制借币还息224: 还债转入225: 还债转出250: 分润支出;251: 分润退还;252: 分润收入;afterString否请求此id之前（更旧的数据）的分页内容，传的值为对应接口的billIdbeforeString否请求此id之后（更新的数据）的分页内容，传的值为对应接口的billIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条9.2.6 账单流水查询（近三月） get_bills_archive请求路径：/api/v5/account/bills-archive 请求方法：GET请求参数：参数名类型是否必须描述instTypeString否产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ccyString否账单币种mgnModeString否仓位类型isolated：逐仓cross：全仓ctTypeString否linear： 正向合约inverse： 反向合约仅交割/永续有效typeString否账单类型1：划转2：交易3：交割4：自动换币5：强平6：保证金划转7：扣息8：资金费9：自动减仓10：穿仓补偿11：系统换币12：策略划拨13：对冲减仓14: 大宗交易15: 一键借币22: 一键还债18: 分润subTypeString否账单子类型1：买入2：卖出3：开多4：开空5：平多6：平空9：市场借币扣息11：转入12：转出14：尊享借币扣息160：手动追加保证金161：手动减少保证金162：自动追加保证金114：自动换币买入115：自动换币卖出118：系统换币转入119：系统换币转出100：强减平多101：强减平空102：强减买入103：强减卖出104：强平平多105：强平平空106：强平买入107：强平卖出110：强平换币转入111：强平换币转出125：自动减仓平多126：自动减仓平空127：自动减仓买入128：自动减仓卖出131：对冲买入132：对冲卖出170：到期行权171：到期被行权172：到期作废112：交割平多113：交割平空117：交割/期权穿仓补偿173：资金费支出174：资金费收入200:系统转入201:手动转入202:系统转出203:手动转出204: 大宗交易买205: 大宗交易卖206: 大宗交易开多207: 大宗交易开空208: 大宗交易平多209: 大宗交易平空210: 手动借币211: 手动还币212: 自动借币213：自动还币"16：强制还币17：强制借币还息224: 还债转入225: 还债转出250: 分润支出;251: 分润退还;252: 分润收入;afterString否请求此id之前（更旧的数据）的分页内容，传的值为对应接口的billIdbeforeString否请求此id之后（更新的数据）的分页内容，传的值为对应接口的billIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条9.2.7 查看账户配置 get_config请求路径：/api/v5/account/config 请求方法：GET请求参数：无9.2.8 设置持仓模式 set_set_position_mode请求路径：/api/v5/account/set-position-mode 请求方法：POST请求参数：参数名类型是否必须描述posModeString是持仓方式long_short_mode：双向持仓net_mode：单向持仓仅适用交割/永续9.2.9 设置杠杆倍数 set_set_leverage请求路径：/api/v5/account/set-leverage 请求方法：POST请求参数：参数名类型是否必须描述leverString是杠杆倍数mgnModeString是保证金模式isolated：逐仓cross：全仓如果ccy有效传值，该参数值只能为cross。instIdString可选产品ID：币对、合约instId和ccy至少要传一个；如果两个都传，默认使用instIdccyString可选保证金币种仅适用于跨币种保证金模式的全仓币币杠杆。设置自动借币的杠杆倍数时必填posSideString可选持仓方向long：双向持仓多头short：双向持仓空头仅适用于逐仓交割/永续在双向持仓且保证金模式为逐仓条件下必填9.2.10 获取最大可买卖/开仓数量 get_max_size请求路径：/api/v5/account/max-size 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDT支持多产品ID查询（不超过5个），半角逗号分隔tdModeString是交易模式cross：全仓isolated：逐仓cash：非保证金ccyString可选保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单pxString否委托价格当不填委托价时会按当前最新成交价计算当指定多个产品ID查询时，忽略该参数，按当前最新成交价计算leverageString否开仓杠杆倍数默认为当前杠杆倍数仅适用于币币杠杆/交割/永续unSpotOffsetBoolean否true：禁止现货对冲，false：允许现货对冲默认为false仅适用于组合保证金模式开启现货对冲模式下有效，否则忽略此参数。9.2.11 获取最大可用数量 get_max_avail_size请求路径：/api/v5/account/max-avail-size 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDT支持多产品ID查询（不超过5个），半角逗号分隔tdModeString是交易模式cross：全仓isolated：逐仓cash：非保证金ccyString可选保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单reduceOnlyBoolean否是否为只减仓模式，仅适用于币币杠杆unSpotOffsetBoolean否true：禁止现货对冲，false：允许现货对冲默认为false仅适用于组合保证金模式开启现货对冲模式下有效，否则忽略此参数。quickMgnTypeString否一键借币类型，仅适用于杠杆逐仓的一键借币模式：manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币默认是manual：手动9.2.12 调整保证金 set_margin_balance请求路径：/api/v5/account/position/margin-balance 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品IDposSideString是持仓方向，默认值是netlong：双向持仓多头short：双向持仓空头net：单向持仓typeString是增加/减少保证金add：增加，或者转入质押资产(一键借币)reduce：减少，或者转出质押资产（一键借币）amtString是增加或减少的保证金数量ccyString否增加或减少的保证金的币种，仅适用于逐仓自主划转和一键借币模式下的币币杠杆autoBoolean否是否自动借币转 true 或 false，默认false仅适用于逐仓自主划转保证金模式下的币币杠杆loanTransBoolean否是否支持跨币种保证金模式或组合保证金模式下的借币转入/转出true 或 false，默认false9.2.13 获取杠杆倍数 get_leverage_info请求路径：/api/v5/account/leverage-info 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID支持多个instId查询，半角逗号分隔。instId个数不超过20个mgnModeString是保证金模式isolated：逐仓cross：全仓9.2.14 获取交易产品最大可借 get_max_loan请求路径：/api/v5/account/max-loan 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品 ID，如BTC-USDT支持多产品ID查询（不超过5个），半角逗号分隔mgnModeString是仓位类型isolated：逐仓cross：全仓mgnCcyString可选保证金币种，如BTC币币杠杆单币种全仓情况下必须指定保证金币种9.2.15 获取当前账户交易手续费费率 get_trade_fee请求路径：/api/v5/account/trade-fee 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权instIdString否产品ID，如BTC-USDT仅适用于instType为币币/币币杠杆ulyString否标的指数适用于交割/永续/期权，如BTC-USDinstFamilyString否交易品种适用于交割/永续/期权，如BTC-USD9.2.16 获取计息记录 get_interest_accrued请求路径：/api/v5/account/interest-accrued 请求方法：GET请求参数：参数名类型是否必须描述typeString否借币类型1：尊享借币2：市场借币默认为市场借币ccyString否借贷币种，如BTC仅适用于市场借币仅适用于币币杠杆instIdString否产品ID，如BTC-USDT仅适用于市场借币mgnModeString否保证金模式cross：全仓isolated：逐仓仅适用于市场借币afterString否请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085beforeString否请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条9.2.17 获取用户当前杠杆借币利率 get_interest_rate请求路径：/api/v5/account/interest-rate 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种9.2.18 期权greeks的PA/BS切换 set_set_greeks请求路径：/api/v5/account/set-greeks 请求方法：POST请求参数：参数名类型是否必须描述greeksTypeString是希腊字母展示方式PA：币本位，BS：美元本位9.2.19 逐仓交易设置 set_set_isolated_mode请求路径：/api/v5/account/set-isolated-mode 请求方法：POST请求参数：参数名类型是否必须描述isoModeString是逐仓保证金划转模式automatic:开仓自动划转autonomy:自主划转quick_margin:一键借币typeString是业务线类型MARGIN:币币杠杆CONTRACTS:合约9.2.20 查看账户最大可转余额 get_max_withdrawal请求路径：/api/v5/account/max-withdrawal 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC支持多币种查询（不超过20个），币种之间半角逗号分隔9.2.21 查看账户特定风险状态 get_risk_state请求路径：/api/v5/account/risk-state 请求方法：GET请求参数：无9.2.22 一键借币模式手动借币还币 set_quick_margin_borrow_repay请求路径：/api/v5/account/quick-margin-borrow-repay 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDTccyString是借贷币种，如BTCsideString是borrow：借币，repay：还币amtString是借/还币的数量9.2.23 获取一键借币还币历史 get_quick_margin_borrow_repay_history请求路径：/api/v5/account/quick-margin-borrow-repay-history 请求方法：GET请求参数：参数名类型是否必须描述instIdString否产品ID，如 BTC-USDTccyString否借贷币种，如BTCsideString否borrow：借币，repay：还币afterString否请求此 ID 之前（更旧的数据）的分页内容，传的值为对应接口的refIdbeforeString否请求此 ID 之后（更新的数据）的分页内容，传的值为对应接口的refIdbeginString否筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085endString否筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085limitString否返回结果的数量，最大为100，默认100条9.2.24 尊享借币还币 set_borrow_repay请求路径：/api/v5/account/borrow-repay 请求方法：POST请求参数：参数名类型是否必须描述ccyString是借贷币种，如BTCsideString是borrow：借币，repay：还币amtString是借/还币的数量ordIdString可选借币订单ID，还币时，该字段必填9.2.25 获取尊享借币还币历史 get_borrow_repay_history请求路径：/api/v5/account/borrow-repay-history 请求方法：GET请求参数：参数名类型是否必须描述ccyString否借贷币种，如BTCafterString否请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085beforeString否请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条9.2.26 获取尊享借币计息记录 get_vip_interest_accrued请求路径：/api/v5/account/vip-interest-accrued 请求方法：GET请求参数：参数名类型是否必须描述ccyString否借贷币种，如BTC，仅适用于币币杠杆ordIdString否借币订单IDafterString否请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085beforeString否请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条9.2.27 获取尊享借币扣息记录 get_vip_interest_deducted请求路径：/api/v5/account/vip-interest-deducted 请求方法：GET请求参数：参数名类型是否必须描述ordIdString否借币订单IDccyString否借贷币种，如BTC，仅适用于币币杠杆afterString否请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085beforeString否请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085limitString否分页返回的结果集数量，最大为100，不填默认返回100条9.2.28 尊享借币订单列表 get_vip_loan_order_list请求路径：/api/v5/account/vip-loan-order-list 请求方法：GET请求参数：参数名类型是否必须描述ordIdString否借币订单IDstateString否订单状态1:借币申请中2:借币中3:还币申请中4:已还币5:借币失败ccyString否借贷币种，如 BTCafterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordIdlimitString否返回结果的数量，最大为100，默认100条9.2.29 尊享借币订单详情 get_vip_loan_order_detail请求路径：/api/v5/account/vip-loan-order-detail 请求方法：GET请求参数：参数名类型是否必须描述ordIdString是借币订单IDccyString否借贷币种，如 BTCafterString否请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085beforeString否请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如1597026383085limitString否返回结果的数量，最大为100，默认100条9.2.30 获取借币利率与限额 get_interest_limits请求路径：/api/v5/account/interest-limits 请求方法：GET请求参数：参数名类型是否必须描述typeString否借币类型1：尊享借币2：市场借币默认为市场借币ccyString否借贷币种，如BTC9.2.31 组合保证金的虚拟持仓保证金计算 set_simulated_margin请求路径：/api/v5/account/simulated_margin 请求方法：POST请求参数：参数名类型是否必须描述instTypeString否产品类型SWAP：永续合约FUTURES：交割合约OPTION：期权inclRealPosBoolean否是否代入已有仓位true：调整被代入的已有仓位信息false：不代入已有仓位，仅使用simPos里新增的模拟仓位进行计算,默认为TruespotOffsetTypeString否现货对冲模式1：现货对冲模式U模式 2：现货对冲模式币模式 3：衍生品模式默认是 3simPosArray否调整持仓列表> instIdString否交易产品ID> posString否持仓量9.2.32 查看账户Greeks get_greeks请求路径：/api/v5/account/greeks 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC9.2.33 获取组合保证金模式全仓限制 get_position_tiers请求路径：/api/v5/account/position-tiers 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString可选标的指数，如BTC-USDT，支持多个查询（不超过3个），uly之间半角逗号分隔适用于交割/永续/期权uly与instFamily必须传一个,若传两个，以instFamily为主instFamilyString可选交易品种，如BTC-USDT，支持多个查询（不超过5个），instFamily之间半角逗号分隔适用于交割/永续/期权uly与instFamily必须传一个,若传两个，以instFamily为主9.2.34 设置组合保证金账户风险对冲模式 set_set_riskOffset_type请求路径：/api/v5/account/set-riskOffset-type 请求方法：POST请求参数：参数名类型是否必须描述typeString是风险对冲模式1：现货对冲(USDT)2:现货对冲(币)3:衍生品对冲9.2.35 开通期权交易 set_activate_option请求路径：/api/v5/account/activate-option 请求方法：POST请求参数：无9.3 例子账户模块需要秘钥fromokx_apiimportAccountfrompprintimportpprintif__name__=='__main__':# 账户模块需要秘钥key='****'secret='****'passphrase='****'flag='0'account=Account(key,secret,passphrase,flag)# 查看账户USDT余额result=account.get_balance('USDT')pprint(result)输出：>> {'code': '0',
>>  'data': [{'adjEq': '',
>>            'details': [{'availBal': '498.00000000169007',
>>                         'availEq': '498.00000000169007',
>>                         'cashBal': '500.00000000169007',
>>                         'ccy': 'USDT',
>>                         'crossLiab': '',
>>                         'disEq': '500.00000000169007',
>>                         'eq': '500.00000000169007',
>>                         'eqUsd': '500.00000000169007',
>>                         'fixedBal': '0',
>>                         'frozenBal': '2',
>>                         'interest': '',
>>                         'isoEq': '0',
>>                         'isoLiab': '',
>>                         'isoUpl': '0',
>>                         'liab': '',
>>                         'maxLoan': '',
>>                         'mgnRatio': '',
>>                         'notionalLever': '0',
>>                         'ordFrozen': '2',
>>                         'spotInUseAmt': '',
>>                         'stgyEq': '0',
>>                         'twap': '0',
>>                         'uTime': '1672592968994',
>>                         'upl': '0',
>>                         'uplLiab': ''}],
>>            'imr': '',
>>            'isoEq': '0',
>>            'mgnRatio': '',
>>            'mmr': '',
>>            'notionalUsd': '',
>>            'ordFroz': '',
>>            'totalEq': '500.22421655441127',
>>            'uTime': '1675570865890'}],
>>  'msg': ''}10 子账户 SubAccount10.1 子账户接口总览接口名称函数名称查看子账户列表get_list重置子账户的APIKeyset_modify_apikey获取子账户交易账户余额get_account_balances获取子账户资金账户余额get_asset_balances查询子账户转账记录get_bills子账户间资金划转set_transfer设置子账户主动转出权限set_set_transfer_out查看被托管的子账户列表get_entrust_subaccount_list获取用户的节点返佣信息get_if_rebate10.2 子账户接口介绍10.2.1 查看子账户列表 get_list请求路径：/api/v5/users/subaccount/list 请求方法：GET请求参数：参数名类型是否必须描述enableString否子账户状态，true：正常使用false：冻结subAcctString否子账户名称afterString否查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式beforeString否查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式limitString否分页返回的结果集数量，最大为100，不填默认返回100条10.2.2 重置子账户的APIKey set_modify_apikey请求路径：/api/v5/users/subaccount/modify-apikey 请求方法：POST请求参数：参数名类型是否必须描述subAcctString是子账户名称apiKeyString是子账户API的公钥labelString否子账户APIKey的备注，如果填写该字段，则该字段会被重置permString否子账户APIKey权限read_only：只读 ；trade：交易多个权限用半角逗号隔开。如果填写该字段，则该字段会被重置ipString否子账户APIKey绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip。如果填写该字段，那该字段会被重置如果ip传""，则表示解除IP绑定10.2.3 获取子账户交易账户余额 get_account_balances请求路径：/api/v5/account/subaccount/balances 请求方法：GET请求参数：参数名类型是否必须描述subAcctString是子账户名称10.2.4 获取子账户资金账户余额 get_asset_balances请求路径：/api/v5/asset/subaccount/balances 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如BTC支持多币种查询（不超过20个），币种之间半角逗号分隔10.2.5 查询子账户转账记录 get_bills请求路径：/api/v5/asset/subaccount/bills 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种，如 BTCtypeString否0: 母账户转子账户  ；1: 子账户转母账户subAcctString否子账户名称afterString否查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式beforeString否查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式limitString否分页返回的结果集数量，最大为100，不填默认返回100条10.2.6 子账户间资金划转 set_transfer请求路径：/api/v5/asset/subaccount/transfer 请求方法：POST请求参数：参数名类型是否必须描述ccyString是币种amtString是划转数量fromString是6：资金账户18：交易账户toString是6：资金账户18：交易账户fromSubAccountString是转出子账户的子账户名称toSubAccountString是转入子账户的子账户名称loanTransBoolean否是否支持跨币种保证金模式或组合保证金模式下的借币转入/转出true 或 false，默认falseomitPosRiskString否是否忽略仓位风险默认为false仅适用于组合保证金模式10.2.7 设置子账户主动转出权限 set_set_transfer_out请求路径：/api/v5/users/subaccount/set-transfer-out 请求方法：POST请求参数：参数名类型是否必须描述subAcctString是子账户名称，支持设置多个（不超过20个），子账户名称之间半角逗号分隔canTransOutBoolean否是否可以主动转出，默认为truefalse：不可转出true：可以转出10.2.8 查看被托管的子账户列表 get_entrust_subaccount_list请求路径：/api/v5/users/entrust-subaccount-list 请求方法：GET请求参数：参数名类型是否必须描述subAcctString否子账户名称10.2.9 获取用户的节点返佣信息 get_if_rebate请求路径：/api/v5/users/partner/if-rebate 请求方法：GET请求参数：参数名类型是否必须描述apiKeyString是用户的 API key10.3 例子子账户模块需要秘钥fromokx_apiimportSubAccountfrompprintimportpprintif__name__=='__main__':# 子账户模块需要秘钥key='****'secret='****'passphrase='****'flag='0'subAccount=SubAccount(key,secret,passphrase,flag)# 查看子账户列表result=subAccount.get_list()pprint(result)输出：>> {'code': '0', 'data': [], 'msg': ''}11 网格交易 Grid11.1 网格交易接口总览接口名称函数名称网格策略委托下单set_order_algo修改网格策略订单set_amend_order_algo网格策略停止set_stop_order_algo获取未完成网格策略委托单列表get_orders_algo_pending获取历史网格策略委托单列表get_orders_algo_history获取网格策略委托订单详情get_orders_algo_details获取网格策略委托子订单信息get_sub_orders获取网格策略委托持仓get_positions现货/天地网格提取利润set_withdraw_income调整保证金计算set_compute_margin_balance调整保证金set_margin_balance网格策略智能回测（公共）get_ai_param11.2 网格交易接口介绍11.2.1 网格策略委托下单 set_order_algo请求路径：/api/v5/tradingBot/grid/order-algo 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDTalgoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托maxPxString是区间最高价格minPxString是区间最低价格gridNumString是网格数量runTypeString否网格类型1：等差，2：等比默认为等差天地网格只支持2tpTriggerPxString否止盈触发价适用于现货网格/合约网格slTriggerPxString否止损触发价适用于现货网格/合约网格tagString否订单标签11.2.2 修改网格策略订单 set_amend_order_algo请求路径：/api/v5/tradingBot/grid/amend-order-algo 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略订单IDinstIdString是产品ID，如BTC-USDT-SWAPslTriggerPxString可选新的止损触发价当值为""则代表取消止损触发价slTriggerPx、tpTriggerPx至少要传一个值tpTriggerPxString可选新的止盈触发价当值为""则代表取消止盈触发价11.2.3 网格策略停止 set_stop_order_algo请求路径：/api/v5/tradingBot/grid/stop-order-algo 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略订单IDinstIdString是产品ID，如BTC-USDTalgoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托stopTypeString是网格策略停止类型现货网格/天地网格1：卖出交易币，2：不卖出交易币合约网格1：市价全平11.2.4 获取未完成网格策略委托单列表 get_orders_algo_pending请求路径：/api/v5/tradingBot/grid/orders-algo-pending 请求方法：GET请求参数：参数名类型是否必须描述algoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托algoIdString否策略订单IDinstIdString否产品ID，如BTC-USDTinstTypeString否产品类型SPOT：币币MARGIN：杠杆FUTURES：交割合约SWAP：永续合约afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoIdlimitString否返回结果的数量，最大为100，默认100条11.2.5 获取历史网格策略委托单列表 get_orders_algo_history请求路径：/api/v5/tradingBot/grid/orders-algo-history 请求方法：GET请求参数：参数名类型是否必须描述algoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托algoIdString否策略订单IDinstIdString否产品ID，如BTC-USDTinstTypeString否产品类型SPOT：币币MARGIN：杠杆FUTURES：交割合约SWAP：永续合约afterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoIdlimitString否返回结果的数量，最大为100，默认100条11.2.6 获取网格策略委托订单详情 get_orders_algo_details请求路径：/api/v5/tradingBot/grid/orders-algo-details 请求方法：GET请求参数：参数名类型是否必须描述algoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托algoIdString是策略订单ID11.2.7 获取网格策略委托子订单信息 get_sub_orders请求路径：/api/v5/tradingBot/grid/sub-orders 请求方法：GET请求参数：参数名类型是否必须描述algoIdString是策略订单IDalgoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托typeString是子订单状态live：未成交，filled：已成交groupIdString否组IDafterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordIdlimitString否返回结果的数量，最大为100，默认100条11.2.8 获取网格策略委托持仓 get_positions请求路径：/api/v5/tradingBot/grid/positions 请求方法：GET请求参数：参数名类型是否必须描述algoOrdTypeString是订单类型contract_grid：合约网格委托algoIdString是策略订单ID11.2.9 现货/天地网格提取利润 set_withdraw_income请求路径：/api/v5/tradingBot/grid/withdraw-income 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略订单ID11.2.10 调整保证金计算 set_compute_margin_balance请求路径：/api/v5/tradingBot/grid/compute-margin-balance 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略订单IDtypeString是调整保证金类型add：增加，reduce：减少amtString否调整保证金数量11.2.11 调整保证金 set_margin_balance请求路径：/api/v5/tradingBot/grid/margin-balance 请求方法：POST请求参数：参数名类型是否必须描述algoIdString是策略订单IDtypeString是调整保证金类型add：增加，reduce：减少amtString可选调整保证金数量amt和percent必须传一个percentString可选调整保证金百分比11.2.12 网格策略智能回测（公共） get_ai_param请求路径：/api/v5/tradingBot/grid/ai-param 请求方法：GET请求参数：参数名类型是否必须描述algoOrdTypeString是策略订单类型grid：现货网格委托contract_grid：合约网格委托moon_grid：天地网格委托instIdString是产品ID，如BTC-USDTdirectionString可选合约网格类型long：做多，short：做空，neutral：中性合约网格必填durationString否回测周期7D：7天，30D：30天，180D：180天默认现货网格为7D，天地网格为180D12 赚币 Staking12.1 赚币接口总览接口名称函数名称查看项目get_offers申购项目set_purchase赎回项目set_redeem撤销项目申购/赎回set_cancel查看活跃订单get_orders_active查看历史订单get_orders_history12.2 赚币接口介绍12.2.1 查看项目 get_offers请求路径：/api/v5/finance/staking-defi/offers 请求方法：GET请求参数：参数名类型是否必须描述productIdString否项目IDprotocolTypeString否项目类型staking：锁仓挖矿defi：DEFIccyString否投资币种，如BTC12.2.2 申购项目 set_purchase请求路径：/api/v5/finance/staking-defi/purchase 请求方法：POST请求参数：参数名类型是否必须描述productIdString是项目IDinvestDataArray是投资信息> ccyString是投资币种，如BTC> amtString是投资数量termString可选投资期限定期项目必须指定投资期限tagString否订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间12.2.3 赎回项目 set_redeem请求路径：/api/v5/finance/staking-defi/redeem 请求方法：POST请求参数：参数名类型是否必须描述ordIdString是订单IDprotocolTypeString是项目类型staking：锁仓挖矿defi：DEFIallowEarlyRedeemBoolean否是否提前赎回默认为false12.2.4 撤销项目申购/赎回 set_cancel请求路径：/api/v5/finance/staking-defi/cancel 请求方法：POST请求参数：参数名类型是否必须描述ordIdString是订单IDprotocolTypeString是项目类型staking：锁仓挖矿defi：DEFI12.2.5 查看活跃订单 get_orders_active请求路径：/api/v5/finance/staking-defi/orders-active 请求方法：GET请求参数：参数名类型是否必须描述productIdString否项目IDprotocolTypeString否项目类型staking：锁仓挖矿defi：DEFIccyString否投资币种，如BTCstateString否订单状态8: 待上车（预约中）13: 订单取消中9: 上链中1: 收益中2: 赎回中12.2.6 查看历史订单 get_orders_history请求路径：/api/v5/finance/staking-defi/orders-history 请求方法：GET请求参数：参数名类型是否必须描述productIdString否项目IDprotocolTypeString否项目类型staking：锁仓挖矿defi：DEFIccyString否投资币种，如BTCafterString否请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordIdbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordIdlimitString否返回结果的数量，默认100条,最大值为100条12.3 例子赚币模块需要秘钥fromokx_apiimportStakingfrompprintimportpprintif__name__=='__main__':# 赚币模块需要秘钥key='****'secret='****'passphrase='****'flag='0'staking=Staking(key,secret,passphrase,flag)# 查看项目result=staking.get_offers()pprint(result)输出：>> {'code': '0',
>>  'data': [{'apy': '0.0673',
>>            'ccy': 'USDT',
>>            'earlyRedeem': False,
>>            'earningData': [{'ccy': 'SUSHI', 'earningType': '1'}],
>>            'investData': [{'bal': '1248.07712484',
>>                            'ccy': 'USDT',
>>                            'maxAmt': '0',
>>                            'minAmt': '100'},
>>                           {'bal': '0',
>>                            'ccy': 'ETH',
>>                            'maxAmt': '0',
>>                            'minAmt': '0.06017661'}],
>>            'productId': '1507',
>>            'protocol': 'Sushiswap',
>>            'protocolType': 'defi',
>>            'state': 'purchasable',
>>            'term': '0'},
>>            ... ...
>>         ]
>>  'msg': ''}13 跟单接口CopyTrading跟单接口权限需要单独申请13.1 跟单接口总览接口名称函数名称交易员获取当前带单get_current_subpositions交易员获取历史带单get_subpositions_history交易员止盈止损set_algo_order交易员平仓set_close_subposition交易员获取带单合约get_instruments交易员修改带单合约set_set_instruments交易员历史分润明细get_profit_sharing_details交易员历史分润汇总get_total_profit_sharing交易员待分润明细get_unrealized_profit_sharing_details13.2 跟单接口介绍13.2.1 交易员获取当前带单 get_current_subpositions请求路径：/api/v5/copytrading/current-subpositions 请求方法：GET请求参数：参数名类型是否必须描述instIdString否产品ID ，如BTC-USDT-SWAP13.2.2 交易员获取历史带单 get_subpositions_history请求路径：/api/v5/copytrading/subpositions-history 请求方法：GET请求参数：参数名类型是否必须描述instIdString否产品ID ，如BTC-USDT-SWAPafterString否请求此id之前（更旧的数据）的分页内容，传的值为对应接口的subPosIdbeforeString否请求此id之后（更新的数据）的分页内容，传的值为对应接口的subPosIdlimitString否分页返回的结果集数量，最大为100，不填默认返回100条13.2.3 交易员止盈止损 set_algo_order请求路径：/api/v5/copytrading/algo-order 请求方法：POST请求参数：参数名类型是否必须描述subPosIdString是带单仓位IDtpTriggerPxString可选止盈触发价，触发后以市价进行委托，tpTriggerPx 和 slTriggerPx 至少需要填写一个slTriggerPxString可选止损触发价，触发后以市价进行委托tpTriggerPxTypeString否止盈触发价类型last：最新价格index：指数价格mark：标记价格默认为lastslTriggerPxTypeString否止损触发价类型last：最新价格index：指数价格mark：标记价格默认为last13.2.4 交易员平仓 set_close_subposition请求路径：/api/v5/copytrading/close-subposition 请求方法：POST请求参数：参数名类型是否必须描述subPosIdString是带单仓位ID13.2.5 交易员获取带单合约 get_instruments请求路径：/api/v5/copytrading/instruments 请求方法：GET请求参数：无13.2.6 交易员修改带单合约 set_set_instruments请求路径：/api/v5/copytrading/set-instruments 请求方法：POST请求参数：参数名类型是否必须描述instIdString是产品ID，如 BTC-USDT-SWAP，多个产品用半角逗号隔开，最多支持10个产品ID13.2.7 交易员历史分润明细 get_profit_sharing_details请求路径：/api/v5/copytrading/profit-sharing-details 请求方法：GET请求参数：参数名类型是否必须描述afterString否请求此id之前（更旧的数据）的分页内容，传的值为对应接口的profitSharingIdbeforeString否请求此id之后（更新的数据）的分页内容，传的值为对应接口的profitSharingIdlimitString否分页返回的结果集数量，最大为100，不填默认返回100条13.2.8 交易员历史分润汇总 get_total_profit_sharing请求路径：/api/v5/copytrading/total-profit-sharing 请求方法：GET请求参数：无13.2.9 交易员待分润明细 get_unrealized_profit_sharing_details请求路径：/api/v5/copytrading/unrealized-profit-sharing-details 请求方法：GET请求参数：无14 行情数据 Market14.1 行情数据接口总览接口名称函数名称获取所有产品行情信息get_tickers获取单个产品行情信息get_ticker获取指数行情get_index_tickers获取产品深度get_books获取产品轻量深度get_books_lite获取交易产品K线数据get_candles获取交易产品历史K线数据get_history_candles获取指数K线数据get_index_candles获取指数历史K线数据get_history_index_candles获取标记价格K线数据get_mark_price_candles获取标记价格历史K线数据get_history_mark_price_candles获取交易产品公共成交数据get_trades获取交易产品公共历史成交数据get_history_trades获取期权品种公共成交数据get_instrument_family_trades获取平台24小时总成交量get_platform_24_volumeOracle  上链交易数据get_open_oracle获取法币汇率get_exchange_rate获取指数成分数据get_index_components获取大宗交易所有产品行情信息get_block_tickers获取大宗交易单个产品行情信息get_block_ticker获取大宗交易公共成交数据get_block_trades14.2 行情数据接口介绍14.2.1 获取所有产品行情信息 get_tickers请求路径：/api/v5/market/tickers 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数适用于交割/永续/期权，如BTC-USDinstFamilyString否交易品种适用于交割/永续/期权，如BTC-USD14.2.2 获取单个产品行情信息 get_ticker请求路径：/api/v5/market/ticker 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如 BTC-USD-SWAP14.2.3 获取指数行情 get_index_tickers请求路径：/api/v5/market/index-tickers 请求方法：GET请求参数：参数名类型是否必须描述quoteCcyString可选指数计价单位， 目前只有USD/USDT/BTC为计价单位的指数，quoteCcy和instId必须填写一个instIdString可选指数，如BTC-USD14.2.4 获取产品深度 get_books请求路径：/api/v5/market/books 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDTszString否深度档位数量，最大值可传400，即买卖深度共800条不填写此参数，默认返回1档深度数据14.2.5 获取产品轻量深度 get_books_lite请求路径：/api/v5/market/books-lite 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDT14.2.6 获取交易产品K线数据 get_candles请求路径：/api/v5/market/candles 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-190927-5000-CbarString否时间粒度，默认值1m如 [1m/3m/5m/15m/30m/1H/2H/4H]香港时间开盘价k线：[6H/12H/1D/2D/3D/1W/1M/3M]UTC时间开盘价k线：[/6Hutc/12Hutc/1Dutc/2Dutc/3Dutc/1Wutc/1Mutc/3Mutc]afterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tslimitString否分页返回的结果集数量，最大为300，不填默认返回100条14.2.7 获取交易产品历史K线数据 get_history_candles请求路径：/api/v5/market/history-candles 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-200927afterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsbarString否时间粒度，默认值1m如 [1m/3m/5m/15m/30m/1H/2H/4H]香港时间开盘价k线：[6H/12H/1D/2D/3D/1W/1M/3M]UTC时间开盘价k线：[6Hutc/12Hutc/1Dutc/2Dutc/3Dutc/1Wutc/1Mutc/3Mutc]limitString否分页返回的结果集数量，最大为100，不填默认返回100条14.2.8 获取指数K线数据 get_index_candles请求路径：/api/v5/market/index-candles 请求方法：GET请求参数：参数名类型是否必须描述instIdString是现货指数，如BTC-USDafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsbarString否时间粒度，默认值1m如 [1m/3m/5m/15m/30m/1H/2H/4H]香港时间开盘价k线：[6H/12H/1D/1W/1M/3M]UTC时间开盘价k线：[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc]limitString否分页返回的结果集数量，最大为100，不填默认返回100条14.2.9 获取指数历史K线数据 get_history_index_candles请求路径：/api/v5/market/history-index-candles 请求方法：GET请求参数：参数名类型是否必须描述instIdString是现货指数，如BTC-USDafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsbarString否时间粒度，默认值1m如 [1m/3m/5m/15m/30m/1H/2H/4H]香港时间开盘价k线：[6H/12H/1D/1W/1M]UTC时间开盘价k线：[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc]limitString否分页返回的结果集数量，最大为100，不填默认返回100条14.2.10 获取标记价格K线数据 get_mark_price_candles请求路径：/api/v5/market/mark-price-candles 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-SWAPafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsbarString否时间粒度，默认值1m如 [1m/3m/5m/15m/30m/1H/2H/4H]香港时间开盘价k线：[6H/12H/1D/1W/1M/3M]UTC时间开盘价k线：[6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc]limitString否分页返回的结果集数量，最大为100，不填默认返回100条14.2.11 获取标记价格历史K线数据 get_history_mark_price_candles请求路径：/api/v5/market/history-mark-price-candles 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USD-SWAPafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsbarString否时间粒度，默认值1m如 [1m/3m/5m/15m/30m/1H/2H/4H]香港时间开盘价k线：[6H/12H/1D/1W/1M]UTC时间开盘价k线：[6Hutc/12Hutc/1Dutc/1Wutc/1Mutc]limitString否分页返回的结果集数量，最大为100，不填默认返回100条14.2.12 获取交易产品公共成交数据 get_trades请求路径：/api/v5/market/trades 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDTlimitString否分页返回的结果集数量，最大为500，不填默认返回100条14.2.13 获取交易产品公共历史成交数据 get_history_trades请求路径：/api/v5/market/history-trades 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDTtypeString否分页类型1：tradeId 分页2：时间戳分页默认为1：tradeId 分页afterString否请求此 ID 或 ts 之前的分页内容，传的值为对应接口的 tradeId 或 tsbeforeString否请求此ID之后（更新的数据）的分页内容，传的值为对应接口的 tradeId。不支持时间戳分页。limitString否分页返回的结果集数量，最大为100，不填默认返回100条14.2.14 获取期权品种公共成交数据 get_instrument_family_trades请求路径：/api/v5/market/option/instrument-family-trades 请求方法：GET请求参数：参数名类型是否必须描述instFamilyString是交易品种，如 BTC-USD，适用于期权14.2.15 获取平台24小时总成交量 get_platform_24_volume请求路径：/api/v5/market/platform-24-volume 请求方法：GET请求参数：无14.2.16 Oracle  上链交易数据 get_open_oracle请求路径：/api/v5/market/open-oracle 请求方法：GET请求参数：无14.2.17 获取法币汇率 get_exchange_rate请求路径：/api/v5/market/exchange-rate 请求方法：GET请求参数：无14.2.18 获取指数成分数据 get_index_components请求路径：/api/v5/market/index-components 请求方法：GET请求参数：参数名类型是否必须描述indexString是指数，如BTC-USDT14.2.19 获取大宗交易所有产品行情信息 get_block_tickers请求路径：/api/v5/market/block-tickers 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数适用于交割/永续/期权，如BTC-USDinstFamilyString否交易品种适用于交割/永续/期权，如BTC-USD14.2.20 获取大宗交易单个产品行情信息 get_block_ticker请求路径：/api/v5/market/block-ticker 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如 BTC-USD-SWAP14.2.21 获取大宗交易公共成交数据 get_block_trades请求路径：/api/v5/market/block-trades 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDT14.3 例子行情数据模块无需秘钥fromokx_apiimportMarketfrompprintimportpprintif__name__=='__main__':# 行情数据模块无需秘钥key=''secret=''passphrase=''flag='0'market=Market(key,secret,passphrase,flag)# 获取所有产品行情信息result=market.get_tickers(instType='SPOT')# SPOT币币pprint(result)输出：>> {'code': '0',
>>  'data': [{'askPx': '0.00000666',
>>            'askSz': '38.2674',
>>            'bidPx': '0.00000657',
>>            'bidSz': '280.5009',
>>            'high24h': '0.00000685',
>>            'instId': 'BCD-BTC',
>>            'instType': 'SPOT',
>>            'last': '0.00000664',
>>            'lastSz': '12.2992',
>>            'low24h': '0.00000644',
>>            'open24h': '0.00000656',
>>            'sodUtc0': '0.00000658',
>>            'sodUtc8': '0.00000674',
>>            'ts': '1675572360017',
>>            'vol24h': '40196.8587',
>>            'volCcy24h': '0.2515'},
>>            ... ...
>>         ],
>>  'msg': ''}15 公共数据 Public15.1 公共数据接口总览接口名称函数名称获取交易产品基础信息get_instruments获取交割和行权记录get_delivery_exercise_history获取持仓总量get_open_interest获取永续合约当前资金费率get_funding_rate获取永续合约历史资金费率get_funding_rate_history获取限价get_price_limit获取期权定价get_opt_summary获取预估交割/行权价格get_estimated_price获取免息额度和币种折算率等级get_discount_rate_interest_free_quota获取系统时间get_time获取平台公共爆仓单信息get_liquidation_orders获取标记价格get_mark_price获取衍生品仓位档位get_position_tiers获取市场借币杠杆利率和借币限额get_interest_rate_loan_quota获取尊享借币杠杆利率和借币限额get_vip_interest_rate_loan_quota获取衍生品标的指数get_underlying获取风险准备金余额get_insurance_fund张币转换get_convert_contract_coin获取期权公共成交数据get_option_trades15.2 公共数据接口介绍15.2.1 获取交易产品基础信息 get_instruments请求路径：/api/v5/public/instruments 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SPOT：币币MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString可选标的指数，仅适用于交割/永续/期权，期权必填instFamilyString否交易品种，仅适用于交割/永续/期权instIdString否产品ID15.2.2 获取交割和行权记录 get_delivery_exercise_history请求路径：/api/v5/public/delivery-exercise-history 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型FUTURES：交割合约OPTION：期权ulyString可选标的指数uly与instFamily必须传一个,若传两个，以instFamily为主instFamilyString可选交易品种uly与instFamily必须传一个,若传两个，以instFamily为主afterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tsbeforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tslimitString否分页返回的结果集数量，最大为100，不填默认返回100条15.2.3 获取持仓总量 get_open_interest请求路径：/api/v5/public/open-interest 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString可选标的指数适用于交割/永续/期权期权情况下，uly和instFamily必须传一个instFamilyString可选交易品种适用于交割/永续/期权期权情况下，uly和instFamily必须传一个instIdString否产品ID，如BTC-USD-180216仅适用于交割/永续/期权15.2.4 获取永续合约当前资金费率 get_funding_rate请求路径：/api/v5/public/funding-rate 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID ，如BTC-USD-SWAP仅适用于永续15.2.5 获取永续合约历史资金费率 get_funding_rate_history请求路径：/api/v5/public/funding-rate-history 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID ，如BTC-USD-SWAP仅适用于永续beforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的fundingTimeafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的fundingTimelimitString否分页返回的结果集数量，最大为100，不填默认返回100条15.2.6 获取限价 get_price_limit请求路径：/api/v5/public/price-limit 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，如BTC-USDT-SWAP仅适用于交割/永续/期权15.2.7 获取期权定价 get_opt_summary请求路径：/api/v5/public/opt-summary 请求方法：GET请求参数：参数名类型是否必须描述ulyString可选标的指数，仅适用于期权uly与instFamily必须传一个,若传两个，以instFamily为主instFamilyString可选交易品种，仅适用于期权uly与instFamily必须传一个,若传两个，以instFamily为主expTimeString否合约到期日，格式为"YYMMDD"，如 "200527"15.2.8 获取预估交割/行权价格 get_estimated_price请求路径：/api/v5/public/estimated-price 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID， 如BTC-USD-200214仅适用于交割/期权15.2.9 获取免息额度和币种折算率等级 get_discount_rate_interest_free_quota请求路径：/api/v5/public/discount-rate-interest-free-quota 请求方法：GET请求参数：参数名类型是否必须描述ccyString否币种discountLvString否折算率等级1:第一档2:第二档3:第三档4:第四档5:第五档15.2.10 获取系统时间 get_time请求路径：/api/v5/public/time 请求方法：GET请求参数：无15.2.11 获取平台公共爆仓单信息 get_liquidation_orders请求路径：/api/v5/public/liquidation-orders 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权mgnModeString否保证金模式cross：全仓isolated：逐仓instIdString否产品ID，仅适用于币币杠杆ccyString否币种 ，仅适用于币币杠杆（全仓）ulyString可选标的指数交割/永续/期权情况下，uly与instFamily必须传一个，若传两个，以instFamily为主instFamilyString可选交易品种交割/永续/期权情况下，uly与instFamily必须传一个，若传两个，以instFamily为主aliasString可选this_week：本周next_week：次周quarter：季度next_quarter：次季度交割合约情况下，该参数必填stateString否状态unfilled：未成交filled：已成交默认为unfilled交割/永续合约情况下，该参数必填beforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tslimitString否分页返回的结果集数量，最大为100，不填默认返回100条15.2.12 获取标记价格 get_mark_price请求路径：/api/v5/public/mark-price 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权ulyString否标的指数适用于交割/永续/期权instFamilyString否交易品种适用于交割/永续/期权instIdString否产品ID，如BTC-USD-SWAP15.2.13 获取衍生品仓位档位 get_position_tiers请求路径：/api/v5/public/position-tiers 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权tdModeString是保证金模式isolated：逐仓 ；cross：全仓ulyString可选标的指数，支持多uly，半角逗号分隔，最大不超过3个当产品类型是永续、交割、期权之一时，uly与instFamily必须传一个，若传两个，以instFamily为主当产品类型是MARGIN时忽略instFamilyString可选交易品种，支持多instFamily，半角逗号分隔，最大不超过5个当产品类型是永续、交割、期权之一时，uly与instFamily必须传一个，若传两个，以instFamily为主instIdString可选产品ID，支持多instId，半角逗号分隔，最大不超过5个仅适用币币杠杆，instId和ccy必须传一个，若传两个，以instId为主ccyString可选保证金币种仅适用杠杆全仓，该值生效时，返回的是跨币种保证金模式和组合保证金模式下的借币量tierString否查指定档位15.2.14 获取市场借币杠杆利率和借币限额 get_interest_rate_loan_quota请求路径：/api/v5/public/interest-rate-loan-quota 请求方法：GET请求参数：无15.2.15 获取尊享借币杠杆利率和借币限额 get_vip_interest_rate_loan_quota请求路径：/api/v5/public/vip-interest-rate-loan-quota 请求方法：GET请求参数：无15.2.16 获取衍生品标的指数 get_underlying请求路径：/api/v5/public/underlying 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型SWAP：永续合约FUTURES：交割合约OPTION：期权15.2.17 获取风险准备金余额 get_insurance_fund请求路径：/api/v5/public/insurance-fund 请求方法：GET请求参数：参数名类型是否必须描述instTypeString是产品类型MARGIN：币币杠杆SWAP：永续合约FUTURES：交割合约OPTION：期权typeString否风险准备金类型liquidation_balance_deposit：强平注入 ；bankruptcy_loss：穿仓亏损 ；platform_revenue：平台收入注入默认返回全部类型ulyString可选标的指数交割/永续/期权情况下，uly与instFamily必须传一个，若传两个，以instFamily为主instFamilyString可选交易品种交割/永续/期权情况下，uly与instFamily必须传一个，若传两个，以instFamily为主ccyString可选币种， 仅适用币币杠杆，且必填写beforeString否请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的tsafterString否请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的tslimitString否分页返回的结果集数量，最大为100，不填默认返回100条15.2.18 张币转换 get_convert_contract_coin请求路径：/api/v5/public/convert-contract-coin 请求方法：GET请求参数：参数名类型是否必须描述instIdString是产品ID，仅适用于交割/永续/期权szString是数量，币转张时，为币的数量，张转币时，为张的数量。张的数量，只能是正整数typeString否转换类型1: 币转张，当张为小数时，会进一取整2: 张转币默认为 1pxString可选委托价格币本位合约的张币转换时必填；U本位合约，usdt 与张的转换时，必填；coin 与张的转换时，可不填；期权的张币转换时，可不填。unitString否币的单位，coin: 币，usds: usdt 或者 usdc仅适用于交割和永续合约的U本位合约15.2.19 获取期权公共成交数据 get_option_trades请求路径：/api/v5/public/option-trades 请求方法：GET请求参数：参数名类型是否必须描述instIdString可选产品ID，如 BTC-USD-221230-4000-C，instId和instFamily必须传一个，若传两个，以instId为主instFamilyString可选交易品种，如 BTC-USDoptTypeString否期权类型，C：看涨期权P：看跌期权15.3 例子公共数据模块无需秘钥fromokx_apiimportPublicfrompprintimportpprintif__name__=='__main__':# 公共数据模块无需秘钥key=''secret=''passphrase=''flag='0'public=Public(key,secret,passphrase,flag)# 获取交易产品基础信息result=public.get_instruments(instType='SWAP',instId='BTC-USDT-SWAP')pprint(result)输出：>> {'code': '0',
>>  'data': [{'alias': '',
>>            'baseCcy': '',
>>            'category': '1',
>>            'ctMult': '1',
>>            'ctType': 'linear',
>>            'ctVal': '0.01',
>>            'ctValCcy': 'BTC',
>>            'expTime': '',
>>            'instFamily': 'BTC-USDT',
>>            'instId': 'BTC-USDT-SWAP',
>>            'instType': 'SWAP',
>>            'lever': '125',
>>            'listTime': '1611916828000',
>>            'lotSz': '1',
>>            'maxIcebergSz': '100000000',
>>            'maxLmtSz': '100000000',
>>            'maxMktSz': '10000',
>>            'maxStopSz': '10000',
>>            'maxTriggerSz': '100000000',
>>            'maxTwapSz': '100000000',
>>            'minSz': '1',
>>            'optType': '',
>>            'quoteCcy': '',
>>            'settleCcy': 'USDT',
>>            'state': 'live',
>>            'stk': '',
>>            'tickSz': '0.1',
>>            'uly': 'BTC-USDT'}],
>>  'msg': ''}16 交易大数据 Rubik16.1 交易大数据接口总览接口名称函数名称获取交易大数据支持币种get_support_coin获取主动买入/卖出情况get_taker_volume获取杠杆多空比get_loan_ratio获取合约多空持仓人数比get_long_short_account_ratio获取合约持仓量及交易量get_contracts_open_interest_volume获取期权持仓量及交易量get_option_open_interest_volume看涨/看跌期权合约 持仓总量比/交易总量比get_open_interest_volume_ratio看涨看跌持仓总量及交易总量（按到期日分）get_open_interest_volume_expiry看涨看跌持仓总量及交易总量（按执行价格分）get_open_interest_volume_strike看跌/看涨期权合约 主动买入/卖出量get_taker_block_volume16.2 交易大数据接口介绍16.2.1 获取交易大数据支持币种 get_support_coin请求路径：/api/v5/rubik/stat/trading-data/support-coin 请求方法：GET请求参数：无16.2.2 获取主动买入/卖出情况 get_taker_volume请求路径：/api/v5/rubik/stat/taker-volume 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种instTypeString是产品类型，币币："SPOT" , 衍生品："CONTRACTS"beginString否开始时间，例如：1597026383085endString否结束时间，例如：1597026383011periodString否时间粒度，默认值5m。支持[5m/1H/1D]5m粒度最多只能查询两天之内的数据1H粒度最多只能查询30天之内的数据1D粒度最多只能查询180天之内的数据16.2.3 获取杠杆多空比 get_loan_ratio请求路径：/api/v5/rubik/stat/margin/loan-ratio 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种beginString否开始时间，例如：1597026383085endString否结束时间，例如：1597026383011periodString否时间粒度，默认值5m。支持[5m/1H/1D]5m粒度最多只能查询两天之内的数据1H粒度最多只能查询30天之内的数据1D粒度最多只能查询180天之内的数据16.2.4 获取合约多空持仓人数比 get_long_short_account_ratio请求路径：/api/v5/rubik/stat/contracts/long-short-account-ratio 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种beginString否开始时间，例如：1597026383085endString否结束时间，例如：1597026383011periodString否时间粒度，默认值5m。支持[5m/1H/1D]5m粒度最多只能查询两天之内的数据1H粒度最多只能查询30天之内的数据1D粒度最多只能查询180天之内的数据16.2.5 获取合约持仓量及交易量 get_contracts_open_interest_volume请求路径：/api/v5/rubik/stat/contracts/open-interest-volume 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种beginString否开始时间，例如：1597026383085endString否结束时间，例如：1597026383011periodString否时间粒度，默认值5m。支持[5m/1H/1D]5m粒度最多只能查询两天之内的数据1H粒度最多只能查询30天之内的数据1D粒度最多只能查询180天之内的数据16.2.6 获取期权持仓量及交易量 get_option_open_interest_volume请求路径：/api/v5/rubik/stat/option/open-interest-volume 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种periodString否时间粒度，默认值8H。支持[8H/1D]每个粒度最多只能查询72条数据16.2.7 看涨/看跌期权合约 持仓总量比/交易总量比 get_open_interest_volume_ratio请求路径：/api/v5/rubik/stat/option/open-interest-volume-ratio 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种periodString否时间粒度，默认值8H。支持[8H/1D]每个粒度最多只能查询72条数据16.2.8 看涨看跌持仓总量及交易总量（按到期日分） get_open_interest_volume_expiry请求路径：/api/v5/rubik/stat/option/open-interest-volume-expiry 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种periodString否时间粒度，默认值8H。支持[8H/1D]每个粒度最多只能查询72条数据16.2.9 看涨看跌持仓总量及交易总量（按执行价格分） get_open_interest_volume_strike请求路径：/api/v5/rubik/stat/option/open-interest-volume-strike 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种expTimeString是到期日（格式: YYYYMMdd，例如："20210623"）periodString否时间粒度，默认值8H。支持[8H/1D]每个粒度最多只能查询72条数据16.2.10 看跌/看涨期权合约 主动买入/卖出量 get_taker_block_volume请求路径：/api/v5/rubik/stat/option/taker-block-volume 请求方法：GET请求参数：参数名类型是否必须描述ccyString是币种periodString否时间粒度，默认值8H。支持[8H/1D]每个粒度最多只能查询72条数据16.3 例子交易大数据模块无需秘钥fromokx_apiimportRubikfrompprintimportpprintif__name__=='__main__':# 交易大数据模块无需秘钥key=''secret=''passphrase=''flag='0'rubik=Rubik(key,secret,passphrase,flag)# 获取主动买入/卖出情况result=rubik.get_taker_volume(instType='SPOT',ccy='BTC')pprint(result)输出：>> {'code': '0',
>>  'data': [['1675572600000', '4.8369', '0.391'],
>>           ['1675572300000', '0.3481', '8.8288'],
>>           ['1675572000000', '0.7026', '1.421'],
>>           ['1675571700000', '1.3064', '0.9826'],
>>           ... ...
>>           ],
>>  'msg': ''}17 Status（系统状态）System17.1 Status接口总览接口名称函数名称获取系统升级事件的状态。get_status17.2 Status接口介绍17.2.1 获取系统升级事件的状态 get_status请求路径：/api/v5/system/status 请求方法：GET请求参数：参数名类型是否必须描述stateStringNo系统的状态，scheduled:等待中 ; ongoing:进行中 ; pre_open:预开放；completed:已完成 canceled: 已取消 当维护时间过长，会存在预开放时间，一般持续10分钟左右。 不填写此参数，默认返回 等待中、进行中和预开放 的数据17.3 例子System模块无需秘钥fromokx_apiimportSystemfrompprintimportpprintif__name__=='__main__':# System模块无需秘钥key=''secret=''passphrase=''flag='0'system=System(key,secret,passphrase,flag)# 获取系统升级事件的状态result=system.get_status()pprint(result)输出：>> {'code': '0', 'data': [], 'msg': ''}