OKX.com

此组别内的文章

欧易 V5 API 功能季报Q2 2021

Avatar
客户支持
  • 创建于
尊敬的欧易API用户：
为了更提升用户体验，欧易在二季度对V5 API服务进行了不断的优化迭代，汇总如下。
未来欧易将持续优化V5 API的功能，为您提供更优秀的产品和更优质的服务。
（更详细的升级日志请参见我们的API在线文档 https://www.OKX.com/docs-v5/zh/#log）
优化汇总:
  1. 交易模块
Id
接口
迭代简述
日期
1
REST-下单
新增order type类型: optimal_limit_ioc
2021-5-25
REST-批量下单
WebSocket-下单
WebSocket-批量下单
  1. 资金模块
Id
接口
迭代简述
日期
1
获取充值地址信息
返回结果新增参数ctAddr：合约地址后6位。
2021-6-15
2
提币
返回结果新增参数chain
2021-6-15
获取充值地址信息
获取提币记录
获取充值记录
3
提币
新增请求参数chain
2021-6-15
  1. 账户模块
Id
接口
迭代简述
日期
1
获取最大可买卖/开仓数量
支持多个instId查询（不超过5个），半角逗号分隔。
2021-6-11
2
查看持仓信息
支持多个instId查询（不超过10个），半角逗号分隔。
2021-6-8
3
REST-查看账户余额
新增字段：notionalUsd（仓位的美金价值），notionalLever（币种杠杆倍数），eqUsd（币种权益的美金价值），maxLoan（币种最大可借）
2021-5-18
WebSocket-账户频道
4
REST-查看持仓信息
返回结果中新增greeks字段
2021-4-21
WebSocket-持仓频道
5
查看账户配置
返回结果新增字段：level（当前在平台上真实交易量的用户等级） ，levelTmp（特约用户的临时体验用户等级）。
2021-4-21
6
账单流水查询
删除subType字段中的枚举值109
2021-4-21
7
REST-查看账户余额
返回结果新增字段：cashBal（币种余额）， uTime（币种余额的更新时间）
2021-4-16
WebSocket-账户频道
8
查看账户和持仓风险
新增该接口
2021-4-16
9
获取用户当前杠杆借币利率
新增该接口
2021-4-16
  1. 子账户模块
Id
接口
迭代简述
日期
1
查询子账户余额
返回结果新增字段：notionalUsd（仓位的美金价值），notionalLever（币种杠杆倍数），eqUsd（币种权益的美金价值），maxLoan（币种最大可借）
2021-5-18
2
查询子账户余额
返回结果新增字段：cashBal（币种余额）， uTime（币种余额的更新时间）
2021-4-16
  1. 行情数据模块
Id
接口
迭代简述
日期
1
Oracle上链交易数据
新增该接口
2021-4-21
2
获取平台24小时总成交量
新增该接口
2021-4-16
  1. 公共数据模块
Id
接口
迭代简述
日期
1
获取免息额度和币种折算率等级
返回结果中新增币种折算率的详情字段。
2021-5-25
2
获取衍生品标的指数
新增该接口
2021-5-25
3
获取杠杆利率和借币限额
新增该接口
2021-5-25
4
获取衍生品仓位档位
新增该接口
2021-4-21
  1. WebSocket模块
Id
接口
迭代简述
日期
1
订单频道
新增推送字段：fillNotionalUsd（成交美元价值），notionalUsd（预估美元价值）
2021-6-8
2
策略委托订单频道
新增推送字段：notionalUsd（预估美元价值）
2021-6-8
3
订单频道
新增推送字段：fillFee（最新一笔成交的手续费），fillFeeCcy（最新一笔成交的手续费币种），execType（最新一笔成交的流动性方向 T：taker， M：maker ）
2021-4-21
4
books50-l2-tbt频道
新增该频道
2021-4-21
5
账户余额和持仓频道
eventType字段新增枚举值 “interest_deduction”
2021-4-21
  1. 错误码
Id
迭代简述
日期
1
新增错误码55000, 交割后30分钟内不能转出。
2021-6-11
优化明细:
  1. 交易模块
  • 迭代 1
  • 日期：2021-5-25
  • REST接口： 下单，批量下单
  • REST URLs: POST /api/v5/trade/order
