# Reddit Subreddit API Documentation

<p><strong>Reddit Subreddit API</strong> returns one subreddit with title, public description, sidebar description, subscribers, creation date, type, language, icon, banner, colours and which post types it allows. <code>rules</code> lists the community rules. Reddit does not tell anonymous readers how many users are online, so <code>active_users</code> is left out. Set <code>rules=false</code> to skip the rules. The request then needs one lookup instead of two.</p>

- **Documentation:** [https://scrappa.co/docs/reddit-api/reddit_subreddit_about](https://scrappa.co/docs/reddit-api/reddit_subreddit_about)
- **API group:** Reddit API
- **Endpoint:** `GET https://scrappa.co/api/reddit/subreddit`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `subreddit` | string | Yes | Subreddit name without r/, 2 to 21 characters. Example: programming. |
| `rules` | boolean | No | false to skip the rules (default true). Example: true. |

## Example response

```json
{
    "data": {
        "rules": [
            {
                "name": "No LLM-Written Content",
                "priority": 0,
                "applies_to": "all",
                "created_at": "2026-03-02T21:12:41+00:00",
                "description": "If you don't want to write it, we don't want to read it. This includes the use of LLMs for translation or summarisation. Moderators reser...",
                "violation_reason": "This is clearly LLM-written."
            }
        ],
        "subreddit": {
            "id": "2fwo",
            "url": "https://www.reddit.com/r/programming/",
            "name": "programming",
            "type": "public",
            "title": "programming",
            "over_18": false,
            "fullname": "t5_2fwo",
            "icon_url": "https://styles.redditmedia.com/t5_2fwo/styles/communityIcon_1bqa1ibfp8q11.png?width=256&s=45361614cdf4a306d5510b414d18c02603c7dd3c",
            "language": "en",
            "key_color": null,
            "banner_url": null,
            "created_at": "2006-02-28T18:19:29+00:00",
            "quarantine": false,
            "created_utc": 1141150769,
            "description": "/r/programming is a reddit for discussion and news about [computer programming](http://en.wikipedia.org/wiki/Computer_programming).\n\n****...",
            "subscribers": 6930652,
            "allows_polls": false,
            "wiki_enabled": true,
            "allows_images": false,
            "allows_videos": false,
            "primary_color": "#002b36",
            "submission_type": "link",
            "allows_galleries": false,
            "spoilers_enabled": true,
            "public_description": "Computer Programming"
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "subreddit"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 404 | Not Found | The subreddit, post or user does not exist, is private or is banned. This response is not billable. |
| 503 | Upstream Unavailable | Reddit could not be reached or returned data that does not match the request. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)