跳到主要内容

获取邀请用户活动数据

API说明​

该接口用于获取当前已认证代理（Affiliate）在指定活动周期内的合约聚合活动数据。 返回数据包括：总转入、总转出、净转入、合约总交易量、合约总收益、合约收益率（ROI）和初始净值。

邀请用户包含下级 Affiliate 用户邀请的用户。

注意事项​

  1. startTime 和 endTime 必须使用 yyyy-MM-dd HH:mm:ss 格式，系统会在下游请求时转换为毫秒时间戳。
  2. 不传 startTime 时，默认取当月第一天 00:00:00。
  3. 不传 endTime 时，默认取当月最后一天 23:59:59。
  4. 结果按 uid 升序排序。
  5. pageSize 默认值为 10，最大值为 1000。
  6. 当 showDetail = yes 时返回按天明细；否则 detail 为空或不返回。

认证​

这是一个私有接口，需要认证。有关 RESTful API 的使用方式，请参考 公共 > 认证和代码示例 > 合约 > RESTful 私有接口。

请求方法​

POST

接口地址​

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

频率限制​

该接口的调用频率限制为：每个 IP 和用户 ID 每秒最多请求5次。
此外，该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息，请参阅"频率限制"部分，跳转

请求参数​

参数必填类型描述
activityIdtrueString活动 ID，对应活动接口编码。
startTimefalseString开始时间，格式 yyyy-MM-dd HH:mm:ss。未传默认当月起始时间。下游调用时会转换为毫秒。
endTimefalseString结束时间，格式 yyyy-MM-dd HH:mm:ss。未传默认当月结束时间。下游调用时会转换为毫秒。
pagefalseInteger页码，默认 1。兼容 pageNo。
pageSizefalseInteger每页条数，默认 10，最大 1000。
uidfalseLong指定邀请用户 UID。
showDetailfalseString是否返回按天明细，支持值：yes / no。

响应参数​

参数类型描述
data.list[].uidLong用户 UID
data.list[].contractTransInString活动周期内合约总转入金额
data.list[].contractTransOutString活动周期内合约总转出金额
data.list[].contractNetTransInString活动周期内合约净转入金额
data.list[].contractVolumeString活动周期内合约总交易量
data.list[].contractProfitString活动周期内合约总收益
data.list[].contractRoiString活动周期内合约收益率
data.list[].initialNetValueString初始净值
data.list[].detail[].dateString日期，格式 YYYY-MM-DD
data.list[].detail[].contractTransInString当日合约转入金额
data.list[].detail[].contractTransOutString当日合约转出金额
data.list[].detail[].contractVolumeString当日合约交易量
data.totalLong总记录数

请求示例​

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)  # 函数 FuturesRestfulPrivate() 定义在章节（公共 > 认证和代码示例 > 合约 > RESTful 私有接口）

响应示例​

{
  "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
  }
}