POST /api/v5/trade/batch-orders
  • WebSocket操作：下单，批量下单
  • WebSocket操作关键字：order, batch-orders
  • 详细描述：新增order type类型optimal_limit_ioc, 适用于交割和永续。
  • 提升点：该新增的订单类型允许用户交易交割和永续的市价委托IOC订单。
  1. 资金模块
  • 迭代 1
  • 日期：2021-6-15
  • 接口： 获取充值地址信息
  • URL: GET /api/v5/asset/deposit-address
  • 详细描述： 返回结果新增参数ctAddr：合约地址后6位。
  • 体验提升点：返回准确的币种合约地址给用户，避免用户充值到错误的合约。
  • 迭代 2
  • 日期：2021-6-15
  • Endpoints: 获取充值地址信息，提币，获取提币记录，获取充值记录
  • URLs: GET /api/v5/asset/deposit-address
POST /api/v5/asset/withdrawal
GET /api/v5/asset/withdrawal-history
GET /api/v5/asset/deposit-history
  • 详细描述：返回结果新增字段chain
  • 体验提升点: 将币种的链信息从币种参数中分离出来，这样币种参数值就更加规范。
  • 迭代 3
  • 日期：2021-6-15
  • 接口：提币
  • URL: POST /api/v5/asset/withdrawal
  • 详细描述： 新增请求参数chain
  • 体验提升点: 将币种的链信息从币种参数中分离出来，这样币种参数值更加规范。
  1. 账户模块
  • 迭代 1
  • 日期：2021-6-11
  • 接口：获取最大可买卖/开仓数量
  • URL: GET /api/v5/account/max-size
  • 详细描述：支持用户指定多个instId（不超过5个）进行查询，半角逗号分割。
  • 体验提升点: 让查询更加灵活
  • 迭代 2
  • 日期：2021-6-8
  • 接口：查看持仓信息
  • URL: GET /api/v5/account/positions
  • 详细描述： 支持用户指定多个instId（不超过10个）进行查询，半角逗号分割。
  • 体验提升点: 让查询更加灵活
  • 迭代 3
  • 日期：2021-5-18
  • REST接口：查看账户余额
  • REST URL: GET /api/v5/account/balance
  • WebSocket频道: 账户频道
  • WebSocket订阅名: account
  • 详细描述：新增字段：notionalUsd（仓位的美金价值），notionalLever（币种杠杆倍数），eqUsd（币种权益的美金价值）和maxLoan（币种最大可借）。
  • 体验提升点: 基于这些字段，用户可以比较方便的计算一些账户整体风险指标。
  • 迭代 4
  • 日期：2021-4-21
  • REST 接口：查看持仓信息
  • REST URL: GET /api/v5/account/positions
  • WebSocket频道: 持仓频道
  • WebSocket订阅名: positions
  • 详细描述：返回结果中新增greeks风险指标的参数
  • 体验提升点:用户可以比较方便的查看期权持仓的greeks风险指标
  • 迭代 5
  • 日期：2021-4-21
  • 接口：查看账户配置
  • URL: GET /api/v5/account/config
  • 详细描述：返回结果新增字段：level（当前在平台上真实交易量的用户等级） 和levelTmp（特约用户的临时体验用户等级）。
  • 体验提升点: 用户可以比较方便的查看基于交易量的真实用户等级，以及特约的临时体验用户等级。
  • 迭代 6
  • 日期：2021-4-21
  • 接口：账单流水查询
  • URLs: GET /api/v5/account/bills
