Skip to main content

Get Affiliate User Info

To use this endpoint, you should have an affiliate account and only tick "affiliate" permission while creating the API key.
Affiliate site: https://affiliates.bybit.com

tip
  • Use master UID only
  • The api key can only have "Affiliate" permission
  • The transaction volume and deposit amount are the total amount of the user done on Bybit, and have nothing to do with commission settlement. Any transaction volume data related to commission settlement is subject to the Affiliate Portal.

HTTP Request

GET/v5/user/aff-customer-info

Request Parameters

ParameterRequiredTypeComments
uidtruestringThe master account UID of affiliate's client
coinfalsestringCoin type for filtering, e.g., USDT
businessfalsestringBusiness line filter. 1: Derivatives, 2: Spot, 3: ByFi, 4: USDC, 5: Options

Response Parameters

ParameterTypeComments
uidstringUID
vipLevelstringVIP tier. Common values: 0 (No VIP), 1, 2, 3, 4, 99 (VVIP)
takerVol30DaystringTaker volume in last 30 days (USDT). All volume fields below include Derivatives, Options, and Spot volume
makerVol30DaystringMaker volume in last 30 days (USDT)
tradeVol30DaystringTotal trading volume in last 30 days (USDT)
depositAmount30DaystringDeposit amount in last 30 days (USDT), updated every 5 mins
takerVol365DaystringLifetime taker volume since becoming affiliate's client (USDT)
makerVol365DaystringLifetime maker volume since becoming affiliate's client (USDT)
tradeVol365DaystringLifetime total trading volume since becoming affiliate's client (USDT)
depositAmount365DaystringLifetime total deposit amount since becoming affiliate's client (USDT). Includes all deposit types regardless of account or business
totalWalletBalancestringWallet balance range
  • 1: less than 100 USDT
  • 2: [100, 250) USDT
  • 3: [250, 500) USDT
  • 4: >= 500 USDT
depositUpdateTimestringUTC timestamp (ms) of the latest deposit data update
volUpdateTimestringUTC timestamp (ms) of the latest trading volume data update
KycLevelintegerKYC level. 0: No KYC, 1: KYC Level 1, 2: KYC Level 2
tradfiTradeVol30DaystringTradFi trade volume in last 30 days (USDT)
tradfiTradeVol365DaystringTradFi trade volume in last 365 days (USDT)
commissions30DayobjectCommission breakdown by coin for the last 30 days (e.g., BTC, ETH, USDT)
commissions365DayobjectCommission breakdown by coin for the last 365 days (e.g., BTC, ETH, USDT)
paySendAmount30DaystringPayment amount in the last 30 days
payFttstringPay first transaction amount
cardFttstringCard first-time transaction amount

Request Example

GET /v5/user/aff-customer-info?uid=1513500 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1685596324209
X-BAPI-RECV-WINDOW: 5000
X-BAPI-SIGN: xxxxxx
Content-Type: application/json

Response Example

{
"retCode": 0,
"retMsg": "",
"result": {
"uid": "1087997",
"takerVol30Day": "17061.64983",
"makerVol30Day": "10756.454142",
"tradeVol30Day": "27818.103972",
"depositAmount30Day": "0",
"takerVol365Day": "1183752.53919162",
"makerVol365Day": "44349.42819772",
"tradeVol365Day": "1228101.96738934",
"depositAmount365Day": "0",
"totalWalletBalance": "4",
"depositUpdateTime": "2026-02-04 00:00:00",
"vipLevel": "5",
"volUpdateTime": "2026-02-04 00:00:00",
"KycLevel": 0,
"tradfiTradeVol30Day": "1828890.6352",
"tradfiTradeVol365Day": "1828890.6352",
"commissions30Day": {
"BTC": "",
"ETH": "",
"MNT": "2.14012088",
"USDC": "",
"USDT": "17.0461748"
},
"commissions365Day": {
"BTC": "0.00012928",
"ETH": "0.00099384",
"MNT": "95.72886531",
"USDC": "2.81382591",
"USDT": "130.48078429"
},
"paySendAmount30Day": "1000.00",
"payFtt": "100.00",
"cardFtt": "50.00"
},
"retExtInfo": {},
"time": 1770197061282
}