跳到主要内容

获取属邀请用户列表

API说明​

此接口用于获取当前已认证 Affiliate 用户的属邀请用户列表。

Affiliate 用户身份通过 OpenAPI 认证自动识别。

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

注意事项​

  1. 请求参数 startTime 和 endTime 必须使用 yyyy-MM-dd HH:mm:ss 格式。
  2. 对于 GET 请求，所有请求参数必须通过 URL Query 传递，不应放在请求体中。
  3. 未传 startTime 时，默认取当月开始时间。
  4. 未传 endTime 时，默认取当月结束时间。
  5. 结果按 register_time 倒序排序，再按 id 排序以保证稳定性。
  6. pageSize 默认值为 100，最大值为 1000。

认证​

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

请求方法​

GET

接口地址​

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

频率限制​

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

请求参数​

参数必填类型描述
startTimefalseString开始时间，格式 yyyy-MM-dd HH:mm:ss，按注册时间过滤。未传时默认当月开始时间。
endTimefalseString结束时间，格式 yyyy-MM-dd HH:mm:ss，按注册时间过滤。未传时默认当月结束时间。
pageNofalseInteger页码，默认 1。
pageSizefalseInteger每页条数，默认 100，最大 1000。
uidfalseLong按指定邀请用户 UID 查询。
referralCodefalseString按指定邀请码过滤注册用户。

响应参数​

参数类型描述
data.list[].uidLong邀请用户 UID
data.list[].registerTimeString注册时间，格式 yyyy-MM-dd HH:mm:ss
data.totalLong总记录数

请求示例​

params = {
    "pageNo": 1,
    "pageSize": 100,
    "uid": 1116977,
    "startTime": "2021-09-09 13:43:18",
    "endTime": "2021-09-09 14:43:18"
}

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

method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key)  # 函数 FuturesRestfulPrivate() 定义在章节（公共 > 认证和代码示例 > 合约 > RESTful 私有接口）

响应示例​

{
  "code": "200",
  "msg": "success",
  "data": {
    "list": [
      {
        "uid": 1116977,
        "registerTime": "2021-09-09 14:43:18"
      }
    ],
    "total": 1
  }
}