导航
English

概览

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

满意度调研

为了更好的提高V5 API的接口服务用户体验,希望您将使用V5 API过程中的感受和建议告诉我们,我们非常重视每一位用户的反馈。V5 API满意度调研

实盘交易

实盘API交易地址如下:

AWS 地址如下:

旧的AWS 地址如下

模拟盘交易

目前可以进行V5 API的模拟盘交易,用户可以通过模拟盘API请求除了提币充值申购赎回外的所有接口。

模拟盘API交易地址如下:

旧的模拟盘API交易地址如下

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

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

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

请求头示例

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

基本信息

交易所层面的下单规则如下:

限价单(包括高级限价单)的最大挂单数:4000个

策略策略委托订单最大挂单数:

做市商申请

满足以下任意条件的用户即可申请加入欧易做市商计划:

提供以下信息发送邮件至:[email protected]或咨询大客户经理

为鼓励做市商为平台提供更好的流动性,可以享受更优的交易手续费,同时也承担相应的做市责任。具体做市责任及手续费申请成功后提供相关资料。

交互式浏览器

使用说明

该功能接口用户需先登录,接口只会请求模拟环境

立即体验 交互式浏览器

REST API

请求验证

生成APIKey

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

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

发起请求

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

所有请求都应该含有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接口需要身份验证。

下单

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

限速: 60次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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-16位之间。
side String 订单方向 buy:买 sell:卖
posSide String 可选 持仓方向 在双向持仓模式下必填,且仅可选择 longshort
ordType String 订单类型
market:市价单
limit:限价单
post_only:只做maker单
fok:全部成交或立即取消
ioc:立即成交并取消剩余
optimal_limit_ioc:市价委托立即成交并取消剩余(仅适用交割、永续)
sz String 委托数量
px String 可选 委托价格,仅适用于limitpost_onlyfokioc类型的订单
reduceOnly Boolean 是否只减仓,truefalse,默认false
仅适用于币币杠杆,以及买卖模式下的交割/永续
仅适用于单币种保证金模式跨币种保证金模式
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
仅适用于币币订单
banAmend Boolean 是否禁止币币市价改单,true 或 false,默认false
为true时,余额不足时会下单失败,仅适用于币币市价单

返回结果

{
    "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

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

限速规则:批量请求中包含几个元素,限速计数就加几次,总的限制是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-16位之间。
side String 订单方向 buy:买 sell:卖
posSide String 可选 持仓方向 在双向持仓模式下必填,且仅可选择 longshort
ordType String 订单类型
market:市价单
limit:限价单
post_only:只做maker单
fok:全部成交或立即取消
ioc:立即成交并取消剩余
optimal_limit_ioc:市价委托立即成交并取消剩余(仅适用交割、永续)
sz String 委托数量
px String 委托价格,仅适用于limitpost_onlyfokioc类型的订单
reduceOnly Boolean 是否只减仓,truefalse,默认false
仅适用于币币杠杆,以及买卖模式下的交割/永续
仅适用于单币种保证金模式跨币种保证金模式
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
仅适用于币币订单
默认买为计价货币,卖为交易货币
banAmend Boolean 是否禁止币币市价改单,true 或 false,默认false
为true时,余额不足时会下单失败,仅适用于币币市价单

返回结果

{
    "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

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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, ordIdclOrdId必须传一个,若传两个,以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

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

限速规则:批量请求中包含几个元素,限速计数就加几次,总的限制是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, ordIdclOrdId必须传一个,若传两个,以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

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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, ordIdclOrdId必须传一个,若传两个,以ordId为主
clOrdId String 可选 用户自定义order ID
reqId String 用户自定义修改事件ID
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
newSz String 可选 修改的新数量,newSznewPx不可同时为空。对于部分成交订单,该数量应包含已成交数量。
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

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

限速规则:批量请求中包含几个元素,限速计数就加几次,总的限制是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, ordIdclOrdId必须传一个,若传两个,以ordId为主
clOrdId String 可选 用户自定义order ID
reqId String 用户自定义修改事件ID
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
newSz String 可选 修改的新数量,newSznewPx不可同时为空。对于部分成交订单,该数量应包含已成交数量。
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

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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 可选 保证金币种,单币种保证金模式的全仓币币杠杆平仓必填
autoCxl Boolean 当市价全平时,平仓单是否需要自动撤销,默认为false.
false:不自动撤单 true:自动撤单

返回结果

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

返回参数

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

获取订单信息

查订单信息

限速: 60次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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 , ordIdclOrdId必须传一个,若传两个,以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":"0",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "source": "",
            "state":"live",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"last",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"last",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "tgtCcy":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
SPOT:币币
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
instId String 产品ID
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
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:立即成交并取消剩余
optimal_limit_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 止盈触发价
tpTriggerPxType String 止盈触发价类型
last:最新价格
index:指数价格
mark:标记价格
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slTriggerPxType String 止损触发价类型
last:最新价格
index:指数价格
mark:标记价格
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费,平台向用户收取的交易手续费,手续费扣除为负数。如: -0.01
rebateCcy String 返佣金币种
source String 订单来源
13:策略委托单触发后的生成的限价单
rebate String 返佣金额,平台向达到指定lv交易等级的用户支付的挂单奖励(返佣),如果没有返佣金,该字段为“”。手续费返佣为正数,如:0.01
category String 订单种类
normal:普通委托
twap:TWAP自动换币
adl:ADL自动减仓
full_liquidation:强制平仓
partial_liquidation:强制减仓
delivery:交割
ddh:对冲减仓类型订单
uTime String 订单状态更新时间,Unix时间戳的毫秒数格式,如:1597026383085
cTime String 订单创建时间,Unix时间戳的毫秒数格式, 如 :1597026383085

获取未成交订单列表

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

限速: 60次/2s

限速规则:UserID

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:立即成交并取消剩余
optimal_limit_ioc:市价委托立即成交并取消剩余(仅适用交割、永续)
state String 订单状态
live:等待成交
partially_filled:部分成交
after String 请求此ID之前(更旧的数据)的分页内容,传的值为对应接口的ordId
before String 请求此ID之后(更新的数据)的分页内容,传的值为对应接口的ordId
limit String 返回结果的数量,默认100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "accFillSz": "0",
            "avgPx": "",
            "cTime": "1618235248028",
            "category": "normal",
            "ccy": "",
            "clOrdId": "",
            "fee": "0",
            "feeCcy": "BTC",
            "fillPx": "",
            "fillSz": "0",
            "fillTime": "",
            "instId": "BTC-USDT",
            "instType": "SPOT",
            "lever": "5.6",
            "ordId": "301835739059335168",
            "ordType": "limit",
            "pnl": "0",
            "posSide": "net",
            "px": "59200",
            "rebate": "0",
            "rebateCcy": "USDT",
            "side": "buy",
            "slOrdPx": "",
            "slTriggerPx": "",
            "slTriggerPxType": "last",
            "source": "",
            "state": "live",
            "sz": "1",
            "tag": "",
            "tdMode": "cross",
            "tgtCcy": "",
            "tpOrdPx": "",
            "tpTriggerPx": "",
            "tpTriggerPxType": "last",
            "tradeId": "",
            "uTime": "1618235248028"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
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:立即成交并取消剩余
optimal_limit_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 止盈触发价
tpTriggerPxType String 止盈触发价类型
last:最新价格
index:指数价格
mark:标记价格
slTriggerPx String 止损触发价
slTriggerPxType String 止损触发价类型
last:最新价格
index:指数价格
mark:标记价格
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费,平台向用户收取的交易手续费,手续费扣除为负数。如: -0.01
rebateCcy String 返佣金币种
source String 订单来源
13:策略委托单触发后的生成的限价单
rebate String 返佣金额,平台向达到指定lv交易等级的用户支付的挂单奖励(返佣),如果没有返佣金,该字段为“”。手续费返佣为正数,如:0.01
category String 订单种类
normal: 普通委托
uTime String 订单状态更新时间,Unix时间戳的毫秒数格式,如 1597026383085
cTime String 订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085

获取历史订单记录(近七天)

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

限速: 40次/2s

限速规则:UserID

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:立即成交并取消剩余
optimal_limit_ioc:市价委托立即成交并取消剩余(仅适用交割、永续)
state String 订单状态
canceled:撤单成功
filled:完全成交
category String 订单种类
twap:TWAP自动换币
adl:ADL自动减仓
full_liquidation:强制平仓
partial_liquidation:强制减仓
delivery:交割
ddh:对冲减仓类型订单
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":"0",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "source": "",
            "state":"filled",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"last",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"last",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "tgtCcy":"",
            "pnl":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
ccy String 保证金币种,仅适用于单币种保证金模式下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
ordType String 订单类型
market:市价单
limit:限价单
post_only:只做maker单
fok:全部成交或立即取消
ioc:立即成交并取消剩余
optimal_limit_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 止盈触发价
tpTriggerPxType String 止盈触发价类型
last:最新价格
index:指数价格
mark:标记价格
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slTriggerPxType String 止损触发价类型
last:最新价格
index:指数价格
mark:标记价格
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费,平台向用户收取的交易手续费,手续费扣除为负数。如: -0.01
rebateCcy String 返佣金币种
source String 订单来源
13:策略委托单触发后的生成的限价单
rebate String 返佣金额,平台向达到指定lv交易等级的用户支付的挂单奖励(返佣),如果没有返佣金,该字段为“”。手续费返佣为正数,如:0.01
pnl String 收益
category String 订单种类
normal:普通委托
twap:TWAP自动换币
adl:ADL自动减仓
full_liquidation:强制平仓
partial_liquidation:强制减仓
delivery:交割
ddh:对冲减仓类型订单
uTime String 订单状态更新时间,Unix时间戳的毫秒数格式,如1597026383085
cTime String 订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085

获取历史订单记录(近三个月)

获取最近3个月的已经完结状态的订单数据

限速: 20次/2s

限速规则:UserID

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:立即成交并取消剩余
optimal_limit_ioc:市价委托立即成交并取消剩余(仅适用交割、永续)
state String 订单状态
canceled:撤单成功
filled:完全成交
category String 订单种类
twap:TWAP自动换币
adl:ADL自动减仓
full_liquidation:强制平仓
partial_liquidation:强制减仓
delivery:交割
ddh:对冲减仓类型订单
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":"0",
            "fillPx":"0",
            "tradeId":"0",
            "fillSz":"0",
            "fillTime":"0",
            "source": "",
            "state":"filled",
            "avgPx":"0",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"last",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"last",
            "slOrdPx":"",
            "feeCcy":"",
            "fee":"",
            "rebateCcy":"",
            "rebate":"",
            "tgtCcy":"",
            "pnl":"",
            "category":"",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
ccy String 保证金币种,仅适用于单币种保证金模式下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
ordType String 订单类型
market:市价单
limit:限价单
post_only:只做maker单
fok:全部成交或立即取消
ioc:立即成交并取消剩余
optimal_limit_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 止盈触发价
tpTriggerPxType String 止盈触发价类型
last:最新价格
index:指数价格
mark:标记价格
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slTriggerPxType String 止损触发价类型
last:最新价格
index:指数价格
mark:标记价格
slOrdPx String 止损委托价
feeCcy String 交易手续费币种
fee String 订单交易手续费,平台向用户收取的交易手续费,手续费扣除为负数。如: -0.01
rebateCcy String 返佣金币种
rebate String 返佣金额,平台向达到指定lv交易等级的用户支付的挂单奖励(返佣),如果没有返佣金,该字段为“”。手续费返佣为正数,如:0.01
pnl String 收益
source String 订单来源
13:策略委托单触发后的生成的限价单
category String 订单种类
normal:普通委托
twap:TWAP自动换币
adl:ADL自动减仓
full_liquidation:强制平仓
partial_liquidation:强制减仓
delivery:交割
ddh:对冲减仓类型订单
uTime String 订单状态更新时间,Unix时间戳的毫秒数格式,如 1597026383085
cTime String 订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085

获取成交明细(近三天)

获取近3天的订单成交明细信息

限速: 60 次/2s

限速规则:UserID

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
begin String 筛选的开始时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
end String 筛选的结束时间戳,Unix 时间戳为毫秒数格式,如 1597027383085
limit String 返回结果的数量,默认 100 条

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "instType": "FUTURES",
      "instId": "BTC-USD-200329",
      "tradeId": "123",
      "ordId": "312269865356374016",
      "clOrdId": "b16",
      "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": "312269865356374016",
      "clOrdId": "b16",
      "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
clOrdId 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

获取成交明细(近三个月)

获取近3个月订单成交明细信息

限速: 10 次/2s

限速规则:UserID

HTTP 请求

GET /api/v5/trade/fills-history

请求示例

GET /api/v5/trade/fills-history

请求参数

参数名 类型 是否必须 描述
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
begin String 筛选的开始时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
end String 筛选的结束时间戳,Unix 时间戳为毫秒数格式,如 1597027383085
limit String 返回结果的数量,默认 100 条

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "instType": "FUTURES",
      "instId": "BTC-USD-200329",
      "tradeId": "123",
      "ordId": "312269865356374016",
      "clOrdId": "b16",
      "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": "312269865356374016",
      "clOrdId": "b16",
      "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
clOrdId 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

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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 持仓方向 在双向持仓模式下必填,且仅可选择 longshort
ordType String 订单类型
conditional:单向止盈止损
oco:双向止盈止损
trigger:计划委托
move_order_stop:移动止盈止损
iceberg:冰山委托
twap:时间加权委托
sz String 委托数量
tag String 订单标签
字母(区分大小写)与数字的组合,可以是纯字母、纯数字,且长度在1-16位之间。
tgtCcy String 委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
仅适用于币币单向止盈止损买单
默认买为计价货币,卖为交易货币
reduceOnly Boolean 是否只减仓 truefalse

止盈止损

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

计划委托

参数名 类型 是否必须 描述
triggerPx String 计划委托触发价格
triggerPxType String 计划委托触发价格类型
last:最新价格
index:指数价格
mark:标记价格
默认为last
orderPx String 委托价格
委托价格为-1时,执行市价委托

移动止盈止损

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

冰山委托

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

时间加权

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

了解更多关于冰山委托和时间加权委托

返回结果

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

返回参数

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

撤销策略委托订单

撤销策略委托订单(不包含冰山委托、时间加权、移动止盈止损等高级策略订单),每次最多可以撤销10个策略委托单

限速: 20次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

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

撤销高级策略委托订单

撤销冰山委托、时间加权、移动止盈止损委托订单,每次最多可以撤销10个策略委托单

限速: 20次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

HTTP请求

POST /api/v5/trade/cancel-advance-algos

请求示例

POST /api/v5/trade/cancel-advance-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

限速规则:UserID

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:计划委托
move_order_stop:移动止盈止损
iceberg:冰山委托
twap:时间加权委托
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",
            "tgtCcy": "",
            "state":"1",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"",
            "triggerPx":"99",
            "triggerPxType": "last",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "pxVar":"",
            "pxSpread":"",
            "pxLimit":"",
            "szLimit":"",
            "tag": "adadadadad",
            "timeInterval":"",
            "triggerTime":"1597026383085",
            "callbackRatio":"",
            "callbackSpread":"",
            "activePx":"",
            "moveTriggerPx":"",
            "cTime":"1597026383000"
        },
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "algoId":"1234",
            "sz":"999",
            "ordType":"oco",
            "side":"buy",
            "posSide":"long",
            "tdMode":"cross",
            "tgtCcy": "",
            "state":"1",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"",
            "triggerPx":"99",
            "triggerPxType": "last",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "pxVar":"",
            "pxSpread":"",
            "pxLimit":"",
            "szLimit":"",
            "tag": "adadadadad",
            "timeInterval":"",
            "triggerTime":"1597026383085",
            "callbackRatio":"",
            "callbackSpread":"",
            "activePx":"",
            "moveTriggerPx":"",
            "cTime":"1597026383000"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种,仅适用于单币种保证金模式下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
sz String 委托数量
ordType String 订单类型
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
state String 订单状态 ,live:待生效 pause:暂停生效 partially_effective:部分生效
lever String 杠杆倍数
tpTriggerPx String 止盈触发价
tpTriggerPxType String 止盈触发价类型
last:最新价格
index:指数价格
mark:标记价格
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slTriggerPxType String 止损触发价类型
last:最新价格
index:指数价格
mark:标记价格
slOrdPx String 止损委托价
triggerPx String 计划委托触发价格
triggerPxType String 计划委托触发价类型
last:最新价格
index:指数价格
mark:标记价格
ordPx String 计划委托委托价格
actualSz String 实际委托量
actualPx String 实际委托价
actualSide String 实际触发方向, tp:止盈 sl: 止损
triggerTime String 策略委托触发时间,Unix时间戳的毫秒数格式,如 1597026383085
pxVar String 价格比例
仅适用于冰山委托时间加权委托
pxSpread String 价距
仅适用于冰山委托时间加权委托
szLimit String 单笔数量
仅适用于冰山委托时间加权委托
tag String 订单标签
字母(区分大小写)与数字的组合,可以是纯字母、纯数字,且长度在1-16位之间。
pxLimit String 挂单限制价
仅适用于冰山委托时间加权委托
timeInterval String 下单间隔
仅适用于时间加权委托
callbackRatio String 回调幅度的比例
仅适用于移动止盈止损
callbackSpread String 回调幅度的价距
仅适用于移动止盈止损
activePx String 移动止盈止损激活价格
仅适用于移动止盈止损
moveTriggerPx String 移动止盈止损触发价格
仅适用于移动止盈止损
cTime String 订单创建时间, Unix时间戳的毫秒数格式,如 1597026383085

获取历史策略委托单列表

获取最近3个月当前账户下所有策略委托单列表

限速: 20次/2s

限速规则:UserID

HTTP请求

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

请求示例

GET /api/v5/trade/orders-algo-history?state=effective&ordType=conditional

请求参数

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

effective:已生效
canceled:已经撤销
order_failed:委托失败
【state和algoId必填且只能填其一】
algoId String 可选 策略委托单ID 【statealgoId必填且只能填其一】
instType String 产品类型
SPOT:币币
SWAP:永续合约
FUTURES:交割合约
MARGIN:杠杆
instId String 产品ID,BTC-USD-190927
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",
            "tgtCcy": "",
            "state":"effective",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"",
            "triggerPx":"99",
            "triggerPxType":"last",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "pxVar":"",
            "pxSpread":"",
            "pxLimit":"",
            "szLimit":"",
            "tag": "adadadadad",
            "timeInterval":"",
            "callbackRatio":"",
            "callbackSpread":"",
            "activePx":"",
            "moveTriggerPx":"",
            "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",
            "tgtCcy": "",
            "state":"effective",
            "lever":"20",
            "tpTriggerPx":"",
            "tpTriggerPxType":"",
            "tpOrdPx":"",
            "slTriggerPx":"",
            "slTriggerPxType":"",
            "triggerPx":"99",
            "triggerPxType":"last",
            "ordPx":"12",
            "actualSz":"",
            "actualPx":"",
            "actualSide":"",
            "pxVar":"",
            "pxSpread":"",
            "pxLimit":"",
            "szLimit":"",
            "tag": "adadadadad",
            "timeInterval":"",
            "callbackRatio":"",
            "callbackSpread":"",
            "activePx":"",
            "moveTriggerPx":"",
            "triggerTime":"1597026383085",
            "cTime":"1597026383000"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种,仅适用于单币种保证金模式下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
sz String 委托数量
ordType String 订单类型
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
tgtCcy String 市价单委托数量的类型
base_ccy: 交易货币 ;quote_ccy:计价货币
state String 订单状态
effective: 已生效
canceled:已撤销
order_failed:委托失败
lever String 杠杆倍数
tpTriggerPx String 止盈触发价
tpTriggerPxType String 止盈触发价类型
last:最新价格
index:指数价格
mark:标记价格
tpOrdPx String 止盈委托价
slTriggerPx String 止损触发价
slTriggerPxType String 止损触发价类型
last:最新价格
index:指数价格
mark:标记价格
slOrdPx String 止损委托价
triggerPx String 计划委托触发价格
triggerPxType String 计划委托触发价格
ordPx String 计划委托委托价格类型
last:最新价格
index:指数价格
mark:标记价格
actualSz String 实际委托量
actualPx String 实际委托价
actualSide String 实际触发方向 tp:止盈 sl: 止损
triggerTime String 策略委托触发时间,Unix时间戳的毫秒数格式,如 1597026383085
pxVar String 价格比例
仅适用于冰山委托时间加权委托
pxSpread String 价距
仅适用于冰山委托时间加权委托
szLimit String 单笔数量
仅适用于冰山委托时间加权委托
pxLimit String 挂单限制价
仅适用于冰山委托时间加权委托
tag String 订单标签
字母(区分大小写)与数字的组合,可以是纯字母、纯数字,且长度在1-16位之间。
timeInterval String 下单间隔
仅适用于时间加权委托
callbackRatio String 回调幅度的比例
仅适用于移动止盈止损
callbackSpread String 回调幅度的价距
仅适用于移动止盈止损
activePx String 移动止盈止损激活价格
仅适用于移动止盈止损
moveTriggerPx String 移动止盈止损触发价格
仅适用于移动止盈止损
cTime String 订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085

大宗交易

获取报价方信息

查询可以参与交易的报价方信息。

限速: 5次/2s

限速规则:UserID

HTTP Requests

GET /api/v5/rfq/counterparties

请求示例

GET /api/v5/rfq/counterparties

请求参数

响应示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "traderName" : "Satoshi Nakamoto",
            "traderCode" : "SATOSHI",
            "type" : "" //Currently not live
        }
    ]
}

