Get Affiliate User Activity Data

API Description

This interface retrieves aggregated futures activity data of users directly invited by the currently authenticated affiliate user within a specified activity period.

The returned data includes total deposits, total withdrawals, net deposits, total futures trading volume, total futures profit, futures ROI, and initial net value.

Only directly invited users are included. Users under downstream affiliate users are not included.

Precautions

1. startTime and endTime must use the format yyyy-MM-dd HH:mm:ss, and will be converted to milliseconds for downstream requests.
2. If startTime is not provided, it defaults to the first day of the current month at 00:00:00.
3. If endTime is not provided, it defaults to the last day of the current month at 23:59:59.
4. Results are sorted in ascending order by uid.
5. Default pageSize is 10, and the maximum is 1000.
6. If showDetail = yes, daily details will be returned. Otherwise, detail will be empty or omitted.

Authentication

This is a private interface and requires authentication. For details on using the RESTful API, refer to Introduction > Authentication & Signature.

Request Method

POST

Endpoint

/api/v3/patener/openapi/v1/partner/invitation/user/activity/list

Request Parameters

Parameter	Mandatory	Type	Description
activityId	true	String	Activity ID, mapped to the activity endpoint code.
startTime	false	String	Start time, formatted as yyyy-MM-dd HH:mm:ss. Defaults to the beginning of the current month if not provided. Converted to milliseconds when calling downstream services.
endTime	false	String	End time, formatted as yyyy-MM-dd HH:mm:ss. Defaults to the end of the current month if not provided. Converted to milliseconds when calling downstream services.
page	false	Integer	Page number. Default: 1. Compatible with pageNo.
pageSize	false	Integer	Number of records per page. Default: 10. Maximum: 1000.
uid	false	Long	Specific invited user UID.
showDetail	false	String	Whether to return daily details. Supported values: yes / no.

Response Parameters

Parameter	Type	Description
data.list[].uid	Long	User UID
data.list[].contractTransIn	String	Total futures transfer-in amount during the activity period
data.list[].contractTransOut	String	Total futures transfer-out amount during the activity period
data.list[].contractNetTransIn	String	Net futures transfer-in amount during the activity period
data.list[].contractVolume	String	Total futures trading volume during the activity period
data.list[].contractProfit	String	Total futures profit during the activity period
data.list[].contractRoi	String	Futures ROI during the activity period
data.list[].initialNetValue	String	Initial net value
data.list[].detail[].date	String	Date in YYYY-MM-DD format
data.list[].detail[].contractTransIn	String	Futures transfer-in amount for the day
data.list[].detail[].contractTransOut	String	Futures transfer-out amount for the day
data.list[].detail[].contractVolume	String	Futures trading volume for the day
data.total	Long	Total number of records

Request Example

params = {
    "activityId": "ACT20260307",
    "page": 1,
    "pageSize": 10,
    "startTime": "2026-03-01 00:00:00",
    "endTime": "2026-03-31 23:59:59",
    "uid": 1116977,
    "showDetail": "yes"
}

api_url = "/api/v3/patener/openapi/v1/partner/invitation/user/activity/list"

method = "POST"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key)  # function FuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)

Response Example

{
  "success": true,
  "code": 200,
  "message": "success",
  "retry": false,
  "data": {
    "list": [
      {
        "uid": "123320752",
        "contractTransIn": "0",
        "contractTransOut": "0",
        "contractNetTransIn": "0",
        "contractVolume": "0",
        "contractProfit": "-29.893815",
        "contractRoi": "-0.92094277",
        "initialNetValue": "32.46001375",
        "detail": [
          {
            "date": "2026-04-02",
            "contractTransIn": "0",
            "contractTransOut": "0",
            "contractVolume": "0"
          }
        ]
      }
    ],
    "total": "9",
    "context": null
  }
}