> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/api-reference/reddit.md).

# Reddit

Reddit: posts, comments, users, and subreddits.

## Search Reddit posts

> Search Reddit posts by keyword. Use \`cursor\` to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive). \`sort\` is \`relevance\` (default), \`hot\`, \`top\`, \`new\`, or \`comments\`.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditPost":{"type":"object","description":"A Reddit post (link or self-text).","properties":{"type":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"textHTML":{"type":"string"},"url":{"type":"string"},"created":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"upvoteRatio":{"type":"number"},"numComments":{"type":"integer"},"viewCount":{"type":"integer","nullable":true},"goldCount":{"type":"integer"},"numCrossposts":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isOriginalContent":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"isNSFW":{"type":"boolean"},"isSpoiler":{"type":"boolean"},"isMediaOnly":{"type":"boolean"},"isSponsored":{"type":"boolean"},"isMeta":{"type":"boolean"},"isGildable":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"contestMode":{"type":"boolean"},"hidden":{"type":"boolean"},"sendReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"flair":{"type":"object","nullable":true},"thumbnail":{"type":"object","additionalProperties":true},"preview":{"type":"object","additionalProperties":true},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}},"flairs":{"type":"array","items":{"type":"object","additionalProperties":true}},"gallery":{"type":"array","items":{"type":"object","additionalProperties":true}},"crosspostParents":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/search/post":{"get":{"operationId":"searchRedditPosts","summary":"Search Reddit posts","description":"Search Reddit posts by keyword. Use `cursor` to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive). `sort` is `relevance` (default), `hot`, `top`, `new`, or `comments`.","tags":["reddit"],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","hot","top","new","comments"]}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditPost"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get a Reddit post by ID

> Returns a single Reddit post by its ID.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditPost":{"type":"object","description":"A Reddit post (link or self-text).","properties":{"type":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"textHTML":{"type":"string"},"url":{"type":"string"},"created":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"upvoteRatio":{"type":"number"},"numComments":{"type":"integer"},"viewCount":{"type":"integer","nullable":true},"goldCount":{"type":"integer"},"numCrossposts":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isOriginalContent":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"isNSFW":{"type":"boolean"},"isSpoiler":{"type":"boolean"},"isMediaOnly":{"type":"boolean"},"isSponsored":{"type":"boolean"},"isMeta":{"type":"boolean"},"isGildable":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"contestMode":{"type":"boolean"},"hidden":{"type":"boolean"},"sendReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"flair":{"type":"object","nullable":true},"thumbnail":{"type":"object","additionalProperties":true},"preview":{"type":"object","additionalProperties":true},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}},"flairs":{"type":"array","items":{"type":"object","additionalProperties":true}},"gallery":{"type":"array","items":{"type":"object","additionalProperties":true}},"crosspostParents":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/post/{id}":{"get":{"operationId":"getRedditPost","summary":"Get a Reddit post by ID","description":"Returns a single Reddit post by its ID.","tags":["reddit"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditPost"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get comments on a Reddit post

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

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditComment":{"type":"object","description":"A Reddit comment.","properties":{"type":{"type":"string"},"id":{"type":"string"},"postId":{"type":"string"},"parentId":{"type":"string"},"body":{"type":"string"},"bodyHTML":{"type":"string"},"url":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"goldCount":{"type":"integer"},"totalAwardsReceived":{"type":"integer"},"controversiality":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isSaved":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"isCollapsed":{"type":"boolean"},"noFollow":{"type":"boolean"},"sendReplies":{"type":"boolean"},"hasReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/post/{id}/comments":{"get":{"operationId":"getRedditPostComments","summary":"Get comments on a Reddit post","description":"Returns the top-level comment tree for a Reddit post.","tags":["reddit"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["best","top","new","controversial","old","qa"]}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditComment"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get replies to a Reddit comment

> Returns replies to a specific comment on a Reddit post.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditComment":{"type":"object","description":"A Reddit comment.","properties":{"type":{"type":"string"},"id":{"type":"string"},"postId":{"type":"string"},"parentId":{"type":"string"},"body":{"type":"string"},"bodyHTML":{"type":"string"},"url":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"goldCount":{"type":"integer"},"totalAwardsReceived":{"type":"integer"},"controversiality":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isSaved":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"isCollapsed":{"type":"boolean"},"noFollow":{"type":"boolean"},"sendReplies":{"type":"boolean"},"hasReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/post/{id}/comments/{commentId}/replies":{"get":{"operationId":"getRedditCommentReplies","summary":"Get replies to a Reddit comment","description":"Returns replies to a specific comment on a Reddit post.","tags":["reddit"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["best","top","new","controversial","old","qa"]}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditComment"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get a Reddit user by username

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

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditUser":{"type":"object","description":"A Reddit user profile.","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"iconImage":{"type":"string"},"snoovatarImage":{"type":"string"},"bannerImage":{"type":"string"},"awarderKarma":{"type":"integer"},"postKarma":{"type":"integer"},"commentKarma":{"type":"integer"},"totalKarma":{"type":"integer"},"hasVerifiedEmail":{"type":"boolean"},"over18":{"type":"boolean"}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/user/{username}":{"get":{"operationId":"getRedditUser","summary":"Get a Reddit user by username","description":"Returns a Reddit user profile by username (without `u/`).","tags":["reddit"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditUser"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get posts submitted by a Reddit user

> Returns posts submitted by a Reddit user. Use \`cursor\` to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditPost":{"type":"object","description":"A Reddit post (link or self-text).","properties":{"type":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"textHTML":{"type":"string"},"url":{"type":"string"},"created":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"upvoteRatio":{"type":"number"},"numComments":{"type":"integer"},"viewCount":{"type":"integer","nullable":true},"goldCount":{"type":"integer"},"numCrossposts":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isOriginalContent":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"isNSFW":{"type":"boolean"},"isSpoiler":{"type":"boolean"},"isMediaOnly":{"type":"boolean"},"isSponsored":{"type":"boolean"},"isMeta":{"type":"boolean"},"isGildable":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"contestMode":{"type":"boolean"},"hidden":{"type":"boolean"},"sendReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"flair":{"type":"object","nullable":true},"thumbnail":{"type":"object","additionalProperties":true},"preview":{"type":"object","additionalProperties":true},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}},"flairs":{"type":"array","items":{"type":"object","additionalProperties":true}},"gallery":{"type":"array","items":{"type":"object","additionalProperties":true}},"crosspostParents":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/user/{username}/posts":{"get":{"operationId":"getRedditUserPosts","summary":"Get posts submitted by a Reddit user","description":"Returns posts submitted by a Reddit user. Use `cursor` to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["reddit"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["hot","top","new"]}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditPost"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get comments authored by a Reddit user

> Returns comments authored by a Reddit user. Use \`cursor\` to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditComment":{"type":"object","description":"A Reddit comment.","properties":{"type":{"type":"string"},"id":{"type":"string"},"postId":{"type":"string"},"parentId":{"type":"string"},"body":{"type":"string"},"bodyHTML":{"type":"string"},"url":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"goldCount":{"type":"integer"},"totalAwardsReceived":{"type":"integer"},"controversiality":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isSaved":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"isCollapsed":{"type":"boolean"},"noFollow":{"type":"boolean"},"sendReplies":{"type":"boolean"},"hasReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/user/{username}/comments":{"get":{"operationId":"getRedditUserComments","summary":"Get comments authored by a Reddit user","description":"Returns comments authored by a Reddit user. Use `cursor` to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["reddit"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["hot","top","new"]}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditComment"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get a subreddit profile

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

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditSubreddit":{"type":"object","description":"A subreddit profile.","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"title":{"type":"string"},"subType":{"type":"string"},"description":{"type":"string"},"descriptionHtml":{"type":"string"},"publicDescription":{"type":"string"},"publicDescriptionHtml":{"type":"string"},"submitText":{"type":"string"},"submitTextHtml":{"type":"string","nullable":true},"submissionType":{"type":"string"},"advertiserCategory":{"type":"string"},"language":{"type":"string"},"url":{"type":"string"},"headerTitle":{"type":"string"},"iconImage":{"type":"string"},"iconSize":{"type":"array","nullable":true,"items":{"type":"integer"}},"bannerImage":{"type":"string"},"bannerBackgroundImage":{"type":"string"},"bannerSize":{"type":"array","nullable":true,"items":{"type":"integer"}},"headerImage":{"type":"string"},"headerSize":{"type":"array","items":{"type":"integer"}},"primaryColor":{"type":"string"},"keyColor":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"subscribers":{"type":"integer"},"commentScoreHideMins":{"type":"integer"},"notificationLevel":{"type":"string","nullable":true},"suggestedCommentSort":{"type":"string","nullable":true},"userFlairEnabled":{"type":"boolean"},"linkFlairEnabled":{"type":"boolean"},"wikiEnabled":{"type":"boolean"},"emojisEnabled":{"type":"boolean"},"spoilersEnabled":{"type":"boolean"},"allowImages":{"type":"boolean"},"allowVideos":{"type":"boolean"},"allowGalleries":{"type":"boolean"},"allowPolls":{"type":"boolean"},"allowPredictions":{"type":"boolean"},"allowTalks":{"type":"boolean"},"allowDiscovery":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"publicTraffic":{"type":"boolean"},"showMediaPreview":{"type":"boolean"},"showMedia":{"type":"boolean"},"collapseDeletedComments":{"type":"boolean"},"shouldArchivePosts":{"type":"boolean"},"canAssignUserFlair":{"type":"boolean"},"canAssignLinkFlair":{"type":"boolean"},"restrictCommenting":{"type":"boolean"},"restrictPosting":{"type":"boolean"},"communityReviewed":{"type":"boolean"},"flairPosition":{"type":"string"},"linkFlairPosition":{"type":"string"}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/subreddit/{name}":{"get":{"operationId":"getRedditSubreddit","summary":"Get a subreddit profile","description":"Returns a subreddit profile by its name (without `r/`).","tags":["reddit"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditSubreddit"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get posts from a subreddit

> Returns posts from a subreddit. Use \`cursor\` to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"reddit","description":"Reddit: posts, comments, users, and subreddits."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RedditPost":{"type":"object","description":"A Reddit post (link or self-text).","properties":{"type":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"textHTML":{"type":"string"},"url":{"type":"string"},"created":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"upvoteRatio":{"type":"number"},"numComments":{"type":"integer"},"viewCount":{"type":"integer","nullable":true},"goldCount":{"type":"integer"},"numCrossposts":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isOriginalContent":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"isNSFW":{"type":"boolean"},"isSpoiler":{"type":"boolean"},"isMediaOnly":{"type":"boolean"},"isSponsored":{"type":"boolean"},"isMeta":{"type":"boolean"},"isGildable":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"contestMode":{"type":"boolean"},"hidden":{"type":"boolean"},"sendReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"flair":{"type":"object","nullable":true},"thumbnail":{"type":"object","additionalProperties":true},"preview":{"type":"object","additionalProperties":true},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}},"flairs":{"type":"array","items":{"type":"object","additionalProperties":true}},"gallery":{"type":"array","items":{"type":"object","additionalProperties":true}},"crosspostParents":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/reddit/subreddit/{name}/posts":{"get":{"operationId":"getRedditSubredditPosts","summary":"Get posts from a subreddit","description":"Returns posts from a subreddit. Use `cursor` to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["reddit"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["hot","top","new"]}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RedditPost"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pullbay.com/api-reference/reddit.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.