响应参数

参数名 类型 描述
traderName String 报价方名称
traderCode String 报价方唯一标识代码,公开可见;报价和询价的相关接口都使用该代码代表报价方。
type String 报价方类型(当前未生效,将返回 "" )

询价

创建一个询价单。

限速: 5次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/create-rfq

请求示例

POST /api/v5/rfq/create-rfq

{
    "anonymous": true,
    "counterparties":[
        "Trader1",
        "Trader2"
    ],
    "clRfqId":"rfq01",
    "legs":[
        {
            "sz":"25",
            "side":"buy",
            "instId":"BTCUSD-221208-100000-C"
        },
        {
            "sz":"150",
            "side":"buy",
            "instId":"ETH-USDT",
            "tgtCcy":"base_ccy"
        }
    ]
}

请求参数

参数名 类型 是否必须 描述
counterparties Array of strings 报价方列表。
anonymous Boolean 是否匿名询价,true表示匿名询价,false表示公开询价,默认值为 false,为true时,即使在交易执行之后,身份也不会透露给报价方。
clRfqId String 询价单自定义ID,字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
legs Array of objects 组合交易,每次最多可以提交15组交易信息
> instId String 产品ID
> sz String 委托数量
> side String 询价单方向
> tgtCcy String 委托数量的类型
base_ccy: 交易货币 quote_ccy: 计价货币
默认为base_ccy,仅适用于币币

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "cTime":"1611033737572",
            "uTime":"1611033737572",
            "traderCode":"SATOSHI",
            "rfqId":"22534",
            "clRfqId":"rfq01",
            "state":"active",
            "validUntil":"1611033857557",
            "counterparties":[
                "Trader1",
                "Trader2"
            ],
            "legs":[
                {
                    "instId":"BTCUSD-221208-100000-C",
                    "sz":"25",
                    "side":"buy",
                    "tgtCcy":""
                },
                {
                    "instId":"ETH-USDT",
                    "sz":"150",
                    "side":"buy",
                    "tgtCcy":"base_ccy"     
                }
            ]
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 询价单结果
> cTime String 询价单创建时间,Unix时间戳的毫秒数格式。
> uTime String 询价单状态更新时间,Unix时间戳的毫秒数格式。
> state String 询价单的状态
active canceled pending_fill filled expired traded_away failed traded_away
traded_away 仅适用于报价方
> counterparties Array of strings 报价方列表
> validUntil String 询价单的过期时间,Unix时间戳的毫秒数格式。
> clRfqId String 询价单自定义ID,为客户端敏感信息,不会公开,对报价方返回""。
> traderCode String 询价方唯一标识代码。
> rfqId String 询价单ID
> legs Array of objects 组合交易
>> instId String 产品ID
>> sz String 委托数量
>> side String 询价单方向
>> tgtCcy String 委托数量的类型

取消询价单

取消一个询价单。

限速: 5次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/cancel-rfq

请求示例

POST /api/v5/rfq/cancel-rfq
{
    "rfqId":"22535",
    "clRfqId":"rfq001"
}

请求参数

参数名 类型 是否必须 描述
rfqId String 可选 询价单ID
clRfqId String 可选 询价单自定义ID,字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间,当 clRfqId 和 rfqId 都传时,以 rfqId 为准。

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "rfqId":"22535",
            "clRfqId":"rfq001",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> rfqId String RFQ ID
> clRfqId String 由用户设置的 RFQ ID
> sCode String 事件执行结果的code,0代表成功
> sMsg String 事件执行失败时的msg

批量取消询价单

取消一个或多个询价单,每次最多可以撤销100个询价单。

限速: 2次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/cancel-batch-rfqs

请求示例

POST /api/v5/rfq/cancel-batch-rfqs
{
    "rfqIds":[
        "2201",
        "2202",
        "2203"
    ],
    "clRfqIds":[
        "r1",
        "r2",
        "r3"
    ]
}

请求参数

参数名 类型 是否必须 描述
rfqIds Array of string 可选 询价单IDs
clRfqIds Array of string 可选 询价单自定义ID,当 clRfqIds 和 rfqIds 都传时,以 rfqIds 为准。

