Skip to content
Scrappa Get API key
Reddit API 1 credit/request

Reddit Subreddit API Documentation

GET https://scrappa.co/api/reddit/subreddit

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

Reddit Subreddit API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/reddit/subreddit
Auth header
x-api-key
Cost
1 credit/request
subreddit = example
Response preview
200 OK
{
    "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",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

subreddit string Required

Subreddit name without r/, 2 to 21 characters. Example: programming.

Example value example
rules boolean Optional

false to skip the rules (default true). Example: true.

Example value true

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

{
    "errors": {
        "subreddit": [
            "The subreddit field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The subreddit, post or user does not exist, is private or is banned. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "subreddit"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
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.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "subreddit"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Reddit could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.