Get Direct Invitee User Asset

API Description

This interface queries the total deposit amount, total withdrawal amount, and current account balance of direct invitee users invited by the currently authenticated affiliate user.

Only direct invitees are included. Users invited by sub-affiliates are excluded.

Precautions

1. Request parameters startTime and endTime must use the format yyyy-MM-dd HH:mm:ss. The system converts them into millisecond timestamps when forwarding the downstream request.
2. If startTime and endTime are not provided, the API returns the cumulative deposit and withdrawal amounts since the user account was created.
3. Results are sorted in ascending order by uid.
4. Default pageSize is 10, and the maximum is 1000.
5. The current account balance is not affected by startTime and endTime. The API always returns the latest current balance of the account.

Authentication

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

Request Method

GET

Endpoint

/api/v3/patener/openapi/v1/partner/invitation/user/assets

Frequency Limit

The frequency limit for this interface is 5 requests/s per IP and user ID. In addition to this per-interface limit, a global rate limit is also enforced.

For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section at click here

Request Parameters

Parameter	Mandatory	Type	Description
uid	false	Long	Invited user UID. If not provided, all invited users under the current affiliate will be queried.
startTime	false	String	Query start time, formatted as yyyy-MM-dd HH:mm:ss.
endTime	false	String	Query end time, formatted as yyyy-MM-dd HH:mm:ss.
quote	false	String	Settlement currency. Supported values: usdt, usdc. When usdc is passed, USDC assets are returned. If omitted, USDT assets are returned by default.
pageNo	false	Integer	Page number. Default: 1.
pageSize	false	Integer	Number of records per page. Default: 20. Maximum: 100.

Response Parameters

Parameter	Type	Description
code	String	Response status code
msg	String	Response message
data	Object	Response data
data.total	Integer	Total number of records
data.list	Array	Direct invitee user asset list
data.list[].uid	Long	Invited user UID
data.list[].totalDeposit	String	User total deposit amount
data.list[].totalWithdrawal	String	User total withdrawal amount
data.list[].currentBalance	String	User current account balance
data.list[].updateTime	String	Last account balance update time
data.list[].firstDepositAmount	String	User first deposit amount
data.list[].firstDepositTime	String	User first deposit time

Request Example

params = {
    "uid": 12345678,
    "quote": "usdt",
    "pageNo": 1,
    "pageSize": 20
}

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

method = "GET"
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": "0",
  "msg": "success",
  "data": {
    "total": 2,
    "list": [
      {
        "uid": 12345678,
        "totalDeposit": "15000.00000000",
        "totalWithdrawal": "3000.00000000",
        "currentBalance": "5800.00000000",
        "updateTime": "2026-05-21 10:25:00",
        "firstDepositAmount": "5000.00000000",
        "firstDepositTime": "2026-03-15 09:12:33"
      },
      {
        "uid": 87654321,
        "totalDeposit": "8200.00000000",
        "totalWithdrawal": "1200.00000000",
        "currentBalance": "4300.50000000",
        "updateTime": "2026-05-21 10:25:00",
        "firstDepositAmount": "5000.00000000",
        "firstDepositTime": "2026-03-15 09:12:33"
      }
    ]
  }
}