导航
English

概览

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

API学习资源与技术支持

创建我的APIKey

点击跳转至官网创建V5APIKey的页面 创建我的APIKey

实盘交易

实盘API交易地址如下：

AWS 地址如下：

模拟盘交易

目前可以进行V5 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

基本信息

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

返回数据规则如下：

交易品种instFamily参数说明：

交易时效性

由于网络延时或者OKX服务器繁忙会导致订单无法及时处理。如果您对交易时效性有较高的要求，可以灵活设置请求有效截止时间expTime以达到你的要求。

（批量）下单，（批量）改单接口请求中如果包含expTime，如果服务器当前系统时间超过expTime，则该请求不会被服务器处理。

你应跟我们服务器系统时间同步。请用获取系统时间来获取系统时间。

REST

请求头中设置如下参数

参数名 类型 是否必须 描述
expTime String 否 请求有效截止时间。Unix时间戳的毫秒数格式，如 1597026383085

目前支持如下接口：

请求示例

curl -X 'POST' \
  'https://www.okx.com/api/v5/trade/order' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'OK-ACCESS-KEY: *****' \
  -H 'OK-ACCESS-SIGN: *****'' \
  -H 'OK-ACCESS-TIMESTAMP: *****'' \
  -H 'OK-ACCESS-PASSPHRASE: *****'' \
  -H 'expTime: 1597026383085' \   // 有效截止时间
  -d '{
  "instId": "BTC-USDT",
  "tdMode": "cash",
  "side": "buy",
  "ordType": "limit",
  "px": "1000",
  "sz": "0.01"
}'

WebSocket

请求中设置如下参数

参数名 类型 是否必须 描述
expTime String 否 请求有效截止时间。Unix时间戳的毫秒数格式，如 1597026383085

目前支持如下接口：

请求示例

{
    "id": "1512",
    "op": "order",
    "expTime":"1597026383085",  // 有效截止时间
    "args": [{
        "side": "buy",
        "instId": "BTC-USDT",
        "tdMode": "isolated",
        "ordType": "market",
        "sz": "100"
    }]
}

限速

我们的 REST 和 WebSocket API 使用限速来保护我们的 API 免受恶意使用，因此我们的交易平台可以可靠和公平地运行。
当请求因限速而被我们的系统拒绝时，系统会返回错误代码 50011（用户请求频率过快，超过该接口允许的限额。请参考 API 文档并限制请求）。
每个接口的限速都不同。 您可以从接口详细信息中找到每个接口的限制。 限速定义详述如下：

对于与交易相关的 API（下订单、取消订单和修改订单），以下条件适用：

最佳实践

如果您需要的请求速率高于我们的限速，您可以设置不同的子账户来批量请求限速。 我们建议使用此方法来限制或间隔请求，以最大化每个帐户的限速并避免断开连接或拒绝请求。

做市商申请

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

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

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

交互式浏览器

使用说明

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

立即体验 交互式浏览器

大宗交易

大宗交易工作流程

大宗交易时指在非公开市场进行的、私下议定的、满足规定最小交易手数的期货、期权、交割、永续或混合产品的大单交易。 交易细节一经确认，此笔交易会被提交到OKX以进行保证金计算，清算和执行。

基本概念

  1. 询价单（RFQs） - 询价单，由询价方发给报价方. 询价单包括询价方希望交易的一种或多种产品及其数量。
  2. 报价单 - 报价单，由报价方发给询价方对询价单的报价。
  3. 交易 - 当询价方接受并执行报价方的报价单，一笔交易就由此产生。

基本工作流程

要以询价方或报价方身份进行交易，用户需要在交易账户中存入至少100,000美元。 此外，要成为报价方请填写表格以访问大宗交易.

  1. 询价方创建一个询价单（RFQ），并选择希望收到此询价单的报价方。 
  2. 不同报价方发送报价单回应此询价单。
  3. 询价方选择执行最好的报价单产生交易。OKX收到此笔交易并做结算。
  4. 询价方和报价方收到交易执行的确认。
  5. 交易详情发布在公共市场数据频道上（不包含交易方信息）。

询价方角度

  1. 询价方使用POST /api/v5/rfq/create-rfq创建询价单。询价方可以可通过GET /api/v5/public/instruments查询可询价产品信息，即通过GET /api/v5/rfq/counterparties查询可选择报价方信息。
  2. 询价方可以在询价单有效时任何时候通过POST /api/v5/rfq/cancel-rfq取消询价单。
  3. 报价方，如果是询价方选择的报价方之一，会在rfqs推送频道收到询价单信息，并可作出相应报价。
  4. 询价方，在quotes推送频道收到报价信息后，可以选择最优报价并通过POST /api/v5/rfq/execute-quote执行。
  5. 询价方会在struc-block-trades和rfqs推送频道收到交易成功执行确认。
  6. 询价方也会在public-struc-block-trades推送频道收到此笔交易以及其他OKX大宗交易的确认信息。

报价方角度

  1. 当有一个新的询价单发出，并且报价方是被选择的报价方之一时，报价方会在rfqs推送频道接收到此询价单信息。
  2. 报价方创建一个单向或者双向的报价单并通过POST /api/v5/rfq/create-quote发出。
  3. 报价方可以通过POST /api/v5/rfq/cancel-quote任意取消一个有效的报价单。
  4. 询价方选择执行最优报价单。
  5. 报价方通过quotes推送频道接收他们报价单的状态更新。
  6. 报价方会在struc-block-trades和quotes推送频道收到他们报价单的交易成功执行确认。
  7. 报价方也会在public-struc-block-trades推送频道收到此笔交易以及其他OKX大宗交易的确认信息。

REST API

获取报价方信息

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

限速: 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" : "" 
        }
    ]
}

响应参数

参数名 类型 描述
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"
    ],
    "allowPartialExecution":false,
    "clRfqId":"rfq01",
    "tag":"123456",
    "legs":[
        {
            "sz":"25",
            "side":"buy",
            "posSide": "long",
            "tdMode":"cross",
            "ccy":"USDT",
            "instId":"BTCUSD-221208-100000-C"
        },
        {
            "sz":"150",
            "side":"buy",
            "posSide": "long",
            "tdMode":"cross",
            "ccy":"USDT",
            "instId":"ETH-USDT",
            "tgtCcy":"base_ccy"
        }
    ]
}

请求参数

