导航
English 中文
Java Python Go C++

概览

欢迎查看OKEx V5 API文档。我们提供完整的REST和WebSocket API以满足您的交易需求。
V5 API只适用于统一账户。

模拟盘交易

目前可以进行V5 API的模拟盘交易，用户可以通过模拟盘API请求除了资金提币、转账和申购赎回外的所有接口。

模拟盘API交易域名如下：

REST：https://www.okex.com

WebSocket公共频道：wss://ws.okex.com:8443/ws/v5/public?brokerId=9999

WebSocket私有频道：wss://ws.okex.com:8443/ws/v5/private?brokerId=9999

模拟盘的账户与OKEx的账户是互通的，如果您已经有OKEx账户，可以直接登录。

模拟盘API交易需要在模拟盘上创建APIKey：

登录OKEx账户—>资产管理—>开始模拟盘交易—>个人中心—>创建模拟盘APIKey—>开始模拟交易

注意：模拟盘的请求的header里面需要添加x-simulated-trading: 1。

请求头示例：

Content-Type: application/json

OK-ACCESS-KEY: 37c541a1-*--***-10fe7a038418

OK-ACCESS-SIGN: leaVRETrtaoEQ3yI9qEtI1CZ82ikZ4xSG5Kj8gnl3uw=

OK-ACCESS-PASSPHRASE: 1****6

OK-ACCESS-TIMESTAMP: 2020-03-28T12:21:41.274Z

x-simulated-trading: 1

REST API

请求验证

生成APIKey

在对任何请求进行签名之前，您必须通过OKEx网站创建一个APIKey。创建APIKey后，您将获得3个必须记住的信息：

APIKey和SecretKey将由OKEx随机生成和提供，Passphrase将由您提供以确保API访问的安全性。OKEx将存储Passphrase加密后的哈希值进行验证，但如果您忘记Passphrase，则无法恢复，请您通过OKEx网站重新生成新的APIKey。

发起请求

所有REST请求头都必须包含以下内容：

OK-ACCESS-KEY字符串类型的APIKey。

OK-ACCESS-SIGN使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）。

OK-ACCESS-TIMESTAMP发起请求的时间（UTC），如：2020-12-08T09:08:57.715Z

OK-ACCESS-PASSPHRASE您在创建API密钥时指定的Passphrase。

所有请求都应该含有application/json类型内容，并且是有效的JSON。

签名

生成签名

OK-ACCESS-SIGN的请求头是对timestamp + method + requestPath + body字符串（+表示字符串连接），以及SecretKey，使用HMAC SHA256方法加密，通过Base-64编码输出而得到的。

如：sign=CryptoJS.enc.Base64.Stringify(CryptoJS.HmacSHA256(timestamp + 'GET' + '/users/self/verify', SecretKey))

其中，timestamp的值与OK-ACCESS-TIMESTAMP请求头相同，为ISO格式，如2020-12-08T09:08:57.715Z。

method是请求方法，字母全部大写：GET/POST。

requestPath是请求接口路径。如：/api/v5/account/balance

body是指请求主体的字符串，如果请求没有主体（通常为GET请求）则body可省略。如：{"instId":"BTC-USDT","lever":"5","mgnMode":"isolated"}

SecretKey为用户申请APIKey时所生成。如：22582BD0CFF14C41EDBF1AB98506286D

账户

账户功能模块下的API接口需要身份验证。

查看账户余额

获取账户中资金余额信息。

限速： 20次/2s

HTTP请求

GET /api/v5/account/balance

请求示例

获取账户中所有资产余额
GET /api/v5/account/balance

获取账户中BTC、ETH两种资产余额
GET /api/v5/account/balance?ccy=BTC,ETH

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种，如 BTC
支持多币种查询，币种之间逗号分隔

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "uTime": "1597026383085",
        "totalEq": "41624.32",
        "isoEq": "3624.32",
        "adjEq": "41624.32",
        "imr": "4162.33",
        "mmr": "4",
        "mgnRatio": "41624.32",
        "details": [{
                "ccy": "BTC",
                "eq": "123",
                "isoEq":"",
                "availEq": "1234",
                "availBal": "",
                "frozenBal": "14",
                "ordFrozen": "1",
                "upl": "124",
                "mgnRatio": "",
                "interest": "12",
                "liab": "1"
            },
            {
                "ccy": "ETH",
                "eq": "223",
                "isoEq":"",
                "availEq": "2234",
                "availBal": "",
                "frozenBal": "141",
                "ordFrozen": "12",
                "upl": "124",
                "mgnRatio": "",
                "interest": "0",
                "liab": "0"
            }
        ]
    }]
}

返回参数

参数名 类型 描述
uTime String 获取账户信息的最新时间，Unix时间戳的毫秒数格式，如 1597026383085
totalEq String 美金层面权益
isoEq String 美金层面逐仓仓位权益
适用于单币种保证金账户和跨币种保证金账户
adjEq String 美金层面有效保证金
适用于跨币种保证金账户
imr String 美金层面占用保证金
适用于跨币种保证金账户
mmr String 美金层面维持保证金
适用于跨币种保证金账户
mgnRatio String 美金层面保证金率
适用于跨币种保证金账户
details Array 各币种资产详细信息
> ccy String 币种
> eq String 币种总权益
> isoEq String 币种逐仓仓位权益
适用于单币种保证金账户和跨币种保证金账户
> availEq String 可用保证金
适用于单币种保证金账户和跨币种保证金账户
> availBal String 可用余额
适用于交易账户
> frozenBal String 币种占用金额
> ordFrozen String 挂单冻结数量
> liab String 币种负债额
适用于跨币种保证金账户
> upl String 未实现盈亏
适用于单币种保证金账户和跨币种保证金账户
> mgnRatio String 保证金率
适用于单币种保证金账户
> interest String 计息
适用于跨币种保证金账户

各账户等级下有效字段分布

参数 交易账户 单币种保证金账户 跨币种保证金账户
uTime 是 是 是
totalEq 是 是 是
isoEq 是 是
adjEq 是
imr 是
mmr 是
mgnRatio 是
details
> ccy 是 是 是
> eq 是 是 是
> isoEq 是 是
> availEq 是 是
> availBal 是
> frozenBal 是 是 是
> ordFrozen 是 是 是
> liab 是
> upl 是 是
> mgnRatio 是
> interest 是

查看持仓信息

获取该账户下拥有实际持仓的信息。账户为单向持仓模式会显示净持仓（net），账户为双向持仓模式下会分别返回多头（long）或空头（short）的仓位。

限速：20次/2s

HTTP请求

GET /api/v5/account/positions

请求示例

查看BTC-USDT的持仓信息
GET /api/v5/account/positions?instId=BTC-USDT

请求参数

参数名 类型 是否必须 描述
instType String 否 产品类型
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
instType和instId同时传入的时候会校验instId与instType是否一致，结果返回instId的持仓信息
instId String 否 产品ID，如 BTC-USD-190927-5000-C
posId String 否 持仓ID
支持多个posId查询，逗号分割

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "instId": "BTC-USDT",
        "instType": "MARGIN",
        "mgnMode": "cross",
        "posId": "111111222",
        "posSide": "net",
        "pos": "10",
        "ccy": "BTC",
        "posCcy": "BTC",
        "availPos": "2",
        "avgPx": "3320",
        "upl": "0.00020928",
        "uplRatio": "0.00020928",
        "lever": "2",
        "liqPx": "0.00020928",
        "imr": "2",
        "margin": "",
        "mgnRatio": "",
        "mmr": "2",
        "liab": "0.00020928",
        "liabCcy": "USDT",
        "interest": "2",
        "tradeId": "2",
        "optVal": "",
        "adl": "2",
        "last":"12353.5",
        "cTime": "1597026383085",
        "uTime": "1597026383085"
    }]
}

返回参数

参数名 类型 描述
instType String 产品类型
mgnMode String 保证金模式
cross：全仓
isolated：逐仓
posId String 持仓ID
posSide String 持仓方向
long：双向持仓多头
short：双向持仓空头
net：单向持仓（交割/永续/期权：pos为正代表多头，pos为负代表空头。币币杠杆：posCcy为交易货币时，代表多头；posCcy为计价货币时，代表空头。）
pos String 持仓数量
posCcy String 仓位资产币种，仅适用于币币杠杆仓位
availPos String 可平仓数量，适用于 币币杠杆,交割/永续（开平仓模式），期权（交易账户及保证金账户逐仓）。
avgPx String 开仓平均价
upl String 未实现收益
uplRatio String 未实现收益率
instId String 产品ID，如 BTC-USD-180216
lever String 杠杆倍数，不适用于期权
liqPx String 预估强平价
不适用于跨币种保证金账户下交割/永续的全仓
不适用于期权
imr String 初始保证金，仅适用于全仓
margin String 保证金余额，可增减，仅适用于逐仓
mgnRatio String 保证金率，仅适用于逐仓
mmr String 维持保证金
liab String 负债额，仅适用于币币杠杆
liabCcy String 负债币种，仅适用于币币杠杆
interest String 利息，已经生成的未扣利息
tradeId String 最新成交ID
optVal String 期权市值，仅适用于期权
adl String 信号区
分为5档，从1到5，数字越小代表adl强度越弱
ccy String 占用保证金的币种
last String 最新成交价
cTime String 持仓创建时间，Unix时间戳的毫秒数格式，如 1597026383085
uTime String 最近一次持仓更新时间，Unix时间戳的毫秒数格式，如 1597026383085

账单流水查询（近七天）

帐户资产流水是指导致帐户余额增加或减少的行为。本接口可以查询最近7天的账单数据。

限速：5次/s

HTTP请求

GET /api/v5/account/bills

请求示例

GET /api/v5/account/bills

GET /api/v5/account/bills?instType=MARGIN

请求参数

参数名 类型 是否必须 描述
instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ccy String 否 币种
mgnMode String 否 仓位类型
isolated：逐仓
cross：全仓
ctType String 否 linear： 正向合约
inverse： 反向合约
仅交割/永续有效
type String 否 账单类型
1：划转 2：交易 3：交割 4：强制换币 5：强平 6：保证金划转 7：扣息 8：资金费 9：自动减仓 10：穿仓代偿
subType String 否 账单子类型
1：买入 2：卖出 3：开多 4：开空 5：平多 6：平空 9：扣息 11：转入 12：转出 160：手动追加保证金 161：手动减少保证金 162：自动追加保证金 110：强制换币买入 111：强制换币卖出 100：强减平多 101：强减平空 102：强减买入 103：强减卖出 104：强平平多 105：强平平空 106：强平买入 107：强平卖出 109：强平惩罚费 110：强平换币转入 111：强平换币转出 125：自动减仓平多 126：自动减仓平空 127：自动减仓买入 128：自动减仓卖出 170：到期行权 171：到期被行权 172：到期作废 112：交割平多 113：交割平空 117：交割/期权穿仓代偿 173：资金费支出 174：资金费收入
after String 否 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的billId
before String 否 请求此id之后（更新的数据）的分页内容，传的值为对应接口的billId
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "instType": "FUTURES",
            "instId": "BTC-USD-180216",
            "billId": "1234",
            "type": "1",
            "subType": "1",
            "balChg": "0.2",
            "bal": "0.3",
            "sz": "0.23",
            "ccy": "BTC",
            "mgnMode": "isolated",
            "pnl": "1",
            "fee": "0.01",
            "ts": "1597026383085",
            "ordId": "332233",
            "from": "",
            "to": "",
            "notes": ""
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
billId String 账单ID
type String 账单类型
subType String 账单子类型
ts String 账单创建时间，Unix时间戳的毫秒数格式，如 1597026383085
balChg String 账户层面的余额变动数量
posBalChg String 仓位层面的余额变动数量
bal String 账户层面的余额数量
posBal String 仓位层面的余额数量
sz String 数量
ccy String 账户余额币种
pnl String 收益
fee String 手续费
正数代表平台返佣 ，负数代表平台扣除
mgnMode String 保证金模式
isolated：逐仓 cross：全仓
账单不是由仓位变化产生的，该字段返回 ""
instId String 产品ID，如 BTC-USD-190927-5000-C
ordId String 订单ID
当账单类型不是交易时，该字段返回 ""
from String 转出账户
1：币币账户 3：交割合约 5：币币杠杆账户 6：资金账户 9：永续合约账户 12：期权合约 18：组合账户
仅适用于资金划转，不是资金划转时，返回 ""
to String 转入账户
1：币币账户 3：交割合约 5：币币杠杆账户 6：资金账户 9：永续合约账户 12：期权合约 18：组合账户
仅适用于资金划转，不是资金划转时，返回 ""
notes String 备注

账单流水查询（近三个月）

帐户资产流水是指导致帐户余额增加或减少的行为。本接口可以查询最近3个月的账单数据。

限速：5次/2s

HTTP请求

GET /api/v5/account/bills-archive

请求示例

GET /api/v5/account/bills-archive

GET /api/v5/account/bills-archive?instType=MARGIN

请求参数

参数名 类型 是否必须 描述
instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ccy String 否 币种
mgnMode String 否 保证金模式
isolated：逐仓 cross：全仓
ctType String 否 linear： 正向合约
inverse： 反向合约
仅交割/永续有效
type String 否 账单类型
1：划转 2：交易 3：交割 4：强制换币 5：强平 6：保证金划转 7：扣息 8：资金费 9：自动减仓 10：穿仓代偿
subType String 否 账单子类型
1：买入 2：卖出 3：开多 4：开空 5：平多 6：平空 9：扣息 11：转入 12：转出 160：手动追加保证金 161：手动减少保证金 162：自动追加保证金 110：强制换币买入 111：强制换币卖出 100：强减平多 101：强减平空 102：强减买入 103：强减卖出 104：强平平多 105：强平平空 106：强平买入 107：强平卖出 109：强平惩罚费 110：强平换币转入 111：强平换币转出 125：自动减仓平多 126：自动减仓平空 127：自动减仓买入 128：自动减仓卖出 170：到期行权 171：到期被行权 172：到期作废 112：交割平多 113：交割平空 117：交割/期权穿仓代偿 173：资金费支出 174：资金费收入
after String 否 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的billId
before String 否 请求此id之后（更新的数据）的分页内容，传的值为对应接口的billId
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "instType": "FUTURES",
            "instId": "BTC-USD-180216",
            "billId": "1234",
            "type": "1",
            "subType": "1",
            "balChg": "0.2",
            "bal": "0.3",
            "sz": "0.23",
            "ccy": "BTC",
            "mgnMode": "isolated",
            "pnl": "1",
            "fee": "0.01",
            "ts": "1597026383085",
            "ordId": "332233",
            "from": "",
            "to": "",
            "notes": ""
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
billId String 账单ID
type String 账单类型
subType String 账单子类型
ts String 账单创建时间，Unix时间戳的毫秒数格式，如 1597026383085
balChg String 账户层面的余额变动数量
posBalChg String 仓位层面的余额变动数量
bal String 账户层面的余额数量
posBal String 仓位层面的余额数量
sz String 数量
ccy String 账户余额币种
pnl String 收益
fee String 手续费
正数代表平台返佣 ，负数代表平台扣除
mgnMode String 保证金模式
isolated：逐仓 cross：全仓
无仓位类型字段，该字段返回 ""
instId String 产品ID，如 BTC-USD-190927-5000-C
ordId String 当type为1：交易时，返回相应订单id。无订单时，该字段返回 ""
from String 转出账户
1：币币账户 3：交割合约 5：币币杠杆账户 6：资金账户 9：永续合约账户 12：期权合约 18：组合账户
仅适用于资金划转，不是资金划转时，返回 ""
to String 转入账户
1：币币账户 3：交割合约 5：币币杠杆账户 6：资金账户 9：永续合约账户 12：期权合约 18：组合账户
仅适用于资金划转，不是资金划转时，返回 ""
notes String 备注

查看账户配置

查看当前账户的配置信息。

限速：5次/2s

HTTP请求

GET /api/v5/account/config

请求示例

GET /api/v5/account/config

请求参数

无

返回结果

{
    "code": "0",
    "msg": "",
    "date": [{
        "uid": "43812",
        "acctLv": "2",
        "posMode": "long_short_mode",
        "autoLoan": true,
        "greeksType": "BS"
    }]
}

返回参数

参数名 类型 描述
uid String 账户ID，账户uid和app上的一致
acctLv String 账户层级
1：交易账户，2：单币种保证金账户，3：跨币种保证金账户
posMode String 持仓方式
long_short_mode：双向持仓 net_mode：单向持仓
仅适用交割/永续
autoLoan Boolean 是否自动借币
true：自动借币 false：非自动借币
greeksType String 当前希腊字母展示方式
PA：币本位 BS：美元本位

设置持仓模式

交割和永续合约支持双向持仓模式和单向持仓模式。单向持仓只会有一个方向的仓位；双向持仓可以分别持有多、空2个方向的仓位。

限速：5次/2s

HTTP请求

POST /api/v5/account/set-position-mode

请求示例

POST /api/v5/account/set-position-mode
{"posMode":"long_short_mode"}

请求参数

参数名 类型 是否必须 描述
posMode String 是 持仓方式
long_short_mode：双向持仓 net_mode：单向持仓
仅适用交割/永续

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "posMode": "long_short_mode"
    }]
}

返回参数

参数名 类型 描述
posMode String 持仓方式

设置杠杆倍数

一个产品可以有如下几种杠杆设置场景：

币币杠杆逐仓杠杆倍数（币对层面）；

币币杠杆单币种保证金账户下全仓杠杆倍数（币对层面）；

币币杠杆跨币种保证金账户下全仓杠杆倍数（币种层面）；

交割/永续/期权逐仓/全仓杠杆倍数（合约层面）。

限速：5次/2s

HTTP请求

POST /api/v5/account/set-leverage

请求示例

设置逐仓杠杆（币币杠杆），币对层面
POST /api/v5/account/set-leverage 
body {"instId":"BTC-USDT","lever":"5","mgnMode":"isolated"}

设置单币种保证金账户下全仓杠杆（币币杠杆），币对层面
POST /api/v5/account/set-leverage 
body {"instId":"BTC-USDT","lever":"5","mgnMode":"cross"}

设置跨币种保证金账户下全仓杠杆（币币杠杆），币种层面
POST /api/v5/account/set-leverage 
body {"ccy":"BTC","lever":"5","mgnMode":"cross"}

设置交割合约BTC-USDT-200802杠杆多头逐仓杠杆，合约层面
POST /api/v5/account/set-leverage 
body {"instId":"BTC-USDT-200802","lever":"5","posSide":"long","mgnMode":"isolated"}

请求参数

参数名 类型 是否必须 描述
instId String 可选 产品ID：币对、合约
instId和ccy至少要传一个；如果两个都传，默认使用instId
ccy String 可选 保证金币种
仅适用于跨币种保证金账户的全仓 币币杠杆。
lever String 是 杠杆倍数
mgnMode String 是 保证金模式
isolated：逐仓 cross：全仓
如果ccy有效传值，该参数值只能为cross。
posSide String 可选 持仓方向
long：双向持仓多头
short：双向持仓空头
net：单向持仓
在双向持仓且保证金模式为逐仓条件下必填，且仅可选择 long或short，其他情况下非必填，默认net；仅适用于交割/永续

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "lever": "30",
        "mgnMode": "isolated",
        "instId": "BTC-USDT-SWAP",
        "posSide": "long"
    }]
}

返回参数

参数名 类型 描述
lever String 杠杆倍数
mgnMode String 保证金模式
isolated：逐仓 cross：全仓
instId String 产品ID
posSide String 持仓方向

