---
title: "Get Subreddit Details"
description: "Retrieves subreddit metadata, community settings, subscriber stats, and moderation rules.\n"
---

> Documentation Index
> Fetch the complete documentation index at: https://staging.threadapi.dev/llms.txt
> Use this file to discover all available pages before exploring further.

Path: ThreadAPI API › Reddit

`GET /v1/reddit/subreddit/about`

Retrieves subreddit metadata, community settings, subscriber stats, and moderation rules.

## Authentication

Requires one of the following:

- `bearerAuth`, http, header `Authorization`
- `apiKeyAuth`, apiKey, in header, header `x-api-key`

## Query parameters

- `sub` (`getSubredditAbout.query.sub`; string, required) — Subreddit name, with or without `r/`.

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.threadapi.dev/v1/reddit/subreddit/about?sub=golang' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.threadapi.dev/v1/reddit/subreddit/about?sub=golang';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.threadapi.dev/v1/reddit/subreddit/about?sub=golang"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Subreddit metadata and rules.

#### Example

```json
{
  "name": "string",
  "title": "string",
  "public_description": "string",
  "description": "string",
  "subscribers": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "over_18": true,
  "type": "string",
  "url": "string",
  "icon": "string",
  "rules": [
    {
      "kind": "string",
      "short_name": "string",
      "description": "string",
      "violation_reason": "string",
      "priority": 0,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
```

- `name` (`getSubredditAbout.response.200.name`; string, optional)
- `title` (`getSubredditAbout.response.200.title`; string, optional)
- `public_description` (`getSubredditAbout.response.200.public_description`; string, optional)
- `description` (`getSubredditAbout.response.200.description`; string, optional)
- `subscribers` (`getSubredditAbout.response.200.subscribers`; integer, optional)
- `created_at` (`getSubredditAbout.response.200.created_at`; string, optional)
  - format `date-time`
- `over_18` (`getSubredditAbout.response.200.over_18`; boolean, optional)
- `type` (`getSubredditAbout.response.200.type`; string, optional)
- `url` (`getSubredditAbout.response.200.url`; string, optional)
- `icon` (`getSubredditAbout.response.200.icon`; string, optional)
- `rules` (`getSubredditAbout.response.200.rules`; array<object>, optional)
  - `kind` (`getSubredditAbout.response.200.rules.kind`; string, optional)
  - `short_name` (`getSubredditAbout.response.200.rules.short_name`; string, optional)
  - `description` (`getSubredditAbout.response.200.rules.description`; string, optional)
  - `violation_reason` (`getSubredditAbout.response.200.rules.violation_reason`; string, optional)
  - `priority` (`getSubredditAbout.response.200.rules.priority`; integer, optional)
  - `created_at` (`getSubredditAbout.response.200.rules.created_at`; string, optional)
    - format `date-time`

### 400

Bad request (invalid parameter or unknown action)

#### Example

```json
{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}
```

One of:

- `ErrorResponse`
- `Error`

### 401

Missing or invalid API key or OAuth access token

#### Example

```json
{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}
```

One of:

- `ErrorResponse`
- `Error`

### 402

The account has no credits left (`insufficient_credits`).

#### Example

```json
{
  "error": {
    "code": "not_found",
    "message": "string",
    "retryable": true,
    "retry_after": 0
  }
}
```

- `error` (`getSubredditAbout.response.402.error`; object, required)
  - `code` (`getSubredditAbout.response.402.error.code`; string, required)
    - example `"not_found"`
  - `message` (`getSubredditAbout.response.402.error.message`; string, required)
  - `retryable` (`getSubredditAbout.response.402.error.retryable`; boolean, required)
  - `retry_after` (`getSubredditAbout.response.402.error.retry_after`; integer, optional) — Seconds to wait before retrying.

### 403

Reddit does not show this content to logged-out readers, e.g. a private or quarantined subreddit (`reddit_refused`).

#### Example

```json
{
  "error": {
    "code": "not_found",
    "message": "string",
    "retryable": true,
    "retry_after": 0
  }
}
```

- `error` (`getSubredditAbout.response.403.error`; object, required)
  - `code` (`getSubredditAbout.response.403.error.code`; string, required)
    - example `"not_found"`
  - `message` (`getSubredditAbout.response.403.error.message`; string, required)
  - `retryable` (`getSubredditAbout.response.403.error.retryable`; boolean, required)
  - `retry_after` (`getSubredditAbout.response.403.error.retry_after`; integer, optional) — Seconds to wait before retrying.

### 404

Requested user or resource not found

#### Example

```json
{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}
```

One of:

- `ErrorResponse`
- `Error`

### 429

Rate limit or daily request quota exceeded

#### Example

```json
{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}
```

One of:

- `ErrorResponse`
- `Error`

### 503

A temporary problem reaching Reddit (`upstream_busy`, `upstream_timeout`, `upstream_error`). Retry shortly; nothing was billed.

#### Example

```json
{
  "error": {
    "code": "not_found",
    "message": "string",
    "retryable": true,
    "retry_after": 0
  }
}
```

- `error` (`getSubredditAbout.response.503.error`; object, required)
  - `code` (`getSubredditAbout.response.503.error.code`; string, required)
    - example `"not_found"`
  - `message` (`getSubredditAbout.response.503.error.message`; string, required)
  - `retryable` (`getSubredditAbout.response.503.error.retryable`; boolean, required)
  - `retry_after` (`getSubredditAbout.response.503.error.retry_after`; integer, optional) — Seconds to wait before retrying.


Source: https://staging.threadapi.dev/api/Reddit/getSubredditAbout/index.md