Subreddit search

Try in Playground

Search post, comment and media sections together or choose the sections to retrieve, with independent continuation for each selected section.

GET/v1/reddit/subreddit/searchx-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

subredditstringrequiredquery

Required.

ExampleExample

querystringdefault: ""query

Optional.

default: "" · max 500 chars

Exampleplanning

sortenumdefault: "relevance"query

Optional.

one of: relevance, hot, top, new, comments · default: "relevance"

Examplerelevance

timeframeenumdefault: "all"query

Optional.

one of: all, year, month, week, day, hour · default: "all"

Exampleall

cursorstringquery

Optional.

min 1 chars · max 50000 chars

sectionsenumdefault: "posts,comments,media"query

Comma-separated selection: posts, comments, media, posts,comments, posts,media, comments,media, or posts,comments,media (default). Keep the same selection when continuing.

one of: posts, comments, media, posts,comments, posts,media, comments,media, posts,comments,media · default: "posts,comments,media"

Exampleposts,comments,media

Response fields

requestIdstring

Always included.

Omitted sections are identified by posts_omitted, comments_omitted or media_omitted in coverage.reasons.

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

Always included.

up to 50 items

posts.idstring

Always included.

posts.titlestringnullableoptional

Optional.

posts.bodystringnullableoptional

Optional.

posts.urlstringnullableoptional

Optional.

posts.permalinkstringnullableoptional

Optional.

posts.votesnumbernullableoptional

Optional.

posts.num_commentsnumbernullableoptional

Optional.

Always included.

up to 50 items

comments.idstring

Always included.

comments.titlestringnullableoptional

Optional.

comments.bodystringnullableoptional

Optional.

comments.urlstringnullableoptional

Optional.

comments.permalinkstringnullableoptional

Optional.

comments.votesnumbernullableoptional

Optional.

comments.num_commentsnumbernullableoptional

Optional.

Always included.

up to 50 items

media.idstring

Always included.

media.titlestringnullableoptional

Optional.

media.bodystringnullableoptional

Optional.

media.urlstringnullableoptional

Optional.

media.permalinkstringnullableoptional

Optional.

media.votesnumbernullableoptional

Optional.

media.num_commentsnumbernullableoptional

Optional.

cursorstringnullable

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/search?subreddit=Example&query=planning&sort=relevance&timeframe=all&sections=posts%2Ccomments%2Cmedia" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/reddit/subreddit/search?subreddit=Example&query=planning&sort=relevance&timeframe=all&sections=posts%2Ccomments%2Cmedia",
  {
    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/search?subreddit=Example&query=planning&sort=relevance&timeframe=all&sections=posts%2Ccomments%2Cmedia",
  {
    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/search",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "subreddit": "Example",
        "query": "planning",
        "sort": "relevance",
        "timeframe": "all",
        "sections": "posts,comments,media"
    },
    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/search?subreddit=Example&query=planning&sort=relevance&timeframe=all&sections=posts%2Ccomments%2Cmedia", 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/search?subreddit=Example&query=planning&sort=relevance&timeframe=all&sections=posts%2Ccomments%2Cmedia"))
            .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"
  },
  "posts": [
    {
      "id": "t3_abc123",
      "title": "Synthetic topic"
    }
  ],
  "comments": [],
  "media": [],
  "cursor": 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"
}