Affiliate · Customer Info

Classic Account — Affiliate · Customer Info

Get Agent Commission Detail

GET

https://api.bitget.com

/api/v2/broker/agent-commission

Rate limit: 10/sec/UID

startTime and endTime should be set simultaneously or not set at all. The maximum time span supported by startTime and endTime is 7 days. This API supports retrieving data within the past 90 days. If startTime and endTime are not set in the request, it will default to returning information for yesterday (00:00-23: 59 UTC+8).

Get Agent Commission Detail › Request Parameters

startTime

string

Start time Unix millisecond timestamp

endTime

string

End time Unix millisecond timestamp

limit

string

max:100,default: 100

idLessThan

string

Requests the content on the page before this ID (older data), the value input should be the endld of the corresponding interface.

Get Agent Commission Detail › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

object[]

Customer Commission List

endId

string

The last data ID. When used as a request, the id is used as an index for the next query

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

Get Agent Customer Assets List

POST

https://api.bitget.com

/api/v2/broker/customer-asset

Rate limit: 10/sec/UID

Data update frequency: 10 minutes

Get Agent Customer Assets List › Request Parameters

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 500

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients yes: Yes no: No

Get Agent Customer Assets List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

balance

string

Account Balance

uTime

string

Account Last update Time

remark

string

When the user has too many sub-accounts, it prompts that there are too many sub-accounts and the account balance cannot be queried

Get Agent Customer Deposit List

POST

https://api.bitget.com

/api/v2/broker/customer-deposit

Rate limit: 10/sec/UID

The API response includes the user's on-chain deposits and internal transfers startTime and endTime should be both set or both left blank startTime and endTime should be within 30days This API endpoint can only query the data in 90 days. If you need older data, please contact BD to export it manually. It will return yesterday's data (00:00-23:59 UTC+8) by default if there is no startTime/endTime set. The data is updated in real time

Get Agent Customer Deposit List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 1000

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients yes: Yes no: No

Get Agent Customer Deposit List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

orderId

string

Deposit Order ID

depositTime

string

Deposit Time (ms)

depositCoin

string

Deposit Coin

depositAmount

string

Deposit Amount

Get Agent Customer Kyc Result

GET

https://api.bitget.com

/api/v2/broker/customer-kyc-result

Rate limit: 10/sec/UID

startTime and endTime should be both set or both left blank It will return yesterday's KYC or KYB data(00:00-23:59UTC+8) by default if there is no startTime/endTimeset. Data update frequency: 5 minutes

Get Agent Customer Kyc Result › Request Parameters

startTime

string

Start time, maximum range of 90 days

endTime

string

End time, maximum range of 90 days.

idLessThan

string

Retrieve data before this endId

limit

string

Limit number of data(default 100,max 1000)

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients
yes: Yes no: No

Get Agent Customer Kyc Result › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

uid

string

UID

kycResult

string

KYC or KYB result passed not_passed

endId

string

The last userID on the page

Get Agent Customer List

POST

https://api.bitget.com

/api/v2/broker/customer-list

Rate limit: 10/sec/UID

startTime and endTime should be both set or both left blank startTime and endTime should be within 30days If startTime / endTime are not set, all registered clients will be returned with no time restriction. It supports querying clients registered at any time, with no 90-day restriction. If you want to confirm whether a specific UID is your referral client you invited, you can verify it by setting the UID in the body, for example: {"uid":"123456"}. The data is updated in real time

Get Agent Customer List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 1000

uid

string

UID

referralCode

string

Referral code

Get Agent Customer List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

registerTime

string

Get Agent Customer Trade Volume List

POST

https://api.bitget.com

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

Rate limit: 10/sec/UID

This API response includes the trading volume for both spot and futures startTime and endTime should be both set or both left blank startTime and endTime should be within 30days This API endpoint can only query the data in 90 days. If you need older data, please contact BD to export it manually. It will return yesterday's data (00:00-23:59 UTC+8) by default if there is no startTime/endTime set. Data update frequency: 10 minutes

Get Agent Customer Trade Volume List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 1000

uid

string

UID

showSub

string

Whether to show sub-customer information yes: Show no: Do not show

Get Agent Customer Trade Volume List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

volumn

string

Trade volume

spotVolume

string

Spot trade volume

futuresVolume

string

Futures trade volume

time

string

