Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reddit

Reddit: posts, comments, users, and subreddits. All endpoints are read-only GET requests and return public Reddit data — no Reddit account or OAuth app of your own is required.

Base URL: https://api.pullbay.com/

Endpoints

Endpoint
Description
Pagination

GET /reddit/search/post

Search Reddit posts by keyword

Cursor / maxItems

GET /reddit/post/{id}

Get a single post by ID

—

GET /reddit/post/{id}/comments

Get the top-level comments on a post

—

GET /reddit/post/{id}/comments/{commentId}/replies

Get replies to a comment

—

GET /reddit/user/{username}

Get a user profile by username

—

GET /reddit/user/{username}/posts

Get posts submitted by a user

Cursor / maxItems

GET /reddit/user/{username}/comments

Get comments authored by a user

Cursor / maxItems

GET /reddit/subreddit/{name}

Get a subreddit profile

—

GET /reddit/subreddit/{name}/posts

Get posts from a subreddit

Cursor / maxItems

Search Posts

Search Reddit posts by keyword.

Request

GET /reddit/search/post
Authorization: Bearer YOUR_API_KEY

Parameters

Parameter
Type
Required
Description

keyword

string

Yes

Search term, 1–100 characters

sort

string

No

relevance (default), hot, top, new, or comments

cursor

string

No

Pagination cursor from a previous response. Mutually exclusive with maxItems

maxItems

integer

No

One-shot bulk pull, 1–200 results. Mutually exclusive with cursor

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged. Using maxItems to pull more results in one call costs proportionally more than a single page.

Get Post

Returns a single Reddit post by its ID.

Request

Parameters

Parameter
Type
Required
Description

id

string (path)

Yes

Post ID, 1–32 characters. Substitute directly into the URL path

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged.

Comments

Get Post Comments

Returns the top-level comment tree for a Reddit post.

Request

Parameters

Parameter
Type
Required
Description

id

string (path)

Yes

Post ID, 1–32 characters. Substitute directly into the URL path

sort

string

No

best, top, new, controversial, old, or qa

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged.

Get Comment Replies

Returns replies to a specific comment on a Reddit post.

Request

Parameters

Parameter
Type
Required
Description

id

string (path)

Yes

Post ID, 1–32 characters. Substitute directly into the URL path

commentId

string (path)

Yes

Comment ID, 1–32 characters. Substitute directly into the URL path

sort

string

No

best, top, new, controversial, old, or qa

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged.

Users

Get User

Returns a Reddit user profile by username (without u/).

Request

Parameters

Parameter
Type
Required
Description

username

string (path)

Yes

Reddit username without the u/ prefix, 1–100 characters. Substitute directly into the URL path

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged.

Get User Posts

Returns posts submitted by a Reddit user.

Request

Parameters

Parameter
Type
Required
Description

username

string (path)

Yes

Reddit username without the u/ prefix, 1–100 characters. Substitute directly into the URL path

sort

string

No

hot, top, or new

cursor

string

No

Pagination cursor from a previous response. Mutually exclusive with maxItems

maxItems

integer

No

One-shot bulk pull, 1–200 results. Mutually exclusive with cursor

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged. Using maxItems to pull more results in one call costs proportionally more than a single page.

Get User Comments

Returns comments authored by a Reddit user.

Request

Parameters

Parameter
Type
Required
Description

username

string (path)

Yes

Reddit username without the u/ prefix, 1–100 characters. Substitute directly into the URL path

sort

string

No

hot, top, or new

cursor

string

No

Pagination cursor from a previous response. Mutually exclusive with maxItems

maxItems

integer

No

One-shot bulk pull, 1–200 results. Mutually exclusive with cursor

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged. Using maxItems to pull more results in one call costs proportionally more than a single page.

Subreddits

Get Subreddit

Returns a subreddit profile by its name (without r/).

Request

Parameters

Parameter
Type
Required
Description

name

string (path)

Yes

Subreddit name without the r/ prefix, 1–100 characters. Substitute directly into the URL path

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged.

Get Subreddit Posts

