跳到主要内容

获取邀请用户交易量

API说明​

此接口用于获取当前已认证 Affiliate 用户直属邀请用户的交易量数据。

仅包含直属邀请用户，不包含下级 Affiliate 用户邀请的用户。

交易时间字段为 trade_time。

注意事项​

  1. 该接口要求请求中必须包含 params，即使为空（{}）也需要传入，否则可能导致签名校验失败。
  2. 当传入 startTime 和 endTime 时，返回指定时间范围内的交易量数据。
  3. 当未传入 startTime 和 endTime 时，保持当前逻辑，默认返回近 30 天数据。
  4. startTime 和 endTime 必须使用 yyyy-MM-dd 格式。
  5. 若传入 uid，将仅返回该邀请用户的数据。
  6. 结果按 trade_time 倒序排序，再按 id 排序以保证稳定性。
  7. pageSize 默认值为 100，最大值为 1000。
  8. 返回时间数据精确到日。

认证​

这是一个私有接口，需要认证。有关 RESTful API 的使用方式，请参考 简介 > 认证和签名。

请求方法​

POST

接口地址​

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

频率限制​

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

请求参数​

参数必填类型描述
startTimefalseString开始日期，格式 yyyy-MM-dd。
endTimefalseString结束日期，格式 yyyy-MM-dd。
pageNofalseInteger页码，默认 1。
pageSizefalseInteger每页条数，默认 100，最大 1000。
uidfalseLong按指定邀请用户 UID 过滤。

响应参数​

参数类型描述
data.list[].uidLong邀请用户 UID
data.list[].volumeString对应日期的交易量
data.list[].timeString交易日期，格式 yyyy-MM-dd
data.totalLong总记录数

请求示例​

params = {
    "startTime": "2024-03-01",
    "endTime": "2024-03-31",
    "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)  # 函数 FuturesRestfulPrivate() 定义在章节（简介 > 认证和代码示例 > 合约 > RESTful 私有接口）

响应示例​

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