参数名 类型 是否必须 描述
counterparties Array of strings 是 希望收到询价的报价方列表，可通过/api/v5/rfq/counterparties/获取。
anonymous Boolean 否 是否匿名询价，true表示匿名询价，false表示公开询价，默认值为 false，为true时，即使在交易执行之后，身份也不会透露给报价方。
clRfqId String 否 询价单自定义ID，字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
tag String 否 询价单标签，与此询价单关联的大宗交易将有相同的标签。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。
allowPartialExecution Boolean 否 RFQ是否可以被部分执行，如果腿的比例和原RFQ一致。有效值为true或false。默认为false。
legs Array of objects 是 组合交易，每次最多可以提交15组交易信息
> instId String 是 产品ID
> tdMode String 否 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
> ccy String 否 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
> sz String 是 委托数量
> side String 是 询价单方向
> posSide String 否 持仓方向
买卖模式下默认为net。在开平仓模式下仅可选择long或short。
如未指定，则处于开平仓模式下的用户始终会开新仓位。
仅适用交割、永续。
> tgtCcy String 否 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "cTime":"1611033737572",
            "uTime":"1611033737572",
            "traderCode":"SATOSHI",
            "tag":"123456",
            "rfqId":"22534",
            "clRfqId":"rfq01",
            "allowPartialExecution":false,
            "state":"active",
            "validUntil":"1611033857557",
            "counterparties":[
                "Trader1",
                "Trader2"
            ],
            "legs":[
                {
                    "instId":"BTCUSD-221208-100000-C",
                    "sz":"25",
                    "side":"buy",
                    "posSide": "long",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "tgtCcy":""
                },
                {
                    "instId":"ETH-USDT",
                    "sz":"150",
                    "side":"buy",
                    "posSide": "long",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "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 仅适用于报价方
> counterparties Array of strings 报价方列表
> validUntil String 询价单的过期时间，Unix时间戳的毫秒数格式。
> clRfqId String 询价单自定义ID，为客户端敏感信息，不会公开，对报价方返回""。
> tag String RFQ标签，与此RFQ关联的大宗交易将有相同的标签。
> allowPartialExecution Boolean RFQ是否可以被部分执行，如果腿的比例和原RFQ一致。有效值为true或false。未指定时，默认为false。
> traderCode String 询价方唯一标识代码。
> rfqId String 询价单ID
> legs Array of objects 组合交易，每个请求最多可放置15条腿
>> instId String 产品ID，例如："BTC-USDT-SWAP"
>> tdMode String 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
>> ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
>> sz String 委托数量
>> side String 询价单方向
有效值为buy和sell。
>> posSide String 持仓方向
买卖模式下默认为net。如未指定，则返回""，相当于net。
在开平仓模式下仅可选择long或short。 如未指定，则返回""，对应于为交易开新仓位的方向（买入=>long，卖出=>short）。
仅适用交割、永续。
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

取消询价单

取消一个询价单。

限速: 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 strings 可选 询价单IDs
clRfqIds Array of strings 可选 询价单自定义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",
    "legs":[
    {
        "sz":"25",
        "instId":"BTC-USD-20220114-13250-C"
    },
    {
        "sz":"25",
        "instId":"BTC-USDT"
    }
     ]
}

请求参数

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

响应示例

{  
   "code":"0",
   "msg":"",
   "data":[
       {
            "blockTdId":"180184",
            "rfqId":"1419",
            "clRfqId":"r0001",
            "quoteId":"1046",
            "clQuoteId":"q0001",
            "tag":"123456",
            "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
> tag String 报价单标签，与此报价单关联的大宗交易将有相同的标签。
> 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.

获取可报价产品

用于maker查询特定的接受询价和报价的产品, 以及数量和价格范围。

限速: 5次/2s

限速规则：UserID

HTTP Requests

GET /api/v5/rfq/maker-instrument-settings

请求示例

GET /api/v5/rfq/maker-instrument-settings

请求参数

无

返回示例

{
    "code": "0",
    "msg": "",
    "data":
        [
            {"instType": "OPTION",
             "includeALL": true,
             "data":
                [
                {    
                    "uly": "BTC-USD",
                    "maxBlockSz": "10000",
                    "makerPxBand": "5"
                    },
                {
                    "uly": "SOL-USD",
                    "maxBlockSz": "100000",
                    "makerPxBand": "15"
                    }
                ]
            },
            {"instType": "FUTURES",
             "includeALL": false,
             "data":
                [
                {
                    "uly": "BTC-USD",
                    "maxBlockSz": "10000",
                    "makerPxBand": "5"
                },
                {
                    "uly": "ETH-USDT",
                    "maxBlockSz": "100000",
                    "makerPxBand": "15"
                }
                ]
            },
            {"instType:": "SWAP",
             "includeALL": false,
             "data":
                [{
                    "uly": "BTC-USD",
                    "maxBlockSz": "10000",
                    "makerPxBand": "5"
                    },
                {
                    "uly": "ETH-USDT"
                    }
                ]
            },
                {"instType:": "SPOT",
                 "includeALL": false,
                 "data":
                    [{
                        "instId": "BTC-USDT"
                        },
                    {
                        "instId": "TRX-USDT"
                        }
                    ]

        ]
    }

返回参数

参数名 类型 描述
code String 结果代码，0 表示成功
msg String 错误信息，如果代码不为0，则不为空
data Array of objects 请求返回值，包含请求结果
instType String 产品类别，枚举值包括FUTURES,OPTION,SWAP和SPOT
includeAll Boolean 是否接收该instType下所有产品。有效值为true或false。默认false。
> data Array of objects instType的元素
>> instFamily String 交易品种
交割/永续/期权情况下必填
>> instId String 产品ID，如 BTC-USDT。对SPOT产品类别有效且必须。
>> maxBlockSz String 该种产品最大可交易数量。FUTURES, OPTION and SWAP 的单位是合约数量。SPOT的单位是交易货币。
>> makerPxBand String 价格限制以价格精度tick为单位，以标记价格为基准。
设置makerPxBand为1个tick代表:
如果买一价 > 标记价格 + 1 tick, 操作将被拦截
如果 买一价 < 标记价格 - 1 tick, 操作将被拦截

设置可报价产品

用于maker设置特定的接受询价和报价的产品, 以及数量和价格范围。

限速: 5次/2s

限速规则：UserID

HTTP Requests

POST /api/v5/rfq/maker-instrument-settings

请求示例

POST /api/v5/rfq/maker-instrument-settings
[
    {
     "instType": "OPTION",
     "data":
        [{
            "instFamily": "BTC-USD",
            "maxBlockSz": "10000",
            "makerPxBand": "5"
        },
        {
            "instFamily": "SOL-USD",
            "maxBlockSz": "100000",
            "makerPxBand": "15"
        }]
    },
    {
     "instType": "FUTURES",
     "data":
        [{
            "instFamily": "BTC-USD",
            "maxBlockSz": "10000",
            "makerPxBand": "5"
        },
        {
            "instFamily": "ETH-USDT",
            "maxBlockSz": "100000",
            "makerPxBand": "15"
        }]
    },
    {
     "instType": "SWAP",
     "data":
        [{
            "instFamily": "BTC-USD",
            "maxBlockSz": "10000",
            "makerPxBand": "5"
         },
        {
            "instFamily": "ETH-USDT"
        }]
    },
    {
    "instType": "SPOT",
     "data":
        [{
            "instId": "BTC-USDT"
         },
        {
            "instId": "TRX-USDT"
        }]
    }
]

请求参数

参数名 类型 是否必须 描述
instType String 是 产品类别，枚举值包括FUTURES,OPTION,SWAP和SPOT
includeAll Boolean 否 是否接收该instType下所有产品。有效值为true或false。默认false。
data Array of objects 是 instType的元素
> instFamily String 可选 交易品种
交割/永续/期权情况下必填
> instId String 可选 产品ID，如 BTC-USDT。对SPOT产品类别有效且必须。
> maxBlockSz String 否 该种产品最大可交易数量。FUTURES, OPTION and SWAP 的单位是合约数量。SPOT的单位是交易货币。
> makerPxBand String 否 价格限制以价格精度tick为单位，以标记价格为基准。
设置makerPxBand为1个tick代表:
如果买一价 > 标记价格 + 1 tick, 操作将被拦截
如果 买一价 < 标记价格 - 1 tick, 操作将被拦截

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "result":true
        }
    ]
}

返回参数

参数名 类型 描述
code String 结果代码，0 表示成功
msg String 错误信息，如果代码不为0，则不为空
data Array of objects 请求返回值，包含请求结果
> result Boolean 请求结果，枚举值为true,false

重设MMP状态

重设MMP状态为无效。

限速: 5次/2s

限速规则：UserID

HTTP Requests

POST /api/v5/rfq/mmp-reset

请求示例

POST /api/v5/rfq/mmp-reset

请求参数

None

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

返回参数

参数名 类型 描述
code String 结果代码，0 表示成功
msg String 错误信息，如果代码不为0，则不为空
data Array of objects 请求返回值，包含请求结果
ts String 重设时间. Unix 时间戳的毫秒数格式，如 1597026383085.

报价

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

限速: 50次/2s

限速规则：UserID

HTTP Requests

POST /api/v5/rfq/create-quote

请求示例

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

请求参数

参数名 类型 是否必须 描述
rfqId String 是 询价单ID
clQuoteId String 否 报价单自定义ID
tag String 否 报价单标签，与此报价单关联的大宗交易将有相同的标签。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。
anonymous Boolean 否 是否匿名报价，true表示匿名报价，false表示公开报价，默认值为false，为true时，即使在交易执行之后，身份也不会透露给询价方。
quoteSide String 是 报价单方向，buy或者sell。当报价单方向为buy，对maker来说，执行方向与legs里的方向相同，对taker来说相反。反之同理
expiresIn String 否 报价单的有效时长（以秒为单位）。 10到120之间的任何整数。 默认值为60
legs Array of objects 是 组合交易
> instId String 是 产品ID
> tdMode String 否 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
> ccy String 否 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
> sz String 是 委托数量
> px String 是 委托价格
> side String 是 报价单方向
> posSide String 否 持仓方向
买卖模式下默认为net。在开平仓模式下仅可选择long或short。
如未指定，则处于开平仓模式下的用户始终会开新仓位。
仅适用交割、永续。
> tgtCcy String 否 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

返回示例

{
    "code":"",
    "msg":"",
    "data":[
        {
            "validUntil":"1608997227834",
            "uTime":"1608267227834",
            "cTime":"1608267227834",
            "legs":[
                {
                    "px":"46000",
                    "sz":"25",
                    "instId":"BTC-USD-220114-25000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side":"sell",
                    "posSide": "long",
                    "tgtCcy":""
                },
                {
                    "px":"4000",
                    "sz":"25",
                    "instId":"ETH-USD-220114-25000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side":"buy",
                    "posSide": "long",
                    "tgtCcy":""
                }
            ],
            "quoteId":"25092",
            "rfqId":"18753",
            "tag":"123456",
            "quoteSide":"sell",
            "state":"active",
            "reason": "mmp_canceled"
            "clQuoteId":"",
            "clRfqId":"",
            "traderCode":"Aksha"
        }
    ]
}

返回参数

参数名 类型 描述
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
> reason String 状态原因. 有效值包括 mmp_canceled.
> validUntil String 报价单的过期时间，Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID，为客户敏感信息，不会公开，对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID，为客户敏感信息，不会公开，对询价方返回""。
> tag String 报价单标签，与此报价单关联的大宗交易将有相同的标签。
> traderCode String 报价方唯一标识代码。
> quoteSide String 报价单方向，有效值为buy或者sell。当报价单方向为buy，对maker来说，执行方向与legs里的方向相同，对taker来说相反。反之同理。
> legs Array of objects 组合交易
>> instId String 产品ID
>> tdMode String 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
>> ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
>> sz String 委托数量
>> px String 委托价格
>> side String 腿的方向，有效值为buy或者sell。
>> posSide String 持仓方向
买卖模式下默认为net。如未指定，则返回""，相当于net。
在开平仓模式下仅可选择long或short。 如未指定，则返回""，对应于为交易开新仓位的方向（买入=>long，卖出=>short）。
仅适用交割、永续。
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

取消报价单

取消一个报价单。

限速: 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 为准。
rfqId String 否 询价单ID

返回示例

{
    "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 strings 可选 报价单ID
clQuoteIds Array of strings 可选 报价单自定义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 succeeded.",
    "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

请求示例

GET /api/v5/rfq/rfqs

请求参数

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

返回示例

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "rfqId": "123456",
            "clRfqId": "",
            "tag": "123456",
            "traderCode": "VITALIK",
            "validUntil": "1650969031817",
            "allowPartialExecution": false,
            "state": "filled",
            "counterparties": [
                "SATOSHI"
            ],
            "legs": [
                {
                    "instId": "BTC-USDT",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side": "buy",
                    "posSide": "long",
                    "sz": "25",
                    "tgtCcy": "base_ccy"
                }
            ],
            "cTime": "1650968131817",
            "uTime": "1650968164944"
        },
        {
            "rfqId": "1234567",
            "clRfqId": "",
            "tag": "1234567",
            "traderCode": "VITALIK",
            "validUntil": "1650967623729",
            "state": "filled",
            "counterparties": [
                "SATOSHI"
            ],
            "legs": [
                {
                    "instId": "BTC-USDT",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side": "buy",
                    "posSide": "long",
                    "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 failed traded_away
traded_away 仅适用于报价方
> counterparties Array of srings 报价方列表
> validUntil String 询价单的过期时间，Unix时间戳的毫秒数格式。
> clRfqId String 询价单自定义ID，为客户敏感信息，不会公开，对报价方返回""。
> tag String 询价单标签，与此询价单关联的大宗交易将有相同的标签。
> traderCode String 询价方唯一标识代码，询价时 anonymous 设置为 true 时不可见
> rfqId String 询价单ID
> allowPartialExecution Boolean RFQ是否可以被部分执行，如果腿的比例和原RFQ一致。有效值为true或false。未指定时，默认为false。
> legs Array of objects 组合交易，每个请求最多可放置15条腿
>> instId String 产品ID，例如："BTC-USDT-SWAP"
>> tdMode String 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
>> ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
>> sz String 委托数量
>> side String 询价单方向
有效值为buy和sell。
>> posSide String 持仓方向
买卖模式下默认为net。如未指定，则返回""，相当于net。
在开平仓模式下仅可选择long或short。 如未指定，则返回""，对应于为交易开新仓位的方向（买入=>long，卖出=>short）。
仅适用交割、永续。
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

获取报价单信息

获取用户发出的或收到的报价单信息

限速: 2次/2s

限速规则：UserID

HTTP Requests

GET /api/v5/rfq/quotes

请求示例

GET /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，默认100条

返回示例

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "validUntil":"1608997227834",
            "uTime":"1608267227834",
            "cTime":"1608267227834",
            "legs":[
                {
                    "px":"46000",
                    "sz":"25",
                    "instId":"BTC-USD-220114-25000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side":"sell",
                    "posSide": "long",
                    "tgtCcy":""
                },
                {
                    "px":"45000",
                    "sz":"25",
                    "instId":"BTC-USDT",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side":"buy",
                    "posSide": "long",
                    "tgtCcy":"base_ccy"
                }
            ],
            "quoteId":"25092",
            "rfqId":"18753",
            "quoteSide":"sell",
            "state":"canceled",
            "reason":"mmp_canceled",
            "clQuoteId":"cq001",
            "clRfqId":"cr001",
            "tag":"123456",
            "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
> reason String 状态原因. 有效值包括 mmp_canceled.
> validUntil String 报价单的过期时间，Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID，为客户敏感信息，不会公开，对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID，为客户敏感信息，不会公开，对询价方返回""。
> tag String 报价单标签，与此报价单关联的大宗交易将有相同的标签。
> traderCode String 报价方唯一标识代码，报价时 Anonymous 设置为 True 时不可见。
> quoteSide String 报价单方向，buy或者sell。当报价单方向为buy，对maker来说，执行方向与legs里的方向相同，对taker来说相反。反之同理
> legs Array of objects 组合交易
>> instId String 产品ID
>> tdMode String 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
>> ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
>> sz String 委托数量
>> px String 委托价格.
>> side String 报价单方向
>> posSide String 持仓方向
买卖模式下默认为net。如未指定，则返回""，相当于net。
在开平仓模式下仅可选择long或short。 如未指定，则返回""，对应于为交易开新仓位的方向（买入=>long，卖出=>short）。
仅适用交割、永续。
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

获取大宗交易信息

获取该用户大宗交易成交信息

限速: 5次/2s

限速规则：UserID

HTTP Requests

GET /api/v5/rfq/trades

请求示例

GET /api/v5/rfq/trades

请求参数

参数名 类型 是否必须 描述
rfqId String 否 询价单ID
clRfqId String 否 由用户设置的询价单ID. 如果 clRfqId 和 rfqId 都通过了，rfqId 将被视为主要
quoteId String 否 报价单ID
blockTdId String 否 大宗交易ID
clQuoteId String 否 由用户设置的报价单ID。如果同时传递了 clQuoteId 和 quoteId，则 quoteId 将被视为主要标识符
state String 否 询价单的状态
active canceled pending_fill filled expired failed traded_away
traded_away 仅适用于报价方
beginId String 否 请求的起始大宗交易ID，请求此ID之后（更新的数据）的分页内容，不包括 beginId
endId String 否 请求的结束大宗交易ID，请求此ID之前（更旧的数据）的分页内容，不包括 endId
beginTs String 否 用开始时间戳筛选交易执行时间（UTC时区）。Unix时间戳的毫秒数格式，例如 1597026383085。
endTs String 否 用结束时间戳筛选交易执行时间（UTC时区）。Unix时间戳的毫秒数格式，例如 1597026383085。
limit String 否 返回结果的数量，最大为100，默认100条。
如果请求范围内的交易数量大于100，则返回该范围内最近的100笔交易。

返回示例

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "rfqId": "123456",
            "clRfqId": "",
            "quoteId": "0T5342O",
            "clQuoteId": "",
            "blockTdId": "439127542058958848",
            "tag": "123456",
            "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
> tag String 交易标签，大宗交易将有与其对应的询价单或报价单相同的标签。
> 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

请求示例

GET /api/v5/rfq/public-trades

请求参数

参数名 类型 是否必须 描述
beginId String 否 请求的起始大宗交易ID，请求此ID之后（更新的数据）的分页内容，不包括 beginId
endId String 否 请求的结束大宗交易ID，请求此ID之前（更旧的数据）的分页内容，不包括 endId
limit String 否 返回结果的数量，最大为100，默认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 询价单方向，从 Taker的视角看
>> tradeId String 最新成交ID

WebSocket 私有频道

询价频道

获取用户自身发送或接收的询价信息。每当用户自身发送或接收询价时，数据都将被推送。

请求示例

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

请求参数

参数名 类型 是否必填 描述
op String 是 操作, subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名, rfqs

成功返回示例 

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

失败返回示例

{
  "event": "error",
  "code": "60012",
  "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"rfqs\"}]}"
}

返回参数

参数名 类型 是否必填 描述
event String 是 操作, subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名, rfqs
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg":{
        "channel":"rfqs",
        "uid": "77982378738415879"
    },
    "data":[
        {
            "cTime":"1611033737572",
            "uTime":"1611033737572",
            "traderCode":"DSK2",
            "rfqId":"22534",
            "clRfqId":"",
            "tag":"123456",
            "state":"active",
            "validUntil":"1611033857557",
            "allowPartialExecution": false,
            "counterparties":[
                "DSK4",
                "DSK5"
            ],
            "legs":[
                {
                    "instId":"BTCUSD-211208-36000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "sz":"25.0",
                    "side":"buy",
                    "posSide": "long",
                    "tgtCcy":""
                },
                {
                    "instId":"ETHUSD-211208-45000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "sz":"25.0",
                    "side":"sell",
                    "posSide": "long",
                    "tgtCcy":""
                }
            ]
        }
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> uid String 用户标识
data Array 订阅的数据
> cTime String 询价单创建时间，Unix时间戳的毫秒数格式。
> uTime String 询价单状态更新时间，Unix时间戳的毫秒数格式。
> state String 询价单的状态
有效值为 active canceled filled expired or failed
> counterparties Array of Strings 报价方列表
> validUntil String 询价单的过期时间，Unix时间戳的毫秒数格式。
> clRfqId String 询价单自定义ID，为客户敏感信息，不会公开，对报价方返回""。
> tag String 询价单标签，与此询价单关联的大宗交易将有相同的标签。
> traderCode String 询价方唯一标识代码，询价时 Anonymous 设置为 True 时不可见
> rfqId String 询价单ID
> allowPartialExecution Boolean RFQ是否可以被部分执行，如果腿的比例和原RFQ一致。>有效值为true或false。
> legs Array of objects 组合交易
>> instId String 产品ID
>> tdMode String 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
>> ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
>> sz String 委托数量
>> side String 询价单方向
>> posSide String 持仓方向
买卖模式下默认为net。如未指定，则返回""，相当于net。
在开平仓模式下仅可选择long或short。 如未指定，则返回""，对应于为交易开新仓位的方向（买入=>long，卖出=>short）。
仅适用交割、永续。
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

报价频道

获取用户自身发送或接收的报价信息。每当用户自身发送或接收报价时，数据都将被推送。

请求示例

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

请求参数

参数名 类型 是否必填 描述
op String 是 操作, subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名, quotes

成功返回示例

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

失败返回示例

{
  "event": "error",
  "code": "60012",
  "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"quotes\"}]}"
}

返回参数

参数名 类型 是否必填 描述
event String 是 操作, subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名, quotes
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg":{
        "channel":"quotes",
        "uid": "77982378738415879"
    },
    "data":[
        {
            "validUntil":"1608997227854",
            "uTime":"1608267227834",
            "cTime":"1608267227834",
            "legs":[
                {
                    "px":"0.0023",
                    "sz":"25.0",
                    "instId":"BTC-USD-220114-25000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side":"sell",
                    "posSide": "long",
                    "tgtCcy":""

                },
                {
                    "px":"0.0045",
                    "sz":"25",
                    "instId":"BTC-USD-220114-35000-C",
                    "tdMode":"cross",
                    "ccy":"USDT",
                    "side":"buy",
                    "posSide": "long",
                    "tgtCcy":""

                }
            ],
            "quoteId":"25092",
            "rfqId":"18753",
            "tag":"123456",
            "traderCode":"SATS",
            "quoteSide":"sell",
            "state":"canceled",
            "reason":"mmp_canceled",
            "clQuoteId":""
        }
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> uid String 账户ID，账户uid和app上的一致
data Array 订阅的数据
> cTime String 报价单创建时间，Unix时间戳的毫秒数格式。
> uTime String 报价单状态更新时间，Unix时间戳的毫秒数格式。
> state String 报价单的状态
有效值为 active canceled filled expired failed
> reason String 状态原因,有效值包括mmp_canceled
> validUntil String 报价单的过期时间，Unix时间戳的毫秒数格式。
> rfqId String 询价单ID
> clRfqId String 询价单自定义ID，为客户敏感信息，不会公开，对报价方返回""。
> quoteId String 报价单ID
> clQuoteId String 报价单自定义ID，为客户敏感信息，不会公开，对询价方返回""。
> tag String 报价单标签，与此报价单关联的大宗交易将有相同的标签。
> traderCode String 报价方唯一标识代码，报价时 Anonymous 设置为 True 时不可见。
> quoteSide String 报价单方向，buy或者sell。当报价单方向为buy，对maker来说，执行方向与legs里的方向相同，对taker来说相反。反之同理。
> legs Array of objects 组合交易
>> instId String 产品ID
>> tdMode String 交易模式
保证金模式：cross全仓 isolated逐仓
非保证金模式：cash非保证金.
如未提供，tdMode 将继承系统设置的默认值：
单币种保证金模式 & 现货: cash
单币种保证金和多币种保证金模式下买入期权： isolated
其他情况: cross
>> ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
在其他情况下该参数将被忽略。
>> sz String 委托数量
>> px String 委托价格
>> side String 报价单方向
>> posSide String 持仓方向
买卖模式下默认为net。如未指定，则返回""，相当于net。
在开平仓模式下仅可选择long或short。 如未指定，则返回""，对应于为交易开新仓位的方向（买入=>long，卖出=>short）。
仅适用交割、永续。
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。

大宗交易频道

获取用户自身的大宗交易信息。同一大宗交易中的所有腿都包含在同一更新中。只要用户自身作为交易对手进行大宗交易，数据都将被推送。

请求示例

{
  "op": "subscribe",
  "args": [
    {
      "channel": "struc-block-trades"
    }
  ]
}

请求参数

参数名 类型 是否必填 描述
op String 是 操作, subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名, struc-block-trades

成功返回示例

{
  "event": "subscribe",
  "arg": {
    "channel": "struc-block-trades"
  }
}

失败返回示例

{
  "event": "error",
  "code": "60012",
  "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"struc-block-trades\""}]}"
}

返回参数

参数名 类型 是否必填 描述
event String 是 操作, subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名, struc-block-trades
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg":{
        "channel":"struc-block-trades",
        "uid": "77982378738415879"
    },
    "data":[
        {
            "cTime":"1608267227834",
            "rfqId":"18753",
            "clRfqId":"",
            "quoteId":"25092",
            "clQuoteId":"",
            "blockTdId":"180184",
            "tag":"123456",
            "tTraderCode":"ANAND",
            "mTraderCode":"WAGMI",
            "legs":[
                {
                    "px":"0.0023",
                    "sz":"25.0",
                    "instId":"BTC-USD-20220630-60000-C",
                    "side":"sell",
                    "fee":"0.1001",
                    "feeCcy":"BTC",
                    "tradeId":"10211",
                    "tgtCcy":""

                },
                {
                    "px":"0.0033",
                    "sz":"25",
                    "instId":"BTC-USD-20220630-50000-C",
                    "side":"buy",
                    "fee":"0.1001",
                    "feeCcy":"BTC",
                    "tradeId":"10212",
                    "tgtCcy":""

                }
            ]
        }
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> uid String 用户标识
data Array 订阅的数据
> cTime String 执行创建的时间戳，Unix 时间戳格式，以毫秒为单位。
> rfqId String RFQ ID.
> clRfqId String 由用户设置的 RFQ ID。 此属性被视为客户端敏感信息。 不会暴露给 Maker，只返回空字符串“”给 Maker。
> quoteId String Quote ID.
> clQuoteId String 由用户设置的 Quote ID。 此属性被视为客户端敏感信息。 不会暴露给 Taker，只为 Taker 返回空字符串“”。
> blockTdId String 大宗交易ID
> tag String 交易标签，大宗交易将有与其对应的询价单或报价单相同的标签。
> tTraderCode String 报价方唯一标识代码。询价时 Anonymous 设置为 True 时不可见。
> mTraderCode String 询价方唯一标识代码。报价时 Anonymous 设置为 True 时不可见。
> legs Array of objects 组合交易
>> instId String 产品ID
>> px String 成交价格
>> sz String 成交数量
>> side String 询价单方向
>> tgtCcy String 委托数量的类型
定义sz属性的单位。仅适用于 instType=SPOT。有效值为base_ccy和quote_ccy。未指定时，默认为base_ccy。
>> fee String 手续费，正数代表平台返佣 ，负数代表平台扣除。
>> feeCcy String 手续费币种
>> tradeId String 最新成交Id

WebSocket 公共频道

公共大宗交易频道

获取欧易的最新大宗交易信息。同一大宗交易中的所有腿都包含在同一更新中。每当欧易有大宗交易时，数据都将被推送。

请求示例

{
  "op": "subscribe",
  "args": [
    {
      "channel": "public-struc-block-trades"
    }
  ]
}

请求参数

参数名 类型 是否必填 描述
op String 是 操作, subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名, public-struc-block-trades

成功返回示例

{
  "event": "subscribe",
  "arg": {
    "channel": "public-struc-block-trades"
  }
}

失败返回示例

{
  "event": "error",
  "code": "60012",
  "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"public-struc-block-trades\""}]}"
}

