2026-08-06
获取历史市场数据接口最大查询范围下调
获取历史市场数据 接口的最大查询范围已由 20 下调至 10。
| 参数名 | 类型 | 描述 |
|---|---|---|
| begin | String | 最大范围:日度 10 天,月度 10 个月(此前为 20 天 / 20 个月)。 |
2026-08-03
联盟受邀用户接口新增 UID、加入时间筛选与滚动窗口成交量
- 获取直客列表 新增请求参数:
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| uid | String | 否 | 按外部 UID 精确匹配。单个或最多 100 个 UID,以逗号分隔。无法解析的 UID 静默跳过;若全部无法解析,返回空页。 |
| joinTimeBegin | String | 条件必填 | 按 joinTime 过滤的下界,Unix时间戳的毫秒数格式,包含端点。需与 joinTimeEnd 同时传入;区间不超过 90 天,且不早于当前时间 180 天前。 |
| joinTimeEnd | String | 条件必填 | 按 joinTime 过滤的上界,Unix时间戳的毫秒数格式,包含端点。需与 joinTimeBegin 同时传入。 |
- 获取被邀请人返佣信息 新增请求参数
periodType与响应字段volPeriod:
| 参数名 | 类型 | 描述 |
|---|---|---|
| periodType(请求) | String | volPeriod 的统计窗口:last_7d、last_30d、this_month、last_month、total、today、this_week。不传时不返回 volPeriod。 |
| volPeriod(响应) | String | 所选 periodType 窗口内的交易量,单位为 USDT。仅当传入 periodType 时返回。窗口内无交易时返回 0。 |
2026-07-28
ELP 更名为 RPI(散户价格优化)计划
OKX 将品牌 Enhanced Liquidity Program(ELP) 更名为 Retail Price Improvement(散户价格优化,RPI)。本次变更包含新的 RPI 合并深度订单簿(books-rpi,同时提供 WebSocket 与 REST)、更名后的挂单类型 rpi(替代 elp)、扩展后的下单参数 rpiTakerAccess(替代 isElpTakerAccess)、用于 RPI 挂单价格间距规则的新参数 rpiPxRound,以及更名后的账户字段 rpi/rpiMaker。
ELP 命名弃用截止日期:2026年10月31日
在此日期之前,OKX 将以两种不同方式并行运行 ELP 与 RPI 命名:
- 字段重命名——两者都被接受;当请求或响应中同时包含两者时,以 RPI 命名的字段为准:
isElpTakerAccess→rpiTakerAccesselp→rpielpMaker→rpiMaker
- 取值重命名——互斥,只能二选一,不能同时传递:
ordType: elp→ordType: rpibooks-elp→books-rpi
现有集成可继续正常运行,无需改动。ELP 命名将于上述截止日期后停止支持——请在此之前完成所有集成向 RPI 命名的迁移。
新增合并深度:books-rpi(WS + REST)
- 新增
books-rpi,将非 RPI(有机)与 RPI 流动性合并为单一深度数据流——同时提供公共 WebSocket 频道(/ws/v5/public,400 档深度,初始全量推送 + 每 100 毫秒增量推送)与 REST 接口(GET /api/v5/market/books-rpi,服务端每 200 毫秒刷新一次)。不提供checksum,WS 序列一致性依赖seqId/prevSeqId。取代books-elp(见上方迁移说明)。
asks/bids 中的每个元素为 [price, totalQty, nonRpiQty, count]——totalQty 为该档位的总深度,nonRpiQty 为其中仅有机的部分,count 为该档位的汇总订单数量。
REST 请求参数:instId(必填)、sz(每侧深度档数,最大 400,默认 1)。
吃单参数:rpiTakerAccess(替代 isElpTakerAccess)
rpiTakerAccess是isElpTakerAccess的更名并扩展,支持所有标准订单类型(limit、market、fok、ioc;此前仅ioc),并可在改单接口中设置。isElpTakerAccess在弃用日期前将作为别名继续被接受(见上方迁移说明)。- 错误码
54045(此前用于非ioc订单尝试吃取 RPI 流动性时返回)已废弃——现在rpiTakerAccess对所有订单类型均有效,该错误码不再可能触发。
均适用于下单/改单,REST + WS:
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| rpiTakerAccess | Boolean | 否 | 默认值为 false。设为 true 时,订单可使用 RPI 流动性,适用于所有标准订单类型(此前仅 ioc)。当 rpiTakerAccess 为 true 时,减速带机制在下单和改单时均适用于所有 ordType,包括 post_only。改单时不会从原始订单继承,必须每次显式指定(省略则该次改单视为 false)。 |
挂单类型:rpi(替代 elp)
- 下 RPI 挂单时,请将
ordType设为rpi而非elp。elp在弃用日期前将继续被接受(见上方迁移说明)——ordType只能取一个值,二者选其一,不能同时传递。
适用于下单,REST + WS:
挂单参数:rpiPxRound
rpiPxRound为新增参数,用于 RPI 挂单价格间距规则(详见下文)。仅对 RPI 挂单(ordType: rpi)生效;对非 RPI 订单及OPTION/EVENTS将被忽略。
均适用于下单/改单,REST + WS(接口列表同上方 rpiTakerAccess)。
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| rpiPxRound | Boolean | 否 | 默认值为 false。设为 true 时,违反间距规则的价格将自动向外取整至最近的可挂单、且不会吃单的价位,而非直接拒绝。 |
- 在
ordersWebSocket 私有频道新增amendSource枚举值6:表示系统为满足 RPI 挂单价格间距规则(由rpiPxRound触发)而自动调整(取整)了订单价格。
RPI 挂单价格间距规则
RPI 挂单需遵守间距规则(见下方 rpiMinLevel / rpiMinPxBand)。订单违反该规则时将被拒绝,除非 rpiPxRound 设为 true,此时价格会自动向外取整至最近的合规价位(见上方 rpiPxRound)。
- 新增返回参数
rpiMinLevel与rpiMinPxBand,用于展示各产品的间距阈值。
| 参数名 | 类型 | 描述 |
|---|---|---|
| rpiMinLevel | String | RPI 买一价与卖一价之间的最小间距,以有机价格档位数计。默认值为 4;事件合约(Event Contracts)为 0。 |
| rpiMinPxBand | String | 满足间距规则所需的、与对方最优有机报价之间的最小距离,单位为基点(bps),例如 20。 |
RPI 挂单权限字段:rpi(替代 elp)
- 新增返回参数
rpi,用于表示 RPI 挂单权限。elp在弃用日期前将作为别名继续被接受(见上方迁移说明)。
| 参数名 | 类型 | 描述 |
|---|---|---|
| rpi | String | RPI 挂单权限。0:该产品未开通 RPI1:已开通,但当前用户无权限下 RPI 订单2:已开通且当前用户有权限返回 1/2 不代表当前存在 RPI 流动性。 |
RPI 挂单费率字段:rpiMaker(替代 elpMaker)
- 新增返回参数
rpiMaker,用于表示 RPI 挂单有效费率。elpMaker在弃用日期前将作为别名继续被接受(见上方迁移说明)。
| 参数名 | 类型 | 描述 |
|---|---|---|
| rpiMaker | String | RPI 挂单有效费率,若该产品不适用 RPI 则返回 ""。 |
成交来源字段:source
GET /api/v5/market/trades返回字段source取值1的说明由"流动性增强计划订单"更新为 RPI 订单(原 ELP 订单)。返回的取值1本身不变,仅更新说明文字。
错误码变更
错误消息由 ELP 更新为 RPI:
| 错误码 | 原消息 | 更新后消息 |
|---|---|---|
| 54039 | ELP 订单不支持仅减仓设置 | RPI 订单不支持仅减仓设置 |
| 54040 | ELP 订单无法与止盈止损设置同时使用 | RPI 订单无法与止盈止损设置同时使用 |
| 54041 | {param0} 不支持下 ELP 订单 | {param0} 不支持下 RPI 订单 |
| 54042 | 您无法为 {param0} 下 ELP 订单 | 您无法为 {param0} 下 RPI 订单 |
| 54043 | 您最多只能为 {param0} 下 {param1} 个 ELP 订单,请撤销部分订单后再试 | 您最多只能为 {param0} 下 {param1} 个 RPI 订单,请撤销部分订单后再试 |
| 54044 | {param0} 不支持 ELP,你不能吃单 ELP 挂单 | {param0} 不支持 RPI,你不能吃单 RPI 挂单 |
| 54046 | 你不能吃单 ELP 挂单 | 你不能吃单 RPI 挂单 |
| 54049 | 由于系统繁忙,API 用户目前无法吃单 ELP 挂单。请将 isElpTakerAccess 设置为 false 以继续操作 | 由于系统繁忙,API 用户目前无法吃单 RPI 挂单。请将 rpiTakerAccess 设置为 false 以继续操作 |
已弃用错误码:
| 错误码 | 消息 | 原因 |
|---|---|---|
| 54045 | OpenAPI 用户只能下 IOC 订单来吃单 ELP 挂单 | 已废弃——rpiTakerAccess 现适用于所有订单类型,不再限于 IOC。 |
2026-07-27
TVB(交易量返佣)节点分档、被邀请人及链接接口
在 /api/v5/affiliate/tvb/* 下新增四个节点(Affiliate)REST API 接口,将交易量返佣(Trading Volume Bonus,TVB)报表从聚合业绩概览进一步扩展——分档返佣明细、分页被邀请人列表、单个被邀请人详情查询,以及分链接业绩列表。所有金额均以 USDC 结算。
新增接口
- 新增接口,按被邀请人的交易手续费等级拆解节点在指定时间段内的 TVB 总额。
- 新增接口,分页返回 TVB 被邀请人列表——包含身份、手续费等级,以及统计窗口内的 TVB 交易量。
- 新增接口,通过 UID 返回单个被邀请人的 TVB 档案。
- 新增接口,列出节点的 TVB 邀请链接,每一行携带该链接的 TVB 业绩。
2026-07-20
TVB(交易量返佣)节点业绩接口
在 /api/v5/affiliate/tvb/* 下新增一个节点(Affiliate)REST API 接口,用于查询交易量返佣(Trading Volume Bonus,TVB)业绩——按可选统计窗口返回累计返佣、有效及符合条件的交易量、有效/符合条件的交易者与被邀请人数、入金额、首次交易者/首次入金者数量,以及节点返佣倍率。返佣以 USDC 结算。
新增接口
- 新增接口,返回指定时间段(
periodType,或自定义begin/end窗口,1 到 90 天)的聚合 TVB 业绩指标。
2026-07-06
节点(Affiliate)接口扩展
以下节点(Affiliate)接口此前已在全局站上线,现已同步开放至 EEA 站。此外,获取被邀请人返佣信息接口新增两个返回参数,并调整了限速。
新增接口
- 节点(Affiliate)下新增以下接口:
新增返回参数
- 在以下接口中新增返回参数
wdAmt、totalVol:
| 参数名 | 类型 | 描述 |
|---|---|---|
| wdAmt | String | 累计提现金额,单位为 USDT。如果没有提现,返回 0。 |
| totalVol | String | 生命周期累计交易量,单位为 USDT。如果没有交易,返回 0。 |
限速变更
- 获取被邀请人返佣信息 的限速由
20次/2s调整为3次/s。
2026-05-26
- 新增错误码
| 错误码 | HTTP状态码 | 错误提示 |
|---|---|---|
| 54092 | 200 | 操作要求:请通过网页端或 App 前端尝试下单 TradFi 永续合约(TradFi Perps)交易,并完成免责声明确认。每个主账户及子账户都必须单独接受免责声明后,方可启用 API 交易功能。 |
2025-12-15
- 开始支持现货杠杆交易
2025-07-02
更新前
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| after | String | 否 | 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085 |
| before | String | 否 | 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085 |
更新后
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| after | String | 否 | 查询在此之前的内容,值为时间戳或账单记录ID,Unix 时间戳为毫秒数格式,如 1597026383085 |
| before | String | 否 | 查询在此之后的内容,值为时间戳或账单记录ID,Unix 时间戳为毫秒数格式,如 1597026383085 |
| pagingType | String | 否 | 分页类型1:按账单记录时间戳分页2:按账单记录ID分页默认值为 1 |
- 新增返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| notes | String | 备注 |
2025-05-28
- 新增接口,以下账单流水(自 2021 年)接口已上线实盘
2025-04-17
新增接口:
新增错误码
| 错误码 | 错误提示 |
|---|---|
| 59515 | 您当前不在托管账户白名单上。请联系客服寻求帮助。 |
| 59516 | 请先创建 Copper 托管资金账户 |
| 59517 | 请先创建 Komainu 托管资金账户 |
| 59518 | 您当前无法使用 API 创建子账户。请在网页端或 App 端创建。 |
| 59519 | 此功能已冻结,暂时无法使用,冻结原因:{freezereason} |
2025-02-12
- 新增返回参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| notionalUsdForBorrow | String | 借币金额(美元价值) 适用于 现货模式/跨币种保证金模式/组合保证金模式 |
| notionalUsdForSwap | String | 永续合约持仓美元价值 适用于 跨币种保证金模式/组合保证金模式 |
| notionalUsdForFutures | String | 交割合约持仓美元价值 适用于 跨币种保证金模式/组合保证金模式 |
| notionalUsdForOption | String | 期权持仓美元价值 适用于 现货模式/跨币种保证金模式/组合保证金模式 |
2025-01-14
欧洲经济区主体用户提币API调整
由于合规要求,欧洲经济区主体用户在做 API 链上提币/闪电网络提币 时需要传入字段 rcvrInfo
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| rcvrInfo | Object | 可选 | 接收方信息 特定 国家/地区 认证用户做 链上提币/闪电网络提币 需要提供此信息 |
| > walletType | String | 是 | 钱包类型exchange:提币到交易所钱包如果提币到交易所钱包,必须提供接收方相关信息。 对于交易所钱包接收方为公司的, rcvrFirstName可以填公司名称,rcvrLastName可以填"N/A"。 |
| > exchId | String | 可选 | 交易所 ID 可以通过 获取交易所列表(公共) 接口查询支持的交易所 如果交易所不在支持的交易所列表中,该字段填 0 |
| > rcvrFirstName | String | 可选 | 接收方名字,如 Bruce |
| > rcvrLastName | String | 可选 | 接收方姓氏,如 Wayne |
用户提币到交易所钱包
当用户提币到交易所钱包,需要提供接收方信息。
- 欧洲经济区主体用户需要传入接受方如下字段信息(rcvrFirstName,rcvrLastName)。对于交易所钱包接收方为公司的,
rcvrFirstName可以填公司名称,rcvrLastName可以填"N/A"。示例如下:
用户提币到私人钱包
不支持 API 提币至私人钱包。请通过欧易 App 或官网完成提币操作。
其他接口调整
| 参数名 | 类型 | 描述 |
|---|---|---|
| note | String | 备注信息 |
| 参数名 | 类型 | 描述 |
|---|---|---|
| state | String | 17:钱包地址正等待国际转账规则认证 |
新增错误码
| 错误码 | 错误提示 |
|---|---|
| 58239 | 不支持 API 提币至私人钱包。请通过欧易 App 或官网完成提币操作。 |
2024-12-30
2024-09-19
- 新增返回参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| enableSpotBorrow | Boolean | 现货模式是否支持借币true:支持false:不支持 |
| spotBorrowAutoRepay | Boolean | 现货模式是否支持自动还币true:支持false:不支持 |
- 新增返回参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| ccy | String | 币种 |
| 参数名 | 类型 | 描述 |
|---|---|---|
| isTradeBorrowMode | String | 是否自动借币 true:自动借币 false:不自动借币 仅适用于计划委托、移动止盈止损和 时间加权策略 |
2024-09-18
- 新增接口