Returns posts from a subreddit.

Request

Parameters

Parameter
Type
Required
Description

name

string (path)

Yes

Subreddit name without the r/ prefix, 1–100 characters. Substitute directly into the URL path

sort

string

No

hot, top, or new

cursor

string

No

Pagination cursor from a previous response. Mutually exclusive with maxItems

maxItems

integer

No

One-shot bulk pull, 1–200 results. Mutually exclusive with cursor

Example

Response

Credit cost: dynamic, returned in pricing.creditsCharged. Using maxItems to pull more results in one call costs proportionally more than a single page.

Object schemas

Post object

Field
Type
Description

type

string

Always post

id

string

Post ID

title

string

Post title

text

string

Self-text body (empty for link posts)

textHTML

string

Rendered HTML of the self-text body

url

string

Relative permalink to the post

created

integer (unix seconds)

Submission timestamp

editedAt

integer or boolean

Edit timestamp, or false if never edited

score

integer

Net score (upvotes minus downvotes)

upvotes / downvotes

integer

Vote counts

upvoteRatio

number

Fraction of votes that are upvotes

numComments

integer

Total comment count

viewCount

integer, nullable

View count, when available

goldCount

integer

Number of Reddit Gold awards

numCrossposts

integer

Number of crossposts of this post

isLocked / isStickied / isArchived

boolean

Moderation/state flags

isOriginalContent / isCrosspostable

boolean

Content flags

isNSFW / isSpoiler / isMediaOnly / isSponsored / isMeta / isGildable / isScoreHidden / contestMode / hidden

boolean

Additional content/state flags

sendReplies

boolean

Whether the author allows reply notifications

author

object

See Author object

subreddit

object

See Subreddit Reference object

flair

object, nullable

Link flair, when set

thumbnail

object

Thumbnail image metadata

preview

object

Preview image/media metadata

awards

array

Awards given to the post

flairs

array

Available flair templates

gallery

array

Gallery media items, for gallery posts

crosspostParents

array

Parent post(s), for crossposts

Comment object

Field
Type
Description

type

string

Always comment

id

string

Comment ID

postId

string

Fullname of the post the comment belongs to

parentId

string

Fullname of the parent (post or comment)

body

string

Comment text

bodyHTML

string

Rendered HTML of the comment text

url

string

Relative permalink to the comment

createdAt

integer (unix seconds)

When the comment was posted

editedAt

integer or boolean

Edit timestamp, or false if never edited

score

integer

Net score (upvotes minus downvotes)

upvotes / downvotes

integer

Vote counts

goldCount

integer

Number of Reddit Gold awards

totalAwardsReceived

integer

Total awards received

controversiality

integer

Reddit's controversiality flag (0 or 1)

isLocked / isStickied / isArchived / isSaved / isScoreHidden / isCollapsed

boolean

Moderation/state flags

noFollow

boolean

Whether links in the comment are nofollow

sendReplies

boolean

Whether the author allows reply notifications

hasReplies

boolean

Whether this comment has reply comments

author

object

See Author object

subreddit

object

See Subreddit Reference object

awards

array

Awards given to the comment

User object

Field
Type
Description

type

string

Always user

id

string

User ID (without t2_ prefix)

name

string

Username

title

string

Profile title (often same as username)

description

string

Profile bio/description

createdAt

integer (unix seconds)

Account creation timestamp

iconImage

string

Avatar image URL

snoovatarImage

string

Snoovatar image URL, if set

bannerImage

string

Profile banner image URL

awarderKarma

integer

Karma earned from giving awards

postKarma

integer

Karma earned from posts

commentKarma

integer

Karma earned from comments

totalKarma

integer

Combined karma total

hasVerifiedEmail

boolean

Whether the account has a verified email

over18

boolean

Whether the account is marked NSFW

Subreddit object

Field
Type
Description

type

string

Always subreddit

id

string

Subreddit ID (without t5_ prefix)

name

string

Subreddit name (without r/)

prefixedName

string

Subreddit name with r/ prefix

title

string

Subreddit title

subType

string