返回参数

参数名 类型 是否必填 描述
event String 是 操作, subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名, public-struc-block-trades
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg":{
        "channel":"public-struc-block-trades"
    },
    "data":[
        {

            "cTime":"1608267227834",
            "blockTdId":"1802896",
            "legs":[
                {
                    "px":"0.323",
                    "sz":"25.0",
                    "instId":"BTC-USD-20220114-13250-C",
                    "side":"sell",
                    "tradeId":"15102"
                },
                {
                    "px":"0.666",
                    "sz":"25",
                    "instId":"BTC-USD-20220114-21125-C",
                    "side":"buy",
                    "tradeId":"15103"
                }
            ]
        }
    ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
data Array 订阅的数据
> cTime String 执行创建的时间戳，Unix 时间戳格式，以毫秒为单位。
> blockTdId String 大宗交易ID
> legs Array of objects 组合交易
>> instId String 产品名Id
>> px String 成交价格
>> sz String 成交数量
>> side String 询价单方向，从 Taker的视角看
>> tradeId String 最新成交Id

公共大宗交易单腿交易频道

获取欧易的最新大宗交易单腿交易信息。大宗交易中的每条腿都在单独的更新中推送。只要有大宗交易，数据都将被推送。

请求示例

{
  "op": "subscribe",
  "args": [
    {
      "channel": "public-block-trades",
      "instId": "BTC-USDT-SWAP"
    }
  ]
}

请求参数

参数名 类型 是否必填 描述
op String 是 操作, subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名, public-block-trades
> instId String 是 产品 ID, e.g., BTC-USDT-SWAP.

成功返回示例

{
  "event": "subscribe",
  "arg": {
    "channel": "public-block-trades",
    "instId": "BTC-USDT-SWAP"
  }
}

失败返回示例

{
  "event": "error",
  "code": "60012",
  "msg": "Invalid request: {\"op\": \"subscribe\", \"args\":[{ \"channel\" : \"public-block-trades\""}]}"
}

返回参数

参数名 类型 是否必需 描述
event String 是 操作, subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名, public-block-trades
> instId String 是 产品 ID, e.g., BTC-USDT-SWAP.
code String 否 错误码
msg String 否 错误消息

推送示例

{
  "arg": {
    "channel": "public-block-trades",
    "instId": "BTC-USDT-SWAP"
  },
  "data": [
    {
      "instId": "BTC-USDT-SWAP",
      "tradeId": "482866817984270338",
      "px": "21950",
      "sz": "100",
      "side": "buy",
      "ts": "1661396420687"
    }
  ]
}

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品 ID, e.g., BTC-USDT-SWAP.
data Array 公共大宗交易单腿交易信息
> instId String 产品 ID, e.g., BTC-USDT-SWAP.
> tradeId String 交易 ID, 由柜台提供.
> px String 该单腿交易价格.
> sz String 交易数量.
> side String 交易方向, buy, sell, 从taker角度看.
> ts String 成交时间, 时间戳格式，以毫秒为单位. e.g. 1597026383085.

大宗交易行情频道

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

当发生成交事件时触发推送，此外，也会根据订阅维度每隔5分钟推送一次

请求示例

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

请求参数

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

成功返回示例

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

失败返回示例

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

返回参数

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

推送示例

{
    "arg": {
        "channel": "block-tickers"
    },
    "data": [
        {
            "instType": "SWAP",
            "instId": "LTC-USD-SWAP",
            "volCcy24h": "0",
            "vol24h": "0",
            "ts": "1597026383085"
        }
    ]
}

推送数据参数

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

REST API

请求验证

生成APIKey

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

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

API key 有如下3种权限，一个 API key 可以有一个或多个权限。

发起请求

所有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' + '/api/v5/account/balance?ccy=BTC', 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

跟单交易带单合约的限速：1次/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

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 可选 持仓方向
在开平仓模式下必填，且仅可选择 long 或 short。 仅适用交割、永续。
ordType String 是 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）
sz String 是 委托数量
px String 可选 委托价格，仅适用于limit、post_only、fok、ioc类型的订单
reduceOnly Boolean 否 是否只减仓，true 或 false，默认false
仅适用于币币杠杆，以及买卖模式下的交割/永续
仅适用于单币种保证金模式和跨币种保证金模式
tgtCcy String 否 市价单委托数量sz的单位，仅适用于币币市价订单
base_ccy: 交易货币 ；quote_ccy：计价货币
买单默认quote_ccy， 卖单默认base_ccy
banAmend Boolean 否 是否禁止币币市价改单，true 或 false，默认false
为true时，余额不足时，系统不会改单，下单会失败，仅适用于币币市价单
tpTriggerPx String 否 止盈触发价，如果填写此参数，必须填写 止盈委托价
tpOrdPx String 否 止盈委托价，如果填写此参数，必须填写 止盈触发价
委托价格为-1时，执行市价止盈
slTriggerPx String 否 止损触发价，如果填写此参数，必须填写 止损委托价
slOrdPx String 否 止损委托价，如果填写此参数，必须填写 止损触发价
委托价格为-1时，执行市价止损
tpTriggerPxType String 否 止盈触发价类型
last：最新价格
index：指数价格
mark：标记价格
默认为last
slTriggerPxType String 否 止损触发价类型
last：最新价格
index：指数价格
mark：标记价格
默认为last
quickMgnType String 否 一键借币类型，仅适用于杠杆逐仓的一键借币模式：
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
默认是manual：手动

返回结果

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

跟单交易带单合约的限速：1个/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

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 可选 持仓方向
在开平仓模式下必填，且仅可选择 long 或 short。 仅适用交割、永续。
ordType String 是 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）
sz String 是 委托数量
px String 否 委托价格，仅适用于limit、post_only、fok、ioc类型的订单
reduceOnly Boolean 否 是否只减仓，true 或 false，默认false
仅适用于币币杠杆，以及买卖模式下的交割/永续
仅适用于单币种保证金模式和跨币种保证金模式
tgtCcy String 否 市价单委托数量sz的单位，仅适用于币币市价订单
base_ccy: 交易货币 ；quote_ccy：计价货币
买单默认quote_ccy， 卖单默认base_ccy
banAmend Boolean 否 是否禁止币币市价改单，true 或 false，默认false
为true时，余额不足时，系统不会改单，下单会失败，仅适用于币币市价单
tpTriggerPx String 否 止盈触发价，如果填写此参数，必须填写 止盈委托价
tpOrdPx String 否 止盈委托价，如果填写此参数，必须填写 止盈触发价
委托价格为-1时，执行市价止盈
slTriggerPx String 否 止损触发价，如果填写此参数，必须填写 止损委托价
slOrdPx String 否 止损委托价，如果填写此参数，必须填写 止损触发价
委托价格为-1时，执行市价止损
tpTriggerPxType String 否 止盈触发价类型
last：最新价格
index：指数价格
mark：标记价格
默认为last
slTriggerPxType String 否 止损触发价类型
last：最新价格
index：指数价格
mark：标记价格
默认为last
quickMgnType String 否 一键借币类型，仅适用于杠杆逐仓的一键借币模式：
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
默认是manual：手动

返回结果

