待发布内容

websocket服务升级断线提示

为提升API服务质量，WebSocket会新增一类新的消息类型(event = notify)。在推送服务升级前30秒会推送如下信息，告知用户WebSocket服务即将升级，请重新建立新的连接避免由于断线对用户造成的影响。

该功能已上模拟盘，支持WebSocket公共频道(/ws/v5/public)和私有频道(/ws/v5/private)。预计该功能于 12月中旬上线。

追逐限价委托

追逐限价委托已经上线模拟盘，将分批次上线实盘。

新增请求参数或者枚举值，将于11 月 20日上线实盘。
- POST / 策略委托下单

参数名	类型	是否必须	描述
ordType	String	否	订单类型 `chase`: 追逐限价委托，仅适用于交割和永续。

追逐限价委托

追逐限价委托会立即下 Post Only 订单（只做maker单）并跟随深度变动进行改单。
追逐限价委托和对应的 Post Only 订单不支持改单。

参数名	类型	是否必须	描述
chaseType	String	否	追逐类型。 `distance`: 买一/卖一价的距离，默认值。 `ratio`: 比例。
chaseVal	String	否	追逐值。当`chaseType`为`distance`时，是到买一/卖一价的距离。对于 USDT 本位合约，单位为 USDT；对于 USDC 合约，单位为 USDC；对于币本位合约，单位为 USD 。当`chaseType`为`ratio`时，为比率，0.1 代表 10%。默认值为 0。
maxChaseType	String	可选	最大追逐值的类型。 `distance`: 买一/卖一价的距离 `ratio`: 比例。0.1 代表 10%。 maxChaseTyep 和 maxChaseVal 需要同时填写或者不填写。
maxChaseVal	String	可选	最大追逐值。当`chaseType`为`distance`时，是到买一/卖一价的的最大距离当`chaseType`为`ratio`时，指的比率，0.1 代表 10%。
reduceOnly	Boolean	否	是否只减仓，`true` 或 `false`，默认`false` 仅适用于`币币杠杆`，以及买卖模式下的`交割/永续` 仅适用于`现货和合约模式`和`跨币种保证金模式`

新增返回参数，将于11 月 20 日上线实盘。

参数名	类型	描述
chaseType	String	追逐类型。
chaseVal	String	追逐值。
maxChaseType	String	最大追逐值的类型。
maxChaseVal	String	最大追逐值。

新增请求参数枚举值，将于11 月 20 日上线实盘。
- 获取未完成策略委托单列表
- 获取历史策略委托单列表

参数名	类型	是否必须	描述
ordType	String	否	订单类型 `chase`: 追逐限价委托，仅适用于交割和永续。

新增返回参数枚举值，将于11 月 20 日上线实盘。

参数名	类型	描述
source	String	`34`: 追逐限价委托生成的普通单
cancelSource	String	`40`: 初始下单价格与最新的买一或卖一价已达到最大追逐距离，您的订单已被自动取消。

2024-11-14

调整返回参数
- 获取币种列表

调整前

参数名	类型	描述
minFee	String	普通地址最小提币手续费数量适用于`链上提币`
maxFee	String	普通地址最大提币手续费数量适用于`链上提币`
minFeeForCtAddr	String	合约地址最小提币手续费数量适用于`链上提币`
maxFeeForCtAddr	String	合约地址最大提币手续费数量适用于`链上提币`

调整后

参数名	类型	描述
fee	String	固定的提币手续费数量适用于`链上提币`
minFee	String	普通地址最小提币手续费数量适用于`链上提币` 该字段已废弃
maxFee	String	普通地址最大提币手续费数量适用于`链上提币` 该字段已废弃
minFeeForCtAddr	String	合约地址最小提币手续费数量适用于`链上提币` 该字段已废弃
maxFeeForCtAddr	String	合约地址最大提币手续费数量适用于`链上提币` 该字段已废弃

删除请求参数
- 提币

参数名	类型	是否必填	描述n
fee	String	是	提币手续费为固定值，用户无需输入。如果用户传了该字段，会被忽略。

2024-11-11

欧易开始支持组合保证金账户模式下的历史仓位数据更新，该功能于2024年11月11日中午12:00（UTC+8）上线实盘。功能上线后，用户在组合保证金账户模式下新创建的仓位，将在平仓后产生历史仓位记录；在功能上线前创建的仓位，在功能上线后平仓，不会产生历史仓位记录。
- 查看历史持仓信息

2024-11-08

新增返回参数
- 查看账户配置

参数名	类型	描述
type	String	账户类型 `0`：母账户 `1`：普通子账户 `2`：资管子账户 `5`：托管交易子账户 - Copper `9`：资管交易子账户 - Copper `12`：托管交易子账户 - Komainu

关于币种折扣率相关字段下线，不必要的币种折扣率相关字段已经下线，详情如下：

关联变更欧易将修改跨币种和组合保证金模式下的币种折扣率规则

查看账户配置

参数名	类型	描述
discountType	String	当前账户所在的币种折扣率类型 `0`: 原先的币种折算率规则，默认值 `1`: 新的币种折算率规则用来确认当前账户所在的币种折扣率类型。当新的币种折算率规则全面生效后，接口将不再返回该字段，建议提前做好兼容。

获取免息额度和币种折算率等级接口

返回参数名	类型	描述
discountInfo	Array	原先的币种折算率详情，该组参数在新的币种折扣规则完全生效后，不再返回，建议提前做好兼容
> discountRate	String	折算率
> maxAmt	String	梯度区间上限（美元），“” 表示正无穷
> minAmt	String	梯度区间下限（美元），最小值是0

子账户维度，订阅特定 WebSocket 频道的最大连接数为调整为 30 个。
- 连接限制

2024-10-28

新增返回参数
- GET / 查看项目

参数名	类型	描述
fastRedemptionDailyLimit	String	快速赎回每日最高限额如果不支持快速赎回，则返回""

新增返回参数
- GET / 查看活跃订单

参数名	类型	描述
fastRedemptionData	Array of object	快速赎回信息
> ccy	String	快速赎回币种，如 `BTC`
> redeemingAmt	String	赎回中的数量

新增接口
- GET / 获取产品信息
新增返回参数
- GET / 获取申购赎回记录

参数名	类型	描述
redeemingAmt	String	赎回中的数量

2024-10-23

欧易将针对交易产品接口及频道进行优化，包括新增auctionEndTime返回参数代表集合竞价结束时间，部分交易产品上线新增预上线状态state:preopen及更新listTime为上线时间。

参数名	类型	描述
auctionEndTime	String	集合竞价结束时间，Unix时间戳的毫秒数格式，如 `1597026383085` 仅适用于通过集合竞价方式上线的`币币`，其余情况返回""

参数名	类型	描述
state	String	产品状态 `preopen`：预上线，交割和期权合约轮转生成到开始交易；部分交易产品上线前

新增返回字段

参数名	类型	描述
> spotCopyTradingEq	String	现货智能跟单权益默认为0，仅适用于跟单人

2024-10-17

闪兑相关接口调整

闪兑

新增错误码

错误码	HTTP 状态码	错误提示
52914	200	交易账户可用资产不足

对应交易账单类型
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
type	String	账单类型 `27`：闪兑 `30`：简单交易
subType	String	子账单类型 `318`：闪兑买入 `319`：闪兑卖出 `320`：简单交易买入 `321`：简单交易卖出

一键兑换主流币

新增请求参数
- GET / 获取一键兑换主流币币种列表
- POST / 一键兑换主流币交易

参数名	类型	是否必须	描述
source	String	否	资金来源 `1`：交易账户 `2`：资金账户默认为`1`

对应交易账单类型
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
type	String	账单类型 `28`：小额兑换
subType	String	子账单类型 `236`：小额兑换买入 `237`：小额兑换卖出

一键还债

对应交易账单类型
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
type	String	账单类型 `29`：一键还债
subType	String	子账单类型 `224`：一键还债买入 `225`：一键还债卖出

小额资产兑换

接口下线
- 小额资产兑换

2024-10-15

新增返回参数
- 获取固定借币限额

参数名	类型	描述
> term	String	借贷期限如 `30D`：30天

新增请求参数
- 获取固定借币订单信息

参数	类型	是否必须	描述
term	String	否	借贷期限如 `30D`：30天

新增参数枚举值
- 查看子账户列表

参数名	类型	描述
type	String	子账户类型 `9`：资管交易子账户 - Copper `12`：托管交易子账户 - Komainu

2024-10-14

新增接口
新增请求参数
- 获取杠杆倍数

参数名	类型	是否必须	描述
ccy	String	可选	币种，用于币种维度的杠杆。仅适用于`现货模式`/`跨币种保证金模式`/`组合保证金模式`的全仓币币杠杆。支持多币种查询，半角逗号分隔。币种个数不超过20个。

新增交易账单子类型
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
subType	String	账单子类型 `306`：手动借币 `307`：自动借币 `308`：手动还币 `309`：自动还币 `312`：自动折抵

新增错误码

错误码	HTTP 状态码	错误提示
59410	200	只有当借币交易启用且该币种支持借币交易时，您才可以进行借币
59411	200	无法手动借币，账户可用保证金不足
59412	200	无法手动借币，您输入的数量已超过借币限额
59413	200	该币种没有负债，无需还币
59414	200	无法手动借币，您输入的数量应大于或等于最小借币数量 {param0}

2024-10-10

新增返回参数
- 获取币种列表

参数名	类型	描述
burningFeeRate	String	燃烧费率，如 `0.05` 代表 `5%`。部分币种会收取燃烧费用。燃烧费用按照提币数量（不含gas fee）乘以燃烧费率，在提币数量基础上扣除。适用于`链上提币`

新增返回参数
- 获取不可交易资产

参数名	类型	描述
burningFeeRate	String	燃烧费率，如 `0.05` 代表 `5%`。部分币种会收取燃烧费用。燃烧费用按照提币数量（不含gas fee）乘以燃烧费率，在提币数量基础上扣除。
feeCcy	String	提币固定手续费单位

价差交易支持市价单，ordType请求、返回参数新增枚举值market。
价差交易新增撤单场景，cancelSource返回参数新增枚举值15: 已撤单：该订单委托价不在限价范围内。

2024-10-04

新增集合竞价信息 WebSocket 频道
- WS / 集合竞价信息频道

2024-10-01

接口新增公共特性
- GET / 公告

2024-09-20

新增接口
- 固定借币转市场借币
- 固定借币减少负债
新增参数枚举值
- 获取固定借币订单信息

参数名	类型	描述
state	String	状态 `8`：待还币 (详情参考固定借币减少负债)

新增返回参数adlType枚举值。具体请参考产品文档。自动减仓机制介绍。
- 获取风险准备金余额
- 自动减仓预警频道

参数名	类型	描述
state	String	状态 `8`：待还币

新增返回参数adlType枚举值。具体请参考产品文档自动减仓机制介绍。
- 获取风险准备金余额
- 自动减仓预警频道

参数名	类型	描述
adlType	String	`pos_adl_start`：由于强平单的规模积累到一定程度的自动减仓开始（仅适用于盘前交易市场）

2024-09-19

新增返回参数
- 查看账户配置

参数名	类型	描述
enableSpotBorrow	Boolean	`现货模式`是否支持借币 `true`：支持 `false`：不支持
spotBorrowAutoRepay	Boolean	`现货模式`是否支持自动还币 `true`：支持 `false`：不支持

新增返回参数
- 获取杠杆倍数

参数名	类型	描述
ccy	String	币种

新增返回参数
- 获取免息额度和币种折算率等级接口

参数名	类型	描述
disCcyEq	String	折扣后的币种权益（取当前梯度区间上限），便于快速计算

新增请求参数
- 撤销 MMP 订单频道
- 撤销 MMP 订单

参数名	类型	是否必须	描述
lockInterval	String	否	锁定时长(毫秒) 范围应为[0, 10 000] 默认为 0. 如果想要立即解锁，您可以设置为 "0" 下单时，如果在该锁定期间，会报错 54008，如果在 MMP 触发期间，会报错 51034

新增错误码

错误码	HTTP 状态码	错误提示
54008	200	该操作被“撤销 MMP 订单”接口限制。请通过该接口解除限制。
54009	200	{param0}的范围应为 [{param1}，{param2}]

新增返回参数

参数名	类型	描述
isTradeBorrowMode	String	是否自动借币 true：自动借币 false：不自动借币仅适用于计划委托、移动止盈止损和时间加权策略

以下成交明细（近两年）接口，已经下线
- POST / 申请成交明细（近两年）
- GET / 获取成交明细（近两年）

2024-09-18

新增接口
- GET / 公告
- GET / 公告类型

2024-09-13

新增错误码

错误码	HTTP 状态码	错误提示
54011	200	盘前交易合约交割前 1 小时内仅允许减少仓位数量，请修改或撤销订单

新增返回参数
- 获取大宗交易公共成交数据

参数名	类型	描述
strategy	String	期权策略, e.g. `CALL_CALENDAR_SPREAD`

2024-08-29

交易手续费费率接口新增ruleType请求、返回参数
- 获取当前账户交易手续费费率

请求参数

参数名	类型	是否必须	描述
ruleType	String	是	交易规则类型 `normal`：普通交易 `pre_market`：盘前交易 ruleType不能与instId/instFamily/uly同时传入

返回参数

参数名	类型	描述
ruleType	String	交易规则类型 `normal`：普通交易 `pre_market`：盘前交易

获取持仓总量接口新增oiUsd返回参数
- 获取持仓总量

返回参数

参数名	类型	描述
oiUsd	String	持仓量（按`USD`折算）

2024-08-28

新增返回字段

参数名	类型	描述
> spotBal	String	现货余额，单位为币种，比如 BTC。点击了解更多
> openAvgPx	Array	现货开仓成本价单位 USD。点击了解更多
> accAvgPx	Array	现货累计成本价单位 USD。点击了解更多
> spotUpl	String	现货未实现收益，单位 USD。点击了解更多
> spotUplRatio	String	现货未实现收益率。点击了解更多
> totalPnl	String	现货累计收益，单位 USD。点击了解更多
> totalPnlRatio	String	现货累计收益率。点击了解更多

新增接口
- GET / 最大网格数量（公共）

2024-08-22

价差交易私有成交接口新增szCont返回参数，表示合约单腿的成交数量。
- 获取历史成交数据（近七天）
- 成交数据频道

参数名	类型	描述
legs	Array of objects	交易的腿
> szCont	String	成交合约数量仅适用于合约，现货将返回""

为了更好的使用体验，对于账户相关接口和频道，币种余额小于 1e-8 的币种信息，会在 details 中返回。

2024-08-21

新增集合竞价信息接口
- GET / 集合竞价信息
新增错误码

错误码	HTTP 状态码	错误提示
51505	200	{instId} 不处于集合竞价阶段

价差速度新增深度频道 sprd-books-l2-tbt，首次推400档快照数据，以后增量推送，每10毫秒推送一次变化的数据。订阅该频道时新增推送数据参数action，checksum，prevSeqId以及seqId
- 深度频道

参数名	类型	描述
action	String	推送数据动作，增量推送数据还是全量推送数据 `snapshot`：全量 `update`：增量
data	Array	订阅的数据
> checksum	Integer	检验和（下方注解）。仅适用 `sprd-books-l2-tbt`
> prevSeqId	Integer	上一个推送的序列号。仅适用 `sprd-books-l2-tbt`
> seqId	Integer	推送的序列号（下方注解）。仅适用 `sprd-books-l2-tbt`

2024-08-14

欧易新增成交频道

WS / 成交频道

欧易将修改跨币种和组合保证金模式下的币种折扣率规则

欧易将逐步修改币种折扣率规则，具体规则请参考欧易将修改跨币种和组合保证金模式下的币种折扣率规则。

API 相应的改动已经上线实盘，为了避免上线后对您的交易策略造成影响，请参考以下内容，进行必要的调整。

新的币种折算率规则是逐步生效的，您可以通过查看账户配置的返回参数discountType ，判断当前账户所处的币种折算率规则：
- 当discountType 为 0 时，说明当前账户在原先的币种折算率规则下，对应获取免息额度和币种折算率等级接口接口的 discountInf 数组，
- 当discountType 为 1 时，说明当前账户在新的币种折算率规则下，对应获取免息额度和币种折算率等级接口接口的 details 数组
查看账户配置接口新增返回参数 discountType，用来确认当前账户所在的币种折扣率类型。当新的币种折算率规则全面生效后，接口将不再返回该字段，建议提前做好兼容。

参数名	类型	描述
discountType	String	当前账户所在的币种折扣率类型 `0`: 原先的币种折算率规则，默认值 `1`: 新的币种折算率规则

获取免息额度和币种折算率等级接口参数调整如下
- 除了返回原先的币种折算率详情（discountInf 数组），还会返回新的币种折算率详情（details 数组）；
- discountLv 将被废弃，建议您停止使用；
- 当新的币种折算率规则全面生效后，接口将不再返回原先的币种折算率详情（discountInf 数组），建议提前做好兼容。

调整前

请求参数名	类型	是否必须	描述
discountLv	String	否	折算率等级

返回参数名	类型	描述
discountLv	String	折算率等级
discountInfo	Array	币种折算率详情
> discountRate	String	折算率
> maxAmt	String	梯度区间上限（美元），“” 表示正无穷
> minAmt	String	梯度区间下限（美元），最小值是0

调整后

请求参数名	类型	是否必须	描述
discountLv	String	否	折算率等级（已废弃）

返回参数名	类型	描述
discountLv	String	~~折算率等级~~（已废弃）~~~~
discountInfo	Array	原先的币种折算率详情，该组参数在新的币种折扣规则完全生效后，不再返回
> discountRate	String	折算率
> maxAmt	String	梯度区间上限（美元），“” 表示正无穷
> minAmt	String	梯度区间下限（美元），最小值是0
minDiscountRate	String	最小折算率，针对数量超过最后一档的最大值时
details	Array	新的币种折算率详情
> discountRate	String	折算率
> maxAmt	String	梯度区间上限，单位为币种，如 BTC，"" 表示正无穷
> minAmt	String	梯度区间下限，单位为币种，如 BTC，最小值是0
> tier	String	档位
> liqPenaltyRate	String	强平罚金费率

新增接口

以下账单流水（自 2021 年）接口已上线模拟盘，已上线实盘
- 申请账单流水（自 2021 年）
- 获取账单流水（自 2021 年）

新增请求参数

修改策略委托订单

参数名	类型	是否必须	描述
newTriggerPx	String	是	修改后的触发价格
newOrdPx	String	是	修改后的委托价格委托价格为`-1`时，执行市价委托
newTriggerPxType	String	否	修改后的计划委托触发价格类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
attachAlgoOrds	Array of object	否	修改附带止盈止损信息适用于`现货和合约模式/跨币种保证金模式/组合保证金模式`
> newTpTriggerPx	String	否	止盈触发价，如果填写此参数，必须填写`止盈委托价`
> newTpTriggerPxType	String	否	修改后的止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
> newTpOrdPx	String	否	止盈委托价，如果填写此参数，必须填写`止盈触发价` 委托价格为`-1`时，执行市价止盈
> newSlTriggerPx	String	否	止损触发价，如果填写此参数，必须填写`止损委托价`
> newSlTriggerPxType	String	否	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
> newSlOrdPx	String	否	止损委托价，如果填写此参数，必须填写`止损触发价` 委托价格为`-1`时，执行市价止损

2024-08-08

巴哈马主体用户提币API调整

由于合规要求，巴哈马主体用户在做 API 链上提币/闪电网络提币时需要传入字段 rcvrInfo
（用户主体信息参考：https://www.okx.com/zh-hans/help/terms-of-service）

参数名	类型	是否必须	描述
rcvrInfo	Object	可选	接收方信息特定国家/地区认证用户做`链上提币`/`闪电网络提币` 需要提供此信息
> walletType	String	是	钱包类型 `exchange`：提币到交易所钱包 `private`：提币到私人钱包如果提币到交易所钱包，必须提供接收方相关信息。对于交易所钱包接收方为公司的，`rcvrFirstName`可以填公司名称，`rcvrLastName`可以填"N/A"，地址信息可以填写公司注册地址。提币到私人钱包，则不需要提供接收方信息
> exchId	String	可选	交易所 ID 可以通过获取交易所列表（公共）接口查询支持的交易所如果交易所不在支持的交易所列表中，该字段填`0`
> rcvrFirstName	String	可选	接收方名字，如 `Bruce`
> rcvrLastName	String	可选	接收方姓氏，如 `Wayne`
> rcvrCountry	String	可选	接收方所在国家，如 `United States`
> rcvrCountrySubDivision	String	可选	接收方所在州/省，如 `California`
> rcvrTownName	String	可选	接收方所在城镇，如 `San Jose`
> rcvrStreetName	String	可选	接收方所在街道地址，如 `Clementi Avenue 1`

用户提币到交易所钱包

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

巴哈马主体用户需要传入接受方如下字段信息（rcvrFirstName,rcvrLastName,rcvrCountry,rcvrCountrySubDivision,rcvrTownName,rcvrStreetName）。对于交易所钱包接收方为公司的，rcvrFirstName可以填公司名称，rcvrLastName可以填"N/A"，地址信息可以填写公司注册地址。示例如下：

用户提币到私人钱包

如果用户提币到私人钱包，不需要提供接收方信息。示例如下：

新增错误码

当巴哈马主体用户没有传入新参数rcvrInfo，会做如下报错

错误码	错误信息	示例
58237	根据当地法律法规，请提供准确的接收方信息 (rcvrInfo)。对于交易所地址，请一并提供交易所信息和接收人的身份信息({recipientParameters})。	根据当地法律法规，请提供准确的接收方信息 (rcvrInfo)。对于交易所地址，请一并提供交易所信息和接收人的身份信息(rcvrFirstName,rcvrLastName,rcvrCountry,rcvrCountrySubDivision,rcvrTownName,rcvrStreetName)。

2024-08-01

历史持仓接口新增 posSide 返回参数，表明持仓模式方向。该字段只支持在功能上线后开平仓的仓位，对于先前的仓位将返回"posSide": ""。
- 查看历史持仓信息

参数名	类型	描述
posSide	String	持仓模式方向 `long`：开平仓模式开多 `short`：开平仓模式开空 `net`：买卖模式

新增接口
- POST / 订单预检查

2024-07-23

产品相关接口新增 ruleType 返回参数，表明交易规则类型

参数名	类型	描述
ruleType	String	交易规则类型 `normal`：普通交易 `pre_market`：盘前交易

新增错误码

错误码	HTTP 状态码	错误提示
54005	200	盘前交割合约请使用逐仓进行交易
54006	200	盘前交易合约用户持仓上限为{posLimit}张
54007	200	不支持该产品 {instId}

2024-07-17

新增深度频道订阅限制。调整后，在相同连接下，用户将无法为相同交易产品同时订阅 books-l2-tbt 以及 books50-l2-tbt/books频道。
- WS / 深度频道

若用户已在一个连接下为某个特定交易产品订阅books-l2-tbt深度频道，并决定新订阅books50-l2-tbt或books频道，由于books-l2-tbt频道提供更完善的深度信息并在推送顺序中靠前，我们将保留用户当前的books-l2-tbt订阅，并针对新订阅返回错误码64004。示例如下。

请求	响应
{ "op": "subscribe", "args": [ { "channel": "books", "instId": "BTC-USDT" } ] }	{ "event":"subscribe", "arg":{ "channel":"books", "instId":"BTC-USDT" }, "connId":"a4d3ae55" } { "event":"error", "code":"64004", "msg":"Subscribe to both books and books-l2-tbt for BTC-USDT is not allowed. Unsubscribe books-l2-tbt first.", "connId":"a4d3ae55" }

若用户已在一个连接下为某个特定交易产品订阅books50-l2-tbt/books深度频道，并决定新订阅books-l2-tbt频道。由于books-l2-tbt频道提供更完善的深度信息并在推送顺序中靠前，我们将先为用户订阅books-l2-tbt频道，再取消用户的现有订阅books50-l2-tbt/books。

假设用户在一个连接下为BTC-USDT同时订阅了books50-l2-tbt以及books深度频道，并决定新订阅books-l2-tbt，示例如下。取消订阅可能会有秒级延迟，意味着用户在成功订阅新频道后可能会持续收到旧频道消息数秒。

请求	响应
{ "op": "subscribe", "args": [ { "channel": "books-l2-tbt", "instId": "BTC-USDT" } ] }	{ "event":"subscribe", "arg":{ "channel":"books-l2-tbt", "instId":"BTC-USDT" }, "connId":"a4d3ae55" } { "event":"unsubscribe", "arg":{ "channel":"books50-l2-tbt", "instId":"BTC-USDT" }, "connId":"a4d3ae55" } { "event":"unsubscribe", "arg":{ "channel":"books", "instId":"BTC-USDT" }, "connId":"a4d3ae55" }

新增错误码

错误码	错误消息
64004	不允许为 {instId} 同时订阅 {channelName} 以及 books-l2-tbt。请先取消订阅 books-l2-tbt。

账单接口新增 instId 请求参数
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	是否必须	描述
instId	String	否	产品ID

新增错误码，对于组合保证金模式下的批量下单和批量改单，如果某个订单的失败是由其他的订单失败引起的，则该订单会收到 54004 报错

错误码	错误消息
54004	下单或改单失败，因为批量订单中的一个订单失败了

新增请求参数
- 网格策略委托下单

参数名	类型	是否必须	描述
profitSharingRatio	String	否	带单员分润比例，仅支持固定比例分润 `0`,`0.1`,`0.2`,`0.3`

2024-07-04

2024-07-03

新增参数枚举值

参数名	类型	描述
state	String	订单状态 `pause`: 已暂停

币币和杠杆支持止盈止损改单

2024-06-26

新增接口
新增返回参数
- 获取借币信息（公共）

参数名	类型	描述
lendQuota	String	出借限额

2024-06-25

新增价差交易倒计时全部撤单接口
- 倒计时全部撤单

2024-06-20

新增返回参数acct，表明资金所在账户
- GET / 获取一键兑换主流币历史记录

参数名	类型	描述
acct	String	`6`：资金账户 `18`：交易账户

2024-06-19

新增tag请求、返回参数，支持订单标签（tag）维度CAA。
- POST / 倒计时全部撤单

参数名	类型	是否必须	描述
tag	String	No	CAA订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间

新增错误码51071

错误码	HTTP 状态码	错误提示
51071	200	当前维护的标签维度倒计时全部撤单达到数量上限

固定单个连接、交易产品维度不同深度频道的数据推送顺序。调整后，单个连接、交易产品维度，深度频道的推送顺序将被固定为：bbo-tbt -> books-l2-tbt -> books50-l2-tbt -> books -> books5。
- WS / 深度频道

仅支持白名单用户使用跟单功能，带单功能不受影响。
Open API 以下接口的数据返回会延迟 5 分钟
Open API 以下接口的敏感信息在带单员开启带单保护时会为空 ""
- 获取交易员当前带单（私有）
- 获取交易员当前带单

涉及到的字段有：

参数名	类型	描述
instId	String	产品ID
openAvgPx	String	开仓均价
openTime	String	开仓时间
subPos	String	持仓张数
markPx	String	最新标记价格，仅适用于合约

2024-06-13

新增接口

2024-06-05

OKX将支持用户自定义现货对冲数量，仅适用于组合保证金模式。新功能与改动点如下。

新增接口设置现货对冲占用
新增返回参数clSpotInUseAmt、maxSpotInUseAmt，分别代表用户自定义现货占用数量以及系统计算得到的最大可能现货占用数量。原spotInUseAmt代表当前实际的现货占用数量。

参数名	类型	描述
> spotInUseAmt	String	实际现货占用数量当用户未自定义现货占用数量时，该字段值等于maxSpotInUseAmt
> clSpotInUseAmt	String	用户自定义现货占用数量
> maxSpotInUseAmt	String	系统计算得到的最大可能现货占用数量

请求、返回参数新增枚举值
- 设置组合保证金账户风险对冲模式

参数名	类型	是否必须	描述
type	String	是	风险对冲模式 `4`：现货对冲(USDC)

新增错误码

错误码	HTTP 状态码	错误提示
59648	200	调整后实际现货对冲占用数量不足，有潜在爆仓风险，请调整现货对冲占用数量
59649	200	关闭现货对冲占用模式可能会增加强制平仓的风险。请调整仓位，使保证金率处于安全状态。
59650	200	切换对冲单位可能会增加强制平仓的风险。请调整仓位，使保证金率处于安全状态。
59651	200	未开启现货对冲占用，无法设置现货对冲数量
59652	200	不支持为非杠杆币种设置现货对冲占用数量

2024-06-03

新增接口
新增枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
subType	String	`293`：固定借币扣息 `294`：固定借币利息退款 `295`：固定借币逾期利息

2024-05-30

新增功能模块简单赚币定期
新增枚举值
- 获取资金流水

参数名	类型	描述
type	String	`304`：定期简单赚币订单提交 `305`：定期简单赚币订单赎回 `306`：定期简单赚币本金发放 `307`：定期简单赚币收益发放 (提前终止订单补偿) `308`：定期简单赚币收益发放 `309`：定期简单赚币补偿收益发放 (订单延期补偿)

2024-05-15

新增返回参数
- 查看账户配置信息

参数名	类型	描述
maxCopyTraderNum	String	最大跟单人数，仅适用于带单员
copyTraderNum	String	当前跟单人数，仅适用于带单员

2024-05-10

新增价差交易行情数据接口

2024-05-09

价差交易行情频道新增推送数据参数
- 行情频道

推送数据参数

参数名	类型	描述
data	Array	订阅的数据
> open24h	String	24小时开盘价
> high24h	String	24小时最高价
> low24h	String	24小时最低价
> vol24h	String	24小时交易量，单元为交易货币或美元

2024-05-08

新增接口
- 加仓
sprdType字段新增枚举值
- 获取Spreads（公共）

参数名	类型	描述
> sprdType	String	Spread类型：`hybrid`

新增接口
- 获取交易产品基础信息

2024-05-06

新增返回参数
- 获取被邀请人返佣信息

参数名	类型	描述
firstTradeTime	String	首次交易时间（在最近的返佣关系建立之后） Unix时间戳的毫秒数格式，如 1597026383085 如果用户没有交易, 返回 ""
level	String	当前在平台上真实交易量的用户等级，例如 Lv1
depAmt	String	累计充值金额，单位为 USDT 如果没有充值, 返回 0
volMonth	String	当月累计交易量，单位为 USDT 如果没有交易, 返回 0
accFee	String	累计交易手续费，单位为 USDT 如果没有交易手续费，返回 0
kycTime	String	KYC2 认证时间. Unix时间戳的毫秒数格式，且精确到天如果没有通过 KYC2, 返回 ""
region	String	国家或地区，如"英国"
affiliateCode	String	节点邀请码

2024-04-25

返佣明细下载优化
- 获取返佣明细下载链接(ND)

新增解压后文件参数，返回数据由订单维度，改为了成交明细的维度。

参数名	描述
tradeId	最新成交 ID
amt	成交金额，单位为`USDT`
fee	手续费，单位为USDT
execType	流动性方向 `T`：taker `M`：maker

2024-04-24

参数名	类型	描述
attachAlgoOrds	Array of object	下单附带止盈止损信息
> failCode	String	委托失败的错误码，默认为"", 委托失败时有值，如 51020
> failReason	String	委托失败的原因，默认为"" 委托失败时有值

新增返回参数ts

返回参数

参数	类型	描述
ts	String	系统完成订单请求处理的时间戳，Unix时间戳的毫秒数格式，如 `1597026383085`

2024-04-18

新增返回参数
- GET / 查看项目

参数名	类型	描述
redeemPeriod	Array of string	赎回期，形式为 [最小赎回时间,最大赎回时间] `H`：小时，`D`：天例 ["1H","24H"] 表示赎回期时1小时到24小时。 ["14D","14D"] 表示赎回期为14天。

已下线天地网格

2024-04-11

为提升系统性能，优化用户体验，OKX决定精简爆仓风险预警频道部分字段。改动后对应字段将返回空字符串""或空数组[]，一段时间后，将彻底下线。用户可使用持仓频道获取相同字段。
爆仓风险预警推送频道

将被删减的字段罗列如下：

参数名	类型	描述
data	Array	订阅的数据
> availPos	String	可平仓数量，适用于 `币币杠杆`,`交割/永续`（开平仓模式），`期权`
> avgPx	String	开仓平均价
> upl	String	未实现收益
> uplRatio	String	未实现收益率
> liqPx	String	预估强平价不适用于`期权`
> imr	String	初始保证金，仅适用于`全仓`
> margin	String	保证金余额，仅适用于`逐仓`，可增减
> mmr	String	维持保证金
> liab	String	负债额，仅适用于`币币杠杆`
> liabCcy	String	负债币种，仅适用于`币币杠杆`
> interest	String	利息，已经生成未扣利息
> tradeId	String	最新成交ID
> notionalUsd	String	以美金价值为单位的持仓数量
> optVal	String	期权价值，仅适用于`期权`
> adl	String	信号区，分为5档，从1到5，数字越小代表adl强度越弱
> last	String	最新成交价
> deltaBS	String	美金本位持仓仓位delta，仅适用于`期权`
> deltaPA	String	币本位持仓仓位delta，仅适用于`期权`
> gammaBS	String	美金本位持仓仓位gamma，仅适用于`期权`
> gammaPA	String	币本位持仓仓位gamma，仅适用于`期权`
> thetaBS	String	美金本位持仓仓位theta，仅适用于`期权`
> thetaPA	String	币本位持仓仓位theta，仅适用于`期权`
> vegaBS	String	美金本位持仓仓位vega，仅适用于`期权`
> vegaPA	String	币本位持仓仓位vega，仅适用于`期权`

新增返回参数acctStpMode
- 查看账户配置

参数名	类型	描述
acctStpMode	String	账户自成交保护模式 `cancel_maker`：撤销挂单 `cancel_taker`：撤销吃单 `cancel_both`：撤销挂单和吃单用户可通过母账户登录网页修改该配置

2024-04-10

为了更好的交易体验，交易所在计算成交比率时，除去法币交易产品的新增和修改请求数，但仍保留交易量。
成交明细接口新增请求、返回参数 subType。
- GET / 获取成交明细（近三天）
- GET / 获取成交明细（近三个月）

请求参数

参数名	类型	是否必须	描述
subType	String	否	成交类型 `1`：买入 `2`：卖出 `3`：开多 `4`：开空 `5`：平多 `6`：平空 `100`：强减平多 `101`：强减平空 `102`：强减买入 `103`：强减卖出 `104`：强平平多 `105`：强平平空 `106`：强平买入 `107`：强平卖出 `110`：强平换币转入 `111`：强平换币转出 `118`：系统换币转入 `119`：系统换币转出 `125`：自动减仓平多 `126`：自动减仓平空 `127`：自动减仓买入 `128`：自动减仓卖出 `212`：一键借币的自动借币 `213`：一键借币的自动还币 `204`：大宗交易买 `205`：大宗交易卖 `206`：大宗交易开多 `207`：大宗交易开空 `208`：大宗交易平多 `209`：大宗交易平空 `270`：价差交易买 `271`：价差交易卖 `272`：价差交易开多 `273`：价差交易开空 `274`：价差交易平多 `275`：价差交易平空

返回参数

参数名	类型	描述
subType	String	成交类型

2024-04-02

新增接口，大宗交易报价单倒计时全部撤单
- 倒计时全部撤单

2024-03-27

下线轻量深度接口，GET /api/v5/market/books-lite。
免除币币、币币杠杆相关订单的子账户限速。

2024-03-19

“限制 WebSocket 私有频道对应连接数量”新功能上线

为了提升交易系统的稳定性以及对用户的公平性，欧易开始限制订阅以下 WebSocket 频道的最大并发连接数。子账户维度，订阅每个 WebSocket 频道的最大连接数为 20 个。每个 WebSocket 连接都由唯一的 connId 标识。

受此限制的 WebSocket 频道如下：

若用户通过不同的请求参数在同一个 WebSocket 连接下订阅同一个频道，例如使用 {"channel": "orders", "instType": "ANY"} 和 {"channel": "orders", "instType": "SWAP"}，只算为一次连接。若用户使用相同或不同的 WebSocket 连接订阅上述频道，例如订单频道和账户频道。在该两个频道之间，计数不会累计，因为它们被视作不同的频道。简言之，系统计算每个频道对应的 WebSocket 连接数量。

新链接订阅频道时，平台将对该订阅返回channel-conn-count的消息同步链接数量。

链接数量更新

{
    "event":"channel-conn-count",
    "channel":"orders",
    "connCount": "2",
    "connId":"abcd1234"
}

当超出限制时，一般最新订阅的链接会收到拒绝。用户会先收到平时的订阅成功信息然后收到channel-conn-count-error消息，代表平台终止了这个链接的订阅。在异常场景下平台会终止已订阅的现有链接。

链接数量限制报错

{
    "event": "channel-conn-count-error",
    "channel": "orders",
    "connCount": "20",
    "connId":"a4d3ae55"
}

通过 WebSocket 进行的订单操作，例如下单、修改和取消订单，不会受到此改动影响。

2024-03-14

强制自成交保护新功能于3月14日18:00（UTC+8）上线
- 弃用下单/批量下单接口及频道中的stpId字段
- 对于撮合交易，默认的自成交保护模式为Cancel Maker；通过下单/批量下单接口及频道进行下单时，用户可以利用stpMode参数为新订单指定部分订单类型的自成交保护模式
- 对于价差交易，默认且仅支持Cancel Maker作为自成交保护模式
- 若订单由于自成交保护被撤销，用户可在历史订单接口中查询到cancelSource = 32的记录；订单频道亦会推送相关信息
- 对于大宗交易，若询价单中的所有报价方都与询价方属于一个母账户，询价单将面临创建失败，用户会收到错误码“56004”；其他情况，询价单将被成功创建，但同属于一个母账户的报价方无法收到询价单。
cancelSource字段新增枚举值
- WS / 订单频道

参数	类型	描述
> cancelSource	String	`38`: 您已撤销做市商保护 (MMP) 类型订单 `39`: 因做市商保护 (MMP) 被触发，该类型订单已被撤销

提币状态state新增枚举值

参数	类型	描述
state	String	`15`：交易待确认 `16`：根据当地法律法规，您的提币最多可能需要 24 小时才能到账

新增返回参数

参数名	类型	描述
fee	String	累计手续费金额，仅适用于合约网格，其他网格策略为""
fundingFee	String	累计资金费用，仅适用于合约网格，其他网格策略为""

已经限制跟单消息通知频道的使用，仅白名单用户会有数据推送。
- 跟单消息通知频道

2024-03-12

新功能上线
- 子账户限速
- 基于成交比率的子账户限速
新增错误码

错误码	HTTP 状态码	错误提示
50061	200	订单请求频率过快，超过账户允许的最高限额

2024-03-06

新增请求参数
- 网格策略委托下单
- 修改网格策略订单

参数名	类型	是否必须	描述
tpRatio	String	否	止盈比率，0.1 代表 10%
slRatio	String	否	止损比率，0.1 代表 10%

新增返回参数

参数名	类型	描述
tpRatio	String	止盈比率，0.1 代表 10%
slRatio	String	止损比率，0.1 代表 10%

新增错误码

错误码	HTTP 状态码	错误提示
55100	200	止盈百分比应在 {parameter1} ~ {parameter2} 的范围内
55101	200	止损百分比应在 {parameter1} ~ {parameter2} 的范围内
55102	200	止盈百分比需大于当前策略收益率
55103	200	止损百分比需小于当前策略收益率
55104	200	仅合约网格支持按收益率百分比止盈止损

2024-02-28

限价止盈功能已上线实盘

新增请求参数

参数名	类型	是否必须	描述
> tpOrdKind	String	否	止盈订单类型 `condition`: 条件单 `limit`: 限价单默认为`condition`

新增请求参数
- 修改订单
- 批量修改订单

参数名	类型	是否必须	描述
> newTpOrdKind	String	否	止盈订单类型 `condition`: 条件单 `limit`: 限价单

新增返回参数以及枚举值

参数名	类型	描述
isTpLimit	String	是否为限价止盈，true 或 false.
cancelSource	String	`36`: 关联止损被触发，撤销限价止盈 `37`: 关联止损被撤销，撤销限价止盈
attachAlgoOrds	Array of object	下单附带止盈止损信息
> tpOrdKind	String	止盈订单类型 `condition`: 条件单 `limit`: 限价单
> linkedAlgoOrd	Object	止损订单信息，仅适用于双向止盈止损的限价止盈单
>> algoId	Object	策略订单唯一标识

新增返回参数

参数名	类型	描述
linkedOrd	Object	止盈订单信息，仅适用于止损单，且该止损订单来自包含限价止盈单的双向止盈止损订单
> ordId	String	订单 ID
uTime	String	订单更新时间，Unix时间戳的毫秒数格式，如 1597026383085

新增错误码

错误码	HTTP 状态码	错误提示
51090	200	对于绑定了限价止盈的止损订单，不允许修改其委托数量
51091	200	同一笔订单上附带分批止盈的止盈类型必须保持一致
51092	200	同一笔订单上附带分批止盈的止盈委托价不能相等
51093	200	同一笔订单上附带分批止盈，其中限价止盈的止盈委托价 (tpOrdPx) 不能为 –1 (市价)
51094	200	币币、杠杆和期权交易不支持限价止盈
51095	200	该接口下限价止盈订单时，也需要同时下一笔止损订单
51096	200	限价止盈时 cxlOnClosePos 需要为 true
51098	200	对于绑定了限价止盈的止损订单，不能添加新的止盈
51099	200	您当前身份为带单交易员，不支持下单限价止盈
50062	200	该功能暂不可用

新增接口
- 仓位创建器
新增接口
- 获取用户的 Broker 返佣信息
新增接口获取产品完整深度
- GET / 获取产品完整深度
新增体验金余额返回参数
- 查看账户余额
- 账户频道

参数名	类型	描述
> details	Array	各币种资产详细信息
rewardBal	String	体验金余额

新增溢价返回参数
- 获取永续合约当前资金费率
- 资金费率频道

参数名	类型	描述
premium	String	溢价，为合约的中间价和指数价格的差异

新增结构化产品账单类型枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
type	String	账单类型 `26`：结构化产品
subType	String	账单子类型 `296`：结构化下单转出 `297`：结构化下单转入 `298`：结构化结算转出 `299`：结构化结算转入

逐仓交易设置参数isoMode不再支持quick_margin（一键借币）

2024-02-07

新增接口。该接口返回账户限速及成交比率相关数据，详见：基于成交比率的子账户限速。
- GET / 获取账户限速

2024-02-06

新增接口
- 仓位创建器

2024-02-01

新增返回参数
- 获取充值地址信息
- 闪电网络充币

参数名	类型	描述
verifiedName	String	(接受方)已验证姓名

2024-01-31

为信号策略交易模块新增多个接口
优化updateInterval请求参数
- 持仓频道

调整前：

参数	类型	是否必须	描述
updateInterval	int	否	`0`: 仅根据持仓事件推送数据若不添加该字段或将其设置为除0外的其他值，数据将根据事件推送并定时推送。使用该字段需严格遵守以下格式。 "extraParams": " { \"updateInterval\": \"0\" } "

调整后：

参数	类型	是否必须	描述
updateInterval	int	否	`0`: 仅根据持仓事件推送数据 `2000, 3000, 4000`: 根据持仓事件推送，且根据设置的时间间隔定时推送（ms）若不添加该字段或将其设置为上述合法值以外的其他值，数据将根据事件推送并大约每 5 秒定期推送一次。使用该字段需严格遵守以下格式。 "extraParams": " { \"updateInterval\": \"0\" } "

逐仓交易设置参数isoMode不再支持autonomy(自主划转)

2024-01-22

余币宝接口迁移，新接口实盘已于2023/03/15上线，旧接口已于2024/01/22下线。

新增余币宝功能模块，原余币宝相关接口做如下调整
- 获取余币宝余额接口路径 /api/v5/asset/saving-balance 调整为 /api/v5/finance/savings/balance
- 余币宝申购/赎回接口路径 /api/v5/asset/purchase_redempt 调整为 /api/v5/finance/savings/purchase-redempt
- 设置余币宝借贷利率接口路径 /api/v5/asset/set-lending-rate 调整为 /api/v5/finance/savings/set-lending-rate
- 获取余币宝出借明细接口路径 /api/v5/asset/lending-history 调整为 /api/v5/finance/savings/lending-history
- 获取市场借贷信息（公共）接口路径 /api/v5/asset/lending-rate-summary 调整为 /api/v5/finance/savings/lending-rate-summary
- 获取市场借贷历史（公共）接口路径 /api/v5/asset/lending-rate-history 调整为 /api/v5/finance/savings/lending-rate-history

2024-01-18

新增返回参数

参数名	类型	描述
upl	String	账户层面全仓未实现盈亏（美元单位）适用于`跨币种保证金模式`/`组合保证金模式`
> (details) imr	String	币种维度占用保证金适用于`现货和合约模式`
> (details) mmr	String	币种维度维持保证金适用于`现货和合约模式`

2024-01-17

参数名	类型	描述
portLink	String	跟单员头像的链接地址

新增错误码

错误码	HTTP 状态码	错误提示
59282	200	仅主账号在白名单中的独立经纪商 ND 子账户支持使用该接口，请联系 BD 进行处理
59284	200	超过本月 {param0} 次调整上限
59286	200	当前账户模式为现货模式，无法成为合约带单人
59287	200	请使用 {param0}-{param1} 范围内的分润比例
59288	200	您当前身份为带单交易员。您的账户正处于组合保证金模式，请切换至现货和合约模式或跨币种模式后重试

爆仓、自动减仓接口及推送数据优化

合约全仓爆仓

WS / 订单频道

参数	调整前	调整后
fillPx, fillSz, fillTime	"" 或 "0"	推送爆仓时对应的实际值
pnl	平仓收益	平仓收益 + 强平惩罚金
tradeId	最新成交ID	"0"
fillPnl	"0"	平仓收益

交易账单相关接口，账单流水查询（近七天），账单流水查询（近三月）

参数	调整前	调整后
ordId	""	爆仓时对应的实际值
tradeId	最新成交ID	"0"

账户余额和持仓频道，持仓频道

参数	调整前	调整后
tradeId	最新成交ID	"0"

合约逐仓爆仓

WS / 订单频道

参数	调整前	调整后
fillPx, fillSz, fillTime	"" 或 "0"	推送爆仓时对应的实际值
tradeId	最新成交ID	"0"
fillPnl	"0"	平仓收益

交易账单相关接口，账单流水查询（近七天），账单流水查询（近三月）

参数	调整前	调整后
ordId	""	爆仓时对应的实际值
tradeId	最新成交ID	"0"

账户余额和持仓频道，持仓频道

参数	调整前	调整后
tradeId	最新成交ID	"0"

自动减仓

WS / 订单频道

参数	调整前	调整后
fillPx, fillSz, fillTime	"" 或 "0"	推送爆仓时对应的实际值
tradeId	最新成交ID	"0"
fillPnl	"0"	平仓收益

交易账单相关接口，账单流水查询（近七天），账单流水查询（近三月）

参数	调整前	调整后
ordId	""	爆仓时对应的实际值
tradeId	最新成交ID	"0"

请注意：爆仓或自动减仓后，仓位对应的tradeId将被设置为"0"。通过查询或推送，用户将收到"tradeId": "0"，直至该仓位有新的成交。

2024-01-15

新增返回参数

参数名	类型	描述
upl	String	账户层面全仓未实现盈亏（美元单位）适用于`跨币种保证金模式`/`组合保证金模式`
> (details) imr	String	币种维度占用保证金适用于`现货和合约模式`
> (details) mmr	String	币种维度维持保证金适用于`现货和合约模式`

2024-01-10

更新了以下的错误提示

错误码	HTTP 状态码	错误提示
51137	200	买单最高价为 {param0}，请调低价格
51138	200	卖单最低价为 {param0}，请调高价格

cancelSource字段新增枚举值
- WS / Order channel

参数	类型	描述
> cancelSource	String	`15`: 已撤单：该订单委托价不在限价范围内

获取风险准备金余额接口新增自动减仓（ADL）历史记录；请求参数type新增枚举值adl；新增返回参数instType，maxBal，maxBalTs，decRate，adlType。
- 获取风险准备金余额

请求参数

参数名	类型	是否必须	描述
type	String	否	风险准备金类型 `adl`：自动减仓历史数据

返回参数

参数名	类型	描述
instType	String	产品类型
details	Array of objects	风险准备金详情
> maxBal	String	过去八小时内的风险准备金余额最大值仅在type为`adl`时适用
> maxBalTs	String	过去八小时内风险准备金余额最大值对应的时间戳，Unix时间戳的毫秒数格式，如 `1597026383085` 仅在type为`adl`时适用
> decRate	String	风险准备金实时下降率（balance与maxBal相比较）仅在type为`adl`时适用
> adlType	String	关于自动减仓的事件 `rate_adl_start`：由于风险准备金下降率过高造成的自动减仓开始 `bal_adl_start`：由于风险准备金余额下降过高造成的自动减仓开始 `adl_end`：自动减仓结束两个开启条件同时触发时，仅返回`bal_adl_start` 仅在type为`adl`时适用

2024-01-09

新增接口，价差交易支持查询近三月的历史订单
- 获取历史订单记录（近三月)

2024-01-04

新增请求参数：
- 创建子账户(ND)

参数名	类型	是否必须	描述
mainAcct	String	可选	二级子账户的母账户名称创建二级子账户时必填，且需要填写一级子账户名称创建一级子账户时，值为空""

新增返回参数
- 获取子账户列表

参数名	类型	描述
> mainAcct	String	二级子账户的母账户名称为""时，代表返回的是一级子账户，有值时为二级子账户

新增错误码

错误码	HTTP 状态码	错误提示
59622	200	您正在创建独立经纪商 2 级子账号。该 1 级子账号不存在或有误，请先创建 1 级子账号或使用正确的 1 级子账号。
59623	200	独立经纪商 1 级子账号下存在 2 级子账号，请删除 2 级子账号后重试。

2023-12-28

余币宝接口迁移，新接口实盘已于2023/03/15上线，旧接口将于2024/01/22下线，请尽快实现迁移。

新增余币宝功能模块，原余币宝相关接口做如下调整
- 获取余币宝余额接口路径 /api/v5/asset/saving-balance 调整为 /api/v5/finance/savings/balance
- 余币宝申购/赎回接口路径 /api/v5/asset/purchase_redempt 调整为 /api/v5/finance/savings/purchase-redempt
- 设置余币宝借贷利率接口路径 /api/v5/asset/set-lending-rate 调整为 /api/v5/finance/savings/set-lending-rate
- 获取余币宝出借明细接口路径 /api/v5/asset/lending-history 调整为 /api/v5/finance/savings/lending-history
- 获取市场借贷信息（公共）接口路径 /api/v5/asset/lending-rate-summary 调整为 /api/v5/finance/savings/lending-rate-summary
- 获取市场借贷历史（公共）接口路径 /api/v5/asset/lending-rate-history 调整为 /api/v5/finance/savings/lending-rate-history

2023-12-20

为返回结果设置一年时间范围限制
- 获取计息记录
新增返回参数，推送数据参数 enabled 以表明限价是否生效
- 获取限价
- 限价频道

返回参数

参数名	类型	描述
enabled	Boolean	限价是否生效 `true`：限价生效 `false`：限价不生效

新增 method 返回参数以确定合约的资金费收取逻辑

返回参数

