Get Subreddit Details

GET /v1/reddit/subreddit/about

1 credit per request Permission: reddit:read

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

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Query parameters

sub: required string

Subreddit name, with or without r/.

Returns

200

Subreddit metadata and rules.

JSON

name: optional string
title: optional string
public_description: optional string
description: optional string
subscribers: optional integer
created_at: optional string

format: date-time
over_18: optional boolean
type: optional string
url: optional string
icon: optional string
rules: optional array ofobject
- kind: optional string
- short_name: optional string
- description: optional string
- violation_reason: optional string
- priority: optional integer
- created_at: optional string
  
  format: date-time

400

Bad request (invalid parameter or unknown action)

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

401

Missing or invalid API key or OAuth access token

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

402

The account has no credits left (insufficient_credits).

JSON

error: required object
- code: required string
- message: required string
- retryable: required boolean
- retry_after: optional integer
  
  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).

JSON

error: required object
- code: required string
- message: required string
- retryable: required boolean
- retry_after: optional integer
  
  Seconds to wait before retrying.

404

Requested user or resource not found

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

429

Rate limit or daily request quota exceeded

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

503

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

JSON

error: required object
- code: required string
- message: required string
- retryable: required boolean
- retry_after: optional integer
  
  Seconds to wait before retrying.

Get Subreddit Details

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

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));

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)

Response example

{
  "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"
    }
  ]
}

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

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

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

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

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

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

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