全部成功示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "rfqId":"2201",
            "clRfqId":"r1",
            "sCode":"0",
            "sMsg":""
        },
        {
            "rfqId":"2202",
            "clRfqId":"r2",
            "sCode":"0",
            "sMsg":""
        },
        {
            "rfqId":"2203",
            "clRfqId":"r3",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

部分成功示例

{
    "code":"2",
    "msg":"Bulk operation partially ",
    "data":[
        {
            "rfqId":"2201",
            "clRfqId":"r1",
            "sCode":"70000",
            "sMsg":"RFQ does not exist."
        },
        {
            "rfqId":"2202",
            "clRfqId":"r2",
            "sCode":"0",
            "sMsg":""
        },
        {
            "rfqId":"2203",
            "clRfqId":"r3",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

失败示例

{
    "code":"1",
    "msg":"Operation failed.",
    "data":[
        {
            "rfqId":"2201",
            "clRfqId":"r1",
            "sCode":"70000",
            "sMsg":"RFQ does not exist."
        },
        {
            "rfqId":"2202",
            "clRfqId":"r2",
            "sCode":"70000",
            "sMsg":"RFQ does not exist."
        },
        {
            "rfqId":"2203",
            "clRfqId":"r3",
            "sCode":"70000",
            "sMsg":"RFQ does not exist."
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID.
> sCode String 事件执行结果的code,0代表成功
> sMsg String 事件执行失败时的msg

取消所有询价单

取消所有询价单

限速: 2次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/cancel-all-rfqs

请求示例

POST /api/v5/rfq/cancel-all-rfqs

请求参数

返回示例

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

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> ts String 成功取消时间,Unix时间戳的毫秒数格式,例如 1597026383085。

执行报价

执行报价,仅限询价的创建者使用

限速: 2次/3s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/execute-quote

请求示例

POST /api/v5/rfq/execute-quote
{
    "rfqId":"22540",
    "quoteId":"84073"
}

请求参数

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

响应示例

{  
   "code":"0",
   "msg":"",
   "data":[
       {
            "blockTdId":"180184",
            "rfqId":"1419",
            "clRfqId":"r0001",
            "quoteId":"1046",
            "clQuoteId":"q0001",
            "tTraderCode":"Trader1",
            "mTraderCode":"Trader2",
            "cTime":"1649670009",
            "legs":[
                {
                    "px":"43000",
                    "sz":"25",
                    "instId":"BTC-USD-20220114-13250-C",
                    "side":"sell",
                    "fee":"-1.001",
                    "feeCcy":"BTC",
                    "tradeId":"10211"
                },
                {
                    "px":"42800",
                    "sz":"25",
                    "instId":"BTC-USDT",
                    "side":"buy",
                    "fee":"-1.001",
                    "feeCcy":"BTC",
                    "tradeId":"10212"
                }
            ]
        }
   ]
}

响应参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> cTime String 执行创建的时间,Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID,为客户敏感信息,不会公开,对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID,为客户敏感信息,不会公开,对询价方返回""。
> blockTdId String 大宗交易ID
> tTraderCode String 询价价方唯一标识代码。询价时 Anonymous 设置为 True 时不可见。
> mTraderCode String 报价方唯一标识代码。 报价时 Anonymous 设置为 True 时不可见。
> legs Array of objects 组合交易
>> instId String 产品ID
>> px String 成交价格
>> sz String 成交数量
>> side String 询价单方向,buy 或者 sell
>> fee String 手续费,正数代表平台返佣 ,负数代表平台扣除
>> feeCcy String 手续费币种
>> tradeId String 最新的成交Id.

报价

允许询价单指定的报价方进行报价,需要对整个询价单报价,不允许部分报价或部分成交。

限速: 50次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/create-quote

请求示例

POST /api/v5/rfq/create-quote
{
    "rfqId":"22539",
    "clQuoteId":"q001",
    "anonymous": true,
    "quoteSide":"buy",
    "expiresIn":"30",
    "legs":[
        {
            "px":"39450.0",
            "sz":"200000",
            "instId":"BTC-USDT-SWAP",
            "side":"buy"
        }
    ]
}

请求参数

参数名 类型 是否必须 描述
rfqId String 询价单ID
clQuoteId String 报价单自定义ID
anonymous Boolean 是否匿名报价,true表示匿名报价,false表示公开报价,默认值为 false,为true时,即使在交易执行之后,身份也不会透露给询价方。
quoteSide String 询价单方向, buy 或者 sell
expiresIn String 报价单的有效时长(以秒为单位)。 10到120之间的任何整数。 默认值为60
legs Array of objects 组合交易
> instId String 产品ID
> sz String 委托数量
> px String 委托价格
> side String 报价单方向
> tgtCcy String 委托数量的类型
base_ccy: 交易货币 quote_ccy: 计价货币
默认为base_ccy,仅适用于币币

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "cTime":"1611038342698",
            "uTime":"1611038342698",
            "quoteId":"84069", 
            "clQuoteId":"q002",
            "rfqId":"22537",
            "quoteSide":"buy",
            "state":"active",
            "validUntil":"1611038442838",
            "legs":[
                {
                    "px":"39450.0",
                    "sz":"200000",
                    "instId":"BTC-USDT-SWAP",
                    "side":"buy",
                    "tgtCcy":""
                }            
            ]
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0表示成功。
msg String 错误信息,如果代码不为0,则不为空。
data Array of objects 包含结果的对象数组
> cTime String 报价单创建时间,Unix时间戳的毫秒数格式。
> uTime String 报价单状态更新时间,Unix时间戳的毫秒数格式。
> state String 报价单的状态
active canceled pending_fill filled expired failed
> validUntil String 报价单的过期时间,Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID,为客户敏感信息,不会公开,对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID,为客户敏感信息,不会公开,对询价方返回""。
> traderCode String 报价方唯一标识代码。
> quoteSide String 报价单方向,buy 或者 sell
> legs Array of objects 组合交易
>> instId String 产品ID
>> sz String 委托数量
>> px String 委托价格
>> side String 报价单方向
>> tgtCcy String 委托数量的类型

取消报价单

取消一个报价单。

限速: 50次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/cancel-quote

请求示例

POST /api/v5/rfq/cancel-quote
{
    "quoteId": "007",
    "clQuoteId":"Bond007"
}

请求参数

参数名 类型 是否必须 描述
quoteId String 可选 报价单ID
clQuoteId String 可选 询价单自定义ID,字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间,当 clRfqId 和 rfqId 都传时,以 rfqId 为准。

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "quoteId":"007",
            "clQuoteId":"Bond007",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> quoteId String 报价单ID
> clQuoteId String 询价单自定义ID
> sCode String 事件执行结果的code,0代表成功
> sMsg String 事件执行失败时的msg

批量取消报价单

取消一个或多个报价单,每次最多可以撤销100个订单。

限速: 2次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/cancel-batch-quotes

请求示例

POST /api/v5/rfq/cancel-batch-quotes
{
    "quoteIds":["1150","1151","1152"],
    "clQuoteIds":["q1","q2","q3"]
}

请求参数

参数名 类型 是否必须 描述
quoteIds Array of string 可选 报价单ID
clQuoteIds Array of string 可选 报价单自定义ID,当 clQuoteIds 和 quoteIds 都传时,以 quoteIds 为准。

全部成功的示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "quoteId":"1150",
            "clQuoteId":"q1",
            "sCode":"0",
            "sMsg":""
        },
        {
            "quoteId":"1151",
            "clQuoteId":"q2",
            "sCode":"0",
            "sMsg":""
        },
        {
            "quoteId":"1152",
            "clQuoteId":"q3",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

部分成功的示例

{
    "code":"2",
    "msg":"Bulk operation partially ",
    "data":[
        {
            "quoteId":"1150",
            "clQuoteId":"q1",
            "sCode":"0",
            "sMsg":""
        },
        {
            "quoteId":"1151",
            "clQuoteId":"q2",
            "sCode":"70001",
            "sMsg":"Quote does not exist."
        },
        {
            "quoteId":"1152",
            "clQuoteId":"q3",
            "sCode":"70001",
            "sMsg":"Quote does not exist."
        }
    ]
}

失败示例

{
    "code":"1",
    "msg":"Operation failed.",
    "data":[
        {
            "quoteId":"1150",
            "clQuoteId":"q1",
            "sCode":"70001",
            "sMsg":"Quote does not exist."
        },
        {
            "quoteId":"1151",
            "clQuoteId":"q2",
            "sCode":"70001",
            "sMsg":"Quote does not exist."
        },
        {
            "quoteId":"1151",
            "clQuoteId":"q3",
            "sCode":"70001",
            "sMsg":"Quote does not exist."
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID
> sCode String 事件执行结果的code,0代表成功
> sMsg String 事件执行失败时的msg

取消所有报价单

取消所有报价单

限速: 2次/2s

限速规则:UserID

HTTP Requests

POST /api/v5/rfq/cancel-all-quotes

请求示例

POST /api/v5/rfq/cancel-all-quotes

请求参数

响应示例

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

响应参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> ts String 成功取消时间,Unix时间戳的毫秒数格式,例如 1597026383085。

获取询价单信息

获取询价单信息

限速: 2次/2s

限速规则:UserID

HTTP Requests

GET /api/v5/rfq/rfqs

请求示例

POST /api/v5/rfq/rfqs

请求参数

参数名 类型 是否必须 描述
rfqId String 询价单ID .
clRfqId String 客户询价单自定义ID,当 clRfqId 和 rfqId 都传时,以 rfqId 为准
state String 询价单的状态
active canceled pending_fill filled expired traded_away failed traded_away
traded_away 仅适用于报价方
beginId String 请求的起始询价单ID,请求此ID之后(更新的数据)的分页内容,不包括 beginId
endId String 请求的结束询价单ID,请求此ID之前(更旧的数据)的分页内容,不包括 endId
limit String 返回结果的数量,默认100条

返回示例

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "rfqId": "123456",
            "clRfqId": "",
            "traderCode": "VITALIK",
            "validUntil": "1650969031817",
            "state": "filled",
            "counterparties": [
                "SATOSHI"
            ],
            "legs": [
                {
                    "instId": "BTC-USDT",
                    "side": "buy",
                    "sz": "25",
                    "tgtCcy": "base_ccy"
                }
            ],
            "cTime": "1650968131817",
            "uTime": "1650968164944"
        },
        {
            "rfqId": "1234567",
            "clRfqId": "",
            "traderCode": "VITALIK",
            "validUntil": "1650967623729",
            "state": "filled",
            "counterparties": [
                "SATOSHI"
            ],
            "legs": [
                {
                    "instId": "BTC-USDT",
                    "side": "buy",
                    "sz": "1500000",
                    "tgtCcy": "quote_ccy"
                }
            ],
            "cTime": "1650966723729",
            "uTime": "1650966816577"
        }
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> cTime String 询价单创建时间,Unix时间戳的毫秒数格式。
> uTime String 询价单状态更新时间,Unix时间戳的毫秒数格式。
> state String 询价单的状态
active canceled pending_fill filled expired traded_away failed traded_away
traded_away 仅适用于报价方
> counterparties Array of srings 报价方列表
> validUntil String 询价单的过期时间,Unix时间戳的毫秒数格式。
> clRfqId String 询价单自定义ID,为客户敏感信息,不会公开,对报价方返回""。
> traderCode String 询价方唯一标识代码,询价时 Anonymous 设置为 True 时不可见
> rfqId String 询价单ID
> legs Array of objects 组合交易
>> instId String 产品ID
>> sz String 委托数量
>> side String 询价单方向
>> tgtCcy String 委托数量的类型

获取报价单信息

获取报价单信息

限速: 2次/2s

限速规则:UserID

HTTP Requests

GET /api/v5/rfq/quotes

请求示例

POST /api/v5/rfq/quotes

请求参数

参数名 类型 是否必须 描述
rfqId String 询价单ID
clRfqId String 询价单自定义ID, 当 clRfqId 和 rfqId 都传时,以 rfqId 为准。
quoteId String 报价单ID
clQuoteId String 报价单自定义ID,当 clRfqId 和 rfqId 都传时,以 rfqId 为准。
state String 报价单的状态
active canceled pending_fill filled expired failed
beginId String 请求的起始报价单ID,请求此ID之后(更新的数据)的分页内容,不包括 beginId
endId String 请求的结束报价单ID,请求此ID之前(更旧的数据)的分页内容,不包括 endId
limit String 返回结果的数量,默认100条

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "validUntil":"1608997227834",
            "uTime":"1608267227834",
            "cTime":"1608267227834",
            "legs":[
                {
                    "px":"46000",
                    "sz":"25",
                    "instId":"BTC-USD-220114-25000-C",
                    "side":"sell",
                    "tgtCcy":""
                },
                {
                    "px":"45000",
                    "sz":"25",
                    "instId":"BTC-USDT",
                    "side":"buy",
                    "tgtCcy":"base_ccy"
                }
            ],
            "quoteId":"25092",
            "rfqId":"18753",
            "quoteSide":"sell",
            "state":"canceled",
            "clQuoteId":"cq001",
            "clRfqId":"cr001",
            "traderCode":"Trader1"
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的数组
> cTime String 报价单创建时间,Unix时间戳的毫秒数格式
> uTime String 报价单状态更新时间,Unix时间戳的毫秒数格式。
> state String 报价单的状态
active canceled pending_fill filled expired failed
> validUntil String 报价单的过期时间,Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID,为客户敏感信息,不会公开,对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID,为客户敏感信息,不会公开,对询价方返回""。
> traderCode String 报价方唯一标识代码,报价时 Anonymous 设置为 True 时不可见。
> quoteSide String 询价单方向, buy 或者 sell
> legs Array of objects 组合交易
>> instId String 产品ID
>> sz String 委托数量
>> px String 委托价格.
>> side String 报价单方向
>> tgtCcy String 委托数量的类型

获取大宗交易信息

获取询价单或报价单信息

限速: 5次/2s

限速规则:UserID

HTTP Requests

GET /api/v5/rfq/trades

请求示例

POST /api/v5/rfq/trades

请求参数

参数名 类型 是否必须 描述
rfqId String 询价单ID
clRfqId String 由用户设置的询价单ID. 如果 clRfqIdrfqId 都通过了,rfqId 将被视为主要
quoteId String 报价单ID
blockTdId String 大宗交易ID
clQuoteId String 由用户设置的报价单ID。如果同时传递了 clQuoteIdquoteId,则 quoteId 将被视为主要标识符
state String 询价单的状态
active canceled pending_fill filled expired traded_away failed traded_away
traded_away 仅适用于报价方
beginId String 请求的起始大宗交易ID,请求此ID之后(更新的数据)的分页内容,不包括 beginId
endId String 请求的结束大宗交易ID,请求此ID之前(更旧的数据)的分页内容,不包括 endId
limit String 返回结果的数量,默认100条。

返回示例

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "rfqId": "123456",
            "clRfqId": "",
            "quoteId": "0T5342O",
            "clQuoteId": "",
            "blockTdId": "439127542058958848",
            "legs": [
                {
                    "instId": "BTC-USDT",
                    "side": "sell",
                    "sz": "0.666",
                    "px": "100",
                    "tradeId": "439127542058958850",
                    "fee": "-0.0333",
                    "feeCcy": "USDT"
                }
            ],
            "cTime": "1650968164900",
            "tTraderCode": "SATS",
            "mTraderCode": "MIKE"
        },
        {
            "rfqId": "1234567",
            "clRfqId": "",
            "quoteId": "0T533T0",
            "clQuoteId": "",
            "blockTdId": "439121886014849024",
            "legs": [
                {
                    "instId": "BTC-USDT",
                    "side": "sell",
                    "sz": "0.532",
                    "px": "100",
                    "tradeId": "439121886014849026",
                    "fee": "-0.0266",
                    "feeCcy": "USDT"
                }
            ],
            "cTime": "1650966816550",
            "tTraderCode": "SATS",
            "mTraderCode": "MIKE"
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组
> cTime String 执行创建的时间,Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID,为客户敏感信息,不会公开,对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID,为客户敏感信息,不会公开,对询价方返回""。
> blockTdId String 大宗交易ID
> tTraderCode String 询价方唯一标识代码,询价时 Anonymous 设置为 True 时不可见
> mTraderCode String 报价方唯一标识代码。报价时 Anonymous 设置为 True 时不可见
> legs Array of objects 组合交易
>> instId String 产品ID
>> px String 成交价格
>> sz String 成交数量
>> side String 询价单方向,buy 或者 sell。
>> fee String 手续费,正数代表平台返佣 ,负数代表平台扣除
>> feeCcy String 手续费币种
>> tradeId String 最新的成交Id

获取大宗交易公共成交数据

获取最近执行的大宗交易。

限速: 5次/2s

限速规则:IP

HTTP Requests

GET /api/v5/rfq/public-trades

请求示例

POST /api/v5/rfq/public-trades

请求参数

参数名 类型 是否必须 描述
beginId String 请求的起始大宗交易ID,请求此ID之后(更新的数据)的分页内容,不包括 beginId
endId String 请求的结束大宗交易ID,请求此ID之前(更旧的数据)的分页内容,不包括 endId
limit String 返回结果的数量,默认100条。

返回示例

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "blockTdId": "439161457415012352",
            "legs": [
                {
                    "instId": "BTC-USD-210826",
                    "side": "sell",
                    "sz": "100",
                    "px": "11000",
                    "tradeId": "439161457415012354"
                },
                {
                    "instId": "BTC-USD-SWAP",
                    "side": "sell",
                    "sz": "100",
                    "px": "50",
                    "tradeId": "439161457415012355"
                },
                {
                    "instId": "BTC-USDT",
                    "side": "buy",
                    "sz": "0.1", //for public feed, spot "sz" is in baseccy
                    "px": "10.1",
                    "tradeId": "439161457415012356"
                },
                {
                    "instId": "BTC-USD-210326-60000-C",
                    "side": "buy",
                    "sz": "200",
                    "px": "0.008",
                    "tradeId": "439161457415012357"
                },
                {
                    "instId": "BTC-USD-220930-5000-P",
                    "side": "sell",
                    "sz": "200",
                    "px": "0.008",
                    "tradeId": "439161457415012360"
                },
                {
                    "instId": "BTC-USD-220930-10000-C",
                    "side": "sell",
                    "sz": "200",
                    "px": "0.008",
                    "tradeId": "439161457415012361"
                },
                {
                    "instId": "BTC-USD-220930-10000-P",
                    "side": "sell",
                    "sz": "200",
                    "px": "0.008",
                    "tradeId": "439161457415012362"
                },
                {
                    "instId": "ETH-USD-220624-100100-C",
                    "side": "sell",
                    "sz": "100",
                    "px": "0.008",
                    "tradeId": "439161457415012363"
                }
            ],
            "cTime": "1650976251241"
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码,0 表示成功。
msg String 错误信息,如果代码不为 0,则不为空。
data Array of objects 包含结果的对象数组.
> cTime String 执行创建的时间,Unix时间戳的毫秒数格式。
> blockTdId String 大宗交易ID.
> legs Array of objects 组合交易
>> instId String 产品ID
>> px String 成交价格
>> sz String 成交数量
>> side String 询价单方向
>> tradeId String 最新成交ID

资金

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

获取币种列表

获取平台所有币种列表。

限速: 6 次/s

限速规则:UserID

HTTP 请求

GET /api/v5/asset/currencies

请求示例

GET /api/v5/asset/currencies

请求参数

参数 类型 是否必须 描述
ccy String 币种,如 BTC
支持多币种查询(不超过20个),币种之间半角逗号分隔

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "canDep": true,
      "canInternal": false,
      "canWd": true,
      "ccy": "USDT",
      "chain": "USDT-TRC20",
      "logoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5F74EB20302D7761.png",
      "mainNet": false,
      "maxFee": "1.6",
      "maxWd": "9608350",
      "minDep": "0.00000001",
      "minDepArrivalConfirm": "1",
      "minFee": "0.8",
      "minWd": "2",
      "minWdUnlockConfirm": "1",
      "name": "Tether",
      "needTag": false,
      "usedWdQuota": "0",
      "wdQuota": "500",
      "wdTickSz": "3"
    }
  ]
}

返回参数

参数名 类型 描述
ccy String 币种名称,如 BTC
name String 币种中文名称,不显示则无对应名称
logoLink String 币种Logo链接
chain String 币种链信息
有的币种下有多个链,必须要做区分,如USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
canDep Boolean 是否可充值,false表示不可链上充值,true表示可以链上充值
canWd Boolean 是否可提币,false表示不可链上提币,true表示可以链上提币
canInternal Boolean 是否可内部转账,false表示不可内部转账,true表示可以内部转账
minDep String 币种单笔最小充值量
minWd String 币种单笔最小提币量
maxWd String 币种单笔最大提币量
wdTickSz String 提币精度,表示小数点后的位数
wdQuota String 过去24小时内提币额度,单位为BTC
usedWdQuota String 过去24小时内已用提币额度,单位为BTC
minFee String 最小提币手续费数量
maxFee String 最大提币手续费数量
mainNet Boolean 当前链是否为主链
如果是则返回true,否则返回false
needTag Boolean 当前链是否需要标签(tag/memo)信息
minDepArrivalConfirm String 充值到账最小网络确认数
minWdUnlockConfirm String 提现解锁最小网络确认数

获取资金账户余额

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

限速: 6次/s

限速规则:UserID

HTTP请求

GET /api/v5/asset/balances

请求示例

GET /api/v5/asset/balances

请求参数

参数 类型 是否必须 描述
ccy String 币种,如 BTC
支持多币种查询(不超过20个),币种之间半角逗号分隔

返回结果

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

返回参数

参数名 类型 描述
ccy String 币种,如 BTC
bal String 余额
frozenBal String 冻结(不可用)
availBal String 可用余额

获取账户资产估值

查看账户资产估值

限速: 1次/2s

限速规则:UserID

HTTP请求

GET /api/v5/asset/asset-valuation

请求示例

GET /api/v5/asset/asset-valuation

请求参数

参数 类型 是否必须 描述
ccy String 资产估值对应的单位
BTC 、USDT
USD 、CNY 、JPY、KRW、RUB、EUR
VND 、IDR 、INR、PHP、THB、TRY
AUD 、SGD 、ARS、SAR、AED、IQD
默认为 BTC 为单位的估值

返回结果

{
    "code": "0",
    "data": [
        {
            "details": {
                "classic": "124.6",
                "earn": "1122.73",
                "funding": "0.09",
                "trading": "2544.28"
            },
            "totalBal": "3790.09",
            "ts": "1637566660769"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
totalBal String 账户总资产估值
ts String 数据更新时间,Unix时间戳的毫秒数格式,如 1597026383085
details Array 各个账户的资产估值
> funding String 资金账户
> trading String 交易账户
> classic String 经典账户
> earn String 金融账户

资金划转

支持母账户的资金账户划转到交易账户,母账户到子账户的资金账户和交易账户划转;

子账户默认可转出至母账户,划转到同一母账户下的其他子账户,需要先调用“设置子账户转出权限”接口进行授权。

限速: 1 次/s

限速规则:UserID + Currency

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"
}

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

请求参数

参数名 类型 是否必须 描述
ccy String 币种,如 USDT
amt String 划转数量
from String 转出账户
6:资金账户 18:交易账户
to String 转入账户
6:资金账户 18:交易账户
subAcct String 可选 子账户名称,type 为12:subAcct 为必填项
type String 划转类型
0:账户内划转
1:母账户转子账户(仅适用于母账户APIKey)
2:子账户转母账户(仅适用于母账户APIKey)
3:子账户转母账户(仅适用于子账户APIKey)
4:子账户转子账户(仅适用于子账户APIKey,且目标账户需要是同一母账户下的其他子账户)
默认是0
loanTrans Boolean 是否支持跨币种保证金模式组合保证金模式下的借币转入/转出
true 或 false,默认false
clientId String 客户自定义ID
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。

返回结果

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

返回参数

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

获取资金划转状态

限速: 10 次/s

限速规则:UserID

HTTP 请求

GET /api/v5/asset/transfer-state

请求示例

GET /api/v5/asset/transfer-state?transId=1&type=1

请求参数

参数名 类型 是否必须 描述
transId String 可选 划转ID
transId和clientId必须传一个,若传两个,以transId为主
clientId String 可选 客户自定义ID
type String 划转类型
0:账户内划转
1:母账户转子账户(仅适用于母账户APIKey)
2:子账户转母账户(仅适用于母账户APIKey)
默认是0

返回结果

{
    "code": "0",
    "data": [
        {
            "amt": "1.5",
            "ccy": "USDT",
            "clientId": "",
            "from": "18",
            "instId": "",
            "state": "success",
            "subAcct": "test",
            "to": "6",
            "toInstId": "",
            "transId": "1",
            "type": "1"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
type String 0:账户内划转
1:母账户转子账户
2:子账户转母账户
transId String 划转 ID
clientId String 客户自定义ID
ccy String 划转币种
from String 转出账户
amt String 划转量
to String 转入账户
subAcct String 子账户名称
instId String 币币杠杆转出币对(如 BTC-USDT)或者转出合约的 underlying(如 BTC-USD
toInstId String 币币杠杆转入币对(如 BTC-USDT)或者转入合约的 underlying(如 BTC-USD
state String 转账状态
成功:success,处理中:pending,失败:failed

获取资金流水

查询资金账户账单流水,可查询最近一个月的数据。

限速:6 次/s

限速规则:UserID

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:撤销提现
20:转出至子账户
21:从子账户转入
28:领取
41:点卡抵扣手续费
42:购买点卡
47:系统冲正
48:活动得到
49:活动送出
50:预约得到
51:预约扣除
52:发红包
53:抢红包
54:红包退还
59:从套保账户转入
60:转出至套保账户
61:兑换
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:转出至交易账户
150:节点返佣
151:邀请奖励
198:无效资产减少
199:有效资产增加
clientId String 客户自定义ID
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
after String 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
limit String 分页返回的结果集数量,最大为 100,不填默认返回 100 条

返回结果

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

返回参数

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

闪电网络充币

一个用户在最近24小时内可以生成不超过1万个不同的invoice。

限速: 2次/s

限速规则:UserID

HTTP请求

GET /api/v5/asset/deposit-lightning

请求示例

GET /api/v5/asset/deposit-lightning

请求参数

参数 类型 是否必须 描述
ccy String 币种,仅支持BTC
amt String 充值数量,推荐在0.000001〜0.05之间
to String 资金充值到账账户
6:资金账户
18:交易账户
不填写此参数,默认到账资金账户

返回结果

{
    "code": "0",
    "data": [
        {
            "cTime": "1631171307612",
            "invoice": "lnbc100u1psnnvhtpp5yq2x3q5hhrzsuxpwx7ptphwzc4k4wk0j3stp0099968m44cyjg9sdqqcqzpgxqzjcsp5hzzdszuv6yv6yw5svctl8kc8uv6y77szv5kma2kuculj86tk3yys9qyyssqd8urqgcensh9l4zwlwr3lxlcdqrlflvvlwldutm6ljx486h7lylqmd06kky6scas7warx69sregzrx20ffmsr4sp865x3wasrjd8ttgqrlx3tr"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
invoice String invoice 号码
cTime String 生成invoice时间

获取充值地址信息

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

限速: 6次/s

限速规则:UserID

HTTP请求

GET /api/v5/asset/deposit-address

请求示例

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

请求参数

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

返回结果

{
    "code": "0",
    "data": [
        {
            "chain": "BTC-Bitcoin",
            "ctAddr": "",
            "ccy": "BTC",
            "to": "6",
            "addr": "39XNxK1Ryqgg3Bsyn6HzoqV4Xji25pNkv6",
            "selected": true
        },
        {
            "chain": "BTC-OKC",
            "ctAddr": "",
            "ccy": "BTC",
            "to": "6",
            "addr": "0x66d0edc2e63b6b992381ee668fbcb01f20ae0428",
            "selected": true
        },
        {
            "chain": "BTC-ERC20",
            "ctAddr": "5807cf",
            "ccy": "BTC",
            "to": "6",
            "addr": "0x66d0edc2e63b6b992381ee668fbcb01f20ae0428",
            "selected": true
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
addr String 充值地址
tag String 部分币种充值需要标签,若不需要则不返回此字段
memo String 部分币种充值需要 memo,若不需要则不返回此字段
pmtId String 部分币种充值需要此字段(payment_id),若不需要则不返回此字段
addrEx Object 充值地址备注,部分币种充值需要,若不需要则不返回此字段
如币种TONCOIN的充值地址备注标签名为comment,则该字段返回:{'comment':'123456'}
ccy String 币种,如BTC
chain String 币种链信息
有的币种下有多个链,必须要做区分,如USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
to String 转入账户
6:资金账户 18:交易账户
selected Boolean 该地址是否为页面选中的地址
ctAddr String 合约地址后6位

获取充值记录

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

限速: 6 次/s

限速规则:UserID

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
depId String 充值记录 ID
txId String 区块转账哈希记录
state String 充值状态
0:等待确认 1:确认到账 2:充值成功
after String 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
limit string 返回的结果集数量,默认为100,最大为100,不填默认返回100条

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "actualDepBlkConfirm": "17",
      "amt": "135.705808",
      "ccy": "USDT",
      "chain": "USDT-TRC20",
      "depId": "34579090",
      "from": "",
      "state": "2",
      "to": "TN4hxxxxxxxxxxxizqs",
      "ts": "1639468288000",
      "txId": "16f3638329xxxxxx42d988f97"
    }
  ]
}

返回参数

参数名 类型 描述
ccy String 币种名称,如 BTC
chain String 币种链信息
有的币种下有多个链,必须要做区分,如USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
amt String 充值数量
from String 充值地址,只显示内部账户转账地址,不显示区块链充值地址
to String 到账地址
txId String 区块转账哈希记录
ts String 充值到账时间,Unix 时间戳的毫秒数格式,如 1597026383085
state String 充值状态
0:等待确认
1:确认到账
2:充值成功
8:因该币种暂停充值而未到账,恢复充值后自动到账
12:账户或充值被冻结
13:子账户充值拦截
depId String 充值记录 ID
actualDepBlkConfirm String 最新的充币网络确认数

提币

用户提币。子账户不支持提币。

限速: 6次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/withdrawal

请求示例

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

请求参数

参数名 类型 是否必须 描述
ccy String 币种,如 USDT
amt String 数量
dest String 提币到
3:OKX
4:数字货币地址
toAddr String 认证过的数字货币地址、邮箱或手机号。
某些数字货币地址格式为:地址+标签,如 ARDOR-7JF3-8F2E-QUWZ-CAN7F:123456
fee String 网络手续费≥0,提币到数字货币地址所需网络手续费可通过获取币种列表接口查询
chain String 可选 币种链信息
USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
如果没有不填此参数,则默认为主链
clientId String 客户自定义ID
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。

返回结果

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

返回参数

参数名 类型 描述
ccy String 提币币种
chain String 币种链信息
有的币种下有多个链,必须要做区分,如USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
amt String 提币数量
wdId String 提币申请ID
clientId String 客户自定义ID

闪电网络提币

单笔提币金额最大值为"0.1BTC",最小值暂定为"0.000001BTC",最近24小时内最大提币数量为"1BTC"。子账户不支持提币。

限速: 2次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/withdrawal-lightning

请求示例

POST /api/v5/asset/withdrawal-lightning
body
{
    "ccy":"BTC",
    "invoice":"lnbc100u1psnnvhtpp5yq2x3q5hhrzsuxpwx7ptphwzc4k4wk0j3stp0099968m44cyjg9sdqqcqzpgxqzjcsp5hz"
}

请求参数

参数名 类型 是否必须 描述
ccy String 币种,如 BTC
invoice String invoice 号码
memo String 闪电网络提币的备注

返回结果

{
        "code": "0",
        "msg": "",
        "data": [{
                "wdId": "121212",
                "cTime": "1597026383085"
        }]
}

返回参数

参数名 类型 描述
wdId String 提币申请ID
cTime String 提币ID生成时间

撤销提币

可以撤销普通提币,但不支持撤销闪电网络上的提币。

限速: 6次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/cancel-withdrawal

请求示例

POST /api/v5/asset/cancel-withdrawal
body {
   "wdId":"1123456"
}

请求参数

参数名 类型 是否必须 描述
wdId String 提币申请ID

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "wdId": "1123456"   
    }
  ]
}

返回参数

参数名 类型 描述
wdId String 提币申请ID

获取提币记录

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

限速: 6 次/s

限速规则:UserID

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
wdId String 提币申请ID
clientId String 客户自定义ID
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
txId String 区块转账哈希记录
state String 提币状态
-3:撤销中 -2:已撤销 -1:失败
0:等待提现 1:提现中 2:已汇出
3:邮箱确认 4:人工审核中 5:等待身份认证
after String 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
limit string 返回的结果集数量,默认为100,最大为100,不填默认返回100条

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "chain": "ETH-Ethereum",
      "fee": "0.007",
      "ccy": "ETH",
      "clientId": "",
      "amt": "0.029809",
      "txId": "0x35c******b360a174d",
      "from": "156****359",
      "to": "0xa30d1fab********7CF18C7B6C579",
      "state": "2",
      "ts": "1622******2000",
      "wdId": "15447421"
    }
  ]
}

返回参数

参数名 类型 描述
ccy String 币种
chain String 币种链信息
有的币种下有多个链,必须要做区分,如USDT下有USDT-ERC20USDT-TRC20USDT-Omni多个链
amt String 数量
ts String 提币申请时间,Unix 时间戳的毫秒数格式,如 1597026383085
from String 提币地址(如果收币地址是 OKX 平台地址,则此处将显示用户账户)
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
clientId String 客户自定义ID

小额资产兑换

将资金账户中的小额资产转化为OKB。24小时之内只能兑换一次。

限速: 6次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/convert-dust-assets

请求示例

POST /api/v5/asset/convert-dust-assets
body {
   "ccy":["BTC","USDT"]
}

请求参数

参数名 类型 是否必须 描述
ccy Array 需要转换的币种资产

返回结果

{
  "code": "0",
  "data": [
    {
      "details": [
        {
            "amt": "1",
            "ccy": "USDT",
            "cnvAmt": "0.04771642808422",
            "fee": "0.00097380465478"
        }
      ],
      "totalCnvAmt": "0.04771642"
    }
  ],
  "msg": ""
}

返回参数

参数名 类型 描述
totalCnvAmt String 兑换后总OKB数量
details Array 各币种资产转换详情
> ccy String 币种资产,如 BTC
> amt String 转换前币种资产数量
> cnvAmt String 转换后的OKB数量
> fee String 兑换手续费,单位为OKB

获取余币宝余额

限速: 6次/s

限速规则:UserID

HTTP请求

GET /api/v5/asset/saving-balance

请求示例

GET /api/v5/asset/saving-balance?ccy=BTC

请求参数

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

返回结果

{
    "code": "0",
    "msg":"",
    "data": [
        {
            "earnings": "0.0010737388791526",
            "redemptAmt": "0.0000000000000000",
            "rate": "0.0100000000000000",
            "ccy": "USDT",
            "amt": "11.0010737453457821",
            "loanAmt": "11.0010630707982819",
            "pendingAmt": "0.0000106745475002"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种,如 BTC
amt String 币种数量
earnings String 币种持仓收益
rate String 最新出借利率
loanAmt String 已出借数量
pendingAmt String 未出借数量
redemptAmt String 赎回中的数量

余币宝申购/赎回

限速: 6次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/purchase_redempt

请求示例

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

请求参数

参数名 类型 是否必须 描述
ccy String 币种名称,如 BTC
amt String 申购(赎回)数量
side String 操作类型
purchase:申购 redempt:赎回
rate String 申购利率
仅适用于申购,新申购的利率会覆盖上次申购的利率
参数取值范围在1%到365%之间

返回结果

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

返回参数

参数名 类型 描述
ccy String 币种名称
amt String 申购(赎回)数量
side String 操作类型
rate String 申购利率

设置余币宝借贷利率

限速: 6次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/set-lending-rate

请求示例

POST /api/v5/asset/set-lending-rate
body
{
    "ccy":"BTC",
    "rate":"0.02"
}

请求参数

参数名 类型 是否必须 描述
ccy String 币种名称,如 BTC
rate String 贷出利率
参数取值范围在1%到365%之间

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "ccy": "BTC",
        "rate": "0.02"
    }]
}

返回参数

参数名 类型 描述
ccy String 币种名称,如 BTC
rate String 贷出利率

获取余币宝出借明细

限速: 6次/s

限速规则:UserID

HTTP请求

GET /api/v5/asset/lending-history

请求示例

GET /api/v5/asset/lending-history

请求参数

参数 类型 是否必须 描述
ccy String 币种,如 BTC
after String 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
limit String 分页返回的结果集数量,最大为 100,不填默认返回 100 条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "ccy": "BTC",
            "amt": "0.01",
            "earnings": "0.001",
            "rate": "0.01",
            "ts": "1597026383085"
        },
        {
            "ccy": "ETH",
            "amt": "0.2",
            "earnings": "0.001",
            "rate": "0.01",
            "ts": "1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种,如 BTC
amt String 出借数量
earnings String 已赚取利息
rate String 出借年利率
ts String 出借时间,Unix时间戳的毫秒数格式,如 1597026383085

获取市场借贷信息(公共)

公共接口无须鉴权

限速: 6次/s

限速规则:IP

HTTP请求

GET /api/v5/asset/lending-rate-summary

请求示例

GET /api/v5/asset/lending-rate-summary

请求参数

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

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "ccy": "BTC",
        "avgAmt": "10000",
        "avgAmtUsd": "10000000000",
        "avgRate": "0.03",
        "preRate": "0.02",
        "estRate": "0.01"
    }]
}

返回参数

参数名 类型 描述
ccy String 币种,如 BTC
avgAmt String 过去24小时平均借贷量
avgAmtUsd String 过去24小时平均借贷美元价值
avgRate String 过去24小时平均借出利率
preRate String 上一次借贷年利率
estRate String 下一次预估借贷年利率

获取市场借贷历史(公共)

公共接口无须鉴权

限速: 6次/s

限速规则:IP

HTTP请求

GET /api/v5/asset/lending-rate-history

请求示例

GET /api/v5/asset/lending-rate-history

请求参数

参数 类型 是否必须 描述
ccy String 币种,如 BTC
after String 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "ccy": "BTC",
        "amt": "0.01",
        "rate": "0.001",
        "ts": "1597026383085"
    }]
}

返回参数

参数名 类型 描述
ccy String 币种,如 BTC
amt String 市场总出借数量
rate String 出借年利率
ts String 时间,Unix时间戳的毫秒数格式,如 1597026383085

闪兑

闪兑功能模块下的API接口需要身份验证。仅支持资金账户中的资产做闪兑交易。

获取闪兑币种列表

限速: 6次/s

限速规则:UserID

HTTP 请求

GET /api/v5/asset/convert/currencies

请求示例

GET /api/v5/asset/convert/currencies

请求参数

返回结果

{
    "code": "0",
    "data": [
        {
            "min": 0.0001,
            "max": 0.5,
            "ccy": "BTC"
        },
        {
            "min": 0.001,
            "max": 10.0,
            "ccy": "ETH"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 币种名称,如 BTC
min String 支持闪兑的最小值
max String 支持闪兑的最大值

获取闪兑币对信息

限速: 6次/s

限速规则:UserID

HTTP 请求

GET /api/v5/asset/convert/currency-pair

请求示例

GET /api/v5/asset/convert/currency-pair?fromCcy=USDT&toCcy=BTC

请求参数

参数 类型 是否必须 描述
fromCcy String 消耗币种,如 USDT
toCcy String 获取币种,如 BTC

返回结果

{
    "code": "0",
    "data": [
        {
            "baseCcy": "BTC",
            "baseCcyMax": "0.5",
            "baseCcyMin": "0.0001",
            "instId": "BTC-USDT",
            "quoteCcy": "USDT",
            "quoteCcyMax": "10000",
            "quoteCcyMin": "1"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
instId String 币对,如 BTC-USDT
baseCcy String 交易货币币种,如 BTC-USDT中的BTC
baseCcyMax String 交易货币支持闪兑的最大值
baseCcyMin String 交易货币支持闪兑的最小值
quoteCcy String 计价货币币种,如 BTC-USDT中的USDT
quoteCcyMax String 计价货币支持闪兑的最大值
quoteCcyMin String 计价货币支持闪兑的最小值

闪兑预估询价

限速: 2次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/convert/estimate-quote

请求示例

POST /api/v5/asset/convert/estimate-quote
body
{
    "baseCcy": "ETH",
    "quoteCcy": "USDT",
    "side": "buy",
    "rfqSz": "30",
    "rfqSzCcy": "USDT"
}

请求参数

参数名 类型 是否必须 描述
baseCcy String 交易货币币种,如 BTC-USDT中的BTC
quoteCcy String 计价货币币种,如 BTC-USDT中的USDT
side String 交易方向
买:buy 卖:sell
描述的是对于baseCcy的交易方向
rfqSz String 询价数量
rfqSzCcy String 询价币种
clQReqId String 客户端自定义的订单标识
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
tag String 订单标签

返回结果

{
    "code": "0",
    "data": [
        {
            "baseCcy": "ETH",
            "baseSz": "0.01023052",
            "clQReqId": "",
            "cnvtPx": "2932.40104429",
            "origRfqSz": "30",
            "quoteCcy": "USDT",
            "quoteId": "quoterETH-USDT16461885104612381",
            "quoteSz": "30",
            "quoteTime": "1646188510461",
            "rfqSz": "30",
            "rfqSzCcy": "USDT",
            "side": "buy",
            "ttlMs": "10000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
quoteTime String 生成报价时间,Unix时间戳的毫秒数格式
ttlMs String 报价有效期,单位为毫秒
clQReqId String 客户端自定义的订单标识
quoteId String 报价ID
baseCcy String 交易货币币种,如 BTC-USDT 中BTC
quoteCcy String 计价货币币种,如 BTC-USDT 中USDT
side String 交易方向
买:buy 卖:sell
origRfqSz String 原始报价的数量
rfqSz String 实际报价的数量
rfqSzCcy String 报价的币种
cnvtPx String 闪兑价格,单位为计价币
baseSz String 闪兑交易币数量
quoteSz String 闪兑计价币数量

闪兑交易

限速: 2次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/convert/trade

请求示例

POST /api/v5/asset/convert/trade
body
{
    "baseCcy": "ETH",
    "quoteCcy": "USDT",
    "side": "buy",
    "sz": "30",
    "szCcy": "USDT",
    "quoteId": "quoterETH-USDT16461885104612381"
}

请求参数

参数名 类型 是否必须 描述
quoteId String 报价ID
baseCcy String 交易货币币种,如 BTC-USDT中的BTC
quoteCcy String 计价货币币种,如 BTC-USDT中的USDT
side String 交易方向
买:buy 卖:sell
描述的是对于baseCcy的交易方向
sz String 用户报价数量
报价数量应不大于预估询价中的询价数量
szCcy String 用户报价币种
clTReqId String 用户自定义的订单标识
字母(区分大小写)与数字的组合,可以是纯字母、纯数字且长度要在1-32位之间。
tag String 订单标签

返回结果

{
    "code": "0",
    "data": [
        {
            "baseCcy": "ETH",
            "clTReqId": "",
            "fillBaseSz": "0.01023052",
            "fillPx": "2932.40104429",
            "fillQuoteSz": "30",
            "instId": "ETH-USDT",
            "quoteCcy": "USDT",
            "quoteId": "quoterETH-USDT16461885104612381",
            "side": "buy",
            "state": "fullyFilled",
            "tradeId": "trader16461885203381437",
            "ts": "1646188520338"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
tradeId String 成交ID
quoteId String 报价ID
clTReqId String 用户自定义的订单标识
state String fullyFilled:交易成功
rejected:交易失败
instId String 币对,如 BTC-USDT
baseCcy String 交易货币币种,如 BTC-USDTBTC
quoteCcy String 计价货币币种,如 BTC-USDTUSDT
side String 交易方向
买:buy 卖:sell
fillPx String 成交价格,单位为计价币
fillBaseSz String 成交的交易币数量
fillQuoteSz String 成交的计价币数量
ts String 闪兑交易时间,值为时间戳,Unix时间戳为毫秒数格式,如 1597026383085

获取闪兑交易历史

限速: 6次/s

限速规则:UserID

HTTP 请求

GET /api/v5/asset/convert/history

请求示例

GET /api/v5/asset/convert/history

请求参数

参数 类型 是否必须 描述
after String 查询在此之前的内容,值为时间戳,Unix时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix时间戳为毫秒数格式,如 1597026383085
limit String 返回的结果集数量,默认为100,最大为100
tag String 订单标签

返回结果

{
    "code": "0",
    "data": [
        {
            "instId": "ETH-USDT",
            "side": "buy",
            "fillPx": "2932.401044",
            "baseCcy": "ETH",
            "quoteCcy": "USDT",
            "fillBaseSz": "0.01023052",
            "state": "fullyFilled",
            "tradeId": "trader16461885203381437",
            "fillQuoteSz": "30",
            "ts": "1646188520000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
tradeId String 成交ID
state String fullyFilled:交易成功
rejected:交易失败
instId String 币对,如 BTC-USDT
baseCcy String 交易货币币种,如 BTC-USDT中的BTC
quoteCcy String 计价货币币种,如 BTC-USDT中的USDT
side String 交易方向
买:buy 卖:sell
fillPx String 成交价格,单位为计价币
fillBaseSz String 成交的交易币数量
fillQuoteSz String 成交的计价币数量
ts String 闪兑交易时间,值为时间戳,Unix时间戳为毫秒数格式,如 1597026383085

账户

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

查看账户余额

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

限速: 10次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/balance

请求示例

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

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

请求参数

参数名 类型 是否必须 描述
ccy String 币种,如 BTC
支持多币种查询(不超过20个),币种之间半角逗号分隔

返回结果

{
    "code": "0",
    "data": [
        {
            "adjEq": "10679688.0460531643092577",
            "details": [
                {
                    "availBal": "",
                    "availEq": "9930359.9998",
                    "cashBal": "9930359.9998",
                    "ccy": "USDT",
                    "crossLiab": "0",
                    "disEq": "9439737.0772999514",
                    "eq": "9930359.9998",
                    "eqUsd": "9933041.196999946",
                    "frozenBal": "0",
                    "interest": "0",
                    "isoEq": "0",
                    "isoLiab": "0",
                    "isoUpl":"0",
                    "liab": "0",
                    "maxLoan": "10000",
                    "mgnRatio": "",
                    "notionalLever": "",
                    "ordFrozen": "0",
                    "twap": "0",
                    "uTime": "1620722938250",
                    "upl": "0",
                    "uplLiab": "0",
                    "stgyEq":"0"
                },
                {
                    "availBal": "",
                    "availEq": "33.6799714158199414",
                    "cashBal": "33.2009985",
                    "ccy": "BTC",
                    "crossLiab": "0",
                    "disEq": "1239950.9687532129092577",
                    "eq": "33.771820625136023",
                    "eqUsd": "1239950.9687532129092577",
                    "frozenBal": "0.0918492093160816",
                    "interest": "0",
                    "isoEq": "0",
                    "isoLiab": "0",
                    "isoUpl":"0",
                    "liab": "0",
                    "maxLoan": "1453.92289531493594",
                    "mgnRatio": "",
                    "notionalLever": "",
                    "ordFrozen": "0",
                    "twap": "0",
                    "uTime": "1620722938250",
                    "upl": "0.570822125136023",
                    "uplLiab": "0",
                    "stgyEq":"0"
                }
            ],
            "imr": "3372.2942371050594217",
            "isoEq": "0",
            "mgnRatio": "70375.35408747017",
            "mmr": "134.8917694842024",
            "notionalUsd": "33722.9423710505978888",
            "ordFroz": "0",
            "totalEq": "11172992.1657531589092577",
            "uTime": "1623392334718"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
uTime String 账户信息的更新时间,Unix时间戳的毫秒数格式,如 1597026383085
totalEq String 美金层面权益
isoEq String 美金层面逐仓仓位权益
适用于单币种保证金模式跨币种保证金模式组合保证金模式
adjEq String 美金层面有效保证金
适用于跨币种保证金模式组合保证金模式
ordFroz String 美金层面全仓挂单占用保证金
适用于跨币种保证金模式组合保证金模式
imr String 美金层面占用保证金
适用于跨币种保证金模式组合保证金模式
mmr String 美金层面维持保证金
适用于跨币种保证金模式组合保证金模式
mgnRatio String 美金层面保证金率
适用于跨币种保证金模式组合保证金模式
notionalUsd String 以美金价值为单位的持仓数量,即仓位美金价值
适用于跨币种保证金模式组合保证金模式
details Array 各币种资产详细信息
> ccy String 币种
> eq String 币种总权益
> cashBal String 币种余额
> uTime String 币种余额信息的更新时间,Unix时间戳的毫秒数格式,如 1597026383085
> isoEq String 币种逐仓仓位权益
适用于单币种保证金模式跨币种保证金模式组合保证金模式
> availEq String 可用保证金
适用于单币种保证金模式跨币种保证金模式组合保证金模式
> disEq String 美金层面币种折算权益
> availBal String 可用余额
适用于简单交易模式
> frozenBal String 币种占用金额
> ordFrozen String 挂单冻结数量
> liab String 币种负债额
适用于跨币种保证金模式组合保证金模式
> upl String 未实现盈亏
适用于单币种保证金模式跨币种保证金模式组合保证金模式
> uplLiab String 由于仓位未实现亏损导致的负债
适用于跨币种保证金模式组合保证金模式
> crossLiab String 币种全仓负债额
适用于跨币种保证金模式组合保证金模式
> isoLiab String 币种逐仓负债额
适用于跨币种保证金模式组合保证金模式
> mgnRatio String 保证金率
适用于单币种保证金模式
> interest String 计息
适用于跨币种保证金模式组合保证金模式
> twap String 当前负债币种触发系统自动换币的风险
0、1、2、3、4、5其中之一,数字越大代表您的负债币种触发自动换币概率越高
适用于跨币种保证金模式组合保证金模式
> maxLoan String 币种最大可借
适用于跨币种保证金模式组合保证金模式
> eqUsd String 币种权益美金价值
> notionalLever String 币种杠杆倍数
适用于单币种保证金模式
> stgyEq String 策略权益
> isoUpl String 逐仓未实现盈亏
适用于单币种保证金模式跨币种保证金模式组合保证金模式

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

参数 简单交易模式 单币种保证金模式 跨币种保证金模式
uTime
totalEq
isoEq
adjEq
ordFroz
imr
mmr
mgnRatio
notionalUsd
details
> ccy
> eq
> cashBal
> uTime
> isoEq
> availEq
> disEq
> availBal
> frozenBal
> ordFrozen
> liab
> upl
> uplLiab
> crossLiab
> isoLiab
> mgnRatio
> interest
> twap
> maxLoan
> eqUsd
> notionalLever
> stgyEq
> isoUpl

查看持仓信息

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

限速:10次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/positions

请求示例

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

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
instTypeinstId同时传入的时候会校验instIdinstType是否一致。
instId String 交易产品ID,如:BTC-USD-190927-5000-C
支持多个instId查询(不超过10个),半角逗号分隔
posId String 持仓ID
支持多个posId查询(不超过20个),半角逗号分割

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "adl":"1",
        "availPos":"1",
        "avgPx":"2566.31",
        "cTime":"1619507758793",
        "ccy":"ETH",
        "deltaBS":"",
        "deltaPA":"",
        "gammaBS":"",
        "gammaPA":"",
        "imr":"",
        "instId":"ETH-USD-210430",
        "instType":"FUTURES",
        "interest":"0",
        "last":"2566.22",
        "usdPx":"",
        "lever":"10",
        "liab":"",
        "liabCcy":"",
        "liqPx":"2352.8496681818233",
        "markPx":"2353.849",
        "margin":"0.0003896645377994",
        "mgnMode":"isolated",
        "mgnRatio":"11.731726509588816",
        "mmr":"0.0000311811092368",
        "notionalUsd":"2276.2546609009605",
        "optVal":"",
        "pTime":"1619507761462",
        "pos":"1",
        "posCcy":"",
        "posId":"307173036051017730",
        "posSide":"long",
        "thetaBS":"",
        "thetaPA":"",
        "tradeId":"109844",
        "quoteBal": "0",
        "baseBal": "0",
        "uTime":"1619507761462",
        "upl":"-0.0000009932766034",
        "uplRatio":"-0.0025490556801078",
        "vegaBS":"",
        "vegaPA":""
    }]
}

返回参数

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

查看历史持仓信息

获取最近3个月有更新的仓位信息

限速:1次/10s

限速规则:UserID

HTTP请求

GET /api/v5/account/positions-history

请求示例

GET /api/v5/account/positions-history

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
instId String 交易产品ID,如:BTC-USD-SWAP
mgnMode String 保证金模式
cross:全仓,isolated:逐仓
type String 平仓类型
1:部分平仓;2:完全平仓;3:强平;4:强减; 5:ADL自动减仓;
状态叠加时,以最新的平仓类型为准状态为准。
after String 查询在此之前的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
before String 查询在此之后的内容,值为时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
limit String 返回结果的数量,默认100条

返回结果

{
    "code": "0",
    "data": [
        {
            "cTime": "1654177169995",
            "ccy": "BTC",
            "closeAvgPx": "29786.5999999789081085",
            "closeTotalPos": "1",
            "instId": "BTC-USD-SWAP",
            "instType": "SWAP",
            "lever": "10.0",
            "mgnMode": "cross",
            "openAvgPx": "29783.8999999995535393",
            "openMaxPos": "1",
            "pnl": "0.00000030434156",
            "pnlRatio": "0.000906447858888",
            "posId": "452587086133239818",
            "posSide": "long",
            "triggerPx": "",
            "type": "allClose",
            "uTime": "1654177174419",
            "uly": "BTC-USD"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 交易产品ID
mgnMode String 保证金模式
cross:全仓,isolated:逐仓
type String 平仓类型
1:部分平仓;2:完全平仓;3:强平;4:强减; 5:ADL自动减仓;
状态叠加时,以最新的平仓类型为准状态为准。
cTime String 仓位创建时间
uTime String 仓位更新时间
openAvgPx String 开仓均价
closeAvgPx String 平仓均价
posId String 仓位ID
openMaxPos String 最大持仓量
closeTotalPos String 累计平仓量
pnl String 平仓收益额
pnlRatio String 平仓收益率
lever String 杠杆倍数
direction String 持仓方向 long:多 short:空
仅适用于 币币杠杆/交割/永续/期权
triggerPx String 触发标记价格
liqPx String 强平价
uly String 标的指数

查看账户持仓风险

查看账户整体风险。

限速: 10次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/account-position-risk

请求示例

GET /api/v5/account/account-position-risk

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权

返回结果

{
    "code":"0",
    "data":[
        {
            "adjEq":"174238.6793649711331679",
            "balData":[
                {
                    "ccy":"BTC",
                    "disEq":"78846.7803721021362242",
                    "eq":"1.3863533369419636"
                },
                {
                    "ccy":"USDT",
                    "disEq":"73417.2495112863300127",
                    "eq":"73323.395564963177146"
                }
            ],
            "posData":[
                {
                    "baseBal": "0.4",
                    "ccy": "",
                    "instId": "BTC-USDT",
                    "instType": "MARGIN",
                    "mgnMode": "isolated",
                    "notionalCcy": "0",
                    "notionalUsd": "0",
                    "pos": "0",
                    "posCcy": "",
                    "posId": "310388685292318723",
                    "posSide": "net",
                    "quoteBal": "0"
                }
            ],
            "ts":"1620282889345"
        }
    ],
    "msg":""
}

返回参数

参数名 类型 描述
ts String 获取账户信息数据的时间,Unix时间戳的毫秒数格式,如 1597026383085
adjEq String 美金层面有效保证金
适用于跨币种保证金模式组合保证金模式
balData Array 币种资产信息
> ccy String 币种
> eq String 币种总权益
> disEq String 美金层面币种折算权益
posData Array 持仓详细信息
> instType String 产品类型
> mgnMode String 保证金模式
cross:全仓
isolated:逐仓
> posId String 持仓ID
> instId String 产品ID,如 BTC-USD-180216
> pos String 为单位的持仓数量,逐仓自主划转模式下,转入保证金后会产生pos为0的仓位
> baseBal String 交易币余额,适用于 币币杠杆(逐仓自主划转模式)
> quoteBal String 计价币余额 ,适用于 币币杠杆(逐仓自主划转模式)
> posSide String 持仓方向
long:双向持仓多头
short:双向持仓空头
net:单向持仓(交割/永续/期权pos为正代表多头,pos为负代表空头。币币杠杆posCcy为交易货币时,代表多头;posCcy为计价货币时,代表空头。)
> posCcy String 仓位资产币种,仅适用于币币杠杆仓位
> ccy String 占用保证金的币种
> notionalCcy String 为单位的持仓数量
> notionalUsd String 美金价值为单位的持仓数量

账单流水查询(近七天)

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

限速:5次/s

限速规则:UserID

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:穿仓补偿 11:系统换币 12:策略划拨 13:对冲减仓
subType String 账单子类型
1:买入 2:卖出 3:开多 4:开空 5:平多 6:平空 9:市场借币扣息 11:转入 12:转出 14:尊享借币扣息 160:手动追加保证金 161:手动减少保证金 162:自动追加保证金 114:自动换币买入 115:自动换币卖出 118:系统换币转入 119:系统换币转出 100:强减平多 101:强减平空 102:强减买入 103:强减卖出 104:强平平多 105:强平平空 106:强平买入 107:强平卖出 110:强平换币转入 111:强平换币转出 125:自动减仓平多 126:自动减仓平空 127:自动减仓买入 128:自动减仓卖出 131:对冲买入 132:对冲卖出 170:到期行权 171:到期被行权 172:到期作废 112:交割平多 113:交割平空 117:交割/期权穿仓补偿 173:资金费支出 174:资金费收入 200:系统转入 201:手动转入 202:系统转出 203:手动转出
after String 请求此id之前(更旧的数据)的分页内容,传的值为对应接口的billId
before String 请求此id之后(更新的数据)的分页内容,传的值为对应接口的billId
begin String 筛选的开始时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
end String 筛选的结束时间戳,Unix 时间戳为毫秒数格式,如 1597027383085
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "bal": "256.27611382",
            "balChg": "256.27611382",
            "billId": "374241568911437826",
            "ccy": "GODS",
            "execType": "",
            "fee": "",
            "from": "1",
            "instId": "",
            "instType": "",
            "mgnMode": "",
            "notes": "From 币币账户",
            "ordId": "",
            "pnl": "",
            "posBal": "",
            "posBalChg": "",
            "subType": "11",
            "sz": "256.27611382",
            "to": "18",
            "ts": "1635498143100",
            "type": "1"
        }
    ]
}

返回参数

参数名 类型 描述
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
当type为2:交易时,返回相应订单id。无订单时,该字段返回 ""
execType String 流动性方向 T:taker M:maker
from String 转出账户
6:资金账户 18:交易账户
仅适用于资金划转,不是资金划转时,返回 ""
to String 转入账户
6:资金账户 18:交易账户
仅适用于资金划转,不是资金划转时,返回 ""
notes String 备注

账单流水查询(近三月)

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

限速:5次/2s

限速规则:UserID

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:穿仓补偿 11:系统换币 12:策略划拨 13:对冲减仓
subType String 账单子类型
1:买入 2:卖出 3:开多 4:开空 5:平多 6:平空 9:市场借币扣息 11:转入 12:转出 14:尊享借币扣息 160:手动追加保证金 161:手动减少保证金 162:自动追加保证金 114:自动换币买入 115:自动换币卖出 118:系统换币转入 119:系统换币转出 100:强减平多 101:强减平空 102:强减买入 103:强减卖出 104:强平平多 105:强平平空 106:强平买入 107:强平卖出 110:强平换币转入 111:强平换币转出 125:自动减仓平多 126:自动减仓平空 127:自动减仓买入 128:自动减仓卖出 131:对冲买入 132:对冲卖出 170:到期行权 171:到期被行权 172:到期作废 112:交割平多 113:交割平空 117:交割/期权穿仓补偿 173:资金费支出 174:资金费收入 200:系统转入 201:手动转入 202:系统转出 203:手动转出
after String 请求此id之前(更旧的数据)的分页内容,传的值为对应接口的billId
before String 请求此id之后(更新的数据)的分页内容,传的值为对应接口的billId
begin String 筛选的开始时间戳,Unix 时间戳为毫秒数格式,如 1597026383085
end String 筛选的结束时间戳,Unix 时间戳为毫秒数格式,如 1597027383085
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "bal": "256.27611382",
            "balChg": "256.27611382",
            "billId": "374241568911437826",
            "ccy": "GODS",
            "execType": "",
            "fee": "",
            "from": "1",
            "instId": "",
            "instType": "",
            "mgnMode": "",
            "notes": "From 币币账户",
            "ordId": "",
            "pnl": "",
            "posBal": "",
            "posBalChg": "",
            "subType": "11",
            "sz": "256.27611382",
            "to": "18",
            "ts": "1635498143100",
            "type": "1"
        }
    ]
}

返回参数

参数名 类型 描述
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
当type为2:交易时,返回相应订单id。无订单时,该字段返回 ""
execType String 流动性方向 T:taker M:maker
from String 转出账户
6:资金账户 18:交易账户
仅适用于资金划转,不是资金划转时,返回 ""
to String 转入账户
6:资金账户 18:交易账户
仅适用于资金划转,不是资金划转时,返回 ""
notes String 备注

查看账户配置

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

限速:5次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/config

请求示例

GET /api/v5/account/config

请求参数

返回结果

{
    "code": "0",
    "data": [
        {
            "acctLv": "3",
            "autoLoan": true,
            "ctIsoMode": "automatic",
            "greeksType": "PA",
            "level": "Lv3",
            "levelTmp": "",
            "mgnIsoMode": "autonomy",
            "posMode": "net_mode",
            "uid": "781767883763712"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
uid String 账户ID,账户uid和app上的一致
acctLv String 账户层级
1:简单交易模式,2:单币种保证金模式 ,3:跨币种保证金模式 ,4:组合保证金模式
posMode String 持仓方式
long_short_mode:双向持仓 net_mode:单向持仓
仅适用交割/永续
autoLoan Boolean 是否自动借币
true:自动借币 false:非自动借币
greeksType String 当前希腊字母展示方式
PA:币本位 BS:美元本位
level String 当前在平台上真实交易量的用户等级,例如 lv1
levelTmp String 特约用户的临时体验用户等级,例如 lv3
ctIsoMode String 衍生品的逐仓保证金划转模式
automatic:开仓划转 autonomy:自主划转
mgnIsoMode String 币币杠杆的逐仓保证金划转模式
automatic:开仓划转 autonomy:自主划转

设置持仓模式

单币种账户和跨币种账户模式:交割和永续合约支持双向持仓模式和单向持仓模式。单向持仓只会有一个方向的仓位;双向持仓可以分别持有多、空2个方向的仓位。
组合保证金模式:交割和永续仅支持单向持仓模式

限速:5次/2s

限速规则:UserID

HTTP请求

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

请求示例

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

请求参数

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

返回结果

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

返回参数

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

设置杠杆倍数

一个产品可以有如下几种杠杆倍数的设置场景:

币币杠杆逐仓杠杆倍数(币对层面);

币币杠杆单币种保证金模式下全仓杠杆倍数(币对层面);

币币杠杆跨币种保证金模式下全仓杠杆倍数(币种层面);

交割/永续逐仓/全仓杠杆倍数(合约/指数层面)。

限速:20次/2s

限速规则:UserID

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"
}

设置交割合约的全仓杠杆倍数,指数层面
POST /api/v5/account/set-leverage 
body
{
    "instId":"BTC-USDT-200802",
    "lever":"5",
    "mgnMode":"cross"
}

请求参数

参数名 类型 是否必须 描述
instId String 可选 产品ID:币对、合约
instIdccy至少要传一个;如果两个都传,默认使用instId
ccy String 可选 保证金币种
仅适用于跨币种保证金模式全仓 币币杠杆。设置自动借币的杠杆倍数时必填
lever String 杠杆倍数
mgnMode String 保证金模式
isolated:逐仓 cross:全仓
如果ccy有效传值,该参数值只能为cross
posSide String 可选 持仓方向
long:双向持仓多头
short:双向持仓空头
net:单向持仓
仅适用于逐仓交割/永续
在双向持仓且保证金模式为逐仓条件下必填,且仅可选择 longshort,默认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

限速规则:UserID

HTTP请求

GET /api/v5/account/max-size

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 产品ID,如 BTC-USDT
支持多产品ID查询(不超过5个),半角逗号分隔
tdMode String 交易模式
cross:全仓 isolated:逐仓 cash:非保证金
ccy String 可选 保证金币种,仅适用于单币种保证金模式下的全仓杠杆订单
px String 委托价格
当不填委托价时会按当前最新成交价计算
当指定多个产品ID查询时,忽略该参数,按当前最新成交价计算
leverage String 开仓杠杆倍数
默认为当前杠杆倍数
仅适用于币币杠杆/交割/永续

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "ccy": "BTC",
        "instId": "BTC-USDT",
        "maxBuy": "0.0500695098559788",
        "maxSell": "64.4798671570072269"
    }]
}

返回参数

参数名 类型 描述
instId String 产品ID
ccy String 保证金币种
maxBuy String 币币/币币杠杆:最大可买的交易币数量
单币种保证金模式下的全仓杠杆订单,为交易币数量
交割/永续/期权:最大可开多的合约张数
maxSell String 币币/币币杠杆:最大可卖的计价币数量
单币种保证金模式下的全仓杠杆订单,为交易币数量
交割/永续/期权:最大可开空的合约张数

获取最大可用数量

限速:20次/2s

限速规则:UserID

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
支持多产品ID查询(不超过5个),半角逗号分隔
tdMode String 交易模式
cross:全仓 isolated:逐仓 cash:非保证金
ccy String 可选 保证金币种,仅适用于单币种保证金模式下的全仓杠杆订单
reduceOnly Boolean 是否为只减仓模式,仅适用于币币杠杆
px String 委托价格
当不填委托价时会按当前最新成交价计算
当指定多个产品ID查询时,忽略该参数,按当前最新成交价计算

返回结果

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

返回参数

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

调整保证金

增加或者减少逐仓保证金。减少保证金可能会导致实际杠杆倍数发生变化。

限速:20次/2s

限速规则:UserID

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 增加或减少的保证金数量
ccy String 增加或减少的保证金的币种,
仅适用于逐仓自主划转保证金模式下的币币杠杆
auto Boolean 是否自动借币转 true 或 false,默认false
仅适用于逐仓自主划转保证金模式下的币币杠杆
loanTrans Boolean 是否支持跨币种保证金模式组合保证金模式下的借币转入/转出
true 或 false,默认false

返回结果

{
    "code": "0",
    "data": [
        {
            "amt": "0.3",
            "ccy": "BTC",
            "instId": "BTC-USDT",
            "leverage": "",
            "posSide": "net",
            "type": "add"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
instId String 产品ID
posSide String 持仓方向
amt String 已增加/减少的保证金数量
type String 增加/减少保证金
leverage String 调整保证金后的实际杠杆倍数
ccy String 增加或减少的保证金的币种

获取杠杆倍数

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/leverage-info

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 产品ID
支持多个instId查询,半角逗号分隔。instId个数不超过20个
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

限速规则:UserID

HTTP 请求

GET /api/v5/account/max-loan

请求示例

单币种逐仓账户获取币币杠杆最大可借
GET  /api/v5/account/max-loan?instId=BTC-USDT&mgnMode=isolated

单币种全仓账户获取币币杠杆最大可借(指定保证金为BTC)
GET  /api/v5/account/max-loan?instId=BTC-USDT&mgnMode=cross&mgnCcy=BTC

跨币种全仓账户获取币币杠杠最大可借
GET  /api/v5/account/max-loan?instId=BTC-USDT&mgnMode=cross

请求参数

参数名 类型 是否必须 描述
instId String 产品 ID,如 BTC-USDT
支持多产品ID查询(不超过5个),半角逗号分隔
mgnMode String 仓位类型
isolated:逐仓
cross:全仓
mgnCcy String 可选 保证金币种,如 BTC
币币杠杆单币种全仓情况下必须指定保证金币种

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "instId": "BTC-USDT",
      "mgnMode": "isolated",
      "mgnCcy": "",
      "maxLoan": "0.1",
      "ccy": "BTC",
      "side": "sell"
    },
    {
      "instId": "BTC-USDT",
      "mgnMode": "isolated",
      "mgnCcy": "",
      "maxLoan": "0.2",
      "ccy": "USDT",
      "side": "buy"
    }
  ]
}

返回参数

参数名 类型 描述
instId String 产品 ID
mgnMode String 仓位类型
mgnCcy String 保证金币种
maxLoan String 最大可借
ccy String 币种
side String 订单方向

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

限速:5次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/trade-fee

请求示例

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

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
SPOT:币币
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
instId String 产品ID,如 BTC-USDT
仅适用于instType为币币/币币杠杆
uly String 标的指数
仅适用于instType为交割/永续/期权,如 BTC-USD

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
            "category": "1", // 已废弃
            "delivery": "",
            "exercise": "",
            "instType": "SPOT",
            "level": "lv1",
            "maker": "-0.0008",
            "makerU": "",
            "taker": "-0.001",
            "takerU": "",
            "ts": "1608623351857"
        }
    ]
}

返回参数

参数名 类型 描述
level String 手续费等级
taker String 吃单手续费率,永续和交割合约时,为币本位合约费率
maker String 挂单手续费率,永续和交割合约时,为币本位合约费率
takerU String U本位合约吃单手续费率,仅适用于交割/永续
makerU String U本位合约挂单手续费率,仅适用于交割/永续
delivery String 交割手续费率
exercise String 行权手续费率
instType String 产品类型
ts String 数据返回时间,Unix时间戳的毫秒数格式,如 1597026383085

获取计息记录

限速:5次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/interest-accrued

请求示例

GET /api/v5/account/interest-accrued

请求参数

参数名 类型 是否必须 描述
type String 借币类型
1:尊享借币
2:市场借币
默认为市场借币
ccy String 借贷币种,如 BTC
仅适用于市场借币
仅适用于币币杠杆
instId String 产品ID,如 BTC-USDT
仅适用于市场借币
mgnMode String 保证金模式
cross:全仓
isolated:逐仓
仅适用于市场借币
after String 请求此时间戳之前(更旧的数据)的分页内容,Unix时间戳的毫秒数格式,如 1597026383085
before String 请求此时间戳之后(更新的数据)的分页内容,Unix时间戳的毫秒数格式,如 1597026383085
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "ccy": "USDT",
            "instId": "",
            "interest": "0.0003960833333334",
            "interestRate": "0.0000040833333333",
            "liab": "97",
            "mgnMode": "",
            "ts": "1637312400000",
            "type": "1"
        }
        {
            "ccy": "USDT",
            "instId": "",
            "interest": "0.0004083333333334",
            "interestRate": "0.0000040833333333",
            "liab": "100",
            "mgnMode": "",
            "ts": "1637049600000",
            "type": "1"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
type String 类型
1:尊享借币
2:市场借币
ccy String 借贷币种,如 BTC
instId String 产品ID,如 BTC-USD-180216
仅适用于市场借币
mgnMode String 保证金模式
cross:全仓
isolated:逐仓
interest String 利息
interestRate String 计息利率(小时)
liab String 计息负债
ts String 计息时间,Unix时间戳的毫秒数格式,如 1597026383085

获取用户当前杠杆借币利率

限速:5次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/interest-rate

请求示例

GET /api/v5/account/interest-rate

请求参数

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

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "ccy":"BTC",
            "interestRate":"0.0001"
        },
        {
            "ccy":"LTC",
            "interestRate":"0.0003"
        }
    ]
}

返回参数

参数名 类型 描述
interestRate String 杠杆借币利率
ccy String 币种

期权greeks的PA/BS切换

设置greeks的展示方式。

限速:5次/2s

限速规则:UserID

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 当前希腊字母展示方式

逐仓交易设置

可以通过该接口设置币币杠杆和交割、永续的逐仓仓位保证金的划转模式

限速:5次/2s

限速规则:UserID

HTTP请求

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

请求示例

POST /api/v5/account/set-isolated-mode
body
{
    "isoMode":"automatic",
    "type":"MARGIN"
}

请求参数

参数名 类型 是否必须 描述
isoMode String 逐仓保证金划转模式
automatic:开仓自动划转
autonomy:自主划转
type String 业务线类型

MARGIN:币币杠杆
CONTRACTS:合约

返回结果

{
    "code": "0",
    "data": [
        {
            "isoMode": "autonomy"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
isoMode String 逐仓保证金划转模式
automatic:开仓自动划转
autonomy:自主划转

查看账户最大可转余额

当指定币种时会返回该币种的交易账户到资金账户的最大可划转数量,不指定币种会返回所有拥有的币种资产可划转数量。

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/max-withdrawal

请求示例

GET /api/v5/account/max-withdrawal

请求参数

参数名 类型 是否必须 描述
ccy String 币种,如 BTC
支持多币种查询(不超过20个),币种之间半角逗号分隔

返回结果

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

返回参数

参数名 类型 描述
ccy String 币种
maxWd String 最大可划转数量(不支持跨币种保证金模式借币转出)
maxWdEx String 最大可划转数量(支持跨币种保证金模式借币转出)

查看账户特定风险状态

仅适用于PM账户

限速: 10次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/risk-state

请求示例

GET /api/v5/account/risk-state

返回结果

{
    "code": "0",
    "data": [
        {
            "atRisk": false,
            "atRiskIdx": [],
            "atRiskMgn": [],
            "ts": "1635745078794"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
atRisk String 自动借币模式下的账户风险状态
true:当前账户为特定风险状态
当前不是特定风险状态
atRiskIdx Array 衍生品的risk unit列表
atRiskMgn Array 杠杆的risk unit列表
ts String 接口数据返回时间 ,Unix时间戳的毫秒数格式,如 1597026383085

尊享借币还币

限速:6次/s

限速规则:UserID

HTTP请求

POST /api/v5/account/borrow-repay

请求示例

POST /api/v5/account/borrow-repay 
body
{
    "ccy":"USDT",
    "side":"borrow",
    "amt":"100"
}

请求参数

参数名 类型 是否必须 描述
ccy String 借贷币种,如 BTC
side String borrow:借币,repay:还币
amt String 借/还币的数量

返回结果

{
    "code": "0",
    "data": [
        {
            "amt": "102",
            "availLoan": "97",
            "ccy": "USDT",
            "loanQuota": "6000000",
            "posLoan": "0",
            "side": "repay",
            "usedLoan": "97"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 借贷币种,如 BTC
side String borrow:借币,repay:还币
amt String 借/还币的数量
loanQuota String 借币限额
posLoan String 当前账户开仓占用
availLoan String 当前账户剩余可用
usedLoan String 当前账户已借额度

获取尊享借币还币历史

限速:5次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/borrow-repay-history

请求示例

GET /api/v5/account/borrow-repay-history

请求参数

参数名 类型 是否必须 描述
ccy String 借贷币种,如 BTC
after String 请求此时间戳之前(更旧的数据)的分页内容,Unix时间戳的毫秒数格式,如 1597026383085
before String 请求此时间戳之后(更新的数据)的分页内容,Unix时间戳的毫秒数格式,如 1597026383085
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "ccy": "USDT",
            "tradedLoan": "102",
            "ts": "1637310691470",
            "type": "2",
            "usedLoan": "97"
        },
        {
            "ccy": "USDT",
            "tradedLoan": "102",
            "ts": "1637050435058",
            "type": "2",
            "usedLoan": "199"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 借贷币种,如 BTC
type String 类型
1:借币
2:还币
3:扣息失败系统还币
tradedLoan String 借/还币数量
usedLoan String 当前账户已借额度
ts String 借/还币时间

获取借币利率与限额

限速:5次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/interest-limits

请求示例

GET /api/v5/account/interest-limits?type=1&ccy=BTC

请求参数

参数名 类型 是否必须 描述
type String 借币类型
1:尊享借币
2:市场借币
默认为市场借币
ccy String 借贷币种,如 BTC

返回结果

{
    "code": "0",
    "data": [
        {
            "debt": "97.06402000000000000000000000000000",
            "interest": "",
            "nextDiscountTime": "1637312400000",
            "nextInterestTime": "1637312400000",
            "records": [
                {
                    "availLoan": "0.0000000000000000",
                    "ccy": "BTC",
                    "interest": "",
                    "loanQuota": "120.0000000000000000",
                    "posLoan": "0",
                    "rate": "0.00199200",
                    "surplusLmt": "120.0000000000000000",
                    "usedLmt": "0",
                    "usedLoan": "0.0000000000000000"
                }
            ]
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
debt String 当前负债,单位为USDT
interest String 当前记息,单位为USDT
仅适用于市场借币
nextDiscountTime String 下次扣息时间,Unix时间戳的毫秒数格式,如 1597026383085
nextInterestTime String 下次计息时间,Unix时间戳的毫秒数格式,如 1597026383085
records Array 各币种详细信息
> ccy String 借贷币种,如 BTC
> rate String 日利率
> loanQuota String 借币限额
> surplusLmt String 剩余可借
> usedLmt String 已借额度
> interest String 已计未扣利息
仅适用于市场借币
> posLoan String 当前账户开仓占用
仅适用于尊享借币
> availLoan String 当前账户剩余可用
仅适用于尊享借币
> usedLoan String 当前账户已借额度
仅适用于尊享借币

组合保证金的虚拟持仓保证金计算

计算用户的模拟头寸或当前头寸的投资组合保证金信息,一次请求最多添加200个虚拟仓位

限速:2次/2s

限速规则:UserID

HTTP请求

POST /api/v5/account/simulated_margin

请求示例

计算指定业务线已有真实仓位和虚拟仓位的投资组合保证金
POST /api/v5/account/simulated_margin
body
{
   "instType":"SWAP",
   "inclRealPos":"true",
   "simPos":[
     {
          "pos":"10",
          "instId":"BTC-USDT-SWAP"
     },
     {
          "pos":"10",
          "instId":"LTC-USDT-SWAP"
     }
   ]
}

只计算已有真实仓位
POST /api/v5/account/simulated_margin
body
{
   "inclRealPos":"true"
}


只计算虚拟仓位
POST /api/v5/account/simulated_margin
body
{
   "inclRealPos":"false",
   "simPos":[
     {
          "pos":"10",
          "instId":"BTC-USDT-SWAP"
     },
     {
          "pos":"10",
          "instId":"LTC-USDT-SWAP"
     }
   ]
}

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
inclRealPos Boolean 是否代入已有仓位
true:调整被代入的已有仓位信息
false:不代入已有仓位,仅使用simPos里新增的模拟仓位进行计算,默认为True
simPos Array 调整持仓列表
> instId String 交易产品ID
> pos String 持仓量

返回结果

{
    "code": "0",
    "data": [
        {
            "imr": "0.005432310199023",
            "mmr": "0.0041787001530946",
            "mr1": "0.0041787001530946",
            "mr2": "0.0000734347499275",
            "mr3": "0",
            "mr4": "0",
            "mr5": "0",
            "mr6": "0.0028031968471",
            "mr7": "0.0022",
            "posData": [
                {
                    "delta": "-0.008926024905498",
                    "gamma": "-0.0707804093543001",
                    "instId": "BTC-USD-220325-50000-C",
                    "instType": "OPTION",
                    "notionalUsd": "3782.9800000000005",
                    "pos": "-1",
                    "theta": "0.000093015207115",
                    "vega": "-0.0000382697346669"
                }
            ],
            "riskUnit": "BTC-USD",
            "ts": "1646639497536"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
riskUnit String 账户内所有持仓的riskUnit
ts String 账户信息的更新时间,Unix时间戳的毫秒数格式,如 1597026383085
mmr String riskUnit维度的初始保证金
imr String riskUnit维度的占用保证金
mr1 String 现货&波动率压力测试值
mr2 String 时间价值压力测试值
mr3 String 波动率跨期压力测试值
mr4 String 基差压力测试值
mr5 String 利率风险压力测试值
mr6 String 极端市场波动压力测试值
mr7 String 减仓成本压力测试值
posData Array 持仓列表
> instId String 产品ID,如 BTC-USD-180216
> instType String 产品类型
> pos String 持仓量
> notionalUsd String 以美金价值为单位的持仓数量
> delta String 期权价格对uly价格的敏感度
> gamma String delta对uly价格的敏感度
> vega String 权价格对隐含波动率的敏感度
> theta String 期权价格对剩余期限的敏感度

查看账户Greeks

获取账户资产的greeks信息。

限速: 10次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/greeks

请求示例

获取账户中所有资产的greeks
GET /api/v5/account/greeks

获取账户中BTC的greeks
GET /api/v5/account/greeks?ccy=BTC

请求参数

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

返回结果

{
    "code":"0",
    "data":[
        {            
           "thetaBS": "",
           "thetaPA":"",
           "deltaBS":"",
           "deltaPA":"",
           "gammaBS":"",
           "gammaPA":"",
           "vegaBS":"",    
           "vegaPA":"",
           "ccy":"BTC"
           "ts":"1620282889345"
        }
    ],
    "msg":""
}

返回参数

参数名 类型 描述
deltaBS String 美金本位账户资产delta
deltaPA String 币本位账户资产delta
gammaBS String 美金本位账户资产gamma,仅适用于期权
gammaPA String 币本位账户资产gamma,仅适用于期权
thetaBS String 美金本位账户资产theta,仅适用于期权
thetaPA String 币本位账户资产theta,仅适用于期权
vegaBS String 美金本位账户资产vega,仅适用于期权
vegaPA String 币本位账户资产vega,仅适用于期权
ccy String 币种
ts String 获取greeks的时间,Unix时间戳的毫秒数格式,如 1597026383085

子账户

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

查看子账户列表

仅适用于母账户

限速:2次/2s

限速规则:UserID

HTTP请求

GET /api/v5/users/subaccount/list

请求示例

GET /api/v5/users/subaccount/list

请求参数

参数名 类型 是否必须 描述
enable String 子账户状态,true:正常使用 false:冻结
subAcct String 子账户名称
after String 查询在此之前的内容,值为时间戳,Unix时间戳为毫秒数格式
before String 查询在此之后的内容,值为时间戳,Unix时间戳为毫秒数格式
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
       {
          "enable":true,
          "subAcct":"test-1",
          "type":"1",
          "label":"trade futures",
          "mobile":"1818181",
          "gAuth":true,
          "canTransOut": true,
          "ts":"1597026383085"
       },
       {
          "enable":false,
          "subAcct":"test-2",
          "type":"1",
          "label":"trade spot",
          "mobile":"1818199",
          "gAuth":true,
          "canTransOut": false,
          "ts":"1597026383082"
       }

    ]
}

返回参数

参数名 类型 描述
type String 子账户类型,1:普通子账户 2:托管子账户
enable Boolean 子账户状态,true:正常使用 false:冻结
subAcct String 子账户名称
label String 子账户备注
mobile String 子账户绑定手机号
gAuth String 子账户是否开启的登录时的谷歌验证 true:已开启 false:未开启
canTransOut Boolean 是否可以主动转出,false:不可转出,true:可以转出
ts String 子账户创建时间,Unix时间戳的毫秒数格式 ,如 1597026383085

获取子账户交易账户余额

获取子账户交易账户余额(适用于母账户)

限速:2次/2s

限速规则:UserID

HTTP请求

GET /api/v5/account/subaccount/balances

请求示例

GET /api/v5/account/subaccount/balances?subAcct=test1

请求参数

参数名 类型 是否必须 描述
subAcct String 子账户名称

返回结果

{
    "code": "0",
    "data": [
        {
            "adjEq": "10679688.0460531643092577",
            "details": [
                {
                    "availBal": "",
                    "availEq": "9930359.9998",
                    "cashBal": "9930359.9998",
                    "ccy": "USDT",
                    "crossLiab": "0",
                    "disEq": "9439737.0772999514",
                    "eq": "9930359.9998",
                    "eqUsd": "9933041.196999946",
                    "frozenBal": "0",
                    "interest": "0",
                    "isoEq": "0",
                    "isoLiab": "0",
                    "liab": "0",
                    "maxLoan": "10000",
                    "mgnRatio": "",
                    "notionalLever": "",
                    "ordFrozen": "0",
                    "twap": "0",
                    "uTime": "1620722938250",
                    "upl": "0",
                    "uplLiab": "0"
                },
                {
                    "availBal": "",
                    "availEq": "33.6799714158199414",
                    "cashBal": "33.2009985",
                    "ccy": "BTC",
                    "crossLiab": "0",
                    "disEq": "1239950.9687532129092577",
                    "eq": "33.771820625136023",
                    "eqUsd": "1239950.9687532129092577",
                    "frozenBal": "0.0918492093160816",
                    "interest": "0",
                    "isoEq": "0",
                    "isoLiab": "0",
                    "liab": "0",
                    "maxLoan": "1453.92289531493594",
                    "mgnRatio": "",
                    "notionalLever": "",
                    "ordFrozen": "0",
                    "twap": "0",
                    "uTime": "1620722938250",
                    "upl": "0.570822125136023",
                    "uplLiab": "0"
                }
            ],
            "imr": "3372.2942371050594217",
            "isoEq": "0",
            "mgnRatio": "70375.35408747017",
            "mmr": "134.8917694842024",
            "notionalUsd": "33722.9423710505978888",
            "ordFroz": "0",
            "totalEq": "11172992.1657531589092577",
            "uTime": "1623392334718"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
uTime String 获取账户信息的最新时间,Unix时间戳的毫秒数格式,如 1597026383085
totalEq String 美金层面权益
isoEq String 美金层面逐仓仓位权益
适用于单币种保证金模式跨币种保证金模式组合保证金模式
adjEq String 美金层面有效保证金
适用于跨币种保证金模式组合保证金模式
ordFroz String 美金层面全仓挂单占用保证金
适用于跨币种保证金模式组合保证金模式
imr String 美金层面占用保证金
适用于跨币种保证金模式组合保证金模式
mmr String 美金层面维持保证金
适用于跨币种保证金模式组合保证金模式
mgnRatio String 美金层面保证金率
适用于跨币种保证金模式组合保证金模式
notionalUsd String 以美金价值为单位的持仓数量,即仓位美金价值
适用于跨币种保证金模式组合保证金模式
details Array 各币种资产详细信息
> ccy String 币种
> eq String 币种总权益
> cashBal String 币种余额
> uTime String 币种余额信息的更新时间,Unix时间戳的毫秒数格式,如 1597026383085
> isoEq String 币种逐仓仓位权益
适用于单币种保证金模式跨币种保证金模式
> availEq String 可用保证金
适用于单币种保证金模式跨币种保证金模式
> disEq String 美金层面币种折算权益
> availBal String 可用余额
适用于简单交易模式
> frozenBal String 币种占用金额
> ordFrozen String 挂单冻结数量
> liab String 币种负债额
适用于跨币种保证金模式组合保证金模式
> upl String 未实现盈亏
适用于单币种保证金模式跨币种保证金模式组合保证金模式
> uplLiab String 由于仓位未实现亏损导致的负债
适用于跨币种保证金模式组合保证金模式
> crossLiab String 币种全仓负债额
适用于跨币种保证金模式组合保证金模式
> isoLiab String 币种逐仓负债额
适用于跨币种保证金模式组合保证金模式
> mgnRatio String 保证金率
适用于单币种保证金模式
> interest String 计息
适用于跨币种保证金模式组合保证金模式
> twap String 当前负债币种触发系统自动换币的风险
0、1、2、3、4、5其中之一,数字越大代表您的负债币种触发自动换币概率越高
适用于跨币种保证金模式组合保证金模式
> maxLoan String 币种最大可借
适用于跨币种保证金模式组合保证金模式
> eqUsd String 币种权益美金价值
> notionalLever String 币种杠杆倍数
适用于单币种保证金模式

获取子账户资金账户余额

获取子账户资金账户余额(适用于母账户)

限速:2次/2s

限速规则:UserID

HTTP请求

GET /api/v5/asset/subaccount/balances

请求示例

GET /api/v5/asset/subaccount/balances?subAcct=test1

请求参数

参数名 类型 是否必须 描述
subAcct String 子账户名称
ccy String 币种,如 BTC
支持多币种查询(不超过20个),币种之间半角逗号分隔

返回结果

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

返回参数

参数名 类型 描述
ccy String 币种,如 BTC
bal String 余额
frozenBal String 冻结(不可用)
availBal String 可用余额

查询子账户转账记录

仅适用于母账户,可以获取最近3个月的转账记录

限速:6次/s

限速规则:UserID

HTTP请求

GET /api/v5/asset/subaccount/bills

请求示例

GET /api/v5/asset/subaccount/bills

请求参数

参数名 类型 是否必须 描述
ccy String 币种,如 BTC
type String 0: 母账户转子账户 ;1 : 子账户转母账户
subAcct String 子账户名称
after String 查询在此之前的内容,值为时间戳,Unix时间戳为毫秒数格式
before String 查询在此之后的内容,值为时间戳,Unix时间戳为毫秒数格式
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
        "code": "0",
        "msg": "",
        "data": [{
                "billId": "12344",
                "type":"1",
                "ccy": "BTC",
                "amt":"2",
                "subAcct":"test-1",
                "ts":"1597026383085"
        }]
}

返回参数

参数名 类型 描述
billId String 账单ID
ccy String 账户余额币种
amt String 划转金额
type String 账单类型
subAcct String 子账户名称
ts String 子账户创建时间,Unix时间戳的毫秒数格式 ,如 1597026383085

子账户间资金划转

母账户控制子账户与子账户之间划转(仅适用于母账户)

限速:1次/s

限速规则:UserID

HTTP请求

POST /api/v5/asset/subaccount/transfer

请求示例

POST /api/v5/asset/subaccount/transfer
body
{
    "ccy":"USDT",
    "amt":"1.5",
    "from":"6",
    "to":"6",
    "fromSubAccount":"test-1",
    "toSubAccount":"test-2"
}

请求参数

参数名 类型 是否必须 描述
ccy String 币种
amt String 划转数量
from String 6:资金账户 18:交易账户
to String 6:资金账户 18:交易账户
fromSubAccount String 转出子账户的子账户名称
toSubAccount String 转入子账户的子账户名称
loanTrans Boolean 是否支持跨币种保证金模式组合保证金模式下的借币转入/转出
true 或 false,默认false

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "transId":"12345",
        }
    ]
}

返回参数

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

设置子账户主动转出权限

设置子账户转出权限(仅适用于母账户),默认可转出至母账户。

限速:1次/s

限速规则:UserID

HTTP请求

POST /api/v5/users/subaccount/set-transfer-out

请求示例

POST /api/v5/users/subaccount/set-transfer-out
body
{
    "subAcct":"test-1",
    "canTransOut":true
}

请求参数

参数名 类型 是否必须 描述
subAcct String 子账户名称,支持设置多个(不超过20个),子账户名称之间半角逗号分隔
canTransOut Boolean 是否可以主动转出,false:不可转出,true:可以转出,默认为true

返回结果

{
    "code": "0",
    "data": [
        {
            "subAcct": "test-1",
            "canTransOut": true
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
canTransOut Boolean 是否可以主动转出,false:不可转出,true:可以转出

查看被托管的子账户列表

交易团队使用该接口查看当前托管中的子账户列表

限速:1次/s

限速规则:UserID

HTTP请求

GET /api/v5/users/entrust-subaccount-list

请求示例

GET /api/v5/users/entrust-subaccount-list

请求参数

参数名 类型 是否必须 描述
subAcct String 子账户名称

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
                   {
                      "subAcct":"test-1"
                   },
                   {
                      "subAcct":"test-2"
                   }

    ]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称

网格交易

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

网格策略委托下单

限速: 20次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

HTTP请求

POST /api/v5/tradingBot/grid/order-algo

请求示例

# 现货网格下单
POST /api/v5/tradingBot/grid/order-algo
body
{
    "instId": "BTC-USDT",
    "algoOrdType": "grid",
    "maxPx": "5000",
    "minPx": "400",
    "gridNum": "10",
    "runType": "1",
    "quoteSz": "25"
}

# 合约网格下单
POST /api/v5/tradingBot/grid/order-algo
body
{
    "instId": "BTC-USDT-SWAP",
    "algoOrdType": "contract_grid",
    "maxPx": "5000",
    "minPx": "400",
    "gridNum": "10",
    "runType": "1",
    "sz": "200", 
    "direction": "long",
    "lever": "2"
}

请求参数

参数名 类型 是否必须 描述
instId String 产品ID,如BTC-USDT
algoOrdType String 订单类型
grid:现货网格委托,contract_grid:合约网格委托
maxPx String 区间最高价格
minPx String 区间最低价格
gridNum String 网格数量
runType String 网格类型
1:等差,2:等比
默认为等差
tpTriggerPx String 止盈触发价
slTriggerPx String 止损触发价
tag String 订单标签

现货网格

参数名 类型 是否必须 描述
quoteSz String 可选 计价币投入数量
quoteSzbaseSz至少指定一个
baseSz String 可选 交易币投入数量
quoteSzbaseSz至少指定一个

合约网格

参数名 类型 是否必须 描述
sz String 投入保证金,单位为USDT
direction String 合约网格类型
long:做多,short:做空,neutral:中性
lever String 杠杆倍数
basePos Boolean 是否开底仓
默认为false
中性合约网格忽略该参数

返回结果

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

返回参数

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

修改网格策略订单

只支持合约网格策略的修改

限速: 20次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

HTTP请求

POST /api/v5/tradingBot/grid/amend-order-algo

请求示例

POST /api/v5/tradingBot/grid/amend-order-algo
body
{
    "algoId":"448965992920907776",
    "instId":"BTC-USDT-SWAP",
    "slTriggerPx":"1200",
    "tpTriggerPx":""
}

请求参数

参数名 类型 是否必须 描述
algoId String 策略订单ID
instId String 产品ID,如BTC-USDT-SWAP
slTriggerPx String 可选 新的止损触发价
当值为""则代表取消止损触发价
slTriggerPxtpTriggerPx至少要传一个值
tpTriggerPx String 可选 新的止盈触发价
当值为""则代表取消止盈触发价

返回结果

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

返回参数

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

网格策略停止

限速: 20次/2s

限速规则:衍生品:UserID +(instrumentType、underlying)

限速规则:币币和币币杠杆:UserID +(instrumentType、instrumentID)

HTTP请求

POST /api/v5/tradingBot/grid/stop-order-algo

请求示例

POST /api/v5/tradingBot/grid/stop-order-algo
body
[
    {
        "algoId":"198273485",
        "instId":"BTC-USDT",
        "stopType":"1",
        "algoOrdType":"grid"
    }
]

请求参数

参数名 类型 是否必须 描述
algoId String 策略订单ID
instId String 产品ID,如BTC-USDT
algoOrdType String 订单类型
grid:现货网格委托,contract_grid:合约网格委托
stopType String 网格策略停止类型
现货网格 1:卖出计价币,2:不卖出计价币
合约网格 1:市价全平,2:停止不平仓

返回结果

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

返回参数

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

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

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/tradingBot/grid/orders-algo-pending

请求示例

GET /api/v5/tradingBot/grid/orders-algo-pending?algoOrdType=grid

请求参数

参数名 类型 是否必须 描述
algoOrdType String 订单类型
grid:现货网格委托,contract_grid:合约网格委托
algoId String 策略订单ID
instId String 产品ID,如BTC-USDT
instType String 产品类型
SPOT:币币
MARGIN:杠杆
FUTURES:交割合约
SWAP:永续合约
after String 请求此ID之前(更旧的数据)的分页内容,传的值为对应接口的algoId
before String 请求此ID之后(更新的数据)的分页内容,传的值为对应接口的algoId
limit String 返回结果的数量,默认100条

返回结果

{
    "code": "0",
    "data": [
        {
            "actualLever": "",
            "algoId": "448965992920907776",
            "algoOrdType": "grid",
            "arbitrageNum": "0",
            "basePos": false,
            "baseSz": "0",
            "cTime": "1653313834104",
            "cancelType": "0",
            "direction": "",
            "floatProfit": "-1.3320201165712",
            "gridNum": "6",
            "gridProfit": "0",
            "instId": "BTC-USDC",
            "instType": "SPOT",
            "investment": "100",
            "lever": "",
            "liqPx": "",
            "maxPx": "33444.8",
            "minPx": "24323.5",
            "pnlRatio": "0",
            "quoteSz": "100",
            "runType": "1",
            "slTriggerPx": "",
            "state": "running",
            "stopType": "",
            "sz": "",
            "tag": "",
            "totalPnl": "-1.3320201165712",
            "tpTriggerPx": "",
            "uTime": "1653347949862",
            "uly": ""
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
algoId String 策略订单ID
instType String 产品类型
instId String 产品ID
cTime String 策略订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085
uTime String 策略订单更新时间,Unix时间戳的毫秒数格式,如 1597026383085
algoOrdType String 策略订单类型
grid:现货网格
contract_grid:合约网格
state String 订单状态
starting:启动中
running:运行中
stopping:终止中
no_close_position:已停止未平仓(仅适用于合约网格)
maxPx String 区间最高价格
minPx String 区间最低价格
gridNum String 网格数量
runType String 网格类型
1:等差,2:等比
tpTriggerPx String 止盈触发价
slTriggerPx String 止损触发价
arbitrageNum String 网格套利次数
totalPnl String 总收益
pnlRatio String 收益率
investment String 投入金额
现货网格如果投入了交易币则折算为计价币
gridProfit String 网格利润
floatProfit String 浮动盈亏
cancelType String 网格策略停止原因
0:无
1:手动停止
2:止盈停止
3:止损停止
4:风控停止
5:交割停止
stopType String 网格策略停止类型
现货网格 1:卖出计价币,2:不卖出计价币
合约网格 1:市价全平,2:停止不平仓
quoteSz String 计价币投入数量
仅适用于现货网格
baseSz String 交易币投入数量
仅适用于现货网格
direction String 合约网格类型
long:做多,short:做空,neutral:中性
仅适用于合约网格
basePos Boolean 是否开底仓
仅适用于合约网格
sz String 投入保证金,单位为USDT
仅适用于合约网格
lever String 杠杆倍数
仅适用于合约网格
actualLever String 实际杠杆倍数
仅适用于合约网格
liqPx String 预估强平价格
仅适用于合约网格
uly String 标的指数
仅适用于合约网格
tag String 订单标签

获取历史网格策略委托单列表

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/tradingBot/grid/orders-algo-history

请求示例

GET /api/v5/tradingBot/grid/orders-algo-history?algoOrdType=grid

请求参数

参数名 类型 是否必须 描述
algoOrdType String 订单类型
grid:现货网格委托,contract_grid:合约网格委托
algoId String 策略订单ID
instId String 产品ID,如BTC-USDT
instType String 产品类型
SPOT:币币
MARGIN:杠杆
FUTURES:交割合约
SWAP:永续合约
after String 请求此ID之前(更旧的数据)的分页内容,传的值为对应接口的algoId
before String 请求此ID之后(更新的数据)的分页内容,传的值为对应接口的algoId
limit String 返回结果的数量,默认100条

返回结果

{
    "code": "0",
    "data": [
        {
            "actualLever": "",
            "algoId": "448965992920907776",
            "algoOrdType": "grid",
            "arbitrageNum": "0",
            "basePos": false,
            "baseSz": "0",
            "cTime": "1653313834104",
            "cancelType": "0",
            "direction": "",
            "floatProfit": "-1.3320201165712",
            "gridNum": "6",
            "gridProfit": "0",
            "instId": "BTC-USDC",
            "instType": "SPOT",
            "investment": "100",
            "lever": "",
            "liqPx": "",
            "maxPx": "33444.8",
            "minPx": "24323.5",
            "pnlRatio": "0",
            "quoteSz": "100",
            "runType": "1",
            "slTriggerPx": "",
            "state": "running",
            "stopType": "",
            "sz": "",
            "tag": "",
            "totalPnl": "-1.3320201165712",
            "tpTriggerPx": "",
            "uTime": "1653347949862",
            "uly": ""
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
algoId String 策略订单ID
instType String 产品类型
instId String 产品ID
cTime String 策略订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085
uTime String 策略订单更新时间,Unix时间戳的毫秒数格式,如 1597026383085
algoOrdType String 策略订单类型
grid:现货网格
contract_grid:合约网格
state String 订单状态
stopped:已停止
maxPx String 区间最高价格
minPx String 区间最低价格
gridNum String 网格数量
runType String 网格类型
1:等差,2:等比
tpTriggerPx String 止盈触发价
slTriggerPx String 止损触发价
arbitrageNum String 网格套利次数
totalPnl String 总收益
pnlRatio String 收益率
investment String 投入金额
现货网格如果投入了交易币则折算为计价币
gridProfit String 网格利润
floatProfit String 浮动盈亏
cancelType String 网格策略停止原因
0:无
1:手动停止
2:止盈停止
3:止损停止
4:风控停止
5:交割停止
stopType String 网格策略停止类型
现货网格 1:卖出计价币,2:不卖出计价币
合约网格 1:市价全平,2:停止不平仓
quoteSz String 计价币投入数量
仅适用于现货网格
baseSz String 交易币投入数量
仅适用于现货网格
direction String 合约网格类型
long:做多,short:做空,neutral:中性
仅适用于合约网格
basePos Boolean 是否开底仓
仅适用于合约网格
sz String 投入保证金,单位为USDT
仅适用于合约网格
lever String 杠杆倍数
仅适用于合约网格
actualLever String 实际杠杆倍数
仅适用于合约网格
liqPx String 预估强平价格
仅适用于合约网格
uly String 标的指数
仅适用于合约网格
tag String 订单标签

获取网格策略委托订单详情

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/tradingBot/grid/orders-algo-details

请求示例

GET /api/v5/tradingBot/grid/orders-algo-details?algoId=448965992920907776&algoOrdType=grid

请求参数

参数名 类型 是否必须 描述
algoOrdType String 订单类型
grid:现货网格委托,contract_grid:合约网格委托
algoId String 策略订单ID

返回结果

{
    "code": "0",
    "data": [
        {
            "actualLever": "",
            "algoId": "448965992920907776",
            "algoOrdType": "grid",
            "annualizedRate": "0",
            "arbitrageNum": "0",
            "basePos": false,
            "baseSz": "0",
            "cTime": "1653313834104",
            "cancelType": "0",
            "curBaseSz": "0.001776289214",
            "curQuoteSz": "46.801755866",
            "direction": "",
            "eq": "",
            "floatProfit": "-1.1021682922796",
            "gridNum": "6",
            "gridProfit": "0",
            "instId": "BTC-USDC",
            "instType": "SPOT",
            "investment": "100",
            "lever": "0",
            "liqPx": "",
            "maxPx": "33444.8",
            "minPx": "24323.5",
            "perMaxProfitRate": "0.060375293181491054543",
            "perMinProfitRate": "0.0455275366818586",
            "pnlRatio": "0",
            "profit": "0",
            "quoteSz": "100",
            "runType": "1",
            "runpx": "30478.1",
            "singleAmt": "0.00059261",
            "slTriggerPx": "",
            "state": "running",
            "stopResult": "0",
            "stopType": "",
            "sz": "",
            "tag": "",
            "totalAnnualizedRate": "-5.679408376687822",
            "totalPnl": "-1.1021682922796",
            "tpTriggerPx": "",
            "tradeNum": "3",
            "uTime": "1653347949862",
            "uly": ""
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
algoId String 策略订单ID
instType String 产品类型
instId String 产品ID
cTime String 策略订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085
uTime String 策略订单更新时间,Unix时间戳的毫秒数格式,如 1597026383085
algoOrdType String 策略订单类型
grid:现货网格
contract_grid:合约网格
state String 订单状态
starting:启动中
running:运行中
stopping:终止中
no_close_position:已停止未平仓(仅适用于合约网格)
stopped:已停止
maxPx String 区间最高价格
minPx String 区间最低价格
gridNum String 网格数量
runType String 网格类型
1:等差,2:等比
tpTriggerPx String 止盈触发价
slTriggerPx String 止损触发价
tradeNum String 挂单成交次数
arbitrageNum String 网格套利次数
singleAmt String 单网格买卖量
perMinProfitRate String 预期单网格最低利润率
perMaxProfitRate String 预期单网格最高利润率
runPx String 启动时价格
totalPnl String 总收益
pnlRatio String 收益率
investment String 投入金额
现货网格如果投入了交易币则折算为计价币
gridProfit String 网格利润
floatProfit String 浮动盈亏
totalAnnualizedRate String 总年化
annualizedRate String 网格年化
cancelType String 网格策略停止原因
0:无
1:手动停止
2:止盈停止
3:止损停止
4:风控停止
5:交割停止
stopType String 网格策略停止类型
现货网格 1:卖出计价币,2:不卖出计价币
合约网格 1:市价全平,2:停止不平仓
quoteSz String 计价币投入数量
仅适用于现货网格
baseSz String 交易币投入数量
仅适用于现货网格
curQuoteSz String 当前持有的计价币资产
仅适用于现货网格
curBaseSz String 当前持有的交易币资产
仅适用于现货网格
profit String 当前可提取利润,单位是计价币
仅适用于现货网格
stopResult String 现货网格策略停止结果
0:默认,1:市价卖币成功 -1:市价卖币失败
仅适用于现货网格
direction String 合约网格类型
long:做多,short:做空,neutral:中性
仅适用于合约网格
basePos Boolean 是否开底仓
仅适用于合约网格
sz String 投入保证金,单位为USDT
仅适用于合约网格
lever String 杠杆倍数
仅适用于合约网格
actualLever String 实际杠杆倍数
仅适用于合约网格
liqPx String 预估强平价格
仅适用于合约网格
uly String 标的指数
仅适用于合约网格
eq String 策略账户总权益
仅适用于合约网格
tag String 订单标签

获取网格策略委托子订单信息

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/tradingBot/grid/sub-orders

请求示例

GET /api/v5/tradingBot/grid/sub-orders?algoId=123456&type=live&algoOrdType=grid

请求参数

参数名 类型 是否必须 描述
algoId String 策略订单ID
algoOrdType String 订单类型
grid:现货网格委托,contract_grid:合约网格委托
type String 子定单状态
live:未成交,filled:已成交
groupId String 组ID
after String 请求此ID之前(更旧的数据)的分页内容,传的值为对应接口的ordId
before String 请求此ID之后(更新的数据)的分页内容,传的值为对应接口的ordId
limit String 返回结果的数量,默认100条

返回结果

{
    "code": "0",
    "data": [
        {
            "accFillSz": "0",
            "algoId": "448965992920907776",
            "algoOrdType": "grid",
            "avgPx": "0",
            "cTime": "1653347949771",
            "ccy": "",
            "ctVal": "",
            "fee": "0",
            "feeCcy": "USDC",
            "groupId": "3",
            "instId": "BTC-USDC",
            "instType": "SPOT",
            "lever": "0",
            "ordId": "449109084439187456",
            "ordType": "limit",
            "pnl": "0",
            "posSide": "net",
            "px": "30404.3",
            "side": "sell",
            "state": "live",    
            "sz": "0.00059213",
            "tdMode": "cash",
            "uTime": "1653347949831"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
algoId String 策略订单ID
instType String 产品类型
instId String 产品ID
algoOrdType String 策略订单类型
grid:现货网格
contract_grid:合约网格
groupId String 组ID
ordId String 子订单ID
cTime String 子订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085
uTime String 子订单更新时间,Unix时间戳的毫秒数格式,如 1597026383085
tdMode String 子订单交易模式
cross:全仓 isolated:逐仓 cash:非保证金
ordType String 子订单类型
market:市价单 limit:限价单
sz String 子订单委托数量
state String 子订单状态
canceled:撤单成功 live:等待成交 partially_filled:部分成交 filled:完全成交 cancelling:撤单中
side String 子订单订单方向
buy:买 sell:卖
px String 子订单委托价格
fee String 子订单手续费数量
feeCcy String 子订单手续费币种
avgPx String 子订单平均成交价格
accFillSz String 子订单累计成交数量
posSide String 子订单持仓方向
long:双向持仓多头
short:双向持仓空头
net:单向持仓
pnl String 子订单收益
ctVal String 合约面值
lever String 杠杆倍数

获取网格策略委托持仓

限速:20次/2s

限速规则:UserID

HTTP请求

GET /api/v5/tradingBot/grid/positions

请求示例

GET /api/v5/tradingBot/grid/positions?algoId=448965992920907776&algoOrdType=contract_grid

请求参数

参数名 类型 是否必须 描述
algoOrdType String 订单类型
contract_grid:合约网格委托
algoId String 策略订单ID

返回结果

{
    "code": "0",
    "data": [
        {
            "adl": "1",
            "algoId": "449327675342323712",
            "avgPx": "29215.0142857142857149",
            "cTime": "1653400065917",
            "ccy": "USDT",
            "imr": "2045.386",
            "instId": "BTC-USDT-SWAP",
            "instType": "SWAP",
            "last": "29206.7",
            "lever": "5",
            "liqPx": "661.1684795867162",
            "markPx": "29213.9",
            "mgnMode": "cross",
            "mgnRatio": "217.19370606167573",
            "mmr": "40.907720000000005",
            "notionalUsd": "10216.70307",
            "pos": "35",
            "posSide": "net",
            "uTime": "1653400066938",
            "upl": "1.674999999999818",
            "uplRatio": "0.0008190504784478"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
algoId String 策略订单ID
instType String 产品类型
instId String 产品ID
cTime String 策略订单创建时间,Unix时间戳的毫秒数格式,如 1597026383085
uTime String 策略订单更新时间,Unix时间戳的毫秒数格式,如 1597026383085
avgPx String 开仓均价
ccy String 保证金币种
lever String 杠杆倍数
liqPx String 预估强平价
posSide String 持仓方向
net:单向持仓
pos String 持仓数量
mgnMode String 保证金模式
cross:全仓
isolated:逐仓
mgnRatio String 保证金率
imr String 初始保证金
mmr String 维持保证金
upl String 未实现收益
uplRatio String 未实现收益率
last String 最新成交价
notionalUsd String 仓位美金价值
adl String 信号区
分为5档,从1到5,数字越小代表adl强度越弱
markPx String 标记价格

现货网格提取利润

限速: 20次/2s

限速规则:UserID

HTTP请求

POST /api/v5/tradingBot/grid/withdraw-income

请求示例

POST /api/v5/tradingBot/grid/withdraw-income
body
{
    "algoId":"448965992920907776"
}

请求参数

参数名 类型 是否必须 描述
algoId String 策略订单ID

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "algoId":"448965992920907776",
            "profit":"100"
        }
    ]
}

返回参数

参数名 类型 描述
algoId String 策略订单ID
profit String 提取的利润

行情数据

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

获取所有产品行情信息

获取产品行情信息

限速: 20次/2s

限速规则:IP

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

限速规则:IP

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": "56956.1",
            "lastSz": "3",
            "askPx": "56959.1",
            "askSz": "10582",
            "bidPx": "56959",
            "bidSz": "4552",
            "open24h": "55926",
            "high24h": "57641.1",
            "low24h": "54570.1",
            "volCcy24h": "81137.755",
            "vol24h": "46258703",
            "ts": "1620289117764",
            "sodUtc0": "55926",
            "sodUtc8": "55926"
        }
    ]
}

返回参数

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

限速规则:IP

HTTP请求

GET /api/v5/market/index-tickers

请求示例

GET /api/v5/market/index-tickers?instId=BTC-USDT

请求参数

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

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "instId": "BTC-USDT",
            "idxPx": "43350",
            "high24h": "43649.7",
            "sodUtc0": "43444.1",
            "open24h": "43640.8",
            "low24h": "43261.9",
            "sodUtc8": "43328.7",
            "ts": "1649419644492"
        }
    ]
}

返回参数

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

限速规则:IP

HTTP请求

GET /api/v5/market/books

请求示例

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

请求参数

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

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "asks": [
                [
                    "41006.8",
                    "0.60038921",
                    "0",
                    "1"
                ]
            ],
            "bids": [
                [
                    "41006.3",
                    "0.30178218",
                    "0",
                    "2"
                ]
            ],
            "ts": "1629966436396"
        }
    ]
}

返回参数

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

获取交易产品K线数据

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

限速: 40次/2s

限速规则:IP

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
bar String 时间粒度,默认值1m
如 [1m/3m/5m/15m/30m/1H/2H/4H]
香港时间开盘价k线:[6H/12H/1D/2D/3D/1W/1M/3M/6M/1Y]
UTC时间开盘价k线:[/6Hutc/12Hutc/1Dutc/2Dutc/3Dutc/1Wutc/1Mutc/3Mutc/6Mutc/1Yutc]
after String 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的ts
before String 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的ts
limit String 分页返回的结果集数量,最大为300,不填默认返回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

限速规则:IP

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]
香港时间开盘价k线:[6H/12H/1D/2D/3D/1W/1M/3M/6M/1Y]
UTC时间开盘价k线:[6Hutc/12Hutc/1Dutc/2Dutc/3Dutc/1Wutc/1Mutc/3Mutc/6Mutc/1Yutc]
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

限速规则:IP

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]
香港时间开盘价k线:[6H/12H/1D/1W/1M/3M/6M/1Y]
UTC时间开盘价k线:[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc/6Mutc/1Yutc]
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

限速规则:IP

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
如 [1m/3m/5m/15m/30m/1H/2H/4H]
香港时间开盘价k线:[6H/12H/1D/1W/1M/3M/6M/1Y]
UTC时间开盘价k线:[6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc/6Mutc/1Yutc]
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

限速规则:IP

HTTP请求

GET /api/v5/market/trades

请求示例

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

请求参数

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

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "instId": "BTC-USDT",
            "side": "sell",
            "sz": "0.00001",
            "px": "29963.2",
            "tradeId": "242720720",
            "ts": "1654161646974"
        },
        {
            "instId": "BTC-USDT",
            "side": "sell",
            "sz": "0.00001",
            "px": "29964.1",
            "tradeId": "242720719",
            "ts": "1654161641568"
        }
    ]
}

返回参数

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

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

查询市场上的成交信息数据,可以分页获取最近3个月的数据。

限速: 10次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/history-trades

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 产品ID,如 BTC-USDT
after String 请求此ID之前(更旧的数据)的分页内容,传的值为对应接口的 tradeId
before String 请求此ID之后(更新的数据)的分页内容,传的值为对应接口的 tradeId
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "instId": "BTC-USDT",
            "side": "sell",
            "sz": "0.00001",
            "px": "29963.2",
            "tradeId": "242720720",
            "ts": "1654161646974"
        },
        {
            "instId": "BTC-USDT",
            "side": "sell",
            "sz": "0.00001",
            "px": "29964.1",
            "tradeId": "242720719",
            "ts": "1654161641568"
        }
    ]
}

返回参数

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

获取平台24小时总成交量

24小时成交量滚动计算,以USD为计价单位,包括大宗交易。

限速: 2次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/platform-24-volume

请求示例

GET /api/v5/market/platform-24-volume

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "volUsd":"2222",
        "volCny":"14220.8",
        "ts": "1597026383085"
     }
  ]
}

返回参数

参数名 类型 描述
volUsd String 24小时平台总成交量,以美元为单位
volCny String 24小时平台总成交量,以人民币为单位
ts String 接口返回数据时间

Oracle 上链交易数据

获取使用 Open Oracle 智能合约签名后加密资产价格。

限速: 1次/5s

限速规则:IP

HTTP请求

GET /api/v5/market/open-oracle

请求示例

GET /api/v5/market/open-oracle

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "messages":[
                "0x000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000616d3b1400000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000e70528b800000000000000000000000000000000000000000000000000000000000000006707269636573000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000034254430000000000000000000000000000000000000000000000000000000000"
            ],
            "prices":{
                "BTC":"62014"
            },
            "signatures":[
                "0xf18330e59eaf42373c2c40f1f9e24113ba21d4ed734dd3ed3bc1d12290fa74ba5623fca1113c5d245a1202dc065e333615b90f810f12132ce4a1ecacb8c6b24a000000000000000000000000000000000000000000000000000000000000001b"
            ],
            "timestamp":"1634548500"
        }
    ]
}

返回参数

参数名 类型 描述
messages String 数组包含对[ kind,timestamp,key,value]进行ABI编码的值,其中kind恒等于prices,timestamp是获取价格的时间戳,key是加密资产(例如,ETH),value是资产价格
price String 价格
signatures String 每个消息的以太坊兼容ECDSA签名的数组
timestamp String 获取最新数据点的时间,Unix时间戳,如 1597026387

获取法币汇率

该接口提供的是2周的平均汇率数据

限速: 1次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/exchange-rate

请求示例

GET /api/v5/market/exchange-rate

返回结果

{
    "code": "0",
    "msg": "",
    "data": [ {
            "usdCny": "6.44"
}]
}

返回参数

参数名 类型 描述
usdCny String 人民币兑美元汇率

获取指数成分数据

查询市场上的指数成分信息数据

限速: 20次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/index-components

请求示例

GET /api/v5/market/index-components?index=BTC-USD

请求参数

参数名 类型 是否必须 描述
index String 指数,如 BTC-USDT

返回结果

{
    "code": "0",
    "msg": "",
    "data": {
        "components": [
            {
                "symbol": "BTC/USDT",
                "symPx": "52733.2",
                "wgt": "0.250",
                "cnvPx": "52733.2",
                "exch": "OKEx"
            },
            {
                "symbol": "BTC/USDT",
                "symPx": "52739.87000000",
                "wgt": "0.250",
                "cnvPx": "52739.87000000",
                "exch": "Binance"
            },
            {
                "symbol": "BTC/USDT",
                "symPx": "52729.1",
                "wgt": "0.250",
                "cnvPx": "52729.1",
                "exch": "Huobi"
            },
            {
                "symbol": "BTC/USDT",
                "symPx": "52739.47929397",
                "wgt": "0.250",
                "cnvPx": "52739.47929397",
                "exch": "Poloniex"
            }
        ],
        "last": "52735.4123234925",
        "index": "BTC-USDT",
        "ts": "1630985335599"
    }
}

返回参数

参数名 类型 描述
index String 指数名称
last String 最新指数价格
ts String 数据产生时间,Unix时间戳的毫秒数格式, 如1597026383085
components String 成分
> exch String 交易所名称
> symbol String 采集的币对名称
> symPx String 采集的币对价格
> wgt String 权重
> cnvPx String 换算成指数后的价格

获取大宗交易所有产品行情信息

获取最近24小时大宗交易量

限速: 20次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/block-tickers

请求示例

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

请求参数

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

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instType":"SWAP",
        "instId":"LTC-USD-SWAP",
        "volCcy24h":"2222",
        "vol24h":"2222",
        "ts":"1597026383085"
     },
     {
        "instType":"SWAP",
        "instId":"BTC-USD-SWAP",
        "volCcy24h":"2222",
        "vol24h":"2222",
        "ts":"1597026383085"
    }
  ]
}

返回参数

参数名 类型 描述
instId String 产品ID
instType String 产品类型
volCcy24h String 24小时成交量,以为单位
如果是衍生品合约,数值为交易货币的数量。
如果是币币/币币杠杆,数值为计价货币的数量。
vol24h String 24小时成交量,以为单位
如果是衍生品合约,数值为合约的张数。
如果是币币/币币杠杆,数值为交易货币的数量。
ts String 数据产生时间,Unix时间戳的毫秒数格式,如 1597026383085

获取大宗交易单个产品行情信息

获取最近24小时大宗交易量

限速: 20次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/block-ticker

请求示例

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

请求参数

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

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "instType":"SWAP",
        "instId":"LTC-USD-SWAP",
        "volCcy24h":"2222",
        "vol24h":"2222",
        "ts":"1597026383085"
     }
  ]
}

返回参数

参数名 类型 描述
instId String 产品ID
instType String 产品类型
volCcy24h String 24小时成交量,以为单位
如果是衍生品合约,数值为交易货币的数量。
如果是币币/币币杠杆,数值为计价货币的数量。
vol24h String 24小时成交量,以为单位
如果是衍生品合约,数值为合约的张数。
如果是币币/币币杠杆,数值为交易货币的数量。
ts String 数据产生时间,Unix时间戳的毫秒数格式,如 1597026383085

获取大宗交易公共成交数据

查询市场上的成交信息数据,根据 tradeId 倒序排序。

限速: 20次/2s

限速规则:IP

HTTP请求

GET /api/v5/market/block-trades

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 产品ID,如 BTC-USDT

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instId":"BTC-USDT-SWAP",
            "tradeId":"90167",
            "px":"42000",
            "sz":"100",
            "side":"sell",
            "ts":"1642670926504"
        }     
    ]
}

返回参数

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

公共数据

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

获取交易产品基础信息

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

限速: 20次/2s

限速规则:IP +instType

HTTP请求

GET /api/v5/public/instruments

请求示例

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

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
SPOT:币币
MARGIN:币币杠杆
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":"inverse",
        "alias":"this_week",
        "state":"live",
        "maxLmtSz":"10000",
        "maxMktSz":"99999",
        "maxTwapSz":"99999",
        "maxIcebergSz":"99999",
        "maxTriggerSz":"9999",
        "maxStopSz":"9999"
    }
  ]
}

