Reddit reddit Subreddit API

Scrape a subreddit and its posts

curl --request POST \
  --url https://api.stophy.dev/v1/reddit/subreddit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subreddit": "AskReddit"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({subreddit: 'AskReddit'})
};

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

import requests

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

payload = { "subreddit": "AskReddit" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "post",
        "postUrl": "<string>",
        "score": 0,
        "comments": 0,
        "isNsfw": true,
        "isVideo": true,
        "isPinned": true,
        "postId": "<string>",
        "title": "<string>",
        "text": "<string>",
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorUrl": "<string>",
        "subreddit": "<string>",
        "upvotePercent": 50,
        "publishedAt": "2023-11-07T05:31:56Z",
        "flair": "<string>",
        "linkUrl": "<string>",
        "thumbnailUrl": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "videoUrl": "<string>",
        "videoHlsUrl": "<string>",
        "videoDurationSeconds": 123,
        "pollOptions": [
          {
            "text": "<string>",
            "votes": 0
          }
        ],
        "pollTotalVotes": 0,
        "pollEndsAt": "2023-11-07T05:31:56Z",
        "repostOfUrl": "<string>"
      }
    ],
    "subredditId": "<string>",
    "subredditName": "<string>",
    "subredditUrl": "<string>",
    "title": "<string>",
    "description": "<string>",
    "members": 0,
    "createdAt": "2023-11-07T05:31:56Z",
    "avatarUrl": "<string>",
    "isNsfw": true,
    "rules": [
      {
        "title": "<string>",
        "description": "<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

subreddit

Scrape a subreddit and its posts

curl --request POST \
  --url https://api.stophy.dev/v1/reddit/subreddit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subreddit": "AskReddit"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({subreddit: 'AskReddit'})
};

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

import requests

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

payload = { "subreddit": "AskReddit" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "post",
        "postUrl": "<string>",
        "score": 0,
        "comments": 0,
        "isNsfw": true,
        "isVideo": true,
        "isPinned": true,
        "postId": "<string>",
        "title": "<string>",
        "text": "<string>",
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorUrl": "<string>",
        "subreddit": "<string>",
        "upvotePercent": 50,
        "publishedAt": "2023-11-07T05:31:56Z",
        "flair": "<string>",
        "linkUrl": "<string>",
        "thumbnailUrl": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "videoUrl": "<string>",
        "videoHlsUrl": "<string>",
        "videoDurationSeconds": 123,
        "pollOptions": [
          {
            "text": "<string>",
            "votes": 0
          }
        ],
        "pollTotalVotes": 0,
        "pollEndsAt": "2023-11-07T05:31:56Z",
        "repostOfUrl": "<string>"
      }
    ],
    "subredditId": "<string>",
    "subredditName": "<string>",
    "subredditUrl": "<string>",
    "title": "<string>",
    "description": "<string>",
    "members": 0,
    "createdAt": "2023-11-07T05:31:56Z",
    "avatarUrl": "<string>",
    "isNsfw": true,
    "rules": [
      {
        "title": "<string>",
        "description": "<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 subreddit and its posts.

Request

subreddit is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.reddit.subreddit({ subreddit: "AskReddit" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.reddit.subreddit(subreddit="AskReddit")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/reddit/subreddit \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"subreddit":"AskReddit"}'

stophy reddit subreddit AskReddit

Response

If successful, the response body contains the standard envelope. data contains the subreddit’s details and rules, and results lists a page of its posts. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "subredditId": "2qh1i",
    "subredditName": "AskReddit",
    "subredditUrl": "https://www.reddit.com/r/AskReddit/",
    "title": "Ask Reddit...",
    "description": "r/AskReddit is the place to ask and answer thought-provoking questions.",
    "members": 59813591,
    "createdAt": "2008-01-25T03:52:15.000Z",
    "avatarUrl": "https://styles.redditmedia.com/t5_2qh1i/styles/communityIcon_p6kb2m6b185b1.png?width=256&s=c28b9f038c305e139b62739f2133…",
    "isNsfw": false,
    "rules": [
      {
        "title": "Rule 1 - Questions must be clear and direct and may not use the body textbox",
        "description": "* All questions must be clear, written in English, and conclude with a question mark\n* All context in the title must…"
      }
    ],
    "results": [
      {
        "type": "post",
        "postId": "1w6eajz",
        "postUrl": "https://www.reddit.com/r/AskReddit/comments/1w6eajz/askreddit_is_looking_for_new_moderators/",
        "title": "AskReddit is looking for new moderators!",
        "text": "As you can probably imagine, r/AskReddit is very busy with nearly 60 million members, over a million comments posted…",
        "authorId": "ytpt7",
        "authorUsername": "AskRedditModerators",
        "authorUrl": "https://www.reddit.com/user/AskRedditModerators/",
        "subreddit": "AskReddit",
        "score": 208,
        "upvotePercent": 93,
        "comments": 0,
        "publishedAt": "2026-09-03T17:39:04.000Z",
        "flair": "Modpost",
        "isNsfw": false,
        "isVideo": false,
        "isPinned": true
      }
    ],
    "cursor": "t3_1wyi2sl"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`type`	string	The kind of item: `post`.
`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.
`createdAt`	string (ISO 8601)	The creation time, in UTC.

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

Optional parameters

Parameter	Type	Description
`sort`	string	Specifies the order of the results. Acceptable values are `hot`, `newest`, `top`, `rising` and `controversial`. If unset, defaults to `hot`.
`time`	string	Restricts results to posts from this period. Leave it out for Reddit’s default. Acceptable values are `pastHour`, `today`, `pastWeek`, `pastMonth`, `pastYear` and `allTime`.
`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 Post: Accepts postUrl. Scrape a Reddit post and its comments.
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

subreddit

string

required

sort

enum<string>

default:hot

Reddit's own sort.

Available options:

hot,

newest,

top,

rising,

controversial

time

enum<string>

Reddit's own time filter. Leave out for Reddit's default.

Available options:

pastHour,

today,

pastWeek,

pastMonth,

pastYear,

allTime

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 Subreddit 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