参数名	类型	描述
method	String	资金费收取逻辑 `current_period`：当期收 `next_period`：跨期收

针对一些资金费率波动较大的小币种，OKX也将实时关注行情变化，在必要时候，将资金费率收取频率从8小时收付，改成频率较高的6小时/4小时/2小时/1小时收付。因此，用户应关注fundingTime及nextFundingTime参数以确定合约的资金费收取频率。

2023-12-12

大宗交易新增设置、查看 MMP 配置的接口
- 设置 MMP
- 查看 MMP 配置

2023-12-11

倒计时全部撤单接口现已适用于所有用户和全部撮合交易产品（不包括价差交易）
- POST / 倒计时全部撤单

2023-12-07

新增返回参数
- 获取用户的 Broker 返佣信息

参数名	类型	描述
lastRebate	String	账号月返佣金额，仅适用于 VIP4 和 VIP5 的用户

2023-12-06

大宗交易和价差交易的相关信息在以下接口的tag参数会返回下单时tag的值。返回""如果为空。
新增请求参数
- 平仓带单或跟单

参数名	类型	是否必须	描述
ordType	String	否	订单类型 `market`：市价单 `limit`：限价单默认为市价单
px	String	否	委托价格，仅适用于`limit`类型的订单，且仅适用于现货交易员委托价格为 0 代表撤销挂单已经设置了限价单，仍为该条目设置价格时，视为改单。

新增请求参数
- 带单或跟单仓位止盈止损

参数名	类型	是否必须	描述
tpOrdPx	String	否	止盈委托价委托价格为-1时，执行市价止盈，默认为市价止盈仅适用于现货交易员
slOrdPx	String	否	止损委托价委托价格为-1时，执行市价止损，默认为市价止损仅适用于现货交易员

新增返回参数
- 获取当前带单或跟单

参数名	类型	描述
availSubPos	String	可平张数/币数

新增返回参数
- 获取历史带单或跟单

参数名	类型	描述
closeSubPos	String	已平仓量
type	String	平仓类型 `1`：部分平仓; `2`：完全平仓;

2023-12-05

新增接口
- 申请月结单
- 获取月结单

2023-12-04

调整 Status 接口和 Status 频道的返回参数：
serviceType 新增枚举值 10：价差交易；11：跟单交易

2023-11-30

新增接口和频道
新增请求参数和返回参数
- 交易员获取当前带单

请求参数

参数名	类型	是否必须	描述
uniqueCode	String	否	交易员唯一标识码，仅适用于跟单
subPosType	String	否	数据的类型 `lead`: 带单，默认值 `copy`: 跟单

返回参数

参数名	类型	描述
tpOrdPx	String	止盈委托价，市价时为-1
slOrdPx	String	止损委托价，市价时为-1
margin	String	保证金
upl	String	未实现收益
uplRatio	String	未实现收益率
markPx	String	最新标记价格，仅适用于合约
uniqueCode	String	交易员唯一标识代码
ccy	String	币种

新增请求参数和返回参数
- 交易员获取历史带单

请求参数

参数名	类型	是否必须	描述
subPosType	String	否	数据的类型 `lead`: 带单，默认值 `copy`: 跟单

返回参数

参数名	类型	描述
margin	String	保证金
ccy	String	币种
markPx	String	最新标记价格，仅适用于合约
uniqueCode	String	交易员唯一标识代码
profitSharingAmt	String	跟单分润额，仅适用于跟单

新增请求参数
- 交易员止盈止损
- 交易员平仓

参数名	类型	是否必须	描述
subPosType	String	否	数据的类型 `lead`: 带单，默认值 `copy`: 跟单

新增错误码

错误码	HTTP 状态码	错误提示
59263	200	独立经纪商需要添加白名单才能使用该功能，请联系 BD 进行处理
59264	200	不支持现货跟单
59267	200	取消失败，跟单关系不存在
59268	200	存在交易员未带单的产品
59269	200	该合约交易员不存在
59270	200	固定金额跟单时，最大跟单金额 (copyTotalAmt) 需要大于等于单笔跟单金额 (copyAmt)
59273	200	您还不是合约跟单用户，请先开始跟单
59275	200	操作失败，您正在申请成为交易员，无法跟单
59276	200	交易员正在退出，当前无法跟单
59277	200	到达跟单人数上限，不允许继续跟单
59278	200	正在处理您的停止跟单请求，请稍后再试
59279	200	您已设置跟单，请勿重复设置
59280	200	跟单关系不存在，请先进行首次设置
59283	200	当前账户不在现货和合约模式
59130	200	最高止盈比例为 {num}%，请重新输入
59259	200	请输入在有效范围内的跟单比例
59285	200	您尚未进行过带单或跟单操作

2023-11-22

新增频道
- ADL预警频道

type 参数新增枚举值
- 获取风险准备金余额

请求参数

参数名	类型	是否必须	描述
type	String	No	`regular_update`

返回参数

参数名	类型	描述
type	String	`regular_update`

regular_update 提供分钟级别的风险准备金余额更新。更新后，amt 参数用于展示 type 为 liquidation_balance_deposit，bankruptcy_loss 或 platform_revenue 时的风险准备金余额差值，数据一天产生一次，每天下午4点左右（UTC 8）更新。当 type 为 regular_update时，amt参数将返回""。

新增返回参数
- 获取永续合约当前资金费率
- 资金费率频道

参数	类型	描述
minFundingRate	String	下一期的预测资金费率下限
maxFundingRate	String	下一期的预测资金费率上限
settState	String	资金费率结算状态 `processing`：结算中 `settled`：已结算
settFundingRate	String	若 settState = `processing`，该参数代表用于本轮结算的资金费率；若 settState = `settled`，该参数代表用于上轮结算的资金费率
ts	String	数据更新时间，Unix时间戳的毫秒数格式，如 `1597026383085`

2023-11-18

alias参数新增枚举值
- 获取交易产品基础信息
- 产品频道

参数	类型	描述
alias	String	`this_month` `next_month` 不建议使用，用户应通过 expTime 参数获取合约的交割日期

关于新月度交割合约生成及alias参数变更通知

目前，BTC币种的 USDT 和 USD 保证金交割合约与其他币种保证金的交割合约数量不同，支持的到期日不同，合约轮转生成的规则亦有些许差异。正如之前的公告所述，欧易建议用户尽快通过产品接口及频道的expTime参数获取交割合约的交割日期，并停用alias参数。

欧易已于 2023 年 11 月 17 日下午 4:00 (UTC+8) 调整 BTC 币种的 USDT 和 USD 保证金交割合约 到期日规则，由当周、次周、当季、次季四个到期日，调整为当周、次周、当月、次月、当季、次季六个到期日。目前线上合约为：

当周（this_week）：到期日 2023 年 11 月 24 日的合约
次周（next_week）：到期日 2023 年 12 月 1 日的合约
当月（this_month）：到期日 2023 年 12 月 29 日的合约。调整前，为当季合约。若使用alias字段判断到期日，可能会误认为到期日为 2023 年 11 月 24 日。
次月（next_month）：到期日 2024 年 1 月 26 日的合约。新生成合约。
当季（quarter）：到期日 2024 年 3 月 29 日的合约。调整前，为次季合约。若使用alias字段判断到期日，可能会误认为到期日为 2023 年 12 月 29 日。
次季（next_quarter）：到期日 2024 年 6 月 28 日的合约。新生成合约。

调整后，产品接口及频道alias字段新增this_month，next_month枚举值。目前新枚举值仅适用于BTC 币种的 USDT 和 USD 保证金交割合约。将来，欧易可能会调整更多不同币种保证金交割合约到期日规则，请尽快通过产品接口及频道的expTime字段获取交割合约的交割日期，并停用alias字段。

更多详情请见公告

2023-11-16

OKX推出经济日历数据接口，为用户提供全面、最新的宏观经济数据。

该功能已上线实盘，且仅支持在实盘使用。

新增接口
- 获取经济日历数据
- 经济日历频道

2023-11-15

新增功能节点
新增参数枚举值

参数名	类型	描述
period	String	周期类型 `hourly`：小时

新增参数

参数名	类型	描述
recurringHour	String	小时级别定投的间隔 `1`/`4`/`8`/`12`
nextInvestTime	String	下一次定投发生的时间，Unix时间戳的毫秒数格式，如 1597026383085

2023-11-13

新增返回参数
- 获取交易产品基础信息

参数名	类型	描述
maxLmtAmt	String	限价单的单笔最大USD价值
maxMktAmt	String	市价单的单笔最大USD价值仅适用于`币币/币币杠杆`

新增错误码

错误码	HTTP 状态码	错误提示
51185	200	单笔订单价值不能超过 {maxOrderValue} USD

2023-11-10

当前仅白名单用户可使用，将于11月中旬开放该功能

新增请求参数枚举值：

参数名	类型	是否必须	描述
tdMode	String	否	交易模式 `spot_isolated`：现货逐仓(仅适用于现货带单)

新增返回参数
- 查看账户配置

参数名	类型	描述
spotRoleType	String	现货跟单角色。 `0`：普通用户；`1`：带单者；`2`：跟单者
spotTraderInsts	String	当前账号已经设置的带单币对，仅适用于带单者

新增返回参数

参数名	类型	描述
> spotIsoBal	String	现货逐仓余额，仅适用于现货带单/跟单

新增枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	是否必须	描述
subType	String	否	账单子类型 `280`: 现货分润支出; `281`: 现货分润退还

新增请求和返回参数

请求参数

参数名	类型	是否必须	描述
instType	String	否	产品类型 SPOT：币币 SWAP：永续合约

返回参数

参数名	类型	描述
instType	String	产品类型 SPOT：币币 SWAP：永续合约

新增错误码

错误码	HTTP 状态码	错误提示
51072	200	您当前身份为现货带单员，设置的带单币对买入时，tdMode 需要使用 spot_isolated
51073	200	您当前身份为现货带单员，卖出带单资产需要使用'/copytrading/close-subposition'接口
51074	200	仅现货带单员设置的带单币对支持使用 tdMode：spot_isolated
59260	200	您还不是现货带单交易员，请先在网页端/移动端完成申请
59262	200	您还不是合约带单交易员，请先在网页端/移动端完成申请
59642	200	现货模式下币币不支持只减仓功能
59643	200	当前存在现货跟单，暂不可切换

2023-11-08

新增功能 ETH质押
迁移大宗交易公共成交数据接口并新增返回参数。新接口的请求URL改为 ”GET /api/v5/public/block-trades“，旧接口将于十一月下旬下线。新接口中新增返回参数：
- 获取大宗交易公共成交数据

参数名	类型	描述
fillVol	String	成交时的隐含波动率仅适用于 `期权`
fwdPx	String	成交时的远期价格仅适用于 `期权`
idxPx	String	成交时的指数价格适用于 `交割`, `永续`, `期权`
markPx	String	成交时的标记价格适用于 `交割`, `永续`, `期权`

新增推送数据参数
- 公共大宗交易单腿交易频道

参数名	类型	描述
fillVol	String	成交时的隐含波动率仅适用于 `期权`
fwdPx	String	成交时的远期价格仅适用于 `期权`
idxPx	String	成交时的指数价格适用于 `交割`, `永续`, `期权`
markPx	String	成交时的标记价格适用于 `交割`, `永续`, `期权`

对于下单和改单，原有附带止盈止损的参数会从文档上隐藏，建议使用新的参数。

新增请求参数：
- 下单
- 批量下单

参数名	类型	是否必须	描述
attachAlgoOrds	Array of object	否	下单附带止盈止损信息
> attachAlgoClOrdId	String	否	下单附带止盈止损时，客户自定义的策略订单ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。订单完全成交，下止盈止损委托单时，该值会传给`algoClOrdId`
> tpTriggerPx	String	可选	止盈触发价，如果填写此参数，必须填写止盈委托价
> tpOrdPx	String	可选	止盈委托价，如果填写此参数，必须填写止盈触发价委托价格为-1时，执行市价止盈
> slTriggerPx	String	可选	止损触发价，如果填写此参数，必须填写止损委托价
> slOrdPx	String	可选	止损委托价，如果填写此参数，必须填写止损触发价委托价格为-1时，执行市价止损
> tpTriggerPxType	String	否	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
> slTriggerPxType	String	否	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
> sz	String	可选	数量。仅适用于“多笔止盈”的止盈订单，且对于“多笔止盈”的止盈订单必填
> amendPxOnTriggerType	String	否	是否启用开仓价止损，仅适用于分批止盈的止损订单，第一笔止盈触发时，止损触发价格是否移动到开仓均价止损 `0`：不开启，默认值 `1`：开启，且止损触发价不能为空

新增请求参数
- 修改订单
- 批量修改订单

参数名	类型	是否必须	描述
attachAlgoOrds	Array of object	否	下单附带止盈止损信息
> attachAlgoId	String	可选	附带止盈止损的订单ID，由系统生成，改单时，可用来标识该笔附带止盈止损订单
> attachAlgoClOrdId	String	可选	下单附带止盈止损时，客户自定义的策略订单ID
> newTpTriggerPx	String	可选	止盈触发价如果止盈触发价或者委托价为0，那代表删除止盈。只适用于交割和永续合约。
> newTpOrdPx	String	可选	止盈委托价委托价格为-1时，执行市价止盈。只适用于交割和永续合约。
> newSlTriggerPx	String	可选	止损触发价如果止损触发价或者委托价为0，那代表删除止损。只适用于交割和永续合约。
> newSlOrdPx	String	可选	止损委托价委托价格为-1时，执行市价止损。只适用于交割和永续合约。
> newTpTriggerPxType	String	可选	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格只适用于`交割`/`永续` 如果要新增止盈，该参数必填
> newSlTriggerPxType	String	可选	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格只适用于`交割`/`永续` 如果要新增止损，该参数必填
> sz	String	可选	新的张数。仅适用于“多笔止盈”的止盈订单且必填
> amendPxOnTriggerType	String	否	是否启用开仓价止损，仅适用于分批止盈的止损订单 `0`：不开启，默认值 `1`：开启

新增返回参数

参数名	类型	描述
attachAlgoOrds	Array of object	下单附带止盈止损信息
> attachAlgoId	String	附带止盈止损的订单ID
> attachAlgoClOrdId	String	下单附带止盈止损时，客户自定义的策略订单ID
> tpTriggerPx	String	止盈触发价
> tpTriggerPxType	String	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格
> tpOrdPx	String	止盈委托价
> slTriggerPx	String	止损触发价
> slTriggerPx	String	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格
> slOrdPx	String	止损委托价
> sz	String	张数。仅适用于“多笔止盈”的止盈订单且必填
> amendPxOnTriggerType	String	是否启用开仓价止损，仅适用于分批止盈的止损订单 `0`：不开启，默认值 `1`：开启

新增返回参数

参数名	类型	描述
amendPxOnTriggerType	String	是否启用开仓价止损，仅适用于分批止盈的止损订单 `0`：不开启，默认值 `1`：开启

新增错误码

错误码	HTTP 状态码	错误提示
51076	200	分批止盈的每笔止盈止损订单仅支持单向止盈止损，slTriggerPx&slOrdPx 与 tpTriggerPx&tpOrdPx 只能填写一组
51077	200	币币/杠杆不支持开启'开仓价止损'
51078	200	您当前身份为带单交易员，不支持分批止盈
51079	200	同一笔订单上附带分批止盈的止盈委托单不能超过 {param0} 笔
51080	200	同一笔订单上附带分批止盈的止盈触发价类型 (tpTriggerPxType) 必须保持一致
51081	200	同一笔订单上附带分批止盈的止盈触发价 (tpTriggerPx) 不能相等
51082	200	同一笔订单上附带分批止盈，其中触发止盈的止盈委托价 (tpOrdPx) 只能是市价
51083	200	同一笔订单上附带分批止盈的止盈数量之和需要等于订单的委托数量
51084	200	同一笔订单上附带分批止盈的止损委托单不能超过 {param0} 笔
51085	200	附带止盈止损开启'开仓价止损'时 (amendPxOnTriggerType 设置为 1)，该笔订单上的止盈委托单必须大于等于 2 笔
51086	200	同一笔订单上附带止盈止损委托单不能超过 {param0} 笔
51538	200	若下单时使用了 attachAlgoOrds 参数，也需要使用 attachAlgoOrds 参数改单；若下单时没有使用 attachAlgoOrds 参数，则不支持使用 attachAlgoOrds 参数改单。
51539	200	修改同一笔订单上分批止盈中的止盈止损订单时，attachAlgoId 或者 attachAlgoClOrdId 的值不能重复
51527	200	改单失败，其中至少有一个附带的止盈止损订单不存在
51089	200	在附带分批止盈时，止盈订单的数量不能为空

2023-11-07

价差交易支持立即成交并取消剩余（ioc）订单

请求参数ordType新增枚举值
- 下单
- 获取历史订单记录（近21天)

参数名	类型	是否必须	描述
ordType	String	否	`ioc`：立即成交并取消剩余

返回参数ordType新增枚举值

参数名	类型	描述
ordType	String	`ioc`：立即成交并取消剩余

返回参数cancelSource新增枚举值
- 获取历史订单记录（近21天)
- 订单频道

参数名	类型	描述
cancelSource	String	`14`: 已撤单：IOC 委托订单未完全成交，仅部分成交，导致部分挂单被撤回

2023-11-02

新增参数
- 获取闪兑交易历史

参数名	类型	描述
clTReqId	String	用户自定义的订单标识

2023-11-01

新增返回参数及数据推送参数
- 获取询价单信息
- 询价频道

参数名	类型	描述
flowType	String	识别询价单的类型。仅适用于报价方，返回""给询价方。

新增返回参数
- 获取子账户列表（ND）

参数名	类型	描述
> enable	Boolean	子账户状态 `true`：正常使用 `false`：冻结
> frozenFunc	Array of string	被冻结的功能 `trading`：交易 `convert`：闪兑 `transfer`：母子账户间资金划转 `withdrawal`：提币 `deposit`：充值 `flexible_loan`：活期借币
> canTransOut	String	是否可以主动转出（通过子账户APIKey直接转到另一个子账户下） `true`：可以转出 `false`：不可转出

新增返回参数
- 查看子账户列表

参数名	类型	描述
frozenFunc	Array of string	被冻结的功能 `trading`：交易 `convert`：闪兑 `transfer`：母子账户间资金划转 `withdrawal`：提币 `deposit`：充值 `flexible_loan`：活期借币

WebSocket 返回消息（event）新增connId参数，以帮助用户定位 WebSocket 连接

参数名	类型	是否必须	描述
connId	String	是	WebSocket 连接ID

2023-10-31

新增 WebSocket 价差交易改单频道。该接口目前仅适用于白名单用户。
- 修改订单

2023-10-27

手续费接口调整

为优化用户交易体验、提升市场流动性，欧易已于 2023 年10 月 27 日 15:00 - 17:00 (UTC+8) 调整手续费规则，
同时，“获取当前账户交易手续费费率”接口的返回参数会受到影响，将做如下调整：

注意：
1. 仅币币和杠杆的返回参数会受到影响，交割、永续和期权的返回参数不受影响。
2. 对于币币和杠杆，USDⓈ&Crypto 交易区的币对费率，由 taker/maker 参数返回，改为由 takerUSDC/makerUSDC 参数返回。

调整前：

参数名	类型	描述
taker	String	对于币币/杠杆，为 USDT&USDⓈ&Crypto 交易区的吃单手续费率；对于永续，交割和期权合约，为币本位合约费率
maker	String	对于币币/杠杆，为 USDT&USDⓈ&Crypto 交易区的挂单手续费率；对于永续，交割和期权合约，为币本位合约费率
takerUSDC	String	USDC 交易区的吃单手续费率，包括 USDC 现货和 USDC 合约
makerUSDC	String	USDC 交易区的挂单手续费率，包括 USDC 现货和 USDC 合约

调整后：

参数名	类型	描述
taker	String	对于币币/杠杆，为 USDT 交易区的吃单手续费率；对于永续，交割和期权合约，为币本位合约费率
maker	String	对于币币/杠杆，为 USDT 交易区挂单手续费率；对于永续，交割和期权合约，为币本位合约费率
takerUSDC	String	对于币币/杠杆，为 USDⓈ&Crypto 交易区的吃单手续费率；对于永续和交割合约，为 USDC 合约费率
makerUSDC	String	对于币币/杠杆，为 USDⓈ&Crypto 交易区的挂单手续费率；对于永续和交割合约，为 USDC 合约费率
fiat	Array	法币费率
> ccy	String	法币币种
> taker	String	吃单手续费率
> maker	String	挂单手续费率

调整请求参数
- 获取当前账户交易手续费费率

调整前：

参数名	类型	是否必须	描述
quoteCcyType	String	否	计价币类型 `2`：USDT/USDⓈ/Crypto `3`：USDC 适用于`币币` 当指定该参数时，`instType`必传

调整后：

参数名	类型	是否必须	描述
quoteCcyType	String	否	计价币类型 `2`：USDT `3`：USDⓈ/Crypto 适用于`币币` 当指定该参数时，`instType`必传

2023-10-24

新增价差交易改单接口。该接口目前仅适用于白名单用户。
- 修改订单

2023-10-19

新增功能 [下载2年内的历史成交明细]
- 申请
- 获取

2023-10-18

交易频道功能调整，聚合每个taker订单价格相同的成交
- WS / 交易频道
新增功能信号交易
新增返回参数
- 获取返佣明细下载链接(ND)
- 获取返佣明细下载链接(FD)

参数名	类型	描述
beginTime	String	返佣明细的开始时间，Unix时间戳的毫秒数格式，如 `1597026383085`
endTime	String	返佣明细的结束时间，Unix时间戳的毫秒数格式，如 `1597026383085`
cTime	String	发起生成下载链接请求的时间，Unix时间戳的毫秒数格式，如 `1597026383085`

新增接口
- 子账户IP上报
新增请求参数
- 创建子账户(ND)

参数名	类型	是否必须	描述
clientIP	String	否	子账户注册时的IP 非个人账户请使用ND服务端IP

cancelSource参数新增枚举值
- WS / 订单频道

参数名	类型	描述
> cancelSource	String	`33`: 当前 taker 订单匹配的订单数量超过最大限制

新增错误码

错误码	HTTP 状态码	错误提示
51088	200	对于同一个仓位，仅支持一笔全部平仓的止盈止损挂单

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
bePx	String	盈亏平衡价

2023-09-29

新增请求参数
- 张币转换

参数名	类型	是否必须	描述
opType	String	否	将要下单的类型 `open`: 开仓时将sz舍位 `close`: 平仓时将sz四舍五入默认值为`close` 适用于`交割` `永续`

2023-09-28

调整交易限制

为保障交易系统性能，为用户提供更好的交易体验，OKX现调整交易限制，限制每笔taker订单匹配的maker订单数量不得超过1000笔。

当taker订单匹配的maker订单数量超过最大限制1000笔时，taker订单将被取消：

限价单仅成交与1000笔maker订单相对应的部分，并取消剩余；
全部成交或立即取消（FOK）订单将直接被取消。

2023-09-27

调整参数
- 订单频道

调整前

参数名	类型	描述
> amendResult	String	修改订单的结果 `-1`：失败 `0`：成功 `1`：自动撤单（因为修改成功导致订单自动撤销）通过API修改订单时，如果`cxlOnFail`设置为`false`且修改失败后，则`amendResult`返回 `-1` 通过API修改订单时，如果`cxlOnFail`设置为`true`且修改失败后，则`amendResult`返回`1` 通过Web/APP修改订单时，如果修改失败后，则`amendResult`返回`-1`

调整后

参数名	类型	描述
> amendResult	String	修改订单的结果 `-1`：失败 `0`：成功 `1`：自动撤单（因为修改成功导致订单自动撤销） `2`: 自动改单成功，仅适用于期权pxUsd和pxVol订单的自动改单通过API修改订单时，如果`cxlOnFail`设置为`false`且修改失败后，则`amendResult`返回 `-1` 通过API修改订单时，如果`cxlOnFail`设置为`true`且修改失败后，则`amendResult`返回`1` 通过Web/APP修改订单时，如果修改失败后，则`amendResult`返回`-1`

2023-09-20

新增返回参数，新参数将适用于以下端点的成功及失败响应：

参数名	类型	描述
inTime	String	WebSocket / REST网关接收请求时的时间戳，Unix时间戳的微秒数格式，如 `1597026383085123` REST接口返回的时间是请求验证后的时间。
outTime	String	WebSocket / REST网关发送响应时的时间戳，Unix时间戳的微秒数格式，如 `1597026383085123`

新增返回参数
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
interest	String	利息
tag	String	订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。
fillTime	String	最新成交时间
tradeId	String	最新成交ID
clOrdId	String	客户自定义订单ID
fillIdxPx	String	交易执行时的指数价格对于交叉现货币对，返回 baseCcy-USDT 的指数价格。例如LTC-ETH，该参数返回LTC-USDT的指数价格。
fillMarkPx	String	成交时的标记价格，仅适用于交割/永续/期权
fillPxVol	String	成交时的隐含波动率，仅适用于期权，其他业务线返回空字符串""
fillPxUsd	String	成交时的期权价格，以USD为单位，仅适用于期权，其他业务线返回空字符串""
fillMarkVol	String	成交时的标记波动率，仅适用于期权，其他业务线返回空字符串""
fillFwdPx	String	成交时的远期价格，仅适用于期权，其他业务线返回空字符串""

新增推送数据参数
- 账户余额和持仓频道

参数名	类型	描述
data	Array	订阅的数据
> trades	Array	成交信息
>> instId	String	产品ID，如 `BTC-USDT`
>> tradeId	String	最新成交ID

计划委托新增参数

