Get Invited Users Trading Volume

API Description

This interface retrieves trading volume details of users directly invited by the currently authenticated affiliate user.

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

The trading time field is trade_time.

Precautions

1. For this endpoint, params is required and must be included in all requests, even if empty ({}). Omitting it may cause signature verification to fail.
2. If startTime and endTime are provided, the API returns trading volume data within the specified date range.
3. If startTime and endTime are not provided, the API keeps the current default behavior and returns data for the past 30 days.
4. startTime and endTime must use the format yyyy-MM-dd.
5. If uid is provided, results will be filtered for the specified invited user.
6. Results are sorted in descending order by trade_time, then by id for stable sorting.
7. Default pageSize is 100, and the maximum is 1000.
8. Returned time data is accurate to day.

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/volume/list

Request Parameters

Parameter	Mandatory	Type	Description
startTime	false	String	Start date, formatted as yyyy-MM-dd.
endTime	false	String	End date, formatted as yyyy-MM-dd.
pageNo	false	Integer	Page number. Default: 1.
pageSize	false	Integer	Number of records per page. Default: 100. Maximum: 1000.
uid	false	Long	Filter by specific invited user UID.

Response Parameters

Parameter	Type	Description
data.list[].uid	Long	Invited user UID
data.list[].volume	String	Trading volume for the corresponding day
data.list[].time	String	Trade date, formatted as yyyy-MM-dd
data.total	Long	Total number of records

Request Example

params = {
    "pageNo": 1,
    "pageSize": 100,
    "uid": 123126704
}

api_url = "/api/v3/patener/openapi/v1/partner/invitation/user/volume/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

{
  "code": "200",
  "msg": "success",
  "data": {
    "list": [
      {
        "uid": 123126704,
        "volume": "629.44650000",
        "time": "2024-04-01"
      }
    ],
    "total": 1
  }
}