Reddit API Capability

Search Subreddits

Search communities by name or topic (typeahead-friendly), ordered by relevance, with subscribers and description.

Capability ID reddit.subreddit.search

Cost 1 credit per request

Maximum runtime 30 seconds

# Search Subreddits

Search communities by name or topic (typeahead-friendly), ordered by relevance, with subscribers and description.

- Platform: [Reddit](https://docs.upscrape.com/docs/platforms/reddit)
- Capability ID: `reddit.subreddit.search`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

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

```bash
curl -X POST https://data.upscrape.com/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"limit":10,"q":"web development"},"capability":"reddit.subreddit.search"}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Result count, 1-25 (default 10). |
| `q` | `string` | Yes | Name or topic; works for short prefixes (typeahead). |

### Example input

```json
{
  "limit": 10,
  "q": "web development"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample 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.

See [jobs and results](https://docs.upscrape.com/docs/api/jobs), [errors and retries](https://docs.upscrape.com/docs/api/errors), and [idempotency](https://docs.upscrape.com/docs/api/idempotency).

## Machine-readable contract

- [Capability OpenAPI 3.1](https://docs.upscrape.com/docs/platforms/reddit/reddit.subreddit.search/openapi.json)
- [Platform OpenAPI 3.1](https://upscrape.com/scrapers/reddit/openapi.json)
- [Focused coding-agent prompt](https://upscrape.com/scrapers/reddit/capabilities/reddit.subreddit.search/llm.md)

POST /execute Shared execution endpoint

Input parameters

Field	Type	Required	Description
`limit`	`integer`	Optional	Result count, 1-25 (default 10).
`q`	`string`	Required	Name or topic; works for short prefixes (typeahead).

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample 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.

Resources

OpenAPI 3.1 Markdown Platform OpenAPI

curl -X POST https://data.upscrape.com/execute \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"input":{"limit":10,"q":"web development"},"capability":"reddit.subreddit.search"}'

const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"input":{"limit":10,"q":"web development"},"capability":"reddit.subreddit.search"}), }); console.log(await response.json());

import requests response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, json={"input":{"limit":10,"q":"web development"},"capability":"reddit.subreddit.search"}, ) print(response.json())