Get Affiliate User List

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

HTTP Request

GET /v5/affiliate/aff-user-list

Request Parameters

Parameter	Required	Type	Comments
size	false	integer	Limit for data size per page. [0, 1000]. Default: 0
cursor	false	string	Cursor. Use the nextPageCursor token from the response to retrieve the next page of the result set
needDeposit	false	boolean	true: return deposit info; false(default): does not return deposit info
need30	false	boolean	true: return 30 days trading info; false(default): does not return 30 days trading info
need365	false	boolean	true: return 365 days trading info; false(default): does not return 365 days trading info
startDate	false	string	Start date of the query period, format YYYY-MM-DD
endDate	false	string	End date of the query period, format YYYY-MM-DD

Response Parameters

Parameter	Type	Comments
list	array	Object
> userId	string	user Id
> registerTime	string	user register time
> source	string	user registration source, from which referrer code
> remarks	string	The remark
> isKyc	boolean	Whether KYC is completed
> takerVol30Day	string	Taker volume in last 30 days (USDT), update at T + 1. All volume related attributes below includes Derivatives, Option, Spot volume
> makerVol30Day	string	Maker volume in last 30 days (USDT), update at T + 1
> tradeVol30Day	string	Total trading volume in last 30 days (USDT), update at T + 1
> depositAmount30Day	string	Deposit amount in last 30 days (USDT)
> takerVol365Day	string	Taker volume in the past year (USDT), update at T + 1
> makerVol365Day	string	Maker volume in the past year (USDT), update at T + 1
> tradeVol365Day	string	Total trading volume in the past year (USDT), update at T + 1
> depositAmount365Day	string	Total deposit amount in the past year (USDT)
> takerVol	string	Taker volume in [startDate, endDate] (USDT), update at T + 1, includes Derivatives, Option, Spot volume
> makerVol	string	Maker volume in [startDate, endDate] (USDT), update at T + 1, includes Derivatives, Option, Spot volume
> tradeVol	string	Total trading volume in [startDate, endDate] (USDT), update at T + 1, includes Derivatives, Option, Spot volume
> startDate	string	Start date of the query period
> endDate	string	End date of the query period
> tradfiTradeVol	string	Only when startDate and endDate are in the input parameters, returns tradfi trade volume between startDate and endDate
> tradfiTradeVol30Day	string	tradfi trade volume in last 30 days (USDT). When startDate and endDate are in the input parameters, return 0
> tradfiTradeVol365Day	string	tradfi trade volume in the past year (USDT). When startDate and endDate are in the input parameters, return 0
> commissionsVol	json	Only when startDate and endDate are in the input parameters, returns commission between startDate and endDate
> commissions30Day	json	commission in last 30 days
> commissions365Day	json	commission in the past year
nextPageCursor	string	Refer to the cursor request parameter

---

Request Example

HTTP

GET /v5/affiliate/aff-user-list?cursor=0&size=2&need365=true&need30=true&needDeposit=true&startDate=2025-10-21&endDate=2025-10-22 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

Python

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
)
print(session.get_affiliate_user_list(
    cursor="0",
    size="2",
    need365=True,
    need30=True,
    needDeposit=True,
    startDate="2025-10-21",
    endDate="2025-10-22",
))

Node.js

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

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

client
  .getAffiliateUserInfo({ size: 2 })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(error);
  });

Response Example

{
    "retCode": 0,
    "retMsg": "",
    "result": {
        "list": [
            {
                "userId": "103895898",
                "registerTime": "2024-10-29",
                "source": "Default",
                "remarks": "",
                "isKyc": true,
                "takerVol30Day": "12861.362976",
                "makerVol30Day": "262.60865",
                "tradeVol30Day": "13123.971626",
                "depositAmount30Day": "",
                "takerVol365Day": "208971.63737375",
                "makerVol365Day": "33392.64275",
                "tradeVol365Day": "242364.28012375",
                "depositAmount365Day": "",
                "takerVol": "194231.4175",
                "makerVol": "32886.108",
                "tradeVol": "227117.5255",
                "startDate": "2025-08-21",
                "endDate": "2025-10-22",
                "tradfiTradeVol": "0",
                "tradfiTradeVol30Day": "0",
                "tradfiTradeVol365Day": "0",
                "commissions30Day": {
                    "BTC": "0",
                    "ETH": "0",
                    "MNT": "0.0621748",
                    "USDC": "0",
                    "USDT": "2.64288011"
                },
                "commissionsVol": {
                    "BTC": "0",
                    "ETH": "0",
                    "MNT": "0",
                    "USDC": "0",
                    "USDT": "0.00835765"
                },
                "commissions365Day": {
                    "BTC": "0.00000002",
                    "ETH": "0.00000063",
                    "MNT": "0.1210605",
                    "USDC": "0.13462624",
                    "USDT": "2.79509816"
                }
            },
            {
                "userId": "1547321",
                "registerTime": "2023-06-28",
                "source": "Default",
                "remarks": "",
                "isKyc": false,
                "takerVol30Day": "",
                "makerVol30Day": "",
                "tradeVol30Day": "",
                "depositAmount30Day": "",
                "takerVol365Day": "147664.35398115",
                "makerVol365Day": "74696.351",
                "tradeVol365Day": "222360.70498115",
                "depositAmount365Day": "",
                "takerVol": "30936.86124",
                "makerVol": "36.032",
                "tradeVol": "30972.89324",
                "startDate": "2025-08-21",
                "endDate": "2025-10-22",
                "tradfiTradeVol": "0",
                "tradfiTradeVol30Day": "0",
                "tradfiTradeVol365Day": "0",
                "commissions30Day": {
                    "BTC": "0",
                    "ETH": "0",
                    "MNT": "0",
                    "USDC": "0",
                    "USDT": "0"
                },
                "commissionsVol": {
                    "BTC": "0",
                    "ETH": "0",
                    "MNT": "2.35583601",
                    "USDC": "0",
                    "USDT": "3.1648939"
                },
                "commissions365Day": {
                    "BTC": "0",
                    "ETH": "0",
                    "MNT": "8.90403178",
                    "USDC": "0",
                    "USDT": "23.89337689"
                }
            }
        ],
        "nextPageCursor": "16197"
    },
    "retExtInfo": {},
    "time": 1733205472513
}