Reddit reddit Post API

Scrape a Reddit post and its comments

curl --request POST \
  --url https://api.stophy.dev/v1/reddit/post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "postUrl": "<string>",
  "postId": "<string>",
  "comment": "<string>",
  "sort": "best",
  "cursor": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    postUrl: '<string>',
    postId: '<string>',
    comment: '<string>',
    sort: 'best',
    cursor: '<string>'
  })
};

fetch('https://api.stophy.dev/v1/reddit/post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/reddit/post"

payload = {
    "postUrl": "<string>",
    "postId": "<string>",
    "comment": "<string>",
    "sort": "best",
    "cursor": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "commentUrl": "<string>",
        "score": 0,
        "depth": 0,
        "isSubmitter": true,
        "isPinned": true,
        "commentId": "<string>",
        "parentId": "<string>",
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorUrl": "<string>",
        "text": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "postId": "<string>",
    "postUrl": "<string>",
    "title": "<string>",
    "text": "<string>",
    "authorId": "<string>",
    "authorUsername": "<string>",
    "authorUrl": "<string>",
    "subreddit": "<string>",
    "score": 0,
    "upvotePercent": 50,
    "comments": 0,
    "publishedAt": "2023-11-07T05:31:56Z",
    "flair": "<string>",
    "linkUrl": "<string>",
    "thumbnailUrl": "<string>",
    "isNsfw": true,
    "isVideo": true,
    "isPinned": true,
    "imageUrls": [
      "<string>"
    ],
    "videoUrl": "<string>",
    "videoHlsUrl": "<string>",
    "videoDurationSeconds": 123,
    "pollOptions": [
      {
        "text": "<string>",
        "votes": 0
      }
    ],
    "pollTotalVotes": 0,
    "pollEndsAt": "2023-11-07T05:31:56Z",
    "repostOfUrl": "<string>",
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

post

Scrape a Reddit post and its comments

curl --request POST \
  --url https://api.stophy.dev/v1/reddit/post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "postUrl": "<string>",
  "postId": "<string>",
  "comment": "<string>",
  "sort": "best",
  "cursor": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    postUrl: '<string>',
    postId: '<string>',
    comment: '<string>',
    sort: 'best',
    cursor: '<string>'
  })
};

fetch('https://api.stophy.dev/v1/reddit/post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/reddit/post"

payload = {
    "postUrl": "<string>",
    "postId": "<string>",
    "comment": "<string>",
    "sort": "best",
    "cursor": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "commentUrl": "<string>",
        "score": 0,
        "depth": 0,
        "isSubmitter": true,
        "isPinned": true,
        "commentId": "<string>",
        "parentId": "<string>",
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorUrl": "<string>",
        "text": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "postId": "<string>",
    "postUrl": "<string>",
    "title": "<string>",
    "text": "<string>",
    "authorId": "<string>",
    "authorUsername": "<string>",
    "authorUrl": "<string>",
    "subreddit": "<string>",
    "score": 0,
    "upvotePercent": 50,
    "comments": 0,
    "publishedAt": "2023-11-07T05:31:56Z",
    "flair": "<string>",
    "linkUrl": "<string>",
    "thumbnailUrl": "<string>",
    "isNsfw": true,
    "isVideo": true,
    "isPinned": true,
    "imageUrls": [
      "<string>"
    ],
    "videoUrl": "<string>",
    "videoHlsUrl": "<string>",
    "videoDurationSeconds": 123,
    "pollOptions": [
      {
        "text": "<string>",
        "votes": 0
      }
    ],
    "pollTotalVotes": 0,
    "pollEndsAt": "2023-11-07T05:31:56Z",
    "repostOfUrl": "<string>",
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape a Reddit post and its comments. The post is identified by its URL or ID.

Request

Exactly one of postUrl or postId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.reddit.post({ postUrl: "https://www.reddit.com/r/programming/comments/1abc2de/example_post/" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.reddit.post(post_url="https://www.reddit.com/r/programming/comments/1abc2de/example_post/")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/reddit/post \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"postUrl":"https://www.reddit.com/r/programming/comments/1abc2de/example_post/"}'

stophy reddit post --postUrl https://www.reddit.com/r/programming/comments/1abc2de/example_post/

Response

If successful, the response body contains the standard envelope. data contains the post, and results lists its comments. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "postId": "1wxj3er",
    "postUrl": "https://www.reddit.com/r/AskReddit/comments/1wxj3er/men_whats_one_small_seemingly_insignificant_thing/",
    "title": "Men, what’s one small, seemingly insignificant thing you’ve noticed that can be a telltale sign of the difference…",
    "authorId": "ojjf3gg0x",
    "authorUsername": "AuthorConfident9386",
    "authorUrl": "https://www.reddit.com/user/AuthorConfident9386/",
    "subreddit": "AskReddit",
    "score": 5312,
    "upvotePercent": 89,
    "comments": 2349,
    "publishedAt": "2026-10-04T15:56:50.000Z",
    "isNsfw": false,
    "isVideo": false,
    "isPinned": false,
    "results": [
      {
        "commentId": "pdu7cxe",
        "commentUrl": "https://www.reddit.com/r/AskReddit/comments/1wxj3er/men_whats_one_small_seemingly_insignificant_thing/pdu7cxe/",
        "authorId": "aug9d",
        "authorUsername": "s0ulfire",
        "authorUrl": "https://www.reddit.com/user/s0ulfire/",
        "text": "Ability to admit one’s mistake ",
        "score": 5756,
        "publishedAt": "2026-10-04T16:47:49.000Z",
        "depth": 0,
        "isSubmitter": false,
        "isPinned": false
      }
    ],
    "cursor": "8f1d680b-d686-4b78-a88e-7334dcfa10d1"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	Pass it as `cursor` to retrieve the rest of the comments.
`publishedAt`	string (ISO 8601)	The publication time, in UTC.
`score`	integer	Upvotes minus downvotes.
`upvotePercent`	number	The share of votes that are upvotes, as a percentage.
`depth`	integer	The nesting level of the comment in the thread. Top-level comments are 0.
`isSubmitter`	boolean	`true` if the commenter is the author of the post.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`comment`	string	A comment id or link. Returns that comment’s thread.
`sort`	string	Specifies the order of the comments. Acceptable values are `best`, `top`, `newest`, `controversial`, `old` and `qa`. If unset, defaults to `best`.
`cursor`	string	The pagination token from the previous response.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

Reddit reddit Subreddit: Accepts subreddit. Scrape a subreddit and its posts.
Reddit reddit Other Discussions: Accepts postUrl. Scrape where else a link was shared on Reddit.
Reddit reddit User: Accepts userUrl. Scrape a Reddit user’s profile, posts and comments.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json

postUrl

string

Link to the Reddit post, like https://www.reddit.com/r/programming/comments/1abc2de/example_post/. Send this or postId.

postId

string

Reddit post id, like 1abc2de. Send this or postUrl.

comment

string

A comment id or link: returns that comment's thread, like Reddit's own link.

sort

enum<string>

default:best

Reddit's own comment sort.

Available options:

best,

top,

newest,

controversial,

old,

qa

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Reddit reddit Post API

Request

Response

Optional parameters

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods