Subreddit details

Try in Playground

Read Reddit community metadata, rules, images, dates and weekly metrics, with null values and explicit coverage.

GET/v1/reddit/subreddit/detailsx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

subredditstringquery

Optional.

ExampleExample

urlstringquery

Optional.

max 2048 chars · absolute HTTPS URL

cache_max_ageenumquery

Optional compatibility value: 1d, 3d, 7d, 14d or 30d.

one of: 1d, 3d, 7d, 14d, 30d

Response fields

requestIdstring

Always included.

Inspect complete and reasons on every response. Source failures never masquerade as empty success.

coverage.completeboolean

Always included.

coverage.reasonsstring[]

Always included.

accounting.httpRequestsinteger

Always included.

≥ 0

accounting.proxyBytesnumber

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

accounting.pageLoadsinteger

Always included.

≥ 0

accounting.challengeCountinteger

Always included.

≥ 0

accounting.rssRequestsinteger

Always included.

≥ 0

accounting.proxySessionIdstring

Always included.

successboolean

Always included.

statusenum

success, partial, challenged or failed. error contains a sanitized machine-readable reason on failure.

one of: success, partial

subreddit_idstringnullable

Always included.

display_namestring

Always included.

weekly_active_usersnumbernullable

Always included.

weekly_contributionsnumbernullable

Always included.

rulesstringnullable

Always included.

descriptionstringnullable

Always included.

header_imgstringnullable

Always included.

icon_imgstringnullable

Always included.

subscribersnumbernullable

Always included.

advertiser_categorystringnullable

Always included.

created_atstringnullable

Always included.

submit_textstringnullable

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	The request failed validation.
401	`invalid_request`	The internal service secret is invalid.
503	`upstream_error` `breaker_open`	Proxy unavailable or thread retrieval temporarily paused.
502	`upstream_error`	Retrieval failed.
504	`timeout`	The deadline expired; available results are retained.
200	`partial` `challenged`	Inspect status and failure even when HTTP succeeds.

Code example

curl "https://api.scrapeatlas.com/v1/reddit/subreddit/details?subreddit=Example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/reddit/subreddit/details?subreddit=Example",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/reddit/subreddit/details?subreddit=Example",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Reddit request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/reddit/subreddit/details",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "subreddit": "Example"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/reddit/subreddit/details?subreddit=Example", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/reddit/subreddit/details?subreddit=Example"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "requestId": "synthetic-request",
  "success": true,
  "status": "success",
  "coverage": {
    "complete": true,
    "reasons": []
  },
  "accounting": {
    "httpRequests": 1,
    "proxyBytes": 256,
    "durationMs": 100,
    "pageLoads": 1,
    "challengeCount": 0,
    "rssRequests": 0,
    "proxySessionId": "synthetic-session"
  },
  "subreddit_id": "t5_abc",
  "display_name": "Example",
  "weekly_active_users": 12,
  "weekly_contributions": 4,
  "rules": "Be respectful.",
  "description": "Synthetic community",
  "header_img": null,
  "icon_img": null,
  "subscribers": 42,
  "advertiser_category": null,
  "created_at": "2023-11-14T22:13:20.000Z",
  "submit_text": null
}

The request failed validation.

{
  "requestId": "string",
  "coverage": {
    "complete": true,
    "reasons": [
      "string"
    ]
  },
  "accounting": {
    "httpRequests": 0,
    "proxyBytes": 0,
    "durationMs": 0,
    "pageLoads": 0,
    "challengeCount": 0,
    "rssRequests": 0,
    "proxySessionId": "string"
  },
  "success": false,
  "status": "failed",
  "error": "string"
}