Bitget APIBitget API
统一账户经典账户
旧文档
  • 概览
  • API 文档
  • WebSocket
  • Agent Hub
  • SDK
  • 更新日志
Copied to clipboard
经纪商
    经纪商
      创建经纪商子账户post创建经纪商子账户API Keypost删除经纪商子账户API Keypost获取经纪商子账户充提记录get获取经纪商子账户佣金记录get获取经纪商子账户API Keyget获取经纪商子账户列表get修改经纪商子账户API Keypost修改经纪商子账户post获取经纪商子账户充值地址post经纪商子账户提币post
经纪商
经纪商

经纪商

经纪商


创建经纪商子账户

POST
https://api.bitget.com
/api/v3/broker/create-sub

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

创建经纪商子账户 › Request Parameters

subaccountName
​string · required

子账户用户名

label
​string · required

备注 最多不超过50个字符

创建经纪商子账户 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
subUid
​string

子账户uid

subaccountName
​string

子账户用户名

subaccountEmail
​string

子账户邮箱 默认为系统生成的虚拟邮箱;若单独绑定过邮箱,则展示绑定邮箱

status
​string

子账户状态 normal 正常 freeze 冻结

permList
​string[]

权限列表 withdraw 提币 transfer 划转 spot_trade 现货交易 contract_trade 合约交易 margin_trade 杠杆交易 deposit 充值权限

label
​string

备注

cTime
​string

账户创建时间 Unix毫秒时间戳

POST/api/v3/broker/create-sub
curl https://api.bitget.com/api/v3/broker/create-sub \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subaccountName": "hunterusers182114141", "label": "hunterusersub21523121" }'
Example Request Body
{ "subaccountName": "hunterusers182114141", "label": "hunterusersub21523121" }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767148977459, "data": { "subUid": "1234567891", "subaccountName": "", "subaccountEmail": "hun****@broker", "status": "normal", "permList": [ "read", "uta_spot_trade", "uta_margin_trade", "uta_contract_trade", "transfer", "withdraw", "deposit" ], "label": "hunterusersub21523121", "cTime": "1767148977593" } }
json
application/json

创建经纪商子账户API Key

POST
https://api.bitget.com
/api/v3/broker/create-sub-apikey

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

创建经纪商子账户API Key › Request Parameters

subUid
​string · required

子账户uid

passphrase
​string · required

Passphrase passphrase是调用 API 接口的必要参数,如果遗失请重新创建API key

label
​string · required

备注

ipList
​string[] · required

IP白名单 最多传入30个

permType
​string · required

权限类型 read_write 读写权限 read_only 只读权限

permList
​string[] · required

权限 uta_trade UTA交易 uta_mgt UTA管理 withdraw 提币(permType需要为read_write类型)

创建经纪商子账户API Key › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
subUid
​string

子账户uid

label
​string

备注

apiKey
​string

API Key

secretKey
​string

私钥

permType
​string

权限类型 read_write 读写权限 read_only 只读权限

permList
​string[]

权限 uta_trade UTA交易 uta_mgt UTA管理 withdraw 提币(permType需要为read_write类型)

ipList
​string[]

IP白名单

POST/api/v3/broker/create-sub-apikey
curl https://api.bitget.com/api/v3/broker/create-sub-apikey \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "12345678910", "passphrase": "12345678", "label": "338040211757111_test01", "permType": "read_write", "permList": [ "uta_trade", "uta_mgt", "withdraw" ] }'
Example Request Body
{ "subUid": "12345678910", "passphrase": "12345678", "label": "338040211757111_test01", "permType": "read_write", "permList": [ "uta_trade", "uta_mgt", "withdraw" ] }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767151739925, "data": { "subUid": "12345678910", "label": "338040211757111_test01", "apiKey": "bg_123456789", "secretKey": "123456789111111", "permType": "read_write", "permList": [ "uta_mgt", "uta_trade", "withdraw" ], "ipList": null } }
json
application/json

删除经纪商子账户API Key

POST
https://api.bitget.com
/api/v3/broker/delete-sub-apikey

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

  • 该接口无响应参数
  • 该接口同步返回删除处理结果
  • 根据code和msg返回删除成功及失败结果 & 失败原因

