REDDIT API

Subreddit Details

Retrieve subreddit details from Reddit with a single API request.

GET/api/data/v1/reddit/subreddit/details
1credit base costZero-credit cache supported

Request parameters

Up to 1 credit

Subreddit name. MUST be case sensitive. So 'AskReddit' not 'askreddit'.

Subreddit URL

If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.]

Try in the console

Live requests use your prepaid balance. Cached responses cost zero where supported.

curl --request GET \
  --url 'https://fetchgoblin.com/api/data/v1/reddit/subreddit/details?url=https%3A%2F%2Fwww.reddit.com%2Fr%2FAbsoluteUnits%2F' \
  --header 'x-api-key: YOUR_FETCHGOBLIN_API_KEY'

Response

Example
{
  "success": true,
  "subreddit_id": "t5_a7wuv",
  "display_name": "AbsoluteUnits",
  "weekly_active_users": 1428398,
  "weekly_contributions": 8923,
  "rules": "#ABSOLUTE UNITS\n\n---\n\n    Be in awe at the size of these lads\n\n---\n\n###[Check out our deep, well-reflected definitions of an absolute unit.](https://www.reddit.com/r/AbsoluteUnits/wiki/index)  ",
  "description": "Absolute Unit : an Animal or Public Figure, who is larger than we should normally expect.",
  "header_img": null,
  "icon_img": "https://styles.redditmedia.com/t5_a7wuv/styles/communityIcon_t3cspt08bl681.png?width=128&frame=1&auto=webp&s=6f7e59ccf1724bd6c8b3e0d2840c9b21297102c3",
  "subscribers": 1923642,
  "advertiser_category": "",
  "created_at": "2018-01-05T10:35:24.000Z",
  "submit_text": "",
  "credits_charged": 1,
  "credits_remaining": 1000,
  "request_id": "00000000-0000-4000-8000-000000000000"
}
Example data from the API specification. Run a request to retrieve current data.

Response shape

This schema describes the documented data shape. Some platform fields may be absent or null. The response also includes your FetchGoblin request ID and current credit balance.

View JSON Schema +
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "subreddit_id": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "weekly_active_users": {
      "type": "integer"
    },
    "weekly_contributions": {
      "type": "integer"
    },
    "rules": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "header_img": {
      "type": [
        "string",
        "object",
        "array",
        "number",
        "boolean",
        "null"
      ]
    },
    "icon_img": {
      "type": "string"
    },
    "subscribers": {
      "type": "integer"
    },
    "advertiser_category": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "submit_text": {
      "type": "string"
    },
    "credits_charged": {
      "type": "integer",
      "minimum": 0,
      "description": "FetchGoblin credits charged for this request."
    },
    "credits_remaining": {
      "type": "integer",
      "description": "Your FetchGoblin credit balance after this request."
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "description": "FetchGoblin request identifier."
    }
  }
}