Bitget APIBitget API
统一账户经典账户
旧文档
  • 概览
  • API 文档
  • WebSocket
  • Agent Hub
  • SDK
  • 更新日志
Copied to clipboard
接口文档
经典账户
    代理 · 客户信息
      获取代理佣金get获取直客余额post获取直客充值记录post获取直客认证结果get获取直客列表post获取直客交易量post获取直客佣金get获取子代理信息get获取直客下级信息接口get
经典账户 · 代理 · 客户信息 API
经典账户 · 代理 · 客户信息 API

代理 · 客户信息

经典账户 — 代理 · 客户信息


获取代理佣金

GET
https://api.bitget.com
/api/v2/broker/agent-commission

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

startTime和endTime应该被同时设置或者同时不设置

startTime和endTime支持的最大时间跨度为7天

该接口支持获取90天内数据,如需更久数据可以联系BD手动导出

如果请求中不设置startTime和endTime将会默认返回昨日(00:00-23:59 UTC+8)的信息

获取代理佣金 › Request Parameters

startTime
​string

开始时间

Unix时间戳的毫秒数格式

endTime
​string

结束时间

Unix时间戳的毫秒数格式

limit
​string

分页限制 最大:100,默认: 100

idLessThan
​string

请求获取此 ID 之前的内容(更早的数据),输入值应为相应的 endId。

获取代理佣金 › Response Parameters

200

Successful response

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

客户佣金列表

uid
​string

合作伙伴用户 ID

bizType
​string

交易类型

spot

futures

subBizType
​string

子交易类型

spot

margin

usdt_futures

coin_futures

usdc_futures

symbol
​string

交易对

coin
​string

币种

fee
​string

总手续费

输入时间范围内的统计值

精度为 8 位小数

volume
​string

交易金额

输入时间范围内的统计值

精度为 8 位小数

activityBonusDeduct
​string

体验金抵扣的金额

spotCouponDeduct
​string

现货返现券抵扣的金额

futuresCouponDeduct
​string

合约空投券抵扣的金额

spotFeeDiscountDeduct
​string

现货手续费折扣减免的金额

negativeMakerFeeDeduct
​string

负maker手续费抵扣的金额

feePaid
​string

实际支付手续费

输入时间范围内的统计值

精度为 8 位小数

directCommission
​string

直客佣金

直客指 KOL 直接邀请的一级用户

输入时间范围内的统计值

精度为 8 位小数

subCommission
​string

下级佣金

直接客户的下级为二级、三级...(非一级)间接邀请关系

输入时间范围内的统计值

精度为 8 位小数

partnerCommission
​string

合作伙伴佣金(= 直客佣金 + 下级佣金)

输入时间范围内的统计值

精度为 8 位小数

partnerActualCommission
​string

合作伙伴实际佣金,扣除风控部分以及特殊场景扣除后实际到手的佣金

输入时间范围内的统计值

精度为 8 位小数

traderType
​string

交易者类型佣金

user: 普通用户 — 普通订单佣金

Trader: 交易员 — 交易员订单佣金

apiType
​string

API 佣金类型

api: API 用户 non_api: 非 API 用户

status
​string

状态

settled 已结算

unsettled 未结算

notIssued 未发放

startCalculationTime
​string

统计开始时间 Unix 毫秒时间戳

endCalculationTime
​string

统计结束时间 Unix 毫秒时间戳

endId
​string

最后一条数据 ID。请求时作为下一次查询的索引 ID

GET/api/v2/broker/agent-commission
curl https://api.bitget.com/api/v2/broker/agent-commission
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1694593273026, "data": { "endId": "6624", "commissionList": [ { "uid": "3125195374", "bizType": "futures", "subBizType": "usdt_futures", "symbol": "BTCUSDT", "coin": "BTC", "fee": "0.0000111", "volume": "2.2", "activityBonusDeduct": "0.00001", "spotCouponDeduct": "0.00001", "futuresCouponDeduct": "0.00001", "spotFeeDiscountDeduct": "0.00001", "negativeMakerFeeDeduct": "0.00001", "feePaid": "0.00005", "directCommission": "0.00001", "subCommission": "0.00001", "partnerCommission": "0.000001", "partnerActualCommission": "0.00001", "traderType": "trader", "apiType": "non_api", "status": "settled", "startCalculationTime": "1728635651441", "endCalculationTime": "1728635651441" } ] } }
json
application/json

获取直客余额

POST
https://api.bitget.com
/api/v2/broker/customer-asset

Rate limit: 10/sec/UID

数据更新频率:10分钟

获取直客余额 › Request Parameters

pageNo
​string

页码

pageSize
​string

分页大小,默认100,最大500