返回参数

参数名 类型 描述
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 期权类型,CP 仅适用于期权
stk String 行权价格,仅适用于期权
listTime String 上线日期
Unix时间戳的毫秒数格式,如 1597026383085
expTime String 交割/行权日期,仅适用于交割期权
Unix时间戳的毫秒数格式,如 1597026383085
lever String instId支持的最大杠杆倍数,不适用于币币期权
tickSz String 下单价格精度,如 0.0001
lotSz String 下单数量精度,如 BTC-USDT-SWAP:1
minSz String 最小下单数量
ctType String linear:正向合约
inverse:反向合约
仅适用于交割/永续
alias String 合约日期别名
this_week:本周
next_week:次周
quarter:季度
next_quarter:次季度
仅适用于交割
state String 产品状态
live:交易中
suspend:暂停中
preopen:预上线
settlement:资金费结算
maxLmtSz String 合约或现货限价单的单笔最大委托数量
maxMktSz String 合约或现货市价单的单笔最大委托数量
maxTwapSz String 合约或现货时间加权单的单笔最大委托数量
maxIcebergSz String 合约或现货冰山委托的单笔最大委托数量
maxTriggerSz String 合约或现货计划委托委托的单笔最大委托数量
maxStopSz String 合约或现货止盈止损委托的单笔最大委托数量

