更新日志

2024年8月15日

• API接口限频调整

2023年08月17日

• 新增接口：
  • 查询子账户划转记录
  • 查询子账户充币记录
  • 查询子账户提币记录

2022年12月28日

• 切换官方telegram群

2022年9月28日

• 新增 账户接口 -> 充币自动划转

2022年9月27日

• 新增子账户绑定邮箱
• 新增子账户获取邮箱

2022年7月1日【新增子账户列表接口】

• 新增子账户列表接口

2022年5月27日【新增Broker文档】

• 新增V1文档
• 错误信息支持中/英

简介

API 简介

欢迎使用Bitget开发者文档！

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

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

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

市商/量化

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

• API@bitget.com 合约做市商申请。

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

更新关注

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

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

联系我们

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

• 发送邮件至 API@bitget.com。
• Telegram 点击加入

快速入门

接入准备

此文档供经纪商接入使用，如果您有一定的研发运营能力，想要搭建独有的交易平台和自主管理您的用户，独立经纪商服务是最好的选择。您则负责前端开发和用户运营，而Bitget为您提供后端技术和市场的流动性，赋能您的交易增值服务.

• 经纪人在 发送邮件 请求成为Bitget 经纪商

• 经纪商在 这里 创建 API Key, 一定要设置IP 白名单，

• 经纪商通过此API 创建自己的子账户，控制权限，创建子账号APIKey，通过子账号APIKey 进行下单操作。

接口类型

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

• 账户接口
• 子账户API接口

账户接口

创建子账户，修改权限以及查询子账户账户列表。

子账户API接口

创建子账户的APIKey, 并且设置权限。

访问限制

本章节主要为访问限制：

• Rest API 当访问超过频率限制时，将返回429状态：请求太频繁。

Rest API

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

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

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

API域名

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

API验证

发起请求

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

• ACCESS-KEY：API KEY作为一个字符串。
• ACCESS-SIGN：使用base64编码签名（请参阅签名消息）。
• ACCESS-TIMESTAMP：您请求的时间戳。
• ACCESS-PASSPHRASE：您在创建API KEY时设置的口令。
• Content-Type：统一设置为application/json。
• locale: 支持多语言, 如：中文(zh-CN),英语(en-US)

签名

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

签名各字段说明

• timestamp：与 ACCESS-TIMESTAMP 请求头相同。
• method：请求方法(POST/GET)，字母全部大写。
• requestPath：请求接口路径。
• queryString：请求URL中(?后的请求参数)的查询字符串。
• body：请求主体对应的字符串，如果请求没有主体(通常为GET请求)则body可省略。

queryString为空时，签名格式

timestamp + method.toUpperCase() + requestPath + body

queryString不为空时，签名格式

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

举例说明

获取获取经纪人账户信息:

• Timestamp = 16273667805456
• Method = "GET"
• requestPath = "/api/broker/v1/account/sub-list"
• queryString= "?pageSize=10&lastEndId=0&status=normal"

生成待签名的字符串:

'16273667805456GET/api/broker/v1/account/sub-list?pageSize=10&lastEndId=0&status=normal'

创建子账户 为例:

• Timestamp = 16273667805456
• Method = "POST"
• requestPath = "/api/broker/v1/account/sub-create"
• body = {"subName":"mySub01","remark":"myBitgetSub"}

生成待签名的字符串:

'16273667805456POST/api/broker/v1/account/sub-create{"subName":"mySub01","remark":"myBitgetSub"}'

生成最终签名的步骤

HMAC

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

Signature = hmac_sha256(secretkey, Message)

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

Signature = base64.encode(Signature)

RSA

第一步，使用RSA私钥privateKey对待签名字符串进行SHA-256签名。

第二步，对生成的签名字符串进行编码为 base64 string，得到签名字符串进行接口请求。

请求交互

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

请求交互说明

• 请求参数：根据接口请求参数规定进行参数封装。
• 提交请求参数：将封装好的请求参数通过GET/POST方式提交至服务器。
• 服务器响应：服务器首先对用户请求数据进行参数安全校验，通过校验后根据业务逻辑将响应数据以JSON格式返回给用户。
• 数据处理：对服务器响应数据进行处理。

成功

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

常见错误码

• 400 Bad Request – Invalid request format 请求格式无效
• 401 Unauthorized – Invalid API Key 无效的API Key
• 403 Forbidden – You do not have access to the requested resource 请求无权限
• 404 Not Found 没有找到请求
• 429 Too Many Requests 请求太频繁被系统限流
• 500 Internal Server Error – We had a problem with our server 服务器内部错误
• 如果失败body带有错误描述信息

标准规范

时间戳

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

请求格式

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

• GET: 参数通过queryString在路径中传输到服务器。
• POST: 参数按照json格式发送body传输到服务器。

RestAPI

账户接口

经纪商账户信息

限速规则：10次/1s (uid)

HTTP请求

• GET /api/broker/v1/account/info

返回数据

{
    "code":"00000",
    "msg":"success",
    "data":{
        "subAccountQty":"2311",
        "maxSubAccountQty":"5000"
    }
}