获取最大可交易数量

限速：20次/2s

HTTP请求

GET /api/v5/account/max-size

请求示例

GET /api/v5/account/max-size?instId=BTC-USDT&mgnMode=isolated

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USDT-200802
tdMode String 是 交易模式
cross：全仓 isolated：逐仓 cash：非保证金
ccy String 可选 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
px String 否 委托价格
当不填委托价时会按当前最新成交价计算

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "instId": "BTC-USDT-200802",
        "maxBuy": "1",
        "maxSell": "1"
    }]
}

返回参数

参数名 类型 描述
instId String 产品ID
maxBuy String 最大可买入交易数量
币币：以币为单位，是交易币的数量；交割/永续/期权：以张为单位，是可交易的张数
maxSell String 最大可卖出交易数量

获取最大可用数量

限速：20次/2s

HTTP请求

GET /api/v5/account/max-avail-size

请求示例

获取BTC-USDT全仓币币杠杆指定BTC作为保证金最大可用数量
GET /api/v5/account/max-avail-size?instId=BTC-USDT&tdMode=cross&ccy=BTC

获取BTC-USDT币币最大可用数量
GET /api/v5/account/max-avail-size?instId=BTC-USDT&tdMode=cash

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USDT-200802
ccy String 可选 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
tdMode String 是 交易模式
cross：全仓 isolated：逐仓 cash：非保证金
reduceOnly Boolean 否 是否为只减仓模式，仅适用于币币杠杆

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "instId": "BTC-USDT-200802",
        "availBuy": "1",
        "availSell": "1"
    }]
}

返回参数

参数名 类型 描述
instId String 产品ID
availBuy String 最大买入可用数量
availSell String 最大卖出可用数量

调整保证金

增加或者减少逐仓保证金。

限速：20次/2s

HTTP请求

POST /api/v5/account/position/margin-balance

请求示例

POST /api/v5/account/position/margin-balance 
body {"instId":"BTC-USDT-200626","posSide":"short","type":"add","amt":"1"}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
posSide String 是 持仓方向，默认值是net
long：双向持仓多头
short：双向持仓空头
net：单向持仓
type String 是 增加/减少保证金
add：增加 reduce：减少
amt String 是 增加或减少的保证金数量

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "instId": "BTC-USDT-200626",
        "posSide": "short",
        "amt": "1",
        "type": "add"
    }]
}

返回参数

参数名 类型 描述
instId String 产品ID
posSide String 持仓方向，long（做多）或者short（做空）
amt String 已增加/减少的保证金数量
type String 增加/减少保证金

获取杠杆倍数

限速：20次/2s

HTTP请求

GET /api/v5/account/leverage-info

请求示例

GET /api/v5/account/leverage-info?instId=BTC-USDT-200626&mgnMode=cross

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
mgnMode String 是 保证金模式
isolated：逐仓 cross：全仓

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "instId": "BTC-USDT-200626",
        "mgnMode": "cross",
        "posSide": "long",
        "lever": "10"
    },{
        "instId": "BTC-USDT-200626",
        "mgnMode": "cross",
        "posSide": "short",
        "lever": "10"
    }]
}

返回参数

参数名 类型 描述
instId String 产品ID
mgnMode String 保证金模式
posSide String 持仓方向
long：双向持仓多头
short：双向持仓空头
net：单向持仓
仅适用于交割/永续
双向持仓模式下会返回两个方向的杠杆倍数
lever String 杠杆倍数

获取币币逐仓杠杆最大可借

限速：20次/2s

HTTP请求

GET /api/v5/account/max-loan

请求示例

GET /api/v5/account/max-loan?instId=BTC-USDT

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，仅适用于币币杠杆

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "instId": "BTC-USDT",
            "maxLoan": "0.1",
            "ccy": "BTC"
        },
        {
            "instId": "BTC-USDT",
            "maxLoan": "0.2",
            "ccy": "USDT"
        }
    ]
}

返回参数

参数名 类型 描述
instId String 产品ID，仅适用于币币杠杆
maxLoan String 最大可借
ccy String 币种

获取当前账户交易手续费费率

限速：5次/2s

HTTP请求

GET /api/v5/account/trade-fee

请求示例

获取币币BTC-USDT交易手续费率  
GET /api/v5/account/trade-fee?instType=SPOT&instId=BTC-USDT

获取第一档手续费率  
GET /api/v5/account/trade-fee?instType=SWAP&category=1

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
instId String 可选 产品ID，如 BTC-USDT
仅适用于instType为币币/币币杠杆
uly String 可选 合约标的指数
仅适用于instType为交割/永续/期权，如 BTC-USD
category String 可选 手续费档位
1：第一档 2：第二档 3：第三档 4：第四档

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "category": "1",
            "delivery": "",
            "exercise": "",
            "instType": "SPOT",
            "level": "101",
            "maker": "-0.001",
            "taker": "-0.0015",
            "ts": "1608623351857"
        }
    ]
}

返回参数

参数名 类型 描述
category String 手续费档位
taker String 吃单手续费率
maker String 挂单手续费率
delivery String 交割手续费率
exercise String 行权手续费率
level String 手续费等级
instType String 产品类型
ts String 数据返回时间，Unix时间戳的毫秒数格式，如 1597026383085

获取计息记录

限速：5次/2s

HTTP请求

GET /api/v5/account/interest-accrued

请求示例

GET /api/v5/account/interest-accrued

请求参数

参数名 类型 是否必须 描述
instId String 否 产品ID，如 BTC-USDT
仅适用于币币杠杆
ccy String 否 币种，如 BTC
mgnMode String 否 保证金模式
isolated：逐仓 cross：全仓
after String 否 查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式
before String 否 查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "instId": "BTC-USDT",
            "ccy": "USDT",
            "mgnMode": "cross",
            "interest": "0.02",
            "ts": "1597026383085"
        },
        {
            "instId": "BTC-USDT",
            "ccy": "USDT",
            "mgnMode": "cross",
            "interest": "0.02",
            "ts": "1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instId String 产品ID
ccy String 币种
mgnMode String 持仓模式
interest String 利息
ts String 计息时间，Unix时间戳的毫秒数格式 ，如 1597026383085

期权希腊字母PA/BS切换

设置希腊字母的展示方式。

限速：5次/2s

HTTP请求

POST /api/v5/account/set-greeks

请求示例

POST /api/v5/account/set-greeks 
body {"greeksType":"PA"}

请求参数

参数名 类型 是否必须 描述
greeksType String 是 希腊字母展示方式
PA：币本位，BS：美元本位

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "greeksType": "PA"
    }]
}

返回参数

参数名 类型 描述
greeksType String 当前希腊字母展示方式

查看账户最大可转余额

当指定币种时会返回该币种的最大可划转数量，不指定币种会返回所有拥有的币种资产可划转数量。

限速：20次/2s

HTTP请求

GET /api/v5/account/max-withdrawal

请求示例

GET /api/v5/account/max-withdrawal

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种，如 BTC

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "ccy": "BTC",
            "maxWd": "124"
        },
        {
            "ccy": "ETH",
            "maxWd": "10"
        }
    ]
}

返回参数

参数名 类型 描述
maxWd String 最大可划转数量
ccy String 币种

资金

资金功能模块下的API接口需要身份验证。

获取充值地址信息

获取各个币种的充值地址，包括曾使用过的老地址。

限速： 6次/s

HTTP请求

GET /api/v5/asset/deposit-address

请求示例

GET /api/v5/asset/deposit-address?ccy=BTC

请求参数

参数 类型 是否必须 描述
ccy String 是 币种，如BTC

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "addr": "okbtothemoon",
        "memo": "971668",
        "ccy": "BTC",
        "to": "6"
    }]
}

返回参数

参数名 类型 描述
addr String 充值地址
tag String 部分币种充值需要标签，若不需要则不返回此字段
memo String 部分币种充值需要标签，若不需要则不返回此字段
pmtId String 部分币种充值需要此字段（payment_id），若不需要则不返回此字段
ccy String 币种，如BTC
to String 转入账户
1：币币 3：交割合约 6：资金账户 9：永续合约 12：期权 18：组合账户

获取资金账户余额信息

获取资金账户所有资产列表，查询各币种的余额、冻结和可用等信息。

限速： 6次/s

HTTP请求

GET /api/v5/asset/balances

请求示例

GET /api/v5/asset/balances

请求参数

参数 类型 是否必须 描述
ccy String 否 币种，如 BTC
支持多币种查询，币种之间逗号分隔

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "availBal": "37.11827078",
            "bal": "37.11827078",
            "ccy": "ETH",
            "frozenBal": "0"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种，如 BTC
bal String 余额
frozenBal String 冻结（不可用）
availBal String 可用余额

资金划转

支持母账户的资金账户划转到交易账户，母账户到子账户的资金账户和交易账户划转。不支持子账户和子账户之间直接划转。

限速： 6次/s

HTTP请求

POST /api/v5/asset/transfer

请求示例

母账户USDT从资金账户划转1.5USDT到组合账户
POST /api/v5/asset/transfer
body {"ccy":"USDT","amt":"1.5","from":"6","to":"18"}

母账户从资金账户划转1.5USDT到子账户的资金账户
POST /api/v5/asset/transfer
body {"ccy":"USDT","type":"1","amt":"1.5","from":"6","to":"6","subAcct":"mini"}

母账户从组合账户划转2USDT到交割合约BTC-USD账户
POST /api/v5/asset/transfer
body {"ccy":"USDT","amt":"2","from":"18","to":"3","toInstId":"BTC-USD"}

母账户从组合账户划转2USDT到币币杠杆BTC-USDT账户
POST /api/v5/asset/transfer
body {"ccy":"USDT","amt":"2","from":"18","to":"5","toInstId":"BTC-USDT"}

请求参数

参数名 类型 是否必须 描述
ccy String 是 币种，如 USDT
amt String 是 划转数量
type String 否 0：母账户内划转
1：母账户转子账户
2：子账户转母账户
默认为0。
from String 是 转出账户
1：币币账户 3：交割合约 5：币币杠杆账户 6：资金账户 9：永续合约账户 12：期权合约 18：组合账户
to String 是 转入账户
1：币币账户 3：交割合约 5：币币杠杆账户 6：资金账户 9：永续合约账户 12：期权合约 18：组合账户
subAcct String 可选 子账户名称，type为1：母账户转子账号时，subAcct为必填项
instId String 可选 币币杠杆转出币对（如 BTC-USDT）或者转出合约的underlying（如 BTC-USD）
toInstId String 可选 币币杠杆转入币对（如 BTC-USDT）或者转入合约的underlying（如 BTC-USD）

返回结果

{
  "code": "0",
  "msg": "",
  "data": [{
    "transId": "754147",
    "ccy": "USDT",
    "from": "6",
    "amt": "0.1",
    "to": "18"
  }]
}

返回参数

参数名 类型 描述
transId String 划转ID
ccy String 划转币种
from String 转出账户
amt String 划转量
to String 转入账户

提币

用户提币。

限速： 6次/s

HTTP请求

POST /api/v5/asset/withdrawal

请求示例

POST /api/v5/asset/withdrawal
body {"amt":"1","fee":"0.0005","pwd":"123456","dest":"4","ccy":"BTC","toAddr":"17DKe3kkkkiiiiTvAKKi2vMPbm1Bz3CMKw"}

请求参数

参数名 类型 是否必须 描述
ccy String 是 币种，如 USDT
amt String 是 数量
dest String 是 提币到
3：OKEx
4：数字货币地址
68：Coinall
69：OKGAEX
71：OCNEX
75：Bbang
89：TOKR
90：4A交易平台
108：99EX
113：EthEx.com以太坊交易所
125：PICKCOIN
136：FT交易所
141：iEx
142：Exipfs
147：VitBlock
152：xFutures
153：Float SV
158：理想国
161：币爱交易所
163：Boomex
172：顺币网
173：VVcoin
175：JIAMIX
178：七十三街交易所
180：纽币
185：UnicornX
186：GazuaX
187：ETF.Pro
188：EGEMoney
189：WaterCoin
toAddr String 是 认证过的数字货币地址、邮箱或手机号。
某些数字货币地址格式为:地址+标签，如 ARDOR-7JF3-8F2E-QUWZ-CAN7F:123456
pwd String 是 交易密码
fee String 是 网络手续费≥0，提币到数字货币地址所需网络手续费可通过提币手续费接口查询

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "amt": "0.1",
        "wdId": "67485",
        "ccy": "BTC"
    }]
}

返回参数

参数名 类型 描述
ccy String 提币币种
amt String 提币数量
wdId String 提币申请ID

充值记录

根据币种，充值状态，时间范围获取充值记录，按照时间倒序排列，默认返回100条数据。

限速： 6次/s

HTTP请求

GET /api/v5/asset/deposit-history

请求示例

查询最近的充值记录
GET /api/v5/asset/deposit-history

查询从2018年09月29日到2018年10月30日之间的BTC的充值记录
GET /api/v5/asset/deposit-history?ccy=BTC&after=1597026383085&before=1597026383085

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种名称，如 BTC
state String 否 充值状态
0：等待确认 1：确认到账 2：充值成功
after String 否 查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式，如 1597026383085
before String 否 查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式，如 1597026383085
limit string 否 返回的结果集数量，默认为100，最大为100

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "amt": "0.01044408",
            "txId": "1915737_3_0_0_asset",
            "ccy": "BTC",
            "from": "13801825426",
            "to": "",
            "ts": "1597026383085",
            "state": "2",
            "depId": "4703879"
        },
        {
            "amt": "491.6784211",
            "txId": "1744594_3_184_0_asset",
            "ccy": "OKB",
            "from": "",
            "to": "",
            "ts": "1597026383085",
            "state": "2",
            "depId": "4703809"
        },
        {
            "amt": "223.18782496",
            "txId": "6d892c669225b1092c780bf0da0c6f912fc7dc8f6b8cc53b003288624c",
            "ccy": "USDT",
            "from": "",
            "to": "39kK4XvgEuM7rX9frgyHoZkWqx4iKu1spD",
            "ts": "1597026383085",
            "state": "2",
            "depId": "4703779"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种名称，如 BTC
amt String 充值数量
from String 充值地址，只显示内部账户转账地址，不显示区块链充值地址
to String 到账地址
txId String 区块转账哈希记录
ts String 充值到账时间，Unix时间戳的毫秒数格式，如 1597026383085
state String 充值状态
0：等待确认 1：确认到账 2：充值成功
depId String 充值记录ID

提币记录

根据币种，提币状态，时间范围获取提币记录，按照时间倒序排列，默认返回100条数据。

限速： 6次/s

HTTP请求

GET /api/v5/asset/withdrawal-history

请求示例

查询最近的提币记录
GET /api/v5/asset/withdrawal-history

查询从2018年09月29日到2018年10月30日之间的BTC的提币记录
GET /api/v5/asset/withdrawal-history?ccy=BTC&after=1597026383085&before=1597026383085

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种名称，如 BTC
state String 否 提币状态
-3：撤销中 -2：已撤销 -1：失败
0：等待提现 1：提现中 2：已汇出
3：邮箱确认 4：人工审核中 5：等待身份认证
after String 否 查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式，如 1597026383085
before String 否 查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式，如 1597026383085
limit string 否 返回的结果集数量，默认为100，最大为100

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "amt": "0.094",
            "wdId": "4703879",
            "fee": "0.01000000eth",
            "txId": "0x62477bac6509a04512819bb1455e923a60dea5966c7caeaa0b24eb8fb0432b85",
            "ccy": "ETH",
            "from": "13426335357",
            "to": "0xA41446125D0B5b6785f6898c9D67874D763A1519",
            "ts": "1597026383085",
            "state": "2"
        },
        {
            "amt": "0.01",
            "wdId": "4703879",
            "fee": "0.00000000btc",
            "txId": "",
            "ccy": "BTC",
            "from": "13426335357",
            "to": "13426335357",
            "ts": "1597026383085",
            "state": "2"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种
amt String 数量
ts String 提币申请时间，Unix时间戳的毫秒数格式，如 1597026383085
from String 提币地址（如果收币地址是OKEx平台地址，则此处将显示用户账户）
to String 收币地址
tag String 部分币种提币需要标签，若不需要则不返回此字段
pmtId String 部分币种提币需要此字段（payment_id），若不需要则不返回此字段
memo String 部分币种提币需要此字段，若不需要则不返回此字段
txId String 提币哈希记录（内部转账将不返回此字段）
fee String 提币手续费
state String 提币状态
-3：撤销中 -2：已撤销 -1：失败
0：等待提现 1：提现中 2：已汇出
3：邮箱确认 4：人工审核中 5：等待身份认证
wdId String 提币申请ID

获取币种列表

获取平台所有币种列表。并非所有币种都可被用于交易。

限速： 6次/s

HTTP请求

GET /api/v5/asset/currencies

请求示例

GET /api/v5/asset/currencies

请求参数

无

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "ccy": "BTC",
            "chain":"",
            "name": "",
            "canDep": true,
            "canWd": true,
            "canInternal": true,
            "minWd": "0.01",
            "maxFee":"0.02",
            "minFee":"0.0005"
        },
        {
            "ccy": "USDT",
            "chain":"USDT-ERC20",
            "name": "",
            "canDep": true,
            "canWd": true,
            "canInternal": true,
            "minWd": "0.1",
            "maxFee":"0.2",
            "minFee":"0.01"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种名称，如 BTC
name String 币种中文名称，不显示则无对应名称
chain String 有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-OMIN三个链
canDep Boolean 是否可充值，false表示不可链上充值，true表示可以链上充值
canWd Boolean 是否可提币，false表示不可链上提币，true表示可以链上提币
canInternal Boolean 是否可内部转账，false表示不可内部转账，true表示可以内部转账
minWd String 币种最小提币量
minFee String 最小提币手续费数量量
maxFee String 最大提币手续费数量量

余币宝申购/赎回

限速： 6次/s

HTTP请求

POST /api/v5/asset/purchase_redempt

请求示例

POST /api/v5/asset/purchase_redempt
body {"ccy":"BTC","amt":"1","side":"purchase"}

请求参数

参数名 类型 是否必须 描述
ccy String 是 币种名称，如 BTC
amt String 是 申购（赎回）数量
side String 是 操作类型
purchase：申购 redempt：赎回

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "ccy":"BTC",
            "amt":"1",
            "side":"purchase"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种名称
amt String 申购（赎回）数量
side String 操作类型

资金流水查询

限速：5次/s

HTTP请求

GET /api/v5/asset/bills

请求示例

GET /api/v5/asset/bills

GET /api/v5/asset/bills?type=1

请求参数

参数名 类型 是否必须 描述
ccy String 是 币种
type String 否 账单类型
1：充值
2：提现
13：撤销提现
18：转出至交割合约账户
19：从交割合约账户转入
20：转出至子账户
21：从子账户转入
28：领取
33：转出至币币杠杆账户
34：从币币杠杆账户转入
41：点卡抵扣手续费
42：购买点卡
47：系统冲正
48：活动得到
49：活动送出
50：预约得到
51：预约扣除
52：发红包
53：抢红包
54：红包退还
55：转出至永续合约账户
56：从永续合约账户转入
59：从套保账户转入
60：转出至套保账户
61：兑换
63：转出至期权合约账户
62：从期权合约账户转入
68：领取卡券权益
69：发送卡券权益
72：收币
73：送币
74：送币退还
75：申购余币宝
76：赎回余币宝
77：派发
78：锁定
79：节点投票
80：锁仓挖矿
81：投票赎回
82：锁仓赎回
83：锁仓挖矿收益
84：违约金
85：算力挖矿收益
86：云算力支付
87：云算力收益
88：补贴收益
89：存币收益
90：挖矿申购
91：挖矿赎回
92：补充质押物
93：赎回质押物
94：投资
95：借款人借款
96：投资本金转入
97：借款人借款转出
98：借款人借款利息转出
99：投资人投资利息转入
102：提前还款违约金转入
103：提前还款违约金转出
104：手续费转入
105：手续费转出
106：逾期手续费转入
107：逾期手续费转出
108：逾期利息转出
109：借款还款逾期利息转入
110：平仓质押物转入到系统账号
111：平仓质押物转出到系统账号
112：爆仓质押物转入到系统账号
113：爆仓质押物转出到系统账号
114：风险准备金转入
115：风险准备金转出
116：创建订单
117：完成订单
118：取消订单
119：商家解冻保证金
120：商家添加保证金
121：FiatGateway 创建订单
122：FiatGateway 取消订单
123：FiatGateway 完成订单
124：Jumpstart解锁
125：手动注入
126：利息注入
127：投资手续费转入
128：投资手续费转出
129：奖励转入
130：从统一账户转入
131：转出至统一账户
after String 否 查询在此之前的内容，值为时间戳，Unix时间戳为毫秒数格式，如 1597026383085
before String 否 查询在此之后的内容，值为时间戳，Unix时间戳为毫秒数格式，如 1597026383085
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "billId": "12344",
        "ccy": "BTC",
        "balChg": "2",
        "bal": "12",
        "type": "1",
        "ts": "1597026383085"
    }]
}

