English
NAV Navbar
console

更新日志

生效时间(新加坡时间 UTC+8) 接口 新增/修改 摘要
2020.9.16 21:00 /api/swap/v3/market/contracts 修改 新增合约信息支持的最小最大杠杆倍数
2020.9.14 21:12 POST /api/swap/v3/position/changeHoldModel 新增 api接口支持全仓
2020.9.7 16:00 GET /api/swap/v3/market/historyFundRate 新增 代替之前的(获取合约历史资金费率)接口
2020.9.7 16:00 GET /api/swap/v3/order/history 新增 获取订单历史委托
2020.9.7 16:00 GET /api/swap/v3/order/current 新增 获取订单当前委托
2020.8.26 20:40 文档优化 修改 文档优化
2020.7.31 15:00 修改域名 修改 修改接入域名
2020.7.19 10:00 支持多语言 新增 支持中/英
2020.7.15 10:00 老版本API地址 新增 老版本API地址
2020.6.9 10:00 合约文档 新增 合约文档

老版本API地址

合约WebSocket行情,资产和交易推送API

WebSocket API

合约交易REST行情、交易API

Contract API

简介

API 简介

欢迎使用Bitget开发者文档!

此文档是Bitget API的唯一官方文档,Bitget API提供的能力会在此持续更新,请大家及时关注。

你可以通过点击上方菜单来切换获取不同业务的API,还可通过点击右上方的语言按钮来切换文档语言。

文档右侧是针对请求参数以及响应结果的示例。

市商/量化

欢迎有优秀 maker 策略且交易量大的用户参与长期做市商项目。请提供以下信息发送邮件至:

  1. 提供 UID (需不存在返佣关系的 UID);
  2. 提供其他交易平台 maker 交易量截图证明(比如30天内成交量);
  3. 请简要阐述做市方法,不需要细节。

更新关注

关于API新增、更新、下线等信息Bitget会提前发布公告进行通知,建议您关注和订阅我们的公告,及时获取相关信息。

您可以点击 这里 订阅公告。

联系我们

使用过程中如有问题或者建议,您可选择以下方式联系我们:

快速入门

接入准备

如需使用API ,请先登录网页端,完成API key的申请和权限配置,再据此文档详情进行开发和交易。

您可以点击 这里 创建 API Key。

每个用户可创建10组Api Key,每个Api Key可对应设置读取、交易两种权限。

权限说明如下:

创建成功后请务必记住以下信息:

SDK/代码示例

SDK(推荐)

Java | Python | Node

CCXT是我们的授权SDK提供者,您可以通过CCXT访问Bitget API。有关更多信息,请访问:https://ccxt.trade

接口类型

本章节主要为接口类型分以下两个方面:

公共接口

公共接口可用于获取配置信息和行情数据。公共请求无需认证即可调用。

私有接口

私有接口可用于订单管理和账户管理。每个私有请求必须使用规范的验证形式进行签名。

私有接口需要使用您的APIKey进行验证。

访问限制

本章节主要为访问限制:

Rest API

如果传入有效的APIKey 用APIKey限速;如果没有则拿公网IP限速。

限速规则:各个接口上有单独的说明,如果没有一般接口限速为 10次/秒。

特殊说明:批量下单时,若下4个币对,每个币对10个订单时,计为一次请求。

API域名

您可以自行使用Rest API接入方式进行操作。

域名 REST API 建议使用
域名1 https://capi.bitget.com 国际
域名2 https://capi.bitgetapi.com 中国地区

API验证

发起请求

所有REST请求的header都必须包含以下key:

签名

ACCESS-SIGN的请求头是对 timestamp + method.toUpperCase() + requestPath + "?" + queryString + body 字符串(+表示字符串连接)使用 HMAC SHA256 方法加密,通过BASE64 编码输出而得到的。

签名各字段说明

queryString为空时,签名格式

timestamp + method.toUpperCase() + requestPath + body

queryString不为空时,签名格式

timestamp + method.toUpperCase() + requestPath + "?" + queryString + body

举例说明

获取合约深度信息,以 cmt_btcusdt 为例:

生成待签名的字符串:

'1591089508404GET/api/swap/v1/market/depth?symbol=cmt_btcusdt&limit=20'

合约下单,以 cmt_btcusdt 为例:

生成待签名的字符串:

'1561022985382POST/api/swap/v3/order/placeOrder{"symbol":"cmt_btcusdt","size":"8","type":"1","match_price":"1","order_type":"1","client_oid":"bitget#123456"}'

生成最终签名的步骤

第1步,将待签名字符串使用私钥secretkey进行hmac sha256加密