返回值说明

创建子账户

限速规则：1次/1s (uid)

HTTP请求

• POST /api/broker/v1/account/sub-create

请求参数(Request Body)

返回数据

{
    "code":"00000",
    "msg":"success",
    "data":{
        "subUid":"293848922",
        "subName":"subEmail@hyc.com",
        "status":"normal",
        "auth":["spot_trade","transfer"],
        "remark":"mySub01",
        "cTime":"1651130117853"
    }
}

• status
  • normal 正常
  • freeze 冻结
  • del 删除
• auth
  • recharge 充值权限
  • withdraw 提币权限
  • transfer 划转
  • spot_trade 只能现货交易
  • contract_trade 只能合约交易
  • readonly 读权限

获取子账户列表

限速规则：1次/1s (uid)

HTTP请求

• GET /api/broker/v1/account/sub-list

请求参数(Request Param)

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 1656589586807,
    "data": {
        "hasNextPage": false,
        "lastEndId": 51,
        "list": [
            {
                "subUid": "7713789662",
                "subName": "mySub01@bgbroker6314497154",
                "status": "normal",
                "auth": [
                    "readonly",
                    "spot_trade",
                    "contract_trade",
                    "transfer",
                    "withdraw",
                    "recharge"
                ],
                "remark": "mySub01",
                "cTime": "1653287983475"
            }
        ]
    }
}

• status
  • normal 正常
  • freeze 冻结
  • del 删除
• auth
  • recharge 充值权限
  • withdraw 提币权限
  • transfer 划转
  • spot_trade 只能现货交易
  • contract_trade 只能合约交易
  • readonly 读权限

修改子账户权限

限速规则：1次/1s (ApiKey)

HTTP请求

• POST /api/broker/v1/account/sub-modify

请求参数(Request Body)

返回数据

{
    "code":"00000",
    "msg":"success",
    "data":{
        "subUid":"293848922",
        "subName":"subEmail@hyc.com",
        "status":"normal",
        "auth":["spot_trade","transfer"],
        "remark":"mySub01",
        "cTime":"1651130117853"
    }
}

• status
  • normal 正常
  • freeze 冻结
  • del 删除
• auth
  • recharge 充值权限
  • withdraw 提币权限
  • transfer 划转
  • spot_trade 只能现货交易
  • contract_trade 只能合约交易
  • readonly 读权限

子账户绑定邮箱

限速规则：1次/1s (ApiKey)

HTTP请求

• POST /api/broker/v1/account/sub-modify-email

请求参数(Request Body)

返回数据

{
    "code":"00000",
    "msg":"success",
    "data":null
}

获取子账户邮箱

限速规则：1次/1s (ApiKey)

HTTP请求

• GET /api/broker/v1/account/sub-email

请求参数(Request Parameter)

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 0,
    "data": {
        "subUid": 7713789662,
        "subName": "demo@bitget.com",
        "subEmail": "demo@bitget.com"
    }
}

获取子现货账户列表

限速规则：10次/1s (uid)

HTTP请求

• GET /api/broker/v1/account/sub-spot-assets

请求参数(Request Body)

返回数据

{
  "code":"00000",
  "message":"success",
  "data":[
    {
        "coinId":"10012",
        "coinName":"usdt",
        "available":"0",
        "frozen":"0",
        "lock":"0",
        "uTime":"1622697148"
    }
]
}

返回值说明

获取子合约账户列表

限速规则：10次/1s (uid)

HTTP请求

• GET /api/broker/v1/account/sub-future-assets

请求参数(Request Body)

返回数据

{
    "code":"00000",
    "data":[
        {
            "marginCoin":"USDT",
            "locked":"0.31876482",
            "available":"10575.26735771",
            "crossMaxAvailable":"10580.56434289",
            "fixedMaxAvailable":"10580.56434289",
            "maxTransferOut":"10572.92904289",
            "equity":"10582.90265771",
            "usdtEquity":"10582.902657719473",
            "btcEquity":"0.204885807029"
        }
    ],
    "msg":"success",
    "requestTime":1630901215622
}

返回值说明

创建子账户充值地址(仅适用主账户)

限速规则：10次/1s (uid)

HTTP请求

• POST /api/broker/v1/account/sub-address

请求参数(Request Body)

返回数据:

{
  "code": "00000",
  "msg": "success",
  "data": {
    "subUid": "29390",
    "address": "1HPn8Rx2y6nNSfagQBKy27GB99Vbzg89wv",
    "chain": "BTC-Bitcoin",
    "coin": "BTC",
    "tag": "",
    "url": "https://btc.com/1HPn8Rx2y6nNSfagQBKy27GB99Vbzg89wv"
  }
}

返回值说明

子账户提币(仅适用主账户)

限速规则：1次/1s (uid)

HTTP请求

• POST /api/broker/v1/account/sub-withdrawal

请求参数(Request Body)

返回数据:

{
  "code": "00000",
  "msg": "success",
  "data": "234433328677111"
}