GET /api/v5/account/bills-archive
  • 详细描述：删除subType字段的枚举值109
  • 体验提升点: 根据最新的业务需求删除该枚举值
  • 迭代 7
  • 日期：2021-4-16
  • REST 接口：查看账户余额
  • REST URL: GET /api/v5/account/balance
  • WebSocket频道: 账户频道
  • WebSocket订阅名: account
  • 详细描述：返回结果新增字段：cashBal（币种余额）和 uTime（币种余额的更新时间）。
  • 体验提升点: 提供币种余额以及更新时间
  • 迭代 8
  • 日期：2021-4-16
  • 接口：查看账户和持仓风险
  • URL: GET /api/v5/account/account-position-risk
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取同一时间的关键账户余额及持仓信息，比较方便的计算一些自定义的风险指标。
  • 迭代 9
  • 日期：2021-4-16
  • 接口：获取用户杠杆借币利率
  • URL: GET /api/v5/account/interest-rate
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取币种的杠杆借币利率（基于用户的账户等级）
  1. 子账户模块
  • 迭代 1
  • 日期：2021-5-18
  • 接口：查询子账户余额
  • URL: GET /api/v5/account/subaccount/balances
  • 详细描述：返回结果新增字段：notionalUsd（仓位的美金价值），notionalLever（币种杠杆倍数），eqUsd（币种权益的美金价值）和maxLoan（币种最大可借）。
  • 体验提升点: 基于这些字段，用户可以比较方便的计算一些账户整体风险指标。
  • 迭代 2
  • 日期：2021-4-16
  • 接口： 查询子账户余额
  • URL: GET /api/v5/account/subaccount/balances
  • 详细描述：返回结果新增字段：cashBal（币种余额）和 uTime（币种余额的更新时间）。
  • 体验提升点: 提供币种余额以及更新时间
  1. 行情数据模块
  • 迭代 1
  • 日期：2021-4-21
  • 接口：Oracle上链交易数据
  • URL: GET /api/v5/market/open-oracle
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取以Open Oracle标准发布到链上的签名加密价格
  • 迭代 2
  • 日期：2021-4-16
  • 接口：获取平台24小时总成交量
  • URL: GET /api/v5/market/platform-24-volume
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取24小时滚动计算的平台总成交量，以美元计价。特别对一些第三方平台很有帮助。
  1. 公共数据模块
  • 迭代 1
  • 日期：2021-5-25
  • 接口：获取免息额度和币种折算率等级
  • URL: GET /api/v5/public/discount-rate-interest-free-quota
  • 详细描述：返回结果新增币种折算率的详情字段：discountRate（折算率）, minAmt（梯度区间下限）和maxAmt (梯度区间上限)。
  • 体验提升点: 提供更具体的折算率梯度信息
  • 迭代 2
  • 日期：2021-5-25
  • 接口：获取衍生品标的指数
  • URL: GET /api/v5/public/underlying
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取衍生品的标的指数列表
  • 迭代 3
  • 日期：2021-5-25
  • 接口：获取杠杆利率和借币限额
  • URL: GET /api/v5/public/interest-rate-loan-quota
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取币币杠杆借币利率和借币限额信息
  • 迭代 4
  • 日期：2021-4-21
  • 接口：获取衍生品仓位档位
  • URL: GET /api/v5/public/position-tiers
  • 详细描述：新增该接口
  • 体验提升点: 用户可以获取衍生品仓位档位信息
  1. WebSocket Module
  • 迭代 1
  • 日期：2021-6-8
  • 频道名: 订单频道
  • 订阅名: orders
  • 详细描述：新增推送字段fillNotionalUsd（成交美元价值）和notionalUsd（预估美元价值）
  • 体验提升点: 用户可以比较方便的查看订单美元价值
  • 迭代 2
  • 日期：2021-6-8
  • 频道名: 策略委托单频道
  • 订阅名: orders-algo
  • 详细描述：新增推送字段notionalUsd（预估美元价值）
  • 体验提升点: 用户可以比较方便的查看订单美元价值
  • 迭代 3
  • 日期：2021-4-21
  • 频道名: 订单频道
  • 订阅名: orders
  • 详细描述：新增推送字段fillFee（最新一笔成交的手续费），fillFeeCcy（最新一笔成交的手续费币种）和execType（最新一笔成交的流动性方向 T：taker， M：maker ）
  • 体验提升点: 使订单推送对用户的实时对账更友好
  • 迭代 4
  • 日期：2021-4-21
  • 频道名: 深度频道
  • 订阅名: books50-l2-tbt
  • 详细描述：新增该频道
  • 体验提升点: 提供50档的逐笔深度频道，满足用户对逐笔深度的需求，同时减少用户的资源开销。
  • 迭代 5
  • 日期：2021-4-21
  • 频道名: 账户余额和持仓频道
  • 订阅名: balance_and_position
  • 详细描述：eventType字段新增枚举值 “interest_deduction”
  • 体验提升点: 扣息也会触发该频道的数据推送
  1. 错误码
  • 迭代 1
  • 日期：2021-6-11
  • 详细描述：新增错误码55000，消息内容“交割后30分钟内不能转出”
  • 体验提升点: 使错误场景对用户更加清晰

 

欧易团队

2022年4月14日(HKT)

 

相关文章

返回顶部