Bitget APIBitget API
统一账户经典账户
旧文档
  • 概览
  • API 文档
  • WebSocket
  • Agent Hub
  • SDK
  • 更新日志
Copied to clipboard
账户
    资产与余额
      获取账户资产get获取资金账户资产get获取财务记录get获取资金账户财务流水get获取交易手续费get获取最大可转出get获取最大可提币数量get设置抵押品模式post获取抵押品模式get获取自定义抵押品支持币种get
    账户设置
      获取账户信息get获取账户设置get预设置调整杠杆get调整杠杆post调整持仓模式post设置BGB抵扣post获取BGB抵扣状态get账户切换post获取切换状态get调整保证金post获取Delta模式信息get账户模式切换post
    杠杆与借贷管理
      获取可还币种get获取支付币种get还款post获取兑换记录get
    交易风控与仓位设置
      获取OI限仓get获取业务线所有交易对手续费get获取准入用户杠杆交易对get获取准入用户杠杆梯度档位get获取准入用户借币数据get获取准入用户币种折扣率梯度get
    子账户
      新建子账户post冻结/解冻子账户post查询子账户列表get查询子账户统一账户资产get新建子账户API Keypost修改子账户API Keypost删除子账户API Keypost查询子账户API Key列表get创建 Agent 子账户post
    充值提币划转
      设置充值账户post获取充值地址get获取子账户充值地址get获取充值记录get获取子账户充值记录get提币post撤销提币post获取提币记录get查询提币地址簿get获取可划转币种get划转post子母划转post获取子母划转记录get子账户主动划转至母账户post
    小额资产兑换
      获取小额兑换历史记录get获取小额兑换可兑换币种get执行小额兑换post
    机构限频
      获取限频配额get设置限频配额post
账户
账户

子账户

子账户


新建子账户

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

限频规则: 10次/秒/UID

该接口用于母账户创建子账户,仅支持创建统一账户虚拟子账户,不支持创建普通子账户。

需要统一账户管理读写权限

仅母账户才能调用此接口

新建子账户 › Request Parameters

username
​string · required

生成虚拟邮箱地址的用户名。只能是小写字母且不能超过20个字符

accountMode
​string

子账户模式 classic 经典账户子账户 unified 统一账户子账户

note
​string

备注,不能超过50个字符

新建子账户 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
username
​string

虚拟邮箱地址

subUid
​string

虚拟子账户ID

status
​string

账户状态 normal 正常

note
​string

备注

createdTime
​string

创建时间,Unix毫秒时间戳

updatedTime
​string

最后修改时间,Unix毫秒时间戳

POST/api/v3/user/create-sub
curl https://api.bitget.com/api/v3/user/create-sub \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "username": "username", "accountMode": "accountMode", "note": "note" }'
Example Request Body
{ "username": "username", "accountMode": "accountMode", "note": "note" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740211442920, "data": { "username": "xxxx@virtual-bitget.com", "subUid": "xxxx", "status": "normal", "note": "xxxx", "createdTime": "1740211445041", "updatedTime": "1740211445041" } }
json
application/json

冻结/解冻子账户

POST
https://api.bitget.com
/api/v3/user/freeze-sub

限频规则: 10次/秒/UID

冻结/解冻虚拟子账户。

需要统一账户管理读写权限

仅母账户才能调用此接口

冻结/解冻子账户 › Request Parameters

subUid
​string · required

要冻结/解冻的子账户ID

operation
​string · required

操作类型 freeze 冻结 unfreeze 解冻

冻结/解冻子账户 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
data
​object

无返回字段

POST/api/v3/user/freeze-sub
curl https://api.bitget.com/api/v3/user/freeze-sub \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "subUid", "operation": "operation" }'
Example Request Body
{ "subUid": "subUid", "operation": "operation" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740212117457, "data": {} }
json
application/json

查询子账户列表

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

限频规则: 10次/秒/UID

查询子账户列表。

需要统一账户管理读取权限

仅母账户才能调用此接口

查询子账户列表 › Request Parameters

limit
​string

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

cursor
​string

游标ID 用于翻页,首次查询不传,查询第二页及后面的数据时,取上一次查询返回的cursor

查询子账户列表 › Response Parameters

200

Successful response

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

子账户列表

hasNext
​boolean

是否还有下一页数据

cursor
​string

游标ID