充币自动划转(仅适用主账户)

限速规则：5次/1s (uid)

HTTP请求

• POST /api/broker/v1/account/sub-auto-transfer

请求参数(Request Body)

返回数据:

{
  "code": "00000",
  "msg": "success",
  "data": true
}

• toAccountType
  • spot
  • mix_usdt
  • mix_usd
  • mix_usdc

查询子账户划转记录

限速规则 10次/1s (uid)

HTTP请求

• GET /api/broker/v1/subaccount-transfer

请求示例

curl "https://api.bitget.com/api/broker/v1/subaccount-transfer?orderId=123" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

请求参数

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 1689833233282,
    "data": {
        "coin": "USDT",
        "status": "Successful",
        "toType": "spot",
        "toSymbol": null,
        "fromType": "usdt_m_futures",
        "fromSymbol": null,
        "amount": "10",
        "transferTime": "1689833233282",
        "orderId": "XXXXX",
        "clientOid": "XXXXX",
        "subUid": "123123",
        "transferId": "XXXXX"
    }
}

返回值说明

• status

  • Successful
  • Failed
  • Processing

• toType/fromType

  • spot
  • p2p
  • coin_m_futures
  • usdt_m_futures
  • usdc_m_futures
  • cross_margin
  • isolated_margin

查询子账户充币记录

限速规则 10次/1s (uid)

HTTP请求

• GET /api/broker/v1/subaccount-deposit

请求示例

curl "https://api.bitget.com/api/broker/v1/subaccount-deposit?orderId=123" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" 

请求参数

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 1689833233282,
    "data": {
        "orderId": "XXXXX",
        "txId": "XXXXXXX",
        "coin": "USDT",
        "type": "deposit",
        "dest": "internal_transfer",
        "amount": "10",
        "status": "success",
        "fromAddress": "123123",
        "toAddress": "456456",
        "fee": "1",
        "chain": "erc20",
        "confirm": "3",
        "tag": "xx",
        "cTime": "1689833233282",
        "uTime": "1689833233282"
    }
}

返回值说明

• dest

  • on_chain
  • internal_transfer

• status

  • pending
  • pending_review
  • pending_fail
  • pending_review_fail
  • reject
  • success

查询子账户提币记录

限速规则 10次/1s (uid)

HTTP请求

• GET /api/broker/v1/subaccount-withdrawal

请求示例

curl "https://api.bitget.com/api/broker/v1/subaccount-withdrawal?orderId=123" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" 

请求参数

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 1689833233282,
    "data": {
        "orderId": "XXXXX",
        "txId": "XXXXXXX",
        "coin": "USDT",
        "type": "withdraw",
        "dest": "internal_transfer",
        "amount": "10",
        "status": "success",
        "fromAddress": "123123",
        "toAddress": "456456",
        "fee": "1",
        "chain": "erc20",
        "confirm": "3",
        "tag": "xx",
        "cTime": "1689833233282",
        "uTime": "1689833233282"
    }
}

返回值说明

• dest

  • on_chain
  • internal_transfer

• status

  • pending
  • pending_review
  • pending_fail
  • pending_review_fail
  • reject
  • success

子账户API

创建子账户ApiKey (主账户请求)

限速规则：10次/1s (uid)

HTTP请求

• POST /api/broker/v1/manage/sub-api-create

请求参数(Request Body)

返回数据:

{
  "code": "00000",
  "msg": "success",
  "data": [
    {
      "subUid": "58281113",
      "label": "sub api",
      "apiKey": "bg_djwwwls98a1s0dLK3deq2",
      "secretKey": "Sjwwwls98a1s0dLK3deq2",
      "perm": "read_only,contract_trade",
      "ip": "127.127.127.127"
    }
  ]
}

返回值说明

• perm
  • readonly
  • spot_trade
  • contract_trade
    
  • transfer
  • recharge

查询子账户ApiKey 列表

限速规则：10次/1s (uid)

HTTP请求

• GET /api/broker/v1/manage/sub-api-list

请求参数

返回数据:

{
  "code": "00000",
  "msg": "success",
  "data": [
    {
      "subUid": "58281113",
      "label": "sub api",
      "apiKey": "bg_djwwwls98a1s0dLK3deq2",
      "secretKey": "Sjwwwls98a1s0dLK3deq2",
      "perm": "read_only,contract_trade",
      "ip": "127.127.127.127"
    }
  ]
}

返回值说明

修改子账户ApiKey权限 (主账户请求)

限速规则：10次/1s (uid)

HTTP请求

• POST /api/broker/v1/manage/sub-api-modify

请求参数(Request Body)

返回数据:

{
  "code": "00000",
  "msg": "success",
  "data": {
      "subUid": "58281113",
      "label": "sub api",
      "apiKey": "bg_djwwwls98a1s0dLK3deq2",
      "perm": "read_only,contract_trade",
      "ip": "127.127.127.127",
    }
}

返回值说明

• perm
  • readonly
  • spot_trade
  • contract_trade
  • transfer
  • recharge

RestAPI错误代码