参数名	类型	描述
attachAlgoOrds	Array of object	附带止盈止损信息适用于`现货和合约模式`/`跨币种保证金模式`/`组合保证金模式`
> attachAlgoClOrdId	String	下单附带止盈止损时，客户自定义的策略订单ID，字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。订单完全成交，下止盈止损委托单时，该值会传给algoClOrdId。
> tpTriggerPx	String	止盈触发价，如果填写此参数，必须填写`止盈委托价`
> tpTriggerPxType	String	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
> tpOrdPx	String	止盈委托价，如果填写此参数，必须填写`止盈触发价` 委托价格为`-1`时，执行市价止盈
> slTriggerPx	String	止损触发价，如果填写此参数，必须填写`止损委托价`
> slTriggerPxType	String	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
> slOrdPx	String	止损委托价，如果填写此参数，必须填写`止损触发价` 委托价格为`-1`时，执行市价止损

移动止盈止损委托新增参数
- 策略委托下单
- 高级策略委托订单频道

参数名	类型	描述
reduceOnly	Boolean	是否只减仓，`true` 或 `false`

新增枚举值

参数名	类型	描述
source	String	订单来源 `6`：计划委托策略触发后的生成的普通单 `7`：止盈止损策略触发后的生成的普通单 `25`：移动止盈止损策略触发后的生成的普通单

新增错误码

错误码	HTTP 状态码	错误提示
51333	200	开平模式下的平仓单或买卖模式下的只减仓单无法附带止盈止损

2023-09-13

新增请求和返回参数
- 交易员平仓
- 交易员止盈止损

参数名	类型	是否必须	描述
tag	String	否	订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。

新增请求参数
- 交易员获取当前带单

参数名	类型	是否必须	描述
after	String	否	请求此id之前（更旧的数据）的分页内容，传的值为对应接口的`subPosId`
before	String	否	请求此id之后（更新的数据）的分页内容，传的值为对应接口的`subPosId`
limit	String	否	分页返回的结果集数量，最大为500，不填默认返回500条

新增最近3个月的限制
- 交易员历史分润明细

2023-09-08

对于下单接口：

调整并新增请求参数

调整前：

参数名	类型	是否必须	描述
px	String	可选	委托价格，仅适用于`limit`、`post_only`、`fok`、`ioc`类型的订单

调整后：

参数名	类型	是否必须	描述
px	String	可选	委托价格，仅适用于`limit`、`post_only`、`fok`、`ioc`类型的订单，期权下单时，px/pxUsd/pxVol 只能填一个

新增请求参数

参数名	类型	是否必须	描述
pxUsd	String	可选	以USD价格进行期权下单仅适用于期权期权下单时 px/pxUsd/pxVol 必填一个，且只能填一个
pxVol	String	可选	以隐含波动率进行期权下单，例如 1 代表 100% 仅适用于期权期权下单时 px/pxUsd/pxVol 必填一个，且只能填一个

对于改单接口：

调整并新增请求参数

调整前：

参数名	类型	是否必须	描述
newPx	String	可选	修改的新价格

调整后：

参数名	类型	是否必须	描述
newPx	String	可选	修改的新价格期权改单时，newPx/newPxUsd/newPxVol 只能填一个，且必须与下单参数保持一致，如下单用px，改单时需使用newPx

新增请求参数

参数名	类型	是否必须	描述
newPxUsd	String	可选	以USD价格进行期权改单仅适用于期权，期权改单时，newPx/newPxUsd/newPxVol 只能填一个
newPxVol	String	可选	以隐含波动率进行期权改单，例如 1 代表 100% 仅适用于期权，期权改单时，newPx/newPxUsd/newPxVol 只能填一个

2023-08-31

新增交易限制

为保障交易系统性能，为用户提供更好的交易体验，OKX现新增交易限制，限制每笔taker订单匹配的maker订单数量不得超过256笔。

当taker订单匹配的maker订单数量超过最大限制256笔时，taker订单将被取消：

限价单仅成交与256笔maker订单相对应的部分，并取消剩余；
全部成交或立即取消（FOK）订单将直接被取消。

当用户因此被撤单时，可以通过如下接口查询到 cancelSource = "0" 及 cancelSourceReason = "系统撤单"：

亦能够通过如下的WebSocket频道接收到cancelSource = "0"：

WS / 订单频道

未来，为适应更多因提升交易系统性能而导致撤单的场景，该原因导致的撤单对应的cancelSource及cancelSourceReason可能会发生修改：

cancelSource = "33"
cancelSourceReason = "当前taker订单匹配的maker订单数量超过最大限制，导致系统撤单"

2023-08-30

对于订单信息、未成交订单列表、订单记录接口：

调整并新增返回参数

调整前：

参数名	类型	描述
px	String	委托价格

调整后：

参数名	类型	描述
px	String	委托价格，对于期权，以币(如BTC, ETH)为单位

新增返回参数

参数名	类型	描述
pxUsd	String	期权价格，以USD为单位仅适用于期权，其他业务线返回空字符串""
pxVol	String	期权订单的隐含波动率仅适用于期权，其他业务线返回空字符串""
pxType	String	期权的价格类型 `px`：代表按价格下单，单位为币 (请求参数 px 的数值单位是BTC或ETH) `pxVol`：代表按pxVol下单 `pxUsd`：代表按照pxUsd下单，单位为USD (请求参数px 的数值单位是USD)

参数amendSource新增枚举值

订单频道

参数名	类型	描述
> amendSource	String	订单修改的来源 `1`: 用户主动改单，改单成功 `2`: 用户主动改单，并且当前这笔订单被只减仓修改，改单成功 `3`: 用户主动下单，并且当前这笔订单被只减仓修改，改单成功 `4`: 用户当前已存在的挂单（非当前操作的订单），被只减仓修改，改单成功 `5`：期权 px, pxVol 或 pxUsd 的跟随变动导致的改单，比如 iv=60，usd，px 锚定iv=60 时，usd, px 产生变动时的改单

对于成交明细接口及订单频道：

新增返回参数

参数名	类型	描述
fillPxVol	String	成交时的隐含波动率，仅适用于期权，其他业务线返回空字符串""
fillPxUsd	String	成交时的期权价格，以USD为单位，仅适用于期权，其他业务线返回空字符串""
fillMarkVol	String	成交时的标记波动率，仅适用于期权，其他业务线返回空字符串""
fillFwdPx	String	成交时的远期价格，仅适用于期权，其他业务线返回空字符串""
fillMarkPx	String	成交时的标记价格，仅适用于 `交割`/`永续`/`期权`

新增错误码

错误码	HTTP 状态码	错误提示
51175	200	参数 {param0}、{param1} 和 {param2} 不能同时为空
51176	200	参数 {param0}、{param1} 和 {param2} 只能填写一个
51177	200	当前期权订单的价格类型为{param0}，不支持修改{param1}
51179	200	现货模式下，不支持使用{param0}进行期权下单。
51180	200	{param0}的范围应为({param1}, {param2})
51181	200	使用{param0}下单，ordType 只能为限价单 (limit)
51182	200	当前账户期权价格类型 pxUsd 和 pxVol 的挂单数量之和，不能超过 {param0} 个
51536	200	期权的 pxVol 或者 pxUsd 订单不支持修改订单数量
51537	200	非期权产品不支持使用 pxUsd 或者 pxVol

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
realizedPnl	String	已实现收益
pnl	String	平仓订单累计收益额
fee	String	累计手续费金额，正数代表平台返佣，负数代表平台扣除
fundingFee	String	累计资金费用
liqPenalty	String	累计爆仓罚金，有值时为负数。

新增返回参数
- 查看历史持仓信息

参数名	类型	描述
realizedPnl	String	已实现收益
fee	String	累计手续费金额，正数代表平台返佣，负数代表平台扣除
fundingFee	String	累计资金费用
liqPenalty	String	累计爆仓罚金，有值时为负数。

调整请求参数
- 倒计时全部撤单

调整前：

参数名	类型	是否必须	描述
timeOut	String	是	取消挂单的倒计时，单位为秒。取值范围为 0, [5, 120] 0 代表不使用该功能。

调整后：

参数名	类型	是否必须	描述
timeOut	String	是	取消挂单的倒计时，单位为秒。取值范围为 0, [10, 120]。 0 代表不使用该功能。

WebSocket API 新增频道
- 全部交易频道

2023-08-23

新增参数
- 获取子账户返佣记录

请求参数

参数名	类型	是否必须	描述
beginTime	String	否	查询起始时间 Unix时间戳的毫秒数格式，如 `1597026383085`，查询在 `1597026383085`（包含）后的记录
endTime	String	否	查询结束时间 Unix时间戳的毫秒数格式，如 `1597026383085`，查询在 `1597026383085`（不包含）前的记录

返回参数

参数名	类型	描述
> rebateTime	String	子账户返佣时间，Unix时间戳的毫秒数格式，如 `1597026383085`

返回结果按照时间倒序排列

2023-08-22

新增接口
- 获取交易所列表（公共）
新增返回参数
- 提币
- 闪电网络提币

参数名	类型	是否必须	描述
rcvrInfo	Object	可选	接收方信息特定国家/地区认证用户做链上提币需要提供此信息
> walletType	String	是	钱包类型 `exchange`：提币到交易所钱包 `private`：提币到私人钱包如果提币到交易所钱包，必须提供`exchId`,`rcvrFirstName`,`rcvrLastName` 提币到私人钱包，则不需要提供其他信息
> exchId	String	可选	交易所 ID 可以通过获取交易所列表（公共）接口查询支持的交易所如果交易所不在支持的交易所列表中，该参数填`0`
> rcvrFirstName	String	可选	接收方名字，如 `Bruce`
> rcvrLastName	String	可选	接收方姓氏，如 `Wayne`

新增错误码

错误码	HTTP 状态码	错误提示
58237	200	根据当地法律法规，请提供准确的接收方信息 (rcvrInfo)。对于交易所地址，请一并提供交易所信息和接收人的身份信息。
58238	200	提币到交易所地址需提供完整的接收方信息，包括交易所信息和接收人的身份信息。

2023-08-16

新增返回参数

参数名	类型	描述
> borrowFroz	String	账户美金层面潜在借币占用保证金仅适用于`跨币种保证金模式`和`组合保证金模式`。在其他账户模式下为""。
>> borrowFroz	String	币种美金层面潜在借币占用保证金仅适用于`跨币种保证金模式`和`组合保证金模式`。在其他账户模式下为""。

调整返回参数
- 获取交易产品基础信息
- 产品频道

调整前：

参数名	类型	描述
> expTime	String	交割日期，仅适用于 `交割/期权`

调整后：

参数名	类型	描述
> expTime	String	产品下线时间适用于`币币/杠杆/交割/永续/期权`，对于 `交割/期权`，为交割/行权日期；亦可以为产品下线时间，有变动就会推送。

新增请求参数：
- 获取最大可用余额/保证金

参数名	类型	是否必须	描述
px	String	否	对应平仓价格下的可用数量，默认为市价。仅适用于杠杆只减仓

调整返回参数描述
- 查看持仓信息
- 持仓频道

调整前：

参数名	类型	描述
availPos	String	可平仓数量，适用于 `币币杠杆`,`交割/永续`（开平仓模式），`期权`

调整后：

参数名	类型	描述
availPos	String	可平仓数量，适用于 `币币杠杆`,`交割/永续`（开平仓模式），`期权` 对于杠杆仓位，平仓时，杠杆还清负债后，余下的部分会视为币币交易，如果想要减少币币交易的数量，可通过"获取最大可用数量"接口获取只减仓的可用数量。

错误码更新
- 停止使用错误码51401，51402，51509，51510
- 将错误码51401及51402合并入51400，错误码51509及51510合并入51503
- 更新后的51400及51503错误提示如下

错误码	HTTP 状态码	错误提示
51400	200	由于订单已完成、已撤销或不存在，撤单失败
51503	200	由于订单已完成、已撤销或不存在，改单失败

文档添加支持 1s k线的描述
- 获取交易产品历史K线数据
- K线频道

2023-08-14

交易产品挂单数量限制调整

调整后，单个交易产品最多支持 500 笔挂单。例如，永续合约 BTC-USDT-SWAP、交割合约 BTC-USDT-230707、现货 BTC-USDT 分别最多支持 500 笔挂单。

单个账户的最大挂单数量仍为 4000 笔不变。现有的期权交易规则不变。新挂单限制不会影响用户现有的超额挂单，但必须待超额挂单被成交或取消，且挂单数量少于限制后，用户才能继续下单同一交易产品。

被计入到 500 笔挂单数量限制的订单类型包括：

限价委托 (Limit)
市价委托 (Market)
只挂单 (Post only)
全部成交或立即取消 (FOK)
立即成交并取消剩余 (IOC)
市价委托立即成交并取消剩余 (optimal limit IOC)
止盈止损 (TP/SL)
以下类型的订单触发的限价和市价委托：
- 止盈止损 (TP/SL)
- 计划委托 (Trigger)
- 移动止盈止损 (Trailing stop)
- 套利下单 (Arbitrage)
- 冰山策略 (Iceberg)
- 时间加权策略 (TWAP)
- 定投 (Recurring buy)

新增错误码51174

错误码	HTTP 状态码	错误提示
51174	200	操作失败，当前 {param0} 的累计挂单数量已达上限 {param1} (单)

2023-08-02

新增接口
- 设置模拟盘ND子账户资产
新增返回参数
- 获取借币利率与限额
- 获取子账户借币利率与限额

参数名	类型	描述
> surplusLmtDetails	Array	母子账户剩余可借额度详情，母子账户剩余可借额度的值取该数组中的最小值，可以用来判断是什么原因导致可借额度不足仅适用于`尊享借币`
>> allAcctRemainingQuota	String	母子账户剩余额度
>> curAcctRemainingQuota	String	当前子账户剩余额度仅适用于为子账户分配限额的场景
>> platRemainingQuota	String	平台剩余额度，当平台剩余额度大于`curAcctRemainingQuota`或者`allAcctRemainingQuota`时，会显示大于某个值，如">1000"

2023-07-26

返回参数调整
- 获取用户的 Broker 返佣信息

调整前

参数名	类型	描述
type	String	账户无法Broker返佣的原因 `2`：用户手续费等级是VIP3或以上

调整后

参数名	类型	描述
type	String	账户无法Broker返佣的原因 `2`：手续费等级为`VIP4/5`且月返佣金额达到上限 `3`：手续费等级大于等于`VIP6`
clientRebateRatio	String	交易用户可获取返佣比例

2023-07-20

新增返回参数
- 获取子账户返佣记录

参数名	类型	描述
totIncomeCat	Object	所有子账户返佣金额分类统计
> spot	String	所有子账户 `现货` 总返佣金额，单位为`USDT`
> derivative	String	所有子账户 `衍生品` 总返佣金额，单位为`USDT`
> convert	String	所有子账户 `闪兑` 总返佣金额，单位为`USDT`
details	Array	子账户返佣记录列表
> incomeCat	Object	当前子账户返佣金额分类统计
>> spot	String	当前子账户 `现货` 返佣金额，单位为`USDT`
>> derivative	String	当前子账户 `衍生品` 返佣金额，单位为`USDT`
>> convert	String	当前子账户 `闪兑` 返佣金额，单位为`USDT`
> netFee	String	当前子账户净手续费，单位`USDT`
> netFeeCat	Object	当前子账户净手续费分类统计
>> spot	String	当前子账户 `现货` 净手续费汇总，单位为`USDT`
>> derivative	String	当前子账户 `衍生品` 净手续费汇总，单位为`USDT`
> markupFee	String	当前子账户加点后手续费，单位`USDT`
> markupFeeCat	Object	当前子账户加点后手续费分类统计
>> spot	String	当前子账户 `现货` 加点后手续费，单位为`USDT`
>> derivative	String	当前子账户 `衍生品` 加点后手续费，单位为`USDT`
>> convert	String	当前子账户 `闪兑` 加点后手续费，单位为`USDT`

新增解压后文件参数
- 获取返佣明细下载链接(FD)

参数名	描述
netFee	净手续费 (去除返佣卡、对手方等数据后进行返佣结算的手续费基数)，单位为`USDT`
settlementFee	结算手续费 (去除节点返佣、返佣卡等，Broker进行结算前的手续费基数)，单位为`USDT`

新增解压后文件参数
- 获取返佣明细下载链接(ND)

参数名	描述
rebateCat	返佣类别 `spot`：现货 `derivative`：衍生品 `convert`：闪兑
netFee	净手续费（去除返佣卡、对手方等数据后进行返佣结算的手续费基数），单位为`USDT`
markupFee	加点手续费，单位为`USDT`

2023-07-19

新增返回参数

参数名	类型	描述
profitSharingRatio	String	分润比例取值范围[0,0.3] 如果是普通订单（既不是带单也不是跟单），该参数返回""
copyType	String	分润订单类型 `0`：普通订单 `1`：普通跟单 `2`：分润跟单 `3`：带单

新增返回参数
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	描述
px	String	价格，与 subType 相关。为成交价格时有 1: 买入 2: 卖出 3：开多 4：开空 5：平多 6：平空 204: 大宗交易买 205: 大宗交易卖 206: 大宗交易开多 207: 大宗交易开空 208: 大宗交易平多 209: 大宗交易平空 114：自动换币买入 115：自动换币卖出强平价格，100：强减平多 101：强减平空 102：强减买入 103：强减卖出 104：强平平多 105：强平平空 106：强平买入 107：强平卖出 16：强制还币 17：强制借币还息 110：强平换币转入 111：强平换币转出交割价格，112：交割平多 113：交割平空行权价格，170：到期行权 171：到期被行权 172：到期作废标记价格，173：资金费支出 174：资金费收入

新增返回参数
- 获取期权定价
- 期权定价频道

参数	类型	描述
volLv	String	价平期权的隐含波动率

新增接口
- 设置账户模式

参数 ordType 新增枚举值:
- 请求参数相关接口：
- 返回参数相关接口：

参数	类型	描述
ordType	String	`mmp_and_post_only`：做市商保护且只做maker单(仅适用于组合保证金账户模式下的期权订单)

新增接口
- 设置 MMP
- 查看 MMP 配置

2023-07-17

新增返回参数
- 查看子账户列表

参数名	类型	描述
uid	String	子账户UID

新增请求参数
- 策略委托下单

参数名	类型	是否必须	描述
cxlOnClosePos	Boolean	否	决定用户所下的止盈止损订单是否与该交易产品对应的仓位关联。若关联，仓位被撤销时，该止盈止损订单会被同时撤销；若不关联，仓位被撤销时，该止盈止损订单不受影响。有效值： `true`：下单与仓位关联的止盈止损订单 `false`：下单与仓位不关联的止盈止损订单默认值为`false`。若传入`true`，用户必须同时传入 reduceOnly = true，说明当下单与仓位关联的止盈止损订单时，必须为只减仓。适用于现货和合约模式、跨币种保证金模式。

2023-07-07

参数 ordType 新增枚举值:
- 请求参数相关接口：
- 返回参数相关接口：

参数	类型	描述
ordType	String	`mmp_and_post_only`：做市商保护且只做maker单(仅适用于组合保证金账户模式下的期权订单)

新增接口
- 设置 MMP
- 查看 MMP 配置

2023-07-05

新增枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	是否必须	描述
type	String	否	账单类型 `24`: 价差交易
subType	String	否	账单子类型 `270`: 价差交易买; `271`: 价差交易卖; `272`: 价差交易开多; `273`: 价差交易开空; `274`: 价差交易平多; `275`: 价差交易平空

新增返回参数
- 获取成交明细（近三天）
- 获取成交明细（近三个月）

参数名	类型	描述
fillPnl	String	最新成交收益，适用于有成交的平仓订单。其他情况均为0。

新增推送数据参数
- 订单频道

参数名	类型	描述
> fillPnl	String	最新成交收益，适用于有成交的平仓订单。其他情况均为0。

新增请求参数
- 账户频道
- 持仓频道

参数名	类型	是否必须	描述
> extraParams	String	否	额外配置
>> updateInterval	int	否	`0`: 仅根据事件推送数据若不添加该参数或将其设置为除0外的其他值，数据将根据事件推送并定时推送。使用该参数需严格遵守以下格式。 "extraParams": " { \"updateInterval\": \"0\" } "

新增接口
- 获取杠杆倍数预估信息
订单频道支持交割订单(category=delivery)的推送
组合保证金的持仓保证金计算的调用权限由"交易"，调整为了"读取"。

2023-06-28

参数 ordType 新增枚举值:
- 请求参数相关接口：
- 返回参数相关接口：

参数	类型	描述
ordType	String	`mmp`：做市商保护(仅适用于组合保证金账户模式下的期权订单)

参数 state 新增枚举值:
- 请求参数相关接口：
  - 获取历史订单记录（近七天）
  - 获取历史订单记录（近三个月）
- 返回参数相关接口：

参数	类型	描述
state	String	`mmp_canceled`：做市商保护机制导致的自动撤单

新增接口

2023-06-27

新增返回参数
- 获取币种列表

参数	类型	描述
minFeeForCtAddr	String	合约地址最小提币手续费数量
maxFeeForCtAddr	String	合约地址最大提币手续费数量

2022-06-26

新增API文档价差撮合交易（Spread Orderbook）。目前只供白名单用户在模拟盘使用
新增错误码

错误码	HTTP 状态码	错误提示
75001	200	交易 ID 不存在
75002	200	{sprdId} : 目前不接受新订单
75003	200	价格无效

2023-06-20

在深度频道新增返回参数:

参数	类型	描述
> prevSeqId	Integer	上一个推送的序列号。仅适用 `books`，`books-l2-tbt`，`books50-l2-tbt`
> seqId	Integer	推送的序列号

请求参数发生了如下变动
- 策略委托下单

调整前：

参数名	类型	是否必须	描述
closeFraction	String	可选	策略委托触发时，平仓的百分比。1 代表100% 现在系统只支持全部平仓，唯一接受参数为`1` 对于同一个仓位，仅支持一笔全部平仓的止盈止损挂单仅适用于`交割`或`永续` 仅适用于买卖模式 `posSide` = `net` 仅适用于减仓订单 `reduceOnly` = `true` 仅适用于止盈止损 `ordType` = `conditional` 或 `oco` 仅适用于止盈止损市价订单不支持组合保证金模式 `sz`和`closeFraction`必填且只能填其一

调整后：

参数名	类型	是否必须	描述
closeFraction	String	可选	策略委托触发时，平仓的百分比。1 代表100% 现在系统只支持全部平仓，唯一接受参数为`1` 对于同一个仓位，仅支持一笔全部平仓的止盈止损挂单仅适用于`交割`或`永续` 当`posSide` = `net`时，`reduceOnly`必须为`true` 仅适用于止盈止损 `ordType` = `conditional` 或 `oco` 仅适用于止盈止损市价订单不支持组合保证金模式 `sz`和`closeFraction`必填且只能填其一

请求参数发生了如下变动
- 创建子账户的APIKey

调整前：

参数名	类型	是否必须	描述
ip	String	可选	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip 如果子账户APIKey拥有 `交易`/`提币` 权限，必须绑定IP地址

调整后：

参数名	类型	是否必须	描述
ip	String	否	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip

请求参数发生了如下变动
- 重置子账户的APIKey

调整前：

参数名	类型	是否必须	描述
ip	String	否	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip 如果填写该参数，则该参数会被重置如果子账户APIKey拥有 `交易`/`提币` 权限，必须绑定IP地址

调整后：

参数名	类型	是否必须	描述
ip	String	否	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip 如果填写该参数，则该参数会被重置

新增请求参数：
- 获取子账户列表

参数名	类型	是否必须	描述
uid	String	否	子账户UID

新增请求参数：
- 下单
- 批量下单

参数名	类型	是否必须	描述
attachAlgoClOrdId	String	否	下单附带止盈止损时，客户自定义的策略订单ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。订单完全成交，下止盈止损委托单时，该值会传给`algoClOrdId`

新增返回参数:

参数	类型	描述
attachAlgoClOrdId	String	下单附带止盈止损时，客户自定义的策略订单ID

调整返回参数

调整前：

参数名	类型	描述
ordId	String	订单ID
state	String	订单状态，`live`：待生效 `pause`：暂停生效 `partially_effective`:部分生效

调整后：

参数名	类型	描述
ordId	String	最新一笔订单ID
state	String	订单状态，`live`：待生效 `pause`：暂停生效 `partially_effective`:部分生效 `partially_failed`：部分委托失败
ordIdList	Array	订单ID列表，当止盈止损存在市价拆单时，会有多个。

2023-06-19

新增接口
- 查询托管子账户转账记录

2023-06-15

由计划系统维护引起的短暂不可用（<5秒）和WebSocket闪断连接（用户可以立即重连）将不会公布。此类维护只会在市场波动性低的时期进行。
- 获取系统状态
- Status频道

2023-06-07

新增请求参数:

参数	类型	是否必须	描述
stpId	String	否	自成交保护ID。来自同一个母账户配着同一个ID的订单不能自成交用户自定义1<=x<=999999999的整数
stpMode	String	否	自成交保护模式预设 cancel maker `cancel_maker`,`cancel_taker`, `cancel_both` Cancel both不支持FOK

新增返回参数:

参数	类型	描述
stpId	String	自成交保护ID 如果自成交保护不适用则返回""
stpMode	String	自成交保护模式如果自成交保护不适用则返回""
cancelSource	String	`32`: 自成交保护

该返回参数的调整已经上线实盘
- 获取期权公共成交数据
- 期权公共成交频道

调整前：

参数名	类型	描述
indexPx	String	成交时的指数价格

调整后：

参数名	类型	描述
idxPx	String	成交时的指数价格

新增返回参数
- 获取成交明细（近三天）
- 获取成交明细（近三个月）

参数名	类型	描述
fillIdxPx	String	交易执行时的指数价格对于交叉现货币对，返回 baseCcy-USDT 的指数价格。例如LTC-ETH，该参数返回LTC-USDT的指数价格。

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
idxPx	String	最新指数价格

新增返回参数
- 查看账户配置

