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

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": "1001699821",
                "registerTime": "0001-01-01",
                "source": "aff_14650_10087",
                "remarks": "front_hub_robot",
                "isKyc": false,
                "takerVol30Day": "",
                "makerVol30Day": "",
                "tradeVol30Day": "",
                "depositAmount30Day": "",
                "takerVol365Day": "",
                "makerVol365Day": "",
                "tradeVol365Day": "",
                "depositAmount365Day": "",
                "takerVol": "",
                "makerVol": "",
                "tradeVol": "",
                "startDate": "2025-09-21",
                "endDate": "2025-10-21"
            },
            {
                "userId": "1001625535",
                "registerTime": "0001-01-01",
                "source": "aff_14650_10087",
                "remarks": "front_hub_robot",
                "isKyc": false,
                "takerVol30Day": "",
                "makerVol30Day": "",
                "tradeVol30Day": "",
                "depositAmount30Day": "",
                "takerVol365Day": "",
                "makerVol365Day": "",
                "tradeVol365Day": "",
                "depositAmount365Day": "",
                "takerVol": "",
                "makerVol": "",
                "tradeVol": "",
                "startDate": "2025-09-21",
                "endDate": "2025-10-21"
            }
        ],
        "nextPageCursor": "16197"
    },
    "retExtInfo": {},
    "time": 1733205472513
}