# youtube.video_comments

**beta** **2 credits** **may need a pack**

Top-level comments on a YouTube video (page of a continuation cursor).

`GET /v1/youtube/video_comments`

> [!NOTE] **Beta.** This endpoint has not yet been verified against the live source, so fields may be missing or differ until it becomes stable. Failed calls are refunded.

> [!NOTE] **May need a pack.** Free credits use only the open fetch path; the fallback path behind it needs a purchased pack and a verified email. See [pricing](https://onekey.dev/pricing).

## What you get

A list of YouTube results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

**Also known as:** `/youtube/video/comments` on APIs that nest their paths. See [Alternatives and equivalents](https://onekey.dev/docs/alternatives.md).

## What it costs

- **2 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `cursor` | string | yes | (required) | Comments cursor from youtube.video_next (cursor.comments) or a previous page | max 255 chars; must match `[A-Za-z0-9_\-=%.~+/]{1,255}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/youtube/video_comments?cursor=Eg0SC2RRdzR3OVdnWGNRGAYyJSIRIgtkUXc0dzlXZ1hjUTAAeAJCEGNvbW1lbnRzLXNlY3Rpb24%253D" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/youtube/video_comments",
    params={"cursor": "Eg0SC2RRdzR3OVdnWGNRGAYyJSIRIgtkUXc0dzlXZ1hjUTAAeAJCEGNvbW1lbnRzLXNlY3Rpb24%3D"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ cursor: "Eg0SC2RRdzR3OVdnWGNRGAYyJSIRIgtkUXc0dzlXZ1hjUTAAeAJCEGNvbW1lbnRzLXNlY3Rpb24%3D" });
const res = await fetch(`https://api.onekey.dev/v1/youtube/video_comments?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real YouTube response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "Ugzge340dBgB75hWBm54AaABAg",
        "text": "can confirm: he never gave us up"
      },
      "ext": {
        "publishedText": "1 year ago",
        "likesText": "321K"
      },
      "author": {
        "id": "UCBR8-60-B28hp2BmDPdntcQ",
        "displayName": "@YouTube",
        "avatarUrl": "https://yt3.ggpht.com/3s6evpqAiDU9tQR4sC2siJippbH2RWVPnwHgyl4V0th2iuQz0VDQZbUhQBGmsxLYo-mjG6TqZQ=s88-c-k-c0x00ffffff-no-rj",
        "verified": true
      },
      "engagement": {
        "comments": 963
      }
    },
    {
      "content": {
        "id": "UgxIOV-sXAchpKX94cB4AaABAg",
        "text": "1987 : normal song \r\n2026 : national anthem of the universe"
      },
      "ext": {
        "publishedText": "6 years ago (edited)",
        "likesText": "138K"
      },
      "author": {
        "id": "UCtbyFPryy7J4DR4xh5CRCvA",
        "displayName": "@ochkalov",
        "avatarUrl": "https://yt3.ggpht.com/mnit-bn8T-v7Z3XoOg71uoXPsN0sErvP-fCJzUboX6CfdJTnQjssN1QATams-lV9zMyZoqwI1Q=s88-c-k-c0x00ffffff-no-rj",
        "verified": false
      },
      "engagement": {
        "comments": 933
      }
    }
  ],
  "metadata": {
    "platform": "youtube",
    "endpoint": "video_comments",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `payload.commentEntityPayload.properties.commentId` | `content.id` | - |
| `payload.commentEntityPayload.properties.content.content` | `content.text` | - |
| `payload.commentEntityPayload.properties.publishedTime` | `ext.publishedText` | - |
| `payload.commentEntityPayload.author.channelId` | `author.id` | - |
| `payload.commentEntityPayload.author.displayName` | `author.displayName` | - |
| `payload.commentEntityPayload.author.avatarThumbnailUrl` | `author.avatarUrl` | `safeUrl` |
| `payload.commentEntityPayload.author.isVerified` | `author.verified` | `toBoolean` |
| `payload.commentEntityPayload.toolbar.likeCountNotliked` | `ext.likesText` | - |
| `payload.commentEntityPayload.toolbar.replyCount` | `engagement.comments` | `toNumber` |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: beta (not yet verified against the live source).