参数名	类型	描述
kycLv	String	母账户KYC等级 `0`: 未认证 `1`: 已完成 level 1 认证, `2`: 已完成 level 2 认证, `3`: 已完成 level 3认证. 如果请求来自子账户, kycLv 为其母账户的等级. 如果请求来自母账户, kycLv 为当前请求的母账户等级.

子账户

新增接口
- 获取子账户最大可转余额

2023-06-02

该返回参数的调整将于2023年6月7日上线实盘
- 获取期权公共成交数据
- 期权公共成交频道

调整前：

参数名	类型	描述
indexPx	String	成交时的指数价格

调整后：

参数名	类型	描述
idxPx	String	成交时的指数价格

2023-05-29

2023年6月1日起新增枚举值pending_fill到Quotes推送频道返回参数state
- Quotes channel

Parameter	Type	Description
state	String	报价单的状态有效值为 `active` `pending_fill` `canceled` `filled` `expired` or `failed`.

2023-05-24

新增返回参数
- 查看账户配置

参数名	类型	描述
mainUid	String	当前请求的母账户ID 如果 uid = mainUid，代表当前账号为母账户；如果 uid != mainUid，代表当前账户为子账户。
perm	String	当前请求的 API key权限 `read_only`：读取 `trade`：交易 `withdraw`：提币

新增返回参数：

参数名	类型	描述
algoClOrdId	String	用户自定义策略ID
tag	String	订单标签

新增返回参数：

参数名	类型	描述
algoClOrdId	String	用户自定义策略ID

2023-05-10

新增返回参数：
- 获取子账户列表

参数名	类型	描述
> uid	String	子账户ID

2023-04-27

新增请求参数：
- 修改订单
- 批量修改订单

参数名	类型	是否必须	描述
newTpTriggerPx	String	可选	止盈触发价如果止盈触发价或者委托价为0，那代表删除止盈
newTpOrdPx	String	可选	止盈委托价委托价格为-1时，执行市价止盈
newSlTriggerPx	String	可选	止损触发价如果止损触发价或者委托价为0，那代表删除止损
newSlOrdPx	String	可选	止损委托价委托价格为-1时，执行市价止损
newTpTriggerPxType	String	可选	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格
newSlTriggerPxType	String	可选	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格

新增接口修改策略委托订单
新增返回参数：
- 策略委托订单频道

参数名	类型	描述
> reqId	String	修改订单时使用的request ID，如果没有修改，该参数为""
> amendResult	String	修改订单的结果 `-1`：失败 `0`：成功

新增请求参数：
- 询价
- 报价

参数名	类型	是否必须	描述
> tdMode	String	否	交易模式保证金模式：`cross`全仓 `isolated`逐仓非保证金模式：`cash`非保证金. 如未提供，tdMode 将继承系统设置的默认值：现货和合约模式 & 现货: `cash` 现货和合约模式和跨币种保证金模式下买入期权： `isolated` 其他情况: `cross`
> ccy	String	否	保证金币种，仅适用于`现货和合约模式`下的`全仓杠杆`订单在其他情况下该参数将被忽略。

新增返回参数：

参数名	类型	描述
>> tdMode	String	交易模式保证金模式：`cross`全仓 `isolated`逐仓非保证金模式：`cash`非保证金. 如未提供，tdMode 将继承系统设置的默认值：现货和合约模式 & 现货: `cash` 现货和合约模式和跨币种保证金模式下买入期权： `isolated` 其他情况: `cross`
>> ccy	String	保证金币种，仅适用于`现货和合约模式`下的`全仓杠杆`订单在其他情况下该参数将被忽略。

2023-04-26

请求参数发生了如下变动
- 设置子账户的交易手续费费率

调整前：

参数名	类型	是否必须	描述
mgnType	String	否	保证金类型 `1`：USDT本位 `2`：币本位适用于`交割/永续`

调整后：

参数名	类型	是否必须	描述
quoteCcyType	String	否	计价币类型 `2`：USDT/USDⓈ/Crypto `3`：USDC 适用于`币币` 当指定该参数时，`instType`必传
mgnType	String	否	保证金类型 `1`：USDT本位 `2`：币本位 `3`：USDC本位适用于`交割/永续` 当指定该参数时，`instType`必传

新增接口
- 设置子账户尊享借币比率
- 获取子账户借币利率与限额
返回参数发生了如下变动
- 获取借币利率与限额

调整前：

参数名	类型	描述
> loanQuota	String	母账户维度借币限额
> surplusLmt	String	母子账户剩余可借
> usedLmt	String	母子账户已借额度

调整后：

参数名	类型	描述
loanAlloc	String	当前交易账户尊享借币可用额度的比率（百分比） 1. 范围为[0, 100]. 精度为 0.01% (2位小数) 2. 0 代表母账户没有为子账户分配； 3. "" 代表母子账户共享
> loanQuota	String	母账户维度借币限额如果已配置可用额度，该参数代表当前交易账户的借币限额
> surplusLmt	String	母子账户剩余可借如果已配置可用额度，该参数代表当前交易账户的剩余可借
> usedLmt	String	母子账户已借额度如果已配置可用额度，该参数代表当前交易账户的已借额度

调整参数
- 接口有：
  - 获取历史仓位信息
  - 查看持仓信息
  - 持仓频道、账户余额和持仓频道以及爆仓风险预警推送频道
- posId 新增有效期的属性，自最近一次平仓算起，满30天 posId 以及整个仓位会被清除。
新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
uplLastPx	String	以最新成交价格计算的未实现收益，主要做展示使用，实际值还是 upl
uplRatioLastPx	String	以最新成交价格计算的未实现收益率

2023-04-19

以下的 WebSocket 频道已迁移到新的 WebSocket URLwss://ws.okx.com:8443/ws/v5/business和wss://wsaws.okx.com:8443/ws/v5/business。现有的websocket URL到2023年5月底将不再支持这些频道。详情可参考：V5 API WebSocket 订阅参数 uly 和部分频道 URL 调整公告
- 大宗交易
- 策略和网格策略委托
- K线频道
V5 API WebSocket 订阅参数 uly 调整如下。详情也可参考：V5 API WebSocket 订阅参数 uly 和部分频道 URL 调整公告
- 当前用户在订阅频道时，订阅参数 uly 会按照 instFamily 处理。2023 年 5 月底之后，订阅参数 uly 会直接被忽略，不再按照 instFamily 处理。请您尽快将 uly 替换为 instFamily。
Websocket 不再支持账户批量登录

2023-04-10

V5 API 为支持 USDC 指数，已经进行了相应调整。
详情请参考：V5 API 支持 USDC 指数的调整公告

2023-04-07

Websocket 将于2023年4月19日起不再支持账户批量登录

2023-04-06

新增推送数据参数
- 订单频道

参数名	类型	描述
> cancelSource	String	订单取消的来源 `31`: 当前只挂单订单 (Post only) 将会吃掉挂单深度
> amendSource	String	订单修改的来源 `1`: 用户主动改单，改单成功 `2`: 用户主动改单，并且当前这笔订单被只减仓修改，改单成功 `3`: 用户主动下单，并且当前这笔订单被只减仓修改，改单成功 `4`: 用户当前已存在的挂单（非当前操作的订单），被只减仓修改，改单成功

2023-04-03

OKX将在2023年4月底后不再支持用户通过REST API接口获取平台历史公共爆仓单。请订阅websocket频道获取实时数据：
- 平台公共爆仓单频道
新增返回参数
- Status 接口
- Status 频道

参数名	类型	描述
maintType	String	维护类型。 `1`：计划维护；`2`：临时维护；`3`：系统故障
env	String	环境。 `1`：实盘，`2`：模拟盘

2023-03-30

返回参数发生了如下变动
- 获取平台24小时总成交量

调整前：

参数名	类型	描述
volUsd	String	24小时平台总成交量，以美元为单位
volCny	String	24小时平台总成交量，以人民币为单位
blockVolUsd	String	24小时平台场外交易总量，以美元为单位
blockVolCny	String	24小时平台场外交易总量，以人民币为单位

调整后：

参数名	类型	描述
volUsd	String	订单簿交易近24小时总成交量，以美元为单位
volCny	String	订单簿交易近24小时总成交量，以人民币为单位

2023-03-29

新增定投功能模块
WebSocket API 新增频道
- 定投策略委托订单频道

2023-03-27

返回参数将在2023年3月30日发生如下变动
- 获取平台24小时总成交量

调整前：

参数名	类型	描述
volUsd	String	24小时平台总成交量，以美元为单位
volCny	String	24小时平台总成交量，以人民币为单位
blockVolUsd	String	24小时平台场外交易总量，以美元为单位
blockVolCny	String	24小时平台场外交易总量，以人民币为单位

调整后：

参数名	类型	描述
volUsd	String	订单簿交易近24小时总成交量，以美元为单位
volCny	String	订单簿交易近24小时总成交量，以人民币为单位

2023-03-24

V5 API 将支持 USDC 指数，于2023年4月10日进行相应调整。
详情请参考：V5 API 支持 USDC 指数的调整公告

2023-03-16

新增接口
- 获取期权价格梯度
- 平台公共爆仓单频道

2023-03-15

新增余币宝功能模块，原余币宝相关接口做如下调整
- 获取余币宝余额接口路径 /api/v5/asset/saving-balance 调整为 /api/v5/finance/savings/balance
- 余币宝申购/赎回接口路径 /api/v5/asset/purchase_redempt 调整为 /api/v5/finance/savings/purchase-redempt
- 设置余币宝借贷利率接口路径 /api/v5/asset/set-lending-rate 调整为 /api/v5/finance/savings/set-lending-rate
- 获取余币宝出借明细接口路径 /api/v5/asset/lending-history 调整为 /api/v5/finance/savings/lending-history
- 获取市场借贷信息（公共）接口路径 /api/v5/asset/lending-rate-summary 调整为 /api/v5/finance/savings/lending-rate-summary
- 获取市场借贷历史（公共）接口路径 /api/v5/asset/lending-rate-history 调整为 /api/v5/finance/savings/lending-rate-history

2023-03-14

获取币种列表返回参数 wdQuota，usedWdQuota 调整:
- 提币额度单位从BTC调整为USD

2023-03-01

新增返回参数

参数名	类型	描述
failCode	String	代表策略触发失败的原因，已撤销和已生效时为""，委托失败时有值，如 51008；仅适用于单向止盈止损委托、双向止盈止损委托、移动止盈止损委托、计划委托。
algoClOrdId	String	客户自定义策略订单ID

请求和返回参数变动
- 策略委托下单
- 获取未完成策略委托单列表

调整请求参数

调整前：

参数名	类型	是否必须	描述
clOrdId	String	否	客户自定义订单ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间

调整后：

参数名	类型	是否必须	描述
algoClOrdId	String	否	客户自定义策略订单ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。

新增返回参数

参数名	类型	描述
algoClOrdId	String	客户自定义策略订单ID

新增返回参数

参数名	类型	描述
algoClOrdId	String	客户自定义策略订单ID。策略订单触发，且策略单有`algoClOrdId`时有值，否则为"",
algoId	String	策略委托单ID，策略订单触发时有值，否则为""

新增接口
- 获取策略委托单信息

2023-02-20

调整推送数据参数
- 订单频道

调整前：

参数名	类型	描述
> cancelSource	String	订单取消的来源有效值及对应的含义是： `0`,`5`,`7`,`8`,`10`,`11`,`12`,`15`,`16`,`18`,`19`: 已撤单：系统撤单 `1`: 用户主动撤单 `2`: 已撤单：预减仓撤单，用户保证金不足导致挂单被撤回 `3`: 已撤单：风控撤单，用户保证金不足有爆仓风险，导致挂单被撤回 `4`: 已撤单：币种借币量达到平台硬顶，系统已撤回该订单 `6`: 已撤单：触发 ADL 撤单，用户保证金率较低且有爆仓风险，导致挂单被撤回 `9`: 已撤单：扣除资金费用后可用余额不足，系统已撤回该订单 `13`: 已撤单：FOK 委托订单未完全成交，导致挂单被完全撤回 `14`: 已撤单：IOC 委托订单未完全成交，仅部分成交，导致部分挂单被撤回 `17`: 已撤单：平仓单被撤单，由于仓位已被市价全平 `20`: 系统倒计时撤单

调整后：

参数名	类型	描述
> cancelSource	String	订单取消的来源有效值及对应的含义是： `0`: 已撤单：系统撤单 `1`: 用户主动撤单 `2`: 已撤单：预减仓撤单，用户保证金不足导致挂单被撤回 `3`: 已撤单：风控撤单，用户保证金不足有爆仓风险，导致挂单被撤回 `4`: 已撤单：币种借币量达到平台硬顶，系统已撤回该订单 `6`: 已撤单：触发 ADL 撤单，用户保证金率较低且有爆仓风险，导致挂单被撤回 `9`: 已撤单：扣除资金费用后可用余额不足，系统已撤回该订单 `13`: 已撤单：FOK 委托订单未完全成交，导致挂单被完全撤回 `14`: 已撤单：IOC 委托订单未完全成交，仅部分成交，导致部分挂单被撤回 `17`: 已撤单：平仓单被撤单，由于仓位已被市价全平 `20`: 系统倒计时撤单 `21`: 已撤单：相关仓位被完全平仓，系统已撤销该止盈止损订单 `22`, `23`: 已撤单：只减仓订单仅允许减少仓位数量，系统已撤销该订单

2023-02-17

新增接口
- 设置自动借币

2023-02-15

新增错误码

错误码	HTTP 状态码	错误提示
58127	200	主账户 API Key 不支持当前 type 划转类型参数，请参考 API 文档描述
58128	200	子账户 API Key 不支持当前 type 划转类型参数，请参考 API 文档描述

新增返回参数
- 获取成交明细（近三天）
- 获取成交明细（近三个月）

参数名	类型	描述
fillTime	String	成交时间，与订单频道的`fillTime`相同

2023-02-08

新增返回参数
- 充值信息频道

参数名	类型	描述
> fromWdId	String	内部转账发起者提币申请 ID 如果该笔充值来自于内部转账，则该参数展示内部转账发起者的提币申请 ID，其他情况返回""

新增返回参数
- 提币信息频道

参数名	类型	描述
> nonTradableAsset	String	是否为不可交易资产 `true`：不可交易资产，`false`：可交易资产
> feeCcy	String	提币手续费币种，如 `USDT`

2023-02-07

Websocket 关闭帧状态码和文案会有更新。
如果客户端程序未有处理 Websocket 的关闭帧状态代码编号，则可以忽略这次更改。
该变更将于 2023 年 2 月 15 日起在生产环境中生效。

2023-02-02

新增返回参数
- 查看账户配置

参数名	类型	描述
ip	String	绑定的ip地址，多个ip用半角逗号隔开，如：`117.37.203.58,117.37.203.57`。如果没有绑定ip，会返回空字符串""

新增接口：
- 获取用户的 Broker 返佣信息
- 获取用户的节点返佣信息

2023-02-01

获取资金流水type新增枚举值：

参数名	类型	描述
type	String	账单类型 `225`：鲨鱼鳍申购 `226`：鲨鱼鳍回款 `227`：鲨鱼鳍收益 `228`：鲨鱼鳍退款

2023-01-30

新增请求参数
- 取消报价单

请求参数

参数名	类型	是否必须	描述
rfqId	String	否	询价单ID

2023-01-19

新增推送频道：
- 充值信息频道
- 提币信息频道

2023-01-09

新增接口：
- 获取充值/提现的详细状态

2022-12-30

新增请求和返回参数
- 获取充值记录

请求参数

参数名	类型	是否必须	描述
fromWdId	String	否	内部转账发起者提币申请 ID 如果该笔充值来自于内部转账，则该参数展示内部转账发起者的提币申请 ID

返回参数

参数名	类型	描述
fromWdId	String	内部转账发起者提币申请 ID 如果该笔充值来自于内部转账，则该参数展示内部转账发起者的提币申请 ID

2022-12-28

K线时间粒度已经发生变动：
变动内容：为了更好的系统性能，以下接口和频道将不再支持这些K线时间粒度：6M, 1Y, 6Mutc, 1Yutc。
“产品频道”的推送逻辑已经发生变动：
变动内容：为了更好的系统性能，“产品频道”首次订阅将不再推送产品的全量数据，请您从“获取交易产品基础信息”接口查询全量数据，用“产品频道”接受更新。
新增接口
- 获取期权公共成交数据
- 期权公共成交频道

2022-12-23

新增 Fast API 功能模块
新增返回参数
- 查看账户配置

参数名	类型	描述
opAuth	String	是否开通期权交易 `0` 未开通，`1` 已经开通

2022-12-20

新增接口
- 开通期权交易
新增返回参数
- 获取未完成策略委托单列表
- 获取历史策略委托单列表

参数名	类型	描述
last	String	下单时的最新成交价

新增请求参数：

参数名	类型	是否必须	描述
quickMgnType	String	否	一键借币类型，仅适用于杠杆逐仓的一键借币模式： `manual`：手动，`auto_borrow`：自动借币，`auto_repay`：自动还币默认是`manual`：手动

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
baseBorrowed	String	交易币已借，适用于币币杠杆（逐仓一键借币模式）
baseInterest	String	交易币计息，适用于币币杠杆（逐仓一键借币模式）
quoteBorrowed	String	计价币已借，适用于币币杠杆（逐仓一键借币模式）
quoteInterest	String	计价币计息，适用于币币杠杆（逐仓一键借币模式）

新增返回参数

参数名	类型	描述
quickMgnType	String	一键借币类型，仅适用于杠杆逐仓的一键借币模式 `manual`：手动，`auto_borrow`：自动借币，`auto_repay`：自动还币

调整请求参数
- 调整保证金

调整前：

参数名	类型	是否必须	描述
type	String	是	增加/减少保证金 `add`：增加 `reduce`：减少
ccy	String	否	增加或减少的保证金的币种，仅适用于逐仓自主划转保证金模式下的币币杠杆

调整后：

参数名	类型	是否必须	描述
type	String	是	增加/减少保证金 `add`：增加，或者转入质押资产(一键借币) `reduce`：减少，或者转出质押资产（一键借币）
ccy	String	否	增加或减少的保证金的币种，仅适用于逐仓自主划转和一键借币模式下的币币杠杆

新增枚举值
- 查看账户配置

参数名	类型	描述
mgnIsoMode	String	quick_margin：一键借币（对于新的账户，包括新的子账户，有些默认是开仓划转，另外的默认是一键借币）

新增枚举值
- 逐仓交易设置

参数名	类型	描述
isoMode	String	quick_margin：一键借币

新增枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	是否必须	描述
type	String	否	账单类型 `15`: 一键借币
subType	String	否	账单子类型 `210`: 手动借币 `211`: 手动还币 `212`: 自动借币 `213`：自动还币" `16`：强制还币 `17`：强制借币还息

新增接口
- 一键借币模式手动借币还币
- 获取一键借币模式借币还币历史
新增错误码

错误码	HTTP 状态码	错误提示
59313	200	无法还币。在一键借币模式下，您目前没有 ${ccy} 借币（币对：${ccyPair}）
51152	200	一键借币模式下，不支持自动借币与自动还币和手动类型混合下单。

2022-12-15

新增返回参数
- 查看项目

参数名	类型	描述
state	String	项目状态 `purchasable`：可申购 `sold_out`：售罄 `stop`：暂停申购

新增请求和返回参数
- 申购项目

请求参数

参数名	类型	是否必须	描述
tag	String	否	订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间

返回参数

参数名	类型	描述
tag	String	订单标签

新增返回参数

参数名	类型	描述
tag	String	订单标签

新增返回参数
- 查看活跃订单

参数名	类型	描述
estSettlementTime	String	预估赎回到账时间
cancelRedemptionDeadline	String	撤销赎回申请截止时间
tag	String	订单标签

新增错误码

错误码	HTTP 状态码	错误提示
51732	200	用户KYC等级不符合要求
51733	200	用户被风险管理中
51734	200	不支持用户所属KYC国家
51735	200	不支持子帐户
51736	200	{ccy} 余额不足

新增返回参数
- 查看账户配置

参数名	类型	描述
roleType	String	用户角色。 `0`：普通用户；`1`：带单者；`2`：跟单者
traderInsts	String	当前账号已经设置的带单产品，仅适用于带单者

新增枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	是否必须	描述
type	String	否	账单类型 `18`: 分润
subType	String	否	账单子类型 `250`: 分润支出; `251`: 分润退还; `252`: 分润收入;

错误码	HTTP 状态码	错误提示
51156	200	您当前身份为带单交易员。在开平仓模式下，对于带单合约标的不支持使用该接口平仓
51159	200	您当前身份为带单交易员，在买卖模式下，如需使用该接口下单，委托的方向必须与现有持仓和挂单保持一致
51162	200	您当前有 {instrument} 挂单，请撤单后重试
51163	200	您当前有 {instrument} 持仓，请平仓后重试
51166	200	当前产品不支持带单
51321	200	您正在带单。暂不支持使用套利、冰山或时间加权 (TWAP) 策略带单
51322	200	您当前身份为带单交易员。您的带单合约持仓已经市价全平，系统已撤销止盈止损委托并进行平仓
51323	200	您当前身份为带单交易员。您的带单合约仓位已设置止盈止损，请先撤销原有止盈止损订单
51324	200	您当前身份为带单交易员，并持有 {instrument} 仓位。平仓委托张数需要与可平张数一致
51325	200	您当前身份为带单交易员。下止盈止损单时，请选择市价作为委托价格
59128	200	您当前身份为带单交易员。您设置的带单合约 {instrument} 杠杆倍数不能超过 {num}×
59216	200	仓位不存在，请稍后重试

2022-12-14

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
bizRefId	String	外部业务id，e.g. 体验券id
bizRefType	String	外部业务类型

新增返回参数
- 获取订单信息
- 获取历史订单记录（近七天）

参数名	类型	描述
cancelSource	String	订单取消来源的原因枚举值代码
cancelSourceReason	String	订单取消来源的对应具体原因

请求和返回参数变动
- 尊享借币还币

调整返回参数

调整前：

参数名	类型	描述
amt	String	借/还币的数量
loanQuota	String	借币限额
posLoan	String	当前账户负债占用（锁定额度内）
availLoan	String	当前账户剩余可用（锁定额度内）
usedLoan	String	当前账户已借额度

调整后：

参数名	类型	描述
amt	String	已借/还币的数量

新增请求参数

参数名	类型	是否必须	描述
ordId	String	可选	借币订单ID，还币时，该参数必填

新增返回参数

参数名	类型	描述
ordId	String	借币订单ID
state	String	订单状态 `1`:借币申请中 `2`:借币中 `3`:还币申请中 `4`:已还币 `5`:借币失败

新增返回参数
- 获取借币利率与限额

参数名	类型	描述
> avgRate	String	币种已借平均利率，仅适用于`尊享借币`

新增接口

2022-12-12

K线时间粒度将发生变动：
模拟盘变动日期：2022年12月15日；
实盘变动日期：2022年12月28日；
变动内容：为了更好的系统性能，以下接口和频道将不再支持这些K线时间粒度：6M, 1Y, 6Mutc, 1Yutc。

2022-12-09

新增接口
- 获取子账户提币记录

2022-12-08

新增返回参数
- 获取币种列表

参数名	类型	描述
depQuoteDailyLayer2	String	Layer2网络每日充值上限

新增请求和返回参数
- 询价

请求参数

参数名	类型	是否必须	描述
tag	String	否	询价单标签，与此询价单关联的大宗交易将有相同的标签。字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。
> posSide	String	否	持仓方向买卖模式下默认为`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则处于开平仓模式下的用户始终会开新仓位。仅适用交割、永续。

返回参数

参数名	类型	描述
> tag	String	询价单标签，与此询价单关联的大宗交易将有相同的标签。
>> posSide	String	持仓方向买卖模式下默认为`net`。如未指定，则返回""，相当于`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则返回""，对应于为交易开新仓位的方向（买入=>`long`，卖出=>`short`）。仅适用交割、永续。

新增请求和返回参数
- 报价

请求参数

参数名	类型	是否必须	描述
tag	String	否	报价单标签，与此报价单关联的大宗交易将有相同的标签。字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。
> posSide	String	否	持仓方向买卖模式下默认为`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则处于开平仓模式下的用户始终会开新仓位。仅适用交割、永续。

返回参数

参数名	类型	描述
> tag	String	报价单标签，与此报价单关联的大宗交易将有相同的标签。
>> posSide	String	持仓方向买卖模式下默认为`net`。如未指定，则返回""，相当于`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则返回""，对应于为交易开新仓位的方向（买入=>`long`，卖出=>`short`）。仅适用交割、永续。

新增返回参数
- 获取询价单信息

参数名	类型	描述
> tag	String	询价单标签，与此询价单关联的大宗交易将有相同的标签。
>> posSide	String	持仓方向买卖模式下默认为`net`。如未指定，则返回""，相当于`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则返回""，对应于为交易开新仓位的方向（买入=>`long`，卖出=>`short`）。仅适用交割、永续。

新增返回参数
- 获取报价单信息

参数名	类型	描述
> tag	String	报价单标签，与此报价单关联的大宗交易将有相同的标签。
>> posSide	String	持仓方向买卖模式下默认为`net`。如未指定，则返回""，相当于`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则返回""，对应于为交易开新仓位的方向（买入=>`long`，卖出=>`short`）。仅适用交割、永续。

新增返回参数
- 执行报价
- 获取大宗交易信息

参数名	类型	描述
> tag	String	交易标签，大宗交易将有与其对应的询价单或报价单相同的标签。

新增推送数据参数
- 询价频道