{
    "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 + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

HTTP请求

POST /api/v5/trade/cancel-order

请求示例

POST /api/v5/trade/cancel-order
body
{
    "ordId":"2510789768709120",
    "instId":"BTC-USD-190927"
}

请求参数

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

返回结果

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

返回参数

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

批量撤单

撤销未完成的订单，每次最多可以撤销20个订单。请求参数应该按数组格式传递。

限速：300个/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

HTTP请求

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

请求示例

POST /api/v5/trade/cancel-batch-orders
body
[
    {
        "instId":"BTC-USDT",
        "ordId":"12312"
    },
    {
        "instId":"BTC-USDT",
        "ordId":"1212"
    }
]

请求参数

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

返回结果

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

返回参数

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

修改订单

修改当前未成交的挂单
只适用于交割和永续合约。

限速：60次/2s

限速规则：UserID + Instrument ID

HTTP请求

POST /api/v5/trade/amend-order

请求示例

POST /api/v5/trade/amend-order
body
{
    "ordId":"2510789768709120",
    "newSz":"2",
    "instId":"BTC-USDT"
}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
cxlOnFail Boolean 否 false：不自动撤单 true：自动撤单 当订单修改失败时，该订单是否需要自动撤销。默认为false
ordId String 可选 订单ID， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义order ID
reqId String 否 用户自定义修改事件ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
newSz String 可选 修改的新数量，对于部分成交订单，该数量应包含已成交数量。
newPx String 可选 修改的新价格
newTpTriggerPx String 可选 止盈触发价
如果止盈触发价或者委托价为0，那代表删除止盈
newTpOrdPx String 可选 止盈委托价
委托价格为-1时，执行市价止盈
newSlTriggerPx String 可选 止损触发价
如果止损触发价或者委托价为0，那代表删除止损
newSlOrdPx String 可选 止损委托价
委托价格为-1时，执行市价止损
newTpTriggerPxType String 可选 止盈触发价类型
last：最新价格
index：指数价格
mark：标记价格
newSlTriggerPxType String 可选 止损触发价类型
last：最新价格
index：指数价格
mark：标记价格

返回结果

{
    "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 + Instrument ID

HTTP请求

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

请求示例

POST /api/v5/trade/amend-batch-orders
body
[
    {
        "ordId":"2510789768709120",
        "newSz":"2",
        "instId":"BTC-USDT"
    },
    {
        "ordId":"2510789768709121",
        "newSz":"2",
        "instId":"BTC-USDT"
    }
]

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
cxlOnFail Boolean 否 false ：不自动撤单 true：自动撤单 当订单修改失败时，该订单是否需要自动撤销，默认为false
ordId String 可选 订单ID， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义order ID
reqId String 否 用户自定义修改事件ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
newSz String 可选 修改的新数量，对于部分成交订单，该数量应包含已成交数量。
newPx String 可选 修改的新价格
newTpTriggerPx String 可选 止盈触发价
如果止盈触发价或者委托价为0，那代表删除止盈
newTpOrdPx String 可选 止盈委托价
委托价格为-1时，执行市价止盈
newSlTriggerPx String 可选 止损触发价
如果止损触发价或者委托价为0，那代表删除止损
newSlOrdPx String 可选 止损委托价
委托价格为-1时，执行市价止损
newTpTriggerPxType String 可选 止盈触发价类型
last：最新价格
index：指数价格
mark：标记价格
newSlTriggerPxType String 可选 止损触发价类型
last：最新价格
index：指数价格
mark：标记价格

返回结果

{
    "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 + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

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：自动撤单
clOrdId String 否 客户自定义ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
tag String 否 订单标签
字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间。

返回结果

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

返回参数

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

获取订单信息

查订单信息

限速：60次/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

HTTP请求

GET /api/v5/trade/order

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID ，如BTC-USD-190927
ordId String 可选 订单ID ， ordId和clOrdId必须传一个，若传两个，以ordId为主
clOrdId String 可选 用户自定义ID
如果clOrdId关联了多个订单，只会返回最近的那笔订单

返回结果

{
    "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":"",
            "reduceOnly": "false",
            "cancelSource": "20",
            "cancelSourceReason": "Cancel all after triggered",
            "quickMgnType": "",
            "algoClOrdId": "",
            "algoId": "",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
SPOT：币币
MARGIN：币币杠杆
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
instId String 产品ID
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_ccy
ccy String 保证金币种，仅适用于单币种保证金模式下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
pnl String 收益，适用于有成交的平仓订单，其他情况均为0
ordType String 订单类型
market：市价单
limit：限价单
post_only：只做maker单
fok：全部成交或立即取消
ioc：立即成交并取消剩余
optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续）
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
accFillSz String 累计成交数量
对于币币和杠杆，单位为交易货币，如 BTC-USDT, 单位为 BTC；对于市价单，无论tgtCcy是base_ccy，还是quote_ccy，单位均为交易货币；
对于交割、永续以及期权，单位为张。
fillPx String 最新成交价格，如果成交数量为0，该字段为""
tradeId String 最新成交ID
fillSz String 最新成交数量
对于币币和杠杆，单位为交易货币，如 BTC-USDT, 单位为 BTC；对于市价单，无论tgtCcy是base_ccy，还是quote_ccy，单位均为交易货币；
对于交割、永续以及期权，单位为张。
fillTime String 最新成交时间
avgPx String 成交均价，如果成交数量为0，该字段也为""
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：对冲减仓类型订单
reduceOnly String 是否只减仓，true 或 false
cancelSource String 订单取消来源的原因枚举值代码
cancelSourceReason String 订单取消来源的对应具体原因
quickMgnType String 一键借币类型，仅适用于杠杆逐仓的一键借币模式
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
algoClOrdId String 客户自定义策略订单ID。策略订单触发，且策略单有algoClOrdId时有值，否则为"",
algoId String 策略委托单ID，策略订单触发时有值，否则为""
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 否 标的指数
instFamily 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，默认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": "",
            "reduceOnly": "false",
            "quickMgnType": "",
            "algoClOrdId": "",
            "algoId": "",
            "uTime": "1618235248028"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_ccy
ccy String 保证金币种，仅适用于单币种保证金模式下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 客户自定义订单ID
tag String 订单标签
px String 委托价格
sz String 委托数量
pnl String 收益，适用于有成交的平仓订单，其他情况均为0
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 成交均价。如果还没成交，系统返回0。
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 止损委托价
tpOrdPx String 止盈委托价
feeCcy String 交易手续费币种
fee String 手续费与返佣
对于币币和杠杆，为订单交易累计的手续费，平台向用户收取的交易手续费，为负数。如： -0.01
对于交割、永续和期权，为订单交易累计的手续费和返佣
rebateCcy String 返佣金币种
source String 订单来源
13:策略委托单触发后的生成的限价单
rebate String 返佣金额，仅适用于币币和杠杆，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”。手续费返佣为正数，如：0.01
category String 订单种类
normal： 普通委托
reduceOnly String 是否只减仓，true 或 false
quickMgnType String 一键借币类型，仅适用于杠杆逐仓的一键借币模式
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
algoClOrdId String 客户自定义策略订单ID。策略订单触发，且策略单有algoClOrdId是有值，否则为"",
algoId String 策略委托单ID，策略订单触发时有值，否则为""
uTime String 订单状态更新时间，Unix时间戳的毫秒数格式，如 1597026383085
cTime String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

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

获取最近7天挂单，且完全成交的订单数据，包括7天以前挂单，但近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 否 标的指数
instFamily 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
begin String 否 筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
end String 否 筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085
limit String 否 返回结果的数量，最大为100，默认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":"",
            "reduceOnly": "false",
            "cancelSource": "20",
            "cancelSourceReason": "Cancel all after triggered",
            "algoClOrdId": "",
            "algoId": "",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_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 最新成交价格，如果成交数量为0，该字段为""
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
avgPx String 成交均价，如果成交数量为0，该字段也为""
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 收益，适用于有成交的平仓订单，其他情况均为0
category String 订单种类
normal：普通委托
twap：TWAP自动换币
adl：ADL自动减仓
full_liquidation：强制平仓
partial_liquidation：强制减仓
delivery：交割
ddh：对冲减仓类型订单
reduceOnly String 是否只减仓，true 或 false
cancelSource String 订单取消来源的原因枚举值代码
cancelSourceReason String 订单取消来源的对应具体原因
algoClOrdId String 客户自定义策略订单ID。策略订单触发，且策略单有algoClOrdId时有值，否则为"",
algoId String 策略委托单ID，策略订单触发时有值，否则为""
uTime String 订单状态更新时间，Unix时间戳的毫秒数格式，如1597026383085
cTime String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

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

获取最近3个月挂单，且完全成交的订单数据，包括3个月以前挂单，但近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 否 标的指数
instFamily 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
begin String 否 筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
end String 否 筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085
limit String 否 返回结果的数量，最大为100，默认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":"",
            "reduceOnly": "false",
            "cancelSource": "20",
            "cancelSourceReason": "Cancel all after triggered",
            "algoClOrdId": "",
            "algoId": "",
            "uTime":"1597026383085",
            "cTime":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_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 最新成交价格，如果成交数量为0，该字段为""
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
avgPx String 成交均价，如果成交数量为0，该字段也为""
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 收益，适用于有成交的平仓订单，其他情况均为0
source String 订单来源
13:策略委托单触发后的生成的限价单
category String 订单种类
normal：普通委托
twap：TWAP自动换币
adl：ADL自动减仓
full_liquidation：强制平仓
partial_liquidation：强制减仓
delivery：交割
ddh：对冲减仓类型订单
reduceOnly String 是否只减仓，true 或 false
cancelSource String 订单取消来源的原因枚举值代码
cancelSourceReason String 订单取消来源的对应具体原因
algoClOrdId String 客户自定义策略订单ID。策略订单触发，且策略单有algoClOrdId是有值，否则为"",
algoId String 策略委托单ID，策略订单触发时有值，否则为""
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 否 标的指数
instFamily 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，默认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",
      "fillTime": "1597026383084"
    },
    {
      "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",
      "fillTime": "1597026383084"
    }
  ]
}

返回参数

参数名 类型 描述
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
不适用于系统订单比如强平和ADL
feeCcy String 交易手续费币种或者返佣金币种
fee String 手续费金额或者返佣金额，手续费扣除为‘负数’，如-0.01；手续费返佣为‘正数’，如 0.01
ts String 成交明细产生时间，Unix时间戳的毫秒数格式，如1597026383085
fillTime String 成交时间，与订单频道的fillTime相同

获取成交明细（近三个月）

获取近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 否 标的指数
instFamily 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，默认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",
      "fillTime": "1597026383084"

    },
    {
      "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",
      "fillTime": "1597026383084"
    }
  ]
}

返回参数

参数名 类型 描述
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
不适用于系统订单比如强平和ADL
feeCcy String 交易手续费币种或者返佣金币种
fee String 手续费金额或者返佣金额 ，手续费扣除 为 ‘负数’，如 -0.01 ； 手续费返佣 为 ‘正数’，如 0.01
ts String 成交明细产生时间，Unix时间戳的毫秒数格式，如1597026383085
fillTime String 成交时间，与订单频道的fillTime相同

策略委托下单

提供单向止盈止损委托、双向止盈止损委托、计划委托、冰山委托、时间加权委托、移动止盈止损委托

限速：20次/2s

跟单交易带单合约的限速：1次/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

HTTP请求

POST /api/v5/trade/order-algo

请求示例

POST /api/v5/trade/order-algo
body
{
    "instId":"BTC-USDT",
    "tdMode":"cross",
    "side":"buy",
    "ordType":"conditional",
    "sz":"2",
    "tpTriggerPx":"15",
    "tpOrdPx":"18"
}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如 BTC-USD-190927-5000-C
tdMode String 是 交易模式
保证金模式 isolated：逐仓，cross：全仓
非保证金模式 cash：非保证金
ccy String 否 保证金币种
仅适用于单币种保证金模式下的全仓杠杆订单
side String 是 订单方向
buy：买
sell：卖
posSide String 可选 持仓方向
在开平仓模式下必填，且仅可选择 long 或 short
ordType String 是 订单类型
conditional：单向止盈止损
oco：双向止盈止损
trigger：计划委托
move_order_stop：移动止盈止损
iceberg：冰山委托
twap：时间加权委托
sz String 可选 委托数量
sz和closeFraction必填且只能填其一
tag String 否 订单标签
字母（区分大小写）与数字的组合，可以是纯字母、纯数字，且长度在1-16位之间
tgtCcy String 否 委托数量的类型
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币单向止盈止损市价买单
默认买为计价货币，卖为交易货币
reduceOnly Boolean 否 是否只减仓，true 或 false，默认false
仅适用于币币杠杆，以及买卖模式下的交割/永续
仅适用于单币种保证金模式和跨币种保证金模式
algoClOrdId String 否 客户自定义策略订单ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
closeFraction String 可选 策略委托触发时，平仓的百分比。1 代表100%
现在系统只支持全部平仓，唯一接受参数为1
仅适用于交割或永续
仅适用于买卖模式 posSide = net
仅适用于减仓订单 reduceOnly = true
仅适用于止盈止损 ordType = conditional 或 oco
仅适用于止盈止损市价订单
sz和closeFraction必填且只能填其一
quickMgnType String 否 一键借币类型，仅适用于杠杆逐仓的一键借币模式：
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
默认是manual：手动

止盈止损

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

计划委托

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

移动止盈止损

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

冰山委托

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

时间加权

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

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

返回结果

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

返回参数

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

撤销策略委托订单

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

限速：20次/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

HTTP请求

POST /api/v5/trade/cancel-algos

请求示例

POST /api/v5/trade/cancel-algos
body
[
    {
        "algoId":"198273485",
        "instId":"BTC-USDT"
    },
    {
        "algoId":"198273485",
        "instId":"BTC-USDT"
    }
]

请求参数

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

返回结果

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

返回参数

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

修改策略委托订单

修改策略委托订单（仅支持止盈止损单，不包含计划委托、冰山委托、时间加权、移动止盈止损等订单）
只适用于交割和永续合约。

限速：20次/2s

限速规则：UserID + Instrument ID

HTTP请求

POST /api/v5/trade/amend-algos

请求示例

POST /api/v5/trade/amend-algos
body
{
    "algoId":"2510789768709120",
    "algoClOrdId":"algo_01"
    "newSz":"2",
    "instId":"BTC-USDT-SWAP",
    "cxlOnFail":false,
    "reqId":"po103ux",
    "newTpTriggerPx":"30000",
    "newTpOrdPx":"30000",
    "newSlTriggerPx":"26000",
    "newSlOrdPx":"26000",
    "newTpTriggerPxType":"last",
    "newSlTriggerPxType":"last"
}

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID
algoId String 可选 策略委托单ID
algoId和algoClOrdId必须传一个，若传两个，以algoId为主
algoClOrdId String 可选 客户自定义策略订单ID
algoId和algoClOrdId必须传一个，若传两个，以algoId为主
cxlOnFail Boolean 否 false：不自动撤单 true：自动撤单 当订单修改失败时，该订单是否需要自动撤销。默认为false
reqId String 否 用户自定义修改事件ID，字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间
newSz String 可选 修改的新数量
newTpTriggerPx String 可选 止盈触发价
如果止盈触发价或者委托价为0，那代表删除止盈
newTpOrdPx String 可选 止盈委托价
委托价格为-1时，执行市价止盈
newSlTriggerPx String 可选 止损触发价
如果止损触发价或者委托价为0，那代表删除止损
newSlOrdPx String 可选 止损委托价
委托价格为-1时，执行市价止损
newTpTriggerPxType String 可选 止盈触发价类型
last：最新价格
index：指数价格
mark：标记价格
newSlTriggerPxType String 可选 止损触发价类型
last：最新价格
index：指数价格
mark：标记价格

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "algoClOrdId":"algo_01",
            "algoId":"2510789768709120",
            "reqId":"po103ux",
            "sCode":"0",
            "sMsg":""
        }
    ]
}

返回参数

参数名 类型 描述
algoId String 订单ID
algoClOrdId String 客户自定义策略订单ID
reqId String 用户自定义修改事件ID，字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间
sCode String 事件执行结果的code，0代表成功
sMsg String 事件执行失败时的msg

撤销高级策略委托订单

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

限速：20次/2s

限速规则（期权以外）：UserID + Instrument ID

限速规则（只限期权）：UserID + Instrument Family

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/order-algo

请求示例

GET /api/v5/trade/order-algo?algoId=1234231231423

请求参数

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

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "clOrdId":"",
            "algoId":"1234",
            "sz":"999",
            "closeFraction":"",
            "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":"",
            "reduceOnly": "false",
            "triggerTime":"1597026383085",
            "last": "16012",
            "failCode": "",
            "algoClOrdId": "",
            "cTime":"1597026383000"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