获取交割和行权记录

获取3个月内的交割合约的交割记录和期权的行权记录

限速: 40次/2s

限速规则:IP +(instrumentType、uly)

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",
                    "instId":"BTC-USD-190927",
                    "px":"0.016"
                }
            ]
        },
        {
            "ts":"1597026383085",
            "details":[
                {
                    "instId":"BTC-USD-200529-6000-C",
                    "type":"exercised",
                    "px":"0.016"
                },
                {
                    "instId":"BTC-USD-200529-8000-C",
                    "type":"exercised",
                    "px":"0.016"
                }
            ]
        }
    ]
}

返回参数

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

获取持仓总量

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

限速: 20次/2s

限速规则:IP +instrumentID

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 产品类型
instId String 产品ID
oi String 持仓量(按折算)
oiCcy String 持仓量(按折算)
ts String 数据返回时间,Unix时间戳的毫秒数格式 ,如 1597026383085

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

获取当前资金费率

限速: 20次/2s

限速规则:IP +instrumentID

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",
    "data": [
        {
            "fundingRate": "0.0001515",
            "fundingTime": "1622822400000",
            "instId": "BTC-USD-SWAP",
            "instType": "SWAP",
            "nextFundingRate": "0.00029",
            "nextFundingTime": "1622851200000"
        }
    ],
    "msg": ""
}