参数名	类型	描述
> tag	String	询价单标签，与此询价单关联的大宗交易将有相同的标签。
>> posSide	String	持仓方向买卖模式下默认为`net`。如未指定，则返回""，相当于`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则返回""，对应于为交易开新仓位的方向（买入=>`long`，卖出=>`short`）。仅适用交割、永续。

新增推送数据参数
- 报价频道

参数名	类型	描述
> tag	String	报价单标签，与此报价单关联的大宗交易将有相同的标签。
>> posSide	String	持仓方向买卖模式下默认为`net`。如未指定，则返回""，相当于`net`。在开平仓模式下仅可选择`long`或`short`。如未指定，则返回""，对应于为交易开新仓位的方向（买入=>`long`，卖出=>`short`）。仅适用交割、永续。

新增推送数据参数
- 大宗交易频道

参数名	类型	描述
> tag	String	交易标签，大宗交易将有与其对应的询价单或报价单相同的标签。

2022-12-06

“产品频道”的推送逻辑将发生变动：
模拟盘变动日期：2022年12月15日；
实盘变动日期：2022年12月28日；
变动内容：为了更好的系统性能，“产品频道”首次订阅将不再推送产品的全量数据，请您从“获取交易产品基础信息”接口查询全量数据，用“产品频道”接受更新。
只减仓订单逻辑优化已经上线实盘
- 上线之后，在下单和改单时，可能存在系统修改订单数量和撤销已有只减仓挂单的情况（视订单优先级排序而定，具体参考产品说明文档）
- 该优化适用于交割永续业务买卖模式下的只减仓订单
- 如果下单后系统修改了订单数量，可以在返回的sMsg中查看提示信息；
- 如果系统撤销了已有的只减仓挂单，orders 频道推送的 cancelSource 会是 22 或者 23。

2022-12-01

只减仓订单逻辑优化将于12月5日上线实盘
- 上线之后，在下单和改单时，可能存在系统修改订单数量和撤销已有只减仓挂单的情况（视订单优先级排序而定，具体参考产品说明文档）
- 该优化适用于交割永续业务买卖模式下的只减仓订单
- 如果下单后系统修改了订单数量，可以在返回的sMsg中查看提示信息；
- 如果系统撤销了已有的只减仓挂单，orders 频道推送的 cancelSource 会是 22 或者 23。
实盘已经调整“获取交易产品基础信息”接口和“产品频道”的返回参数。
会返回测试阶段的产品，且状态为 test。
调整返回参数

调整前：

参数名	类型	描述
sMsg	String	事件执行失败时的msg

调整后：

参数名	类型	描述
sMsg	String	事件执行失败或成功时的msg

新增接口
- 获取不可交易资产
新增返回参数
- 获取提币记录

参数名	类型	描述
nonTradableAsset	Boolean	是否为不可交易资产 `true`：不可交易资产，`false`：可交易资产
feeCcy	String	提币手续费币种，如 `USDT`

新增错误码

错误码	HTTP 状态码	错误提示
58125	200	不可交易资产仅支持子账户转母账户
58126	200	不可交易资产划转，只能在资金账户间互转
58127	200	不可交易资产提币只能全部提出
58128	200	不可交易资产提币要求APIKey必须绑定IP
58129	200	资金账户手续费不足 {fee} USDT

2022-11-30

新增接口
- 设置组合保证金账户风险对冲模式
- 获取可报价产品
新增返回参数
- 查看账户配置

参数名	类型	描述
label	String	当前请求API Key的备注名，不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。

新增perm枚举值
- 创建子账户的APIKey
- 重置子账户的APIKey

参数名	类型	描述
perm	String	API Key权限 `withdraw`：提币

新限速规则

调整限速规则

调整前：
* 限速规则：衍生品：UserID + (instrumentType + underlying)
* 限速规则：币币和币币杠杆：UserID + (instrumentType + instrumentID

调整后：
* 限速规则（期权以外）：UserID + Instrument ID
* 限速规则（只限期权）：UserID + Instrument Family

新增请求参数和参数必须性
- 策略委托下单

参数名	类型	是否必须	描述
sz	String	可选	委托数量 `sz`和`closeFraction`必填且只能填其一
closeFraction	String	可选	策略委托触发时，平仓的百分比。1 代表100% 现在系统只支持全部平仓，唯一接受参数为`1` 对于同一个仓位，仅支持一笔全部平仓的止盈止损挂单仅适用于`交割`或`永续` 仅适用于买卖模式 `posSide` = `net` 仅适用于减仓订单 `reduceOnly` = `true` 仅适用于止盈止损 `ordType` = `conditional` 或 `oco` 仅适用于止盈止损市价订单 `sz`和`closeFraction`必填且只能填其一

新增返回参数
- 获取未完成策略委托单列表
- 获取历史策略委托单列表

参数名	类型	描述
closeFraction	String	策略委托触发时，平仓的百分比

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
> closeOrderAlgo	Array	平仓策略委托订单
>> algoId	String	策略委托单ID
>> slTriggerPx	String	止损触发价
>> slTriggerPxType	String	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格
>> tpTriggerPx	String	止盈委托价
>> tpTriggerPxType	String	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格
>> closeFraction	String	策略委托触发时，平仓的百分比。1 代表100%

新增错误码

错误码	HTTP 状态码	错误提示
51327	200	closeFraction 仅适用于交割合约和永续合约
51328	200	closeFraction 仅适用于只减仓订单
51329	200	closeFraction 仅适用于买卖模式
51330	200	closeFraction 仅适用于止盈止损市价订单

新增请求参数：

参数名	类型	是否必须	描述
quickMgnType	String	否	一键借币类型，仅适用于杠杆逐仓的一键借币模式： `manual`：手动，`auto_borrow`：自动借币，`auto_repay`：自动还币默认是`manual`：手动

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
baseBorrowed	String	交易币已借，适用于币币杠杆（逐仓一键借币模式）
baseInterest	String	交易币计息，适用于币币杠杆（逐仓一键借币模式）
quoteBorrowed	String	计价币已借，适用于币币杠杆（逐仓一键借币模式）
quoteInterest	String	计价币计息，适用于币币杠杆（逐仓一键借币模式）

新增返回参数

参数名	类型	描述
quickMgnType	String	一键借币类型，仅适用于杠杆逐仓的一键借币模式 `manual`：手动，`auto_borrow`：自动借币，`auto_repay`：自动还币

调整请求参数
- 调整保证金

调整前：

参数名	类型	是否必须	描述
type	String	是	增加/减少保证金 `add`：增加 `reduce`：减少
ccy	String	否	增加或减少的保证金的币种，仅适用于逐仓自主划转保证金模式下的币币杠杆

调整后：

参数名	类型	是否必须	描述
type	String	是	增加/减少保证金 `add`：增加，或者转入质押资产(一键借币) `reduce`：减少，或者转出质押资产（一键借币）
ccy	String	否	增加或减少的保证金的币种，仅适用于逐仓自主划转和一键借币模式下的币币杠杆

新增枚举值
- 查看账户配置

参数名	类型	描述
mgnIsoMode	String	quick_margin：一键借币

新增枚举值
- 账单流水查询（近七天）
- 账单流水查询（近三月）

参数名	类型	是否必须	描述
type	String	否	账单类型 `15`: 一键借币
subType	String	否	账单子类型 `210`: 手动借币 `211`: 手动还币 `212`: 自动借币 `213`：自动还币" `16`：强制还币 `17`：强制借币还息

新增接口
- 一键借币模式手动借币还币
- 获取一键借币模式借币还币历史
新增错误码

错误码	HTTP 状态码	错误提示
59313	200	无法还币。在一键借币模式下，您目前没有 ${ccy} 借币（币对：${ccyPair}）
51152	200	一键借币模式下，不支持自动借币与自动还币和手动类型混合下单。

2022-11-29

请求和返回参数变动
- 尊享借币还币

调整返回参数

调整前：

参数名	类型	描述
amt	String	借/还币的数量

调整后：

参数名	类型	描述
amt	String	已借/还币的数量

新增请求参数

参数名	类型	是否必须	描述
ordId	String	可选	借币订单ID，还币时，该参数必填

新增返回参数

参数名	类型	描述
ordId	String	借币订单ID
state	String	订单状态 `1`:借币申请中 `2`:借币中 `3`:还币申请中 `4`:已还币 `5`:借币失败

新增返回参数
- 获取借币利率与限额

参数名	类型	描述
> avgRate	String	币种已借平均利率，仅适用于`尊享借币`

新增接口

2022-11-28

新增返回参数

参数名	类型	描述
confirm	String	K线状态 `0` 代表 K 线未完结，`1` 代表 K 线已完结。

新增接口
- 获取期权品种公共成交数据

2022-11-25

调整 Status 接口和 Status 频道的返回参数：
serviceType 新增枚举值 8：交易服务 (按账户分批次)；9：交易服务 (按产品分批次)

2022-11-24

新增请求参数
- 设置子账户的交易手续费费率

参数名	类型	是否必须	描述
mgnType	String	否	保证金类型 `1`：USDT本位 `2`：币本位适用于`交割/永续`

2022-11-21

最早将于2022年11月28日新增返回参数

参数名	类型	描述
confirm	String	K线状态 `0` 代表 K 线未完结，`1` 代表 K 线已完结。

新增请求参数
- 下单
- 批量下单

参数名	类型	是否必须	描述
tpTriggerPx	String	否	止盈触发价，如果填写此参数，必须填写止盈委托价
tpOrdPx	String	否	止盈委托价，如果填写此参数，必须填写止盈触发价委托价格为-1时，执行市价止盈
slTriggerPx	String	否	止损触发价，如果填写此参数，必须填写止损委托价
slOrdPx	String	否	止损委托价，如果填写此参数，必须填写止损触发价委托价格为-1时，执行市价止损
tpTriggerPxType	String	否	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
slTriggerPxType	String	否	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`

2022-11-11

新增请求参数
- 提币

参数名	类型	是否必须	描述
areaCode	String	可选	手机区号当`toAddr`为手机号时，该参数必填

新增返回参数
- 获取充值记录
- 获取子账户充值记录

参数名	类型	描述
areaCodeFrom	String	如果`from`为手机号，该参数为该手机号的区号

新增返回参数
- 获取提币记录

参数名	类型	描述
areaCodeFrom	String	如果`from`为手机号，该参数为该手机号的区号
areaCodeTo	String	如果`to`为手机号，该参数为该手机号的区号

2022-11-10

新增推送数据参数
- 订单频道

参数名	类型	描述
> cancelSource	String	订单取消的来源有效值及对应的含义是： `0`,`5`,`7`,`8`,`10`,`11`,`12`,`15`,`16`,`18`,`19`: 已撤单：系统撤单 `1`: 用户主动撤单 `2`: 已撤单：预减仓撤单，用户保证金不足导致挂单被撤回 `3`: 已撤单：风控撤单，用户保证金不足有爆仓风险，导致挂单被撤回 `4`: 已撤单：币种借币量达到平台硬顶，系统已撤回该订单 `6`: 已撤单：触发 ADL 撤单，用户保证金率较低且有爆仓风险，导致挂单被撤回 `9`: 已撤单：扣除资金费用后可用余额不足，系统已撤回该订单 `13`: 已撤单：FOK 委托订单未完全成交，导致挂单被完全撤回 `14`: 已撤单：IOC 委托订单未完全成交，仅部分成交，导致部分挂单被撤回 `17`: 已撤单：平仓单被撤单，由于仓位已被市价全平 `20`: 系统倒计时撤单

新增请求和返回参数
- 组合保证金的虚拟持仓保证金计算

请求参数

参数名	类型	是否必须	描述
spotOffsetType	String	否	现货对冲模式 1：现货对冲模式U模式 2：现货对冲模式币模式 3：衍生品模式默认是 3

返回参数

参数名	类型	描述
acctImr	String	账户维度的最低初始保证金
acctMmr	String	账户维度的维持保证金

2022-11-08

新增返回参数

参数名	类型	描述
volCcyQuote	String	交易量，以计价货币为单位如：BTC-USDT 和 BTC-USDT-SWAP, 单位均是 USDT； BTC-USD-SWAP 单位是 USD

2022-11-07

新增请求参数
- 获取返佣明细下载链接
- 生成返佣明细下载链接

参数名	类型	是否必须	描述
brokerType	String	可选	经纪商类型 `api`：API经纪商 `oauth`：Oauth经纪商当经纪商只有一种类型时，该参数可以不填当经纪商有多种类型时，该参数必填

新增错误码

错误码	HTTP 状态码	错误提示
50044	200	必须指定一种broker类型

2022-11-01

最早将于2022年11月8日新增返回参数

参数名	类型	描述
volCcyQuote	String	交易量，以计价货币为单位如：BTC-USDT 和 BTC-USDT-SWAP, 单位均是 USDT； BTC-USD-SWAP 单位是 USD

2022-10-28

新增请求参数
- 获取大宗交易信息

参数名	类型	是否必须	描述
beginTs	String	否	用开始时间戳筛选交易执行时间（UTC时区）。Unix时间戳的毫秒数格式，例如 1597026383085。
endTs	String	否	用结束时间戳筛选交易执行时间（UTC时区）。Unix时间戳的毫秒数格式，例如 1597026383085。

新增错误码

错误码	HTTP 状态码	错误提示
70010	200	时间戳参数必须是Unix时间戳的毫秒格式
70013	200	endTs必须大于等于beginTs
70016	200	交易产品设置中需选择至少一个交易品种

2022-10-27

新增参数
- 获取历史订单记录（近七天）
- 获取历史订单记录（近三个月）

参数名	类型	是否必须	描述
begin	String	否	筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
end	String	否	筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085

使用begin end进行时间筛选的规则如下：
1. 返回结果包含begin end传参；
2. begin end同时存在时，靠近end返回；
3. begin或end和after或 before同时存在时，接口会先使用begin或end进行筛选，然后使用after或before在进行分页。

2022-10-20

实盘已经调整“获取交易产品基础信息”接口和“产品频道”的返回参数。
会返回预开盘阶段的币对，且产品状态为预上线 (preopen)。
新增返回参数

参数名	类型	描述
reduceOnly	String	是否只减仓，true 或 false

K线相关频道推送频率变更

调整前：推送频率最快是间隔500ms推送一次数据。
调整后：推送频率最快是间隔1秒推送一次数据。

调整 Status 接口和 Status 频道的返回参数：
serviceType 新增枚举值 6：大宗交易
新增接口
- 获取产品轻量深度

2022-10-19

实盘最早将于10月20日，调整“获取交易产品基础信息”接口和“产品频道”的返回字段。
调整之后，会返回预开盘阶段的币对，且产品状态为预上线 (preopen)。

2022-10-14

新增参数
- 获取交易产品基础信息

参数名	类型	描述
instFamily	String	交易品种适用于`交割/永续/期权`

新增请求参数

参数名	类型	是否必须	描述
instFamily	String	否	交易品种适用于`交割/永续/期权`

新增请求和返回参数
- 获取衍生品仓位档位

请求参数：

参数名	类型	是否必须	描述
instFamily	String	可选	交易品种，如BTC-USDT，支持多个查询（不超过5个），instFamily之间半角逗号分隔适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

返回参数：

参数名	类型	描述
instFamily	String	交易品种适用于`交割/永续/期权`

新增请求和返回参数
- 获取风险准备金余额

请求参数：

参数名	类型	是否必须	描述
instFamily	String	可选	交易品种适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

返回参数：

参数名	类型	描述
instFamily	String	交易品种适用于`交割/永续/期权`

新增请求参数
- 获取平台公共爆仓单信息

参数名	类型	是否必须	描述
instFamily	String	可选	交易品种适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

调整请求参数
- 设置可报价产品

调整前：

参数名	类型	是否必须	描述
> uly	String	可选	标的指数

调整后：

参数名	类型	是否必须	描述
> instFamily	String	可选	交易品种适用于`交割/永续/期权`

调整请求参数
- 获取组合保证金模式全仓限制

调整前：

参数名	类型	是否必须	描述
uly	String	是	标的指数，如BTC-USDT，支持多个查询（不超过3个），uly之间半角逗号分隔

调整后：

参数名	类型	是否必须	描述
uly	String	可选	标的指数，如BTC-USDT，支持多个查询（不超过3个），uly之间半角逗号分隔 `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主
instFamily	String	可选	交易品种，如BTC-USDT，支持多个查询（不超过5个），instFamily之间半角逗号分隔适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

调整请求参数
- 获取期权定价
- 获取交割和行权记录

调整前：

参数名	类型	是否必须	描述
uly	String	是	标的指数

调整后：

参数名	类型	是否必须	描述
uly	String	可选	标的指数 `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主
instFamily	String	可选	交易品种适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

调整请求参数

调整前：

参数	类型	描述
> uly	String	标的指数

调整后：

参数	类型	描述
> instFamily	String	交易品种适用于`交割/永续/期权`

新增返回参数
- 产品频道

参数名	类型	描述
> instFamily	String	交易品种适用于`交割/永续/期权`

2022-10-13

新增返回参数
- 资金费率频道

参数名	类型	描述
> nextFundingTime	String	下一期资金费时间，Unix时间戳的毫秒数格式，如 `1622851200000`

2022-10-10

新增请求参数
- 询价

参数名	类型	是否必须	描述
allowPartialExecution	Boolean	否	RFQ是否可以被部分执行，如果腿的比例和原RFQ一致。有效值为`true`或`false`。默认为`false`。

新增请求参数
- 执行报价

参数名	类型	是否必须	描述
legs	Array of objects	否	用于部分执行的腿的数量。腿的数量比例必须与原RFQ相同。注意：每条腿的`tgtCcy`和`side`和原RFQ一致，`px`和对应Quote一致。
> instId	String	是	产品ID, 如 "BTC-USDT-SWAP".
> sz	String	是	该条腿的部分执行数量

新增请求参数
- 设置报价产品

参数名	类型	是否必须	描述
includeAll	Boolean	否	是否接收该instType下所有产品。有效值为`true`或`false`。默认`false`。

新增返回参数
- 询价
- 获取询价单
- Rfqs频道
  返回参数:

参数名	类型	描述
allowPartialExecution	Boolean	RFQ是否可以被部分执行，如果腿的比例和原RFQ一致。有效值为`true`或`false`。默认为`false`。

新增错误码

错误提示	错误码
交易产品设置中需选择至少一个交易品种	70013
不允许对所有产品类别设置includeAll=True	70014
全现货的RFQ总价值应该大于最小名义值{spotMinNotional}	70108
执行腿的价值总和小于大宗交易的最小名义值	70503
腿的数量比例与原RFQ不一致	70506
部分执行尝试失败。须设置allowPartialExecution为`true`	70507

2022-10-10

新增请求参数
- 获取充值记录
- 获取子账户充值记录

参数名	类型	是否必须	描述
type	String	否	充值方式 `3`：内部转账 `4`：链上充值

新增请求和返回参数
- 获取提币记录

请求参数：

参数名	类型	是否必须	描述
type	String	否	提币方式 `3`：内部转账 `4`：链上提币

返回参数：

参数名	类型	描述
addrEx	Object	提币地址备注，部分币种提币需要，若不需要则不返回此参数。如币种TONCOIN的提币地址备注标签名为comment,则该参数返回：{'comment':'123456'}

2022-09-28

新增参数
- 获取交易产品基础信息

参数名	类型	描述
instFamily	String	交易品种适用于`交割/永续/期权`

新增请求参数

参数名	类型	是否必须	描述
instFamily	String	否	交易品种适用于`交割/永续/期权`

新增请求和返回参数
- 获取衍生品仓位档位

请求参数：

参数名	类型	是否必须	描述
instFamily	String	可选	交易品种，如BTC-USDT，支持多个查询（不超过5个），instFamily之间半角逗号分隔适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

返回参数：

参数名	类型	描述
instFamily	String	交易品种适用于`交割/永续/期权`

新增请求和返回参数
- 获取风险准备金余额

请求参数：

参数名	类型	是否必须	描述
instFamily	String	可选	交易品种适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

返回参数：

参数名	类型	描述
instFamily	String	交易品种适用于`交割/永续/期权`

新增请求参数
- 获取平台公共爆仓单信息

参数名	类型	是否必须	描述
instFamily	String	可选	交易品种适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

调整请求参数
- 设置可报价产品

调整前：

参数名	类型	是否必须	描述
> uly	String	可选	标的指数

调整后：

参数名	类型	是否必须	描述
> instFamily	String	可选	交易品种适用于`交割/永续/期权`

调整请求参数
- 获取组合保证金模式全仓限制

调整前：

参数名	类型	是否必须	描述
uly	String	是	标的指数，如BTC-USDT，支持多个查询（不超过3个），uly之间半角逗号分隔

调整后：

参数名	类型	是否必须	描述
uly	String	可选	标的指数，如BTC-USDT，支持多个查询（不超过3个），uly之间半角逗号分隔 `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主
instFamily	String	可选	交易品种，如BTC-USDT，支持多个查询（不超过5个），instFamily之间半角逗号分隔适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

调整请求参数
- 获取期权定价
- 获取交割和行权记录

调整前：

参数名	类型	是否必须	描述
uly	String	是	标的指数

调整后：

参数名	类型	是否必须	描述
uly	String	可选	标的指数 `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主
instFamily	String	可选	交易品种适用于`交割/永续/期权` `uly`与`instFamily`必须传一个,若传两个，以`instFamily`为主

调整请求参数

调整前：

参数	类型	描述
> uly	String	标的指数

调整后：

参数	类型	描述
> instFamily	String	交易品种适用于`交割/永续/期权`

新增返回参数
- 产品频道

参数名	类型	描述
> instFamily	String	交易品种适用于`交割/永续/期权`

2022-09-22

新增接口
- 获取指数历史K线数据
- 获取标记价格历史K线数据

2022-09-08

实盘已经调整“获取当前账户交易手续费费率”接口的返回参数：

调整前：

参数名	类型	描述
taker	String	吃单手续费率，永续和交割合约时，为币本位合约费率
maker	String	挂单手续费率，永续和交割合约时，为币本位合约费率
takerU	String	U本位合约吃单手续费率，仅适用于`交割/永续`
makerU	String	U本位合约挂单手续费率，仅适用于`交割/永续`

调整后：

参数名	类型	描述
taker	String	USDT&USDⓈ&Crypto 交易区的吃单手续费率，永续和交割合约时，为币本位合约费率
maker	String	USDT&USDⓈ&Crypto 交易区挂单手续费率，永续和交割合约时，为币本位合约费率
takerU	String	USDT 合约吃单手续费率，仅适用于`交割/永续`
makerU	String	USDT 合约挂单手续费率，仅适用于`交割/永续`
takerUSDC	String	USDC 交易区的吃单手续费率
makerUSDC	String	USDC 交易区的挂单手续费率

新增参数

参数名	类型	描述
clOrdId	String	客户自定义订单ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。

2022-09-06

新增返回参数
- 获取币种列表

参数名	类型	描述
depQuotaFixed	String	充币固定限额，单位为`BTC` 没有充币限制则返回""
usedDepQuotaFixed	String	已用充币固定额度，单位为`BTC` 没有充币限制则返回""

实盘最早将于9月8日，调整“获取当前账户交易手续费费率”接口的返回参数：

调整前：

参数名	类型	描述
taker	String	吃单手续费率，永续和交割合约时，为币本位合约费率
maker	String	挂单手续费率，永续和交割合约时，为币本位合约费率
takerU	String	U本位合约吃单手续费率，仅适用于`交割/永续`
makerU	String	U本位合约挂单手续费率，仅适用于`交割/永续`

调整后：

参数名	类型	描述
taker	String	USDT&USDⓈ&Crypto 交易区的吃单手续费率，永续和交割合约时，为币本位合约费率
maker	String	USDT&USDⓈ&Crypto 交易区挂单手续费率，永续和交割合约时，为币本位合约费率
takerU	String	USDT 合约吃单手续费率，仅适用于`交割/永续`
makerU	String	USDT 合约挂单手续费率，仅适用于`交割/永续`
takerUSDC	String	USDC 交易区的吃单手续费率
makerUSDC	String	USDC 交易区的挂单手续费率

2022-09-05

为CSV文件新增参数
- 获取返佣明细下载链接

参数名	描述
affiliated	是否有节点关系, `true` 或 `false`

2022-09-01

新增接口
- 重设MMP状态
新增请求参数
- 设置可报价产品

参数名	类型	描述
> maxBlockSz	String	该种产品最大可交易数量。FUTURES, OPTION and SWAP 的单位是合约数量。SPOT的单位是交易货币。
> makerPxBand	String	价格限制以价格精度tick为单位，以标记价格为参考。设置makerPxBand为1个tick代表: 如果买一价 > 标记价格 + 1 tick, 操作将被拦截如果买一价 < 标记价格 - 1 tick, 操作将被拦截

新增返回参数

参数名	类型	描述
> reason	String	状态原因. 有效值包括 `mmp_canceled`.

新增请求和返回参数
- 市价仓位全平

参数名	类型	描述
clOrdId	String	客户自定义ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。

网格交易新增algoOrdType枚举值

参数	类型	描述
algoOrdType	String	`moon_grid`: 天地网格

新增频道
- 天地网格策略委托订单频道
新增错误码

错误提示	HTTP 状态码	错误码
MMP状态下操作失败。冻结时间为 {0} 秒	200	70008
同一个instType{1}下的instFamily/instId{0} 存在重复设置	200	70012
instId {0} 报价不可以超过你预设的价格限制	200	70310

2022-08-29

最早将于2022年9月1日新增请求和返回参数
- 市价仓位全平

参数名	类型	描述
clOrdId	String	客户自定义ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。

调整设置子账户的交易手续费费率返回参数：

调整前：

参数名	类型	是否必须	描述
chgTaker	String	可选	Taker手续费加点 `固定加点`：单位`bp`(1bp = 0.01%)，范围【0.1bp，1,000bp】，即【0.001%，10%】，精度为`0.1bp` `百分比加点`：单位`%`范围【1%，1,0000%】，精度为`1%`
chgMaker	String	可选	Maker手续费加点 `固定加点`：单位`bp`(1bp = 0.01%)，范围【0.1bp，1,000bp】，即【0.001%，10%】，精度为`0.1bp` `百分比加点`：单位`%`范围【1%，1,0000%】，精度为`1%` chgTaker和chgMaker必须填写一个