Signature = hmac_sha256(secretkey, Message)

第2步,对于Signature进行base64编码

Signature = base64.encode(Signature)

请求交互

所有请求基于Https协议,请求头信息中Content-Type 需要统一设置为: 'application/json'。

请求交互说明

成功

HTTP状态码200表示成功响应,并可能包含内容。如果响应含有内容,则将显示在相应的返回内容里面。

常见错误码

标准规范

时间戳

请求签名中的ACCESS-TIMESTAMP的单位是毫秒。请求的时间戳必须在API服务时间的30秒内,否则请求将被视为过期并被拒绝。 如果本地服务器时间和API服务器时间之间存在较大的偏差,那么我们建议您使用通过查询API服务器时间来更新http header。

限频规则

如果请求过于频繁系统将自动限制请求,并在http header中返回429 too many requests状态码。

请求格式

目前只有两种格式的请求方法:GET和POST

合约行情接口

获取服务端时间

限速规则:20次/2s

HTTP请求 返回服务器的时间

返回数据:

{
    "epoch":"1591099099.896", //Unix时间戳的秒数
    "iso":"2020-06-02T11:58:19.896Z", //ISO8601标准的时间格式
    "timestamp":1591099099896 //Unix时间戳的毫秒数
}

返回值说明

返回字段 字段说明
epoch Unix时间戳的秒数
iso ISO8601标准的时间格式
timestamp Unix时间戳的毫秒数

获取合约信息

限速规则:20次/2s

HTTP请求 获取所有合约的信息

返回数据:

[
  {
    "symbol":"cmt_btcusdt",  //合约名称
    "coin":"USDT", //保证金币种
    "contract_val":"0.0001", //合约面值
    "delivery":[  //结算时间
         "07:00:00",
         "15:00:00",
         "23:00:00"
     ], 
    "forwardContractFlag":true, //是否是正向合约
    "priceEndStep":5, //价格最后一位步长
    "quote_currency":"USDT", //计价币种
    "size_increment":"0", //数量精度
    "tick_size":"1", //价格精度
    "underlying_index":"BTC" //合约币种
    "minLeverage":1 // 最小杠杆 
    "maxLeverage":100 //最大杠杆
  }
]

返回值说明

返回字段 字段说明
symbol 合约名称
coin 保证金币种
contract_val 合约面值
delivery 结算时间
forwardContractFlag 是否是正向合约
priceEndStep 价格最后一位步长
quote_currency 计价币种
size_increment 数量精度
tick_size 价格精度
underlying_index 合约币种
minLeverage 最小杠杆
maxLeverage 最大杠杆

获取深度数据

限速规则:20次/2s

HTTP请求 获取深度数据

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
limit Integer 深度大小 范围在(1-200)之间

返回数据:

{
   "asks":[
         [
            "8858.0", //价格
            "19299", //数量
              2.0  //废弃字段
        ]   
     ],
   "bids":[
         [
            "7466.0", //价格
            "499",  //数量
             1.0 //废弃字段
        ],
         [
            "4995.0",
            "12500",
              2.0  
        ]
     ],
   "timestamp":"1591237821479" 
}

返回值说明

返回字段 字段说明
asks 买方深度
bids 卖方深度
timestamp 时间戳

获取全部ticker信息

限速规则:20次/2s

HTTP请求 获取全部ticker信息

返回数据:


[
    {
        "symbol":"cmt_bchusdt", //合约名称
        "best_ask":"332.00",  //卖一价
        "best_bid":"203.00", //买一价
        "high_24h":"394",  //24小时最高价
        "last":"332",     //最新成交价
        "low_24h":"332", //24小时最低价
        "timestamp":"1591240033936", //系统时间戳
        "volume_24h":"0",  //24小时成交量
        "priceChangePercent": "-0.63"  //24小时价格变动百分比
 }
]

返回值说明

返回字段 字段说明
symbol 合约名称
best_ask 卖一价
best_bid 买一价
high_24h 24小时最高价
last 最新成交价
low_24h 24小时最低价
timestamp 系统时间戳
volume_24h 24小时成交量
priceChangePercent 24小时价格变动百分比

获取某个ticker信息

限速规则:20次/2s

HTTP请求 获取某个ticker信息

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

{
    "symbol":"cmt_btcusdt", //合约名称
    "best_ask":"8858.0", //卖一价
    "best_bid":"7466.0", //买一价
    "high_24h":"8858", //24小时最高价
    "last":"8858",  //最新成交价
    "low_24h":"8858", //24小时最低价
    "timestamp":"1591252726275", //系统时间戳
    "volume_24h":"0", //24小时成交量
    "priceChangePercent": "-0.63"  //24小时价格变动百分比
}