clOrdId String 客户自定义订单ID
sz String 委托数量
closeFraction String 策略委托触发时，平仓的百分比。1 代表100%
ordType String 订单类型
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_ccy
state String 订单状态
live：待生效
pause：暂停生效
partially_effective:部分生效
effective： 已生效
canceled：已撤销
order_failed：委托失败
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
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 单笔数量
仅适用于冰山委托和时间加权委托
pxLimit String 挂单限制价
仅适用于冰山委托和时间加权委托
tag String 订单标签
timeInterval String 下单间隔
仅适用于时间加权委托
callbackRatio String 回调幅度的比例
仅适用于移动止盈止损
callbackSpread String 回调幅度的价距
仅适用于移动止盈止损
activePx String 移动止盈止损激活价格
仅适用于移动止盈止损
moveTriggerPx String 移动止盈止损触发价格
仅适用于移动止盈止损
reduceOnly String 是否只减仓，true 或 false
quickMgnType String 一键借币类型，仅适用于杠杆逐仓的一键借币模式
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
last String 下单时的最新成交价
failCode String 代表策略触发失败的原因，已撤销和已生效时为""，委托失败时有值，如 51008；
仅适用于单向止盈止损委托、双向止盈止损委托、移动止盈止损委托、计划委托。
algoClOrdId String 客户自定义策略订单ID
cTime String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

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

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

限速：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，默认100条
algoClOrdId String 否 客户自定义策略订单ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。

返回结果

{
    "code": "0",
    "data": [
        {
            "activePx": "",
            "actualPx": "",
            "actualSide": "",
            "actualSz": "0",
            "algoId": "492453578716610560",
            "cTime": "1663682082511",
            "callbackRatio": "",
            "callbackSpread": "",
            "ccy": "",
            "clOrdId": "hahawang",
            "instId": "BTC-USDT-SWAP",
            "instType": "SWAP",
            "lever": "3",
            "moveTriggerPx": "",
            "ordId": "",
            "ordPx": "",
            "ordType": "conditional",
            "posSide": "long",
            "pxLimit": "",
            "pxSpread": "",
            "pxVar": "",
            "side": "buy",
            "slOrdPx": "-1",
            "slTriggerPx": "22000",
            "slTriggerPxType": "last",
            "state": "live",
            "sz": "10",
            "closeFraction": "",
            "szLimit": "",
            "tag": "",
            "tdMode": "cross",
            "tgtCcy": "",
            "timeInterval": "",
            "tpOrdPx": "",
            "tpTriggerPx": "",
            "tpTriggerPxType": "",
            "triggerPx": "",
            "triggerPxType": "",
            "reduceOnly": "false",
            "quickMgnType": "",
            "last": "16012",
            "failCode": "",
            "algoClOrdId": "",
            "triggerTime": ""
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
clOrdId String 客户自定义订单ID
sz String 委托数量
closeFraction String 策略委托触发时，平仓的百分比。1 代表100%
ordType String 订单类型
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_ccy
state String 订单状态 ，live：待生效 pause：暂停生效 partially_effective:部分生效
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
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 订单标签
pxLimit String 挂单限制价
仅适用于冰山委托和时间加权委托
timeInterval String 下单间隔
仅适用于时间加权委托
callbackRatio String 回调幅度的比例
仅适用于移动止盈止损
callbackSpread String 回调幅度的价距
仅适用于移动止盈止损
activePx String 移动止盈止损激活价格
仅适用于移动止盈止损
moveTriggerPx String 移动止盈止损触发价格
仅适用于移动止盈止损
reduceOnly String 是否只减仓，true 或 false
quickMgnType String 一键借币类型，仅适用于杠杆逐仓的一键借币模式
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
last String 下单时的最新成交价
failCode String 代表策略触发失败的原因，委托失败时有值，如 51008，对于该接口一直为""。
algoClOrdId String 客户自定义策略订单ID
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 【state和algoId必填且只能填其一】
instType String 否 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
MARGIN：杠杆
instId String 否 产品ID，BTC-USD-190927
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的algoId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的algoId
limit String 否 返回结果的数量，最大为100，默认100条

返回结果

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "clOrdId":"",
            "algoId":"1234",
            "sz":"999",
            "closeFraction":"",
            "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":"",
            "reduceOnly": "false",
            "triggerTime":"1597026383085",
            "last": "16012",
            "failCode": "",
            "algoClOrdId": "",
            "cTime":"1597026383000"
        },
        {
            "instType":"FUTURES",
            "instId":"BTC-USD-200329",
            "ordId":"123445",
            "ccy":"BTC",
            "clOrdId":"",
            "algoId":"1234",
            "sz":"999",
            "closeFraction":"",
            "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":"",
            "reduceOnly": "false",
            "triggerTime":"1597026383085",
            "last": "16012",
            "failCode": "",
            "algoClOrdId": "",
            "cTime":"1597026383000"
        }
    ]
}

返回参数

参数名 类型 描述
instType String 产品类型
instId String 产品ID
ccy String 保证金币种，仅适用于单币种保证金模式下的全仓杠杆订单
ordId String 订单ID
algoId String 策略委托单ID
clOrdId String 客户自定义订单ID
sz String 委托数量
closeFraction String 策略委托触发时，平仓的百分比。1 代表100%
ordType String 订单类型
side String 订单方向
posSide String 持仓方向
tdMode String 交易模式
tgtCcy String 币币市价单委托数量sz的单位
base_ccy: 交易货币 ；quote_ccy：计价货币
仅适用于币币市价订单
默认买单为quote_ccy，卖单为base_ccy
state String 订单状态
effective： 已生效
canceled：已撤销
order_failed：委托失败
lever String 杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续
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 订单标签
timeInterval String 下单间隔
仅适用于时间加权委托
callbackRatio String 回调幅度的比例
仅适用于移动止盈止损
callbackSpread String 回调幅度的价距
仅适用于移动止盈止损
activePx String 移动止盈止损激活价格
仅适用于移动止盈止损
moveTriggerPx String 移动止盈止损触发价格
仅适用于移动止盈止损
reduceOnly String 是否只减仓，true 或 false
quickMgnType String 一键借币类型，仅适用于杠杆逐仓的一键借币模式
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
last String 下单时的最新成交价
failCode String 代表策略触发失败的原因，已撤销和已生效时为""，委托失败时有值，如 51008；
仅适用于单向止盈止损委托、双向止盈止损委托、移动止盈止损委托、计划委托。
algoClOrdId String 客户自定义策略订单ID
cTime String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

获取一键兑换主流币币种列表

获取小币一键兑换主流币币种列表。仅可兑换余额在 $10 以下小币币种。

限速：1次/2s

限速规则：UserID

HTTP 请求

GET /api/v5/trade/easy-convert-currency-list

请求示例

GET /api/v5/trade/easy-convert-currency-list

请求参数

无

返回结果