返回参数

参数名 类型 描述
billId String 账单ID
ccy String 账户余额币种
balChg String 账户层面的余额变动数量
bal String 账户层面的余额数量
type String 账单类型
ts String 账单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

行情数据

行情数据功能模块下的API接口不需要身份验证。

获取所有产品行情信息

获取产品行情信息

限速： 20次/2s

HTTP请求

GET /api/v5/market/tickers

请求示例

GET /api/v5/market/tickers?instType=SWAP

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数，仅适用于交割/永续/期权 ，如 BTC-USD

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instType":"SWAP",
        "instId":"LTC-USD-SWAP",
        "last":"9999.99",
        "lastSz":"0.1",
        "askPx":"9999.99",
        "askSz":"11",
        "bidPx":"8888.88",
        "bidSz":"5",
        "open24h":"9000",
        "high24h":"10000",
        "low24h":"8888.88",
        "volCcy24h":"2222",
        "vol24h":"2222",
        "sodUtc0":"0.1",
        "sodUtc8":"0.1",
        "ts":"1597026383085"
     },
     {
        "instType":"SWAP",
        "instId":"BTC-USD-SWAP",
        "last":"9999.99",
        "lastSz":"0.1",
        "askPx":"9999.99",
        "askSz":"11",
        "bidPx":"8888.88",
        "bidSz":"5",
        "open24h":"9000",
        "high24h":"10000",
        "low24h":"8888.88",
        "volCcy24h":"2222",
        "vol24h":"2222",
        "sodUtc0":"0.1",
        "sodUtc8":"0.1",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
last String 最新成交价
lastSz String 最新成交的数量
askPx String 卖一价
askSz String 卖一价的挂单数数量
bidPx String 买一价
bidSz String 买一价的挂单数量
open24h String 24小时开盘价
high24h String 24小时最高价
low24h String 24小时最低价
volCcy24h String 24小时成交量，以币为单位
如果是衍生品合约，数值为结算货币的数量。
如果是币币/币币杠杆，数值为交易货币的数量。
vol24h String 24小时成交量，以张为单位
如果是衍生品合约，数值为合约的张数。
如果是币币/币币杠杆，数值为计价货币的数量。
sodUtc0 String UTC 0 时开盘价
sodUtc8 String UTC+8 时开盘价
ts String ticker数据产生时间，Unix时间戳的毫秒数格式，如 1597026383085

获取单个产品行情信息

获取产品行情信息

限速： 20次/2s

HTTP请求

GET /api/v5/market/ticker

请求示例

GET /api/v5/market/ticker?instId=BTC-USD-SWAP

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-SWAP

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instType":"SWAP",
        "instId":"BTC-USD-SWAP",
        "last":"9999.99",
        "lastSz":"0.1",
        "askPx":"9999.99",
        "askSz":"11",
        "bidPx":"8888.88",
        "bidSz":"5",
        "open24h":"9000",
        "high24h":"10000",
        "low24h":"8888.88",
        "volCcy24h":"2222",
        "vol24h":"2222",
        "sodUtc0":"0.1",
        "sodUtc8":"0.1",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
last String 最新成交价
lastSz String 最新成交的数量
askPx String 卖一价
askSz String 卖一价对应的数量
bidPx String 买一价
bidSz String 买一价对应的数量
open24h String 24小时开盘价
high24h String 24小时最高价
low24h String 24小时最低价
volCcy24h String 24小时成交量，以币为单位
vol24h String 24小时成交量，以张为单位
sodUtc0 String UTC 0 时开盘价
sodUtc8 String UTC+8 时开盘价
ts String ticker数据产生时间，Unix时间戳的毫秒数格式，如 1597026383085

获取指数行情

获取指数行情数据

限速： 20次/2s

HTTP请求

GET /api/v5/market/index-tickers

请求示例

GET /api/v5/market/index-tickers?quoteCcy=BTC

请求参数

参数名 类型 是否必须 描述
quoteCcy String 可选 指数计价单位， 目前只有 USD/USDT/BTC为计价单位的指数，quoteCcy和instId必须填写一个
instId String 可选 指数，如 BTC-USD

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instId":"BTC-USDT",
        "idxPx":"0.1",
        "high24h":"0.5",
        "low24h":"0.1",
        "open24h":"0.1",
        "sodUtc0":"0.1",
        "sodUtc8":"0.1",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instId String 指数
idxPx String 最新指数价格
high24h String 24小时指数最高价格
low24h String 24小时指数最低价格
open24h String 24小时指数开盘价格
sodUtc0 String UTC 0 时开盘价
sodUtc8 String UTC+8 时开盘价
ts String 指数价格更新时间，Unix时间戳的毫秒数格式，如1597026383085

获取产品深度

获取产品深度列表

限速： 20次/2s

HTTP请求

GET /api/v5/market/books

请求示例

GET /api/v5/market/books?instId=BTC-USD-SWAP

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927-5000-C
sz String 否 深度档位数量，最大值可传200，即买卖深度共400条
不填写此参数，默认返回1档深度数据

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "asks":[
                [
                    "411.8","10","0","8" 
                ],
                [
                    "1","2","3","6"
                ]
            ],
            "bids":[
                [
                    "1","2","3","6"
                ],
                [
                    "1","2","3","6"
                ]
            ],
            "ts":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
asks Array 卖方深度
bids Array 买方深度
ts String 深度产生的时间

获取所有交易产品K线数据

获取K线数据。K线数据按请求的粒度分组返回，K线数据每个粒度最多可获取最近1440条。

限速： 20次/2s

HTTP请求

GET /api/v5/market/candles

请求示例

GET /api/v5/market/candles?instId=BTC-USD-190927-5000-C

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如BTC-USD-190927-5000-C
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ts
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ts
bar String 否 时间粒度，默认值1m
如 [1m/3m/5m/15m/30m/1H/2H/4H/6H/12H/1D/1W/1M/3M/6M/1Y]
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     [
        "1597026383085",
        "3.721",
        "3.743",
        "3.677",
        "3.708",
        "8422410",
        "22698348.04828491"
    ],
    [
        "1597026383085",
        "3.731",
        "3.799",
        "3.494",
        "3.72",
        "24912403",
        "67632347.24399722"
    ]
    ]
}

返回参数

参数名 类型 描述
ts String 数据生成的时间，Unix时间戳的毫秒数格式，如 1597026383085
o String 开盘价格
h String 最高价格
l String 最低价格
c String 收盘价格
vol String 交易量（按张折算）
volCcy String 交易量（按币折算）

获取交易产品历史K线数据（仅主流币）

获取最近几年的历史k线数据

限速： 20次/2s

HTTP请求

GET /api/v5/market/history-candles

请求示例

GET /api/v5/market/history-candles?instId=BTC-USD-190927

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如BTC-USD-200927
after String 否 请求时间戳之前（更旧的数据）的分页内容，传的值为对应接口的ts
before String 否 请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的ts
bar String 否 时间粒度，默认值1m
如 [1m/3m/5m/15m/30m/1H/2H/4H/6H/12H/1D/1W/1M/3M/6M/1Y]
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     [
        "1597026383085",
        "3.721",
        "3.743",
        "3.677",
        "3.708",
        "8422410",
        "22698348.04828491"
    ],
    [
        "1597026383085",
        "3.731",
        "3.799",
        "3.494",
        "3.72",
        "24912403",
        "67632347.24399722"
    ]
    ]
}

返回参数

参数名 类型 描述
ts String 数据生成的时间，Unix时间戳的毫秒数格式，如 1597026383085
o String 开盘价格
h String 最高价格
l String 最低价格
c String 收盘价格
vol String 交易量（按张折算）
volCcy String 交易量（按币折算）

获取指数K线数据

指数K线数据每个粒度最多可获取最近1440条。

限速： 20次/2s

HTTP请求

GET /api/v5/market/index-candles

请求示例

GET /api/v5/market/index-candles?instId=BTC-USD

请求参数

参数名 类型 是否必须 描述
instId String 是 现货指数，如BTC-USD
after String 否 请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的ts
before String 否 请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的ts
bar String 否 时间粒度，默认值1m
如 [1m/3m/5m/15m/30m/1H/2H/4H/6H/12H/1D/1W/1M/3M/6M/1Y]
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     [
        "1597026383085",
        "3.721",
        "3.743",
        "3.677",
        "3.708"
    ],
    [
        "1597026383085",
        "3.731",
        "3.799",
        "3.494",
        "3.72"
    ]
    ]
}

返回参数

参数名 类型 描述
ts String 开始时间，Unix时间戳的毫秒数格式，如 1597026383085
o String 开盘价格
h String 最高价格
l String 最低价格
c String 收盘价格

获取标记价格K线数据

标记价格K线数据每个粒度最多可获取最近1440条。

限速： 20次/2s

HTTP请求

GET /api/v5/market/mark-price-candles

请求示例