返回值说明

返回字段 字段说明
symbol 合约名称
best_ask 卖一价
best_bid 买一价
high_24h 24小时最高价
last 最新成交价
low_24h 24小时最低价
timestamp 系统时间戳
volume_24h 24小时成交量
priceChangePercent 24小时价格变动百分比

获取成交数据

限速规则:20次/2s

HTTP请求

获取成交数据

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
limit String 数据的size大小,范围在(1-100)

返回数据:

[
  {
      "symbol":"cmt_btcusdt", //合约名称
      "price":"7844.00", //成交价格
      "side":"buy", //成交方向:sell或者buy
      "size":"48", //成交数量
      "timestamp":"1591111746879", //成交时间戳
      "trade_id":"651735392382353615" //成交id
 }
]

返回值说明

返回字段 字段说明
symbol 合约名称
price 成交价格
side 成交方向:sell,buy
size 成交数量
timestamp 成交时间戳
trade_id 成交id

获取K线数据

限速规则:20次/2s

HTTP请求 获取K线数据

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
start String 开始时间 (UTC时间,格式为:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
end String 结束时间 (UTC时间,格式为:yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
granularity String K线的时间单位,粒度(取值参考如下列表)
key 描述
60 1分钟
5分钟 300
15分钟 900
30分钟 1800
1小时 3600
4小时 14400
12小时 43200
1天 86400
7天 604800

返回数据:

[
    "1556687460000", //系统时间戳
    "5315.5", //开盘价格
    "5315.5", //最高价格
    "5315.5", //最低价格
    "5315.5", //收盘价格
    "342", //交易量(按张折算)
    "0.064340137494" //交易量(按币折算)
]

返回值说明

返回字段 字段说明
timestamp 系统时间戳
open 开盘价格
high 最高价格
low 最低价格
close 收盘价格
volume 交易量(按张折算)
currency_volume 交易量(按币折算)

获取币种指数

限速规则:20次/2s

HTTP请求 获取币种指数

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

{
    "symbol":"cmt_btcusdt", //合约名称
    "index":"9654.1", //现货指数价格
    "timestamp":"1591256590003" //系统时间戳
}

返回值说明

返回字段 字段说明
symbol 合约名称
index 现货指数价格
timestamp 系统时间戳

获取平台总持仓量

限速规则:20次/2s

HTTP请求 获取平台总持仓量

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "amount":"425810",  //总持仓量
   "forwardContractFlag":true, //是否是正向合约
   "timestamp":"1591256880751" // 系统时间戳
}

返回值说明

返回字段 字段说明
symbol 合约名称
amount 总持仓量
forwardContractFlag 是否是正向合约
timestamp 系统时间戳

获取合约最高限价和最低限价

限速规则:20次/2s

HTTP请求 获取合约最高限价和最低限价 - GET /api/swap/v3/market/price_limit

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

{
     "symbol":"cmt_btcusdt",  //合约名称
     "forwardContractFlag":true, //是否是正向合约
     "highest":"14474.5", //最高买价
     "lowest":"4824.5", //最低卖价
     "timestamp":"1591257126461"  //系统时间戳
 }

返回值说明

返回字段 字段说明
symbol 合约名称
forwardContractFlag 是否是正向合约
highest 最高买价
lowest 最低卖价
timestamp 系统时间戳

获取合约下一次结算时间

限速规则:20次/2s

HTTP请求 获取合约下一次结算时间

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

 {
     "symbol":"cmt_btcusdt", //合约名称
     "forwardContractFlag":false, //是否是正向合约
     "funding_time":"1591282800000"  //下一次的结算时间
 }

返回值说明

返回字段 字段说明
symbol 合约名称
forwardContractFlag 是否是正向合约
funding_time 下一次的结算时间

获取合约历史资金费率

限速规则:20次/2s

HTTP请求 获取合约历史资金费率

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
pageIndex String 页码,为空默认第一页,从1开始
pageSize String 每页数据的条数

返回数据:

 {
     "symbol":"cmt_btcusdt", //合约名称
     "funding_rate":"0.001", //资金费率
     "funding_time":"19238271212" //结算时间
 }

返回值说明

返回字段 字段说明
symbol 合约名称
funding_rate 资金费率
funding_time 结算时间

获取合约标记价格

限速规则:20次/2s

HTTP请求 获取合约标记价格

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

 {
     "symbol":"cmt_btcusdt", //合约名称
     "mark_price":"8047.87", //标记价格
     "timestamp":"1591264230941" //系统时间戳
 }

返回值说明

返回字段 字段说明
symbol 合约名称
mark_price 标记价格
timestamp 系统时间戳

获取可开张数

限速规则:20次/2s

HTTP请求 获取可开张数

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
amount BigDecimal 开仓的总的金额
openPrice BigDecimal 开仓价格
leverage BigDecimal 杠杆默认20倍

返回数据:

{
   "openCount":"199999" //可开张数
 }

返回值说明

返回字段 字段说明
openCount 可开张数

合约账户接口

查询所有合约账户信息

限速规则:1次/s

HTTP请求 查询所有合约账户信息

返回数据:

[ 
  {
   "symbol":"cmt_btcusdt", //合约名称
   "equity":"0.00000000",  //账户权益
   "fixed_balance":"0.00000000",//废弃字段
   "total_avail_balance":"0.00000000", //可用余额
   "margin":"0", //已用保证金
   "realized_pnl":"0", //已实现盈亏
   "unrealized_pnl":"0", //未实现盈亏
   "margin_frozen":"0", //开仓冻结保证金
   "timestamp":"1658098718494", //创建时间
   "margin_mode":"fixed", //仓位模式 fixed逐仓模式 crossed全仓模式
   "forwardContractFlag":true //是否是正向合约
 }
]

返回值说明

返回字段 字段说明
symbol 合约名称
equity 账户权益
fixed_balance 逐仓可用余额
total_avail_balance 可用余额
margin 已用保证金
realized_pnl 已实现盈亏
unrealized_pnl 未实现盈亏
margin_frozen 开仓冻结保证金
timestamp 创建时间
margin_mode 仓位模式 fixed逐仓模式 crossed全仓模式
forwardContractFlag 是否是正向合约

单个合约账户信息

限速规则:5次/s

HTTP请求 单个合约账户信息

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "equity":"0.00000000", //账户权益
   "fixed_balance":"0.00000000", //废弃字段
   "total_avail_balance":"0.00000000", //可用余额
   "margin":"0", //已用保证金
   "realized_pnl":"0", //已实现盈亏
   "unrealized_pnl":"0", //未实现盈亏
   "margin_frozen":"0", //开仓冻结保证金
   "timestamp":"1658098718494", //创建时间
   "margin_mode":"fixed", //仓位模式 fixed逐仓模式 crossed全仓模式
   "forwardContractFlag":true //是否是正向合约
 }

