# YouTube Video Comments (`youtube.video_comments`)

Top-level comments on a YouTube video or Short (text, author, likes, reply count, publish time), top or newest first, with cursor pagination.

Docs: https://primaryapi.com/docs/api-reference/youtube/video_comments

- Endpoint: `POST https://api.primaryapi.com/v1/run/youtube.video_comments`
- Category: Social · Platform: `youtube` · Kind: list · Status: live
- Price: 2 credits per call; up to 38 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=youtube.video_comments`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | yes |  | max 2048 chars | YouTube video or Short URL (watch, youtu.be, shorts, live or embed link). |
| `order` | enum | no | "top" | one of: top, newest | Comment order: top (default) or newest first. |
| `limit` | integer | no | 20 | 1–50 | Maximum number of results to return (1-50, default 20). |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `comments` | object[] |  |
| `comments[].id` | string \| null | Comment ID (null when the source does not expose one) |
| `comments[].text` | string \| null |  |
| `comments[].author` | string \| null | Author display name, usually the @handle |
| `comments[].authorId` | string \| null | Author's channel ID (UC…) |
| `comments[].authorUrl` | string \| null |  |
| `comments[].authorAvatarUrl` | string \| null |  |
| `comments[].likes` | integer \| null |  |
| `comments[].replies` | integer \| null |  |
| `comments[].publishedTime` | string \| null | Publish time, ISO 8601 (best effort: sources derive it from the relative label) |
| `comments[].publishedTimeText` | string \| null | Relative label as YouTube shows it, e.g. "9 days ago" |
| `comments[].repliesCursor` | string \| null | Vendor continuation token for this comment's replies (input of youtube.comment_replies) |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/youtube.video_comments" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=5EWaxmWgQMI"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "comments": [
        {
          "id": "UgwVfRopfS2F-WB3aF14AaABAg",
          "text": "I love how in the middle he said \"I've been able to work with 2 great coaches... Pete and Coach Tomlin\"... Side shade to Coach Sean Payton, love it :)",
          "author": "@SimonT80",
          "authorId": "UC8JC3uSUmmXTCTKl-bgr1DA",
          "authorUrl": "https://youtube.com/@SimonT80",
          "authorAvatarUrl": "https://yt3.ggpht.com/ytc/AIdro_lQ_2v9lDqwRrmdvEBfDNyFOvgQICl68X6WFkwZ5KI=s88-c-k-c0x00ffffff-no-rj",
          "likes": 110,
          "replies": 5,
          "publishedTime": "2025-01-23T23:14:02.948Z",
          "publishedTimeText": "9 days ago",
          "repliesCursor": "Eg0SC2RRdzR3OVdnWGNRGAYy1AEK..."
        }
      ],
      "nextCursor": "eyJsIjoieW91dHViZS52aWRlb19jb21tZW50cyNzY3JhcGVjcmVhdG9ycyIsInQiOiJFZzBTQ3pWRlYyRjRiVmQuLi4uIn0"
    }
  },
  "provider": "PrimaryAPI",
  "credits": 2,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 2 credits per call
- Price ceiling: up to 38 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=youtube.video_comments`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

