English
NAV Navbar
console

更新日志

生效时间(新加坡时间 UTC+8) 接口 新增/修改 摘要
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 | Go | PHP

其它代码示例

https://github.com/BitgetLimited/Exchange_API

接口类型

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

公共接口

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

私有接口

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

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

访问限制

本章节主要为访问限制的细节分以下两个方面:

Rest API

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

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

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

WebSocket

WebSocket将每个命令类型限制为每秒xx条命令。

API域名

您可以自行比较使用Rest API和Websocket两个接入方式,选择延迟低的进行使用。

域名 REST API Websocket 建议使用
域名1 https://capi.bitget.com wss://csocketapi.bitget.com 国际
域名2 https://capi.bitgetapi.com wss://csocketapi.bitgetapi.com 国内

API验证

发起请求

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

签名

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

签名各字段说明

queryString为空时,签名格式

timestamp + method + requestPath + body

queryString不为空时,签名格式

timestamp + method + 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。

例如:1591094342502

限频规则

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

请求格式

所有的API请求都是restful,目前只有两种方法:GET和POST

分页请求

REST请求使用游标分页,参数如下,适合与查询/trades,/fills,/orders,默认返回100条记录。可以通【游标参数】指定要分页查询的方向,我们会标注支持游标查询的方法。

游标参数

参数名 参数类型 描述
gt String 大于,表示查询大于它的ID数据。
lt String 小于,表示查询小于它的ID数据。

分页游标

例如:GET /api/swap/v3/order/orders?gt=1&limit=50

实例

  1. GET /api/swap/v3/order/orders?gt=1&limit=50 查询订单id大于1的50条记录
  2. GET /api/swap/v3/order/orders?lt=100&limit=30 查询订单id小于100的30条记

限频规则

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

请求格式

所有的API请求都是restful,目前只有两种方法:GET和POST

合约行情接口

获取服务端时间

限速规则:20次/2s

HTTP请求 返回服务器的时间

返回数据:

{
    "epoch":"1591099099.896",
    "iso":"2020-06-02T11:58:19.896Z",
    "timestamp":1591099099896
}

返回值说明

返回字段 字段说明
epoch UTC时区Unix时间戳的十进制秒数格式
iso ISO8601标准的时间格式
timestamp 服务器的时间戳

获取合约信息

限速规则:20次/2s

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

返回数据:

[
  {
    "coin":"USDT",
    "contract_val":"0.0001",
    "delivery":[
         "07:00:00",
         "15:00:00",
         "23:00:00"
     ], 
    "forwardContractFlag":true,
    "symbol":"cmt_btcusdt",
    "priceEndStep":5,
    "quote_currency":"USDT",
    "size_increment":"0",
    "tick_size":"1",
    "underlying_index":"BTC"
  }
]

返回值说明

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

获取深度数据

限速规则: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信息

返回数据:


[
    {
        "best_ask":"332.00",
        "best_bid":"203.00",
        "high_24h":"394",
        "symbol":"cmt_bchusdt",
        "last":"332",
        "low_24h":"332",
        "timestamp":"1591240033936",
        "volume_24h":"0"
 }
]

返回值说明

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

获取某个ticker信息

限速规则:20次/2s

HTTP请求 获取某个ticker信息

请求参数

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

返回数据:

{
    "best_ask":"8858.0",
    "best_bid":"7466.0",
    "high_24h":"8858",
    "symbol":"cmt_btcusdt",
    "last":"8858",
    "low_24h":"8858",
    "timestamp":"1591252726275",
    "volume_24h":"0"
}

返回值说明

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

获取成交数据

限速规则:20次/2s

HTTP请求

获取成交数据

请求参数

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

返回数据:

[
  {
      "symbol":"cmt_btcusdt",
      "price":"7844.00",
      "side":"buy",
      "size":"48",
      "timestamp":"1591111746879",
      "trade_id":"651735392382353615"
 }
]

返回值说明

返回字段 字段说明
symbol 合约Id
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 合约名称

返回数据:

{
    "index":"9654.1",
    "symbol":"cmt_btcusdt",
    "timestamp":"1591256590003"
}

返回值说明

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

获取平台总持仓量

限速规则:20次/2s

HTTP请求 获取平台总持仓量

请求参数

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

返回数据:

{
   "amount":"425810",
   "forwardContractFlag":true,
   "symbol":"cmt_btcusdt",
   "timestamp":"1591256880751"
}