返回值说明

返回字段 字段说明
symbol 合约名称
equity 账户权益
fixed_balance 逐仓可用余额
total_avail_balance 可用余额
margin 已用保证金
realized_pnl 已实现盈亏
unrealized_pnl 未实现盈亏
margin_frozen 开仓冻结保证金
timestamp 创建时间
margin_mode 仓位模式 fixed逐仓模式 crossed全仓模式
forwardContractFlag 是否是正向合约

获取单个合约的用户配置

限速规则:5次/s

HTTP请求 获取单个合约的用户配置

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

 {
   "symbol":"cmt_btcusdt", //合约名称
   "long_leverage":"100", //多仓杠杆
   "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
   "short_leverage":"2", //空仓杠杆
   "forwardContractFlag":true //是否是正向合约
 }

返回值说明

返回字段 字段说明
symbol 合约名称
long_leverage 多仓杠杆
margin_mode 持仓模式 fixed逐仓模式 crossed全仓模式
short_leverage 空仓杠杆
forwardContractFlag 是否是正向合约

调整杠杆

限速规则:5次/s

HTTP请求 调整杠杆

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
leverage Integer 杠杆倍数,可填写1-100之间的整数
side Integer 持仓方向(1-多仓,2-空仓) 标注废弃
holdSide Integer 持仓方向 (1-多仓,2-空仓)

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "long_leverage":"100", //多仓杠杆
   "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
   "short_leverage":"2", //空仓杠杆
   "forwardContractFlag":true //是否是正向合约
 }

返回值说明

返回字段 字段说明
symbol 合约名称
long_leverage 多仓杠杆
margin_mode 持仓模式 fixed逐仓模式 crossed全仓模式
short_leverage 空仓杠杆
forwardContractFlag 是否是正向合约

调整保证金

限速规则:20次/2s

HTTP请求 调整保证金

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
amount String 数量
positionType Integer 方向0多仓 1空仓
type Integer 类型1增加 2减少

返回数据:

 {
    "result":true, //结果
    "orderNo":"527252921197264814" //订单号
 }

返回值说明

返回字段 字段说明
result 结果
orderNo 订单号

自动追加保证金

