# WeChat Channels live room API

> A Channels live by its live ID (the id wechat_channels.live.users.get answers with): whether it is still on, start time, likes, the host and the cover, and once it has ended, how many people watched the replay. The count WeChat labels as online here is everyone who has come in since the live started, so it is returned as total_viewers; WeChat gives no figure for who is in the room right now, so viewers is null. A live ID WeChat does not know answers not_found and is charged like any other call.

Canonical page: https://okdata.online/apis/wechat_channels/live/rooms/get/

- **Endpoint**: `GET /v1/wechat_channels/live/rooms/get`
- **ID**: `wechat_channels.live.rooms.get`
- **Price**: $0.02 per call
- **Returns**: one LiveRoom object (`data.item`)
- **Status**: preview
- **Good for**: Competitor monitoring

## Price

One call costs $0.02 and returns one live_room. 1,000 lookups cost $20.00. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `id` | string | yes |  | The live ID (digits): the id wechat_channels.live.users.get answers with while the account is live. (e.g. `1214317309080180172`) |
| `host_id` | string | no |  | The host's account ID (v2_…@finder), host.id of that same answer. Optional; it helps WeChat find the live. (e.g. `v2_060000231003b20faec8c7e78d10cad5c60ce835b07750c30d46f2375d2e2b76d9fd609427c4@finder`) |
| `view` | string: brief / compact / standard / full | no | `standard` | How much of each object comes back. brief: IDs, title, the first 100 characters of the text, link, time and the main counts, for scanning a list (then get what you need by ID). compact leaves out empty fields and cuts long text at 500 characters. full adds platform-specific fields under ext. |
| `fields` | string[] | no |  | Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated. |

