Post comments with a POST body

Try in Playground

Read a Reddit post and nested comments using JSON input, with a continuation token for further comment pages.

POST/v1/reddit/post/commentsx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

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

Content-Typestringrequiredheader

Must be application/json.

Request body

urlstringrequiredbody

Required.

max 2048 chars · absolute HTTPS URL

Examplehttps://www.reddit.com/r/Example/comments/abc123/example/

cursorstringbody

Optional.

min 1 chars · max 50000 chars

trimboolean | enumdefault: falsebody

Optional.

default: false

Examplefalse

include_postboolean | enumdefault: truebody

Defaults to true. With a cursor, false skips the post reload and returns post as null with the post_omitted coverage reason (status partial); without a cursor the first page keeps the post.

default: true

Exampletrue

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

Always included.

post.idstring

Always included.

post.titlestring

Always included.

post.permalinkstring

Always included.

post.namestringoptional

Optional.

post.authorstringnullableoptional

Optional.

post.author_fullnamestringnullableoptional

Optional.

post.subredditstringnullableoptional

Optional.

post.subreddit_idstringnullableoptional

Optional.

post.selftextstringnullableoptional

Optional.

post.selftext_htmlstringnullableoptional

Optional.

post.scorenumbernullableoptional

Optional.

post.upsnumbernullableoptional

Optional.

post.downsnumbernullableoptional

Optional.

post.upvote_rationumbernullableoptional

Optional.

post.num_commentsnumbernullableoptional

Optional.

post.creatednumbernullableoptional

Optional.

post.created_utcnumbernullableoptional

Optional.

post.created_at_isostringnullable

Always included.

post.urlstringnullableoptional

Optional.

post.is_videobooleannullableoptional

Optional.

post.over_18booleannullableoptional

Optional.

post.archivedbooleannullableoptional

Optional.

post.lockedbooleannullableoptional

Optional.

post.spoilerbooleannullableoptional

Optional.

post.link_flair_textstringnullableoptional

Optional.

post.total_awards_receivednumbernullableoptional

Optional.

post.subreddit_subscribersnumbernullableoptional

Optional.

Always included.

up to 100 items

comments.idstring

Always included.

comments.bodystring

Always included.

comments.parent_idstringnullable

Always included.

comments.namestringoptional

Optional.

comments.link_idstringnullableoptional

Optional.

comments.authorstringnullableoptional

Optional.

comments.author_fullnamestringnullableoptional

Optional.

comments.body_htmlstringnullableoptional

Optional.

comments.scorenumbernullableoptional

Optional.

comments.upsnumbernullableoptional

Optional.

comments.downsnumbernullableoptional

Optional.

comments.created_utcnumbernullableoptional

Optional.

comments.created_at_isostringnullable

Always included.

comments.permalinkstringnullableoptional

Optional.

comments.urlstringnullableoptional

Optional.

Always included.

up to 100 items

comments.replies.items.idstring

Always included.

comments.replies.items.bodystring

Always included.

comments.replies.items.parent_idstringnullable

Always included.

comments.replies.items.namestringoptional

Optional.

comments.replies.items.link_idstringnullableoptional

Optional.

comments.replies.items.authorstringnullableoptional

Optional.

comments.replies.items.author_fullnamestringnullableoptional

Optional.

comments.replies.items.body_htmlstringnullableoptional

Optional.

comments.replies.items.scorenumbernullableoptional

Optional.

comments.replies.items.upsnumbernullableoptional

Optional.

comments.replies.items.downsnumbernullableoptional

Optional.

comments.replies.items.created_utcnumbernullableoptional

Optional.

comments.replies.items.created_at_isostringnullable

Always included.

comments.replies.items.permalinkstringnullableoptional

Optional.

comments.replies.items.urlstringnullableoptional

Optional.

Always included.

comments.replies.items.replies.itemsobject[]

Always included.

up to 100 items

comments.replies.items.replies.moreobject

Always included.

comments.replies.more.has_moreboolean

Always included.

comments.replies.more.cursorstringnullable

Always included.

more.has_moreboolean

Always included.

more.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 -X POST "https://api.scrapeatlas.com/v1/reddit/post/comments" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.reddit.com/r/Example/comments/abc123/example/","trim":false,"include_post":true}'

const response = await fetch(
  "https://api.scrapeatlas.com/v1/reddit/post/comments",
  {
    method: "POST",
    headers: {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "https://www.reddit.com/r/Example/comments/abc123/example/",
      "trim": false,
      "include_post": true
    })
  }
);

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/post/comments",
  {
    method: "POST",
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "https://www.reddit.com/r/Example/comments/abc123/example/",
      "trim": false,
      "include_post": true
    })
  }
);

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.post(
    "https://api.scrapeatlas.com/v1/reddit/post/comments",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "url": "https://www.reddit.com/r/Example/comments/abc123/example/",
        "trim": False,
        "include_post": True
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

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

func main() {
	body := strings.NewReader(`{"url":"https://www.reddit.com/r/Example/comments/abc123/example/","trim":false,"include_post":true}`)
	req, _ := http.NewRequest("POST", "https://api.scrapeatlas.com/v1/reddit/post/comments", body)
	req.Header.Set("Content-Type", "application/json")
	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/post/comments"))
            .POST(HttpRequest.BodyPublishers.ofString("{\"url\":\"https://www.reddit.com/r/Example/comments/abc123/example/\",\"trim\":false,\"include_post\":true}"))
            .header("Content-Type", "application/json")
            .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"
  },
  "post": {
    "id": "abc123",
    "title": "Synthetic topic",
    "author": "sample_user",
    "subreddit": "Example",
    "permalink": "/r/Example/comments/abc123/topic/",
    "created_utc": 1700000000,
    "created_at_iso": "2023-11-14T22:13:20.000Z",
    "score": 10,
    "num_comments": 2,
    "url": "https://www.reddit.com/r/Example/comments/abc123/topic/"
  },
  "comments": [
    {
      "id": "reply1",
      "body": "Synthetic comment",
      "author": "sample_user",
      "parent_id": "t3_abc123",
      "link_id": "t3_abc123",
      "created_utc": 1700000001,
      "created_at_iso": "2023-11-14T22:13:21.000Z",
      "score": 2,
      "replies": {
        "items": [],
        "more": {
          "has_more": false,
          "cursor": null
        }
      }
    }
  ],
  "more": {
    "has_more": false,
    "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"
}