调整后：

参数名	类型	是否必须	描述
chgTaker	String	可选	Taker手续费加点 `固定加点`：单位`bp`(1bp = 0.01%)，范围【0.0bp，1,000bp】，即【0.00%，10%】，精度为`0.1bp` `百分比加点`：单位`%`范围【0%，1,0000%】，精度为`1%`
chgMaker	String	可选	Maker手续费加点 `固定加点`：单位`bp`(1bp = 0.01%)，范围【0.0bp，1,000bp】，即【0.00%，10%】，精度为`0.1bp` `百分比加点`：单位`%`范围【0%，1,0000%】，精度为`1%` chgTaker和chgMaker必须填写一个

2022-08-26

新增请求和返回参数
- 市价仓位全平

参数名	类型	描述
tag	String	订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。

新增错误码

错误提示	HTTP 状态码	错误码
询价数量不能低于下限	200	52917
询价数量不能超过上限	200	52918
闪兑交易参数{param}与报价不一致	200	52919
闪兑交易数量不能超过报价数量	200	52920
报价已交易，请重新询价	200	52921
报价已过期，请重新询价	200	52922
服务异常，请稍后重试	200	52923

2022-08-25

错误提示	HTTP 状态码	错误码
下单失败，现货交易仅支持设置最新价为触发价格，请更改触发价格并重试	200	51415

2022-08-24

新增请求参数
- 获取最大可用余额/保证金
- 获取最大可下单数量

参数名	类型	是否必须	描述
unSpotOffset	Boolean	否	`true`：禁止现货对冲，`false`：允许现货对冲默认为`false` 仅适用于`组合保证金模式` 开启现货对冲模式下有效，否则忽略此参数。

新增返回参数
- 查看账户最大可转余额

参数名	类型	描述
spotOffsetMaxWd	String	现货对冲不支持借币最大可转数量仅适用于`组合保证金模式`
spotOffsetMaxWdEx	String	现货对冲支持借币的最大可转数量仅适用于`组合保证金模式`

新增返回参数
- 查看账户配置

参数名	类型	描述
spotOffsetType	String	现货对冲类型 `1`：现货对冲模式U模式 `2`：现货对冲模式币模式 `3`：非现货对冲模式适用于`组合保证金模式`

新增请求参数
- 资金划转
- 子账户间资金划转

参数名	类型	是否必须	描述
omitPosRisk	String	否	是否忽略仓位风险默认为`false` 仅适用于`组合保证金模式`

新增返回参数
- 查看账户余额
- 账户频道

参数名	类型	描述
> spotInUseAmt	String	现货对冲占用数量适用于`组合保证金模式`

新增返回参数
- 查看持仓信息
- 持仓频道

参数名	类型	描述
> spotInUseAmt	String	现货对冲占用数量适用于`组合保证金模式`
> spotInUseCcy	String	现货对冲占用币种，如 `BTC` 适用于`组合保证金模式`

新增错误码

错误提示	HTTP 状态码	错误码
此次划转将导致您的仓位风险水平较高，进而可能引起爆仓。您需要重新调整划转金额，确保仓位处于安全水平后，再进行划转操作。	200	58121
您的一部分现货正用于仓位间的 Delta 对冲，若划转数量超过可用金额，可能会影响现有的现货对冲结构，进而导致维持保证金率增加，请留意您的风险水平。	200	58122

2022-08-15

新增返回参数
- 创建子账户

参数名	类型	描述
uid	String	账户ID

调整重置子账户的APIKey 返回参数：

调整前：

参数名	类型	是否必须	描述
label	String	是	API Key的备注，如果填写该参数，那该参数会被重置不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。
perm	String	是	API Key权限 `read_only`：读取 `trade`：交易多个权限用半角逗号隔开。如果填写该参数，那该参数会被重置。

调整后：

参数名	类型	是否必须	描述
label	String	否	API Key的备注，如果填写该参数，那该参数会被重置不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。
perm	String	否	API Key权限 `read_only`: 读取 `trade`: 交易多个权限用半角逗号隔开。如果填写该参数，那该参数会被重置。

2022-08-10

新增接口
- 设置可报价产品
新增错误码

错误提示	HTTP 状态码	错误码
该产品类型 {0} 的标的指数 {0} 不存在	200	70007
Data数组必须至少含有一个有效元素	200	70009
产品类型 {0} 存在重复设置	200	70011
所选产品无有效对手方	200	70109

2022-08-03

新增错误码

错误提示	HTTP 状态码	错误码
提币地址需要标签	200	58221
提币地址不合法	200	58222
该类型币种暂不支持链上提币到 OKX 地址，请通过内部转账进行提币	200	58224

2022-08-02

新增赚币功能模块

2022-07-25

新增请求参数
- 查看历史持仓信息

参数名	类型	是否必须	描述
posId	String	否	持仓ID

2022-07-22

新增接口
- 重置子账户的APIKey

2022-07-18

新增交易时效性功能模块

2022-07-15

新增接口
- 调整保证金计算
- 调整保证金
新增返回参数
- 获取网格策略委托子订单信息
- 网格策略子订单频道

参数名	类型	描述
tag	String	订单标签

2022-07-11

调整获取交易产品公共历史成交数据

调整前：

参数名	类型	是否必须	描述
after	String	否	请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的 tradeId
before	String	否	请求此ID之后（更新的数据）的分页内容，传的值为对应接口的 tradeId

调整后：

参数名	类型	是否必须	描述
type	String	否	分页类型 `1`：tradeId 分页 `2`：时间戳分页默认为`1`：tradeId 分页
after	String	否	请求此 ID 或 ts 之前的分页内容，传的值为对应接口的 tradeId 或 ts
before	String	否	请求此ID之后（更新的数据）的分页内容，传的值为对应接口的 tradeId。不支持时间戳分页。

2022-07-01

新增接口
- 获取组合保证金模式全仓限制
- 网格策略智能回测（公共）

2022-06-30

报价接口新增请求参数 anonymous 和 expiresIn
新增返回参数
- 获取币种列表

参数名	类型	描述
minDep	String	币种单笔最小充值量
needTag	Boolean	当前链提币是否需要标签（tag/memo）信息
minDepArrivalConfirm	String	充值到账最小网络确认数
minWdUnlockConfirm	String	提现解锁最小网络确认数

新增返回参数
- 获取充值记录
- 获取子账户充值记录

参数名	类型	描述
actualDepBlkConfirm	String	最新的充币网络确认数

2022-06-24

新增接口
- 获取子账户资金账户余额
调整获取衍生品仓位档位的请求参数：

调整前：

参数名	类型	是否必须	描述
uly	String	可选	标的指数，当产品类型是永续、交割、期权之一时必填，当产品类型是 MARGIN 时忽略
instId	String	可选	产品ID，仅适用币币杠杆，且必填写

调整后：

参数名	类型	是否必须	描述
uly	String	可选	标的指数，支持多uly，半角逗号分隔，最大不超过3个当产品类型是 `永续`、`交割`、`期权` 之一时必填，当产品类型是 `MARGIN` 时忽略
instId	String	可选	产品ID，支持多instId，半角逗号分隔，最大不超过5个仅适用`币币杠杆`，且必填写

2022-06-23

实盘已调整获取历史仓位信息的返回参数：

调整前：

参数名	类型	描述
type	String	平仓类型 `partClose`：部分平仓;`allClose`：完全平仓; 状态叠加时，以最新的平仓类型为准状态为准。
posSide	String	持仓方向 `long`：多 `short`：空仅适用于 `币币杠杆/交割/永续/期权`

调整后：

参数名	类型	描述
type	String	平仓类型 `1`：部分平仓;`2`：完全平仓;`3`：强平;`4`：强减; `5`：ADL自动减仓; 状态叠加时，以最新的平仓类型为准状态为准。
direction	String	持仓方向 `long`：多 `short`：空仅适用于 `币币杠杆/交割/永续/期权`

2022-06-20

调整 Status 请求和返回参数：

请求参数调整前：

参数名	类型	是否必须	描述
state	String	No	系统的状态，`scheduled`:等待中 ; `ongoing`:进行中 ; `completed`:已完成 `canceled`: 已取消不填写此参数，默认返回等待中和进行中的数据

请求参数调整后：

参数名	类型	是否必须	描述
state	String	No	系统的状态，`scheduled`:等待中 ; `ongoing`:进行中 ; `pre_open`:预开放；`completed`:已完成 `canceled`: 已取消当维护时间过长，会存在预开放时间，一般持续10分钟左右。不填写此参数，默认返回等待中、进行中和预开放的数据

返回参数调整前：

参数名	类型	描述
end	String	系统维护的结束时间，Unix时间戳的毫秒数格式如：`1617788463867` 在维护完成前，是预期结束时间；维护完成后，会变更为实际结束时间。
serviceType	String	服务类型， `0`：WebSocket ; `5`：交易服务

返回参数调整后：

参数名	类型	描述
end	String	交易全面开放的时间，Unix时间戳的毫秒数格式如：`1617788463867` 在维护完成前，是预期结束时间；维护完成后，会变更为实际结束时间。
preOpenBegin	String	预开放开始的时间，开放撤单、Post Only 下单和资金转入功能的时间
serviceType	String	服务类型， `0`：WebSocket ; `5`：交易服务；`99`：其他（如：停止部分产品交易）

调整 Status 频道推送数据参数：

调整前：

参数名	类型	描述
> end	String	系统维护的结束时间，Unix时间戳的毫秒数格式如：`1617788463867` 在维护完成前，是预期结束时间；维护完成后，会变更为实际结束时间。
> serviceType	String	服务类型， `0`：WebSocket ; `5`：交易服务

调整后：

参数名	类型	描述
> end	String	交易全面开放的时间，Unix时间戳的毫秒数格式如：`1617788463867` 在维护完成前，是预期结束时间；维护完成后，会变更为实际结束时间。
> preOpenBegin	String	预开放开始的时间，开放撤单、Post Only 下单和资金转入功能的时间
> serviceType	String	服务类型， `0`：WebSocket ; `5`：交易服务；`99`：其他（如：停止部分产品交易）

2022-06-16

移除请求参数acctLv：
- 创建子账户

2022-06-14

实盘最早将于6月16日，调整获取历史仓位信息返回参数：

调整前：

参数名	类型	描述
type	String	平仓类型 `partClose`：部分平仓;`allClose`：完全平仓; 状态叠加时，以最新的平仓类型为准状态为准。
posSide	String	持仓方向 `long`：多 `short`：空仅适用于 `币币杠杆/交割/永续/期权`

调整后：

参数名	类型	描述
type	String	平仓类型 `1`：部分平仓;`2`：完全平仓;`3`：强平;`4`：强减; `5`：ADL自动减仓; 状态叠加时，以最新的平仓类型为准状态为准。
direction	String	持仓方向 `long`：多 `short`：空仅适用于 `币币杠杆/交割/永续/期权`

2022-06-10

错误提示	HTTP 状态码	错误码
组合保证金模式暂不支持合约网格	200	51055
当前策略不支持该操作	200	51056
当前账户模式暂不支持此交易策略，请前往“交易设置 > 账户模式”进行切换	200	51057
该策略无仓位	200	51058
策略当前状态不支持此操作	200	51059
投入保证金需大于{0}{1}	200	51340
当前策略状态下暂不支持平仓	200	51341
已有平仓单，请稍后重试	200	51342
止盈价格需小于区间最低价格	200	51343
止损价格需大于区间最高价格	200	51344
策略类型不是网格策略	200	51345
最高价格不能低于最低价格	200	51346
暂无可提取利润	200	51347
止损价格需小于区间最低价格	200	51348
止盈价格需大于区间最高价格	200	51349
单格收益必须大于0	200	51351

新增接口

2022-06-09

大宗交易上线实盘
调整创建子账户请求参数：

调整前：

参数名	类型	是否必须	描述
label	String	否	子账户的备注

调整后：

参数名	类型	是否必须	描述
label	String	否	子账户的备注不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。

调整创建子账户的APIKey 请求参数：

调整前：

参数名	类型	是否必须	描述
label	String	是	APIKey的备注

调整后：

参数名	类型	是否必须	描述
label	String	是	APIKey的备注不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。

调整重置子账户的APIKey 请求参数：

调整前：

参数名	类型	是否必须	描述
label	String	是	APIKey的备注

调整后：

参数名	类型	是否必须	描述
label	String	是	APIKey的备注不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。

2022-06-07

实盘已上线以下接口功能：
- 所有的ND子账户默认有主动转出权限，设置子账户主动转出权限接口将不再支持给ND子账户设置主动转出权限。

2022-06-01

以下接口功能，最早将于2022年6月6日上线实盘：
- 所有的ND子账户默认有主动转出权限，设置子账户主动转出权限接口将不再支持给ND子账户设置主动转出权限。

2022-05-26

新增参数

参数名	类型	是否必须	描述
banAmend	Boolean	否	是否禁止币币市价改单，true 或 false，默认false 为true时，余额不足时，系统不会改单，下单会失败，仅适用于币币市价单

新增接口
- 获取交易产品公共历史成交数据

2022-05-23

大宗交易功能已上线模拟盘
- REST API 参考这里
- WebSocket 参考私有频道 and 公共频道

2022-05-20

新增参数

参数名	类型	是否必须	描述
begin	String	否	筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
end	String	否	筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085

2022-05-19

FD Broker 新增接口：
- 生成返佣明细下载链接
- 获取返佣明细下载链接
“Tickers行情频道”的推送逻辑发生了如下变动：
- 对于没有发生成交的币对和合约，会出现last为空字符串的情况，常见于新上线的币对和合约（尤其是期权合约）。
实盘新增如下功能：
- book5深度频道由每"200"毫秒有深度变化推送一次5档数据调整为每"100"毫秒有深度变化推送一次5档数据

2022-05-18

调整创建子账户的APIKey 请求参数：

调整前：

参数名	类型	是否必须	描述
passphrase	String	是	APIKey的密码，6-32位小写字母数字组合，及至少包含一个大写字母或特殊字符
ip	String	是	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip

调整后：

参数名	类型	是否必须	描述
passphrase	String	是	APIKey的密码，8-32位字母数字组合，至少包含一个数字、一个大写字母、一个小写字母、一个特殊字符
ip	String	可选	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip 如果子账户APIKey拥有交易权限，必须绑定IP地址

调整重置子账户的APIKey 请求参数：

调整前：

参数名	类型	是否必须	描述
ip	String	否	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip

调整后：

参数名	类型	是否必须	描述
ip	String	否	绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip 如果子账户APIKey拥有交易权限，必须绑定IP地址

2022-05-13

新增参数

参数名	类型	描述
clientId	String	客户自定义ID 字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。

2022-05-07

“Tickers行情频道”的推送逻辑将于2022年5月12日发生如下变动：
- 对于没有发生成交的币对和合约，会出现last为空字符串的情况，常见于新上线的币对和合约（尤其是期权合约）。
实盘“获取当前账户交易手续费费率”接口发生如下变动：
- category参数被废弃，但是不影响现有的程序调用，请求时category传值与不传值均返回一样的数据。
- 新增返回参数takerU和makerU，代表交割合约和永续合约下U本位合约的费率，当查询交割合约和永续合约的手续费费率时，原有参数taker和maker的含义发生变化，仅代表币本位。

详情请参考：关于“获取当前账户交易手续费费率”接口调整的公告

2022-05-05

实盘新增如下功能：
- 新增bbo-tbt实时推送买卖1档的深度频道。
- book5深度频道由每"200"毫秒有深度变化推送一次5档数据调整为每"100"毫秒有深度变化推送一次5档数据将在两周内上线。
- books-l2-tbt400档深度频道，只允许交易手续费等级VIP5及以上的API用户订阅。此更改仅影响WebSocket API用户，详细内容如下：
- books50-l2-tbt50档深度频道，只允许交易手续费等级VIP4及以上的API用户订阅。此更改仅影响WebSocket API用户，详细内容如下：

深度频道	更新前	更新后
bbo-tbt	无	1、新增bbo深度频道，实时推送买卖1档深度数据 2、所有API用户均可订阅 3、公共深度频道，无需身份验证
books-l2-tbt	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、仅手续费等级达到VIP5及以上的用户可以订阅 2、该TBT深度频道需要身份验证后才可订阅，身份认证参考登录功能
books50-l2-tbt	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、仅手续费等级达到VIP4及以上的用户可以订阅 2、该TBT深度频道需要身份验证后才可订阅，身份认证参考登录功能
books	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	无更新
books5	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	无更新从每"200"毫秒调整为每"100"毫秒,有深度变化推送一次的变动`将在两周内上线`

新增接口
- 设置子账户主动转出权限
新增请求参数type的枚举值3和4
- 资金划转

参数名	类型	是否必须	描述
type	String	否	`3`：子账户转母账户(仅适用于子账户APIKey) `4`：子账户转子账户(仅适用于子账户APIKey，且目标账户需要是同一母账户下的其他子账户)

新增返回参数
- 查看子账户列表

参数名	类型	描述
canTransOut	Boolean	是否可以主动转出 `false`：不可转出 `true`：可以转出

新增错误码

错误消息	错误码
{0} 子账户没有转出权限，请先设置	58119

2022-04-28

新增返回参数
- 获取交易产品基础信息

参数名	类型	描述
> maxLmtSz	String	合约或现货限价单的单笔最大委托数量
> maxMktSz	String	合约或现货市价单的单笔最大委托数量
> maxTwapSz	String	合约或现货时间加权单的单笔最大委托数量
> maxIcebergSz	String	合约或现货冰山委托的单笔最大委托数量
> maxTriggerSz	String	合约或现货计划委托委托的单笔最大委托数量
> maxStopSz	String	合约或现货止盈止损委托的单笔最大委托数量

WebSocket 频道新增订阅枚举值和推送参数
- 产品频道

参数名	类型	是否必须	描述
op	String	是	操作，`subscribe` `unsubscribe`
args	Array	是	请求订阅的频道列表
> channel	String	是	频道名 `instruments`
> instType	String	是	产品类型 `MARGIN`：币币杠杆

参数名	类型	描述
> maxLmtSz	String	合约或现货限价单的单笔最大委托数量
> maxMktSz	String	合约或现货市价单的单笔最大委托数量
> maxTwapSz	String	合约或现货时间加权单的单笔最大委托数量
> maxIcebergSz	String	合约或现货冰山委托的单笔最大委托数量
> maxTriggerSz	String	合约或现货计划委托委托的单笔最大委托数量
> maxStopSz	String	合约或现货止盈止损委托的单笔最大委托数量

2022-04-26

新增返回参数
- 获取币种列表

参数名	类型	描述
logoLink	String	币种Logo链接

2022-04-25

模拟盘新增如下功能，最早将于2022年5月5日上线实盘：
- 新增bbo-tbt实时推送买卖1档的深度频道。
- book5深度频道由每"200"毫秒有深度变化推送一次5档数据调整为每"100"毫秒有深度变化推送一次5档数据
- books-l2-tbt400档深度频道，只允许交易手续费等级VIP5及以上的API用户订阅。此更改仅影响WebSocket API用户，详细内容如下：
- books50-l2-tbt50档深度频道，只允许交易手续费等级VIP4及以上的API用户订阅。此更改仅影响WebSocket API用户，详细内容如下：

深度频道	更新前	更新后
bbo-tbt	无	1、新增bbo深度频道，实时推送买卖1档深度数据 2、所有API用户均可订阅 3、公共深度频道，无需身份验证
books-l2-tbt	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、仅手续费等级达到VIP5及以上的用户可以订阅 2、该TBT深度频道需要身份验证后才可订阅，身份认证参考登录功能
books50-l2-tbt	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、仅手续费等级达到VIP4及以上的用户可以订阅 2、该TBT深度频道需要身份验证后才可订阅，身份认证参考登录功能
books	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	无更新
books5	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、所有API用户均可订阅 2、公共深度频道，无需身份验证 3、从每200ms推送一次，调整为每100ms推送一次

2022-04-15

2022年5月升级预告，“获取当前账户交易手续费费率”接口将有如下变动：
- category参数会被废弃，但是不影响现有的程序调用，请求时category传值与不传值均返回一样的数据。
- 新增返回参数takerU和makerU，代表交割合约和永续合约下U本位合约的费率，当查询交割合约和永续合约的手续费费率时，原有参数taker和maker的含义发生变化，仅代表币本位。

详情请参考：关于“获取当前账户交易手续费费率”接口调整的公告

2022-04-14

2022年4月25日模拟盘升级预告，最早将于2022年5月5日上线实盘：
- 新增bbo-tbt实时推送买卖1档的深度频道。

{
    "op": "subscribe",
    "args": [{
        "channel": "bbo-tbt",
        "instId": "BTC-USDT"
    }]
}

请求参数

参数	类型	是否必须	描述
op	String	是	操作，`subscribe` `unsubscribe`
args	Array	是	请求订阅的频道列表
> channel	String	是	频道名 `books` `books5` `books-l2-tbt` `books50-l2-tbt` `bbo-tbt`
> instId	String	是	产品ID

返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "bbo-tbt",
        "instId": "BTC-USDT"
    }
}

失败示例

{
    "event": "error",
    "code": "Invalid",
    "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"bbo-tbt\", \"instId\" : \"BTC-USDT\"}]}"
}

返回参数

参数	类型	是否必须	描述
event	String	是	事件，`subscribe` `unsubscribe` `error`
arg	Object	否	订阅的频道
> channel	String	是	频道名
> instId	String	是	产品ID
msg	String	否	错误消息
code	String	否	错误码

推送示例：

{
    "arg": {
        "channel": "bbo-tbt",
        "instId": "BTC-USDT"
    },
    "data": [{
        "asks": [
            ["8506.96", "100", "0", "2"]
        ],
        "bids": [
            ["8446", "95", "0", "3"]
        ],
        "ts": "1597026383085"
    }]
}

推送示例：仅买方有深度时

{
    "arg": {
        "channel": "bbo-tbt",
        "instId": "BTC-USDT"
    },
    "data": [{
        "asks": [],
        "bids": [
            ["8446", "95", "0", "3"]
        ],
        "ts": "1597026383085"
    }]
}

* book5深度频道由每"200"毫秒有深度变化推送一次5档数据调整为每"100"毫秒有深度变化推送一次5档数据
* books-l2-tbt400档深度频道，只允许交易手续费等级VIP5及以上的API用户订阅。此更改仅影响WebSocket API用户，详细内容如下：
* books50-l2-tbt50档深度频道，只允许交易手续费等级VIP4及以上的API用户订阅。此更改仅影响WebSocket API用户，详细内容如下：

深度频道	更新前	更新后
bbo-tbt	无	1、新增bbo深度频道，实时推送买卖1档深度数据 2、所有API用户均可订阅 3、公共深度频道，无需身份验证
books-l2-tbt	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、仅手续费等级达到VIP5及以上的用户可以订阅 2、该TBT深度频道需要身份验证后才可订阅，身份认证参考登录功能
books50-l2-tbt	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、仅手续费等级达到VIP4及以上的用户可以订阅 2、该TBT深度频道需要身份验证后才可订阅，身份认证参考登录功能
books	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	无更新
books5	1、所有API用户均可订阅 2、公共深度频道，无需身份验证	1、所有API用户均可订阅 2、公共深度频道，无需身份验证 3、从每200ms推送一次，调整为每100ms推送一次

2022-04-08

模拟盘支持如下接口

2022-04-07

新增请求参数

参数名	类型	是否必须	描述
tag	String	否	订单标签

新增返回参数
- 获取币种列表

参数名	类型	描述
maxWd	String	币种单笔最大提币量
wdTickSz	String	提币精度,表示小数点后的位数
wdQuota	String	过去24小时内提币额度，单位为`USD`
usedWdQuota	String	过去24小时内已用提币额度，单位为`USD`

新增请求参数
- 获取充值记录

参数名	类型	是否必须	描述
depId	String	否	充值记录ID

新增请求参数
- 获取提币记录

参数名	类型	是否必须	描述
wdId	String	否	提币申请ID

新增接口
- 撤销提币
- 小额资产兑换
新增错误码

错误消息	错误码
小额兑换功能每日使用次数超限	58370
小额资产超过最大限制	58371
小额资产不足	58372
提币申请ID不存在	58215
不允许执行该操作	58216

2022-03-10

下线接口：
移除资金密码参数pwd：

若用户继续传入资金密码参数会忽略，不报错

ND Broker将新增接口：
新增返回参数
- 组合保证金的虚拟持仓保证金计算

参数名	类型	描述
mr1	String	现货&波动率压力测试值
mr2	String	时间价值压力测试值
mr3	String	波动率跨期压力测试值
mr4	String	基差压力测试值
mr5	String	利率风险压力测试值
mr6	String	极端市场波动压力测试值
mr7	String	减仓成本压力测试值

新增错误码

错误消息	错误码
您当前不在白名单列表，请联系客服	50041
该接口要求APIKey必须绑定IP	50035
起始日期和结束日期的时间间隔不能超过180天。	59615
起始日期不能大于结束日期	59616

2022-03-02

新增闪兑功能模块
新增大宗交易错误码模块

2022-02-17

余币宝申购/赎回请求参数调整：
调整前：

参数名	类型	是否必须	描述
rate	String	否	申购年利率仅适用于申购，新申购的利率会覆盖上次申购的利率如果不填按照默认1%的利率申购参数取值范围在1%到365%之间

调整后：

参数名	类型	是否必须	描述
rate	String	是	申购年利率仅适用于申购，新申购的利率会覆盖上次申购的利率参数取值范围在1%到365%之间

业务公告

2022-01-26

新增接口
- 查看被托管的子账户列表
新增返回参数
- 查看子账户列表

参数名	类型	描述
type	String	子账户类型,`1`:普通子账户 `2`:托管子账户

2022-01-25

新增返回参数
- 获取充值地址信息

