> 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 Search

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

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

## Overview

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

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/reddit-post-search/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=programming" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/reddit-post-search/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "programming"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

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

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. |
| `queries` | string | yes | e.g. `programming` | Search term. Required on first call; ignored when `cursor` is supplied. |
| `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 | `comments` | Sort: relevance, hot, top, new, comments. Locked into the cursor. One of: `comments`, `hot`, `top`, `new`, `relevance`. |
| `time_filter` | string | no | `year` | Time window: hour, day, week, month, year, all. Locked into the cursor. One of: `hour`, `day`, `week`, `month`, `year`, `all`. |
| `subreddit` | string | no | — | Optional: restrict the search to one subreddit (name, r/Name or URL). Locked into the cursor. |
| `page_size` | integer | no | `25` | Posts per page (1-100). 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.posts`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "queries": "programming",
    "sort_by": "comments",
    "time_filter": "year",
    "subreddit": null,
    "page": 1,
    "page_size": 25,
    "posts": [
      {
        "post_id": "1olrcxd",
        "subreddit": "programming",
        "author_id": "t2_xxx",
        "created_time": "2026-11-20T10:00:00Z",
        "title": "Best practices for async Python",
        "type": "text",
        "url": "https://old.reddit.com/r/programming/comments/1olrcxd/...",
        "score": 842,
        "comments": 137,
        "nsfw": false,
        "spoiler": false,
        "archived": false,
        "media_type": "text",
        "votes": 842,
        "subreddit_icon": ""
      }
    ],
    "has_more": true,
    "next_cursor": "eyJoIjoiYWJjMTIzZGVmIiwiaSI6InByb2dyYW1taW5nIiwicCI6MiwibGsiOnt9fQ"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `queries` | string | `programming` |  |
| `sort_by` | string | `comments` |  |
| `time_filter` | string | `year` |  |
| `subreddit` | null | `null` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `25` |  |
| `posts` | array | `[1 item]` | The results. |
| `has_more` | boolean | `true` |  |
| `next_cursor` | string | `eyJoIjoiYWJjMTIzZGVmIiwiaSI6InByb2dyYW1taW5nI…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `posts[].post_id` | string | `1olrcxd` |  |
| `posts[].subreddit` | string | `programming` |  |
| `posts[].author_id` | string | `t2_xxx` |  |
| `posts[].created_time` | string | `2026-11-20T10:00:00Z` |  |
| `posts[].title` | string | `Best practices for async Python` |  |
| `posts[].type` | string | `text` |  |
| `posts[].url` | string | `https://old.reddit.com/r/programming/comments…` |  |
| `posts[].score` | integer | `842` |  |
| `posts[].comments` | integer | `137` |  |
| `posts[].nsfw` | boolean | `false` |  |
| `posts[].spoiler` | boolean | `false` |  |
| `posts[].archived` | boolean | `false` |  |
| `posts[].media_type` | string | `text` |  |
| `posts[].votes` | integer | `842` |  |
| `posts[].subreddit_icon` | string |  |  |

## 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-post-search/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "programming"}
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("posts") 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

- [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 Comments](https://docs.scrapier.io/api-reference/reddit/reddit-comments.md): Structured Reddit data: send `urls`. 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.