返回参数

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

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

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

限速: 10次/2s

限速规则:IP +instrumentID

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
仅适用于永续
before String 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的fundingTime
after String 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的fundingTime
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:永续合约
instId 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-USDT-SWAP

请求参数

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

返回结果

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

返回参数

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

获取期权定价

查询期权详细信息

限速: 20次/2s

限速规则:IP +uly

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":[
      {
            "askVol": "3.7207056835937498",
            "bidVol": "0",
            "delta": "0.8310206676289528",
            "deltaBS": "0.9857332101544538",
            "fwdPx": "39016.8143629068452065",
            "gamma": "-1.1965483553276135",
            "gammaBS": "0.000011933182397798109",
            "instId": "BTC-USD-220309-33000-C",
            "instType": "OPTION",
            "lever": "0",
            "markVol": "1.5551965233045728",
            "realVol": "0",
            "theta": "-0.0014131955002093717",
            "thetaBS": "-66.03526900575946",
            "ts": "1646733631242",
            "uly": "BTC-USD",
            "vega": "0.000018173851073258973",
            "vegaBS": "0.7089307622132419"
        },
        {
            "askVol": "1.7968814062499998",
            "bidVol": "0",
            "delta": "-0.014668822072611904",
            "deltaBS": "-0.01426678984554619",
            "fwdPx": "39016.8143629068452065",
            "gamma": "0.49483062407551576",
            "gammaBS": "0.000011933182397798109",
            "instId": "BTC-USD-220309-33000-P",
            "instType": "OPTION",
            "lever": "0",
            "markVol": "1.5551965233045728",
            "realVol": "0",
            "theta": "-0.0014131955002093717",
            "thetaBS": "-54.93377294845015",
            "ts": "1646733631242",
            "uly": "BTC-USD",
            "vega": "0.000018173851073258973",
            "vegaBS": "0.7089307622132419"
        }
  ]
}

