YouTube API Capability

List comments

Fetch top or newest video comments, or replies using a returned replies continuation. Published times retain YouTube’s displayed relative text; rounded counts are marked approximate.

Capability ID youtube.comments.list

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 120 seconds

View raw

# List comments

Fetch top or newest video comments, or replies using a returned replies continuation. Published times retain YouTube’s displayed relative text; rounded counts are marked approximate.

- Platform: [YouTube](https://docs.upscrape.com/docs/platforms/youtube)
- Capability ID: `youtube.comments.list`
- Cost: 1 credit per request
- Maximum runtime: 120 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "limit": 5,
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  },
  "capability": "youtube.comments.list"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum number of results to return. From 1 to 500. Default: `100`. |
| `max_pages` | `integer` | No | Maximum number of result pages to fetch. From 1 to 100. Default: `5`. |
| `parent_comment_id` | `string` | No | Comment ID whose replies_continuation is being fetched. |
| `replies_continuation` | `string` | No | The replies_continuation from a returned comment. Supply its parent_comment_id and the same video URL. |
| `sort` | `string` | No | Top comments or newest first. Applies to top-level comments. Allowed values: `top`, `newest`. Default: `top`. |
| `url` | `string` | Yes | Public URL of the page to fetch. |

### Example input

```json
{
  "limit": 5,
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
```

## Response

Successful output is returned in `results[0].data`.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

No example output is available for this capability.


## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

limit integer optional

Maximum number of results to return. From 1 to 500. Default: `100`.

Example 5

max_pages integer optional

Maximum number of result pages to fetch. From 1 to 100. Default: `5`.

parent_comment_id string optional

Comment ID whose replies_continuation is being fetched.

replies_continuation string optional

The replies_continuation from a returned comment. Supply its parent_comment_id and the same video URL.

sort string optional

Top comments or newest first. Applies to top-level comments. Allowed values: `top`, `newest`. Default: `top`.

Available values topnewest

url string required

Public URL of the page to fetch.

Example https://www.youtube.com/watch?v=dQw4w9WgXcQ

Response

Successful output is returned in results[0].data.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

No example output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "limit": 5, "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "capability": "youtube.comments.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "limit": 5, "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "capability": "youtube.comments.list" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))