删除经纪商子账户API Key › Request Parameters

subUid
​string · required

子账户uid

apiKey
​string · required

API Key

删除经纪商子账户API Key › Response Parameters

200

Successful response

code
​string

状态码

Example: 00000
msg
​string

响应信息

Example: success
requestTime
​integer

请求时间

POST/api/v3/broker/delete-sub-apikey
curl https://api.bitget.com/api/v3/broker/delete-sub-apikey \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "12345678910", "apiKey": "bg_12345678910" }'
Example Request Body
{ "subUid": "12345678910", "apiKey": "bg_12345678910" }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767151778823 }
json
application/json

获取经纪商子账户充提记录

GET
https://api.bitget.com
/api/v3/broker/all-sub-deposit-withdrawal

限频规则: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

获取经纪商子账户充提记录 › Request Parameters

startTime
​string

记录开始时间 Unix毫秒时间戳。开始与结束时间均为空默认时间为查询昨日00:00-23:59(UTC+0)数据。startTime和endTime范围不能超过7天

endTime
​string

记录结束时间 Unix毫秒时间戳。开始与结束时间均为空默认时间为查询昨日00:00-23:59(UTC+0)数据。startTime和endTime范围不能超过7天

limit
​string

每页条目数 默认100,最大100

cursor
​string

游标ID

status
​string

状态 pending 确认中 fail 失败 success 成功

获取经纪商子账户充提记录 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

记录列表

endId
​string

翻页游标 ID(取当前页最小记录 ID)

GET/api/v3/broker/all-sub-deposit-withdrawal
curl https://api.bitget.com/api/v3/broker/all-sub-deposit-withdrawal
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767151164765, "data": { "list": [ { "uid": "12345678910", "txId": "1390096439417995264", "type": "withdrawal", "subType": "internal", "coin": "USDT", "amount": "10.000000000", "status": "fail", "ts": "1767150805032" } ], "endId": "1390096439417995264" } }
json
application/json

获取经纪商子账户佣金记录

GET
https://api.bitget.com
/api/v3/broker/commission

限频规则: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

获取经纪商子账户佣金记录 › Request Parameters

startTime
​string

查询开始时间 Unix毫秒时间戳。若开始与结束时间均不传,默认查询时间为昨日00:00-23:59(UTC+0)。单次查询的startTime与endTime间隔不超过30天

endTime
​string

查询结束时间 Unix毫秒时间戳。若开始与结束时间均不传,默认查询时间为昨日00:00-23:59(UTC+0)。单次查询的startTime与endTime间隔不超过30天

pageSize
​string

每页条目数 默认值为100,最大值为1000

pageNo
​string

分页页码 默认值为1

bizType
​string

业务类型 spot 现货 futures 合约 如不填,则返回全部类型佣金信息

subBizType
​string

业务子类型 spot_trade 现货交易 spot_margin 现货杠杆 usdt_futures U本位合约 usdc_futures USDC合约 coin_futures 币本位合约 当bizType=spot时,该参数可填spot_trade及spot_margin;当bizType=futures时,该参数可填usdt_futures,usdc_futures及coin_futures

获取经纪商子账户佣金记录 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
uid
​string

用户ID

coin
​string

佣金币种

symbol
​string

交易对

dealtAmount
​string

成交额

totalFee
​string

总手续费

deductedFee
​string

扣减手续费

paidFee
​string

实付手续费

markUpFee
​string

加点手续费

totalCommission
​string

总计佣金

GET/api/v3/broker/commission
curl https://api.bitget.com/api/v3/broker/commission
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767677788472, "data": [ { "uid": "1359901376", "coin": "BTC", "symbol": "BTC/USDT", "dealtAmount": "84.346065", "totalFee": "0.0000005", "deductedFee": "0", "paidFee": "0.0000005", "markUpFee": "0", "totalCommission": "0.00000002" } ] }
json
application/json

获取经纪商子账户API Key

GET
https://api.bitget.com
/api/v3/broker/query-sub-apikey

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

获取经纪商子账户API Key › Request Parameters

subUid
​string · required

子账户uid

