Twitch Profile
Twitch 公开主页可能提供 username、显示名称、简介、主页图片、网站、认证或私密状态、地点信息和可见账号数量。标准化账号记录适合创作者资料补全、主页核验和可重复的公开数据快照,但不提供频道管理或需要账号授权的操作。
主要特性
- 精确 username 查询提交一个必填 username,可带一个可选的前导 @,主体使用 1 到 64 个受支持字符。
- 标准化公开身份按照 AccountItem 契约读取可用主页 ID、公开 URL、username、显示名称、简介、头像、封面图和网站。
- 账号状态信号将可用认证和私密状态保留为可空字段,provider 未提供时不会推断其值。
- 可见主页指标将可用粉丝数、关注数和帖子数作为独立选填指标,并与采集时间关联。
- 异步任务流程提交 username 后保存 task_id,轮询共享任务读取接口,并在成功后获取已落库的标准化结果。
- 固定请求计费每个成功任务固定消耗 0.19 个 SocQ 积分,不随选填字段是否可用而变化。
参数
| 参数 | 必填 | 描述 |
|---|---|---|
username | 必填 | 必填 Twitch username。去除首尾空白后,可以一个 @ 开头,随后必须包含 1 到 64 个 ASCII 字母、数字、点、下划线或连字符。 |
如何使用
提交一个受支持的 Twitch username,跟踪异步任务,再通过共享 cursor 响应读取单条已落库主页结果。
- 选择一个符合受支持字符规则的 Twitch 公开 username。
- 将 username POST 到 /v1/twitch/profile,并保存返回的 task_id。
- 轮询 /v1/tasks/{task_id},直到任务成功或报告失败。
- 读取 data.results.items;主页查询最多产生一条来源记录,已落库结果外层仍包含 has_more 和 next_cursor。
curl -X POST "https://api.socq.ai/v1/twitch/profile" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username":"ninja"}'
# 轮询 GET /v1/tasks/{task_id}
# 从 data.results.items 读取标准化账号最佳使用场景
- 创作者资料补全: 为已知创作者记录补充可用 Twitch 身份、简介、图片、网站、账号状态和公开数量。
- username 核验流程: 将输入 handle 解析为标准化公开主页,再与内部实体或研究对象建立关联。
- 公开账号比较: 对分别提交的 username 使用同一种 AccountItem 结构比较可见粉丝数、关注数和帖子数。
- 主页变化监测: 将可空身份字段和指标与 collected_at 一同保存,使后续运行保持为可区分的公开快照。
使用建议
- 提交 username,而不是 Twitch 频道 URL;此 endpoint 不接受 url 和 results_limit 请求字段。
- 最多使用一个前导 @;空格、斜杠、非 ASCII 字符和重复 @ 不符合 runtime username 规则。
- 每次请求预期返回零条或一条来源主页记录;不要把任务读取接口的 limit 参数理解为主页视频或粉丝的扩展数量。
- 将 ID、URL、简介、图片、网站、账号状态、地点和各项指标视为可空,并保留 collected_at 以比较快照。
- 需要视频或 clips 时使用可用的独立 Twitch 内容 endpoint;此 endpoint 只读查询主页,不登录、发布、审核或管理频道。
相关 API
需要其他类型的 Twitch 公开数据时,可以使用以下 API。