# Twitch 主播开播状态 API

> 按用户名查 Twitch 主播此刻是否在直播：当前观看人数、直播标题、游戏分类、标签和开播时间，以及主播的昵称、头像和粉丝数。没在播时返回 status 为 offline，以及上一场的标题和开播时间。

网页版：https://okdata.online/zh/apis/twitch/live/users/get/

- **接口**：`GET /v1/twitch/live/users/get`
- **ID**：`twitch.live.users.get`
- **价格**：$0.004/次
- **返回**：一个 LiveRoom 对象（`data.item`）
- **状态**：预览
- **适合**：竞品监控、找博主

## 价格

每次调用 $0.004，返回一个结果。查 1,000 次共 $4.00。请求到了数据源的查询，查不到或出错也照常计费；还没请求数据源就被拦下的不扣费。

## 参数

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| `username` | string | 是 |  | Twitch 用户名（登录名）：twitch.tv/ 后面那段，带不带 @ 都行。（例：`bobross`） |
| `view` | string: brief / compact / standard / full | 否 | `standard` | 返回多少字段。brief：只给 ID、标题、正文前 100 字、链接、时间和主要数字，适合先扫一遍列表，再按 ID 取详情；compact 去掉空字段、长正文截到 500 字；full 会在 ext 里带上平台特有字段。 |
| `fields` | string[] | 否 |  | 只保留这些字段，按路径写（如 author.name），用来省 token。放在查询参数里时用逗号分隔。 |