返回参数

参数名 类型 描述
instType String 产品类型
OPTION:期权
instId 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 已实现波动率(目前该字段暂未启用)
fwdPx String 远期价格
ts String 数据更新时间,Unix时间戳的毫秒数格式,如 1597026383085

获取预估交割/行权价格

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

限速: 10次/2s

限速规则:IP +instrumentID

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":"FUTURES",
        "instId":"BTC-USDT-201227",
        "settlePx":"200",
        "ts":"1597026383085"
    }
  ]
}

返回参数

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

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

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

限速: 2 次/2s

限速规则:IP

HTTP 请求

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

请求示例

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

请求参数

参数名 类型 是否必须 描述
ccy String 币种
discountLv String 折算率等级
1:第一档
2:第二档
3:第三档
4:第四档
5:第五档

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
            "amt": "1",
            "ccy": "LTC",
            "discountInfo": [
                {
                    "discountRate": "0.95",
                    "maxAmt": "2000000",
                    "minAmt": "0"
                },
                {
                    "discountRate": "0.85",
                    "maxAmt": "4000000",
                    "minAmt": "2000000"
                },
                {
                    "discountRate": "0.5",
                    "maxAmt": "8000000",
                    "minAmt": "4000000"
                },
                {
                    "discountRate": "0",
                    "maxAmt": "",
                    "minAmt": "8000000"
                }
            ],
            "discountLv": "2"
        }
  ]
}