限速规则:5次/s

HTTP请求 自动追加保证金

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
side Integer 持仓方向 1多仓 2空仓 标注废弃
holdSide Integer 持仓方向 1多仓 2空仓
append_type Integer 追加保证金类型 0 不自动追加 1 自动追加

返回数据:

 {
     "result":true, //设置结果
     "append_type":1 //当前设置状态:0表示不自动追加,1表示自动追加
 }

返回值说明

返回字段 字段说明
result 设置结果
append_type 当前设置状态:0表示不自动追加,1表示自动追加

获取全部合约仓位信息

限速规则:5次/s

HTTP请求 获取全部合约仓位信息

返回数据:

 [
 {
    "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
    "holding":[
           {
              "symbol":"cmt_btcusdt",  //合约名称
              "liquidation_price":"0.00", //预估爆仓价
              "position":"0", //持仓数量
              "avail_position":"0", //可平数量
              "avg_cost":"0.00", //开仓平均价
              "leverage":"2", //杠杆
              "realized_pnl":"0.00000000", //已实现盈亏
              "side":"1", //持仓方向  标注废弃
              "holdSide": "1",// 持仓方向
              "timestamp":"1557571623963", //系统时间戳
              "margin":"0.0000000000000000" //已用保证金
       }
     ]
 }
]

返回值说明

返回字段 字段说明
margin_mode 持仓模式 fixed逐仓模式 crossed全仓模式
symbol 合约名称
liquidation_price 预估爆仓价
position 持仓数量
avail_position 可平数量
avg_cost 开仓平均价
leverage 杠杆
realized_pnl 已实现盈亏
side 方向
holdSide 持仓方向
timestamp 系统时间戳
margin 已用保证金

获取单个合约仓位信息

限速规则:10次/s

HTTP请求 获取单个合约仓位信息

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

{
    "margin_mode":"fixed", //持仓模式 fixed逐仓模式 crossed全仓模式
    "holding":[
           {
              "symbol":"cmt_btcusdt", //合约名称
              "liquidation_price":"0.00", //预估爆仓价
              "position":"0", //持仓数量
              "avail_position":"0", //可平数量
              "avg_cost":"0.00", //开仓平均价
              "leverage":"2", //杠杆
              "realized_pnl":"0.00000000", //已实现盈亏
              "side":"1", //持仓方向    标注废弃
              "holdSide": "1",// 持仓方向
              "timestamp":"1557571623963", //系统时间戳
              "margin":"0.0000000000000000" //已用保证金
       }
     ]
 }

返回值说明

返回字段 字段说明
margin_mode 持仓模式 fixed逐仓模式 crossed全仓模式
symbol 合约名称
liquidation_price 预估爆仓价
position 持仓数量
avail_position 可平数量
avg_cost 开仓平均价
leverage 杠杆
realized_pnl 已实现盈亏
side 方向
holdSide 持仓方向
timestamp 系统时间戳
margin 已用保证金

修改用户账户模式

限速规则:20次/s

HTTP请求 修改用户账户模式

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
holdModel Integer 账户模式(1 逐仓 2 全仓)

返回数据:

 {
    "symbol":"cmt_btcusdt",     //合约名称
    "resultHoldMode":1,        //返回账户模式 1 逐仓 2 全仓
    "switchSuccess":true      //是否修改成功  true 成功  false 失败
}

返回值说明

返回字段 字段说明
symbol 合约名称
resultHoldMode 返回账户模式 1 逐仓 2 全仓
switchSuccess 是否修改成功 true 成功 false 失败

合约交易接口

下单

限速规则:10次/s

HTTP请求 下单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
client_oid String 自定义订单号(不超过50个字符,且不能是特殊字符,如火星字符等)
size String 下单数量(不能为0,不能为负数)
type String 1:开多 2:开空 3:平多 4:平空
order_type String 0:普通,1:只做maker;2:全部成交或立即取消;3:立即成交并取消剩余
match_price String 0:限价还是1:市价
price String 委托价格(有精度限制,精度(tick_size)和步长(priceEndStep)取“合约信息接口”,限价必填)

返回数据:

{
    "client_oid":"bitget#123456", //客户端请求标识
    "order_id":"513466539039522813" //订单号
}

返回值说明

返回字段 字段说明
client_oid 客户端请求标识
order_id 订单号

批量下单

限速规则:10次/s