cursor、view、fields 的用法见 [请求说明](https://okdata.online/zh/docs/requests/)。

## 返回字段

每一条都是一个 [LiveRoom](https://okdata.online/zh/docs/objects/live_room/)。

| 字段 | 类型 | 说明 |
|---|---|---|
| `id` | string \| null | 直播间 ID，取直播间信息的接口直接用它。平台没给直播间时为 null：账号没在播，或榜单上这一条只链到主播。 |
| `url` | string \| null | 直播间网页地址；平台没有直播间网页时为 null。 |
| `status` | string | live：正在直播；offline：没在播（这时其余字段是平台还保留的上一场的信息）。 |
| `title` | string \| null | 主播设置的直播间标题。 |
| `category` | string \| null | 直播分类或游戏，平台原文（Twitch 的游戏分类、B 站的分区）；平台不给时为 null。 |
| `cover_url` | string \| null | 封面图。 |
| `host` | AccountRef | 主播的公开账号。 |
| `started_at` | string \| null | 本场（或上一场）开播时间，ISO 8601，UTC。 |
| `rank` | integer \| null | 在榜单上的名次，从 1 开始；不是榜单时为 null。 |
| `metrics` | LiveMetrics | 抓取时的直播间整体数据；平台不给的为 null。 |
| `ext` | object | 平台特有字段，只在 view=full 时返回。 |

## 请求示例

### cURL

```bash
curl -G "https://api.okdata.online/v1/twitch/live/users/get" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'username=bobross'
```

### Python

```python
import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/twitch/live/users/get",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"username": "bobross"},
    timeout=60,
)
body = resp.json()
if body["code"] != "ok":
    raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")

row = body["data"]["item"]
print(row["status"], row["title"], row["metrics"]["viewers"])
print("cost: $" + body["meta"]["billing"]["amount"])
```

### TypeScript

```ts
const url = new URL('https://api.okdata.online/v1/twitch/live/users/get');
url.searchParams.set('username', "bobross");

const res = await fetch(url, {
  headers: {
    Authorization: `Bearer ${process.env.OKDATA_API_KEY}`,
  },
});
const body = await res.json();
if (body.code !== 'ok') throw new Error(`${body.code}: ${body.message}`);

const row = body.data.item;
console.log(row.status, row.title, row.metrics.viewers);
console.log('cost: $' + body.meta.billing.amount);
```

### MCP

```json
{
  "name": "call",
  "arguments": {
    "capability": "twitch.live.users.get",
    "username": "bobross"
  }
}
```

或者对接好 MCP 的智能体直接说：

> 用「Twitch 主播开播状态」看现在是不是在播、有多少人在看、几点开播的。

## 返回示例

```json
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "id": "321451958240",
      "url": "https://www.twitch.tv/trailkit",
      "status": "live",
      "title": "Winter camping, packing the sled",
      "category": "Travel & Outdoors",
      "cover_url": null,
      "host": {
        "id": "105458682",
        "username": "trailkit",
        "name": "TrailKit",
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/trailkit-profile_image-150x150.jpeg",
        "followers": 182300,
        "verified": null
      },
      "started_at": "2026-11-19T01:37:37Z",
      "rank": null,
      "metrics": {
        "viewers": 805,
        "total_viewers": null,
        "likes": null,
        "heat": null,
        "products": null
      }
    }
  },
  "warnings": [],
  "meta": {
    "capability": "twitch.live.users.get",
    "billing": {
      "amount": "0.004",
      "currency": "USD",
      "balance_after": "9.996"
    },
    "unavailable": {},
    "cached": false,
    "replayed": false,
    "fetched_at": "2026-11-11T08:00:00Z"
  }
}
```

## 错误

所有错误同一种结构：code、request_id、message 和 message_zh（每个 code 一句固定的话）、charged、retry、retry_after_seconds、param 和 docs_url，具体问题写在 problems 里。请求到了数据源的调用出错（查不到、数据源失败或超时）时，按这个接口的价格计一次费，charged 为 true，并给出 amount；参数错误这类还没请求数据源的错误不扣费。只有 settlement_unknown 的扣费结果要查询后才知道。完整列表：https://okdata.online/zh/docs/errors/

## 常见问题

### Twitch 主播开播状态接口多少钱？

每次调用 $0.004，返回一个结果。查 1,000 次共 $4.00。请求到了数据源的查询，查不到或出错也照常计费；还没请求数据源就被拦下的不扣费。

### 需要Twitch账号、Cookie 或扫码登录吗？

不需要。只要带上 okdata 的 API key。返回的是Twitch上的公开数据，不会用到你自己的Twitch账号。

### 调用失败会扣费吗？

请求到了数据源就会扣一次：返回为空、查不到、数据源出错或超时，都按一次调用计费（按条计价的按 1 条），错误里 charged 为 true，并给出 amount。参数错误、余额不足这类还没请求数据源就被拦下的不扣费。

### Twitch不展示某个字段怎么办？

这个字段会是 null，meta.unavailable 里会列出它和原因：platform（平台本来就不展示）或 capability（我们暂时取不到）。

## 概要

- **简称**：Twitch 主播开播状态
- **英文名**：Twitch streamer live status API
- **也叫**：Twitch是否在直播、Twitch在线人数、Twitch开播监控
- **分类**：[社交媒体](https://okdata.online/zh/categories/social/)
- **状态**：预览。还可能调整，改动会提前公告。
- **价格**：$0.004（约 ¥0.028） / 次 · 参数错误不扣费
- **返回**：一个 LiveRoom，放在 data.item 里
- **调用出错时**：照常计一次费。一个数据源出错就换下一个。请求到了数据源的调用，出错也按一次计费；参数错误不扣费。

## 什么时候收费

- 返回了数据：$0.004，每次调用收一次
- 参数不合法、余额不足、接口暂停：不收费

| 情况 | 收费 |
|---|---|
| 单次最高扣费 | $0.004 |
| 空结果 | $0.004 |
| 查无此项（平台上没有） | $0.004 |
| 数据源出错或超时 | $0.004 |
| 参数不合法、余额不足、接口暂停 | 不收费 |
| 24 小时内带同一个 Idempotency-Key 重发 | 直接返回保存的结果，不扣费 |

请求到了数据源的调用，返回为空、查不到或出错也照常计费，收 $0.004；参数错误这类还没请求数据源就被拦下的不扣费。

价格取自价目表版本 53dd8ce13c359590。 [这个平台的全部价格](https://okdata.online/zh/pricing/twitch/)

- 新账号送 $0.10 试用额度，不用绑卡：够调这个接口 25 次。
- 查 1,000 次共 $4.00。

## 各视图返回的字段

“视图”一列是字段最早出现的 `view`：`compact` 只返回 compact 字段，`standard` 再加上 standard 字段，`full` 返回全部。默认是 `standard`。

- `compact`：`id`, `url`, `status`, `title`, `category`, `host`, `started_at`, `rank`, `metrics`
- `standard`：`cover_url`
- `full`：`ext`

## 这个接口的常见报错

| 状态码 | 代码 | 含义 | 是否扣费 | 能否重试 |
|---|---|---|---|---|
| 400 | `invalid_params` | 参数缺失、类型或取值不对，或者请求方法不对。problems 列出每一处问题，param 是第一个出错的参数。 | 否 | 修正后重试 |
| 401 | `unauthorized` | Key 缺失、格式不对、已撤销、已停用或已过期（知道原因时 reason 会写明）。 | 否 | 不要重试 |
| 402 | `insufficient_balance` | 余额（available）不够这次调用的最高费用（required）。 | 否 | 修正后重试 |
| 404 | `not_found` | 内容、账号或页面不存在或不公开。数据源对这次查询收了费，或者接口的 charge_when_not_found 大于 0 时，这个结果会计费：返回体里 charged 为 true，并给出 amount。 | 请求到了数据源就扣一次 | 不要重试 |
| 429 | `rate_limited` | 账号这一分钟请求太多（reason: rate），或同时进行的调用太多（reason: concurrency）。 | 否 | 可以重试 |
| 500 | `settlement_unknown` | 数据已返回，但没能确认是否扣费。 | 查询后才知道 | 用同一个 Idempotency-Key 重试 |
| 502 | `upstream_failed` | 这个接口的所有数据源这次都失败了。如果数据源对这次请求收了费，就按接口价格计一次费（charged 为 true，并给出 amount）；否则不计费。 | 请求到了数据源就扣一次 | 可以重试 |
| 503 | `capability_paused` | 这个接口暂时停用了，这次没有执行。 | 否 | 可以重试 |
| 504 | `timeout` | 数据没有及时返回。如果请求已经到了会收费的数据源，就按接口价格计一次费（charged 为 true，并给出 amount）；否则预扣退回。 | 请求到了数据源就扣一次 | 可以重试 |

[全部错误码](https://okdata.online/zh/docs/errors/)

## 在你的 AI 里用

> 先读 https://okdata.online/zh/apis/twitch/live/users/get.md，再用 okdata 帮我调这个接口，key 在环境变量 OKDATA_API_KEY 里。用「Twitch 主播开播状态」看现在是不是在播、有多少人在看、几点开播的。