返回值说明

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

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

限速规则:20次/2s

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

请求参数

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

返回数据:

{
     "forwardContractFlag":true,
     "highest":"14474.5",
     "symbol":"cmt_btcusdt",
     "lowest":"4824.5",
     "timestamp":"1591257126461"
 }

返回值说明

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

获取合约下一次结算时间

限速规则:20次/2s

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

请求参数

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

返回数据:

 {
     "symbol':"cmt_btcusdt",
     "forwardContractFlag":false,
     "funding_time":"1591282800000"
 }

返回值说明

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

获取合约历史资金费率

限速规则:20次/2s

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

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约名称
from String 请求开始页码数
to String 请求结束此页码数
limit 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请求 查询所有合约账户信息

返回数据:

[ 
  {
   "equity":"0.00000000",
   "fixed_balance":"0.00000000",
   "total_avail_balance":"0.00000000",
   "margin":"0",
   "realized_pnl":"0",
   "unrealized_pnl":"0",
   "symbol":"cmt_btcusdt",
   "margin_frozen":"0",
   "timestamp":"1658098718494",
   "margin_mode":"fixed",
   "forwardContractFlag":true
 }
]

返回值说明

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

单个合约账户信息

限速规则:5次/s

HTTP请求 单个合约账户信息

请求参数

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

返回数据:

{
   "equity":"0.00000000",
   "fixed_balance":"0.00000000",
   "total_avail_balance":"0.00000000",
   "margin":"0",
   "realized_pnl":"0",
   "unrealized_pnl":"0",
   "symbol":"cmt_btcusdt",
   "margin_frozen":"0",
   "timestamp":"1658098718494",
   "margin_mode":"fixed",
   "forwardContractFlag":true
 }

返回值说明

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

获取单个合约的用户配置

限速规则:5次/s

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

请求参数

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

返回数据:

 {
   "long_leverage":"100",
   "margin_mode":"fixed",
   "short_leverage":2"",
   "symbol":"cmt_btcusdt",
   "forwardContractFlag":true
 }

返回值说明

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

调整杠杆

限速规则:5次/s

HTTP请求 调整杠杆

请求参数

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

返回数据:

{
   "long_leverage":"100",
   "margin_mode":"fixed",
   "short_leverage":"2",
   "symbol":"cmt_btcusdt",
   "forwardContractFlag":true
 }

返回值说明

返回字段 字段说明
long_leverage 多仓杠杆
margin_mode 持仓模式 fixed逐仓模式 crossed全仓模式
short_leverage 空仓杠杆
symbol 合约名称
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空仓
append_type Integer 追加保证金类型 0 不自动追加 1 自动追加

返回数据:

 {
     "result":true,
     "append_type":1
 }

返回值说明

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

获取全部合约仓位信息

限速规则:5次/s

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

返回数据:

 [
 {
    "margin_mode":"",
    "holding":[
           {
              "liquidation_price":"0.00",
              "position":"0",
              "avail_position":"0",
              "avg_cost":"0.00",
              "symbol":"cmt_btcusdt",
              "leverage":"2",
              "realized_pnl":"0.00000000",
              "side":"1",
              "timestamp":"1557571623963",
              "margin":"0.0000000000000000"
       }
     ]
 }
]

返回值说明

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

获取单个合约仓位信息

限速规则:10次/s

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

请求参数

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

返回数据:

{
    "margin_mode":"",
    "holding":[
           {
              "liquidation_price":"0.00",
              "position":"0",
              "avail_position":"0",
              "avg_cost":"0.00",
              "symbol":"cmt_btcusdt",
              "leverage":"2",
              "realized_pnl":"0.00000000",
              "side":"1",
              "timestamp":"1557571623963",
              "margin":"0.0000000000000000"
       }
     ]
 }

返回值说明

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

获取合约挂单冻结数量

限速规则:10次/s

HTTP请求 获取合约挂单冻结数量

请求参数

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

返回数据:

{
   "symbol":"cmt_btcusdt",
   "amount":"102",
   "timestamp":"1557571623963" 
}

返回值说明

返回字段 字段说明
symbol 合约名称
amount 开仓冻结保证金
timestamp 查询时间戳

合约交易接口

下单

限速规则: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笔订单

返回数据:

