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

Parameter	Required	Type	Comments
uid	true	string	The master account UID of affiliate's client

Response Parameters

Parameter	Type	Comments
uid	string	UID
vipLevel	string	VIP level
takerVol30Day	string	Taker volume in last 30 days (USDT). All volume related attributes below includes Derivatives, Option, Spot volume
makerVol30Day	string	Maker volume in last 30 days (USDT)
tradeVol30Day	string	Total trading volume in last 30 days (USDT)
depositAmount30Day	string	Deposit amount in last 30 days (USDT)
takerVol365Day	string	Taker volume in the past year (USDT)
makerVol365Day	string	Maker volume in the past year (USDT)
tradeVol365Day	string	Total trading volume in the past year (USDT)
depositAmount365Day	string	Total deposit amount in the past year (USDT)
totalWalletBalance	string	Wallet balance range 1: less than 100 USDT value 2: [100, 250) USDT value 3: [250, 500) USDT value 4: greater than 500 USDT value
depositUpdateTime	string	The update date time (UTC) of deposit data
volUpdateTime	string	The update date of volume data time (UTC)
KycLevel	integer	KYC level. 1, 2, 0

---

Request Example

HTTP

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

Python

Node.js

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
  testnet: true,
  key: 'apikey',
  secret: 'apisecret',
});

client
  .getAffiliateUserInfo({ uid: '1513500' })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(error);
  });

Response Example

{
    "retCode": 0,
    "retMsg": "",
    "result": {
        "uid": "1513500",
        "takerVol30Day": "10",
        "makerVol30Day": "20",
        "tradeVol30Day": "30",
        "depositAmount30Day": "90",
        "takerVol365Day": "100",
        "makerVol365Day": "500",
        "tradeVol365Day": "600",
        "depositAmount365Day": "1300",
        "totalWalletBalance": "4",
        "depositUpdateTime": "2023-06-01 05:12:04",
        "vipLevel": "99",
        "volUpdateTime": "2023-06-02 00:00:00",
        "KycLevel": 1
    },
    "retExtInfo": {},
    "time": 1685596324508
}