GET/api/v3/user/sub-list
curl https://api.bitget.com/api/v3/user/sub-list
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740212430491, "data": { "list": [ { "subUid": "xxx", "username": "llt****@virtual-bitget.com", "status": "normal", "accountMode": "CLASSIC", "type": "virtual", "note": "xxxx", "createdTime": "1740129303268", "updatedTime": "1740129303268" }, { "subUid": "xxx", "username": "zml****@virtual-bitget.com", "status": "normal", "accountMode": "UNIFIED", "type": "virtual", "note": "xxx", "createdTime": "1740211445018", "updatedTime": "1740211445018" }, { "subUid": "xxx", "username": "tmr****@virtual-bitget.com", "status": "freeze", "accountMode": "UNIFIED", "type": "virtual", "note": "xxx", "createdTime": "1740131800692", "updatedTime": "1740212129476" } ], "hasNext": false, "cursor": "18484" } }
json
application/json

查询子账户统一账户资产

GET
https://api.bitget.com
/api/v3/account/sub-unified-assets

限频规则: 1次/秒/UID

查询子账户统一账户资产。

需要统一账户管理读取权限

查询子账户统一账户资产 › Request Parameters

subUid
​string

子账户UID 如不填,则返回所有子账户资产列表

cursor
​string

游标ID 用于翻页,首次请求不传。后续请求传上次返回的cursor值

limit
​string

每页子账户数量 默认值为10,最大值为50

查询子账户统一账户资产 › Response Parameters

200

Successful response

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

子账户资产列表

subUid
​string

子账户UID

cursor
​string

游标ID

​object[]

账户币种列表

GET/api/v3/account/sub-unified-assets
curl https://api.bitget.com/api/v3/account/sub-unified-assets
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1751970047603, "data": [ { "subUid": "1111111111", "cursor": "5832862", "assets": [ { "coin": "USDT", "equity": "1", "usdValue": "0.99996985", "balance": "1", "available": "1", "debt": "0", "locked": "0" } ] } ] }
json
application/json

新建子账户API Key

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

限频规则: 10次/秒/UID

该接口用于新建统一账户子账户的API Key,即母账户为混合账户模式或统一账户模式。如当前母账户模式为经典账户,则无法调用该接口。

目前只支持虚拟子账户的创建。

需要统一账户管理读写权限

仅母账户才能调用此接口

新建子账户API Key › Request Parameters

subUid
​string · required

子账户ID

note
​string · required

备注名称 长度限制20字符;需以字母开头,支持[0-9], [a-z], [A-Z]以及[-,_]

type
​string · required

权限类型 read_write 读写 read_only 只读

passphrase
​string · required

密钥 长度为8至32位的英文字母与数字组合

permissions
​string[] · required

权限值 统一账户权限: uta_mgt 统一账户管理 uta_trade 统一账户交易

ips
​string[] · required

提币白名单IP 支持传入多个IP地址 单密钥最多支持绑定30个IP 只支持IPv4

新建子账户API Key › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
note
​string

备注

apiKey
​string

子账户api key

secret
​string

子账户密钥

type
​string

子账户API Key权限类型 read_write 读写 read_only 只读

permissions
​string[]

子账户API Key权限值 统一账户权限: uta_mgt 统一账户管理 uta_trade 统一账户交易

ips
​string[]

子账户提币IP白名单列表

POST/api/v3/user/create-sub-api
curl https://api.bitget.com/api/v3/user/create-sub-api \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "subUid": "subUid", "note": "note", "type": "type", "passphrase": "passphrase", "permissions": [ "string" ], "ips": [ "string" ] }'
Example Request Body
{ "subUid": "subUid", "note": "note", "type": "type", "passphrase": "passphrase", "permissions": [ "string" ], "ips": [ "string" ] }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740213448866, "data": { "note": "test", "apiKey": "***********************************", "secret": "*********************************************", "type": "read_only", "permissions": [ "uta_trade" ], "ips": [ "127.0.0.1" ] } }
json
application/json

修改子账户API Key

POST
https://api.bitget.com
/api/v3/user/update-sub-api

限频规则: 10次/秒/UID

该接口用于修改统一账户子账户API Key权限及提币白名单IP地址。仅支持修改统一账户子账户的API Key,不支持创建经典账户子账户的API Key。

需要统一账户管理读写权限

仅母账户才能调用此接口

修改子账户API Key › Request Parameters

apiKey
​string · required

子账户API Key

passphrase
​string · required

密钥 长度为8至32位的英文字母与数字组合

type
​string

权限类型 read_write 读写 read_only 只读 permissions有值时此参数必传

