导航
English

2023-02-02

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

2023-02-01

参数名 类型 描述
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

2022-12-23

参数名 类型 描述
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 当前账号已经设置的带单合约,仅适用于带单者
参数名 类型 描述
> code String 错误码,默认为0
> msg 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 借/还币的数量

调整后:

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

新增请求参数

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

新增返回参数

参数名 类型 描述
ordId String 借币订单ID
state String 订单状态
1:借币申请中
2:借币中
3:还币申请中
4:已还币
5:借币失败
参数名 类型 描述
> avgRate String 币种已借平均利率,仅适用于尊享借币

2022-12-12

2022-12-09

2022-12-08

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

请求参数

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

返回参数

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

请求参数

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

返回参数

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

2022-12-06

2022-12-01

调整前:

参数名 类型 描述
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 String API Key权限
withdraw:提币

调整限速规则

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

调整后:
* 限速规则(期权以外):UserID + Instrument ID
* 限速规则(只限期权):UserID + Instrument Family

参数名 类型 是否必须 描述
sz String 可选 委托数量
szcloseFraction必填且只能填其一
closeFraction String 可选 策略委托触发时,平仓的百分比。1 代表100%
现在系统只支持全部平仓,唯一接受参数为1
仅适用于交割永续
仅适用于买卖模式 posSide = net
仅适用于减仓订单 reduceOnly = true
仅适用于止盈止损 ordType = conditionaloco
仅适用于止盈止损市价订单
szcloseFraction必填且只能填其一
参数名 类型 描述
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

2022-11-24

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

2022-11-21

参数名 类型 描述
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

参数名 类型 描述
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. beginendafterbefore同时存在时,接口会先使用beginend进行筛选,然后使用afterbefore在进行分页。

2022-10-20

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

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

2022-10-19

2022-10-14

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

请求参数:

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

返回参数:

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

请求参数:

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

返回参数:

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

调整前:

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

调整后:

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

调整前:

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

调整后:

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

调整前:

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

调整后:

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

调整前:

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

调整后:

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

2022-10-13

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

2022-10-10

参数名 类型 是否必须 描述
allowPartialExecution Boolean RFQ是否可以被部分执行,如果腿的比例和原RFQ一致。有效值为truefalse。默认为false
参数名 类型 是否必须 描述
legs Array of objects 用于部分执行的腿的数量。腿的数量比例必须与原RFQ相同。注意:每条腿的tgtCcyside和原RFQ一致,px和对应Quote一致。
> instId String 产品ID, 如 "BTC-USDT-SWAP".
> sz String 该条腿的部分执行数量
参数名 类型 是否必须 描述
includeAll Boolean 是否接收该instType下所有产品。有效值为truefalse。默认false
参数名 类型 描述
allowPartialExecution Boolean RFQ是否可以被部分执行,如果腿的比例和原RFQ一致。有效值为truefalse。默认为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之间半角逗号分隔
适用于交割/永续/期权
ulyinstFamily必须传一个,若传两个,以instFamily为主

返回参数:

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

请求参数:

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

返回参数:

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

调整前:

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

调整后:

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

调整前:

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

调整后:

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

调整前:

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

调整后:

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

调整前:

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

调整后:

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

2022-09-22

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
没有充币限制则返回""

调整前:

参数名 类型 描述
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

参数名 描述
affiliated 是否有节点关系, truefalse

2022-09-01

参数名 类型 描述
> 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 String moon_grid: 天地网格
错误提示 HTTP 状态码 错误码
MMP状态下操作失败。冻结时间为 {0} 秒 200 70008
同一个instType{1}下的instFamily/instId{0} 存在重复设置 200 70012
instId {0} 报价不可以超过你预设的价格限制 200 70310

2022-08-29

参数名 类型 描述
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

调整前:

参数名 类型 是否必须 描述
label String APIKey的备注,如果填写该字段,那该字段会被重置
不超过50位字母(区分大小写)或数字,可以是纯字母或纯数字。
perm String APIKey权限
read_only: 只读; trade: 交易
多个权限用半角逗号隔开。
如果填写该字段,那该字段会被重置。

调整后:

参数名 类型 是否必须 描述
label String APIKey的备注,如果填写该字段,那该字段会被重置
不超过50位字母(区分大小写)或数字,可以是纯字母或纯数字。
perm String APIKey权限
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

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

参数名 类型 描述
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

请求参数调整前:

参数名 类型 是否必须 描述
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:其他(如:停止部分产品交易)

调整前:

参数名 类型 描述
> 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