{
    "code": "0",
    "data": [
        {
            "fromData": [
                {
                    "fromAmt": "6.580712708344864",
                    "fromCcy": "ADA"
                },
                {
                    "fromAmt": "2.9970000013055097",
                    "fromCcy": "USDC"
                }
            ],
            "toCcy": [
                "USDT",
                "BTC",
                "ETH",
                "OKB"
            ]
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
fromData Array 当前拥有并可兑换的小币币种列表信息
> fromCcy String 可兑换币种
> fromAmt String 可兑换币种数量
toCcy Array 可转换成的主流币币种列表

一键兑换主流币交易

进行小币一键兑换主流币交易。仅可兑换余额在 $10 以下小币币种。

限速：1次/2s

限速规则：UserID

HTTP 请求

POST /api/v5/trade/easy-convert

请求示例

POST /api/v5/trade/easy-convert
body
{
    "fromCcy": ["ADA","USDC"], //逗号分隔小币
    "toCcy": "OKB" 
}

请求参数

参数名 类型 是否必须 描述
fromCcy Array 是 小币支付币种
单次最多同时选择5个币种，如有多个币种则用逗号隔开
toCcy String 是 兑换的主流币
只选择一个币种，且不能和小币支付币种重复

返回结果

{
    "code": "0",
    "data": [
        {
            "fillFromSz": "6.5807127",
            "fillToSz": "0.17171580105126",
            "fromCcy": "ADA",
            "status": "running",
            "toCcy": "OKB",
            "uTime": "1661419684687"
        },
        {
            "fillFromSz": "2.997",
            "fillToSz": "0.1683755161661844",
            "fromCcy": "USDC",
            "status": "running",
            "toCcy": "OKB",
            "uTime": "1661419684687"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
status String 当前兑换进度/状态
running: 进行中
filled: 已完成
failed: 失败
fromCcy String 小币支付币种
toCcy String 兑换的主流币
fillFromSz String 小币偿还币种支付数量
fillToSz String 兑换的主流币成交数量
uTime String 交易时间戳，Unix时间戳为毫秒数格式，如 1597026383085

获取一键兑换主流币历史记录

查询一键兑换主流币的历史记录与进度状态。

限速：1次/2s

限速规则：UserID

HTTP 请求

GET /api/v5/trade/easy-convert-history

请求示例

GET /api/v5/trade/easy-convert-history

请求参数

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

返回结果

{
    "code": "0",
    "data": [
        {
            "fillFromSz": "0.1761712511667539",
            "fillToSz": "6.7342205900000000",
            "fromCcy": "OKB",
            "status": "filled",
            "toCcy": "ADA",
            "uTime": "1661313307979"
        },
        {
            "fillFromSz": "0.1722106121112177",
            "fillToSz": "2.9971018300000000",
            "fromCcy": "OKB",
            "status": "filled",
            "toCcy": "USDC",
            "uTime": "1661313307979"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
fromCcy String 小币支付币种
fromSz String 对应的小币支付数量
toCcy String 兑换到的主流币
toSz String 兑换到的主流币数量
status String 当前兑换进度/状态
running: 进行中
filled: 已完成
failed: 失败
uTime String 交易时间戳，Unix时间戳为毫秒数格式，如 1597026383085

获取一键还债币种列表

查询一键还债币种列表。负债币种包括全仓负债和逐仓负债。

限速：1次/2s

限速规则：UserID

HTTP 请求

GET /api/v5/trade/one-click-repay-currency-list

请求示例

GET /api/v5/trade/one-click-repay-currency-list

请求参数

参数名 类型 是否必须 描述
debtType String 否 负债类型
cross: 全仓负债
isolated: 逐仓负债

返回结果

{
    "code": "0",
    "data": [
        {
            "debtData": [
                {
                    "debtAmt": "29.653478",
                    "debtCcy": "LTC"
                },
                {
                    "debtAmt": "237803.6828295906051002",
                    "debtCcy": "USDT"
                }
            ],
            "debtType": "cross",
            "repayData": [
                {
                    "repayAmt": "0.4978335419825104",
                    "repayCcy": "ETH"
                }
            ]
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
debtData Array 负债币种信息
> debtCcy String 负债币种
> debtAmt String 可负债币种数量
包括本金和利息
debtType String 负债类型
cross: 全仓负债
isolated: 逐仓负债
repayData Array 偿还币种信息
> repayCcy String 可偿还负债的币种
> repayAmt String 可偿还负债的币种可用资产数量

一键还债交易

交易一键偿还小额全仓债务。不支持逐仓负债的偿还。根据资金和交易账户的剩余可用余额为最大偿还数量。

限速：1次/2s

限速规则：UserID

HTTP 请求

POST /api/v5/trade/one-click-repay

请求示例

POST /api/v5/trade/one-click-repay
body
{
    "debtCcy": ["ETH","BTC"], //逗号分隔债务币
    "repayCcy": "USDT" //用USDT偿还ETH和BTC
}

请求参数

参数名 类型 是否必须 描述
debtCcy Array 是 负债币种
单次最多同时选择5个币种，如有多个币种则用逗号隔开
repayCcy String 是 偿还币种
只选择一个币种，且不能和负债币种重复

返回结果

{
    "code": "0",
    "data": [
        {
            "debtCcy": "ETH", 
            "fillDebtSz": "0.01023052",
            "fillRepaySz": "30", 
            "repayCcy": "USDT", 
            "status": "filled",
            "uTime": "1646188520338"
        },
        {
            "debtCcy": "BTC", 
            "fillFromSz": "3",
            "fillToSz": "60,221.15910001",
            "repayCcy": "USDT",
            "status": "filled",
            "uTime": "1646188520338"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
status String 当前还债进度/状态
running: 进行中
filled: 已完成
failed: 失败
debtCcy String 负债币种
repayCcy String 偿还币种
fillDebtSz String 负债币种成交数量
fillRepaySz String 偿还币种成交数量
uTime String 交易时间戳，Unix时间戳为毫秒数格式，如 1597026383085

获取一键还债历史记录

查询一键还债的历史记录与进度状态。

限速：1次/2s

限速规则：UserID

HTTP 请求

GET /api/v5/trade/one-click-repay-history

请求示例

GET /api/v5/trade/one-click-repay-history

请求参数

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

返回结果

{
    "code": "0",
    "data": [
        {
            "debtCcy": "USDC",
            "fillDebtSz": "6950.4865447900000000",
            "fillRepaySz": "4.3067975995094930",
            "repayCcy": "ETH",
            "status": "filled",
            "uTime": "1661256148746"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
debtCcy String 负债币种
debtSz String 对应的负债币种成交数量
repayCcy String 偿还币种
repaySz String 偿还币种实际支付数量
status String 当前还债进度/状态
running: 进行中
filled: 已完成
failed: 失败
uTime String 交易时间戳，Unix时间戳为毫秒数格式，如 1597026383085

资金

资金功能模块下的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": true,
        "canWd": true,
        "ccy": "BTC",
        "chain": "BTC-Bitcoin",
        "depQuotaFixed": "",
        "depQuoteDailyLayer2":"",
        "logoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/btc.png",
        "mainNet": true,
        "maxFee": "0.0004",
        "maxWd": "500",
        "minDep": "0.00005",
        "minDepArrivalConfirm": "1",
        "minFee": "0.0002",
        "minWd": "0.001",
        "minWdUnlockConfirm": "3",
        "name": "Bitcoin",
        "needTag": false,
        "usedDepQuotaFixed": "",
        "usedWdQuota": "0",
        "wdQuota": "200",
        "wdTickSz": "8"
    }
  ]
}

返回参数

参数名 类型 描述
ccy String 币种名称，如 BTC
name String 币种名称，不显示则无对应名称
logoLink String 币种Logo链接
chain String 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
canDep Boolean 是否可充值，false表示不可链上充值，true表示可以链上充值
canWd Boolean 是否可提币，false表示不可链上提币，true表示可以链上提币
canInternal Boolean 是否可内部转账，false表示不可内部转账，true表示可以内部转账
minDep String 币种单笔最小充值量
minWd String 币种单笔最小提币量
maxWd String 币种单笔最大提币量
wdTickSz String 提币精度,表示小数点后的位数。提币手续费精度与提币精度保持一致。
内部转账提币精度为小数点后8位。
wdQuota String 过去24小时内提币额度，单位为USD
usedWdQuota String 过去24小时内已用提币额度，单位为USD
minFee String 最小提币手续费数量
maxFee String 最大提币手续费数量
mainNet Boolean 当前链是否为主链
如果是则返回true，否则返回false
needTag Boolean 当前链是否需要标签（tag/memo）信息
minDepArrivalConfirm String 充值到账最小网络确认数。币已到账但不可提。
minWdUnlockConfirm String 提现解锁最小网络确认数
depQuotaFixed String 充币固定限额，单位为USD
没有充币限制则返回""
usedDepQuotaFixed String 已用充币固定额度，单位为USD
没有充币限制则返回""
depQuoteDailyLayer2 String Layer2网络每日充值上限

获取资金账户余额

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

限速：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 可用余额

获取不可交易资产

限速：6 次/s

限速规则：UserID

HTTP 请求

GET /api/v5/asset/non-tradable-assets

请求示例

GET /api/v5/asset/non-tradable-assets

请求参数

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

返回结果

{
    "code": "0",
    "data": [{
        "bal": "0.9",
        "canWd": true,
        "ccy": "USD_BSC",
        "chain": "BSC",
        "ctAddr": "197955",
        "fee": "0.1",
        "logoLink": "",
        "minWd": "0",
        "name": "",
        "needTag": false,
        "wdAll": true,
        "wdTickSz": "4"
    }],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 币种名称，如 USD_BSC
name String 币种中文名称，不显示则无对应名称
logoLink String 币种Logo链接
bal String 可提余额
canWd Boolean 是否可提
false: 不可提 true: 可提
chain String 支持提币的链
minWd String 币种单笔最小提币量
wdAll String 该币种资产是否必须一次性全部提取
fee String 提币固定手续费，单位是USDT。提币手续费精度为小数点后8位。
ctAddr String 合约地址后6位
wdTickSz String 提币精度,表示小数点后的位数
needTag Boolean 提币的链是否需要标签（tag/memo）信息

获取账户资产估值

查看账户资产估值

限速：1次/s

限速规则：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 Object 各个账户的资产估值
> funding String 资金账户
> trading String 交易账户
> classic String 经典账户 (已废弃)
> earn String 金融账户

资金划转

调用时，API Key 需要有交易权限

支持母账户的资金账户划转到交易账户，母账户到子账户的资金账户和交易账户划转；

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

限速：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 为1，2 或 4：subAcct 为必填项
type String 否 划转类型
0：账户内划转
1：母账户转子账户(仅适用于母账户APIKey)
2：子账户转母账户(仅适用于母账户APIKey)
3：子账户转母账户(仅适用于子账户APIKey)
4：子账户转子账户(仅适用于子账户APIKey，且目标账户需要是同一母账户下的其他子账户)
默认是0
loanTrans Boolean 否 是否支持跨币种保证金模式或组合保证金模式下的借币转入/转出
true 或 false，默认false
clientId String 否 客户自定义ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
omitPosRisk String 否 是否忽略仓位风险
默认为false
仅适用于组合保证金模式

返回结果

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

获取资金划转状态

获取最近2个星期内的资金划转状态数据

限速：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)
3：子账户转母账户(仅适用于子账户APIKey)
4：子账户转子账户(仅适用于子账户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": ""
}

返回参数

参数名 类型 描述
transId String 划转 ID
clientId String 客户自定义ID
ccy String 划转币种
amt String 划转量
type String 划转类型
0：账户内划转
1：母账户转子账户(仅适用于母账户APIKey)
2：子账户转母账户(仅适用于母账户APIKey)
3：子账户转母账户(仅适用于子账户APIKey)
4：子账户转子账户(仅适用于子账户APIKey，且目标账户需要是同一母账户下的其他子账户)
from String 转出账户
6：资金账户 18：交易账户
to String 转入账户
6：资金账户 18：交易账户
subAcct String 子账户名称
instId String 已废弃
toInstId String 已废弃
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：从子账户转入（主体是母账户）
22：转出到母账户（主体是子账户）
23：母账户转入（主体是子账户）
28：领取
47：系统冲正
48：活动得到
49：活动送出
50：预约得到
51：预约扣除
52：发红包
53：抢红包
54：红包退还
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：转出至交易账户
132：客服冻结
133：客服解冻
134：客服转交
135：跨链兑换
136：兑换
137：ETH2.0申购
138：ETH2.0兑换
139：ETH2.0收益
143：系统退款
145：系统回收
146：客户回馈
147：sushi 增发收益
150：节点返佣
151：邀请奖励
152：经纪商返佣
153：新手奖励
154：拆盲盒奖励
155：福利中心提现
156：返佣卡返佣
157：红包
160：双币赢申购
161：双币赢回款
162：双币赢收益
163：双币赢退款
169：2022春节红包
172：助力人返佣
173：手续费返现
174：支付
175：锁定质押物
176：借款转入
177：添加质押物
178：减少质押物
179：还款
180：释放质押物
181：偿还空投糖果
182：反馈奖励
183：邀请好友奖励
184：瓜分奖池奖励
185：经纪商闪兑返佣
186：0元领ETH
187：闪兑划转
188：插槽竞拍兑换
189：盲盒奖励
193：卡支付购买
195：不可交易资产提币
196：不可交易资产提币撤销
197：不可交易资产充值
198：无效资产减少
199：有效资产增加
200：买入
202：价格锁定申购
203：价格锁定回款
204：价格锁定收益
205：价格锁定退款
207：双币赢精简版申购
208：双币赢精简版回款
209：双币赢精简版收益
210：双币赢精简版退款
211：投聪夺币中奖
212：多币种借贷锁定质押物
213：多币种质押物转出用户帐户
214：多币种质押物返还用户
215：多币种借贷释放质押物
216：多币种借贷划转到用户帐户
217：多币种借贷借款转入
218：多币种借贷还款
219：多币种还款由用户帐户转入
220：已下架数字货币
221：提币手续费支出
222：提币手续费退款
223：带单分润
224：服务费
225：鲨鱼鳍申购
226：鲨鱼鳍回款
227：鲨鱼鳍收益
228：鲨鱼鳍退款
229：空投发放
230：换币完成
232：利息补贴已入账
233：经纪商佣金补偿
263：策略分润
270：DCD经纪商划转
271：DCD经纪商返佣
284：转出交易子账户
285：转入交易子账户
286: 转出托管资金账户
287: 转入托管资金账户
288: 托管资金入金
289: 托管资金出金
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=BTC&amt=0.01

请求参数

参数 类型 是否必须 描述
ccy String 是 币种，仅支持BTC
amt String 是 充值数量，推荐在0.000001〜0.1之间
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-ERC20，USDT-TRC20，USDT-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

查询从2022年06月01日到2022年07月01日之间的BTC的充值记录
GET /api/v5/asset/deposit-history?ccy=BTC&after=1654041600000&before=1656633600000

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种名称，如 BTC
depId String 否 充值记录 ID
fromWdId String 否 内部转账发起者提币申请 ID
如果该笔充值来自于内部转账，则该字段展示内部转账发起者的提币申请 ID
txId String 否 区块转账哈希记录
type String 否 充值方式
3：内部转账
4：链上充值
state String 否 充值状态
0：等待确认
1：确认到账
2：充值成功
8：因该币种暂停充值而未到账，恢复充值后自动到账
11：命中地址黑名单
12：账户或充值被冻结
13：子账户充值拦截
14：KYC限额
after String 否 查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1654041600000
before String 否 查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1656633600000
limit string 否 返回的结果集数量，默认为100，最大为100，不填默认返回100条

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
        "actualDepBlkConfirm": "2",
        "amt": "1",
        "areaCodeFrom": "",
        "ccy": "USDT",
        "chain": "USDT-TRC20",
        "depId": "88****33",
        "from": "",
        "fromWdId": "",
        "state": "2",
        "to": "TN4hGjVXMzy*********9b4N1aGizqs",
        "ts": "1674038705000",
        "txId": "fee235b3e812********857d36bb0426917f0df1802"
    },
    {
        "actualDepBlkConfirm": "",
        "amt": "11",
        "areaCodeFrom": "86",
        "ccy": "USDT",
        "chain": "USDT-Omni",
        "depId": "53****85",
        "from": "158****5369",
        "fromWdId": "",
        "state": "2",
        "to": "",
        "ts": "1651809380000",
        "txId": "36532892_**********_0_WALLET"
    }
  ]
}

返回参数

参数名 类型 描述
ccy String 币种名称，如 BTC
chain String 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
amt String 充值数量
from String 充值账户
如果该笔充值来自于内部转账，则该字段展示内部转账发起者的账户信息，可以是手机号、邮箱、账户名称，其他情况返回""
areaCodeFrom String 如果from为手机号，该字段为该手机号的区号
to String 到账地址
如果该笔充值来自于链上充值，则该字段展示链上地址，其他情况返回""
txId String 区块转账哈希记录
ts String 充值到账时间，Unix 时间戳的毫秒数格式，如 1655251200000
state String 充值状态
0：等待确认
1：确认到账
2：充值成功
8：因该币种暂停充值而未到账，恢复充值后自动到账
11：命中地址黑名单
12：账户或充值被冻结
13：子账户充值拦截
14：KYC限额
depId String 充值记录 ID
fromWdId String 内部转账发起者提币申请 ID
如果该笔充值来自于内部转账，则该字段展示内部转账发起者的提币申请 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：内部转账
4：链上提币
toAddr String 是 如果选择链上提币，toAddr必须是认证过的数字货币地址。某些数字货币地址格式为地址:标签，如 ARDOR-7JF3-8F2E-QUWZ-CAN7F:123456
如果选择内部转账，toAddr必须是接收方地址，可以是邮箱、手机或者账户名。
fee String 是 网络手续费≥0，提币到数字货币地址所需网络手续费可通过获取币种列表接口查询
chain String 可选 币种链信息
如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
如果没有不填此参数，则默认为主链
对于无效资产提币，不填此参数，则默认为唯一的提币链
areaCode String 可选 手机区号
当toAddr为手机号时，该参数必填
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-ERC20，USDT-TRC20，USDT-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

查询从2022年06月01日到2022年07月01日之间的BTC的提币记录
GET /api/v5/asset/withdrawal-history?ccy=BTC&after=1654041600000&before=1656633600000

请求参数

参数名 类型 是否必须 描述
ccy String 否 币种名称，如 BTC
wdId String 否 提币申请ID
clientId String 否 客户自定义ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
txId String 否 区块转账哈希记录
type String 否 提币方式
3：内部转账
4：链上提币
state String 否 提币状态
-3：撤销中
-2：已撤销
-1：失败
0：等待提币
1：提币中
2：提币成功
7: 审核通过
10: 等待划转
4, 5, 6, 8, 9, 12: 等待客服审核
after String 否 查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1654041600000
before String 否 查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1656633600000
limit string 否 返回的结果集数量，默认为100，最大为100，不填默认返回100条

返回结果

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

返回参数

参数名 类型 描述
ccy String 币种
chain String 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
nonTradableAsset Boolean 是否为不可交易资产
true：不可交易资产，false：可交易资产
amt String 数量
ts String 提币申请时间，Unix 时间戳的毫秒数格式，如 1655251200000
from String 提币账户
可以是邮箱/手机号
areaCodeFrom String 如果from为手机号，该字段为该手机号的区号
to String 收币地址
areaCodeTo String 如果to为手机号，该字段为该手机号的区号
tag String 部分币种提币需要标签，若不需要则不返回此字段
pmtId String 部分币种提币需要此字段（payment_id），若不需要则不返回此字段
memo String 部分币种提币需要此字段，若不需要则不返回此字段
addrEx Object 提币地址备注，部分币种提币需要，若不需要则不返回此字段。如币种TONCOIN的提币地址备注标签名为comment,则该字段返回：{'comment':'123456'}
txId String 提币哈希记录
内部转账该字段返回""
fee String 提币手续费数量
feeCcy String 提币手续费币种，如 USDT
state String 提币状态
-3：撤销中
-2：已撤销
-1：失败
0：等待提币
1：提币中
2：提币成功
7: 审核通过
10: 等待划转
4, 5, 6, 8, 9, 12: 等待客服审核
wdId String 提币申请ID
clientId String 客户自定义ID

获取充值/提现的详细状态

获取充值与提现的详细状态信息与预估完成时间。

限速：1次/2s

限速规则：UserID

HTTP请求

GET /api/v5/asset/deposit-withdraw-status

请求示例

// 查询充值
GET /api/v5/asset/deposit-withdraw-status?txId=xxxxxx&to=1672734730284&ccy=USDT&chain=USDT-ERC20

// 查询提现
GET /api/v5/asset/deposit-withdraw-status?wdId=200045249

请求参数

参数 类型 是否必须 描述
wdId String 可选 提币申请ID，用于查询资金提现
wdId与txId必传其一也仅可传其一
txId String 可选 区块转账哈希记录ID，用于查询资金充值
wdId与txId必传其一也仅可传其一
ccy String 可选 币种，如USDT
查询充值时必填，需要与txId一并提供
to String 可选 资金充值到账账户地址
查询充值时必填，需要与txId一并提供
chain String 可选 币种链信息，例如 USDT-ERC20
查询充值时必填，需要与txId一并提供

返回结果

{
    "code":"0",
    "data":[
        {
            "wdId": "200045249",
            "txId": "16f3638329xxxxxx42d988f97", //此时提现如生成了txId将一并返回
            "state": "Pending withdrawal: Wallet is under maintenance, please wait.",
            "estCompleteTime": "01/09/2023, 8:10:48 PM"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
estCompleteTime String 预估完成时间
时区为 UTC+8；格式为 MM/dd/yyyy, h:mm:ss AM/PM
estCompleteTime仅为预估完成时间，仅供参考
state String 充值/提现的现处于的详细阶段提示
冒号前面代表阶段，后面代表状态
txId String 区块转账哈希记录
如查询的是提现，则txId返回为空""，此时提现如生成了txId将一并返回
wdId String 提币申请ID
如查询的是充值，则wdId返回为空""

小额资产兑换

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

限速：1次/s

限速规则：UserID

HTTP请求

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

请求示例

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

请求参数

参数名 类型 是否必须 描述
ccy Array of strings 是 需要转换的币种资产，如 ["BTC","USDT"]

返回结果

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

返回参数

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

闪兑

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

获取闪兑币种列表

限速：6次/s

限速规则：UserID

HTTP 请求

GET /api/v5/asset/convert/currencies

请求示例

GET /api/v5/asset/convert/currencies

请求参数

无

返回结果

{
    "code": "0",
    "data": [
        {
            "min": "",  // 已废弃
            "max": "",  // 已废弃
            "ccy": "BTC"
        },
        {
            "min": "",
            "max": "",
            "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 计价货币支持闪兑的最小值

闪兑预估询价

限速：10次/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 否 订单标签
适用于broker用户

返回结果

{
    "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 闪兑计价币数量

闪兑交易

限速：10次/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 否 订单标签
适用于broker用户

返回结果

{
    "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-USDT中BTC
quoteCcy String 计价货币币种，如 BTC-USDT中USDT
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 否 订单标签
适用于broker用户

返回结果

{
    "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",
                    "spotInUseAmt":""
                },
                {
                    "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",
                    "spotInUseAmt":""
                }
            ],
            "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 逐仓未实现盈亏
适用于单币种保证金模式和跨币种保证金模式和组合保证金模式
> spotInUseAmt 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：期权
instType和instId同时传入的时候会校验instId与instType是否一致。
instId String 否 交易产品ID，如：BTC-USD-190927-5000-C
支持多个instId查询（不超过10个），半角逗号分隔
posId String 否 持仓ID
支持多个posId查询（不超过20个）。
存在有效期的属性，自最近一次平仓算起，满30天 posId 以及整个仓位会被清除。

返回结果

{
    "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",
        "spotInUseAmt": "",
        "spotInUseCcy": "",
        "thetaBS":"",
        "thetaPA":"",
        "tradeId":"109844",
        "bizRefId": "",
        "bizRefType": "",
        "quoteBal": "0",
        "baseBal": "0",
        "baseBorrowed": "",
        "baseInterest": "",
        "quoteBorrowed": "",
        "quoteInterest": "",
        "uTime":"1619507761462",
        "upl":"-0.0000009932766034",
        "uplLastPx":"-0.0000009932766034",
        "uplRatio":"-0.0025490556801078",
        "uplRatioLastPx":"-0.0025490556801078",
        "vegaBS":"",
        "vegaPA":"",
        "closeOrderAlgo":[
            {
                "algoId":"123",
                "slTriggerPx":"123",
                "slTriggerPxType":"mark",
                "tpTriggerPx":"123",
                "tpTriggerPxType":"mark",
                "closeFraction":"0.6"
            },
            {
                "algoId":"123",
                "slTriggerPx":"123",
                "slTriggerPxType":"mark",
                "tpTriggerPx":"123",
                "tpTriggerPxType":"mark",
                "closeFraction":"0.4"
            }
       ]
    }]
}

返回参数

参数名 类型 描述
instType String 产品类型
mgnMode String 保证金模式
cross：全仓
isolated：逐仓
posId String 持仓ID
posSide String 持仓方向
long：开平仓模式开多，pos为正
short：开平仓模式开空，pos为正
net：买卖模式（交割/永续/期权：pos为正代表开多，pos为负代表开空。币币杠杆时，pos均为正，posCcy为交易货币时，代表开多；posCcy为计价货币时，代表开空。）
pos String 持仓数量，逐仓自主划转模式下，转入保证金后会产生pos为0的仓位
baseBal String 交易币余额，适用于 币币杠杆（逐仓自主划转模式 和 一键借币模式）
quoteBal String 计价币余额 ，适用于 币币杠杆（逐仓自主划转模式 和 一键借币模式）
baseBorrowed String 交易币已借，适用于 币币杠杆（逐仓一键借币模式）
baseInterest String 交易币计息，适用于 币币杠杆（逐仓一键借币模式）
quoteBorrowed String 计价币已借，适用于 币币杠杆（逐仓一键借币模式）
quoteInterest String 计价币计息，适用于 币币杠杆（逐仓一键借币模式）
posCcy String 仓位资产币种，仅适用于币币杠杆仓位
availPos String 可平仓数量，适用于 币币杠杆,交割/永续（开平仓模式），期权（交易账户及保证金账户逐仓）。
avgPx String 开仓平均价
upl String 未实现收益（以标记价格计算）
uplRatio String 未实现收益率（以标记价格计算
uplLastPx String 以最新成交价格计算的未实现收益，主要做展示使用，实际值还是 upl
uplRatioLastPx 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
spotInUseAmt String 现货对冲占用数量
适用于组合保证金模式
spotInUseCcy String 现货对冲占用币种，如 BTC
适用于组合保证金模式
closeOrderAlgo Array 平仓策略委托订单。调用策略委托下单，且closeFraction=1 时，该数组才会有值。
> algoId String 策略委托单ID
> slTriggerPx String 止损触发价
> slTriggerPxType String 止损触发价类型
last：最新价格
index：指数价格
mark：标记价格
> tpTriggerPx String 止盈委托价
> tpTriggerPxType String 止盈触发价类型
last：最新价格
index：指数价格
mark：标记价格
> closeFraction String 策略委托触发时，平仓的百分比。1 代表100%
cTime String 持仓创建时间，Unix时间戳的毫秒数格式，如 1597026383085
uTime String 最近一次持仓更新时间，Unix时间戳的毫秒数格式，如 1597026383085
bizRefId String 外部业务id，e.g. 体验券id
bizRefType String 外部业务类型

查看历史持仓信息

获取最近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自动减仓;
状态叠加时，以最新的平仓类型为准状态为准。
posId String 否 持仓ID。存在有效期的属性，自最近一次平仓算起，满30天 posId 以及整个仓位会被清除。
after String 否 查询仓位更新 (uTime) 之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
before String 否 查询仓位更新 (uTime) 之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
limit String 否 分页返回结果的数量，最大为100，默认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",
            "direction": "long",
            "triggerPx": "",
            "type": "1",
            "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：对冲减仓 14: 大宗交易 15: 一键借币 18: 分润 22: 一键还债
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：强平卖出 108：穿仓补偿 110：强平换币转入 111：强平换币转出 125：自动减仓平多 126：自动减仓平空 127：自动减仓买入 128：自动减仓卖出 131：对冲买入 132：对冲卖出 170：到期行权 171：到期被行权 172：到期作废 112：交割平多 113：交割平空 117：交割/行权穿仓补偿 173：资金费支出 174：资金费收入 200:系统转入 201:手动转入 202:系统转出 203:手动转出 204: 大宗交易买 205: 大宗交易卖 206: 大宗交易开多 207: 大宗交易开空 208: 大宗交易平多 209: 大宗交易平空 210: 手动借币 211: 手动还币 212: 自动借币 213：自动还币" 16：强制还币 17：强制借币还息 224: 还债转入 225: 还债转出 250: 分润支出; 251: 分润退还; 252: 分润收入;
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：对冲减仓 14: 大宗交易 15: 一键借币 22: 一键还债 18: 分润
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：强平卖出 108：穿仓补偿 110：强平换币转入 111：强平换币转出 125：自动减仓平多 126：自动减仓平空 127：自动减仓买入 128：自动减仓卖出 131：对冲买入 132：对冲卖出 170：到期行权 171：到期被行权 172：到期作废 112：交割平多 113：交割平空 117：交割/行权穿仓补偿 173：资金费支出 174：资金费收入 200:系统转入 201:手动转入 202:系统转出 203:手动转出 204: 大宗交易买 205: 大宗交易卖 206: 大宗交易开多 207: 大宗交易开空 208: 大宗交易平多 209: 大宗交易平空 210: 手动借币 211: 手动还币 212: 自动借币 213：自动还币" 16：强制还币 17：强制借币还息 224: 还债转入 225: 还债转出 250: 分润支出; 251: 分润退还; 252: 分润收入;
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": "Lv1",
            "levelTmp": "",
            "mgnIsoMode": "automatic",
            "posMode": "net_mode",
            "spotOffsetType": "",
            "uid": "44705892343619584",
            "label": "V5 Test",
            "roleType": "0",
            "traderInsts": [],
            "opAuth": "0",
            "ip": "120.255.24.182,49.245.196.13",
            "perm": "read_only,withdraw,trade",
            "mainUid": "444810535339712570"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
uid String 当前请求的账户ID，账户uid和app上的一致
mainUid String 当前请求的母账户ID
如果 uid = mainUid，代表当前账号为母账户；如果 uid != mainUid，代表当前账户为子账户。
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：自主划转 quick_margin：一键借币（对于新的账户，包括新的子账户，有些默认是开仓划转，另外的默认是一键借币）
spotOffsetType String 现货对冲类型
1：现货对冲模式U模式 2：现货对冲模式币模式 3：非现货对冲模式
适用于组合保证金模式
roleType String 用户角色。
0：普通用户；1：带单者；2：跟单者
traderInsts Array 当前账号已经设置的带单合约，仅适用于带单者
opAuth String 是否开通期权交易
0 未开通，1 已经开通
label String 当前请求API key的备注名，不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。
ip String 当前请求API key绑定的ip地址，多个ip用半角逗号隔开，如：117.37.203.58,117.37.203.57。
如果没有绑定ip，会返回空字符串""
perm String 当前请求的 API key权限 read_only：只读；trade ：交易；withdraw: 提币

设置持仓模式

单币种账户和跨币种账户模式：交割和永续合约支持开平仓模式和买卖模式。买卖模式只会有一个方向的仓位；开平仓模式可以分别持有多、空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 持仓方式

设置杠杆倍数


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

  1. 在逐仓交易模式下，设置币币杠杆的杠杆倍数（币对层面）；
  2. 单币种保证金账户在全仓交易模式下，设置币币杠杆的杠杆倍数（币对层面）；
  3. 跨币种保证金账户在全仓交易模式下，设置币币杠杆的杠杆倍数（币种层面）；
  4. 组合保证金账户在全仓交易模式下，设置币币杠杆的杠杆倍数（币种层面）；
  5. 在全仓交易模式下，设置交割的杠杆倍数（指数层面）；
  6. 在逐仓交易模式、买卖持仓模式下，设置交割的杠杆倍数（合约层面）；
  7. 在逐仓交易模式、开平仓持仓模式下，设置交割的杠杆倍数（合约与持仓方向层面）；
  8. 在全仓交易模式下，设置永续的杠杆倍数（合约层面）；
  9. 在逐仓交易模式、买卖持仓模式下，设置永续的杠杆倍数（合约层面）；
  10. 在逐仓交易模式、开平仓持仓模式下，设置永续的杠杆倍数（合约与持仓方向层面）；

注意请求参数 posSide 仅在交割/永续的开平仓持仓模式下才需要填写（参见场景7和10）。
请参阅右侧对应的每个案例的请求示例。

限速：20次/2s

限速规则：UserID

HTTP请求

POST /api/v5/account/set-leverage

请求示例

# 1.在`逐仓`交易模式下，设置`币币杠杆`的杠杆倍数（币对层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT",
    "lever":"5",
    "mgnMode":"isolated"
}

# 2.`单币种保证金`账户在`全仓`交易模式下，设置`币币杠杆`的杠杆倍数（币对层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT",
    "lever":"5",
    "mgnMode":"cross"
}

# 3.`跨币种保证金`账户在`全仓`交易模式下，设置`币币杠杆`的杠杆倍数（币种层面）
POST /api/v5/account/set-leverage
body
{
    "ccy":"BTC",
    "lever":"5",
    "mgnMode":"cross"
}

# 4. `组合保证金`账户在`全仓`交易模式下，设置`币币杠杆`的杠杆倍数（币种层面）
POST /api/v5/account/set-leverage
body
{
    "ccy":"BTC",
    "lever":"5",
    "mgnMode":"cross"
}

# 5.在`全仓`交易模式下，设置`交割`的杠杆倍数（指数层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT-200802",
    "lever":"5",
    "mgnMode":"cross"
}

# 6.在`逐仓`交易模式、`买卖`持仓模式下，设置`交割`的杠杆倍数（合约层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT-200802",
    "lever":"5",
    "mgnMode":"isolated"
}

# 7.在`逐仓`交易模式、`开平仓`持仓模式下，设置`交割`的杠杆倍数（合约与头寸层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT-200802",
    "lever":"5",
    "posSide":"long",
    "mgnMode":"isolated"
}

# 8.在`全仓`交易模式下，设置`永续`的杠杆倍数（合约层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT-SWAP",
    "lever":"5",
    "mgnMode":"cross"
}

# 9.在`逐仓`交易模式、`买卖`持仓模式下，设置`永续`的杠杆倍数（合约层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT-SWAP",
    "lever":"5",
    "mgnMode":"isolated"
}

# 10.在`逐仓`交易模式、`开平仓`持仓模式下，设置`永续`的杠杆倍数（合约与头寸层面）
POST /api/v5/account/set-leverage
body
{
    "instId":"BTC-USDT-SWAP",
    "lever":"5",
    "posSide":"long",
    "mgnMode":"isolated"
}

请求参数

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

返回结果

{
    "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 否 开仓杠杆倍数
默认为当前杠杆倍数
仅适用于币币杠杆/交割/永续
unSpotOffset Boolean 否 true：禁止现货对冲，false：允许现货对冲
默认为false
仅适用于组合保证金模式
开启现货对冲模式下有效，否则忽略此参数。

返回结果

{
    "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 否 是否为只减仓模式，仅适用于币币杠杆
unSpotOffset Boolean 否 true：禁止现货对冲，false：允许现货对冲
默认为false
仅适用于组合保证金模式
开启现货对冲模式下有效，否则忽略此参数。
quickMgnType String 否 一键借币类型，仅适用于杠杆逐仓的一键借币模式：
manual：手动，auto_borrow： 自动借币，auto_repay： 自动还币
默认是manual：手动

返回结果

{
    "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 否 标的指数
适用于交割/永续/期权，如 BTC-USD
instFamily String 否 交易品种
适用于交割/永续/期权，如 BTC-USD

返回结果

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

返回参数

参数名 类型 描述
level String 手续费等级
taker String USDT&USDⓈ&Crypto 交易区的吃单手续费率，永续和交割合约时，为币本位合约费率
maker String USDT&USDⓈ&Crypto 交易区挂单手续费率，永续和交割合约时，为币本位合约费率
takerU String USDT 合约吃单手续费率，仅适用于交割/永续
makerU String USDT 合约挂单手续费率，仅适用于交割/永续
delivery String 交割手续费率
exercise String 行权手续费率
instType String 产品类型
takerUSDC String USDC 交易区的吃单手续费率，包括 USDC 现货和 USDC 合约
makerUSDC String USDC 交易区的挂单手续费率，包括 USDC 现货和 USDC 合约
ts String 数据返回时间，Unix时间戳的毫秒数格式，如 1597026383085
category String 币种类别，注意：此参数已废弃

获取计息记录

限速：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:自主划转
quick_margin:一键借币
type String 是 业务线类型

MARGIN:币币杠杆
CONTRACTS:合约

返回结果

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

返回参数

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

查看账户最大可转余额

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

限速：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",
            "spotOffsetMaxWd": "",
            "spotOffsetMaxWdEx": ""
        },
        {
            "ccy": "ETH",
            "maxWd": "10",
            "maxWdEx": "12",
            "spotOffsetMaxWd": "",
            "spotOffsetMaxWdEx": ""
        }
    ]
}

返回参数

参数名 类型 描述
ccy String 币种
maxWd String 最大可划转数量（不包含跨币种保证金模式借币金额）
maxWdEx String 最大可划转数量（包含跨币种保证金模式借币金额）
spotOffsetMaxWd String 现货对冲不支持借币最大可转数量
仅适用于组合保证金模式
spotOffsetMaxWdEx 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： 当前账户为特定风险状态
false： 当前不是特定风险状态
atRiskIdx Array 衍生品的risk unit列表
atRiskMgn Array 杠杆的risk unit列表
ts String 接口数据返回时间 ，Unix时间戳的毫秒数格式，如 1597026383085

一键借币模式手动借币还币

限速：5次/2s

限速规则：UserID

HTTP请求

POST /api/v5/account/quick-margin-borrow-repay

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 是 产品ID，如BTC-USDT
ccy String 是 借贷币种，如 BTC
side String 是 borrow：借币，repay：还币
amt String 是 借/还币的数量

返回结果

{
    "code": "0",
    "data": [
        {
            "amt": "100",
            "instId":"BTC-USDT",
            "ccy": "USDT",
            "side": "borrow"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
instId String 产品ID，如BTC-USDT
ccy String 借贷币种，如 BTC
side String borrow：借币，repay：还币
amt String 借/还币的数量

获取一键借币还币历史

限速：5次/2s

限速规则：UserID

HTTP请求

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

请求示例

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

请求参数

参数名 类型 是否必须 描述
instId String 否 产品ID，如 BTC-USDT
ccy String 否 借贷币种，如 BTC
side String 否 borrow：借币，repay：还币
after String 否 请求此 ID 之前（更旧的数据）的分页内容，传的值为对应接口的refId
before String 否 请求此 ID 之后（更新的数据）的分页内容，传的值为对应接口的refId
begin String 否 筛选的开始时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
end String 否 筛选的结束时间戳，Unix 时间戳为毫秒数格式，如 1597027383085
limit String 否 返回结果的数量，最大为100，默认100条

返回结果

{
    "code": "0",
    "data": [
        {
            "instId": "BTC-USDT",
            "ccy": "USDT",
            "side": "borrow",
            "accBorrowed": "0.01",
            "amt": "0.005",
            "refId": "1637310691470124",
            "ts": "1637310691470"
        },
        {
            "instId": "BTC-USDT",
            "ccy": "USDT",
            "side": "borrow",
            "accBorrowed": "0.01",
            "amt": "0.005",
            "refId": "1637310691470123",
            "ts": "1637310691400"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
instId String 产品ID，如 BTC-USDT
ccy String 借贷币种，如 BTC
side String borrow：借币，repay：还币
accBorrowed String 累计借币
amt String 借/还币的数量
refId String 对应记录ID，借币或还币的ID
ts String 借/还币时间

尊享借币还币

单个币种的借币订单数量最多为20个

限速：6次/s

限速规则：UserID

HTTP请求

POST /api/v5/account/borrow-repay

请求示例

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

请求参数

参数名 类型 是否必须 描述
ccy String 是 借贷币种，如 BTC
side String 是 borrow：借币，repay：还币
amt String 是 借/还币的数量
ordId String 可选 借币订单ID，还币时，该字段必填

返回结果

{
    "code": "0",
    "data": [
        {
            "amt": "70809.316200",
            "ccy": "USDT",
            "ordId": "544199684697214976",
            "side": "borrow",
            "state": "1"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 借贷币种，如 BTC
side String borrow：借币，repay：还币
amt String 已借/还币的数量
ordId String 借币订单ID
state String 订单状态
1:借币申请中
2:借币中
3:还币申请中
4:已还币
5:借币失败

获取尊享借币还币历史

限速：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/vip-interest-accrued

请求示例

GET /api/v5/account/vip-interest-accrued

请求参数

参数名 类型 是否必须 描述
ccy String 否 借贷币种，如 BTC，仅适用于币币杠杆
ordId String 否 借币订单ID
after String 否 请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如 1597026383085
before String 否 请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如 1597026383085
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "ccy": "USDT",
            "interest": "0.0003960833333334",
            "interestRate": "0.0000040833333333",
            "liab": "97",
            "ordId": "16373124000001235",
            "ts": "1637312400000"
        },
        {
            "ccy": "USDT",
            "interest": "0.0004083333333334",
            "interestRate": "0.0000040833333333",
            "liab": "100",
            "ordId": "16370496000001234",
            "ts": "1637049600000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ordId String 借币订单ID
ccy String 借贷币种，如 BTC
interest String 利息
interestRate String 计息利率(小时)
liab String 计息负债
ts String 计息时间，Unix时间戳的毫秒数格式，如 1597026383085

获取尊享借币扣息记录

限速：5次/2s

限速规则：UserID

HTTP请求

GET /api/v5/account/vip-interest-deducted

请求示例

GET /api/v5/account/vip-interest-deducted

请求参数

参数名 类型 是否必须 描述
ordId String 否 借币订单ID
ccy String 否 借贷币种，如 BTC，仅适用于币币杠杆
after String 否 请求此时间戳之前（更旧的数据）的分页内容，Unix时间戳的毫秒数格式，如 1597026383085
before String 否 请求此时间戳之后（更新的数据）的分页内容，Unix时间戳的毫秒数格式，如 1597026383085
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "ccy": "USDT",
            "interest": "0.0003960833333334",
            "interestRate": "0.0000040833333333",
            "liab": "97",
            "ordId": "16373124000001235",
            "ts": "1637312400000"
        },
        {
            "ccy": "USDT",
            "interest": "0.0004083333333334",
            "interestRate": "0.0000040833333333",
            "liab": "100",
            "ordId": "16370496000001234",
            "ts": "1637049600000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ordId String 借币订单ID
ccy String 借贷币种，如 BTC
interest String 利息
interestRate String 计息利率(小时)
liab String 计息负债
ts String 计息时间，Unix时间戳的毫秒数格式，如 1597026383085

尊享借币订单列表

限速：5次/2s

限速规则：UserID

HTTP请求

GET /api/v5/account/vip-loan-order-list

请求示例

GET /api/v5/account/vip-loan-order-list

请求参数

参数名 类型 是否必须 描述
ordId String 否 借币订单ID
state String 否 订单状态
1:借币申请中
2:借币中
3:还币申请中
4:已还币
5:借币失败
ccy String 否 借贷币种，如 BTC
after String 否 请求此ID之前（更旧的数据）的分页内容，传的值为对应接口的ordId
before String 否 请求此ID之后（更新的数据）的分页内容，传的值为对应接口的ordId
limit String 否 返回结果的数量，最大为100，默认100条

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
         {
            "borrowAmt": "1.5000000000000000",
            "ccy": "USDT",
            "curRate": "0.0000169999999992",
            "dueAmt": "0.0000000000000000",
            "nextRefreshTime": "1688172235000",
            "ordId": "584301085292781568",
            "origRate": "0.0000169999999992",
            "repayAmt": "1.5000000000000000",
            "state": "4",
            "ts": "1685580235000"
        }
   ]
}

返回参数

参数名 类型 描述
ts String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085
nextRefreshTime String 下一次理论刷新时间，Unix时间戳的毫秒数格式，如 1597026383085
ccy String 借贷币种，如 BTC
ordId String 订单ID
state String 订单状态
1:借币申请中
2:借币中
3:还币申请中
4:已还币
5:业务异常，借币失败
origRate String 订单原始利率
curRate String 借贷币种当前利率
dueAmt String 待还数量
borrowAmt String 借币数量
repayAmt String 还币数量

尊享借币订单详情

限速：5次/2s

限速规则：UserID

HTTP请求

GET /api/v5/account/vip-loan-order-detail

请求示例

GET /api/v5/account/vip-loan-order-detail

请求参数

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

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "amt": "1.5000000000000000",
            "ccy": "USDT",
            "failReason": "",
            "rate": "0.0000000000000000",
            "ts": "1685580264572",
            "type": "2"
        }
   ]
}

返回参数

参数名 类型 描述
ts String 操作时间
ccy String 借贷币种，如 BTC
type String 操作类型
1:借币
2:还币
3:系统还币
4:利率刷新
rate String 订单当前利率
amt String 借还数量
failReason 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",
            "loanAlloc": "", 
            "records": [
                {
                    "availLoan": "0.0000000000000000",
                    "ccy": "BTC",
                    "interest": "",
                    "loanQuota": "120.0000000000000000",
                    "posLoan": "0",
                    "rate": "0.00199200",
                    "avgRate": "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
loanAlloc String 当前交易账户尊享借币可用额度的比率（百分比）
1. 范围为[0, 100]. 精度为 0.01% (2位小数)
2. 0 代表母账户没有为子账户分配；
3. "" 代表母子账户共享
records Array 各币种详细信息
> ccy String 借贷币种，如 BTC
> rate String 日利率
> loanQuota String 母账户维度借币限额
如果 loanAlloc 不为 ""，该字段代表当前交易账户的借币限额
> surplusLmt String 母子账户剩余可借
如果 loanAlloc 不为 ""，该字段代表当前交易账户的剩余可借
> usedLmt String 母子账户已借额度
如果 loanAlloc 不为 ""，该字段代表当前交易账户的已借额度
> interest String 已计未扣利息
仅适用于市场借币
> posLoan String 当前账户负债占用（锁定额度内）
仅适用于尊享借币
> availLoan String 当前账户剩余可用（锁定额度内）
仅适用于尊享借币
> usedLoan String 当前账户已借额度
仅适用于尊享借币
> avgRate 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
spotOffsetType String 否 现货对冲模式
1：现货对冲模式U模式 2：现货对冲模式币模式 3：衍生品模式
默认是 3
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"
        },
        {
            "acctImr": "6847.294720745276",
            "acctMmr": "5140.116514138115"
        }
    ],
    "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 减仓成本压力测试值
acctImr String 账户维度的最低初始保证金
acctMmr 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

获取组合保证金模式仓位限制

仅支持获取组合保证金模式下，交割、永续和期权的全仓仓位限制。

限速：10次/2s

限速规则：UserID

HTTP请求

GET /api/v5/account/position-tiers

请求示例

查看BTC-USDT在组合保证金模式下的全仓限制
GET /api/v5/account/position-tiers?instType=SWAP&uly=BTC-USDT

请求参数

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

返回结果

{
  "code": "0",
  "data": [
    {
      "instFamily": "BTC-USD",
      "maxSz": "10000",
      "posType": "",
      "uly": "BTC-USDT"
    }
  ],
  "msg": ""
}

返回参数

参数名 类型 描述
uly String 标的指数
适用于交割/永续/期权
instFamily String 交易品种
适用于交割/永续/期权
maxSz String 最大持仓量
posType String 限仓类型，仅适用于组合保证金模式下的期权全仓。
1：所有合约挂单 + 持仓张数，2：所有合约总挂单张数，3：所有合约总挂单单数，4：同方向合约挂单 + 持仓张数，5：单一合约总挂单单数，6：单一合约挂单 + 持仓张数，7：单笔挂单张数"

设置组合保证金账户风险对冲模式

设置 Portfolio Margin 账户风险对冲模式

限速：10次/2s

限速规则：UserID

HTTP请求

POST /api/v5/account/set-riskOffset-type

请求示例

POST /api/v5/account/set-riskOffset-type
body 
{
    "type":"1"
}

请求参数

参数名 类型 是否必须 描述
type String 是 风险对冲模式
1：现货对冲(USDT)
2:现货对冲(币)
3:衍生品对冲

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "type":"1"
    }]
}

返回参数

参数名 类型 描述
type String 风险对冲模式
1：现货对冲(USDT)
2:现货对冲(币)
3:衍生品对冲

开通期权交易

限速：5次/2s

限速规则：UserID

HTTP请求

POST /api/v5/account/activate-option

请求参数

无

返回结果

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

返回参数

参数名 类型 描述
ts String 开通时间

设置自动借币

仅适用于跨币种保证金模式和组合保证金模式

限速：5次/2s

限速规则：UserID

HTTP请求

POST /api/v5/account/set-auto-loan

请求示例

POST /api/v5/account/set-auto-loan
body
{
    "autoLoan":true,
}

请求参数

参数名 类型 是否必须 描述
autoLoan Boolean 否 是否自动借币
有效值为true, false
默认为 true

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "autoLoan": true
    }]
}

返回参数

参数名 类型 描述
autoLoan Boolean 是否自动借币

子账户

子账户功能模块下的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: 资管子账户
5: 托管子账户 - Copper
enable Boolean 子账户状态
true: 正常使用 false: 冻结
subAcct String 子账户名称
label String 子账户备注
mobile String 子账户绑定手机号
gAuth Boolean 子账户是否开启的登录时的谷歌验证
true: 已开启 false: 未开启
canTransOut Boolean 是否可以主动转出
true: 可以转出
false: 不可转出
ts String 子账户创建时间，Unix时间戳的毫秒数格式 ，如 1597026383085

重置子账户的APIKey

仅适用于母账户,且母账户APIKey必须绑定IP

限速：1次/s

限速规则：UserID

HTTP请求

POST /api/v5/users/subaccount/modify-apikey

请求示例

POST /api/v5/users/subaccount/modify-apikey
body
{
    "subAcct":"yongxu",
    "apiKey":"49e1b84b-6dee-4894-80ee-ce9eb7ad614f",
    "ip":"1.1.1.1"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
apiKey String 是 子账户API的公钥
label String 否 子账户APIKey的备注，如果填写该字段，则该字段会被重置
perm String 否 子账户APIKey权限 read_only：只读 ；trade ：交易
多个权限用半角逗号隔开。
如果填写该字段，则该字段会被重置
ip String 否 子账户APIKey绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip。
如果填写该字段，那该字段会被重置
如果ip传""，则表示解除IP绑定

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "subAcct": "yongxu",
        "label": "v5",
        "apiKey": "arg13sdfgs",
        "perm": "read,trade",
        "ip": "1.1.1.1",
        "ts": "1597026383085"
    }]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
label String APIKey的备注
apiKey String API公钥
perm String APIKey权限
ip String APIKey绑定的ip地址
ts String 创建时间

获取子账户交易账户余额

获取子账户交易账户余额（适用于母账户）

限速：6次/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 币种杠杆倍数
适用于单币种保证金模式

获取子账户资金账户余额

获取子账户资金账户余额（适用于母账户）

限速：6次/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 可用余额

查询子账户转账记录

仅适用于母账户

限速：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

子账户间资金划转

母账户控制子账户与子账户之间划转（仅适用于母账户）

调用时，APIKey 需要有交易权限

限速：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
omitPosRisk String 否 是否忽略仓位风险
默认为false
仅适用于组合保证金模式

返回结果

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

返回参数

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

设置子账户主动转出权限

设置子账户转出权限（仅适用于母账户），默认可转出至母账户。

限速：1次/s

限速规则：UserID

HTTP请求

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

请求示例