获取经纪商子账户API Key › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
subUid
​string

子账户uid

label
​string

备注

apiKey
​string

API Key

secretKey
​string

私钥

permType
​string

权限类型 read_write 读写权限 read_only 只读权限

permList
​string[]

权限 uta_trade UTA交易 uta_mgt UTA管理 withdraw 提币(permType需要为read_write类型)

ipList
​string[]

IP白名单

GET/api/v3/broker/query-sub-apikey
curl 'https://api.bitget.com/api/v3/broker/query-sub-apikey?subUid=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767151739925, "data": { "subUid": "12345678910", "label": "338040211757111_test01", "apiKey": "bg_12345678910b", "secretKey": "12345678910xxx", "permType": "read_write", "permList": [ "uta_mgt", "uta_trade", "withdraw" ], "ipList": null } }
json
application/json

获取经纪商子账户列表

GET
https://api.bitget.com
/api/v3/broker/sub-list

限频规则: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

获取经纪商子账户列表 › Request Parameters

limit
​string

每页条目数 默认10 最大100

cursor
​string

游标ID 用于分页。首次调用不传。后续调用传入上次查询返回的最后一个subUid

status
​string

账户状态 normal 正常 freeze 冻结

获取经纪商子账户列表 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

子账户列表

GET/api/v3/broker/sub-list
curl https://api.bitget.com/api/v3/broker/sub-list
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767149918448, "data": { "subList": [ { "subUid": "12345678910", "subaccountName": "hun****@broker_8383826362", "subaccountEmail": null, "status": "normal", "permList": [ "read", "uta_spot_trade", "uta_margin_trade", "uta_contract_trade", "transfer", "withdraw", "deposit" ], "label": "hunterusersub21523121", "language": "zh_CN", "cTime": "1767148977593", "uTime": "1767148977593" } ] } }
json
application/json

修改经纪商子账户API Key

POST
https://api.bitget.com
/api/v3/broker/modify-sub-apikey

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

修改经纪商子账户API Key › Request Parameters

subUid
​string · required

子账户uid

passphrase
​string · required

Passphrase passphrase是调用 API 接口的必要参数,如果遗失请重新创建API key

apiKey
​string · required

API Key

label
​string

备注

ipList
​string[]

IP白名单 最多传入30个

permType
​string

权限类型 read_write 读写权限 read_only 只读权限

permList
​string[]

权限 uta_trade UTA交易 uta_mgt UTA管理 withdraw 提币(permType需要为read_write类型)

修改经纪商子账户API Key › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
subUid
​string

子账户uid

label
​string

备注

apiKey
​string

API Key

permType
​string

权限类型 read_write 读写权限 read_only 只读权限

permList
​string[]

权限 uta_trade UTA交易 uta_mgt UTA管理 withdraw 提币(permType需要为read_write类型)

ipList
​string[]

IP白名单

POST/api/v3/broker/modify-sub-apikey
curl https://api.bitget.com/api/v3/broker/modify-sub-apikey \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "12345678910", "passphrase": "12345678", "apiKey": "bg_12345678910", "label": "338040211757111_test01", "permType": "read_write", "permList": [ "uta_trade", "uta_mgt", "withdraw" ] }'
Example Request Body
{ "subUid": "12345678910", "passphrase": "12345678", "apiKey": "bg_12345678910", "label": "338040211757111_test01", "permType": "read_write", "permList": [ "uta_trade", "uta_mgt", "withdraw" ] }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767151778823, "data": { "subUid": "12345678910", "label": "3380407571_test02update", "apiKey": "bg_12345678910", "permType": "read_write", "permList": [ "uta_mgt", "uta_trade", "withdraw" ], "ipList": [ "1.3.1.2" ] } }
json
application/json

修改经纪商子账户

POST
https://api.bitget.com
/api/v3/broker/modify-sub

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

修改经纪商子账户 › Request Parameters

subUid
​string · required

子账户uid

status
​string

子账户状态 normal 正常 freeze 冻结

permList
​string

权限列表 withdraw 提币 transfer 划转 spot_trade 现货交易 contract_trade 合约交易 margin_trade 杠杆交易 deposit 充值权限