2022-06-14

调整前:

参数名 类型 描述
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位字母(区分大小写)或数字,可以是纯字母或纯数字。

调整前:

参数名 类型 是否必须 描述
label String APIKey的备注

调整后:

参数名 类型 是否必须 描述
label String APIKey的备注
不超过50位字母(区分大小写)或数字,可以是纯字母或纯数字。

调整前:

参数名 类型 是否必须 描述
label String APIKey的备注

调整后:

参数名 类型 是否必须 描述
label String APIKey的备注
不超过50位字母(区分大小写)或数字,可以是纯字母或纯数字。

2022-06-07

2022-06-01

2022-05-26

参数名 类型 是否必须 描述
banAmend Boolean 是否禁止币币市价改单,true 或 false,默认false
为true时,余额不足时,系统不会改单,下单会失败,仅适用于币币市价单

2022-05-23

2022-05-20

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

使用begin end进行时间筛选的规则如下:
1. 返回结果包含begin end传参;
2. begin end同时存在时,靠近end返回;
3. beginendafterbefore同时存在时,接口会先使用beginend进行筛选,然后使用afterbefore在进行分页。

2022-05-19

2022-05-18

调整前:

参数名 类型 是否必须 描述
passphrase String APIKey的密码,6-32位小写字母数字组合,及至少包含一个大写字母或特殊字符
ip String 绑定ip地址,多个ip用半角逗号隔开,最多支持20个ip

调整后:

参数名 类型 是否必须 描述
passphrase String APIKey的密码,8-32位字母数字组合,至少包含一个数字、一个大写字母、一个小写字母、一个特殊字符
ip String 可选 绑定ip地址,多个ip用半角逗号隔开,最多支持20个ip
如果子账户APIKey拥有交易权限,必须绑定IP地址

调整前:

参数名 类型 是否必须 描述
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

详情请参考:关于“获取当前账户交易手续费费率”接口调整的公告

2022-05-05

深度频道 更新前 更新后
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 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 合约或现货止盈止损委托的单笔最大委托数量
参数名 类型 是否必须 描述
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

深度频道 更新前 更新后
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-04-14

{
    "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": "60012",
    "msg": "Illegal 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小时内提币额度,单位为BTC
usedWdQuota String 过去24小时内已用提币额度,单位为BTC
参数名 类型 是否必须 描述
depId String 充值记录ID
参数名 类型 是否必须 描述
wdId String 提币申请ID
错误消息 错误码
小额兑换功能每日使用次数超限 58370
小额资产超过最大限制 58371
小额资产不足 58372
提币申请ID不存在 58215
不允许执行该操作 58216

2022-03-10

若用户继续传入资金密码参数会忽略,不报错

参数名 类型 描述
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 String 订单标签
字母(区分大小写)与数字的组合,可以是纯字母、纯数字,且长度在1-16位之间。

2022-01-17

参数名 类型 描述
triggerPxType String 计划委托触发价类型
last:最新价格
index:指数价格
mark:标记价格
默认为last
参数名 类型 是否必须 描述
triggerPxType String 计划委托触发价类型
last:最新价格
index:指数价格
mark:标记价格
默认为last

2022-01-14

2022-01-11

2022-01-06

参数名 类型 描述
callbackRatio String 回调幅度的比例
仅适用于移动止盈止损
callbackSpread String 回调幅度的价距
仅适用于移动止盈止损
activePx String 移动止盈止损激活价格
仅适用于移动止盈止损
moveTriggerPx String 移动止盈止损触发价格
仅适用于移动止盈止损

ordType新增枚举值:

参数名 类型 描述
ordType String move_order_stop:移动止盈止损


参数名 类型 是否必须 描述
callbackRatio String 可选 回调幅度的比例,如 0.05
callbackRatiocallbackSpread只能传入一个
callbackSpread String 可选 回调幅度的价距
activePx String 激活价格

ordType新增枚举值:

参数名 类型 是否必须 描述
ordType String move_order_stop:移动止盈止损
错误消息 错误码
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 是否只减仓,truefalse,默认false
仅适用于币币杠杆,以及买卖模式下的交割/永续
仅适用于单币种保证金模式跨币种保证金模式

2021-11-25

参数名 类型 描述
type String 借币类型
1:尊享借币
2:市场借币


参数名 类型 描述
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

2021-11-20

参数名 类型 描述
leverage String 调整保证金后的实际杠杆倍数

2021-11-02

参数名 类型 是否必须 描述
leverage String 开仓杠杆倍数
默认为当前杠杆倍数
仅适用于币币杠杆/交割/永续

2021-11-01

参数名 类型 描述
category String ddh:对冲减仓类型订单
参数名 类型 描述
category String ddh:对冲减仓类型订单
参数名 类型 描述
category String ddh:对冲减仓类型订单
参数名 类型 描述
category String ddh:对冲减仓类型订单
参数名 类型 是否必须 描述
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 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 String 账户层级
1:简单交易模式,2:单币种保证金模式 ,3:跨币种保证金模式 ,4:组合账户
参数名 类型 是否必须 描述
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]
参数 类型 是否必须 描述
> 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
参数 类型 是否必须 描述
> 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
参数 类型 是否必须 描述
> 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 String 流动性方向 T:taker M:maker
参数名 类型 描述
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 String 标记价格
参数名 类型 描述
>markPx String 标记价格

