List Subreddits

GET /v1/reddit/subreddits

1 credit per page Permission: reddit:read

Lists popular or newly created subreddits across Reddit.

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Query parameters

sort: optional popular|new

Subreddit listing sort.

default: "popular"
limit: optional integer

Number of items per page.

range: 1–100 · default: 25
after: optional string

Pagination cursor from the previous page's after field.
nsfw: optional boolean

Include NSFW content (filtered out by default).

default: false

Returns

200

Subreddit listing.

JSON

sort: required string
count: required integer
items: required array ofobject
- 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
filtered_nsfw: required integer
query: optional string | null
after: optional string | null
degraded: optional boolean

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.

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.

List Subreddits

curl --request GET \
  --url https://api.threadapi.dev/v1/reddit/subreddits \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.threadapi.dev/v1/reddit/subreddits';
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));

Response example

{
  "query": "string",
  "sort": "string",
  "count": 0,
  "items": [
    {
      "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"
        }
      ]
    }
  ],
  "after": "string",
  "filtered_nsfw": 0,
  "degraded": true
}

{
  "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": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}

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