# Subreddit about



<MethodPage method="GET" path="/v1/reddit/subreddit/about" credits={1}>
  <MethodSignature name="getSubreddit" args={[{ name: "sub" }]} returns="Subreddit" />

  Returns what a subreddit is about, how many subscribers it has, and its rules. Useful before posting in or analysing a community you don't know. 1 credit per call; details are cached for an hour.

  <Security permission="reddit:read" />

  <SchemaGroup title="Query parameters">
    <SchemaField name="sub" type="string" location="query" required>
      Subreddit name, with or without `r/`.
    </SchemaField>
  </SchemaGroup>

  <div id="returns" className="mt-8">
    Response [#response]

    ```jsonc
    {
      "name": "golang",
      "title": "The Go Programming Language",
      "public_description": "Ask questions and post articles about the Go programming language and related tools, events etc.",
      "description": "# Rules\n\n## 1. Be friendly and welcoming.\n\n…",
      "subscribers": 380079,
      "created_at": "2009-11-11T00:54:28Z",
      "over_18": false,
      "type": "public",
      "url": "/r/golang/",
      "icon": "https://styles.redditmedia.com/t5_2rc7j/styles/communityIcon_wy4riduoe9k11.png?width=256&s=0d681daaa8d4b6271e6be788d0f9379f0661e04a",
      "rules": [
        {
          "kind": "all",
          "short_name": "Be friendly and welcoming.",
          "description": "Post is not in keeping with an inclusive and friendly technical atmosphere.",
          "violation_reason": "unfriendly or abrasive",
          "priority": 0,
          "created_at": "2022-05-19T18:59:55Z"
        }
        // …11 more
      ]
    }
    ```

    `public_description` is the one-line summary; `description` is the sidebar, in Markdown. `type` is Reddit's subreddit type, such as `public`, `restricted` or `private`. A rule's `kind` says what it applies to: `link` (posts), `comment` or `all`. `priority` is the rule's position in the list, from 0.
  </div>

  <MethodSamples>
    <LanguageSample language="cURL">
      ```bash
      curl "https://api.threadapi.dev/v1/reddit/subreddit/about?sub=golang" \
        -H "Authorization: Bearer $THREADAPI_API_KEY"
      ```
    </LanguageSample>
  </MethodSamples>
</MethodPage>