返回参数

参数名 类型 描述
ccy String 币种
amt String 免息金额
discountLv String 折算率等级
折算率等级说明
discountInfo Array 币种折算率详情
> discountRate String 折算率
> maxAmt String 梯度区间上限(美元),“” 表示正无穷
> minAmt String 梯度区间下限(美元),最小值是0

获取系统时间

获取系统时间

限速: 10次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/time

请求示例

GET /api/v5/public/time

返回结果

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

返回参数

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

获取平台公共爆仓单信息

最近1天的爆仓单信息

限速: 2次/2s

限速规则:IP

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:已成交
默认为unfilled
交割/永续合约情况下,该参数必填
before String 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的ts
after String 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的ts
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "details": [
                {
                    "bkLoss": "0",
                    "bkPx": "",
                    "ccy": "USDT",
                    "posSide": "",
                    "side": "",
                    "sz": "989.9123170781309932",
                    "ts": "1629962347000"
                },
                {
                    "bkLoss": "0",
                    "bkPx": "",
                    "ccy": "USDT",
                    "posSide": "",
                    "side": "",
                    "sz": "10.1066764750370217",
                    "ts": "1629961447000"
                }
            ],
            "instId": "BTC-USDT",
            "instType": "MARGIN",
            "totalLoss": "0",
            "uly": ""
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
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:空
sideposSide组合方式,sell/long:强平多 ; buy/short:强平空
>bkPx String 破产价格,与系统爆仓账号委托成交的价格。
>sz String 强平数量
>bkLoss String 穿仓亏损数量
>ccy String 强平币种,仅适用于币币杠杆
>ts String 强平发生的时间,Unix时间戳的毫秒数格式,如 1597026383085

获取标记价格

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

限速: 10次/2s

限速规则:IP +instrumentID

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:期权
instId String 产品ID,如 BTC-USD-200214
markPx String 标记价格
ts String 接口数据返回时间,Unix时间戳的毫秒数格式,如1597026383085

获取衍生品仓位档位

全部仓位档位对应信息,当前最高可开杠杆倍数由您的借币持仓和保证金率决定。

限速: 10次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/position-tiers

请求示例

GET /api/v5/public/position-tiers

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
tdMode String 保证金模式
isolated:逐仓 ;cross:全仓
uly String 可选 标的指数,支持多uly,半角逗号分隔,最大不超过3个
当产品类型是 永续交割期权 之一时必填,当产品类型是 MARGIN 时忽略
instId String 可选 产品ID,支持多instId,半角逗号分隔,最大不超过5个
仅适用币币杠杆,且必填写
tier String 查指定档位

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
    {
            "baseMaxLoan": "50",
            "imr": "0.1",
            "instId": "BTC-USDT",
            "maxLever": "10",
            "maxSz": "50",
            "minSz": "0",
            "mmr": "0.03",
            "optMgnFactor": "0",
            "quoteMaxLoan": "500000",
            "tier": "1",
            "uly": ""
        }
  ]
}

返回参数

参数名 类型 描述
uly String 标的指数
instId String 币对
tier String 仓位档位
minSz String 该档位最少持仓数量 期权/永续/交割 最小持仓量 默认0
maxSz String 该档位最多持仓数量 期权/永续/交割
mmr String 维持保证金率
imr String 最低初始保证金率
maxLever String 最高可用杠杆倍数
optMgnFactor String 期权保证金系数 (仅适用于期权)
quoteMaxLoan String 计价货币 最大借币量(仅适用于杠杆),例如 BTC-USDT 里的 USDT最大借币量
baseMaxLoan String 交易货币 最大借币量(仅适用于杠杆),例如 BTC-USDT 里的 BTC最大借币量

获取市场借币杠杆利率和借币限额

限速: 2次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/interest-rate-loan-quota

请求示例

GET /api/v5/public/interest-rate-loan-quota

返回结果

{
    "code": "0",
    "data": [
        {
            "basic": [
                {
                    "ccy": "USDT",
                    "quota": "500000",
                    "rate": "0.00043728"
                },
                {
                    "ccy": "BTC",
                    "quota": "10",
                    "rate": "0.00019992"
                }
            ],
            "vip": [
                {
                    "irDiscount": "0.7",
                    "loanQuotaCoef": "6",
                    "level": "VIP1"
                },
                {
                    "irDiscount": "0.65",
                    "loanQuotaCoef": "7",
                    "level": "VIP2"
                }
            ],
            "regular": [
                {
                    "irDiscount": "1",
                    "loanQuotaCoef": "1",
                    "level": "Lv1"
                },
                {
                    "irDiscount": "0.95",
                    "loanQuotaCoef": "2",
                    "level": "Lv2"
                }
            ]
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
basic Array 基础利率和借币限额
> ccy String 币种
> rate String 基础杠杆日利率
> quota String 基础借币限额
vip Array 专业用户
> level String 账户交易手续费等级,如 VIP1
> loanQuotaCoef String 借币限额系数
> irDiscount String 利率的折扣率
regular Array 普通用户
> level String 账户交易手续费等级,如 Lv1
> loanQuotaCoef String 借币限额系数
> irDiscount String 利率的折扣率

获取尊享借币杠杆利率和借币限额

限速:2次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/vip-interest-rate-loan-quota

请求示例

GET /api/v5/public/vip-interest-rate-loan-quota

返回结果

{
    "code": "0",
    "data": [
        {
            "ccy": "ENJ",
            "levelList": [
                {
                    "level": "VIP5",
                    "loanQuota": "100000.00000000"
                },
                {
                    "level": "VIP6",
                    "loanQuota": "110000.00000000"
                },
                {
                    "level": "VIP7",
                    "loanQuota": "120000.00000000"
                },
                {
                    "level": "VIP8",
                    "loanQuota": "130000.00000000"
                }
            ],
            "quota": "10000.0000",
            "rate": "0.00048000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 币种
rate String 基础杠杆日利率
quota String 基础借币限额
levelList Array 不同VIP等级下的限额信息
> level String 用户VIP等级,如 VIP5
> loanQuota String 借币限额

获取衍生品标的指数

限速: 20次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/underlying

请求示例

GET /api/v5/public/underlying?instType=FUTURES

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
SWAP:永续合约
FUTURES:交割合约
OPTION:期权

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        [
            "LTC-USDT",
            "BTC-USDT",
            "ETC-USDT"
        ]
    ]
}

返回参数

参数名 类型 描述
uly Array 标的指数 如:BTC-USDT

获取风险准备金余额

通过该接口获取系统风险准备金余额信息

限速: 10次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/insurance-fund

请求示例

GET /api/v5/public/insurance-fund?instType=SWAP&uly=BTC-USD

请求参数

参数名 类型 是否必须 描述
instType String 产品类型
MARGIN:币币杠杆
SWAP:永续合约
FUTURES:交割合约
OPTION:期权
type String 风险准备金类型
liquidation_balance_deposit:强平注入 ;bankruptcy_loss:穿仓亏损 ;platform_revenue:平台收入注入
默认返回全部类型
uly String 标的指数, 仅适用于交割/永续/期权,且必填写
ccy String 币种, 仅适用币币杠杆,且必填写
before String 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的ts
after String 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的ts
limit String 分页返回的结果集数量,最大为100,不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "details": [
                {
                    "amt": "0.2465",
                    "balance": "3228.0732",
                    "ccy": "BTC",
                    "ts": "1646726421082",
                    "type": "liquidation_balance_deposit"
                }
            ],
            "total": "883110357.6581"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
total String 平台风险准备金总计,单位为USD
> balance String 风险准备金总量
> amt String 风险准备金更新数量
> ccy String 风险准备金总量对应的币种
> type String 风险准备金类型
> ts String 风险准备金更新时间,Unix时间戳的毫秒数格式,如 1597026383085

张币转换

由币转换为张,或者张转换为币。

限速: 10次/2s

限速规则:IP

HTTP请求

GET /api/v5/public/convert-contract-coin

请求示例

GET /api/v5/public/convert-contract-coin?instId=BTC-USD-SWAP&px=35000&sz=0.888

请求参数

参数名 类型 是否必须 描述
type String 转换类型
1: 币转张,当张为小数时,会进一取整
2: 张转币
默认为 1
instId String 产品ID,仅适用于交割/永续/期权
sz String 数量,币转张时,为币的数量,张转币时,为张的数量。
张的数量,只能是正整数
px String 可选 委托价格
币本位合约的张币转换时必填;
U本位合约,usdt 与张的转换时,必填;coin 与张的转换时,可不填;
期权的张币转换时,可不填。
unit String 币的单位,coin: 币,usdt: usdt
仅适用于交割和永续合约的U本位合约

返回结果

{
    "code": "0",
    "data": [
        {
            "instId": "BTC-USD-SWAP",
            "px": "35000",
            "sz": "311",
            "type": "1",
            "unit": "coin"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
type String 转换类型
1: 币转张,当张小数时,会进一取整
2: 张转币
instId String 产品ID
px String 委托价格
sz String 数量,张转币时,为币的数量,币转张时,为张的数量
unit String 币的单位,coin: 币,usdt: usdt

交易大数据

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

获取交易大数据支持币种

获取支持交易大数据的币种

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/trading-data/support-coin

请求示例

GET /api/v5/rubik/stat/trading-data/support-coin

返回结果

{
    "code": "0",
    "data": {
        "contract": [
            "ADA",
            "BTC",
        ],
        "option": [
            "BTC"
        ],
        "spot": [
            "ADA",
            "BTC",
        ]
    },
    "msg": ""
}

返回参数

参数名 类型 描述
contract Array 合约交易大数据接口功能支持的币种
option Array 期权交易大数据接口功能支持的币种
spot Array 现货交易大数据接口功能支持的币种

获取主动买入/卖出情况

获取taker主动买入和卖出的交易量

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/taker-volume

请求示例

GET /api/v5/rubik/stat/taker-volume?ccy=BTC&instType=SPOT

请求参数

参数名 类型 是否必须 描述
ccy String 币种
instType String 产品类型,币币:"SPOT" , 衍生品:"CONTRACTS"
begin String 开始时间,例如:1597026383085
end String 结束时间,例如:1597026383011
period String 时间粒度,默认值5m。支持[5m/1H/1D]
5m粒度最多只能查询两天之内的数据
1H粒度最多只能查询30天之内的数据
1D粒度最多只能查询180天之内的数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630425600000",
            "7596.2651",
            "7149.4855"
        ],
        [
            "1630339200000",
            "5312.7876",
            "7002.7541"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
sellVol String 卖出量
buyVol String 买入量

获取杠杆多空比

获取借入计价货币与借入交易货币的累计数额比值。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/margin/loan-ratio

请求示例

GET /api/v5/rubik/stat/margin/loan-ratio?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 币种
begin String 开始时间,例如:1597026383085
end String 结束时间,例如:1597026383011
period String 时间粒度,默认值5m。支持[5m/1H/1D]
5m粒度最多只能查询两天之内的数据
1H粒度最多只能查询30天之内的数据
1D粒度最多只能查询180天之内的数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630492800000",
            "0.4614"
        ],
        [
            "1630492500000",
            "0.5767"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
ratio String 多空比值

获取合约多空持仓人数比

获取交割永续净多头持仓用户数与净空头持仓用户数的比值。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/contracts/long-short-account-ratio

请求示例

GET /api/v5/rubik/stat/contracts/long-short-account-ratio?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 币种
begin String 开始时间,例如:1597026383085
end String 结束时间,例如:1597026383011
period String 时间粒度,默认值5m。支持[5m/1H/1D]
5m粒度最多只能查询两天之内的数据
1H粒度最多只能查询30天之内的数据
1D粒度最多只能查询180天之内的数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630502100000",
            "1.25"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
ratio String 多空人数比

获取合约持仓量及交易量

获取交割永续的持仓量和交易量。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/contracts/open-interest-volume

请求示例

GET /api/v5/rubik/stat/contracts/open-interest-volume?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 币种
begin String 开始时间,例如:1597026383085
end String 结束时间,例如:1597026383011
period String 时间粒度,默认值5m。支持[5m/1H/1D]
5m粒度最多只能查询两天之内的数据
1H粒度最多只能查询30天之内的数据
1D粒度最多只能查询180天之内的数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630502400000",
            "1713028741.6898",
            "39800873.554"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
oi String 持仓总量(USD)
vol String 交易总量(USD)

获取期权持仓量及交易量

获取期权的持仓量和交易量。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/option/open-interest-volume

请求示例

GET /api/v5/rubik/stat/option/open-interest-volume?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 币种
period String 时间粒度,默认值8H。支持[8H/1D]
每个粒度最多只能查询72条数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630368000000",
            "3458.1000",
            "78.8000"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
oi String 持仓总量(USD)
vol String 交易总量(USD)

看涨/看跌期权合约 持仓总量比/交易总量比

获取看涨期权和看跌期权的持仓量比值,以及交易量比值。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/option/open-interest-volume-ratio

请求示例

GET /api/v5/rubik/stat/option/open-interest-volume-ratio?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 币种
period String 时间粒度,默认值8H。支持[8H/1D]
每个粒度最多只能查询72条数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630512000000",
            "2.7261",
            "2.3447"
        ],
        [
            "1630425600000",
            "2.8101",
            "2.3438"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
oiRatio String 看涨/看跌 持仓总量比
volRatio String 看涨/看跌 交易总量比

看涨看跌持仓总量及交易总量(按到期日分)

获取每个到期日上看涨期权和看跌期权的持仓量和交易量。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/option/open-interest-volume-expiry

请求示例

GET /api/v5/rubik/stat/option/open-interest-volume-expiry?ccy=BTC

请求参数

参数名 类型 是否必须 描述
ccy String 币种
period String 时间粒度,默认值8H。支持[8H/1D]
每个粒度最多只能查询72条数据

返回结果

{
    "code": "0",
    "data": [
        [
            "1630540800000",
            "20210902",
            "6.4",
            "18.4",
            "0.7",
            "0.4"
        ],
        [
            "1630540800000",
            "20210903",
            "47",
            "36.6",
            "1",
            "10.7"
        ]
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 数据产生时间
expTime String 到期日(格式: YYYYMMdd,例如:"20210623")
callOI String 看涨持仓总量(以为单位)
putOI String 看跌持仓总量(以为单位)
callVolume String 看涨交易总量(以为单位)
putVolume String 看跌交易总量(以为单位)

看涨看跌持仓总量及交易总量(按执行价格分)

获取看涨期权和看跌期权的taker主动买入和卖出的交易量。

限速: 5次/2s

限速规则:IP

HTTP请求

GET /api/v5/rubik/stat/option/open-interest-volume-strike

请求示例

GET /api/v5/rubik/stat/option/open-interest-volume-strike?ccy=BTC&expTime=20210901

请求参数

参数名 类型 是否必须 描述
c