参数名	类型	描述
addrEx	Object	充值地址备注，部分币种充值需要，若不需要则不返回此参数如币种`TONCOIN`的充值地址备注标签名为`comment`,则该参数返回：{'comment':'123456'}

2022-01-20

新的域名已启用，点击这里查看详情

2022-01-18

新增请求参数tag
- 策略委托下单
新增返回参数

参数名	类型	描述
tag	String	订单标签字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。

2022-01-17

新增返回参数

参数名	类型	描述
triggerPxType	String	计划委托触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`

策略委托下单计划委托新增请求参数：

参数名	类型	是否必须	描述
triggerPxType	String	否	计划委托触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`

2022-01-14

新增请求参数autoCxl
- 市价全平
新增账户greeks接口和频道
- 查看账户greeks
- 账户greeks频道

2022-01-11

Broker API 迁移到 Broker接入

2022-01-06

新增返回参数

参数名	类型	描述
callbackRatio	String	回调幅度的比例仅适用于`移动止盈止损`
callbackSpread	String	回调幅度的价距仅适用于`移动止盈止损`
activePx	String	移动止盈止损激活价格仅适用于`移动止盈止损`
moveTriggerPx	String	移动止盈止损触发价格仅适用于`移动止盈止损`

ordType新增枚举值：

参数名	类型	描述
ordType	String	`move_order_stop`：移动止盈止损

策略委托下单新增请求参数：

参数名	类型	是否必须	描述
callbackRatio	String	可选	回调幅度的比例，如 `0.05` `callbackRatio`和`callbackSpread`只能传入一个
callbackSpread	String	可选	回调幅度的价距
activePx	String	否	激活价格

ordType新增枚举值：

参数名	类型	是否必须	描述
ordType	String	是	`move_order_stop`：移动止盈止损

获取余币宝余额接口URL调整为/api/v5/asset/saving-balance
新增错误码

错误消息	错误码
passphrase不正确	60024

2021-12-24

新增接口
- 组合保证金的虚拟持仓保证金计算
- 逐仓交易设置
查看账户配置新增返回参数：

参数名	类型	描述
ctIsoMode	String	衍生品的逐仓保证金划转模式 `automatic`：开仓划转 `autonomy`：自主划转
mgnIsoMode	String	币币杠杆的逐仓保证金划转模式 `automatic`：开仓划转 `autonomy`：自主划转

查看持仓信息、查看账户持仓风险、持仓频道、账户余额和持仓频道新增返回参数：

参数名	类型	描述
baseBal	String	交易币余额，适用于 `币币杠杆`（逐仓自主划转模式）
quoteBal	String	计价币余额，适用于 `币币杠杆`（逐仓自主划转模式）

调整保证金新增参数：

参数名	类型	是否必须	描述
ccy	String	否	增加或减少的保证金的币种，仅适用于逐仓自主划转保证金模式下的币币杠杆
auto	Boolean	否	是否自动借币转 true 或 false，默认false 仅适用于逐仓自主划转保证金模式下的币币杠杆

获取最大可用余额/保证金新增参数：

参数名	类型	是否必须	描述
px	String	否	委托价格当不填委托价时会按当前最新成交价计算当指定多个产品ID查询时，忽略该参数，按当前最新成交价计算

2021-12-14

新增接口
获取余币宝余额新增返回参数：

参数名	类型	描述
rate	String	最新出借利率
loanAmt	String	已出借数量
pendingAmt	String	未出借数量
redemptAmt	String	赎回中的数量

余币宝申购/赎回新增参数：

参数名	类型	描述
rate	String	申购年利率

获取市场借币杠杆利率和借币限额返回参数字段调整：

参数名	类型	描述
> irDiscount	String	利率的折扣率该字段已废弃，始终返回""

2021-12-06

资金划转、子账户间资金划转、调整保证金新增请求参数：

参数名	类型	是否必须	描述
loanTrans	Boolean	否	是否支持`跨币种保证金模式`下的借币转出/转入默认为`false`。

查看账户最大可转余额新增返回参数：

参数名	类型	描述
maxWdEx	String	最大可划转数量（支持`跨币种保证金模式`借币转出）

获取尊享借币杠杆利率和借币限额返回字段调整：

参数名	类型	描述
> level	String	用户VIP等级，如 `VIP5`

2021-12-04

新增返回参数

参数名	类型	描述
tpTriggerPxType	String	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格
slTriggerPxType	String	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格

策略委托下单止盈止损委托新增请求参数：

参数名	类型	是否必须	描述
tpTriggerPxType	String	否	止盈触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`
slTriggerPxType	String	否	止损触发价类型 `last`：最新价格 `index`：指数价格 `mark`：标记价格默认为`last`

2021-11-26

下单、批量下单请求参数字段调整：

参数名	类型	是否必须	描述
reduceOnly	Boolean	否	是否只减仓，`true` 或 `false`，默认`false` 仅适用于`币币杠杆`，以及买卖模式下的`交割/永续` 仅适用于`现货和合约模式`和`跨币种保证金模式`

2021-11-25

新增接口
获取计息记录新增参数：

参数名	类型	描述
type	String	借币类型 `1`：尊享借币 `2`：市场借币

账单流水查询（近七天）和账单流水查询（近三月） subType字段新增枚举值：

参数名	类型	描述
subType	String	14：尊享借币扣息

新增错误码

错误提示	HTTP 状态码	错误码
可用保证金不足，请尝试增加保证金或减少借币数量	200	59303
借币币种权益不足，请至少留有一天的利息	200	59304
您当前没有进行尊享借币，无法设置尊享借币优先	200	59305
借币数量超过总额度，不可继续借币	200	59306
当前用户不满足尊享借币条件	200	59307
市场化借币额度不足，VIP还币失败	200	59308
还币数量超出已借数量，还币失败	200	59309
当前账户不支持尊享借币	200	59310
存在尊享借币，无法设置	200	59311
{币种}不支持尊享借币	200	59312

2021-11-23

新增 ND-Broker 功能模块
新增接口获取账户资产估值

2021-11-20

调整保证金新增返回参数：

参数名	类型	描述
leverage	String	调整保证金后的实际杠杆倍数

2021-11-02

获取最大可下单数量新增请求参数：

参数名	类型	是否必须	描述
leverage	String	否	开仓杠杆倍数默认为当前杠杆倍数仅适用于`币币杠杆/交割/永续`

2021-11-01

新增接口查看账户特定风险状态
获取订单信息 category字段新增枚举值 ddh：

参数名	类型	描述
category	String	`ddh`：对冲减仓类型订单

获取历史订单记录（近七天） category字段新增枚举值 ddh：

参数名	类型	描述
category	String	`ddh`：对冲减仓类型订单

获取历史订单记录（近三个月） category字段新增枚举值 ddh：

参数名	类型	描述
category	String	`ddh`：对冲减仓类型订单

订单频道 category字段新增枚举值 ddh：

参数名	类型	描述
category	String	`ddh`：对冲减仓类型订单

账单流水查询（近七天） type字段新增枚举值 13：ddh；subType字段新增枚举值：131：对冲买入和132：对冲卖出

参数名	类型	是否必须	描述
type	String	否	账单类型 `1`：划转 `2`：交易 `3`：交割 `4`：自动换币 `5`：强平 `6`：保证金划转 `7`：扣息 `8`：资金费 `9`：自动减仓 `10`：穿仓补偿 `11`：系统换币 `12`：策略划拨 `13`：对冲减仓
subType	String	否	账单子类型 `1`：买入 `2`：卖出 `3`：开多 `4`：开空 `5`：平多 `6`：平空 `9`：扣息 `11`：转入 `12`：转出 `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`:手动转出

账单流水查询（近三月） type字段新增枚举值 13：ddh；subType字段新增枚举值：131：对冲买入和132：对冲卖出

参数名	类型	是否必须	描述
type	String	否	账单类型 `1`：划转 `2`：交易 `3`：交割 `4`：自动换币 `5`：强平 `6`：保证金划转 `7`：扣息 `8`：资金费 `9`：自动减仓 `10`：穿仓补偿 `11`：系统换币 `12`：策略划拨 `13`：对冲减仓
subType	String	否	账单子类型 `1`：买入 `2`：卖出 `3`：开多 `4`：开空 `5`：平多 `6`：平空 `9`：扣息 `11`：转入 `12`：转出 `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`:手动转出

查看账户配置 acctLv字段新增枚举值 4：组合账户

参数名	类型	描述
acctLv	String	账户层级 `1`：现货模式，`2`：现货和合约模式，`3`：跨币种保证金模式，`4`：组合账户

获取所有交易产品K线数据、获取交易产品历史K线数据、获取指数K线数据、获取标记价格K线数据 bar字段新增枚举值，支持获取UTC时区k线[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc/6Mutc/1Yutc]

参数名	类型	是否必须	描述
bar	String	否	时间粒度，默认值`1m` 如 [1m/3m/5m/15m/30m/1H/2H/4H] 香港时间开盘价k线：[6H/12H/1D/1W/1M/3M/6M/1Y] UTC时间开盘价k线：[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc/6Mutc/1Yutc]

指数k线频道新增UTC时区k线频道

参数	类型	是否必须	描述
> channel	String	是	频道名 `index-candle1Y` `index-candle6M` `index-candle3M` `index-candle1M` `index-candle1W` `index-candle1D` `index-candle2D` `index-candle3D` `index-candle5D` `index-candle12H` `index-candle6H` `index-candle4H` `index -candle2H` `index-candle1H` `index-candle30m` `index-candle15m` `index-candle5m` `index-candle3m` `index-candle1m` `index-candle1Yutc` `index-candle3Mutc` `index-candle1Mutc` `index-candle1Wutc` `index-candle1Dutc` `index-candle2Dutc` `index-candle3Dutc` `index-candle5Dutc` `index-candle12Hutc` `index-candle6Hutc`

标记价格K线频道新增UTC时区k线频道

参数	类型	是否必须	描述
> channel	String	是	频道名 `mark-price-candle1Y` `mark-price-candle6M` `mark-price-candle3M` `mark-price-candle1M` `mark-price-candle1W` `mark-price-candle1D` `mark-price-candle2D` `mark-price-candle3D` `mark-price-candle5D` `mark-price-candle12H` `mark-price-candle6H` `mark-price-candle4H` `mark-price-candle2H` `mark-price-candle1H` `mark-price-candle30m` `mark-price-candle15m` `mark-price-candle5m` `mark-price-candle3m` `mark-price-candle1m` `mark-price-candle1Yutc` `mark-price-candle3Mutc` `mark-price-candle1Mutc` `mark-price-candle1Wutc` `mark-price-candle1Dutc` `mark-price-candle2Dutc` `mark-price-candle3Dutc` `mark-price-candle5Dutc` `mark-price-candle12Hutc` `mark-price-candle6Hutc`

K线频道新增UTC时区k线频道

参数	类型	是否必须	描述
> channel	String	是	频道名 `candle1Y` `candle6M` `candle3M` `candle1M` `candle1W` `candle1D` `candle2D` `candle3D` `candle5D` `candle12H` `candle6H` `candle4H` `candle2H` `candle1H` `candle30m` `candle15m` `candle5m` `candle3m` `candle1m` `candle1Yutc` `candle3Mutc` `candle1Mutc` `candle1Wutc` `candle1Dutc` `candle2Dutc` `candle3Dutc` `candle5Dutc` `candle12Hutc` `candle6Hutc`

账单流水查询（近七天）返回参数新增字段 execType：订单流动性方向

参数名	类型	描述
execType	String	流动性方向 `T`：taker `M`：maker

账单流水查询（近三月）返回参数新增字段 execType：订单流动性方向

参数名	类型	描述
execType	String	流动性方向 `T`：taker `M`：maker

新增错误码

错误提示	HTTP 状态码	错误码
当前账户风险状态，仅支持降低账户风险方向的IOC订单	200	51037
当前风险模块下已经存在降低账户风险方向的IOC类型订单	200	51038
PM账户下交割和永续的全仓不能调整杠杆倍数	200	51039
期权逐仓的买方不能调整保证金	200	51040
当前账户模式不支持此API接口	200	51010
PM账户不支持ordType为{0}的策略委托单	200	51295
PM账户仅支持买卖模式	200	51041
修改订单失败，PM账户下，批量改单不允许一批量请求中包含相同的订单	200	51512
期权全仓不能有净开多持仓	200	51019

2021-10-19

查看持仓信息新增参数字段 markPx：
返回参数新增标记价格字段：

参数名	类型	描述
markPx	String	标记价格

持仓频道新增参数字段 markPx：
返回参数新增标记价格字段：

参数名	类型	描述
>markPx	String	标记价格

2021-10-18

查看账户最大可转余额支持多币种查询（不超过20个），币种之间半角逗号分隔。
获取币种列表新增返回字段：mainNet

参数名	类型	描述
mainNet	Boolean	当前链是否为主链如果是则返回`true`，否则返回`false`

新增错误码

错误提示	HTTP 状态码	错误码
用户没有使用此API接口的权限	200	50030
交割、永续合约的买卖模式下，不支持计划委托	200	51298
{chainName}维护中，暂停提币	200	58214
只支持同一业务线下交易产品ID	200	59004

2021-10-15

实盘支持冰山委托和时间加权委托

策略委托下单请求参数字段调整：
调整前：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托

调整后：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托 `iceberg`：冰山委托 `twap`：时间加权委托

请求参数字段新增：

冰山委托

参数名	类型	是否必须	描述
pxVar	String	可选	挂单价距离盘口的比例 `pxVar`和`pxSpread`只能传入一个
pxSpread	String	可选	挂单价距离盘口的价距
szLimit	String	是	单笔数量
pxLimit	String	是	挂单限制价

时间加权

参数名	类型	是否必须	描述
pxVar	String	可选	吃单价优于盘口的比例 `pxVar`和`pxSpread`只能传入一个
pxSpread	String	可选	吃单单价优于盘口的价距
szLimit	String	是	单笔数量
pxLimit	String	是	挂单限制价
timeInterval	String	是	下单间隔

获取历史策略委托单列表、获取未完成策略委托单列表请求参数字段调整：

调整前：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托

调整后：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托 `iceberg`：冰山委托 `twap`：时间加权委托

新增返回字段：

参数名	类型	描述
pxVar	String	价格比例仅适用于`冰山委托`和`时间加权委托`
pxSpread	String	价距仅适用于`冰山委托`和`时间加权委托`
szLimit	String	单笔数量仅适用于`冰山委托`和`时间加权委托`
pxLimit	String	挂单限制价仅适用于`冰山委托`和`时间加权委托`
timeInterval	String	下单间隔仅适用于`时间加权委托`

新增接口撤销高级策略委托订单
新增高级策略委托订单频道

2021-10-14

新增交互式浏览器功能

2021-10-12

获取最大可用余额/保证金和获取交易产品最大可借支持多个instId查询，半角逗号分隔。instId个数不超过5个。
新增接口资金划转状态查询

2021-09-30

新增接口闪电网络提币
新增接口闪电网络充币
新增错误码

错误提示	HTTP 状态码	错误码
invoice已经过期	200	58351
invoice无效	200	58352
充币数量需要在限额范围内	200	58353
单日达到生成invoice 10,000 个的上限	200	58354
用户没有使用此API接口的权限	200	58355
同节点账户不支持闪电网络充币或提币	200	58356

2021-09-08

新增错误码

错误提示	HTTP 状态码	错误码
吃单价优于盘口的比例范围	200	51282
时间间隔的范围{0}s~{1}s	200	51283
单笔数量的范围{0}~{1}	200	51284
委托总量的范围{0}~{1}	200	51285
下单金额需大于等于{0}	200	51286
策略不支持此合约	200	51287
策略正在停止中，请勿重复点击	200	51288
策略配置不存在，请稍后再试	200	51289
策略引擎正在升级，请稍后重试	200	51290
策略不存在或已停止	200	51291
策略类型不存在	200	51292
策略不存在	200	51293
该策略暂不能创建，请稍后再试	200	51294

2021-09-07

获取杠杆倍数支持多个instId查询，半角逗号分隔。instId个数不超过20个。

参数名	类型	是否必须	描述
instId	String	是	产品ID 支持多产品ID查询（不超过20个）,半角逗号分隔

新增接口获取指数成分接口

2021-09-06

模拟盘支持冰山委托和时间加权委托

策略委托下单请求参数字段调整：
调整前：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托

调整后：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托 `iceberg`：冰山委托 `twap`：时间加权委托

请求参数字段新增：

冰山委托

参数名	类型	是否必须	描述
pxVar	String	可选	挂单价距离盘口的比例 `pxVar`和`pxSpread`只能传入一个
pxSpread	String	可选	挂单价距离盘口的价距
szLimit	String	是	单笔数量
pxLimit	String	是	挂单限制价

时间加权

参数名	类型	是否必须	描述
pxVar	String	可选	吃单价优于盘口的比例 `pxVar`和`pxSpread`只能传入一个
pxSpread	String	可选	吃单单价优于盘口的价距
szLimit	String	是	单笔数量
pxLimit	String	是	挂单限制价
timeInterval	String	是	下单间隔

获取历史策略委托单列表、获取未完成策略委托单列表请求参数字段调整：

调整前：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托

调整后：

参数名	类型	是否必须	描述
ordType	String	是	订单类型 `conditional`：单向止盈止损 `oco`：双向止盈止损 `trigger`：计划委托 `iceberg`：冰山委托 `twap`：时间加权委托

新增返回字段：

参数名	类型	描述
pxVar	String	价格比例仅适用于`冰山委托`和`时间加权委托`
pxSpread	String	价距仅适用于`冰山委托`和`时间加权委托`
szLimit	String	单笔数量仅适用于`冰山委托`和`时间加权委托`
pxLimit	String	挂单限制价仅适用于`冰山委托`和`时间加权委托`
timeInterval	String	下单间隔仅适用于`时间加权委托`

新增接口撤销高级策略委托订单
新增高级策略委托订单频道

2021-09-03

新增功能 V5OpenAPI支持交易大数据功能

2021-08-31

查看账户余额接口新增返回字段：stgyEq和isoUpl
账户频道推送数据新增字段：stgyEq和isoUpl

参数名	类型	描述
> stgyEq	String	策略权益
> isoUpl	String	逐仓未实现盈亏适用于`现货和合约模式`和`跨币种保证金模式`

2021-08-20

获取提币记录、获取充值记录新增请求参数txId。

参数名	类型	是否必须	描述
txId	String	否	区块转账哈希记录

提币支持通用地址

2021-07-30

下单功能新增请求参数 tgtCcy 字段：

参数名	类型	是否必须	描述
tgtCcy	String	否	委托数量的类型 `base_ccy`: 交易货币；`quote_ccy`：计价货币仅适用于`币币`订单

订单查询功能新增返回参数 tgtCcy 字段：

参数名	类型	描述
tgtCcy	String	委托数量的类型 `base_ccy`: 交易货币；`quote_ccy`：计价货币仅适用于`币币`订单

推送数据新增 tgtCcy 字段：
- 订单频道
- 策略委托订单频道

参数名	类型	描述
tgtCcy	String	委托数量的类型 `base_ccy`: 交易货币；`quote_ccy`：计价货币仅适用于`币币`订单

新增错误码 59110

错误提示	HTTP 状态码	错误码
该{0}对应的产品业务线不支持使用tgtCcy参数。	200	59110

新增错误码 51281

错误提示	HTTP 状态码	错误码
计划委托不支持使用tgtCcy参数	200	51281

2021-07-20

新增接口获取成交明细（近三个月）
获取成交明细（近三天）当前的成交明细接口由可获取近3个月历史数据的时间范围修改为可获取近3天的历史数据。
新增接口获取衍生品仓位档位

2021-07-08

新增接口获取余币宝余额

2021-06-15

获取充值地址信息返回结果新增参数ctAddr：合约地址后6位。

参数名	类型	描述
ctAddr	String	合约地址后6位

获取充值地址信息、提币、获取提币记录、获取充值记录返回结果新增参数chain。

参数名	类型	描述
chain	String	币种链信息如`USDT`下有`USDT-ERC20`，`USDT-TRC20`多个链

提币新增请求参数chain。

参数名	类型	是否必须	描述
chain	String	可选	币种链信息如`USDT`下有`USDT-ERC20`，`USDT-TRC20`多个链如果没有不填此参数，则默认为主链

2021-06-11

新增错误码 55000

错误提示	HTTP 状态码	错误码
交割后30分钟内不能转出	200	55000

获取最大可下单数量支持多个instId查询，半角逗号分隔。instId个数不超过5个。

参数名	类型	是否必须	描述
instId	String	是	产品ID，如 `BTC-USDT` 支持多产品ID查询（不超过5个），半角逗号分隔

2021-06-08

调整子账户间资金划转返回字段：

调整前：

参数名	类型	描述
transferId	int	划转ID

调整后：

参数名	类型	描述
transId	String	划转ID

更新返回错误码的数据类型 50011

调整前：

code	类型	httpcode	msg
50011	int	429	用户请求频率过快，超过该接口允许的限额

调整后：

code	类型	httpcode	msg
50011	String	429	用户请求频率过快，超过该接口允许的限额

查看持仓信息支持多个instId查询，半角逗号分割。instId个数不超过10个。

参数名	类型	是否必须	描述
instType	String	否	产品类型 `MARGIN`：币币杠杆 `SWAP`：永续合约 `FUTURES`：交割合约 `OPTION`：期权 `instType`和`instId`同时传入的时候会校验`instId`与`instType`是否一致，结果返回`instId`的持仓信息
instId	String	否	交易产品ID，如：`BTC-USD-190927-5000-C` 如果该instId拥有过的仓位，将返回持仓信息，不管持仓量是否为0；否则不返回
posId	String	否	持仓ID 支持多个`posId`查询（不超过20个），半角逗号分隔

订单频道新增字段：

参数名	类型	描述
> fillNotionalUsd	String	委托单已成交的美元价值
> notionalUsd	String	委托单预估美元价值

策略委托订单频道新增字段：

参数名	类型	描述
> notionalUsd	String	委托单预估美元价值

2021-05-25

获取免息额度和币种折算率等级接口新增字段：

参数名	类型	描述
discountInfo	Array	币种折算率详情
> discountRate	String	折算率
> maxAmt	String	梯度区间上限（美元），“” 表示正无穷
> minAmt	String	梯度区间下限（美元），最小值是0

新增获取衍生品标的指数
新增获取市场借币杠杆利率和借币限额
下单接口，批量下单接口，下单频道，批量下单频道ordType新增枚举值：optimal_limit_ioc

参数名	类型	描述
ordType	String	订单类型 `market`：市价单 `limit`：限价单 `post_only`：只做maker单 `fok`：全部成交或立即取消 `ioc`：立即成交并取消剩余 `optimal_limit_ioc`：市价委托立即成交并取消剩余（仅适用交割、永续）

2021-05-18

查看账户余额、查询子账户资产余额、账户频道新增字段：notionalUsd（仓位的美金价值）、notionalLever（币种杠杆倍数）、eqUsd（币种权益的美金价值）、maxLoan（币种最大可借）。

2021-05-12

Status 调整了字段：begin、end 时间戳从秒变为毫秒。

2021-04-27

WebSocket交易模块接口修改clOrdId 规则。

2021-04-21

新增 50档深度TBT频道
订单信息频道新增字段：fillFee（最新一笔成交的手续费），fillFeeCcy（最新一笔成交的手续费币种），execType（最新一笔成交的流动性方向 T：taker M：maker ）
获取账户配置信息接口新增字段：level（当前在平台上真实交易量的用户等级），levelTmp（特约用户的临时体验用户等级）
新增获取衍生品仓位档位接口
新增链上交易数据接口
账户余额和持仓频道增加事件类型枚举值interest_deduction
账单流水查询（近七天）和账单流水查询（近三个月）删除subType字段中 109：强平惩罚费的类型。
持仓频道,持仓接口新增返回字段：

参数名	类型	描述
> deltaBS	String	美金本位持仓仓位delta，仅适用于`期权`
> deltaPA	String	币本位持仓仓位delta，仅适用于`交割`、`永续`、`期权`
> gammaBS	String	美金本位持仓仓位gamma，仅适用于`期权`
> gammaPA	String	币本位持仓仓位gamma，仅适用于`期权`
> thetaBS	String	美金本位持仓仓位theta，仅适用于`期权`
> thetaPA	String	币本位持仓仓位theta，仅适用于`期权`
> vegaBS	String	美金本位持仓仓位vega，仅适用于`期权`
> vegaPA	String	币本位持仓仓位vega，仅适用于`期权`

2021-04-16

新增接口查看账户和持仓风险
查看账户余额、获取子账户交易账户余额、账户频道新增字段：cashBal（币种余额），uTime（币种余额信息的更新时间）
新增接口获取用户当前杠杆借币利率
新增接口获取平台24小时总成交量

2021-03-31

查看账户余额新增字段：ordFroz（美金层面全仓挂单占用保证金）
获取子账户资产余额新增字段：ordFroz（美金层面全仓挂单占用保证金）
账户频道新增字段：ordFroz（美金层面全仓挂单占用保证金）

2021-03-24

实盘新增AWS域名地址
模拟盘新增域名地址，近期将原域名地址完全切换到新的域名地址

2021-03-02

新增推送频道：账户余额和持仓频道。

2021-02-26

查看账户余额接口新增字段：disEq（美金层面币种折算权益）

2021-02-05

由于折算率计算逻辑变化，调整获取免息额度和币种折算率返回参数原折算率（discount）为折算率等级（discountLv）。详情查看折算率
返回结果调整前为：
{ "code":"0", "msg":"", "data":[ { "ccy":"BTC", "amt" :"2" , "discount" :"0.8" } ] }
返回结果调整后为：
{ "code":"0", "msg":"", "data":[ { "ccy":"BTC", "amt" :"2" , "discountLv" :"1" } ] }
查看账户余额接口新增字段：uplLiab（由于仓位未实现亏损导致的负债）