> 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`.

# Reddit Post Comments

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

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

## Overview

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

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/reddit-comments/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.reddit.com/r/ChatGPT/comments/1epeshq/these_are_all_ai/" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/reddit-comments/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.reddit.com/r/ChatGPT/comments/1epeshq/these_are_all_ai/"},
    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.reddit.com/r/ChatGPT/comments/1epeshq/these_are_all_ai/` | Reddit post URL (or share link / redd.it / t3_<id>). Required on first call; ignored when `cursor` is supplied. 50 comments per page, native cursor. |
| `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. |
| `reply_limit` | integer | no | `1` | Direct replies kept per comment (0 = top-level only; max 500). Locked into the cursor. |
| `sort_order` | string | no | `hot` | Comment sort: hot, best, confidence, top, new, controversial, old, qa, random, live, all. Locked into the cursor. (random reshuffles every call - not page-stable.) |
| `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.reddit.com/r/ChatGPT/comments/1epeshq/these_are_all_ai/",
    "post_id": "t3_1epeshq",
    "post_title": "These are all AI",
    "num_comments": 3507,
    "sort_order": "hot",
    "reply_limit": 1,
    "page": 1,
    "page_size": 50,
    "comments": [
      {
        "comment_id": "lcv1234",
        "post_id": "t3_1epeshq",
        "author": "exampleuser",
        "permalink": "https://www.reddit.com/r/ChatGPT/comments/.../lcv1234/",
        "upvotes": 42,
        "content_type": "text",
        "parent_id": "1epeshq",
        "author_avatar": "",
        "userUrl": "https://www.reddit.com/user/exampleuser/",
        "contentText": "These look incredibly realistic.",
        "created_time": "",
        "replies": [],
        "scraped_at": "2026-12-01T12:00:00.000Z",
        "input_url": "https://www.reddit.com/r/ChatGPT/comments/1epeshq/these_are_all_ai/"
      }
    ],
    "next_cursor": "eyJoIjoiYWJjMTIzZGVmIiwiaSI6Imh0dHBzOi8vLi4uIiwicCI6MiwibGsiOnt9fQ"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.reddit.com/r/ChatGPT/comments/1ep…` |  |
| `post_id` | string | `t3_1epeshq` |  |
| `post_title` | string | `These are all AI` |  |
| `num_comments` | integer | `3507` |  |
| `sort_order` | string | `hot` |  |
| `reply_limit` | integer | `1` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `50` |  |
| `comments` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJoIjoiYWJjMTIzZGVmIiwiaSI6Imh0dHBzOi8vLi4uI…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `comments[].comment_id` | string | `lcv1234` |  |
| `comments[].post_id` | string | `t3_1epeshq` |  |
| `comments[].author` | string | `exampleuser` |  |
| `comments[].permalink` | string | `https://www.reddit.com/r/ChatGPT/comments/...…` |  |
| `comments[].upvotes` | integer | `42` |  |
| `comments[].content_type` | string | `text` |  |
| `comments[].parent_id` | string | `1epeshq` |  |
| `comments[].author_avatar` | string |  |  |
| `comments[].userUrl` | string | `https://www.reddit.com/user/exampleuser/` |  |
| `comments[].contentText` | string | `These look incredibly realistic.` |  |
| `comments[].created_time` | string |  |  |
| `comments[].replies` | array | `[]` |  |
| `comments[].scraped_at` | string | `2026-12-01T12:00:00.000Z` |  |
| `comments[].input_url` | string | `https://www.reddit.com/r/ChatGPT/comments/1ep…` |  |

## 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/reddit-comments/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "https://www.reddit.com/r/ChatGPT/comments/1epeshq/these_are_all_ai/"}
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

- This endpoint can take several minutes. Set your client timeout to at least 210 seconds.

## Related

- [Reddit Comment Replies](https://docs.scrapier.io/api-reference/reddit/reddit-comment-replies.md): Structured Reddit data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [Reddit Post Search](https://docs.scrapier.io/api-reference/reddit/reddit-post-search.md): Structured Reddit data: send `queries`. Cursor-paginated, 1 credit per successful call.
- [Reddit Post Transcript](https://docs.scrapier.io/api-reference/reddit/reddit-post-transcript.md): Structured Reddit data: send `urls`. Single lookup, 1 credit per successful call.
- [Reddit User Submitted Posts](https://docs.scrapier.io/api-reference/reddit/reddit-profile.md): Structured Reddit data: send `users`. Cursor-paginated, 1 credit per successful call.