Timestamp(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 Agent Direct commissions

GET

https://api.bitget.com

/api/v2/broker/customer-commissions

Rate limit: 10/sec/UID

startTime and endTime should be both set or both left blank This API endpoint can only query the data in 90 days. If you need older data, please contact BD to export it manually. It will return yesterday's data (00:00-23:59 UTC+8) by default if there is no startTime/endTime set. Data update frequency: T+1 (UTC+8)

Get Agent Direct commissions › Request Parameters

startTime

string

Start time, maximum range of 30 days

endTime

string

End time, maximum range of 30 days.

idLessThan

string

Retrieve data before this ID

limit

string

Limit number of data(default 100,max 1000)

uid

string

UID

coin

string

Coin, e.g: BTC

symbol

string

Symbol e.g： BGBUSDT_SPBL spot BTCUSDT_SPBL-MABL spot margin BTCUSDT_UMCBL USDT-Futures BTCUSD_DMCBL COIN-Futures BTCPERP_CMCBL USDC-Futures

showSub

string

Whether to Display Subordinate User Information of Direct Clients
yes: Yes no: No

Get Agent Direct commissions › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

object[]

Commission List

endId

string

Last data ID. Used as an index for querying data when making a request

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 Agent SubCustomer List

GET

https://api.bitget.com

/api/v2/broker/sub-customer-list

Rate limit: 10/sec/UID

Get Agent SubCustomer List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

idLessThan

string

Cursor ID

limit

string

Items per page

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients
yes: Yes no: No

Get Agent SubCustomer List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

uid

string

UID

registerTime

string

Classic Affiliate Customer Info API

Affiliate · Customer Info

Classic Account — Affiliate · Customer Info

Get Agent Commission Detail

GET

https://api.bitget.com

/api/v2/broker/agent-commission

Rate limit: 10/sec/UID

Get Agent Commission Detail › Request Parameters

startTime

string

Start time Unix millisecond timestamp

endTime

string

End time Unix millisecond timestamp

limit

string

max:100,default: 100

idLessThan

string

Requests the content on the page before this ID (older data), the value input should be the endld of the corresponding interface.

Get Agent Commission Detail › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

object[]

Customer Commission List

endId

string

The last data ID. When used as a request, the id is used as an index for the next query

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

Get Agent Customer Assets List

POST

https://api.bitget.com

/api/v2/broker/customer-asset

Rate limit: 10/sec/UID

Data update frequency: 10 minutes

Get Agent Customer Assets List › Request Parameters

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 500

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients yes: Yes no: No

Get Agent Customer Assets List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

balance

string

Account Balance

uTime

string

Account Last update Time

remark

string

When the user has too many sub-accounts, it prompts that there are too many sub-accounts and the account balance cannot be queried

Get Agent Customer Deposit List

POST

https://api.bitget.com

/api/v2/broker/customer-deposit

Rate limit: 10/sec/UID

Get Agent Customer Deposit List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 1000

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients yes: Yes no: No

Get Agent Customer Deposit List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

orderId

string

Deposit Order ID

depositTime

string

Deposit Time (ms)

depositCoin

string

Deposit Coin

depositAmount

string

Deposit Amount

Get Agent Customer Kyc Result

GET

https://api.bitget.com

/api/v2/broker/customer-kyc-result

Rate limit: 10/sec/UID

Get Agent Customer Kyc Result › Request Parameters

startTime

string

Start time, maximum range of 90 days

endTime

string

End time, maximum range of 90 days.

idLessThan

string

Retrieve data before this endId

limit

string

Limit number of data(default 100,max 1000)

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients
yes: Yes no: No

Get Agent Customer Kyc Result › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

uid

string

UID

kycResult

string

KYC or KYB result passed not_passed

endId

string

The last userID on the page

Get Agent Customer List

POST

https://api.bitget.com

/api/v2/broker/customer-list

Rate limit: 10/sec/UID

Get Agent Customer List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 1000

uid

string

UID

referralCode

string

Referral code

Get Agent Customer List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

registerTime

string

Get Agent Customer Trade Volume List

POST

https://api.bitget.com

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

Rate limit: 10/sec/UID

Get Agent Customer Trade Volume List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

pageNo

string

Page number

pageSize

string

Page size, 100 default, Max 1000

uid

string

UID

showSub

string

Whether to show sub-customer information yes: Show no: Do not show

Get Agent Customer Trade Volume List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

uid

string

UID

volumn

string

Trade volume

spotVolume

string

Spot trade volume

futuresVolume

string

Futures trade volume

time

string

Timestamp(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 Agent Direct commissions

GET

https://api.bitget.com

/api/v2/broker/customer-commissions

Rate limit: 10/sec/UID

Get Agent Direct commissions › Request Parameters

startTime

string

Start time, maximum range of 30 days

endTime

string

End time, maximum range of 30 days.

idLessThan

string

Retrieve data before this ID

limit

string

Limit number of data(default 100,max 1000)

uid

string

UID

coin

string

Coin, e.g: BTC

symbol

string

Symbol e.g： BGBUSDT_SPBL spot BTCUSDT_SPBL-MABL spot margin BTCUSDT_UMCBL USDT-Futures BTCUSD_DMCBL COIN-Futures BTCPERP_CMCBL USDC-Futures

showSub

string

Whether to Display Subordinate User Information of Direct Clients
yes: Yes no: No

Get Agent Direct commissions › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

object[]

Commission List

endId

string

Last data ID. Used as an index for querying data when making a request

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 Agent SubCustomer List

GET

https://api.bitget.com

/api/v2/broker/sub-customer-list

Rate limit: 10/sec/UID

Get Agent SubCustomer List › Request Parameters

startTime

string

Start time (ms)

endTime

string

End time (ms)

idLessThan

string

Cursor ID

limit

string

Items per page

uid

string

UID

showSub

string

Whether to Display Subordinate User Information of Direct Clients
yes: Yes no: No

Get Agent SubCustomer List › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

uid

string

UID

registerTime

string