导航
English
Java Python Go C++

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(请求) String volPeriod 的统计窗口:last_7dlast_30dthis_monthlast_monthtotaltodaythis_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 命名:

现有集成可继续正常运行,无需改动。ELP 命名将于上述截止日期后停止支持——请在此之前完成所有集成向 RPI 命名的迁移。

新增合并深度:books-rpi(WS + REST)

asks/bids 中的每个元素为 [price, totalQty, nonRpiQty, count]——totalQty 为该档位的总深度,nonRpiQty 为其中仅有机的部分,count 为该档位的汇总订单数量。

REST 请求参数:instId(必填)、sz(每侧深度档数,最大 400,默认 1)。

吃单参数:rpiTakerAccess(替代 isElpTakerAccess

均适用于下单/改单,REST + WS:

参数名 类型 是否必须 描述
rpiTakerAccess Boolean 默认值为 false
设为 true 时,订单可使用 RPI 流动性,适用于所有标准订单类型(此前仅 ioc)。
rpiTakerAccesstrue 时,减速带机制在下单和改单时均适用于所有 ordType,包括 post_only
改单时不会从原始订单继承,必须每次显式指定(省略则该次改单视为 false)。

挂单类型:rpi(替代 elp

适用于下单,REST + WS:

挂单参数:rpiPxRound

均适用于下单/改单,REST + WS(接口列表同上方 rpiTakerAccess)。

参数名 类型 是否必须 描述
rpiPxRound Boolean 默认值为 false。设为 true 时,违反间距规则的价格将自动向外取整至最近的可挂单、且不会吃单的价位,而非直接拒绝。

RPI 挂单价格间距规则

RPI 挂单需遵守间距规则(见下方 rpiMinLevel / rpiMinPxBand)。订单违反该规则时将被拒绝,除非 rpiPxRound 设为 true,此时价格会自动向外取整至最近的合规价位(见上方 rpiPxRound)。

参数名 类型 描述
rpiMinLevel String RPI 买一价与卖一价之间的最小间距,以有机价格档位数计。默认值为 4;事件合约(Event Contracts)为 0
rpiMinPxBand String 满足间距规则所需的、与对方最优有机报价之间的最小距离,单位为基点(bps),例如 20

RPI 挂单权限字段:rpi(替代 elp

参数名 类型 描述
rpi String RPI 挂单权限。
0:该产品未开通 RPI
1:已开通,但当前用户无权限下 RPI 订单
2:已开通且当前用户有权限
返回 1/2 不代表当前存在 RPI 流动性。

RPI 挂单费率字段:rpiMaker(替代 elpMaker

参数名 类型 描述
rpiMaker String RPI 挂单有效费率,若该产品不适用 RPI 则返回 ""

成交来源字段:source

错误码变更

错误消息由 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 结算。

新增接口

2026-07-20

TVB(交易量返佣)节点业绩接口

/api/v5/affiliate/tvb/* 下新增一个节点(Affiliate)REST API 接口,用于查询交易量返佣(Trading Volume Bonus,TVB)业绩——按可选统计窗口返回累计返佣、有效及符合条件的交易量、有效/符合条件的交易者与被邀请人数、入金额、首次交易者/首次入金者数量,以及节点返佣倍率。返佣以 USDC 结算。

新增接口

2026-07-06

节点(Affiliate)接口扩展

以下节点(Affiliate)接口此前已在全局站上线,现已同步开放至 EEA 站。此外,获取被邀请人返佣信息接口新增两个返回参数,并调整了限速。

新增接口

新增返回参数

参数名 类型 描述
wdAmt String 累计提现金额,单位为 USDT。如果没有提现,返回 0
totalVol String 生命周期累计交易量,单位为 USDT。如果没有交易,返回 0

限速变更

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

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

用户提币到交易所钱包

当用户提币到交易所钱包,需要提供接收方信息。

用户提币到私人钱包

不支持 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