HTTP请求 批量下单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
order_data String JSON类型的字符串 例:[{price:5,size:2,type:1,match_price:1,order_type:1,client_oid:"abc"},{price:5,size:2,type:1,match_price:1,order_type:1,client_oid:"abc"}],字段参考【合约下单】接口,且最多只能批量处理20笔订单 标注废弃
orderDataList List 对象属性 例(price=5,size=2,type=1,match_price=1,order_type=1,client_oid="abc"),字段参考【合约下单】接口,且最多只能批量处理20笔订单

返回数据:

{
    "result":true,
    "order_info":[
        {
            "result":true, //成交结果
            "client_oid":"dxdanzi", //客户端请求标识
            "order_id":"513468410013679613" //成交订单Id
        },
        {
            "result":true,
            "client_oid":"dxdanzi",
            "order_id":"513468410001096713"
        }
    ]
}

返回值说明

返回字段 字段说明
result 成交结果
client_oid 客户端请求标识
order_id 成交订单Id

取消订单

限速规则:10次/s

HTTP请求 取消订单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
orderId String 订单号

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "order_id":"513468410013679613", //订单号
   "client_oid":"dxdanzi", //客户端标识
   "result":true //取消结果
}

返回值说明

返回字段 字段说明
symbol 合约名称
order_id 订单号
client_oid 客户端标识
result 取消结果

批量撤单

限速规则:10次/s

HTTP请求 批量撤单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
ids List 订单号的集合

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "result":true, //处理结果
   "order_ids":[
          "258414711",//成功的id
          "478585558"
    ],
   "fail_infos":[
          {
        "order_id":"258414711", //失败的id
        "err_code":"401", //错误code
        "err_msg":""  //错误信息
     }
  ]
}

返回值说明

返回字段 字段说明
symbol 合约名称
result 处理结果
order_ids 订单ids
order_id 订单号
err_code 错误code
err_msg 错误信息

获取单订单信息

限速规则:10次/s

HTTP请求 获取单订单信息

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
orderId String 订单号

返回数据:

{
     "symbol":"cmt_btcusdt",//合约名称
     "size":"12", //委托数量
     "timestamp":"15582271175271", //废弃字段
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0",  //订单类型
     "totalProfits":"253" //总盈亏
}

返回值说明

返回字段 字段说明
symbol 合约名称
size 委托数量
timestamp 系统时间戳 //废弃字段
client_oid 客户端标识
createTime 创建时间戳
filled_qty 成交数量
fee 手续费
order_id 订单id
price 委托价格
price_avg 成交均价
status 订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type 委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type 订单类型 0:普通委托 1:只做Maker(Post only) 2:全部成交或立即取消(FOK) 3:立即成交并取消剩余(IOC)
totalProfits 总盈亏

获取订单列表 标注废弃

限速规则:10次/s

HTTP请求 获取订单列表

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
from String from 和to主要是组成查第几页的数据(默认为1)
to String from 和to主要是组成查第几页的数据 (默认为1)
limit String 分页返回的结果集数量,最大为100,不填默认返回100条,小于或等于0报异常,非数字型字符报异常
status String -1:已撤单(包含风险触发撤销),0:未成交,1:部分成交,2:完全成交, 3:未成交或部分成交,4:已撤单(包含风险触发撤销)或完全成交 5:所有状态

返回数据:

[
   {
     "symbol":"cmt_btcusdt", //合约名称
     "size":"12", //委托数量
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0", //订单类型
     "totalProfits":"253" //总盈亏
 }
]

返回值说明

返回字段 字段说明
symbol 合约名称
size 委托数量
client_oid 客户端标识
createTime 创建时间戳
filled_qty 成交数量
fee 手续费
order_id 订单id
price 委托价格
price_avg 成交均价
status 订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type 委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type 订单类型 0:普通委托 1:只做Maker(Post only) 2:全部成交或立即取消(FOK) 3:立即成交并取消剩余(IOC)
totalProfits 总盈亏

获取订单历史委托

限速规则:10次/s

HTTP请求 获取订单历史委托

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
pageIndex String 页码,为空默认第一页,从1开始
pageSize String 每页数据的条数
createDate Integer 天数 (天数必须小于或等于90,不能为负数)

返回数据:

[
   {
     "symbol":"cmt_btcusdt", //合约名称
     "size":"12", //委托数量
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0", //订单类型
     "totalProfits":"253" //总盈亏
 }
]

返回值说明

返回字段 字段说明
symbol 合约名称
size 委托数量
client_oid 客户端标识
createTime 创建时间戳
filled_qty 成交数量
fee 手续费
order_id 订单id
price 委托价格
price_avg 成交均价
status 订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type 委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type 订单类型 0:普通委托 1:只做Maker(Post only) 2:全部成交或立即取消(FOK) 3:立即成交并取消剩余(IOC)
totalProfits 总盈亏