permissions
​string[]

权限值 统一账户权限: uta_mgt 统一账户管理 uta_trade 统一账户交易 type有值时此参数必传

ips
​string[]

白名单IP 如不传,则不修改IP地址 如传空值,则删除IP白名单 支持传入多个IP地址 单密钥最多支持绑定30个IP 只支持IPv4

修改子账户API Key › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
apiKey
​string

子账户api密钥

note
​string

备注

type
​string

子账户API Key权限类型 read_write 读写 read_only 只读

permissions
​string[]

子账户API Key权限值 统一账户权限: uta_mgt 统一账户管理 uta_trade 统一账户交易

ips
​string[]

子账户IP白名单列表

POST/api/v3/user/update-sub-api
curl https://api.bitget.com/api/v3/user/update-sub-api \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "apiKey": "apiKey", "passphrase": "passphrase", "type": "type", "permissions": [ "string" ], "ips": [ "string" ] }'
Example Request Body
{ "apiKey": "apiKey", "passphrase": "passphrase", "type": "type", "permissions": [ "string" ], "ips": [ "string" ] }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740213448866, "data": { "note": "test", "apiKey": "***********************************", "type": "read_only", "permissions": [ "uta_trade" ], "ips": [ "127.0.0.1" ] } }
json
application/json

删除子账户API Key

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

限频规则: 10次/秒/UID

该接口用于母账户删除子账户的API Key,不适用于母账户或子账户删除其调用API Key的场景。

请注意,删除操作一旦完成,子账户API Key将立即失效。在执行删除前,请务必确认此操作不会导致任何损失。

该接口仅支持删除统一账户子账户的API Key,不支持删除经典账户子账户的API Key。

需要统一账户管理读写权限

仅母账户才能调用此接口

删除子账户API Key › Request Parameters

apikey
​string · required

子账户API Key

删除子账户API Key › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
data
​object

无返回字段

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

查询子账户API Key列表

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

限频规则: 10次/秒/UID

支持查询单个子账户下的全部API Key列表。

需要统一账户管理读取权限

仅母账户才能调用此接口

查询子账户API Key列表 › Request Parameters

subUid
​string · required

子账户UID

limit
​string

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

cursor
​string

游标ID 用于翻页,首次查询不传,查询第二页及后面的数据时,取上一次查询返回的cursor

查询子账户API Key列表 › Response Parameters

200

Successful response

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

子账户API Key列表

hasNext
​boolean

是否还有下一页数据

cursor
​string

游标ID

GET/api/v3/user/sub-api-list
curl 'https://api.bitget.com/api/v3/user/sub-api-list?subUid=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740212430491, "data": { "list": [ { "apiKey": "***********************************", "note": "xxxx", "type": "read_only", "permissions": [ "uta_trade" ], "ips": [ "127.0.0.1" ], "ts": "1740129303268" } ], "hasNext": false, "cursor": "18484" } }
json
application/json

创建 Agent 子账户

POST
https://api.bitget.com
/api/v3/user/sub-account/agent-create

限频规则: 1次/秒/UID

为 AI Agent 实例创建专属子账户。Agent 子账户创建后不支持编辑(名称、权限等配置均不可修改)。每个主账户可创建的 Agent 子账户数量上限与普通子账户共享总配额。

需要统一账户管理读写权限

仅母账户才能调用此接口

创建 Agent 子账户 › Request Parameters

username
​string · required

用于生成虚拟邮箱地址的用户名。只能是小写字母且不能超过20个字符

passphrase
​string · required

API Key 密钥,长度为8至32位的英文字母与数字组合

note
​string

子账户备注

创建 Agent 子账户 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
username
​string

Agent 子账户昵称

subUid
​string

Agent 子账户 ID

apiKey
​string

Agent 子账户 API Key

secret
​string

Agent 子账户密钥

note
​string

备注

createdTime
​string

创建时间,Unix毫秒时间戳

POST/api/v3/user/sub-account/agent-create
curl https://api.bitget.com/api/v3/user/sub-account/agent-create \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "username": "username", "passphrase": "passphrase", "note": "note" }'
Example Request Body
{ "username": "username", "passphrase": "passphrase", "note": "note" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1740000000000, "data": { "username": "xxxx@virtual-bitget.com", "subUid": "xxxx", "apiKey": "***********************************", "secret": "*********************************************", "note": "xxxx", "createdTime": "1740211445041" } }
json
application/json

交易风控与仓位设置充值提币划转