cursor, view and fields work as described in [Requests](https://okdata.online/docs/requests/).

## Returned fields

Each item is a [LiveRoom](https://okdata.online/docs/objects/live_room/).

| Field | Type | Description |
|---|---|---|
| `id` | string \| null | The room's ID; the endpoints that read a room take it. Null where the platform names no room: an account that is not live, or a board entry that links to the host only. |
| `url` | string \| null | The room's web page; null where the platform gives the room none. |
| `status` | string | live: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it). |
| `title` | string \| null | The room's title as the host set it. |
| `category` | string \| null | The room's category or game, in the platform's words (Twitch's game, Bilibili's area); null where the platform gives none. |
| `cover_url` | string \| null | Cover image. |
| `host` | AccountRef | The host's public account. |
| `started_at` | string \| null | When the current (or last) session started, ISO 8601 in UTC. |
| `rank` | integer \| null | Place on the board, from 1; null outside boards. |
| `metrics` | LiveMetrics | Room-level counts at fetch time; a count the platform does not show is null. |
| `ext` | object | Platform-specific extras. Only returned with view=full. |

## Request examples

### cURL

```bash
curl -G "https://api.okdata.online/v1/wechat_channels/live/rooms/get" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'id=1214317309080180172'
```

### Python

```python
import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/wechat_channels/live/rooms/get",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"id": "1214317309080180172"},
    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/wechat_channels/live/rooms/get');
url.searchParams.set('id', "1214317309080180172");

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": "wechat_channels.live.rooms.get",
    "id": "1214317309080180172"
  }
}
```

Or ask an agent that has the MCP server connected:

> Use WeChat Channels live room and tell me whether this live is still on, how many people have come in and how many likes it has.

## Response example

```json
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "id": "1214317309080180172",
      "url": null,
      "status": "live",
      "title": null,
      "category": null,
      "cover_url": "https://cdn.example.com/live/cover.jpg",
      "host": {
        "id": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder",
        "username": null,
        "name": "轻装徒步",
        "avatar_url": "https://cdn.example.com/avatar/trailkit.jpg",
        "followers": null,
        "verified": true
      },
      "started_at": "2026-11-19T01:12:00Z",
      "rank": null,
      "metrics": {
        "viewers": null,
        "total_viewers": 580640,
        "likes": 784911,
        "heat": null,
        "products": null
      }
    }
  },
  "warnings": [],
  "meta": {
    "capability": "wechat_channels.live.rooms.get",
    "billing": {
      "amount": "0.02",
      "currency": "USD",
      "balance_after": "9.98"
    },
    "unavailable": {},
    "cached": false,
    "replayed": false,
    "fetched_at": "2026-11-11T08:00:00Z"
  }
}
```

## Errors

Errors share one shape: code, request_id, message and message_zh (a fixed sentence per code), charged, retry, retry_after_seconds, param and docs_url, with the specifics in problems. An error from a call that reached the data source (not found, a failure or a timeout of the source) is charged once at this endpoint's price, with charged: true and amount; errors before that, such as bad parameters, are not charged; not_found here costs at least $0.02. Only settlement_unknown is unknown until looked up. The full table: https://okdata.online/docs/errors/

## Questions

### How much does the WeChat Channels live room API cost?

One call costs $0.02 and returns one live_room. 1,000 lookups cost $20.00. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.

### Do I need a WeChat Channels account, cookies or a QR login?

No. You send only your okdata API key. The data is public data from WeChat Channels; nothing is fetched with your own WeChat Channels account.

### Am I charged when a call fails?

Yes, once, when the call reached the data source: an empty answer, a not_found, a failure or a timeout of the source costs one call (one item for per-item endpoints), and the error says charged: true with amount. Calls refused before reaching a source, such as bad parameters or a low balance, cost nothing.

### What if WeChat Channels does not show a field?

The field is null, and meta.unavailable names it with the reason: platform (the platform never shows it) or capability (we cannot fetch it yet).

## More WeChat Channels endpoints

- [WeChat Channels video search](https://okdata.online/apis/wechat_channels/videos/search/): $0.02 per call · about 10 videos per page
- [WeChat Channels account search](https://okdata.online/apis/wechat_channels/users/search/): $0.02 per call · about 1 accounts per page
- [WeChat Channels account profile](https://okdata.online/apis/wechat_channels/users/get/): $0.02 per call
- [WeChat Channels account videos](https://okdata.online/apis/wechat_channels/users/videos/list/): $0.02 per call · about 15 videos per page
- [WeChat Channels video detail](https://okdata.online/apis/wechat_channels/videos/get/): $0.02 per call
- [WeChat Channels video comments](https://okdata.online/apis/wechat_channels/videos/comments/list/): $0.015 per call · about 25 comments per page
- [WeChat Channels comment replies](https://okdata.online/apis/wechat_channels/comments/replies/list/): $0.015 per call · about 20 comments per page
- [WeChat Channels live replays](https://okdata.online/apis/wechat_channels/users/live_replays/list/): $0.02 per call · about 48 posts per page
- [WeChat Channels video share link](https://okdata.online/apis/wechat_channels/videos/share_link/get/): $0.02 per call
- [WeChat Channels account collections](https://okdata.online/apis/wechat_channels/users/collections/list/): $0.02 per call · about 7 results per page
- [WeChat Channels collection videos](https://okdata.online/apis/wechat_channels/collections/videos/list/): $0.02 per call · about 20 videos per page
- [WeChat Channels video stats](https://okdata.online/apis/wechat_channels/videos/metrics/): $0.015 per call
- [WeChat Channels account profile (backup)](https://okdata.online/apis/wechat_channels/backup/users/get/): $0.03 per call
- [WeChat Channels account videos (backup)](https://okdata.online/apis/wechat_channels/backup/users/videos/list/): $0.06 per call · about 15 videos per page
- [WeChat Channels video search (backup)](https://okdata.online/apis/wechat_channels/backup/videos/search/): $0.15 per call · about 10 videos per page
- [WeChat Channels account live status](https://okdata.online/apis/wechat_channels/live/users/get/): $0.02 per call

## At a glance

- **Short name**: WeChat Channels live room
- **Also called**: wechat channels live detail, channels live likes
- **Category**: [Social media](https://okdata.online/categories/social/)
- **Status**: preview. It may still change; any change is announced beforehand.
- **Price**: $0.02 per call · bad parameters are free
- **Returns**: One LiveRoom, as data.item
- **If a call fails**: Charged once. When a data source fails, the next one is tried. A call that reached a source is charged once even if it fails; bad parameters are free.

## When it is charged

- Data comes back: $0.02 per call
- Bad parameters, too little balance, a paused endpoint: Free

| When | Charge |
|---|---|
| Most one call costs | $0.02 |
| An empty answer | $0.02 |
| Not found (the platform has no such item) | $0.02 |
| The data source fails or times out | $0.02 |
| Bad parameters, too little balance, a paused endpoint | Free |
| Resent with the same Idempotency-Key within 24 hours | Free when the kept result comes back |

A call that reached the data source costs $0.02 even when the answer is empty, not found or a failure of the source; a call stopped before that, such as for bad parameters, is free.

Prices from price book 53dd8ce13c359590. [Every price on this platform](https://okdata.online/pricing/wechat_channels/)

- New accounts get $0.10 of credit, no card needed: 5 calls to this endpoint.
- 1,000 lookups cost $20.00.

## Fields by view

The view column is the smallest `view` a field comes back in: `compact` returns only compact fields, `standard` adds the standard ones, `full` returns everything. The default is `standard`.

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

## Common errors on this endpoint

| HTTP | Code | Meaning | Charged | Retry |
|---|---|---|---|---|
| 400 | `invalid_params` | A parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first. | no | after a fix |
| 401 | `unauthorized` | The key is missing, malformed, revoked, disabled or expired (reason says which when known). | no | no |
| 402 | `insufficient_balance` | The balance (available) cannot cover the most this call could cost (required). | no | after a fix |
| 404 | `not_found` | The post, account or page does not exist or is not public. When the data source billed the lookup, or the endpoint's charge_when_not_found is above 0, this answer is charged: the body then says charged: true and amount. | once, if it reached a data source | no |
| 429 | `rate_limited` | The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency). | no | yes |
| 500 | `settlement_unknown` | The data came back, but the charge could not be confirmed. | unknown until looked up | with the same Idempotency-Key |
| 502 | `upstream_failed` | Every data source for this endpoint failed on this request. If a source billed the attempt, it is charged once at the endpoint's price (charged: true and amount); otherwise nothing is charged. | once, if it reached a data source | yes |
| 503 | `capability_paused` | This endpoint is paused right now; nothing ran. | no | yes |
| 504 | `timeout` | The data did not come back in time. If the request had reached a data source that bills it, it is charged once at the endpoint's price (charged: true and amount); otherwise the hold is released. | once, if it reached a data source | yes |

[All error codes](https://okdata.online/docs/errors/)

## Use it in your AI

> Read https://okdata.online/apis/wechat_channels/live/rooms/get.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use WeChat Channels live room and tell me whether this live is still on, how many people have come in and how many likes it has.