获取订单当前委托

限速规则:10次/s

HTTP请求 获取订单当前委托

参数名 参数类型 是否必须 描述
symbol String 合约名称

返回数据:

[
   {
     "symbol":"cmt_btcusdt", //合约名称
     "size":"12", //委托数量
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0", //订单类型
     "totalProfits":"253" //总盈亏
 }
]

返回值说明

返回字段 字段说明
symbol 合约名称
size 委托数量
client_oid 客户端标识
createTime 创建时间戳
filled_qty 成交数量
fee 手续费
order_id 订单id
price 委托价格
price_avg 成交均价
status 订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type 委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type 订单类型 0:普通委托 1:只做Maker(Post only) 2:全部成交或立即取消(FOK) 3:立即成交并取消剩余(IOC)
totalProfits 总盈亏

查询成交明细

限速规则:10次/s

HTTP请求 查询成交明细

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
orderId String 订单号

返回数据:

[
  {
      "symbol":"cmt_btcusdt",  //合约名称
      "trade_id":"6667390", //成交Id
      "order_id":"525946425993854915", //订单id
      "price":"9839.00", //成交价格 
      "order_qty":"3466", //成交数量
      "fee":"-0.0000528407360000", //手续费
      "timestamp":"1561121514442", //创建时间戳
      "exec_type":"M", //流动性方向
      "side":"3", //委托类型    标注废弃
      "delegateType": "3" //委托类型
}
]

返回值说明

