Skip to main content
POST
Get a user's profile and a page of their posts and comments
Returns a user’s profile and a page of their posts and comments. The user is identified by its URL or username.

Request

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

Response

If successful, the response body contains the standard envelope. data contains the user’s profile and karma, and results lists a page of their posts and comments. The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.

Optional parameters

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 post: Accepts postUrl. Returns a post and its comment thread, with a cursor for the rest of the comments.
  • Reddit subreddit: Accepts subreddit. Returns a subreddit’s info and a page of its posts.
  • Reddit other discussions: Accepts postUrl. Returns where else on Reddit one link was shared, equivalent to Reddit’s Other discussions.

Authorizations

Authorization
string
header
required

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

Body

application/json
userUrl
string

Link to the Reddit user, like https://www.reddit.com/user/spez. Send this or username.

username
string

Reddit user username, like spez. Send this or userUrl.

tab
enum<string>
default:overview
Available options:
overview,
posts,
comments
sort
enum<string>
default:newest

Reddit's own sort.

Available options:
newest,
hot,
top,
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
creditsUsed
integer
required
requestId
string
required