Subreddit visibility type (e.g. public)

description / descriptionHtml

string

Sidebar description, plain and HTML

publicDescription / publicDescriptionHtml

string

Short public description, plain and HTML

submitText / submitTextHtml

string, nullable

Text shown on the submit page

submissionType

string

Allowed submission type (e.g. link, self, any)

advertiserCategory

string

Ad category classification

language

string

Subreddit's primary language code

url

string

Relative URL to the subreddit

headerTitle

string

Header link title

iconImage / iconSize

string / array, nullable

Icon image URL and dimensions

bannerImage / bannerBackgroundImage / bannerSize

string / array, nullable

Banner images and dimensions

headerImage / headerSize

string / array

Header image URL and dimensions

primaryColor / keyColor

string

Theme colors

createdAt

integer (unix seconds)

Subreddit creation timestamp

subscribers

integer

Subscriber count

commentScoreHideMins

integer

Minutes comment scores are hidden after posting

notificationLevel / suggestedCommentSort

string, nullable

User-specific notification setting and suggested sort

userFlairEnabled / linkFlairEnabled

boolean

Flair feature flags

wikiEnabled / emojisEnabled / spoilersEnabled

boolean

Feature flags

allowImages / allowVideos / allowGalleries / allowPolls / allowPredictions / allowTalks

boolean

Allowed content type flags

allowDiscovery / isCrosspostable / publicTraffic

boolean

Discovery and traffic flags

showMediaPreview / showMedia

boolean

Media display settings

collapseDeletedComments / shouldArchivePosts

boolean

Moderation settings

canAssignUserFlair / canAssignLinkFlair

boolean

Flair assignment permissions

restrictCommenting / restrictPosting

boolean

Posting/commenting restrictions

communityReviewed

boolean

Whether the subreddit has passed community review

flairPosition / linkFlairPosition

string

Flair display position (e.g. right)

Author object

Embedded in Post and Comment objects as the author field.

Field
Type
Description

id

string

Author's user ID (fullname, e.g. t2_1w72)

username

string

Author's username

isBlocked

boolean

Whether the author is blocked by the requesting context

isDeleted

boolean

Whether the author's account has been deleted

Subreddit Reference object

Embedded in Post and Comment objects as the subreddit field.

Field
Type
Description

id

string

Subreddit ID (fullname, e.g. t5_2fwo)

name

string

Subreddit name (without r/)

prefixedName

string

Subreddit name with r/ prefix

type

string

Subreddit visibility type (e.g. public)

Errors

All non-2xx responses share the same envelope:

Status
Meaning

400

Bad request — missing/invalid parameters

402

Insufficient credits

404

Post, comment, user, or subreddit not found

Finding Post, Comment, User, and Subreddit IDs

  • Post ID: the alphanumeric segment in a Reddit URL, e.g. https://reddit.com/r/learnprogramming/comments/1qclvp3/... → 1qclvp3.

  • Comment ID: the alphanumeric segment after the post ID in a comment permalink, e.g. .../comments/1t0jood/some_title/ojb40kw/ → ojb40kw.

  • Username: the part after u/ in a profile URL, e.g. https://reddit.com/u/spez → spez. Pass it without the u/ prefix.

  • Subreddit name: the part after r/ in a subreddit URL, e.g. https://reddit.com/r/programming → programming. Pass it without the r/ prefix.

  • The search/post endpoint is the fastest way to discover post IDs for a topic without already knowing a permalink.

Pagination Notes

  • List endpoints (search/post, user/{username}/posts, user/{username}/comments, subreddit/{name}/posts) use cursor-based pagination: pass the cursor value from a previous response's pagination object to fetch the next page.

  • maxItems is a one-shot bulk-pull alternative to cursor — it returns up to the requested count of results in a single call (capped at 200) instead of paging manually. cursor and maxItems are mutually exclusive on every endpoint that supports them.

  • Single-resource endpoints (post/{id}, post/{id}/comments, post/{id}/comments/{commentId}/replies, user/{username}, subreddit/{name}) return the full result in one call and have no pagination.

Last updated