> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# YouTube Comments

Structured YouTube data: send `urls`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/youtube-comments-scraper/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/youtube-comments-scraper/` with `urls`. The results are in `data.comments`; send `data.next_cursor` back as `cursor` to get the next page. 4 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/youtube-comments-scraper/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.youtube.com/watch?v=uKv3mi2t2KE" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/youtube-comments-scraper/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.youtube.com/watch?v=uKv3mi2t2KE"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["comments"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `urls` | string | yes | e.g. `https://www.youtube.com/watch?v=uKv3mi2t2KE` | YouTube watch URL / youtu.be / bare 11-char id. Required on the first call. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `sort_by` | string | no | `top` | Comment sort order. Locked into the cursor. One of: `top`, `newest`. |
| `language` | string | no | `en` | innertube hl. Locked into the cursor. |
| `region` | string | no | `US` | innertube gl. Locked into the cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.comments`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "https://www.youtube.com/watch?v=uKv3mi2t2KE",
    "video_id": "uKv3mi2t2KE",
    "page": 1,
    "page_size": 20,
    "comments": [
      {
        "cid": "Ugx3cSNbOeJMcSWom1R4AaABAg",
        "type": "comment",
        "published_time_text": "7 months ago",
        "comment": "🚨 Watch our three part episode series on the Student Revolution that took Bangla",
        "author": "@thedeshbhakt",
        "author_channel_id": "UCmTM_hPCeckqN3cPWtYZZcg",
        "avatar": "https://yt3.ggpht.com/DfVqzaxetTmlyiL2oZHng3i9nKBEKJWWjQoPVUYf3U9Qq6rxDeCtaXjCUj9ARjqdluzwbv_r=s88-c-k-c0x00ffffff-no-rj",
        "author_is_channel_owner": true,
        "is_verified": true,
        "vote_count": 264,
        "has_creator_heart": true,
        "reply_count": 72,
        "reply_to_cid": null,
        "video_id": "uKv3mi2t2KE",
        "page_url": "https://www.youtube.com/watch?v=uKv3mi2t2KE",
        "title": "BNP Wins Big In Historic Elections | Options For India In Post-Hasina Bangladesh? | Akash Banerjee",
        "comments_count": 8300,
        "comment_id": "Ugx3cSNbOeJMcSWom1R4AaABAg",
        "like_count": 264,
        "input_url": "uKv3mi2t2KE",
        "scraped_at": "2026-09-14T08:58:22.312Z"
      }
    ],
    "next_cursor": "eyJ2IjoidUt2M21pMnQyS0UiLCJ0IjoiRWtNU0MuLi4iLCJwIjoxfQ"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.youtube.com/watch?v=uKv3mi2t2KE` |  |
| `video_id` | string | `uKv3mi2t2KE` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `20` |  |
| `comments` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJ2IjoidUt2M21pMnQyS0UiLCJ0IjoiRWtNU0MuLi4iL…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `comments[].cid` | string | `Ugx3cSNbOeJMcSWom1R4AaABAg` |  |
| `comments[].type` | string | `comment` |  |
| `comments[].published_time_text` | string | `7 months ago` |  |
| `comments[].comment` | string | `🚨 Watch our three part episode series on the…` |  |
| `comments[].author` | string | `@thedeshbhakt` |  |
| `comments[].author_channel_id` | string | `UCmTM_hPCeckqN3cPWtYZZcg` |  |
| `comments[].avatar` | string | `https://yt3.ggpht.com/DfVqzaxetTmlyiL2oZHng3i…` |  |
| `comments[].author_is_channel_owner` | boolean | `true` |  |
| `comments[].is_verified` | boolean | `true` |  |
| `comments[].vote_count` | integer | `264` |  |
| `comments[].has_creator_heart` | boolean | `true` |  |
| `comments[].reply_count` | integer | `72` |  |
| `comments[].reply_to_cid` | null | `null` |  |
| `comments[].video_id` | string | `uKv3mi2t2KE` |  |
| `comments[].page_url` | string | `https://www.youtube.com/watch?v=uKv3mi2t2KE` |  |
| `comments[].title` | string | `BNP Wins Big In Historic Elections \| Options …` |  |
| `comments[].comments_count` | integer | `8300` |  |
| `comments[].comment_id` | string | `Ugx3cSNbOeJMcSWom1R4AaABAg` |  |
| `comments[].like_count` | integer | `264` |  |
| `comments[].input_url` | string | `uKv3mi2t2KE` |  |
| `comments[].scraped_at` | string | `2026-09-14T08:58:22.312Z` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/youtube-comments-scraper/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "https://www.youtube.com/watch?v=uKv3mi2t2KE"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("comments") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Nothing special: send the inputs, read the result.

## Related

- [YouTube Channel Info](https://docs.scrapier.io/api-reference/youtube/youtube-channel-info.md): Structured YouTube data: send `urls`. Single lookup, 1 credit per successful call.
- [YouTube Channel Live/Streams](https://docs.scrapier.io/api-reference/youtube/youtube-channel-live.md): Structured YouTube data: send `channels`. Cursor-paginated, 1 credit per successful call.
- [YouTube Channel Video Scraper](https://docs.scrapier.io/api-reference/youtube/youtube-channel-video-scraper.md): Structured YouTube data: send `youtube_channels`. Cursor-paginated, 1 credit per successful call.
- [YouTube Comment Replies](https://docs.scrapier.io/api-reference/youtube/youtube-comment-replies.md): Structured YouTube data: send `continuation_tokens`. Cursor-paginated, 1 credit per successful call.