uid
​string

UID

showSub
​string

是否展示直客的下级用户信息

yes: 是

no: 否

获取直客余额 › Response Parameters

200

Successful response

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

用户ID

balance
​string

账户余额

uTime
​string

账户上次余额更新时间

remark
​string

当用户的子账户过多时,提示子账户过多,无法查询到账户余额

POST/api/v2/broker/customer-asset
curl https://api.bitget.com/api/v2/broker/customer-asset \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "showSub": "showSub" }'
Example Request Body
{ "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "showSub": "showSub" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 163123213132, "data": [ { "balance": "1234", "uid": "23423432", "uTime": "23423423423", "remark": "sub account exceed 5" } ] }
json
application/json

获取直客充值记录

POST
https://api.bitget.com
/api/v2/broker/customer-deposit

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

API响应中包含了用户的链上充值和内部转账

startTime和endTime应该被同时设置或者同时不设置

startTime和endTime支持的最大时间跨度为30天

该接口支持获取90天内数据,如需更久数据可以联系BD手动导出

如果请求中不设置startTime和endTime将会默认返回昨日(00:00-23:59 UTC+8)的信息

该接口数据更新信息是实时的

获取直客充值记录 › Request Parameters

startTime
​string

开始时间(毫秒)

endTime
​string

结束时间(毫秒)

pageNo
​string

页码

pageSize
​string

分页大小,默认100,最大1000

uid
​string

UID

showSub
​string

是否展示直客的下级用户信息

yes: 是

no: 否

获取直客充值记录 › Response Parameters

200

Successful response

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

UID

orderId
​string

充值订单ID

depositTime
​string

充值时间 (ms)

depositCoin
​string

充值币种

depositAmount
​string

充值数量

POST/api/v2/broker/customer-deposit
curl https://api.bitget.com/api/v2/broker/customer-deposit \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "startTime": "startTime", "endTime": "endTime", "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "showSub": "showSub" }'
Example Request Body
{ "startTime": "startTime", "endTime": "endTime", "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "showSub": "showSub" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 163123213132, "data": [ { "orderId": "3423423", "uid": "234342343", "depositTime": "11234342343", "depositCoin": "USDT", "depositAmount": "500" } ] }
json
application/json

获取直客认证结果

GET
https://api.bitget.com
/api/v2/broker/customer-kyc-result

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

startTime和endTime应该被同时设置或者同时不设置

如果请求中不设置startTime和endTime将会默认返回昨日(00:00-23:59UTC+8)KYC或KYB的用戶信息

数据更新频率:5分钟

获取直客认证结果 › Request Parameters

startTime
​string

开始时间(毫秒)

开始、结束时间间隔最大90天

endTime
​string

结束时间(毫秒)

开始、结束时间间隔最大90天

idLessThan
​string

获取endId之前的数据

limit
​string

查询条数,默认100,最大1000

uid
​string

UID

showSub
​string

是否展示直客的下级用户信息

yes: 是

no: 否

获取直客认证结果 › Response Parameters

200

Successful response

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

UID

kycResult
​string

认证结果

passed

not_passed

endId
​string

本页面最后的UID

GET/api/v2/broker/customer-kyc-result
curl https://api.bitget.com/api/v2/broker/customer-kyc-result
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 163123213132, "data": { "userList": [ { "uid": "435435345", "kycResult": "passed" } ], "endId": "435435345" } }
json
application/json

获取直客列表

POST
https://api.bitget.com
/api/v2/broker/customer-list

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

startTime和endTime应该被同时设置或者同时不设置

startTime和endTime支持的最大时间跨度为30天

若不传startTime / endTime,将返回该代理商名下所有时间段注册的直客数据,无时间限制。

支持查询任意时间段注册的直客,已取消 90 天限制。

如果想确认某UID是否是您邀请的直客,可以通过在body里传入UID进行验证,例如{"uid':"123456"}

注册直客数据更新信息是实时的

获取直客列表 › Request Parameters

startTime
​string

开始时间(毫秒)

endTime
​string

结束时间(毫秒)

pageNo
​string

页码

pageSize
​string

分页大小,默认100,最大1000

uid
​string

UID

referralCode
​string

邀请code

获取直客列表 › Response Parameters

200

Successful response

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

UID

registerTime
​string

注册时间

POST/api/v2/broker/customer-list
curl https://api.bitget.com/api/v2/broker/customer-list \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "startTime": "startTime", "endTime": "endTime", "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "referralCode": "referralCode" }'
Example Request Body
{ "startTime": "startTime", "endTime": "endTime", "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "referralCode": "referralCode" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1695785738672, "data": [ { "uid": 1235665663, "registerTime": "1679991960110" }, { "uid": 1235665663, "registerTime": "1679991960110" } ] }
json
application/json

获取直客交易量

POST
https://api.bitget.com
/api/v2/broker/customer-trade-volume

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

该接口返回的统计数据包含现货、合约的交易量

startTime和endTime应该被同时设置或者同时不设置

startTime和endTime支持的最大时间跨度为30天

该接口支持获取90天内数据

如果请求中不设置startTime和endTime将会默认返回昨日(00:00-23:59 UTC+8)的信息

数据更新频率:1小时

获取直客交易量 › Request Parameters

startTime
​string

开始时间(毫秒)

endTime
​string

结束时间(毫秒)

pageNo
​string

页码

pageSize
​string

分页大小,默认100,最大1000

uid
​string

UID

showSub
​string

是否展示直客的下级用户信息

yes:是

no:否

获取直客交易量 › Response Parameters

200

Successful response

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

UID

volumn
​string

交易量

spotVolume
​string

现货交易量

futuresVolume
​string

合约交易量

time
​string

时间戳 (ms)

POST/api/v2/broker/customer-trade-volume
curl https://api.bitget.com/api/v2/broker/customer-trade-volume \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "startTime": "startTime", "endTime": "endTime", "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "showSub": "showSub" }'
Example Request Body
{ "startTime": "startTime", "endTime": "endTime", "pageNo": "pageNo", "pageSize": "pageSize", "uid": "uid", "showSub": "showSub" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 163123213132, "data": [ { "uid": "435435345", "volumn": "34234.4", "spotVolume": "12000.0", "futuresVolume": "22234.4", "time": "1679991960110" }, { "uid": "435435345", "volumn": "34234.4", "spotVolume": "12000.0", "futuresVolume": "22234.4", "time": "1679991960110" } ] }
json
application/json

获取直客佣金

GET
https://api.bitget.com
/api/v2/broker/customer-commissions

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

startTime和endTime应该被同时设置或者同时不设置

该接口支持获取90天内数据,如需更久数据可以联系BD手动导出

如果请求中不设置startTime和endTime将会默认返回昨日(00:00-23:59 UTC+8)的信息

数据更新频率:T+1 (UTC +8)

获取直客佣金 › Request Parameters

startTime
​string

开始时间(毫秒)

开始、结束时间间隔最大30天

endTime
​string

结束时间(毫秒)

开始、结束时间间隔最大30天

idLessThan
​string

获取此ID前的数据

limit
​string

查询条数,默认100,最大1000

uid
​string

用户ID

coin
​string

币种,如BTC

symbol
​string

交易对 举例:

BGBUSDT_SPBL spot

BTCUSDT_SPBL-MABL spot margin

BTCUSDT_UMCBL USDT-Futures

BTCUSD_DMCBL COIN-Futures

BTCPERP_CMCBL USDC-Futures

showSub
​string

是否展示直客的下级用户信息

yes: 是

no: 否

获取直客佣金 › Response Parameters

200

Successful response

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

直客佣金列表

uid
​string

用户ID

date
​string

返佣日期

coin
​string

币种

symbol
​string

交易对

productType
​string

业务线

SPOT 现货

MARGIN 杠杆

USDT-FUTURES USDT合约

COIN-FUTURES 币本位合约

USDC-FUTURES USDC合约

dealAmount
​string

交易量(maker+taker)

fee
​string

手续费(maker+taker)

佣金和手续费均以 coin 币种计价

feeDeduction
​string

手续费抵扣

activityBonusDeduct
​string

体验金抵扣的金额

spotCouponDeduct
​string

现货返现券抵扣的金额

futuresCouponDeduct
​string

合约空投券抵扣的金额

spotFeeDiscountDeduct
​string

现货手续费折扣减免的金额

negativeMakerFeeDeduct
​string

负maker手续费抵扣的金额

feePaid
​string

实际收取手续费(maker+taker)

rebateAmount
​string

返还代理佣金,用户返给直接上级代理商的佣金(maker+taker)

userTotalRebateAmount
​string

返还用户佣金,代理商返给用户的佣金;仅在合伙人为直客设置了用户返佣后才有此数据(maker+taker)

dayTotalRebateAmount
​string

当日总佣金(maker+taker)

= rebateAmount + userTotalRebateAmount

totalRebateAmount
​string

90天累计佣金(maker+taker)

统计范围为今天往前推90天,包括当天

endId
​string

最后一条数据 ID。用于在发出请求时作为查询数据的索引

GET/api/v2/broker/customer-commissions
curl https://api.bitget.com/api/v2/broker/customer-commissions
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1694593273026, "data": { "endId": "6624", "commissionList": [ { "uid": "3125195374", "date": "1694275200000", "coin": "BTC", "symbol": "BTCUSDT_SPBL", "productType": "SPOT", "dealAmount": "222", "fee": "0.0000111", "feeDeduction": "0.00000333", "activityBonusDeduct": "0.00001", "spotCouponDeduct": "0.00001", "futuresCouponDeduct": "0.00001", "spotFeeDiscountDeduct": "0.00001", "negativeMakerFeeDeduct": "0.00001", "feePaid": "0.00000777", "rebateAmount": "0.00000388", "userTotalRebateAmount": "0", "dayTotalRebateAmount": "0.00000388", "totalRebateAmount": "0.00000388" } ] } }
json
application/json

获取子代理信息

GET
https://api.bitget.com
/api/v2/broker/sub-affiliate-info

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

查询子代理信息。

获取子代理信息 › Request Parameters

uid
​string

用户ID

可传入子代理uid以查询指定子代理信息

startTime
​string

查询开始时间

Unix毫秒时间戳

endTime
​string

查询结束时间

Unix毫秒时间戳

开始、结束时间间隔最大30天

idLessThan
​string

游标ID

用于翻页,获取此ID前的数据

limit
​string

查询条数

默认100,最大100

includeDownLine
​string

是否包含下级用户

yes 是

no 否

如不传,默认值为yes

获取子代理信息 › Response Parameters

200

Successful response

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

子代理列表

uid
​string

用户ID

uplineName
​string

上级名称

​object[]

返佣比例列表

rebateType
​string

返佣类型

futures 合约常规返佣

futures_api 合约API返佣

futures_trader 合约交易专家返佣

futures_trader_api 合约交易专家API返佣

spot 现货常规返佣

spot_api 现货API返佣

spot_trader 现货交易专家返佣

spot_trader_api 现货交易专家API返佣

onchain 链上常规返佣

onchain_api 链上API返佣

onchain_trader 链上交易专家返佣

onchain_trader_api 链上交易专家API返佣

cfd CFD常规返佣

cfd_api CFD API返佣

cfd_trader CFD交易专家返佣

cfd_trader_api CFD交易专家API返佣

stock 股票常规返佣

stock_api 股票API返佣

stock_trader 股票交易专家返佣

stock_trader_api 股票交易专家API返佣

rebateRate
​string

返佣比例

百分比数值,如5代表5%

verificationStatus
​string

认证状态

verified 已认证

not_verified 未认证

包含KYC及KYB结果。通过KYC或KYB其中一项的用户,该字段为已认证

directReferrals
​string

直客数量

subAffiliates
​string

子代理数量

subAffiliateDirectReferrals
​string

子代理直客数量

volume
​string

交易额

单位为USDT

deposit
​string

充值金额

单位为USDT

transactionFee
​string

手续费

单位为USDT

rebate
​string

返还佣金

单位为USDT

子代理返还给渠道的佣金

endId
​string

分页结尾ID

用于在发出请求时作为查询数据的索引

GET/api/v2/broker/sub-affiliate-info
curl https://api.bitget.com/api/v2/broker/sub-affiliate-info
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1758512000000, "data": { "list": [ { "uid": "123456789", "uplineName": "agentUser001", "rebateRateList": [ { "rebateType": "futures", "rebateRate": "5" }, { "rebateType": "spot", "rebateRate": "5" } ], "verificationStatus": "verified", "directReferrals": "10", "subAffiliates": "2", "subAffiliateDirectReferrals": "20", "volume": "100000", "deposit": "5000", "transactionFee": "300", "rebate": "150" } ], "endId": "123456789" } }
json
application/json

获取直客下级信息接口

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

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

startTime和endTime应该被同时设置或者同时不设置

startTime和endTime支持的最大时间跨度为30天

若不传startTime / endTime,将返回该代理商名下所有时间段注册的直客数据,无时间限制。

支持查询任意时间段注册的直客,已取消 90 天限制。

获取直客下级信息接口 › Request Parameters

startTime
​string

开始时间(毫秒)

endTime
​string

结束时间(毫秒)

idLessThan
​string

游标ID

limit
​string

每页条目数

uid
​string

UID

showSub
​string

是否展示直客的下级用户信息

yes: 是

no: 否

获取直客下级信息接口 › Response Parameters

200

Successful response

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

UID

registerTime
​string

注册时间

GET/api/v2/broker/sub-customer-list
curl https://api.bitget.com/api/v2/broker/sub-customer-list
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1695785738672, "data": { "list": [ { "uid": 1235665663, "registerTime": "1679991960110" }, { "uid": 1235665663, "registerTime": "1679991960110" } ], "minId": "123456" } }
json
application/json