代理 · 客户信息

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

获取代理佣金

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[]

客户佣金列表

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

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

充值数量

获取直客认证结果

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

获取直客列表

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

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)的信息数据更新频率：10分钟

获取直客交易量 › 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[]

直客佣金列表

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-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

注册时间

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

代理 · 客户信息

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

获取代理佣金

GET

https://api.bitget.com

/api/v2/broker/agent-commission

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

获取代理佣金 › 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[]

客户佣金列表

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

https://api.bitget.com

/api/v2/broker/customer-deposit

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

获取直客充值记录 › 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

充值数量

获取直客认证结果

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

获取直客列表

POST

https://api.bitget.com

/api/v2/broker/customer-list

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

获取直客列表 › 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

https://api.bitget.com

/api/v2/broker/customer-trade-volume

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

获取直客交易量 › 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)

获取直客佣金 › 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[]

直客佣金列表

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-customer-list

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

获取直客下级信息接口 › 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

注册时间