2021-10-18

参数名 类型 描述
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 可选 挂单价距离盘口的比例
pxVarpxSpread只能传入一个
pxSpread String 可选 挂单价距离盘口的价距
szLimit String 单笔数量
pxLimit String 挂单限制价

时间加权

参数名 类型 是否必须 描述
pxVar String 可选 吃单价优于盘口的比例
pxVarpxSpread只能传入一个
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

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 String 产品ID
支持多产品ID查询(不超过20个),半角逗号分隔

2021-09-06

模拟盘支持冰山委托和时间加权委托

参数名 类型 是否必须 描述
ordType String 订单类型
conditional:单向止盈止损
oco:双向止盈止损
trigger:计划委托

调整后:

参数名 类型 是否必须 描述
ordType String 订单类型
conditional:单向止盈止损
oco:双向止盈止损
trigger:计划委托
iceberg:冰山委托
twap:时间加权委托

请求参数字段新增:

冰山委托

参数名 类型 是否必须 描述
pxVar String 可选 挂单价距离盘口的比例
pxVarpxSpread只能传入一个
pxSpread String 可选 挂单价距离盘口的价距
szLimit String 单笔数量
pxLimit String 挂单限制价

时间加权

参数名 类型 是否必须 描述
pxVar String 可选 吃单价优于盘口的比例
pxVarpxSpread只能传入一个
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

2021-08-31

参数名 类型 描述
> stgyEq String 策略权益
> isoUpl String 逐仓未实现盈亏
适用于单币种保证金模式跨币种保证金模式

2021-08-20

参数名 类型 是否必须 描述
txId String 区块转账哈希记录

2021-07-30

参数名 类型 是否必须 描述
tgtCcy String 委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
仅适用于币币订单
参数名 类型 描述
tgtCcy String 委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
仅适用于币币订单
参数名 类型 描述
tgtCcy String 委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
仅适用于币币订单
错误提示 HTTP 状态码 错误码
该{0}对应的产品业务线不支持使用tgtCcy参数。 200 59110
错误提示 HTTP 状态码 错误码
计划委托不支持使用tgtCcy参数 200 51281

2021-07-20

2021-07-08

2021-06-15

参数名 类型 描述
ctAddr String 合约地址后6位
参数名 类型 描述
chain String 币种链信息
USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链

提币 新增请求参数chain

参数名 类型 是否必须 描述
chain String 可选 币种链信息
USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
如果没有不填此参数,则默认为主链

2021-06-11

错误提示 HTTP 状态码 错误码
交割后30分钟内不能转出 200 55000
参数名 类型 是否必须 描述
instId String 产品ID,如 BTC-USDT
支持多产品ID查询(不超过5个),半角逗号分隔

2021-06-08

调整前:

参数名 类型 描述
transferId int 划转ID

调整后:

参数名 类型 描述
transId String 划转ID

调整前:

code 类型 httpcode msg
50011 int 429 用户请求频率过快,超过该接口允许的限额

调整后:

code 类型 httpcode msg
50011 String 429 用户请求频率过快,超过该接口允许的限额
参数名 类型 是否必须 描述
instType String 产品类型
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
instTypeinstId同时传入的时候会校验instIdinstType是否一致,结果返回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 String 订单类型
market:市价单
limit:限价单
post_only:只做maker单
fok:全部成交或立即取消
ioc:立即成交并取消剩余
optimal_limit_ioc:市价委托立即成交并取消剩余(仅适用交割、永续)

2021-05-18

2021-05-12

2021-04-27

2021-04-21

参数名 类型 描述
> 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

2021-03-31

2021-03-24

2021-03-02

2021-02-26

2021-02-05