getAffiliateUserList
Retrieve the list of direct client users under your affiliate account with optional trading volume, deposit, and commission data for 30-day, 365-day, or custom date ranges using cursor pagination.
Instructions
Query the list of all direct client users under the current affiliate account. Supports cursor-based pagination. Trading volume, deposit amount, and commission data for 30-day, 365-day, and custom date ranges can be returned on demand.
Notes:
Must use an API Key with
affiliatepermission bound to a Master UID.For
cursor, pass""or"0"on the first request; pass thenextPageCursorfrom the previous response for subsequent pages.need30,need365, andneedDepositdefault tofalse; enable as needed to avoid unnecessary performance overhead.When
startDate/endDateare provided, the response includes custom-range fields (takerVol,makerVol,tradeVol,tradfiTradeVol,commissionsVol) and omits the 30-day / 365-day fields.The commission map always returns five fixed currencies:
BTC,ETH,MNT,USDC,USDT.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | ||
| size | No | ||
| needDeposit | No | ||
| need30 | No | ||
| need365 | No | ||
| startDate | No | ||
| endDate | No |