Reddit API Capability

Get Subreddit

Fetch public community metadata, including Reddit's anonymous weekly-visitor estimate when available.

Capability ID reddit.subreddit.get

Cost 1 credit per request

Maximum runtime 30 seconds

# Get Subreddit

Fetch public community metadata, including Reddit's anonymous weekly-visitor estimate when available.

- Platform: [Reddit](https://docs.upscrape.com/docs/platforms/reddit)
- Capability ID: `reddit.subreddit.get`
- 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 --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "name": "webdev"
  },
  "capability": "reddit.subreddit.get"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | Subreddit name, optionally prefixed with r/ (case-insensitive). |

### Example input

```json
{
  "name": "webdev"
}
```

## Response

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

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "active_users": null,
  "created_utc": null,
  "description": "A community dedicated to all things web development: both front-end and back-end. For more design-related questions, try /r/web_design.",
  "icon_url": "https://styles.redditmedia.com/t5_2qs0q/styles/communityIcon_kxcmzy9bt1381.jpg?width=64&frame=1&auto=webp&s=[redacted:token]",
  "name": "webdev",
  "nsfw": false,
  "subscribers": null,
  "title": null,
  "url": "https://www.reddit.com/r/webdev/",
  "weekly_visitors": 459900
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `active_users` | `null` | null |
| `created_utc` | `null` | null |
| `description` | `string` | A community dedicated to all things web development: both front-end and… |
| `icon_url` | `string` | https://styles.redditmedia.com/t5_2qs0q/styles/communityIcon_kxcmzy9bt1… |
| `name` | `string` | webdev |
| `nsfw` | `boolean` | false |
| `subscribers` | `null` | null |
| `title` | `null` | null |
| `url` | `string` | https://www.reddit.com/r/webdev/ |
| `weekly_visitors` | `integer` | 459900 |

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

name string required

Subreddit name, optionally prefixed with r/ (case-insensitive).

Example webdev

Response

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

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`active_users`	`null`	null
`created_utc`	`null`	null
`description`	`string`	A community dedicated to all things web development: both front-end and…
`icon_url`	`string`	https://styles.redditmedia.com/t5_2qs0q/styles/communityIcon_kxcmzy9bt1…
`name`	`string`	webdev
`nsfw`	`boolean`	false
`subscribers`	`null`	null
`title`	`null`	null
`url`	`string`	https://www.reddit.com/r/webdev/
`weekly_visitors`	`integer`	459900

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 YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "name": "webdev" }, "capability": "reddit.subreddit.get" }'

import json import requests payload = json.loads(r'''{ "input": { "name": "webdev" }, "capability": "reddit.subreddit.get" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "active_users": null, "created_utc": null, "description": "A community dedicated to all things web development: both front-end and back-end. For more design-related questions, try /r/web_design.", "icon_url": "https://styles.redditmedia.com/t5_2qs0q/styles/communityIcon_kxcmzy9bt1381.jpg?width=64&frame=1&auto=webp&s=[redacted:token]", "name": "webdev", "nsfw": false, "subscribers": null, "title": null, "url": "https://www.reddit.com/r/webdev/", "weekly_visitors": 459900 }