GET /api/v5/market/mark-price-candles?instId=BTC-USD-SWAP

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如BTC-USD-SWAP
after String 否 请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的ts
before String 否 请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的ts
bar String 否 时间粒度，默认值1m<`br>如 [1m/3m/5m/15m/30m/1H/2H/4H/6H/12H/1D/1W/1M/3M/6M/1Y]
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     [
        "1597026383085",
        "3.721",
        "3.743",
        "3.677",
        "3.708"
    ],
    [
        "1597026383085",
        "3.731",
        "3.799",
        "3.494",
        "3.72"
    ]
    ]
}

返回参数

参数名 类型 描述
ts String 开始时间，Unix时间戳的毫秒数格式，如 1597026383085
o String 开盘价格
h String 最高价格
l String 最低价格
c String 收盘价格

获取交易产品公共成交数据

查询市场上的成交信息数据

限速： 20次/2s

HTTP请求

GET /api/v5/market/trades

请求示例

GET /api/v5/market/trades?instId=BTC-USDT

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD
limit String 否 分页返回的结果集数量，最大为500，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instId":"BTC-USDT",
        "tradeId":"9",
        "px":"0.016",
        "sz":"50",
        "side":"buy",
        "ts":"1597026383085"
    },
    {
        "instId":"BTC-USDT",
        "tradeId":"9",
        "px":"0.016",
        "sz":"50",
        "side":"buy",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instId String 产品ID ，如 BTC-USDT-201227
tradeId String 成交ID
px String 成交价格
sz String 成交数量
side String 成交方向
buy：买
sell：卖
ts String 成交时间，Unix时间戳的毫秒数格式， 如1597026383085

公共数据

公共数据功能模块下的API接口不需要身份验证。

获取交易产品基础信息

获取所有可交易产品的信息列表。

限速： 20次/2s

HTTP请求

GET /api/v5/public/instruments

请求示例

GET /api/v5/public/instruments?instType=SPOT

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 可选 合约标的指数，仅适用于交割/永续/期权，期权必填
instId String 否 产品ID

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instType":"SWAP",
        "instId":"LTC-USD-SWAP",
        "uly":"LTC-USD",
        "category":"1",
        "baseCcy":"",
        "quoteCcy":"",
        "settleCcy":"LTC",
        "ctVal":"10",
        "ctMult":"1",
        "ctValCcy":"USD",
        "optType":"C",
        "stk":"",
        "listTime":"1597026383085",
        "expTime":"1597026383085",
        "lever":"10",
        "tickSz":"0.01",
        "lotSz":"1",
        "minSz":"1",
        "ctType":"linear",
        "alias":"this_week",
        "state":"live"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品id， 如 BTC-USD-SWAP
uly String 合约标的指数，如 BTC-USD ，仅适用于交割/永续/期权
category String 手续费档位，每个交易产品属于哪个档位手续费
baseCcy String 交易货币币种，如 BTC-USDT 中的 BTC ，仅适用于币币
quoteCcy String 计价货币币种，如 BTC-USDT 中的USDT ，仅适用于币币
settleCcy String 盈亏结算和保证金币种，如 BTC 仅适用于交割/永续/期权
ctVal String 合约面值 ，仅适用于交割/永续/期权
ctMult String 合约乘数 ，仅适用于交割/永续/期权
ctValCcy String 合约面值计价币种，仅适用于交割/永续/期权
optType String 期权类型，C或P 仅适用于期权
stk String 行权价格 ，仅适用于期权
listTime String 上线日期 ，仅适用于交割 和 期权
Unix时间戳的毫秒数格式，如 1597026383085
expTime String 交割日期 仅适用于交割 和 期权
Unix时间戳的毫秒数格式，如 1597026383085
lever String 杠杆倍数 ， 不适用于币币，用于区分币币和币币杠杆
tickSz String 下单价格精度， 如 0.0001
lotSz String 下单数量精度， 如 BTC-USDT-SWAP：1
minSz String 最小下单数量
ctType String linear：正向合约
inverse：反向合约
仅交割/永续有效
alias String 合约日期别名
this_week：本周
this_week：次周
quarter：季度
next_quarter：次季度
仅适用于交割
state String 产品状态
live：交易中
suspend：暂停中
preopen：预上线

获取交割和行权记录

获取交割合约的交割记录和期权的行权记录

限速： 40次/2s

HTTP请求

GET /api/v5/public/delivery-exercise-history

请求示例

GET /api/v5/public/delivery-exercise-history?instType=OPTION&uly=BTC-USD

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
FUTURES：交割合约
OPTION：期权
uly String 是 合约标的指数，仅适用于交割/期权
after String 否 请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的ts
before String 否 请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的ts
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "ts":"1597026383085",
            "details":[
                {
                    "type":"delivery",
                    "insId":"BTC-USD-190927",
                    "px":"0.016"
                }
            ]
        },
        {
            "ts":"1597026383085",
            "details":[
                {
                    "insId":"BTC-USD-200529-6000-C",
                    "type":"exercised",
                    "px":"0.016"
                },
                {
                    "insId":"BTC-USD-200529-8000-C",
                    "type":"exercised",
                    "px":"0.016"
                }
            ]
        }
    ]
}

返回参数

参数名 类型 描述
ts String 交割/行权日期，Unix时间戳的毫秒数格式，如 1597026383085
details String 详细数据
> insId String 交割/行权的合约ID
> px String 交割/行权的价格
> type String 类型
delivery：交割
exercised：实值已行权
expired_otm：虚值已过期

获取持仓总量

查询单个交易产品的市场的持仓总量

限速： 20次/2s

HTTP请求

GET /api/v5/public/open-interest

请求示例

GET /api/v5/public/open-interest?instType=SWAP

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数，仅适用于交割/永续/期权，期权必填
instId String 否 产品ID，如 BTC-USD-180216
仅适用于交割/永续/期权

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instType":"SWAP",
        "instId":"BTC-USDT-SWAP",
        "oi":"5000",
        "oiCcy":"555.55",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
insId String 产品ID
oi String 持仓量（按张折算）
oiCcy String 持仓量（按币折算）
ts String 数据返回时间， Unix时间戳的毫秒数格式 ，如 1597026383085

获取永续合约当前资金费率

获取当前资金费率

限速： 20次/2s

HTTP请求

GET /api/v5/public/funding-rate

请求示例

GET /api/v5/public/funding-rate?instId=BTC-USD-SWAP

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID ，如 BTC-USD-SWAP
仅适用于永续

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instType":"SWAP",
        "instId":"BTC-USDT-SWAP",
        "fundingRate":"0.018",
        "nextFundingRate":"0.017",
        "fundingTime":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型 SWAP：永续合约
insId String 产品ID，如BTC-USD-SWAP
fundingRate String 资金费率
nextFundingRate String 下一期预测资金费率
fundingTime String 资金费时间 ，Unix时间戳的毫秒数格式，如 1597026383085

获取永续合约历史资金费率

获取最近3个月的历史资金费率

限速： 20次/2s

HTTP请求

GET /api/v5/public/funding-rate-history

请求示例

GET /api/v5/public/funding-rate-history?instId=BTC-USD-SWAP

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID ，如 BTC-USD-SWAP
仅适用于永续
after String 否 请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的ts
before String 否 请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的ts
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instType":"SWAP",
        "instId":"BTC-USDT-SWAP",
        "fundingRate":"0.018",
        "realizedRate":"0.017",
        "fundingTime":"1597026383085"
    },
    {
        "instType":"SWAP",
        "instId":"BTC-USDT-SWAP",
        "fundingRate":"0.018",
        "realizedRate":"0.017",
        "fundingTime":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
SWAP：永续合约
insId String 产品ID，如 BTC-USD-SWAP
fundingRate String 资金费率
realizedRate String 实际资金费率
fundingTime String 资金费时间，Unix时间戳的毫秒数格式，如 1597026383085

获取限价

查询单个交易产品的最高买价和最低卖价

限速： 20次/2s

HTTP请求

GET /api/v5/public/price-limit

请求示例

GET /api/v5/public/price-limit?instId=BTC-USD-180216

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-180216
仅适用于交割/永续/期权

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instType":"SWAP",
        "instId":"BTC-USDT-SWAP",
        "buyLmt":"200",
        "sellLmt":"300",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
insId String 产品ID ，如 BTC-USD-200214
buyLmt String 最高买价
sellLmt String 最低卖价
ts String 限价数据更新时间 ，Unix时间戳的毫秒数格式，如 1597026383085

获取期权定价

查询期权详细信息

限速： 20次/2s

HTTP请求

GET /api/v5/public/opt-summary

请求示例

GET /api/v5/public/opt-summary?uly=BTC-USD

请求参数

参数名 类型 是否必须 描述
uly String 是 合约标的指数，仅适用于期权
expTime String 否 合约到期日，格式为"YYMMDD"，如 "200527"

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
      {
        "instType":"OPTION",
        "instId":"BTC-USD-200103-5500-C",
        "uly":"BTC-USD",
        "delta":"0.7494223636",
        "gamma":"-0.6765419039",
        "theta":"-0.0000809873",
        "vega":"0.0000077307",
        "deltaBS":"0.7494223636",
        "gammaBS":"-0.6765419039",
        "thetaBS":"-0.0000809873",
        "vegaBS":"0.0000077307",
        "realVol":"0",
        "bidVol":"",
        "askVol":"1.5625",
        "markVol":"0.9987",
        "lever":"4.0342",
        "ts":"1597026383085"
    },
    {
        "instType":"OPTION",
        "instId":"BTC-USD-200103-6500-C",
        "uly":"BTC-USD",
        "delta":"0.7494223636",
        "gamma":"-0.6765419039",
        "theta":"-0.0000809873",
        "vega":"0.0000077307",
        "deltaBS":"0.7494223636",
        "gammaBS":"-0.6765419039",
        "thetaBS":"-0.0000809873",
        "vegaBS":"0.0000077307",
        "realVol":"0",
        "bidVol":"",
        "askVol":"1.5625",
        "markVol":"0.9987",
        "lever":"4.0342",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
OPTION：期权
insId String 产品ID，如 BTC-USD-200103-5500-C
uly String 合约标的指数
delta String 期权价格对uly价格的敏感度
gamma String delta对uly价格的敏感度
vega String 权价格对隐含波动率的敏感度
theta String 期权价格对剩余期限的敏感度
deltaBS String BS模式下期权价格对uly价格的敏感度
gammaBS String BS模式下delta对uly价格的敏感度
vegaBS String BS模式下期权价格对隐含波动率的敏感度
thetaBS String BS模式下期权价格对剩余期限的敏感度
lever String 杠杆倍数
markVol String 标记波动率
bidVol String bid波动率
askVol String ask波动率
realVol String 已实现波动率（目前该字段暂未启用）
ts String 数据更新时间，Unix时间戳的毫秒数格式，如 1597026383085

获取预估交割/行权价格

获取交割合约和期权预估交割/行权价。交割/行权预估价只有交割/行权前一小时才有返回值

限速： 10次/2s

HTTP请求

GET /api/v5/public/estimated-price

请求示例

GET /api/v5/public/estimated-price?instId=BTC-USDT-191227

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID， 如 BTC-USD-200214
仅适用于交割/期权

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instType":"SWAP",
        "instId":"BTC-USDT-201227",
        "settlePx":"200",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
FUTURES：交割合约
OPTION：期权
instId String 产品ID， 如 BTC-USD-180216
settlePx String 预估交割、行权价格
ts String 数据返回时间 ，Unix时间戳的毫秒数格式，如 1597026383085

获取免息额度和币种折算率

获取免息额度和币种折算率

限速： 10次/2s

HTTP请求

GET /api/v5/public/discount-rate-interest-free-quota

请求示例

GET /api/v5/public/discount-rate-interest-free-quota?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "ccy":"BTC",
            "amt" :"2" ,
            "discount" :"1"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种
amt String 免息额度
discount String 折算率

获取系统时间

获取系统时间

限速： 10次/2s

HTTP请求

GET /api/v5/public/time

请求示例

GET /api/v5/public/time

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
ts String 系统时间，Unix时间戳的毫秒数格式，如 1597026383085

获取平台公共爆仓单信息

最近1个月的爆仓单信息

限速： 40次/2s

HTTP请求

GET /api/v5/public/liquidation-orders

请求示例

GET /api/v5/public/liquidation-orders?instType=MARGIN

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
mgnMode String 否 保证金模式
cross：全仓
isolated：逐仓
instId String 否 产品ID，仅适用于币币杠杆
ccy String 否 币种 ，仅适用于币币杠杆（全仓）
uly String 可选 合约标的指数
交割/永续/期权合约情况下，该参数必填
alias String 可选 this_week：本周
next_week：次周
quarter：季度
next_quarter：次季度
交割合约情况下，该参数必填
state String 可选 状态
unfilled：未成交
filled：已成交
交割/永续合约情况下，该参数必填
before String 否 请求此时间戳之后（更新的数据）的分页内容，传的值为对应接口的ts
after String 否 请求此时间戳之前（更旧的数据）的分页内容，传的值为对应接口的ts
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instType":"2",
        "totalLoss":"123",
        "instId":"btc",
        "uly":"123",
         "details":[
                {
                    "side":"buy",
                    "posSide":"short",
                    "bkPx":"1234",
                    "sz":"1415",
                    "bkLoss":"14",
                    "ccy":"",
                    "ts":"1597026383085"
                },
                {
                    "side":"buy",
                    "posSide":"short",
                    "bkPx":"1234",
                    "sz":"1415",
                    "bkLoss":"14",
                    "ccy":"",
                    "ts":"1597026383085"
                }
            ]
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
totalLoss String 当前underlying下，当期内的总穿仓亏损
以USDT为单位，每天16:00（UTC+8）清零
instId String 产品ID，如 BTC-USD-SWAP
uly String 合约标的指数，仅适用于交割/永续/期权
details Array 详细内容
>side String 订单方向 buy：买 sell：卖
>posSide String 持仓方向，long：多 ；short：空
side和posSide组合方式，sell/long：强平多 ; buy short:强平空>
>bkPx String 破产价格
>sz String 强平数量
>bkLoss String 穿仓亏损数量
>ccy String 强平币种，仅适用于币币杠杆
>ts String 强平发生的时间，Unix时间戳的毫秒数格式，如 1597026383085

获取标记价格

为了防止个别用户恶意操控市场导致合约价格波动剧烈，我们根据现货指数和合理基差设定标记价格。

限速： 10次/2s

HTTP请求

GET /api/v5/public/mark-price

请求示例

GET /api/v5/public/mark-price?instType=SWAP

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数
instId String 否 产品ID，如 BTC-USD-SWAP

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
        "instType":"SWAP",
        "instId":"BTC-USDT-SWAP",
        "markPx":"200",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
insId String 产品ID，如 BTC-USD-200214
markPx String 标记价格
ts String 接口数据返回时间，Unix时间戳的毫秒数格式，如1597026383085

交易

交易功能模块下的API接口需要身份验证。

下单

只有当您的账户有足够的资金才能下单。

限速： 60次/2s

HTTP请求

POST /api/v5/trade/order

请求示例

 币币下单：
 POST /api/v5/trade/order
 body{"instId":"BTC-USDT","tdMode":"cash","clOrdId":"b15","side":"buy","ordType":"limit","px":"2.15","sz":"2"}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927-5000-C
tdMode String 是 交易模式
保证金模式：isolated：逐仓 ；cross：全仓
非保证金模式：cash：非保证金
ccy String 否 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
clOrdId String 否 客户自定义订单ID
字母（区分大小写）与数字的组合，必须以字母开头，可以是纯字母，且长度要在1-32位之间。
tag String 否 订单标签
字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-8位之间。
side String 是 订单方向 buy：买 sell：卖
posSide String 可选 持仓方向 在双向持仓模式下必填，且仅可选择 long 或 short
ordType String 是 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
sz String 是 委托数量
px String 可选 委托价格，仅适用于限价单
reduceOnly Boolean 否 是否只减仓，true 或 false，默认false
仅适用于币币杠杆订单

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "clOrdId":"oktswap6",
            "ordId":"12345689",
            "tag":"",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

批量下单

每次最多可以批量提交20个新订单。

限速： 300次/2s

HTTP请求

POST /api/v5/trade/batch-orders

请求示例

 币币批量下单：
 Post：/api/v5/trade/batch-orders

 body[{"instId":"BTC-USDT","tdMode":"cash","clOrdId":"b15","side":"buy","ordType":"limit","px":"2.15","sz":"2"},{"instId":"BTC-USDT","tdMode":"cash","clOrdId":"b15","side":"buy","ordType":"limit","px":"2.15","sz":"2"}]

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927-5000-C
tdMode String 是 交易模式
保证金模式：isolated：逐仓 ；cross：全仓
非保证金模式：cash：非保证金
ccy String 否 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
clOrdId String 否 客户自定义订单ID
字母（区分大小写）与数字的组合，必须以字母开头，可以是纯字母，且长度要在1-32位之间。
tag String 否 订单标签
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-8位之间。
side String 是 订单方向 buy：买 sell：卖
posSide String 可选 持仓方向 在双向持仓模式下必填，且仅可选择 long 或 short
ordType String 是 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
sz String 是 委托数量
px String 否 委托价格
reduceOnly Boolean 否 是否只减仓 true 或 false，默认false

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "clOrdId":"oktswap6",
            "ordId":"12345689",
            "tag":"",
            "sCode":"0",
            "sMsg":""
        },
        {
            "clOrdId":"oktswap7",
            "ordId":"12344",
            "tag":"",
            "sCode":"0",
            "sMsg":""
        },
     .......
    ]
}

返回参数

参数名 类型 描述
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

撤单

撤销之前下的未完成订单。

限速： 60次/2s

HTTP请求

POST /api/v5/trade/cancel-order

请求示例

POST /api/v5/trade/cancel-order

body {"ordId":"2510789768709120","instId":"BTC-USD-190927"}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927
ordId String 可选 订单ID， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义ID

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "clOrdId":"oktswap6",
            "ordId":"12345689",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
ordId String 订单ID
clOrdId String 客户自定义订单ID
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

批量撤单

撤销未完成的订单，每次最多可以撤销20个订单。

限速： 300次/2s

HTTP请求

POST /api/v5/trade/cancel-batch-orders

请求示例

POST /api/v5/trade/cancel-batch-orders

body [{"instId":"BTC-USDT","ordId":"12312"},{"instId":"BTC-USDT","ordId":"1212"}]

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927
ordId String 可选 订单ID， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义ID

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "clOrdId":"oktswap6",
            "ordId":"12345689",
            "sCode":"0",
            "sMsg":""
        },
        {
            "clOrdId":"oktswap7",
            "ordId":"12344",
            "sCode":"0",
            "sMsg":""
        },
     .......
    ]
}

返回参数

参数名 类型 描述
ordId String 订单ID
clOrdId String 客户自定义订单ID
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

修改订单

修改当前未成交的挂单

限速： 60次/2s

HTTP请求

POST /api/v5/trade/amend-order

请求示例

POST /api/v5/trade/amend-order

body {"ordId":"2510789768709120","newSz":"2","instId":"BTC-USDT"}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
cxlOnFail Boolean 否 false：不自动撤单 true：自动撤单 当订单修改失败时，该订单是否需要自动撤销。默认为false
ordId String 可选 订单ID， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义order ID
reqId String 否 用户自定义修改事件ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
newSz String 可选 修改的新数量，newSz和newPx不可同时为空。对于部分成交订单，该数量应包含已成交数量。
newPx String 可选 修改的新价格

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
         "clOrdId":"",
         "ordId":"12344",
         "reqId":"b12344",
         "sCode":"0",
         "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
ordId String 订单ID
clOrdId String 用户自定义ID
reqId String 用户自定义修改事件ID
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

批量修改订单

修改未完成的订单，一次最多可批量修改20个订单。

限速： 300次/2s

HTTP请求

POST /api/v5/trade/amend-batch-orders

请求示例

POST /api/v5/trade/amend-batch-orders

body [{"ordId":"2510789768709120","newSz":"2","instId":"BTC-USDT"},{"ordId":"2510789768709121","newSz":"2","instId":"BTC-USDT"}]

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
cxlOnFail Boolean 否 false ：不自动撤单 true：自动撤单 当订单修改失败时，该订单是否需要自动撤销，默认为false
ordId String 可选 订单ID， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义order ID
reqId String 否 用户自定义修改事件ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
newSz String 可选 修改的新数量，newSz和newPx不可同时为空。对于部分成交订单，该数量应包含已成交数量。
newPx String 可选 修改的新价格

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "clOrdId":"oktswap6",
            "ordId":"12345689",
            "reqId":"b12344",
            "sCode":"0",
            "sMsg":""
        },
        {
            "clOrdId":"oktswap7",
            "ordId":"12344",
            "reqId":"b12344",
            "sCode":"0",
            "sMsg":""
        },
     .......
    ]
}

返回参数

参数名 类型 描述
ordId String 订单ID
clOrdId String 用户自定义ID
reqId String 用户自定义修改事件ID
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

市价仓位全平

市价平掉某个合约下的全部持仓

限速： 20次/2s

HTTP请求

POST /api/v5/trade/close-position

请求示例

POST /api/v5/trade/close-position
body {"instId":"BTC-USDT-SWAP","mgnMode":"cross"}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
posSide String 可选 持仓方向
单向持仓模式下：可不填写此参数，默认值net，如果填写，仅可以填写net
双向持仓模式下： 必须填写此参数，且仅可以填写 long：平多 ，short：平空
mgnMode String 是 保证金模式
全仓：cross ； 逐仓： isolated
ccy String 可选 保证金币种，单币种保证金账户的全仓币币杠杆平仓必填

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
           {
            "instId":"BTC-USDT-SWAP",
            "posSide":"long"
          }
    ]
}

返回参数

参数名 类型 描述
instId String 产品ID
posSide String 持仓方向

获取订单信息

查订单信息

限速： 60次/2s

HTTP请求

GET /api/v5/trade/order

请求示例

GET /api/v5/trade/order?ordId=2510789768709120&instId=BTC-USDT

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID ，如BTC-USD-190927
ordId String 可选 订单ID ， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义ID

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ccy":"",
            "ordId":"123445",
            "clOrdId":"b1",
            "tag":"",
            "px":"999",
            "sz":"3",
            "pnl":"5",
            "ordType":"limit",
            "side":"buy",
            "posSide":"long",
            "tdMode":"isolated",
            "accFillSz":"isolated",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "state":"live",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金账户下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
pnl String 收益
ordType String 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
accFillSz String 累计成交数量
fillPx String 最新成交价格
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
avgPx String 成交均价
state String 订单状态
canceled：撤单成功
live：等待成交
partially_filled：部分成交
filled：完全成交
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费，平台向用户收取的交易手续费，手续费扣除 为负数。如： -0.01
rebateCcy String 返佣金币种
rebate String 返佣金额，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”。 手续费返佣 为正数，如：0.01
category String 订单种类
normal：普通委托
twap：TWAP自动换币
adl：ADL自动减仓
full_liquidation：强制平仓
partial_liquidation：强制减仓
uTime String 订单状态更新时间， Unix时间戳的毫秒数格式，如：1597026383085
cTime String 订单创建时间， Unix时间戳的毫秒数格式， 如 ：1597026383085

获取未成交订单列表

获取当前账户下所有未成交订单信息

限速： 20次/2s

HTTP请求

GET /api/v5/trade/orders-pending

请求示例

GET /api/v5/trade/orders-pending?ordType=post_only,fok,ioc&instType=SPOT

请求参数

参数名 类型 是否必须 描述
instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数
instId String 否 产品ID，如BTC-USD-200927
ordType String 否 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
state String 否 订单状态
live：等待成交
partially_filled：部分成交
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordId
limit String 否 返回结果的数量，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ccy":"",
            "ordId":"123445",
            "clOrdId":"b1",
            "tag":"",
            "px":"999",
            "sz":"3",
            "pnl":"5",
            "ordType":"limit",
            "side":"buy",
            "posSide":"long",
            "tdMode":"isolated",
            "accFillSz":"isolated",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "state":"live",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金账户下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
pnl String 收益
ordType String 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
accFillSz String 累计成交数量
fillPx String 最新成交价格
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
avgPx String 成交均价
state String 订单状态
live：等待成交
partially_filled：部分成交
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费，平台向用户收取的交易手续费，手续费扣除 为负数。如： -0.01
rebateCcy String 返佣金币种
rebate String 返佣金额，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”。 手续费返佣 为正数，如：0.01
category String 订单种类
normal： 普通委托
twap：TWAP自动换币
uTime String 订单状态更新时间， Unix时间戳的毫秒数格式，如 1597026383085
cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085

获取历史订单记录（近七天）

获取最近7天的已经完结状态的订单数据，已经撤销的未成交单 只保留2小时

限速： 40次/2s

HTTP请求

GET /api/v5/trade/orders-history

请求示例

GET /api/v5/trade/orders-history?ordType=post_only,fok,ioc&instType=SPOT

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数
instId String 否 产品ID，如BTC-USD-190927
ordType String 否 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
state String 否 订单状态
canceled：撤单成功
filled：完全成交
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordId
limit String 否 返回结果的数量，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ccy":"",
            "ordId":"123445",
            "clOrdId":"b1",
            "tag":"",
            "px":"999",
            "sz":"3",
            "ordType":"limit",
            "side":"buy",
            "posSide":"long",
            "tdMode":"isolated",
            "accFillSz":"isolated",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "state":"live",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "pnl":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金账户下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
ordType String 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
accFillSz String 累计成交数量
fillPx String 最新成交价格
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
avgPx String 成交均价
state String 订单状态
canceled：撤单成功
filled：完全成交
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费，平台向用户收取的交易手续费，手续费扣除 为负数。如： -0.01
rebateCcy String 返佣金币种
rebate String 返佣金额，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”。 手续费返佣 为正数，如：0.01
pnl String 收益
category String 订单种类
normal：普通委托
twap：TWAP自动换币
adl：ADL自动减仓
full_liquidation：强制平仓
partial_liquidation：强制减仓
uTime String 订单状态更新时间， Unix时间戳的毫秒数格式，如1597026383085
cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085

获取历史订单记录（近三个月）

获取最近3个月的已经完结状态的订单数据，已经撤销的未成交单 只保留2小时

限速： 20次/2s

HTTP请求

GET /api/v5/trade/orders-history-archive

请求示例

GET /api/v5/trade/orders-history-archive?ordType=post_only,fok,ioc&instType=SPOT

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数
instId String 否 产品ID，如BTC-USD-200927
ordType String 否 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
state String 否 订单状态
canceled：撤单成功
filled：完全成交
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordId
limit String 否 返回结果的数量，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ccy":"",
            "ordId":"123445",
            "clOrdId":"b1",
            "tag":"",
            "px":"999",
            "sz":"3",
            "ordType":"limit",
            "side":"buy",
            "posSide":"long",
            "tdMode":"isolated",
            "accFillSz":"isolated",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "state":"live",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "pnl":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金账户下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
ordType String 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
accFillSz String 累计成交数量
fillPx String 最新成交价格
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
avgPx String 成交均价
state String 订单状态
canceled：撤单成功
filled：完全成交
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费，平台向用户收取的交易手续费，手续费扣除 为负数。如： -0.01
rebateCcy String 返佣金币种
rebate String 返佣金额，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”。 手续费返佣 为正数，如：0.01
pnl String 收益
category String 订单种类
normal：普通委托
twap：TWAP自动换币
adl：ADL自动减仓
full_liquidation：强制平仓
partial_liquidation：强制减仓
uTime String 订单状态更新时间， Unix时间戳的毫秒数格式，如 1597026383085
cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085

获取成交明细

获取订单成交明细信息信息

限速： 60次/2s

HTTP请求

GET /api/v5/trade/fills

请求示例

GET /api/v5/trade/fills

请求参数

参数名 类型 是否必须 描述
instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
uly String 否 合约标的指数
instId String 否 产品ID，如BTC-USD-190927
ordId String 否 订单ID
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的billId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的billId
limit String 否 返回结果的数量，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
         {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "tradeId":"123",
            "ordId":"123445",
            "billId":"1111",
            "tag":"",
            "fillPx":"999",
            "fillSz":"3",
            "side":"buy",
            "posSide":"long",
            "execType":"M",             
            "feeCcy":"",
            "fee":"",
            "ts":"1597026383085"
        },
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "tradeId":"123",
            "ordId":"123445",
            "billId":"1111",
            "tag":"",
            "fillPx":"999",
            "fillSz":"3",
            "side":"buy",
            "posSide":"long",
            "execType":"M",             
            "feeCcy":"",
            "fee":"",
            "ts":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tradeId String 最新成交ID
ordId String 订单ID
billId String 账单ID
tag String 订单标签
fillPx String 最新成交价格
fillSz String 最新成交数量
side String 订单方向 buy：买 sell：卖
posSide String 持仓方向 long：多 short：空 单向持仓模式返回 net
execType String 流动性方向 T：taker M：maker
feeCcy String 交易手续费币种或者返佣金币种
fee String 手续费金额或者返佣金额 ，手续费扣除 为 ‘负数’，如 -0.01 ； 手续费返佣 为 ‘正数’，如0.01
ts String 成交明细产生时间， Unix时间戳的毫秒数格式，如 1597026383085

策略委托下单

提供单向止盈止损委托 、双向止盈止损委托、计划委托

限速： 20次/2s

HTTP请求

POST /api/v5/trade/order-algo

请求示例

POST /api/v5/trade/order-algo

body {"instId":"BTC-USDT","tdMode":"cross","side":"buy","ordType":"conditional","sz":"2","tpTriggerPx":"15","tpOrdPx":"18"}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927-5000-C
tdMode String 是 交易模式
保证金模式：isolated：逐仓 ；cross：全仓
非保证金模式：cash：非保证金
ccy String 否 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
side String 是 订单方向 buy：买 sell：卖
posSide String 否 持仓方向 在双向持仓模式下必填，且仅可选择 long 或 short
ordType String 是 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
sz String 是 委托数量
reduceOnly Boolean 否 是否只减仓 true 或 false

止盈止损

参数名 类型 是否必须 描述
tpTriggerPx String 否 止盈触发价，如果填写此参数，必须填写 止盈委托价
tpOrdPx String 否 止盈委托价，如果填写此参数，必须填写 止盈触发价
委托价格为-1时，执行市价止盈
slTriggerPx String 否 止损触发价，如果填写此参数，必须填写 止损委托价
slOrdPx String 否 止损委托价，如果填写此参数，必须填写 止损触发价
委托价格为-1时，执行市价止损

计划委托

参数名 类型 是否必须 描述
triggerPx String 否 计划委托触发价格
orderPx String 否 委托价格

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "algoId":"12345689",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
algoId String 策略委托单ID
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

撤销策略委托订单

撤销策略委托订单，每次最多可以撤销10个策略委托单

限速： 20次/2s

HTTP请求

POST /api/v5/trade/cancel-algos

请求示例

POST /api/v5/trade/cancel-algos

body [{"algoId":"198273485","instId":"BTC-USDT"},{"algoId":"198273485","instId":"BTC-USDT"}]

请求参数

参数名 类型 是否必须 描述
algoId String 是 策略委托单ID
instId String 是 产品ID 如 BTC-USDT

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "algoId":"1234",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
algoId String 订单ID
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

获取未完成策略委托单列表

获取当前账户下未触发的策略委托单列表

限速： 20次/2s

HTTP请求

GET /api/v5/trade/orders-algo-pending

请求示例

GET /api/v5/trade/orders-algo-pending?ordType=conditional

请求参数

参数名 类型 是否必须 描述
algoId String 可选 策略委托单ID
instType String 否 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
MARGIN：杠杆
instId String 否 产品ID，BTC-USD-190927
ordType String 是 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoId
limit String 否 返回结果的数量，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "algoId":"1234",
            "sz":"999",
            "ordType":"oco",
            "side":"buy",
            "posSide":"long",
            "tdMode":"cross",
            "state":"1",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "triggerPx":"99",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "triggerTime":"1597026383085",
            "cTime":"1597026383000"
        },
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "algoId":"1234",
            "sz":"999",
            "ordType":"oco",
            "side":"buy",
            "posSide":"long",
            "tdMode":"cross",
            "state":"1",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "triggerPx":"99",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "triggerTime":"1597026383085",
            "cTime":"1597026383000"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
sz String 委托数量
ordType String 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
state String 订单状态 ，pending：待生效
lever String 杠杆倍数
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slOrdPx String 止损委托价
triggerPx String 计划委托触发价格
ordPx String 计划委托委托价格
actualSz String 实际委托量
actualPx String 实际委托价
actualSide String 实际触发方向， tp：止盈 sl： 止损
triggerTime String 策略委托触发时间，Unix时间戳的毫秒数格式，如 1597026383085
cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085

获取历史策略委托单列表

获取当前账户下所有策略委托单列表

限速： 20次/2s

HTTP请求

GET /api/v5/trade/orders-algo-history

请求示例

GET /api/v5/trade/order-algos-history?state=effective&ordType=conditional

请求参数

参数名 类型 是否必须 描述
state String 可选 订单状态

effective：已生效
canceled：已经撤销
order_failed：委托失败
【state和algoId必填且只能填其一】
algoId String 可选 策略委托单ID 【state和algoId必填且只能填其一】
instType String 否 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
MARGIN：杠杆
instId String 否 产品ID，BTC-USD-190927
ordType String 是 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoId
limit String 否 返回结果的数量，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "algoId":"1234",
            "sz":"999",
            "ordType":"oco",
            "side":"buy",
            "posSide":"long",
            "tdMode":"cross",
            "state":"effective",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "triggerPx":"99",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "triggerTime":"1597026383085",
            "cTime":"1597026383000"
        },
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "algoId":"1234",
            "sz":"999",
            "ordType":"oco",
            "side":"buy",
            "posSide":"long",
            "tdMode":"cross",
            "state":"effective",
            "lever":"20",
            "tpTriggerPx":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "triggerPx":"99",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "triggerTime":"1597026383085",
            "cTime":"1597026383000"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
sz String 委托数量
ordType String 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
state String 订单状态
effective： 已生效
canceled：已撤销
order_failed：委托失败
lever String 杠杆倍数
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slOrdPx String 止损委托价
triggerPx String 计划委托触发价格
ordPx String 计划委托委托价格
actualSz String 实际委托量
actualPx String 实际委托价
actualSide String 实际触发方向 tp：止盈 sl： 止损
triggerTime String 策略委托触发时间，Unix时间戳的毫秒数格式，如 1597026383085
cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085

WebSocket API

概述

WebSocket是HTML5一种新的协议（Protocol）。它实现了用户端与服务器全双工通信， 使得数据可以快速地双向传播。通过一次简单的握手就可以建立用户端和服务器连接， 服务器根据业务规则可以主动推送信息给用户端。其优点如下：

连接

连接说明：

连接限制：1次/秒

当订阅公有频道时，使用公有服务的地址；当订阅私有频道时，使用私有服务的地址

订阅限制：240次/小时

登录

请求格式说明

{
 "op": "login",
 "args":
  [
     {
       "apiKey"    : "<api_key>",
       "passphrase" :"<passphrase>",
       "timestamp" :"<timestamp>",
       "sign" :"<sign>" 
      }
   ]
}

请求示例

{
 "op": "login",
 "args":
  [
     {
       "apiKey"    : "985d5b66-57ce-40fb-b714-afc0b9787083",
       "passphrase" :"123456"    ,
       "timestamp" :"1538054050"    ,
       "sign" :"7L+zFQ+CEgGu5rzCj4+BdV2/uUHGqddA9pI6ztsRRPs=" 
      }
   ]
}

成功返回示例

{
"event": "login",
"code": "0",
"msg": ""
}

失败返回示例

{
"event": "error",
"code": "60008",
"msg": "Login is not supported for public channels."
}

api_key: 用于调用API的用户身份唯一标示，需要用户申请

passphrase: API Key 的密码

timestamp: 时间戳 ，是Unix Epoch时间，单位是秒

sign:签名字符串，签名算法如下：

先将timestamp 、 method 、requestPath 、 body进行字符串拼接，再使用HMAC SHA256方法将拼接后的字符串和SecretKey加密，然后进行Base64编码

SecretKey:用户申请APIKey时所生成的安全密钥，如：22582BD0CFF14C41EDBF1AB98506286D

其中 timestamp 示例:const timestamp = '' + Date.now() / 1000

其中 sign 示例: sign=CryptoJS.enc.Base64.Stringify(CryptoJS.HmacSHA256(timestamp +'GET'+ '/users/self/verify', secret))

method 总是 'GET'。

requestPath 总是 '/users/self/verify'

订阅

订阅说明

请求格式说明

{
    "op": "subscribe",
    "args": ["<SubscriptionTopic> "]
}

WebSocket 频道分成两类： 公共频道 和 私有频道

公共频道无需登录，包括行情频道，K线频道，交易数据频道，资金费率频道，限价范围频道，深度数据频道，标记价格频道等。

私有频道需登录，包括用户账户频道，用户交易频道，用户持仓频道等。

用户可以选择订阅一个或者多个频道，多个频道总长度不能超过4096个字节。

请求示例

{
 "op": "subscribe",
 "args":
  [
      {
       "channel"   : "tickers",
       "instId":"LTC-USD-200327"
      },
      {
       "channel"   : "candle1m",
       "instId":"LTC-USD-200327"
      }
  ]

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名
> instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY： 全部
> uly String 否 合约标的指数
> instId String 否 产品ID

返回示例 

{
    "event": "subscribe",
    "arg": {
        "channel": "tickers",
        "instId": "LTC-USD-200327"
    }
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION ： 期权
ANY： 全部
> uly String 否 合约标的指数
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

取消订阅

可以取消一个或者多个频道

请求格式说明

{
    "op": "unsubscribe",
    "args": ["< SubscriptionTopic > "]
}

请求示例

{
 "op": "unsubscribe",
 "args":
  [
      {
       "channel"   : "tickers",
       "instId":"LTC-USD-200327"
      },
      {
       "channel"   : "candle1m",
       "instId":"LTC-USD-200327"
      }
   ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，unsubscribe
args Array 是 取消订阅的频道列表
> channel String 是 频道名
> instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY： 全部
> uly String 否 合约标的指数
> instId String 否 产品ID

返回示例

{
    "event": "unsubscribe",
    "arg": {
        "channel": "tickers",
        "instId": "LTC-USD-200327"
    }
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，unsubscribe error
arg Object 否 取消订阅的频道
> channel String 是 频道名
> instType String 否 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY： 全部
> uly String 否 合约标的指数
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

Checksum 机制

此机制可以帮助用户校验深度数据的准确性。

校验说明

深度频道每次推送的数据都有时间戳和checksum， checksum是深度合并后前25档bids和asks组成的字符串， 用户可以用自己合并后的checksum值和推送的checksum值进行比较，如果不匹配可以重新订阅。

计算说明

checksum字符串是一个有符号整型(32位)的crc32值，用ask和bid中的价格和数量以冒号连接而成

深度合并规则

用户订阅深度频道成功后，首次会接收到全量数据，后续推送的都是增量数据。获取到增量数据后，遍历增量数据中的买一和卖一，然后与全量数据中的买一和卖一比较

  1. 如果价格相同， 则比较数量，如果数量不同且数量不是0，则更新全量数据中的买一或者卖一，否则删除此买一或者卖一
  2. 如果价格不相同，则按照顺序排序，将买一或者卖一插入到全量数据中

例1

{
 "arg": {
       "channel"   : "books",
       "instId":"BTC-USD-191227"
     },
 "action":"snapshot",
 "data": [
      {
        "asks": [[3366.8, 9, 10, 3],[ 3368,8,3,4 ]],
        "bids": [[3366.1, 7, 0, 3],[ 3366,6,3,4 ]]],
        "ts": "1597026383085",
        "checksum": "-855196043"
      }
  ]
}

例1：bid和ask成对档的情况下，要校验的字符串为：
bid[价格:数量]:ask[价格:数量]:bid[价格:数量]:ask[价格:数量]...

该例子对应的checksum字符串为：
3366.1:7:3366.8:9:3366:6:3368:8

例2

{
 "arg": {
       "channel"   : "books",
       "instId":"BTC-USD-191227"
     },
 "action":"update",
 "data": [
      {
        "asks": [[3366.8, 9, 10, 3],[ 3368,8,3,4 ],[ 3372,8,3,4 ]],
        "bids": [[3366.1, 7, 0, 3]],
        "ts": "1597026383085",
        "checksum": "-855196043"
      }
  ]
}

例2：bid和ask不成对档的情况 ，要校验的字符串为：

bid[价格:数量]:ask[价格:数量]:ask[价格:数量]:ask[价格:数量]:...

该例子对应的checksum 字符串为：
3366.1:7:3366.8:9:3368:8:3372:8

公共频道

产品频道

首次订阅推送产品的全量数据；后续当有产品状态变化时（如期货交割、期权行权、新合约/币对上线、人工暂停/恢复交易等），推送产品的增量数据。

请求示例

{ 
  "op": "subscribe",  
  "args":   [    
    {     
      "channel" : "instruments",
      "instType": "FUTURES"
    }
  ] 
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，instruments
> instType String 是 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
OPTION：期权

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "instruments",
        "instType": "FUTURES"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"instruments\", \"instType\" : \"FUTURES\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "instruments",
        "instType": "FUTURES"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "BTC-USD-191115",
        "uly": "BTC-USD",
        "category":"1",
        "baseCcy": "",
        "quoteCcy": "",
        "settleCcy": "BTC",
        "ctVal": "10",
        "ctMult": "1",
        "ctValCcy": "USD",
        "optType": "",
        "stk": "",
        "listTime": "",
        "expTime": "",
        "tickSz": "0.01",
        "lotSz": "1",
        "minSz": "1",
        "ctType": "linear",
        "alias": "this_week",
        "state": "live"
    }, {
        "instType": "FUTURES",
        "instId": "BTC-USD-201115",
        "uly": "BTC-USD",
        "category":"1",
        "baseCcy": "",
        "quoteCcy": "",
        "settleCcy": "BTC",
        "ctVal": "10",
        "ctMult":   "1",
        "ctValCcy": "USD",
        "optType": "",
        "stk": "",
        "listTime": "",
        "expTime": "",
        "tickSz": "0.01",
        "lotSz": "1",
        "minSz": "1",
        "ctType": "linear",
        "alias": "this_week",
        "state": "live"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅的频道
> channel String 频道名
> instType String 产品类型
data Array 订阅的数据
> instType String 产品类型
> instId String 产品ID，如 BTC-USD-SWAP
> category String 手续费档位，每个交易产品属于哪个档位手续费
> uly String 合约标的指数，如 BTC-USD ，仅适用于交割/永续/期权
> baseCcy String 交易货币币种，如 BTC-USDT 中BTC ，仅适用于币币
> quoteCcy String 计价货币币种，如 BTC-USDT 中 USDT ，仅适用于币币
> settleCcy String 盈亏结算和保证金币种，如 BTC ，仅适用于 交割/永续/期权
> ctVal String 合约面值
> ctMult String 合约乘数
> ctValCcy String 合约面值计价币种
> optType String 期权类型，C：看涨期权 P：看跌期权 ，仅适用于期权
> stk String 行权价格， 仅适用于期权
> listTime String 上线日期， 仅适用于 交割/期权
> expTime String 交割日期， 仅适用于 交割/期权
> lever String 杠杆倍数， 不适用于币币
> tickSz String 下单价格精度，如 0.0001
> lotSz String 下单数量精度，如 1：BTC-USDT-200925 0.001：BTC-USDT
> minSz String 最小下单数量
> ctType String 合约类型，linear：正向合约 inverse：反向合约
> alias String 合约日期别名
this_week：本周
this_week：次周
quarter：季度
next_quarter：次季度

仅适用于交割
> state String 产品状态
live：交易中
suspend：暂停中
expired：已过期
preopen：预上线

行情频道

获取产品的最新成交价、买一价、卖一价和24小时交易量等信息，每100ms有数据更新推送一次数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "tickers",
        "instId": "LTC-USD-200327"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，tickers
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "tickers",
        "instId": "LTC-USD-200327"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"tickers\", \"instId\" : \"LTC-USD-200327\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "tickers",
        "instId": "LTC-USD-200327"
    },
    "data": [{
        "instType": "SWAP",
        "instId": "LTC-USD-SWAP",
        "last": "9999.99",
        "lastSz": "0.1",
        "askPx": "9999.99",
        "askSz": "11",
        "bidPx": "8888.88",
        "bidSz": "5",
        "open24h": "9000",
        "high24h": "10000",
        "low24h": "8888.88",
        "volCcy24h": "2222",
        "vol24h": "2222",
        "sodUtc0": "2222",
        "sodUtc8": "2222",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
instType String 产品类型
instId String 产品ID
last String 最新成交价
lastSz String 最新成交的数量
askPx String 卖一价
askSz String 卖一价对应的量
bidPx String 买一价
bidSz String 买一价对应的数量
open24h String 24小时开盘价
high24h String 24小时最高价
low24h String 24小时最低价
volCcy24h String 24小时成交量
vol24h String 24小时成交量
sodUtc0 String UTC 0 时开盘价
sodUtc8 String UTC+8 时开盘价
ts String 数据产生时间，Unix时间戳的毫秒数格式，如 1597026383085

持仓总量频道

获取持仓总量，每3s有数据更新推送一次数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "open-interest",
        "instId": "LTC-USD-SWAP"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，open-interest
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": [{
        "channel": "open-interest",
        "instId": "LTC-USD-SWAP"
    }]
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"open-interest\", \"instId\" : \"LTC-USD-SWAP\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例 

{
    "arg": {
        "channel": "open-interest",
        "instId": "LTC-USD-SWAP"
    },
    "data": [{
        "instType": "SWAP",
        "instId": "LTC-USD-SWAP",
        "oi": "5000",
        "oiCcy": "555.55",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型
> instId String 产品ID，如 BTC-USD-18021
> oi String 持仓量，按张为单位，open interest
> oiCcy String 持仓量，按币为单位
> ts String 数据更新的时间，Unix时间戳的毫秒数格式，如 1597026383085

K线频道

获取产品的K线数据，每500ms推送一次数据。

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "candle1D",
        "instId": "LTC-USD-200327"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，
candle1Y
candle6M candle3M candle1M
candle1W
candle1D candle2D candle3D candle5D
candle12H candle6H candle4H candle2H candle1H
candle30m candle15m candle5m candle3m candle1m
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "candle1D",
        "instId": "BTC-USD-191227"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"candle1D\", \"instId\" : \"BTC-USD-191227\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "candle1D",
        "instId": "BTC-USD-191227"
    },
    "data": [
        ["1597026383085", "8533.02", "8553.74", "8527.17", "8548.26", "45247", "529.5858061"]
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> ts String 开始时间，Unix时间戳的毫秒数格式，如 1597026383085
> o String 开盘价格
> h String 最高价格
> l String 最低价格
> c String 收盘价格
> vol String 交易量，以张为单位
> volCcy String 交易量，以币为单位

交易频道

获取最近的成交数据，有成交数据就推送

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "trades",
        "instId": "BTC-USD-191227"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，trades
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "trades",
        "instId": "BTC-USD-191227"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"trades\", \"instId\" : \"BTC-USD-191227\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "trades",
        "instId": "BTC-USD-191227"
    },
    "data": [{
        "instId": "BTC-USD-191227",
        "tradeId": "9",
        "px": "0.016",
        "sz": "50",
        "side": "buy",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> instId String 产品ID，如 BTC-USD-180216
> tradeId String 成交ID
> px String 成交价格
> sz String 成交数量
> side String 成交方向，buy sell
> ts String 成交时间，Unix时间戳的毫秒数格式，如 1597026383085

预估交割/行权价格频道

获取交割合约和期权预估交割/行权价。交割/行权预估价只有交割/行权前一小时开始推送预估交割/行权价，有价格变化就推送

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "estimated-price",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，estimated-price
> instType String 是 产品类型
FUTURES：交割合约
OPTION：期权
ANY：全部
> uly String 否 合约标的指数
> instId String 否 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "estimated-price",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"estimated-price\", \"instId\" : \"FUTURES\",\"uly\" :\"BTC-USD\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
FUTURES：交割合约
OPTION：期权
> uly String 否 合约标的指数
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "args": "estimated-price",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "BTC-USD-170310",
        "settlePx": "200",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instType String 产品类型
OPTION：期权
FUTURES：交割
> uly String 合约标的指数
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型
> instId String 产品ID，如 BTC-USD-170310
> settlePx String 预估交割/行权价
> ts String 数据更新时间， Unix时间戳的毫秒数格式，如 1597026383085

标记价格频道

获取标记价格，标记价格有变化时，每200ms推送一次数据，标记价格没变化时，每10s推送一次数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "mark-price",
        "instId": "LTC-USD-190628"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，mark-price
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "mark-price",
        "instId": "LTC-USD-190628"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"mark-price\", \"instId\" : \"LTC-USD-190628\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "mark-price",
        "instId": "LTC-USD-190628"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "LTC-USD-190628",
        "markPx": "0.1",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> instType String 交易品种
> instId String 产品ID
> markPx String 标记价格
> ts String 标记价格数据更新时间 ， Unix时间戳的毫秒数格式，如 1597026383085

标记价格K线频道

获取标记价格的K线数据，每500ms推送一次数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "mark-price-candle1D",
        "instId": "BTC-USD-190628"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> 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
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "mark-price-candle1D",
        "instId": "BTC-USD-190628"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"mark-price-candle1D\", \"instId\" : \"BTC-USD-190628\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "mark-price-candle1D",
        "instId": "BTC-USD-190628"
    },
    "data": [
        ["1597026383085", "3.721", "3.743", "3.677", "3.708"],
        ["1597026383085", "3.731", "3.799", "3.494", "3.72"]
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> ts String 开始时间， Unix时间戳的毫秒数格式，如 1597026383085
> o String 开盘价格
> h String 最高价格
> l String 最低价格
> c String 收盘价格

限价频道

获取交易的最高买价和最低卖价。限价有变化时，每5秒推送一次数据，限价没变化时，不推送数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "price-limit",
        "instId": "LTC-USD-190628"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，price-limit
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "price-limit",
        "instId": "LTC-USD-190628"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"price-limit\", \"instId\" : \"LTC-USD-190628\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "price-limit",
        "instId": "LTC-USD-190628"
    },
    "data": [{
        "instId": "LTC-USD-190628",
        "buyLmt": "200",
        "sellLmt": "300",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型
> instId String 产品ID，如 BTC-USD-SWAP
> buyLmt String 最高买价
> sellLmt String 最低卖价
> ts String 数据更新时间， Unix时间戳的毫秒数格式，如 1597026383085

深度频道

获取深度数据，books是400档频道，books5是5档频道，books-l2-tbt是先400档后实时推送的频道；

books 首次推400档快照数据，以后增量推送，即每100毫秒有深度变化推送一次变化的数据
books5 首次推五档快照数据，以后定量推送，每100毫秒有深度变化推送一次5档数据，即每次都推送5档数据
books-l2-tbt 首次推400档快照数据，以后增量推送，即有深度有变化推送一次变化的数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "books",
        "instId": "BTC-USD-191227"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，books books5 books-l2-tbt
> instId String 是 产品ID

返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "books",
        "instId": "BTC-USD-191227"
    }
}

失败示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"books\", \"instId\" : \"BTC-USD-191227\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 是 产品ID
msg String 否 错误消息
code String 否 错误码

推送示例 ：全量

{
    "arg": {
        "channel": "books",
        "instId": "BTC-USD-191227"
    },
    "action": "snapshot",
    "data": [{
        "asks": [
            ["8476.98", "415", "0", "13"],
            ["8477", "7", "0", "2"],
            ["8477.34", "85", "0", "1"],
            ["8477.56", "1", "0", "1"],
            ["8505.84", "8", "0", "1"],
            ["8506.37", "85", "0", "1"],
            ["8506.49", "2", "0", "1"],
            ["8506.96", "100", "0", "2"]
        ],
        "bids": [
            ["8476.97", "256", "0", "12"],
            ["8475.55", "101", "0", "1"],
            ["8475.54", "100", "0", "1"],
            ["8475.3", "1", "0", "1"],
            ["8447.32", "6", "0", "1"],
            ["8447.02", "246", "0", "1"],
            ["8446.83", "24", "0", "1"],
            ["8446", "95", "0", "3"]
        ],
        "ts": "1597026383085",
        "checksum": "-855196043"
    }]
}

推送示例：增量

{
    "arg": {
        "channel": "books",
        "instId": "BTC-USD-191227"
    },
    "action": "update",
    "data": [{
        "asks": [
            ["8476.98", "415", "0", "13"],
            ["8477", "7", "0", "2"],
            ["8477.34", "85", "0", "1"],
            ["8477.56", "1", "0", "1"],
            ["8505.84", "8", "0", "1"],
            ["8506.37", "85", "0", "1"],
            ["8506.49", "2", "0", "1"],
            ["8506.96", "100", "0", "2"]
        ],
        "bids": [
            ["8476.97", "256", "0", "12"],
            ["8475.55", "101", "0", "1"],
            ["8475.54", "100", "0", "1"],
            ["8475.3", "1", "0", "1"],
            ["8447.32", "6", "0", "1"],
            ["8447.02", "246", "0", "1"],
            ["8446.83", "24", "0", "1"],
            ["8446", "95", "0", "3"]
        ],
        "ts": "1597026383085",
        "checksum": "-855196043"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> asks Array 卖方深度
> bids Array 买方深度
> action String 推送数据动作，增量推送数据还是全量推送数据
snapshot：全量
update：增量
> ts String 数据更新时间戳，Unix时间戳的毫秒数格式，如 1597026383085
> checksum String 检验和

期权定价频道

获取所有期权合约详细定价信息，一次性推送所有

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "opt-summary",
        "uly": "BTC-USD"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，opt-summary
> uly String 是 合约标的指数

返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "opt-summary",
        "uly": "BTC-USD"
    }
}

失败示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"opt-summary\", \"uly\" : \"BTC-USD\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> uly String 是 合约标的指数
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "opt-summary",
        "uly": "BTC-USD"
    },
    "data": [{
        "instType": "OPTION",
        "instId": "BTC-USD-200103-5500-C",
        "uly": "BTC-USD",
        "delta": "0.7494223636",
        "gamma": "-0.6765419039",
        "theta": "-0.0000809873",
        "vega": "0.0000077307",
        "deltaBS": "0.7494223636",
        "gammaBS": "-0.6765419039",
        "thetaBS": "-0.0000809873",
        "vegaBS": "0.0000077307",
        "realVol": "0",
        "bidVol": "",
        "askVol": "1.5625",
        "markVol": "0.9987",
        "lever": "4.0342",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> uly String 合约标的指数
data Array 订阅的数据
> instType String 产品类型， OPTION
> instId String 产品ID
> uly String 合约标的指数
> delta String 期权价格对uly价格的敏感度
> gamma String delta对uly价格的敏感度
> vega String 期权价格对隐含波动率的敏感度
> theta String 期权价格对剩余期限的敏感度
> deltaBS String BS模式下期权价格对uly价格的敏感度
> gammaBS String BS模式下delta对uly价格的敏感度
> vegaBS String BS模式下期权价格对隐含波动率的敏感度
> thetaBS String BS模式下期权价格对剩余期限的敏感度
> lever String 杠杆倍数
> markVol String 标记波动率
> bidVol String bid波动率
> askVol String ask波动率
> realVol String 已实现波动率，目前该字段暂未启用
> ts String 数据更新时间， Unix时间戳的毫秒数格式，如 1597026383085

资金费率频道

获取合约资金费率，一分钟推送一次数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "funding-rate",
        "instId": "BTC-USD-SWAP"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，funding-rate
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "funding-rate",
        "instId": "BTC-USD-SWAP"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"funding-rate\", \"instId\" : \"BTC-USD-SWAP\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "funding-rate",
        "instId": "BTC-USD-SWAP"
    },
    "data": [{
        "instType": "SWAP",
        "instId": "BTC-USD-SWAP",
        "fundingRate": "0.018",
        "nextFundingRate": "",
        "fundingTime": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型，SWAP
> instId String 产品ID，如 BTC-USD-SWAP
> fundingRate String 资金费率
> nextFundingRate String 下一期预测资金费率
> fundingTime String 最新的到期结算的资金费时间，Unix时间戳的毫秒数格式，如 1597026383085

指数K线频道

获取指数的K线数据，每500ms推送一次数据。

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "index-candle30m",
        "instId": "BTC-USD"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> 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
> instId String 是 产品ID

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "index-candle30m",
        "instId": "BTC-USD"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"index-candle30m\", \"instId\" : \"BTC-USD\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 subscribe unsubscribe
arg Object 否 订阅的频道
> channel String 是 频道名
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "index-candle30m",
        "instId": "BTC-USD"
    },
    "data": [
        ["1597026383085", "3811.31", "3811.31", "3811.31", "3811.31"]
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> ts String 开始时间， Unix时间戳的毫秒数格式，如 1597026383085
> o String 开盘价格
> h String 最高价格
> l String 最低价格
> c String 收盘价格

指数行情频道

获取指数的行情数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "index-tickers",
        "instId": "BTC-USDT"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，index-tickers
> instId String 是 指数

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "index-tickers",
        "instId": "BTC-USDT"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"index-tickers\", \"instId\" : \"BTC-USDT\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名，index-tickers
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg": {
        "channel": "index-tickers",
        "instId": "BTC-USDT"
    },
    "data": [{
        "instId": "BTC-USDT",
        "idxPx": "0.1",
        "high24h": "0.5",
        "low24h": "0.1",
        "open24h": "0.1",
        "sodUtc0": "0.1",
        "sodUtc8": "0.1",
        "ts": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
data Array 订阅的数据
> instId String 指数，以USD、USDT、BTC 为计价货币的指数，如 BTC-USDT
> idxPx String 最新指数价格
> open24h String 24小时开盘价
> high24h String 24小时指数最高价格
> low24h String 24小时指数最低价格
>sodUtc0 String UTC 0 时开盘价
>sodUtc8 String UTC+8 时开盘价
> ts String 指数价格更新时间，Unix时间戳的毫秒数格式，如 1597026383085

私有频道

账户频道

获取账户信息，首次订阅按照订阅维度推送数据，此外，当下单、撤单等事件触发时，推送数据以及按照订阅维度定时推送数据

请求示例：单个

{
    "op": "subscribe",
    "args": [{
        "channel": "account",
        "ccy": "BTC"
    }]
}

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "account"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，account
> ccy String 否 币种

成功返回示例：单个

{
    "event": "subscribe",
    "arg": {
        "channel": "account",
        "ccy": "BTC"
    }
}

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "account"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"account\", \"ccy\" : \"BTC\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 操作，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名，account
> ccy String 否 币种
code String 否 错误码
msg String 否 错误消息

推送示例：单个

{
    "arg": {
        "channel": "account",
        "ccy": "BTC"
    },
    "data": [{
        "uTime": "1597026383085",
        "totalEq": "41624.32",
        "isoEq": "3624.32",
        "adjEq": "41624.32",
        "imr": "4162.33",
        "mmr": "4",
        "mgnRatio": "41624.32",
        "details": [{
            "ccy": "BTC",
            "eq": "123",
            "availEq": "1234",
            "availBal": "1415",
            "frozenBal": "14",
            "ordFrozen": "12",
            "upl": "124",
            "mgnRatio": "124",
            "interest": "12",
            "liab": "1"
        }]
    }]
}

推送示例

{
    "arg": {
        "channel": "account"
    },
    "data": [{
        "uTime": "1597026383085",
        "totalEq": "41624.32",
        "isoEq": "3624.32",
        "adjEq": "41624.32",
        "imr": "4162.33",
        "mmr": "4",
        "mgnRatio": "41624.32",
        "details": [{
            "ccy": "BTC",
            "eq": "123",
            "availEq": "1234",
            "availBal": "1415",
            "frozenBal": "14",
            "ordFrozen": "12",
            "upl": "124",
            "mgnRatio": "124",
            "interest": "12",
            "liab": "1"
        }, {
            "ccy": "ETH",
            "eq": "223",
            "availEq": "2234",
            "availBal": "415",
            "frozenBal": "141",
            "ordFrozen": "12",
            "upl": "124",
            "mgnRatio": "124",
            "interest": "0",
            "liab": "0"
        }]
    }]
}

推送数据参数

参数名 类型 描述
arg Object 请求订阅的频道
> channel String 频道名
> ccy String 币种
data Array 订阅的数据
> uTime String 账户信息的推送时间， Unix时间戳的毫秒数格式，如 1597026383085
> totalEq String 美金层面权益
> isoEq String 美金层面逐仓仓位权益
适用于单币种保证金账户和跨币种保证金账户
> adjEq String 美金层面有效保证金
适用于跨币种保证金账户
> imr String 美金层面占用保证金
适用于跨币种保证金账户
> mmr String 美金层面维持保证金
适用于跨币种保证金账户
> mgnRatio String 美金层面保证金率
适用于跨币种保证金账户
> details Array 币种层面详情
>> ccy String 币种
>> eq String 币种总权益
>> isoEq String 币种逐仓仓位权益
适用于单币种保证金账户和跨币种保证金账户
>> availEq String 可用保证金
适用于单币种保证金账户和跨币种保证金账户
>> availBal String 现货可用余额
适用于交易账户
>> frozenBal String 币种占用余额
>> ordFrozen String 挂单冻结数量
>> liab String 币种负债额
适用于跨币种保证金账户
>> upl String 未实现盈亏
适用于单币种保证金账户和跨币种保证金账户
>> mgnRatio String 保证金率
适用于单币种保证金账户
>> interest String 计息
适用于跨币种保证金账户

持仓频道

获取持仓信息，首次订阅按照订阅维度推送数据，此外，当下单、撤单等事件触发时，推送数据以及按照订阅维度定时推送数据

请求示例：单个

{
    "op": "subscribe",
    "args": [{
        "channel": "positions",
        "instType": "FUTURES",
        "uly": "BTC-USD",
        "instId": "BTC-USD-200329"
    }]
}

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "positions",
        "instType": "ANY"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，positions
> instType String 是 产品类型
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY：全部
> uly String 否 合约标的指数
> instId String 否 产品ID

成功返回示例：单个

{
    "event": "subscribe",
    "arg": {
        "channel": "positions",
        "instType": "FUTURES",
        "uly": "BTC-USD",
        "instId": "BTC-USD-200329"
    }
}

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "positions",
        "instType": "ANY"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"positions\", \"instType\" : \"FUTURES\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe errror
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY： 全部
> uly String 否 合约标的指数
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例：单个

{
    "arg": {
        "channel": "positions",
        "instType": "FUTURES",
        "instId": "BTC-USD-200329"
    },
    "data": [{
        "instId": "BTC-USD-200329",
        "instType": "FUTURES",
        "mgnMode": "cross",
        "posId": "11123412",
        "posSide": "long",
        "pos": "10",
        "ccy": "BTC",
        "posCcy": "",
        "availPos": "10",
        "avgPx": "3320",
        "upl": "0.00020928",
        "uplRatio": "0.00020928",
        "lever": "2",
        "liqPx": "0.00020928",
        "imr": "2",
        "margin": "",
        "mgnRatio": "",
        "mmr": "2",
        "liab": "0.00020928",
        "liabCcy": "USDT",
        "interest": "2",
        "tradeId": "2",
        "optVal": "",
        "adl": "1",
        "last": "13452.1",
        "cTime": "1597026383085",
        "uTime": "1597026383085",
        "pTime": "1597026383085"
    }]
}

推送示例

{
    "arg": {
        "channel": "positions",
        "instType": "ANY"
    },
    "data": [{
        "instId": "BTC-USD-200329",
        "instType": "FUTURES",
        "mgnMode": "cross",
        "posId": "11111224",
        "posSide": "long",
        "pos": "10",
        "ccy": "BTC",
        "posCcy": "",
        "availPos": "10",
        "avgPx": "3320",
        "upl": "0.00020928",
        "uplRatio": "0.00020928",
        "lever": "2",
        "liqPx": "0.00020928",
        "imr": "2",
        "margin": "",
        "mgnRatio": "",
        "mmr": "2",
        "liab": "0.00020928",
        "liabCcy": "USDT",
        "interest": "2",
        "tradeId": "2",
        "optVal": "",
        "adl": "1",
        "last": "13452.1",
        "cTime": "1597026383085",
        "uTime": "1597026383085",
        "pTime": "1597026383085"
    }, {
        "instType": "SWAP",
        "instId": "BTC-USD-SWAP",
        "mgnMode": "cross",
        "posId": "111112222",
        "posSide": "long",
        "pos": "10",
        "ccy": "BTC",
        "posCcy": "",
        "availPos": "10",
        "avgPx": "3320",
        "upl": "0.00020928",
        "uplRatio": "0.00020928",
        "lever": "2",
        "liqPx": "0.00020928",
        "imr": "2",
        "margin": "",
        "mgnRatio": "",
        "mmr": "2",
        "liab": "0.00020928",
        "liabCcy": "USDT",
        "interest": "2",
        "tradeId": "2",
        "optVal": "",
        "adl": "1",
        "last": "1342.1",
        "cTime": "1597026383085",
        "uTime": "1597026383085",
        "pTime": "1597026383085"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instType String 产品类型
> uly String 合约标的指数
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型
> mgnMode String 保证金模式， cross：全仓 isolated：逐仓
> posId String 持仓ID
> posSide String 持仓方向
long：双向持仓多头
short：双向持仓空头
net：单向持仓（交割/永续/期权：pos为正代表多头，pos为负代表空头。币币杠杆：posCcy为交易货币时，代表多头；posCcy为计价货币时，代表空头。）
> pos String 持仓数量
> posCcy String 持仓数量币种，仅适用于币币杠杆
> availPos String 可平仓数量
适用于 币币杠杆,交割/永续（开平仓模式），期权（交易账户及保证金账户逐仓）。
> avgPx String 开仓平均价
> upl String 未实现收益
> uplRatio String 未实现收益率
> instId String 产品ID，如 BTC-USD-180216
> lever String 杠杆倍数，不适用于期权卖方
> liqPx String 预估强平价
不适用于跨币种保证金账户下交割/永续的全仓
不适用于期权
> imr String 初始保证金，仅适用于全仓
> margin String 保证金余额，仅适用于逐仓，可增减
> mgnRatio String 保证金率，仅适用于逐仓
> mmr String 维持保证金
> liab String 负债额，仅适用于币币杠杆
> liabCcy String 负债币种，仅适用于币币杠杆
> interest String 利息，已经生成未扣利息
> tradeId String 最新成交ID
> optVal String 期权价值，仅适用于期权
> adl String 信号区，分为5档，从1到5，数字越小代表adl强度越弱
> ccy String 占用保证金的币种
> last String 最新成交价
> cTime String 持仓创建时间，Unix时间戳的毫秒数格式，如 1597026383085
> uTime String 最近一次持仓更新时间，Unix时间戳的毫秒数格式，如 1597026383085
> pTime String 持仓信息的推送时间，Unix时间戳的毫秒数格式，如 1597026383085

订单频道

获取订单信息，首次订阅不推送，只有当下单、撤单等事件触发时，推送数据

请求示例：单个

{
    "op": "subscribe",
    "args": [{
        "channel": "orders",
        "instType": "FUTURES",
        "uly": "BTC-USD",
        "instId": "BTC-USD-200329"
    }]
}

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "orders",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名， orders
> instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY：全部
> uly String 否 合约标的指数
> instId String 否 产品ID

成功返回示例：单个

{
    "event": "subscribe",
    "arg": {
        "channel": "orders",
        "instType": "FUTURES",
        "uly": "BTC-USD",
        "instId": "BTC-USD-200329"
    }
}

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "orders",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"orders\", \"instType\" : \"FUTURES\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe errror
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
ANY： 全部
> uly String 否 合约标的指数
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例：单个

{
    "arg": {
        "channel": "orders",
        "instType": "FUTURES",
        "instId": "BTC-USD-200329"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "BTC-USD-200329",
        "ordId": "123445",
        "clOrdId": "b1",
        "tag": "",
        "px": "999",
        "sz": "3",
        "ordType": "limit",
        "side": "buy",
        "posSide": "long",
        "tdMode": "cross",
        "fillSz": "0",
        "fillPx": "long",
        "tradeId": "0",
        "accFillSz": "323",
        "fillTime": "0",
        "state": "canceled",
        "avgPx": "0",
        "lever": "20",
        "tpTriggerPx": "0",
        "tpOrdPx": "20",
        "slTriggerPx": "0",
        "slOrdPx": "20",
        "feeCcy": "",
        "fee": "",
        "rebateCcy": "",
        "rebate": "",
        "pnl": "",
        "category": "",
        "uTime": "1597026383085",
        "cTime": "1597026383085",
        "reqId": "",
        "amendResult": "",
        "code": "0",
        "msg": ""
    }]
}

推送示例

{
    "arg": {
        "channel": "orders",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "BTC-USD-200329",
        "ordId": "123445",
        "clOrdId": "b1",
        "tag": "",
        "px": "999",
        "sz": "3",
        "ordType": "limit",
        "side": "buy",
        "posSide": "long",
        "tdMode": "cross",
        "fillSz": "0",
        "fillPx": "long",
        "tradeId": "0",
        "accFillSz": "323",
        "fillTime": "0",
        "state": "canceled",
        "avgPx": "0",
        "lever": "20",
        "tpTriggerPx": "0",
        "tpOrdPx": "20",
        "slTriggerPx": "0",
        "slOrdPx": "20",
        "feeCcy": "",
        "fee": "",
        "rebateCcy": "",
        "rebate": "",
        "pnl": "",
        "category": "",
        "uTime": "1597026383085",
        "cTime": "1597026383085",
        "reqId": "",
        "amendResult": "",
        "code": "0",
        "msg": ""
    }, {
        "instType": "FUTURES",
        "instId": "BTC-USD-200829",
        "ordId": "123445",
        "clOrdId": "b1",
        "tag": "",
        "px": "999",
        "sz": "3",
        "ordType": "limit",
        "side": "buy",
        "posSide": "long",
        "tdMode": "cross",
        "fillSz": "0",
        "fillPx": "long",
        "tradeId": "0",
        "accFillSz": "323",
        "fillTime": "0",
        "state": "canceled",
        "avgPx": "0",
        "lever": "20",
        "tpTriggerPx": "0",
        "tpOrdPx": "20",
        "slTriggerPx": "0",
        "slOrdPx": "20",
        "feeCcy": "",
        "fee": "",
        "rebateCcy": "",
        "rebate": "",
        "pnl": "",
        "category": "",
        "uTime": "1597026383085",
        "cTime": "1597026383085",
        "reqId": "",
        "amendResult": "",
        "code": "0",
        "msg": ""
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> uly String 合约标的指数
> instType String 产品类型
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型
> instId String 产品ID
> ccy String 保证金币种，仅适用于单币种保证金账户下的全仓币币杠杆订单
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID来识别您的订单
> tag String 订单标签
> px String 委托价格
> sz String 原始委托数量，币币/币币杠杆，以币为单位；交割/永续/期权 ，以张为单位
> ordType String 订单类型
market：市价单
limit：限价单
post_only： 只做maker单
fok：全部成交或立即取消单
ioc：立即成交并取消剩余单
> side String 订单方向，buy sell
> posSide String 持仓方向
long：双向持仓多头
short：双向持仓空头
net：单向持仓
> tdMode String 交易模式
保证金模式 isolated：逐仓 cross：全仓
非保证金模式 cash：现金
> fillPx String 最新成交价格
> tradeId String 最新成交ID
> fillSz String 最新成交数量
> fillTime String 最新成交时间
> accFillSz String 累计成交数量
> avgPx String 成交均价，如果成交数量为0，该字段也为0
> state String 订单状态
canceled：撤单成功
live：等待成交
partially_filled： 部分成交
filled：完全成交
> lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
> tpTriggerPx String 止盈触发价
> tpOrdPx String 止盈委托价，止盈委托价格为-1时，执行市价止盈
> slTriggerPx String 止损触发价
> slOrdPx String 止损委托价，止损委托价格为-1时，执行市价止损
> feeCcy String 交易手续费币种
币币/币币杠杆：如果是买的话，收取的就是BTC；如果是卖的话，收取的就是USDT
交割/永续/期权 收取的就是保证金
> fee String 订单交易手续费，平台向用户收取的交易手续费
> rebateCcy String 返佣金币种 ，如果没有返佣金，该字段为“”
> rebate String 返佣金额，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”
> pnl String 收益
> category String 订单种类分类
normal：普通委托订单种类
twap：TWAP订单种类
adl：ADL订单种类
full_liquidation：爆仓订单种类
partial_liquidation：减仓订单种类
> uTime String 订单更新时间， Unix时间戳的毫秒数格式，如 1597026383085
> cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085
> reqId String 修改订单时使用的request ID，如果没有修改，该字段为""
> amendResult String 修改订单的结果
-1： 失败
0：成功
1：自动撤单（因为修改成功导致订单自动撤销）
通过API修改订单时，如果cxlOnFail设置为false且修改失败后，则amendResult返回 -1
通过API修改订单时，如果cxlOnFail设置为true且修改失败后，则amendResult返回1
通过Web/APP修改订单时，如果修改失败后，则amendResult返回-1
> code String 错误码，默认为0
> msg String 错误消息，默认为""

策略委托订单频道

获取策略委托订单，首次订阅不推送，只有当下单、撤单等事件触发时，推送数据

请求示例：单个

{
    "op": "subscribe",
    "args": [{
        "channel": "orders-algo",
        "instType": "FUTURES",
        "uly": "BTC-USD",
        "instId": "BTC-USD-200329"
    }]
}

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "orders-algo",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，orders-algo
> instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
ANY：全部
> uly String 否 合约标的指数
> instId String 否 产品ID

成功返回示例：单个

{
    "event": "subscribe",
    "arg": {
        "channel": "orders-algo",
        "instType": "FUTURES",
        "uly": "BTC-USD",
        "instId": "BTC-USD-200329"
    }
}

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "orders-algo",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    }
}

失败返回示例

{
    "event": "error",
    "code": "60012",
    "msg": "Unrecognized request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"orders-algo\", \"instType\" : \"FUTURES\"}]}"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe errror
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
ANY：全部
> uly String 否 合约标的指数
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例：单个

{
    "arg": {
        "channel": "orders-algo",
        "instType": "FUTURES",
        "instId": "BTC-USD-200329"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "BTC-USD-200329",
        "ordId": "123445",
        "ccy": "BTC",
        "algoId": "1234",
        "px": "999",
        "sz": "3",
        "ordType": "trigger",
        "side": "buy",
        "posSide": "long",
        "state": "1",
        "lever": "20",
        "tpTriggerPx": "",
        "tpOrdPx": "",
        "slTriggerPx": "",
        "triggerPx": "99",
        "ordPx": "12",
        "actualSz": "",
        "actualPx": "",
        "actualSide": "",
        "triggerTime": "1597026383085",
        "cTime": "1597026383000"
    }]
}

推送示例

{
    "arg": {
        "channel": "orders-algo",
        "instType": "FUTURES",
        "uly": "BTC-USD"
    },
    "data": [{
        "instType": "FUTURES",
        "instId": "BTC-USD-200329",
        "ordId": "123445",
        "ccy": "BTC",
        "algoId": "1234",
        "px": "999",
        "sz": "3",
        "ordType": "trigger",
        "side": "buy",
        "posSide": "long",
        "state": "1",
        "lever": "20",
        "tpTriggerPx": "",
        "tpOrdPx": "",
        "slTriggerPx": "",
        "triggerPx": "99",
        "ordPx": "12",
        "actualSz": "",
        "actualPx": "",
        "actualSide": "",
        "triggerTime": "1597026383085",
        "cTime": "1597026383000"
    }, {
        "instType": "FUTURES",
        "instId": "BTC-USD-200829",
        "ordId": "123445",
        "ccy": "BTC",
        "algoId": "1234",
        "px": "999",
        "sz": "3",
        "ordType": "trigger",
        "side": "buy",
        "posSide": "long",
        "state": "1",
        "lever": "20",
        "tpTriggerPx": "",
        "tpOrdPx": "",
        "slTriggerPx": "",
        "triggerPx": "99",
        "ordPx": "12",
        "actualSz": "",
        "actualPx": "",
        "actualSide": "",
        "triggerTime": "1597026383085",
        "cTime": "1597026383000"
    }]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instType String 产品类型
> uly String 合约标的指数
> instId String 产品ID
data Array 订阅的数据
> instType String 产品类型
> instId String 产品ID
> ccy String 保证金币种，仅单币种保证金账户下的全仓币币杠杆需要选择保证金币种
> ordId String 订单ID，与策略委托订单关联的订单ID
> algoId String 策略委托单ID
> sz String 委托数量，币币/币币杠杆 以币为单位；交割/永续/期权 以张为单位
> ordType String 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
> side String 订单方向，buy sell
> posSide String 持仓方向
long：双向持仓多头
short：双向持仓空头
net：单向持仓
> tdMode String 交易模式
保证金模式 cross：全仓 isolated：逐仓
非保证金模式 cash：现金
> lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
> state String 订单状态
live：待生效
effective：已生效
canceled：已撤销
order_failed：委托失败
> tpTriggerPx String 止盈触发价
> tpOrdPx String 止盈委托价，委托价格为-1时，执行市价止盈
> slTriggerPx String 止损触发价
> slOrdPx String 止损委托价委托价格为-1时，执行市价止损
> triggerPx String 计划委托单的触发价格
> ordPx String 计划委托单的委托价格
> actualSz String 实际委托量
> actualPx String 实际委托价
> actualSide String 实际触发方向，sl：止损 tp：止盈
> triggerTime String 策略委托触发时间， Unix时间戳的毫秒数格式，如 1597026383085
> cTime String 订单创建时间， Unix时间戳的毫秒数格式，如 1597026383085

交易

WebSocket交易需要身份验证。

下单

只有当您的账户有足够的资金才能下单。一旦下单，您的账户资金将在订单生命周期内被冻结。被冻结的资金以及数量取决于订单指定的类型和参数

限速：60次/2s

请求示例

{
    "id": "1512",
    "op": "order",
    "args": [{
        "side": "buy",
        "instId": "BTC-USDT",
        "tdMode": "isolated",
        "ordType": "market",
        "sz": "1"
    }]
}

请求参数

参数名 类型 是否必须 描述
id String 是 消息的唯一标识
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
op String 是 支持的业务操作，如 order
args Array 是 请求参数
> instId String 是 产品ID，如 BTC-USD-190927-5000-C
> tdMode String 是 交易模式
保证金模式 isolated：逐仓 cross： 全仓
非保证金模式 cash：现金
> ccy String 否 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
> clOrdId String 否 由用户设置的订单ID
字母（区分大小写）与数字的组合，必须以字母开头，可以是纯字母，且长度要在1-32位之间。
> tag String 否 订单标签
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-8位之间。
> side String 是 订单方向，buy sell
> posSide String 否 持仓方向
在单向持仓模式下，默认 net
在双向持仓模式下必填，且仅可选择 long 或 short，仅适用于交割/永续
> ordType String 是 订单类型
market：市价单
limit：限价单
post_only： 只做maker单
fok： 全部成交或立即取消单
ioc： 立即成交并取消剩余单
> sz String 是 当type为limit时，表示买入或卖出的数量
当type为market时，现货交易买入时，表示买入的总金额，而
当其他产品买入或卖出时，表示数量
> px String 否 委托价，仅适用于限价单
> reduceOnly Boolean 否 是否只减仓，true false ，仅适用于币币杠杆

成功返回示例

{
    "id": "1512",
    "op": "order",
    "data": [{
        "clOrdId": "",
        "ordId": "12345689",
        "tag": "",
        "sCode": "0",
        "sMsg": ""
    }],
    "code": "0",
    "msg": ""
}

失败返回示例

{
    "id": "1512",
    "op": "order",
    "data": [{
        "clOrdId": "",
        "ordId": "",
        "tag": "",
        "sCode": "5XXXX",
        "sMsg": "not exist"
    }],
    "code": "1",
    "msg": ""
}

格式错误返回示例

{
    "id": "1512",
    "op": "order",
    "data": [],
    "code": "60013",
    "msg": "Invalid args"
}

返回参数

参数名 类型 描述
id String 消息的唯一标识
op String 业务操作
code String 代码
msg String 消息
data Array 请求成功后返回的数据
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID
> tag String 订单标签
> sCode String 订单状态码，0 代表成功
> sMsg String 订单状态消息

批量下单

批量进行下单操作，每次可批量交易不同类型的产品，最多可下单20个

限速：300次/2s

请求示例

{
    "id": "1513",
    "op": "batch-orders",
    "args": [{
        "side": "buy",
        "instId": "BTC-USDT",
        "tdMode": "isolated",
        "ordType": "limit",
        "sz": "1"
    }, {
        "side": "buy",
        "instId": "BTC-USD-200925",
        "tdMode": "isolated",
        "ordType": "limit",
        "sz": "1"
    }]
}

请求参数

参数名 类型 是否必须 描述
id String 是 消息的唯一标识
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
op String 是 支持的业务操作，如 batch-orders
args Array 是 请求参数
> instId String 是 产品ID，如 BTC-USD-190927-5000-C
> tdMode String 否 交易模式
保证金模式 cross：全仓 isolated：逐仓
非保证金模式 cash：现金
> ccy String 否 保证金币种，仅适用于单币种保证金账户下的全仓杠杆订单
> clOrdId String 否 用户提供的订单ID
字母（区分大小写）与数字的组合，必须以字母开头，可以是纯字母，且长度要在1-32位之间。
> tag String 否 订单标签
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-8位之间。
> side String 是 订单方向， buy sell
> posSide String 否 持仓方向
在单向持仓模式下，默认 net
在双向持仓模式下必填，且仅可选择 long 或 short，仅适用于交割/永续
> ordType String 是 订单类型
market： 市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消单
ioc：立即成交并取消剩余单
> sz String 是 买入或卖出的数量
当type为limit时，表示买入或卖出的数量
当type为market时，表示买入或卖出的总金额，而
当其他产品买入或卖出时，表示数量
> px String 否 委托价，仅适用于限价单
> reduceOnly Boolean 否 是否只减仓，true false  ，仅适用于币币杠杆

全部成功返回示例

{
    "id": "1513",
    "op": "batch-orders",
    "data": [{
        "clOrdId": "",
        "ordId": "12345689",
        "tag": "",
        "sCode": "0",
        "sMsg": ""
    }, {
        "clOrdId": "",
        "ordId": "12344",
        "tag": "",
        "sCode": "0",
        "sMsg": ""
    }],
    "code": "0",
    "msg": ""
}

部分成功返回示例

{
    "id": "1513",
    "op": "batch-orders",
    "data": [{
        "clOrdId": "",
        "ordId": "12345689",
        "tag": "",
        "sCode": "0",
        "sMsg": ""
    }, {
        "clOrdId": "",
        "ordId": "",
        "tag": "",
        "sCode": "5XXXX",
        "sMsg": "Insufficient margin"
    }],
    "code": "2",
    "msg": ""
}

全部失败返回示例

{
    "id": "1513",
    "op": "batch-orders",
    "data": [{
        "clOrdId": "oktswap6",
        "ordId": "",
        "tag": "",
        "sCode": "5XXXX",
        "sMsg": "Insufficient margin"
    }, {
        "clOrdId": "oktswap7",
        "ordId": "",
        "tag": "",
        "sCode": "5XXXX",
        "sMsg": "Insufficient margin"
    }],
    "code": "1",
    "msg": ""
}

格式错误返回示例

{
    "id": "1513",
    "op": "batch-orders",
    "data": [],
    "code": "60013",
    "msg": "Invalid args"
}

返回参数

参数 类型 描述
id String 消息的唯一标识
op String 业务操作
code String 代码
msg String 消息
data Array 请求成功后返回的数据
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID
> tag String 订单标签
> sCode String 订单状态码，0 代表成功
> sMsg String 订单状态消息

撤单

撤销当前未完成订单

限速：60次/2s

请求示例

{
    "id": "1514",
    "op": "cancel-order",
    "args": [{
        "instId": "BTC-USDT-200920",
        "ordId": "2510789768709120"
    }]
}

请求参数

参数名 类型 是否必须 描述
id String 是 消息的唯一标识
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
op String 是 支持的业务操作，如 cancel-order
args Array 是 请求参数
> instId String 是 产品ID
> ordId String 可选 订单ID
ordId和clOrdId必须传一个，若传两个，以 ordId 为主
> clOrdId String 可选 用户提供的订单ID
由字母开头，1到32位的字母、数字组成

成功返回示例

{
    "id": "1514",
    "op": "cancel-order",
    "data": [{
        "clOrdId": "",
        "ordId": "2510789768709120",
        "sCode": "0",
        "sMsg": ""
    }],
    "code": "0",
    "msg": ""
}

失败返回示例

{
    "id": "1514",
    "op": "cancel-order",
    "data": [{
        "clOrdId": "",
        "ordId": "2510789768709120",
        "sCode": "5XXXX",
        "sMsg": "Order not exist"
    }],
    "code": "1",
    "msg": ""
}

格式错误返回示例

{
    "id": "1514",
    "op": "cancel-order",
    "data": [],
    "code": "60013",
    "msg": "Invalid args"
}

返回参数

参数 类型 描述
id String 消息的唯一标识
op String 业务操作
code String 代码
msg String 消息
data Array 请求成功后返回的数据
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID
> sCode String 订单状态码，0 代表成功
> sMsg String 订单状态消息

批量撤单

批量进行撤单操作，每次可批量撤销不同类型的产品，最多撤销20个

限速：300次/2s

请求示例

{
    "id": "1515",
    "op": "batch-cancel-orders",
    "args": [{
        "instId": "BTC-USDT-200920",
        "ordId": "2517748157541376"
    }, {
        "instId": "LTC-USDT-200920",
        "ordId": "2517748155771904"
    }]
}

请求参数

参数 类型 是否必须 描述
id String 是 消息的唯一标识
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
op String 是 支持的业务操作，如 batch-cancel-orders
args Array 是 请求参数
> instId String 是 产品ID
> ordId String 可选 订单ID
ordId和clOrdId必须传一个，若传两个，以ordId 为主
> clOrdId String 可选 用户提供的订单ID
由字母开头，1到32位的字母、数字组成

全部成功返回示例

{
    "id": "1515",
    "op": "batch-cancel-orders",
    "data": [{
        "clOrdId": "oktswap6",
        "ordId": "2517748157541376",
        "sCode": "0",
        "sMsg": ""
    }, {
        "clOrdId": "oktswap7",
        "ordId": "2517748155771904",
        "sCode": "0",
        "sMsg": ""
    }],
    "code": "0",
    "msg": ""
}

部分成功的返回示例

{
    "id": "1515",
    "op": "batch-cancel-orders",
    "data": [{
        "clOrdId": "oktswap6",
        "ordId": "2517748157541376",
        "sCode": "0",
        "sMsg": ""
    }, {
        "clOrdId": "oktswap7",
        "ordId": "2517748155771904",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }],
    "code": "2",
    "msg": ""
}

全部失败的返回示例

{
    "id": "1515",
    "op": "batch-cancel-orders",
    "data": [{
        "clOrdId": "oktswap6",
        "ordId": "2517748157541376",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }, {
        "clOrdId": "oktswap7",
        "ordId": "2517748155771904",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }],
    "code": "1",
    "msg": ""
}

格式错误示例

{
    "id": "1515",
    "op": "batch-cancel-orders",
    "data": [],
    "code": "60013",
    "msg": "Invalid args"
}

返回参数

参数 类型 描述
id String 消息的唯一标识
op String 业务操作
code String 代码
msg String 消息
data Array 请求成功后返回的数据
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID
> sCode String 订单状态码，0 代表成功
> sMsg String 订单状态消息

改单

修改当前未成交的订单

限速：60次/2s

请求示例

{
    "id": "1512",
    "op": "amend-order",
    "args": [{
        "instId": "BTC-USDT-200920",
        "ordId": "2510789768709120",
        "newSz": "2"
    }]
}

请求参数

参数名 类型 是否必须 描述
id String 是 消息的唯一标识
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
op String 是 支持的业务操作，如 amend-order
args Array 是 请求参数
> instId String 是 产品ID
> cxlOnFail Boolean 否 当订单修改失败时，该订单是否需要自动撤销
false：不自动撤单 true：自动撤单 ，默认为 false
> ordId String 可选 订单ID
ordId和clOrdId必须传一个，若传两个，以 ordId 为主
> clOrdId String 可选 用户提供的订单ID
> reqId String 否 用户提供的reqId
如果提供，那在返回参数中返回reqId，方便找到相应的修改请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
> newSz String 可选 请求修改的新数量，newSz和newPx不可同时为空。对于部分成交订单，该数量应包含已成交数量。
> newPx String 可选 请求修改的新价格

成功返回示例

{
    "id": "1512",
    "op": "amend-order",
    "data": [{
        "clOrdId": "",
        "ordId": "2510789768709120",
        "reqId": "b12344",
        "sCode": "0",
        "sMsg": ""
    }],
    "code": "0",
    "msg": ""
}

失败返回示例

{
    "id": "1512",
    "op": "amend-order",
    "data": [{
        "clOrdId": "",
        "ordId": "2510789768709120",
        "reqId": "b12344",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }],
    "code": "1",
    "msg": ""
}

格式错误返回示例

{
    "id": "1512",
    "op": "amend-order",
    "data": [],
    "code": "60013",
    "msg": "Invalid args"
}

返回参数

参数 类型 描述
id String 消息的唯一标识
op String 业务操作
code String 代码
msg String 消息
data Array 请求成功后返回的数据
> ordId String 订单ID
> clOrdId String 用户提供的订单ID
> reqId String 用户提供的reqId
如果用户在请求中提供reqId，则返回相应reqId
> sCode String 订单状态码，0 代表成功
> sMsg String 订单状态消息

批量改单

批量进行改单操作，每次可批量修改不同类型的产品，最多改20个

限速：300次/2s

请求示例

{
    "id": "1513",
    "op": "batch-amend-orders",
    "args": [{
        "instId": "BTC-USDT-200920",
        "ordId": "12345689",
        "newSz": "2"
    }, {
        "instId": "BTC-USDT-200920",
        "ordId": "12344",
        "newSz": "2"
    }]
}

请求参数

参数名 类型 是否必须 描述
id String 是 消息的唯一标识
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
op String 是 支持的业务操作，如 batch-amend-orders
args Array 是 请求参数
> instId String 是 产品ID
> cxlOnFail Boolean 否 当订单修改失败时，该订单是否需要自动撤销
false：不自动撤单 true：自动撤单 ，默认为false
> ordId String 可选 订单ID
ordId 和 clOrdId 必须传一个，若传两个，以order id 为主
> clOrdId String 可选 用户提供的订单ID
> reqId String 否 用户提供的请求ID
如果提供，那在返回参数中返回reqId，方便找到相应的修改请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
> newSz String 可选 修改后的新数量，newSz和newPx不可同时为空。对于部分成交订单，该数量应包含已成交数量。
> newPx String 可选 修改后的新价格

全部成功返回示例

{
    "id": "1513",
    "op": "batch-amend-orders",
    "data": [{
        "clOrdId": "oktswap6",
        "ordId": "12345689",
        "reqId": "b12344",
        "sCode": "0",
        "sMsg": ""
    }, {
        "clOrdId": "oktswap7",
        "ordId": "12344",
        "reqId": "b12344",
        "sCode": "0",
        "sMsg": ""
    }],
    "code": "0",
    "msg": ""
}

全部失败返回示例

{
    "id": "1513",
    "op": "batch-amend-orders",
    "data": [{
        "clOrdId": "",
        "ordId": "12345689",
        "reqId": "b12344",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }, {
        "clOrdId": "oktswap7",
        "ordId": "",
        "reqId": "b12344",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }],
    "code": "1",
    "msg": ""
}

部分成功返回示例

{
    "id": "1513",
    "op": "batch-amend-orders",
    "data": [{
        "clOrdId": "",
        "ordId": "12345689",
        "reqId": "b12344",
        "sCode": "0",
        "sMsg": ""
    }, {
        "clOrdId": "oktswap7",
        "ordId": "",
        "reqId": "b12344",
        "sCode": "5XXXX",
        "sMsg": "order not exist"
    }],
    "code": "2",
    "msg": ""
}

格式错误返回示例

{
    "id": "1513",
    "op": "batch-amend-orders",
    "data": [],
    "code": "60013",
    "msg": "Invalid args"
}

返回参数

参数名 类型 描述
id String 消息的唯一标识
op String 业务操作
code String 代码
msg String 消息
data Array 请求成功后返回的数据
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID
> reqId String 用户提供的请求ID
如果用户在请求中提供reqId，则返回相应reqId
> sCode String 订单状态码，0 代表成功
> sMsg String 订单状态消息

错误码

这里是REST API 错误码

REST

REST API错误码从50000到59999

公共

错误码从50000到53999

通用类

错误提示 HTTP状态码 错误码
操作成功 200 0
操作全部失败 200 1
批量操作部分成功 200 2
body不能为空 400 50000
撮合引擎正在升级，请稍后重试 200 50001
非法的json数据 400 50002
接口请求超时 400 50004
接口已下线或无法使用 410 50005
无效的Content_Type，请使用"application/json"格式 400 50006
用户被冻结 200 50007
用户不存在 200 50008
用户处于爆仓冻结 200 50009
用户ID为空 200 50010
用户请求频率过快，超过该接口允许的限额 429 50011
用户状态无效 200 50012
当前系统繁忙，请稍后重试 429 50013
必填参数{0}不能为空 400 50014
参数{0}和{1}不能同时为空 400 50015
参数{0}和{1}不匹配 400 50016
当前仓位处于ADL冻结中，无法进行相关操作 200 50017
{0}币种处于ADL冻结中，无法进行相关操作 200 50018
当前账户处于ADL冻结中，无法进行相关操作 200 50019
当前仓位处于强平冻结中，无法进行相关操作 200 50020
{0}币种处于强平冻结中，无法进行相关操作 200 50021
当前账户处于强平冻结中，无法进行相关操作 200 50022
资金费冻结，无法进行相关操作 200 50023
参数{0}和{1}不能同时存在 200 50024
参数{0}传值个数超过最大限制{1} 200 50025

API类

错误提示 HTTP状态码 错误码
Api已被冻结，请联系客服处理 400 50100
APIKey与当前环境不匹配 401 50101
请求时间戳过期 401 50102
请求头"OK_ACCESS_KEY"不能为空 401 50103
请求头"OK_ACCESS_PASSPHRASE"不能为空 401 50104
请求头"OK_ACCESS_PASSPHRASE"错误 401 50105
请求头"OK_ACCESS_SIGN"不能为空 401 50106
请求头"OK_ACCESS_TIMESTAMP"不能为空 401 50107
券商ID不存在 401 50108
券商域名不存在 401 50109
无效的ip 401 50110
无效的OK_ACCESS_KEY 401 50111
无效的OK_ACCESS_TIMESTAMP 401 50112
无效的签名 401 50113
无效的授权 401 50114

交易类

错误提示 HTTP状态码 错误码
{0}参数错误 400 51000
交易产品ID不存在 200 51001
交易产品ID不匹配指数 200 51002
ordId或clOrdId至少填一个 200 51003
委托数量超过用户当前档位 200 51004
委托数量大于单笔上限 200 51005
委托价格不在限价范围内 200 51006
委托失败，委托数量不可小于1张（用户下单数量不足1张时） 200 51007
委托失败，账户可用余额不足 200 51008
下单功能被平台冻结 200 51009
账户等级不足 200 51010
ordId重复 200 51011
币种不存在 200 51012
指数不存在 200 51014
instId和instType不匹配 200 51015
ordId重复 200 51016
杠杆委托交易借币超出限额 200 51017
期权交易账户不能有净空头持仓 200 51018
期权逐仓不能有净多头持仓 200 51019
委托数量必须超过单笔下限 200 51020
合约待上线 200 51021
合约暂停中 200 51022
仓位不存在 200 51023
统一账户冻结 200 51024
委托笔数超限 200 51025
交易产品类型不匹配指数（instType和uly不匹配） 200 51026
合约已到期 200 51027
合约交割中 200 51028
合约结算中 200 51029
资金费结算中 200 51030
币交易金额小于最小可交易金额 200 51100
超出单笔最大挂单张数 200 51101
超出合约最大挂单数量 200 51102
超出标的最大挂单数量 200 51103
超出标的最大挂单张数 200 51104
超出合约最大可开张数 200 51105
超出标的最大可开张数 200 51106
超出标的最大持仓张数 200 51107
持仓量超过市价全平最大限制 200 51108
订单深度中无买一卖一价 200 51109
集合竞价开始后方可下限价单 200 51110
批量下单时，超过最大单数{0} 200 51111
平仓张数大于该仓位的可平张数 200 51112
市价全平操作过于频繁 429 51113
市价全平前请先撤销所有平仓单 200 51115
委托价格或触发价格超过{0}美元 200 51116
委托总数量需大于单笔上限 200 51118
下单失败，用户余额不足 200 51119
下单数量不足{0}张 200 51120
下单张数应为一手张数的倍数 200 51121
委托价格小于最小值{0} 200 51122
价格发现期间您只可下限价单 200 51124
当前杠杆存在非只减仓挂单，请撤销所有非只减仓挂单后进行只减仓挂单 200 51125
当前杠杆存在只减仓挂单，请撤销所有只减仓挂单后进行非只减仓挂单 200 51126
仓位可用余额为0 200 51127
跨币种账户无法进行全仓杠杆交易 200 51128
持仓及买入订单价值已达到持仓限额，不允许继续买入 200 51129
逐仓杠杆保证金币种错误 200 51130
仓位可用余额不足 200 51131
仓位正资产小于最小交易单位 200 51132
跨币种全仓币币不支持只减仓功能 200 51133
平仓失败，请检查持仓和挂单 200 51134
您的平仓价格已触发限价，最高买入价格为{0} 200 51135
您的平仓价格已触发限价，最低卖出价格为{0} 200 51136
您的开仓价格已触发限价，最高买入价格为{0} 200 51137
您的开仓价格已触发限价，最低卖出价格为{0} 200 51138
交易账户下币币不支持只减仓功能 200 51139
市价委托单笔价值不能超过100,000 USDT 200 51201
市价单下单数量超出最大值 200 51202
普通委托数量超出最大限制{0} 200 51203
限价委托单价格不能为空 200 51204
不支持只减仓操作 200 51205
策略委托价格不在正确范围内 200 51250
策略委托类型错误 200 51251
策略委托数量不在正确范围内 200 51252
冰山委托单笔均值超限 200 51253
冰山委托单笔均值错误 200 51254
冰山委托单笔委托超限 200 51255
冰山委托深度错误 200 51256
跟踪委托回调服务错误，回调幅度限制为{0}<x<={1}% 200 51257
跟踪委托失败，卖单激活价格需大于最新成交价格 200 51258
跟踪委托失败，买单激活价格需小于最新成交价格 200 51259
每个用户最多可同时持有{0}笔未成交的跟踪委托 200 51260
每个用户最多可同时持有{0}笔未成交的止盈止损 200 51261
每个用户最多可同时持有{0}笔未成交的冰山委托 200 51262
每个用户最多可同时持有{0}笔未成交的时间加权单 200 51263
时间加权单笔均值超限 200 51264
时间加权单笔上限错误 200 51265
时间加权扫单比例出错 200 51267
时间加权扫单范围出错 200 51268
时间加权委托间隔错误，应为{0}<=x<={1} 200 51269
时间加权委托深度限制为0<x<=1% 200 51270
时间加权委托失败，扫单比例应该为0<x<=100% 200 51271
时间加权委托失败，扫单范围应该为0<x<=1% 200 51272
时间加权委托总量应为大于0 200 51273
时间加权委托总数量需大于单笔上限 200 51274
止盈止损市价单笔委托数量不能超过最大限制 200 51275
止盈止损市价单不能指定价格 200 51276
止盈触发价格不能大于最新成交价 200 51277
止损触发价格不能小于最新成交价 200 51278
止盈触发价格不能小于最新成交价 200 51279
止损触发价格不能大于最新成交价 200 51280
撤单失败，订单不存在 200 51400
撤单失败，订单已撤销 200 51401
撤单失败，订单已完成 200 51402
撤单失败，该委托类型无法进行撤单操作 200 51403
价格发现第二阶段您不可撤单 200 51404
撤单失败，您当前没有未成交的订单 200 51405
撤单数量超过最大允许单数{0} 400 51406
ordIds和clOrdIds不能同时为空 200 51407
币对id或币对名称与订单信息不匹配 200 51408
币对id或币对名称不能同时为空 200 51409
撤单失败，订单已处于撤销中 200 51410
价格和数量不能同时为空 200 51500
修改订单超过最大允许单数{0} 200 51501
修改订单失败，用户保证金不足 200 51502
修改订单失败,订单不存在 200 51503
订单类型不支持改单 200 51506
集合竞价第一阶段和第二阶段不允许改单 200 51508
修改订单失败,订单已撤销 200 51509
修改订单失败,订单已完成 200 51510
修改订单失败,订单价格不满足Post Only条件 200 51511
查询订单的状态不存在 200 51600
订单状态和订单id不能同时存在 200 51601
订单状态或订单id必须存在一个 200 51602
查询订单不存在 200 51603

数据类

错误提示 HTTP状态码 错误码
没有最新行情信息 200 52000

币币/币币杠杆类

错误码从54000到54999

错误提示 HTTP状态码 错误码
暂不支持币币杠杆业务 200 54000
只有跨币种全仓账户才能设置自动借币 200 54001

交割合约类

暂无

永续合约类

暂无

期权合约类

暂无

资金类

错误码从58000到58999

错误提示 HTTP状态码 错误码
获取母账户余额，{0}不支持 200 58000
交易密码错误 200 58001
请先开通余币宝服务 200 58002
余币宝不支持该币种 200 58003
账户冻结 200 58004
赎回额度不可超过{0} 200 58005
币种{0}不支持当前操作 200 58006
行权或结算中，暂无法转入或转出 200 58100
划转冻结 200 58101
划转过于频繁，请降低划转频率 429 58102
您在法币区的交易异常，现已被限制划转功能，请您联系在线客服以解除限制 200 58104
您在法币区的交易异常，现已被限制划转功能，请您在网页或APP进行法币划转操作以完成身份验证 200 58105
请先开通币币杠杆账户 200 58106
请先开通交割合约账户 200 58107
请先开通期权合约账户 200 58108
请先开通永续合约账户 200 58109
当前合约触发市场风控，平台已暂停该合约的资金转出功能，请耐心等待 200 58110
永续合约正在收取资金费，暂时无法做资金划转，请稍后重试 200 58111
转账金额必须大于零（划转接口，金额输入不正确） 400 58114
子账户不存在 200 58115
转出数量大于最大可转数量 200 58116
该币种暂不支持从{0}提现至{1}，敬请谅解 200 58200
今日提现金额累计超过每日限额 200 58201
NEO最小提现数量为1，且提现数量必须为整数 200 58202
请先添加提现地址 200 58203
提现冻结 200 58204
提现金额大于单笔提现最大金额（单笔提现最大金额提现接口，提现金额输入有误） 200 58205
提现金额小于最小提现金额（最小提现金额提现接口，提现金额输入有误） 200 58206
提现失败，认证地址错误 200 58207
提现失败，邮箱未绑定 200 58208
提现失败，子账号不允许 200 58209
提现手续费大于最大值（提现接口，提现手续费输入有误） 200 58210
提现手续费小于最小值（提现接口，手续费输入有误） 200 58211
提现手续费应填写为提币数量的{0}% 200 58212
提现前请先设置交易密码 200 58213
创建充值地址超过上限 200 58300
您的余额不足 200 58350

账户类

错误码从59000到59999

错误提示 HTTP状态码 错误码
挂单或持仓存在，无法设置 200 59000
当前存在借币，暂不可切换 200 59001
当前存在持仓，请撤销所有挂单后进行杠杆倍数修改 200 59100
当前业务存在逐仓挂单，请撤销所有挂单后进行杠杆倍数修改 200 59101
杠杆倍数超过最大杠杆倍数，请重新调整杠杆倍数 200 59102
杠杆倍数过低，账户中没有足够的可用保证金可以追加，请重新调整杠杆倍数 200 59103
杠杆倍数过高，借币仓位已超过该杠杆倍数的最大仓位，请重新调整杠杆倍数 200 59104
杠杆倍数设置不能小于{0}，请重新调整杠杆倍数 400 59105
您下单后仓位总张数所处档位的最高可用杠杆为{0}，请重新调整 200 59106
当前业务存在全仓挂单，请撤销所有挂单后进行杠杆倍数修改 200 59107
杠杆倍数过低，账户中保证金不足，请重新调整杠杆倍数 200 59108
调整后，账户权益小于所需保证金，请重新调整杠杆倍数 200 59109
账户余额不足 200 59200
账户余额是负数 200 59201
追加保证金失败，指定仓位不存在 200 59300
调整保证金超过当前最大可调整数量 200 59301
当前仓位存在平仓挂单，请撤销平仓挂单后进行保证金修改 200 59302
持仓价值达到持仓限制 200 59401

WebSocket

公共

错误码从60000到63999

通用类

错误消息 错误码
"OK_ACCESS_KEY"不能为空 60001
"OK_ACCESS_SIGN"不能为空 60002
"OK_ACCESS_PASSPHRASE"不能为空 60003
无效的OK_ACCESS_TIMESTAMP 60004
无效的OK_ACCESS_KEY 60005
请求时间戳过期 60006
无效的签名 60007
公共频道不支持登录 60008
登陆失败 60009
重复登录 60010
用户需要登录 60011
不合法的请求 60012
无效的参数args 60013
用户请求频率过快，超过该接口允许的限额 60014
30秒内没有数据通讯，连接关闭 60015
缓冲区无法写入数据，连接关闭 60016
无效的url path 60017
频道不存在 60018
无效的op {0} 60019
内部系统错误 63999

日志

更新日志

Java Python Go C++