修改经纪商子账户 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
subUid
​string

子账户uid

status
​string

子账户状态 normal 正常 freeze 冻结

subaccountName
​string

子账户名称

label
​string

备注

permList
​string[]

权限列表 withdraw 提币 transfer 划转 spot_trade 现货交易 contract_trade 合约交易 margin_trade 杠杆交易 deposit 充值权限

cTime
​string

账户创建时间 Unix毫秒时间戳

uTime
​string

账户更新时间 Unix毫秒时间戳

language
​string

子账户语言 en_US zh_CN ja_JP vi_VN zh_TW ru_RU es_ES tr_TR fr_FR de_DE pt_PT th_TH

POST/api/v3/broker/modify-sub
curl https://api.bitget.com/api/v3/broker/modify-sub \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "1234567891", "status": "freeze" }'
Example Request Body
{ "subUid": "1234567891", "status": "freeze" }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767150632929, "data": { "subUid": "12345678910", "subaccountName": "hun****@broker", "status": "freeze", "permList": [ "uta_spot_trade", "transfer", "deposit" ], "label": "hunterusersub123121", "cTime": "1766476082509", "uTime": "1766476102463" } }
json
application/json

获取经纪商子账户充值地址

POST
https://api.bitget.com
/api/v3/broker/sub-deposit-address

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

获取经纪商子账户充值地址 › Request Parameters

subUid
​string · required

子账户uid

coin
​string · required

币种

chain
​string

链名称 如果不填该参数,则默认为币种的主链

获取经纪商子账户充值地址 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
subUid
​string

子账户uid

coin
​string

币种

chain
​string

链名称

address
​string

充值地址

tag
​string

标识 部分链生效,如EOS的memo,TON的comment

url
​string

自定义订单ID

cTime
​string

创建时间

POST/api/v3/broker/sub-deposit-address
curl https://api.bitget.com/api/v3/broker/sub-deposit-address \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "12345678910", "chain": "ERC20", "coin": "USDT" }'
Example Request Body
{ "subUid": "12345678910", "chain": "ERC20", "coin": "USDT" }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767150821166, "data": { "subUid": "12345678910", "coin": "USDT", "address": "0xe4de63ebbf937385c17e7332557fe5c3337648ca", "chain": "ERC20", "tag": null, "url": "https://sepolia.etherscan.io/tx/", "cTime": "1765987200000" } }
json
application/json

经纪商子账户提币

POST
https://api.bitget.com
/api/v3/broker/sub-withdrawal

限频: 20次/秒/UID

仅用户类型为ND Broker的母账户才能调用该接口。

Broker子账户提币接口存在限制,目前仅支持以下币种:

BTC, ETH, USDT, USDC, TRX, XRP, LTC, SOL, BNB, FTM, DOGE, ADA, SHIB, UNI, SEI, SUI, POL, FIL, LINK, GRAM, ARB, OP, DOT, AVAX, BGB

经纪商子账户提币 › Request Parameters

subUid
​string · required

子账户uid

coin
​string · required

币种

dest
​string · required

提币方式 on_chain 链上提币 internal_transfer 内部转账

address
​string · required

提币地址 当选择链上提币时,填链上地址;当选择内部转账时,填uid

amount
​string · required

提币数量

chain
​string

链名称 如果不填该参数,则默认为币种的主链

tag
​string

标识 EOS的memo,GRAM的comment都使用该字段填入

clientOid
​string

自定义订单ID

经纪商子账户提币 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

订单ID

clientOid
​string

自定义订单ID

POST/api/v3/broker/sub-withdrawal
curl https://api.bitget.com/api/v3/broker/sub-withdrawal \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "12345678910", "dest": "internal_transfer", "coin": "USDT", "address": "123456789", "amount": "10", "clientOid": "91500512549_1765977438100" }'
Example Request Body
{ "subUid": "12345678910", "dest": "internal_transfer", "coin": "USDT", "address": "123456789", "amount": "10", "clientOid": "91500512549_1765977438100" }
json
application/json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1767150755184, "data": { "orderId": "1390096439417995264", "clientOid": "91500512549_1765977438100" } }
json
application/json