{
    "result":true,
    "order_info":[
        {
            "result":true,
            "client_oid":"dxdanzi",
            "order_id":"513468410013679613"
        },
        {
            "result":true,
            "client_oid":"dxdanzi",
            "order_id":"513468410001096713"
        }
    ]
}

返回值说明

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

取消订单

限速规则:10次/s

HTTP请求 取消订单

请求参数

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

返回数据:

{
   "order_id":"513468410013679613",
   "client_oid":"dxdanzi",
   "symbol":"cmt_btcusdt",
   "result":true
}

返回值说明

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

批量撤单

限速规则:10次/s

HTTP请求 批量撤单

请求参数

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

返回数据:

{
   "result":true,
   "symbol":"cmt_btcusdt",
   "order_ids":[
          "258414711",
          "478585558"
    ],
   "fail_infos":[
          {
        "order_id":"258414711",
        "err_code":"401",
        "err_msg":""
     }
  ]
}

返回值说明

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

获取单订单信息

限速规则:10次/s

HTTP请求 获取单订单信息

请求参数

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

返回数据:

{
     "symbol":"cmt_btcusdt",
     "size":"12",
     "timestamp":"15582271175271", 
     "client_oid":"cmdtde",
     "createTime":"1698475585258",
     "filled_qty":"0",
     "fee":"0",
     "order_id":"513468410013679613",
     "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 合约code
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",
     "timestamp":"15582271175271", 
     "client_oid":"cmdtde",
     "createTime":"1698475585258",
     "filled_qty":"0",
     "fee":"0",
     "order_id":"513468410013679613",
     "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 合约code
orderId String 订单号

返回数据:

[
  {
      "trade_id":"6667390",
      "symbol":"cmt_btcusdt",
      "order_id":"525946425993854915",
      "price":"9839.00",
      "order_qty":"3466",
      "fee":"-0.0000528407360000",
      "timestamp":"1561121514442",
      "exec_type":"M",
      "side":"3"
}
]

返回值说明

返回字段 字段说明
trade_id 成交Id
symbol 合约code
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:爆仓平空查询

计划委托下单

限速规则:10次/s

HTTP请求 计划委托下单

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约code
client_oid String 客户端请求标识(不超过50个字符,且不能是特殊字符,如火星字符等)
size String 下单张数(不能为0,不能为负数)
type String 类型 1开仓 2平仓
side 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 合约code
orderId String 订单号

返回数据:

 {
     "order_id":"5895798275566469458",
     "client_oid":"bitget#123456",
     "result":false,
     "err_code":"403",
     "err_msg":"订单不存在
}

返回值说明

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

查询当前计划委托

限速规则:10次/s

HTTP请求 查询当前计划委托

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约code
side String 方向 1开多 2开空 3平多 4平空
pageIndex String 当前页
pageSize String 每页数量:实际查询会多查5条,且最多1000条
startTime String 查询开始时间(时间戳)
endTime String 查询结束时间(时间戳)

返回数据:

{
      "list":[
              {
                 "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,
                 "symbol":"cmt_btcusdt",
                 "status":1,
                 "status_desc":"未执行状态",
                 "create_trade_price":"7490"
           }
         ],
    "nextPage":false
}

返回值说明

返回字段 字段说明
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市价
symbol 合约code
status 1未执行状态 2已委托 3执行失败状态 4用户取消状态
status_desc (1未执行状态 2已委托 3执行失败状态 4用户取消状态) 描述
create_trade_price 计划委托时的成交价

查询计划历史委托

限速规则:10次/s

HTTP请求 查询计划历史委托

请求参数

参数名 参数类型 是否必须 描述
symbol String 合约code
side String 方向 1开多 2开空 3平多 4平空
page_index String 当前页
page_size String 每页数量:实际查询会多查5条,且最多1000条
start_time String 查询开始时间(时间戳)
end_time String 查询结束时间(时间戳)

返回数据:

{
      "list":[
              {
                 "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,
                 "symbol":"cmt_btcusdt",
                 "status":1,
                 "status_desc":"未执行状态",
                 "create_trade_price":"7490"
           }
         ],
    "nextPage":false
}

返回值说明

返回字段 字段说明
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市价
symbol 合约code
status 1未执行状态 2已委托 3执行失败状态 4用户取消状态
status_desc (1未执行状态 2已委托 3执行失败状态 4用户取消状态) 描述
create_trade_price 计划委托时的成交价