返回字段 字段说明
symbol 合约名称
trade_id 成交Id
order_id 订单id
price 成交价格
order_qty 成交数量
fee 手续费
timestamp 创建时间戳
exec_type 流动性方向,T:taker M:maker
side 委托类型(1:开多;2:开空;3:平多;4:平空;5:强制平多;6:强制平空;11:协议平多;12:协议平空;13:爆仓平多查询;14:爆仓平空查询
delegateType 委托类型(1:开多;2:开空;3:平多;4:平空;5:强制平多;6:强制平空;11:协议平多;12:协议平空;13:爆仓平多查询;14:爆仓平空查询

计划委托下单

限速规则:10次/s

HTTP请求 计划委托下单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
client_oid String 客户端请求标识(不超过50个字符,且不能是特殊字符,如火星字符等)
size String 下单张数(不能为0,不能为负数)
type String 类型 1开仓 2平仓
side String 持仓方向 1多仓 2空仓 标注废弃
holdSide String 持仓方向 1多仓 2空仓
match_type String 0:限价还是1:市价
execute_price String 执行价格
trigger_price String 触发价格

返回数据:

{
      "client_oid":"bitget#123456", //客户端标识
      "order_id":"589579827556646928" //计划委托订单号
}

返回值说明

返回字段 字段说明
client_oid 客户端标识
order_id 计划委托订单号

计划委托撤单

限速规则:10次/s

HTTP请求 计划委托撤单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
orderId String 订单号

返回数据:

 {
     "order_id":"5895798275566469458", //订单号
     "client_oid":"bitget#123456", //客户端标识
     "result":false, //是否撤销成功
     "err_code":"403", //撤销失败时的原因code
     "err_msg":"订单不存在" //撤销失败时的原因
}

返回值说明

返回字段 字段说明
order_id 订单号
client_oid 客户端标识
result 是否撤销成功
err_code 撤销失败时的原因code
err_msg 撤销失败时的原因

查询当前计划委托

限速规则:10次/s

HTTP请求 查询当前计划委托

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
side String 委托类型 1开多 2开空 3平多 4平空 标注废弃
delegateType String 委托类型 1开多 2开空 3平多 4平空
pageIndex String 当前页(1-200整数)
pageSize String 每页数量(1-100整数)
startTime String 查询开始时间(时间戳)
endTime String 查询结束时间(时间戳)

返回数据:

{
      "list":[
              {
                 "symbol":"cmt_btcusdt", //合约名称
                 "execute_count":"0", //执行数量
                 "delegate_count":"1222222", //委托数量
                 "create_time":1576294708136, //创建时间戳
                 "update_time":1576294708136, //更新时间戳
                 "direction":1, //方向
                 "direction_desc":"开多", //方向描述
                 "trigger_price":"22222210.0", //触发价格
                 "execute_price":"7490.0", //执行价格
                 "order_id":"589588227514433528", //订单号
                 "order_type":0, //订单类型
                 "status":1, //状态
                 "status_desc":"未执行状态", //状态描述
                 "create_trade_price":"7490" //计划委托时的成交价
           }
         ],
    "nextPage":false //是否有下一页
}

返回值说明

返回字段 字段说明
symbol 合约名称
nextPage 是否有下一页
execute_count 执行数量
delegate_count 委托数量
create_time 创建时间戳
update_time 更新时间戳
direction 方向 1开多 2开空 3平多 4平空"
direction_desc 方向 1开多 2开空 3平多 4平空"的描述
trigger_price 触发价格
execute_price 执行价格
order_id 订单号
order_type 订单类型 0限价 1市价
status 状态 1未执行状态 2已委托 3执行失败状态 4用户取消状态
status_desc 状态描述 (1未执行状态 2已委托 3执行失败状态 4用户取消状态)
create_trade_price 计划委托时的成交价

查询计划历史委托

限速规则:10次/s

HTTP请求 查询计划历史委托

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
side String 委托类型 1开多 2开空 3平多 4平空 标注废弃
delegateType String 委托类型 1开多 2开空 3平多 4平空
pageIndex String 当前页(1-200整数)
pageSize String 每页数量(1-100整数)
startTime String 查询开始时间(时间戳)
endTime String 查询结束时间(时间戳)

返回数据:

{
      "list":[
              {
                 "symbol":"cmt_btcusdt", //合约名称
                 "execute_count":"0", //执行数量
                 "delegate_count":"1222222",//委托数量
                 "create_time":1576294708136,//创建时间戳
                 "update_time":1576294708136, //更新时间戳
                 "direction":1, //方向
                 "direction_desc":"开多", //方向描述
                 "trigger_price":"22222210.0", //触发价格
                 "execute_price":"7490.0", //执行价格
                 "order_id":"589588227514433528", //订单号
                 "order_type":0, //订单类型
                 "status":1, // 订单状态
                 "status_desc":"未执行状态", //订单状态描述
                 "create_trade_price":"7490" //计划委托时的成交价
           }
         ],
    "nextPage":false //是否有下一页
}

返回值说明

返回字段 字段说明
symbol 合约名称
nextPage 是否有下一页
execute_count 执行数量
delegate_count 委托数量
create_time 创建时间戳
update_time 更新时间戳
direction 方向 1开多 2开空 3平多 4平空"
direction_desc 方向 1开多 2开空 3平多 4平空"的描述
trigger_price 触发价格
execute_price 执行价格
order_id 订单号
order_type 订单类型0限价 1市价
status 订单状态 1未执行状态 2已委托 3执行失败状态 4用户取消状态
status_desc 状态描述(1未执行状态 2已委托 3执行失败状态 4用户取消状态)
create_trade_price 计划委托时的成交价

RestAPI错误代码

公共错误码

错误提示 错误码 http状态码
请求头"ACCESS_KEY"不能为空 40001 400
请求头"ACCESS_SIGN"不能为空 40002 400
请求头"ACCESS_TIMESTAMP"不能为空 40003 400
无效的ACCESS_TIMESTAMP 40005 400
无效的ACCESS_KEY 40006 400
无效的Content_Type,请使用“application/json”格式 40007 400
请求时间戳过期 40008 400
api 校验失败 40009 400
请求太频繁 429 429
请求头"ACCESS_PASSPHRASE"不能为空 40011 400
apikey/passphrase不正确 40012 400
用户被冻结 40013 400
权限不正确 40014 400
系统错误 40015 400
用户必须绑定手机或者谷歌 40016 400
参数校验失败 40017 400
非法的ip请求 40018 400

合约错误码

错误提示 错误码 http状态码
合约配置不存在,请检查参数 40102 400
查不到该订单的数据,请确认订单号 40109 400
服务器升级,请稍后再试 40200 400
暂未获得使用权限,如需使用,请联系客服 40301 400
最多只能查询20000条数据 40303 400
client_oid长度不大于50,且不能是火星字符 40305 400
批量处理订单最多只能处理50条 40306 400
该合约正在临时维护 40308 400
该合约已下架 40309 400
状态校验异常 40400 400
该操作无法执行 40401 400
查询方向不是计划委托的方向 40407 400
范围错误 40408 400
格式错误 40409 400
只能查最近三个月的数据 40704 400
起止时间不能超过90天 40705 400
开始时间大于结束时间 40707 400
该仓位暂无持仓,不能设置自动追加保证金 40709 400
账户非正常状态 40710 400
合约账户余额不足 40711 400
保证金数量不足 40712 400
不能超过最大可转出保证金数量 40713 400
仓位为零,不允许直接追加保证金 40714 400
委托数量大于最大可开张数 40715 400
参数为空 40724 400
返回无映射信息 40725 400