Reddit
Access Reddit data and content
Integrate Reddit into workflows. Read posts, comments, and search content. Submit posts, vote, reply, edit, manage messages, and access user and subreddit info.
| Parameter | Type | Required | Description |
|---|
subreddit | string | Yes | The subreddit to fetch posts from (e.g., "technology", "news") |
sort | string | No | Sort method for posts (e.g., "hot", "new", "top", "rising", "controversial"). Default: "hot" |
limit | number | No | No description |
time | string | No | Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" (default: "all") |
after | string | No | No description |
before | string | No | No description |
count | number | No | No description |
show | string | No | Show items that would normally be filtered (e.g., "all") |
sr_detail | boolean | No | No description |
g | string | No | Geo filter for posts (e.g., "GLOBAL", "US", "AR", etc.) |
| Parameter | Type | Description |
|---|
subreddit | string | Name of the subreddit where posts were fetched from |
posts | array | Array of posts with title, author, URL, score, comments count, and metadata |
↳ id | string | Post ID |
↳ name | string | Thing fullname (t3_xxxxx) |
↳ title | string | Post title |
↳ author | string | Author username |
↳ url | string | Post URL |
↳ permalink | string | Reddit permalink |
↳ score | number | Post score (upvotes - downvotes) |
↳ num_comments | number | Number of comments |
↳ created_utc | number | Creation timestamp (UTC) |
↳ is_self | boolean | Whether this is a text post |
↳ selftext | string | Text content for self posts |
↳ thumbnail | string | Thumbnail URL |
↳ subreddit | string | Subreddit name |
after | string | Fullname of the last item for forward pagination |
before | string | Fullname of the first item for backward pagination |
| Parameter | Type | Required | Description |
|---|
postId | string | Yes | The ID of the Reddit post to fetch comments from (e.g., "abc123") |
subreddit | string | Yes | The subreddit where the post is located (e.g., "technology", "programming") |
sort | string | No | Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" (default: "confidence") |
limit | number | No | No description |
depth | number | No | No description |
context | number | No | No description |
showedits | boolean | No | No description |
showmore | boolean | No | Include "load more comments" elements in the response |
threaded | boolean | No | No description |
truncate | number | No | No description |
comment | string | No | No description |
| Parameter | Type | Description |
|---|
post | object | Post information including ID, title, author, content, and metadata |
↳ id | string | Post ID |
↳ name | string | Thing fullname (t3_xxxxx) |
↳ title | string | Post title |
↳ author | string | Post author |
↳ selftext | string | Post text content |
↳ score | number | Post score |
↳ created_utc | number | Creation timestamp |
↳ permalink | string | Reddit permalink |
comments | array | Nested comments with author, body, score, timestamps, and replies |
↳ id | string | Comment ID |
↳ name | string | Thing fullname (t1_xxxxx) |
↳ author | string | Comment author |
↳ body | string | Comment text |
↳ score | number | Comment score |
↳ created_utc | number | Creation timestamp |
↳ permalink | string | Comment permalink |
↳ replies | array | Nested reply comments |
| Parameter | Type | Required | Description |
|---|
subreddit | string | Yes | The subreddit to fetch posts from (e.g., "technology", "news") |
time | string | No | Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" (default: "all") |
limit | number | No | No description |
after | string | No | No description |
before | string | No | No description |
count | number | No | No description |
show | string | No | Show items that would normally be filtered (e.g., "all") |
sr_detail | boolean | No | No description |
| Parameter | Type | Description |
|---|
subreddit | string | Name of the subreddit where posts were fetched from |
posts | array | Array of controversial posts with title, author, URL, score, comments count, and metadata |
↳ id | string | Post ID |
↳ name | string | Thing fullname (t3_xxxxx) |
↳ title | string | Post title |
↳ author | string | Author username |
↳ url | string | Post URL |
↳ permalink | string | Reddit permalink |
↳ score | number | Post score (upvotes - downvotes) |
↳ num_comments | number | Number of comments |
↳ created_utc | number | Creation timestamp (UTC) |
↳ is_self | boolean | Whether this is a text post |
↳ selftext | string | Text content for self posts |
↳ thumbnail | string | Thumbnail URL |
↳ subreddit | string | Subreddit name |
after | string | Fullname of the last item for forward pagination |
before | string | Fullname of the first item for backward pagination |
| Parameter | Type | Required | Description |
|---|
subreddit | string | Yes | The subreddit to search in (e.g., "technology", "programming") |
query | string | Yes | Search query text (e.g., "artificial intelligence", "machine learning tutorial") |
sort | string | No | Sort method for search results (e.g., "relevance", "hot", "top", "new", "comments"). Default: "relevance" |
time | string | No | Time filter for search results: "hour", "day", "week", "month", "year", or "all" (default: "all") |
limit | number | No | No description |
restrict_sr | boolean | No | No description |
after | string | No | No description |
before | string | No | No description |
count | number | No | No description |
show | string | No | Show items that would normally be filtered (e.g., "all") |
type | string | No | Type of search results: "link" (posts), "sr" (subreddits), or "user" (users). Default: "link" |
sr_detail | boolean | No | No description |
| Parameter | Type | Description |
|---|
subreddit | string | Name of the subreddit where search was performed |
posts | array | Array of search result posts with title, author, URL, score, comments count, and metadata |
↳ id | string | Post ID |
↳ name | string | Thing fullname (t3_xxxxx) |
↳ title | string | Post title |
↳ author | string | Author username |
↳ url | string | Post URL |
↳ permalink | string | Reddit permalink |
↳ score | number | Post score (upvotes - downvotes) |
↳ num_comments | number | Number of comments |
↳ created_utc | number | Creation timestamp (UTC) |
↳ is_self | boolean | Whether this is a text post |
↳ selftext | string | Text content for self posts |
↳ thumbnail | string | Thumbnail URL |
↳ subreddit | string | Subreddit name |
after | string | Fullname of the last item for forward pagination |
before | string | Fullname of the first item for backward pagination |
| Parameter | Type | Required | Description |
|---|
subreddit | string | Yes | The subreddit to post to (e.g., "technology", "programming") |
title | string | Yes | Title of the submission (e.g., "Check out this new AI tool"). Max 300 characters |
text | string | No | Text content for a self post in markdown format (e.g., "This is the body of my post") |
url | string | No | No description |
nsfw | boolean | No | No description |
spoiler | boolean | No | No description |
send_replies | boolean | No | No description |
flair_id | string | No | No description |
flair_text | string | No | No description |
collection_id | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the post was submitted successfully |
message | string | Success or error message |
data | object | Post data including ID, name, URL, and permalink |
↳ id | string | New post ID |
↳ name | string | Thing fullname (t3_xxxxx) |
↳ url | string | Post URL from API response |
↳ permalink | string | Full Reddit permalink |
| Parameter | Type | Required | Description |
|---|
id | string | Yes | Thing fullname to vote on (e.g., "t3_abc123" for post, "t1_def456" for comment) |
dir | number | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the vote was successful |
message | string | Success or error message |
| Parameter | Type | Required | Description |
|---|
id | string | Yes | Thing fullname to save (e.g., "t3_abc123" for post, "t1_def456" for comment) |
category | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the save was successful |
message | string | Success or error message |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
subreddit | string | Subreddit name |
posts | json | Posts data |
post | json | Single post data |
comments | json | Comments data |
success | boolean | Operation success status |
message | string | Result message |
data | json | Response data |
after | string | Pagination cursor (next page) |
before | string | Pagination cursor (previous page) |
id | string | Entity ID |
name | string | Entity fullname |
messages | json | Messages data |
display_name | string | Subreddit display name |
subscribers | number | Subscriber count |
description | string | Description text |
link_karma | number | Link karma |
comment_karma | number | Comment karma |
total_karma | number | Total karma |
icon_img | string | Icon image URL |
| Parameter | Type | Required | Description |
|---|
parent_id | string | Yes | Thing fullname to reply to (e.g., "t3_abc123" for post, "t1_def456" for comment) |
text | string | Yes | Comment text in markdown format (e.g., "Great post! Here is my reply") |
return_rtjson | boolean | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the reply was posted successfully |
message | string | Success or error message |
data | object | Comment data including ID, name, permalink, and body |
↳ id | string | New comment ID |
↳ name | string | Thing fullname (t1_xxxxx) |
↳ permalink | string | Comment permalink |
↳ body | string | Comment body text |
| Parameter | Type | Required | Description |
|---|
thing_id | string | Yes | Thing fullname to edit (e.g., "t3_abc123" for post, "t1_def456" for comment) |
text | string | Yes | New text content in markdown format (e.g., "Updated content here") |
| Parameter | Type | Description |
|---|
success | boolean | Whether the edit was successful |
message | string | Success or error message |
data | object | Updated content data |
↳ id | string | Edited thing ID |
↳ body | string | Updated comment body (for comments) |
↳ selftext | string | Updated post text (for self posts) |
| Parameter | Type | Required | Description |
|---|
id | string | Yes | Thing fullname to delete (e.g., "t3_abc123" for post, "t1_def456" for comment) |
| Parameter | Type | Description |
|---|
success | boolean | Whether the deletion was successful |
message | string | Success or error message |
| Parameter | Type | Required | Description |
|---|
subreddit | string | Yes | The subreddit to subscribe to or unsubscribe from (e.g., "technology", "programming") |
action | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe |
| Parameter | Type | Description |
|---|
success | boolean | Whether the subscription action was successful |
message | string | Success or error message |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
id | string | User ID |
name | string | Username |
created_utc | number | Account creation time in UTC epoch seconds |
link_karma | number | Total link karma |
comment_karma | number | Total comment karma |
total_karma | number | Combined total karma |
is_gold | boolean | Whether user has Reddit Premium |
is_mod | boolean | Whether user is a moderator |
has_verified_email | boolean | Whether email is verified |
icon_img | string | User avatar/icon URL |
| Parameter | Type | Required | Description |
|---|
username | string | Yes | Reddit username to look up (e.g., "spez", "example_user") |
| Parameter | Type | Description |
|---|
id | string | User ID |
name | string | Username |
created_utc | number | Account creation time in UTC epoch seconds |
link_karma | number | Total link karma |
comment_karma | number | Total comment karma |
total_karma | number | Combined total karma |
is_gold | boolean | Whether user has Reddit Premium |
is_mod | boolean | Whether user is a moderator |
has_verified_email | boolean | Whether email is verified |
icon_img | string | User avatar/icon URL |
| Parameter | Type | Required | Description |
|---|
to | string | Yes | Recipient username (e.g., "example_user") or subreddit (e.g., "/r/subreddit") |
subject | string | Yes | No description |
text | string | Yes | No description |
from_sr | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the message was sent successfully |
message | string | Success or error message |
| Parameter | Type | Required | Description |
|---|
where | string | No | Message folder to retrieve: "inbox" (all), "unread", "sent", "messages" (direct messages only), "comments" (comment replies), "selfreply" (self-post replies), or "mentions" (username mentions). Default: "inbox" |
limit | number | No | No description |
after | string | No | No description |
before | string | No | No description |
mark | boolean | No | No description |
count | number | No | No description |
show | string | No | Show items that would normally be filtered (e.g., "all") |
| Parameter | Type | Description |
|---|
messages | array | Array of messages with sender, recipient, subject, body, and metadata |
↳ id | string | Message ID |
↳ name | string | Thing fullname (t4_xxxxx) |
↳ author | string | Sender username |
↳ dest | string | Recipient username |
↳ subject | string | Message subject |
↳ body | string | Message body text |
↳ created_utc | number | Creation time in UTC epoch seconds |
↳ new | boolean | Whether the message is unread |
↳ was_comment | boolean | Whether the message is a comment reply |
↳ context | string | Context URL for comment replies |
↳ distinguished | string | Distinction: null/"moderator"/"admin" |
after | string | Fullname of the last item for forward pagination |
before | string | Fullname of the first item for backward pagination |
| Parameter | Type | Required | Description |
|---|
subreddit | string | Yes | The subreddit to get info about (e.g., "technology", "programming", "news") |
| Parameter | Type | Description |
|---|
id | string | Subreddit ID |
name | string | Subreddit fullname (t5_xxxxx) |
display_name | string | Subreddit name without prefix |
title | string | Subreddit title |
description | string | Full subreddit description (markdown) |
public_description | string | Short public description |
subscribers | number | Number of subscribers |
accounts_active | number | Number of currently active users |
created_utc | number | Creation time in UTC epoch seconds |
over18 | boolean | Whether the subreddit is NSFW |
lang | string | Primary language of the subreddit |
subreddit_type | string | Subreddit type: public, private, restricted, etc. |
url | string | Subreddit URL path (e.g., /r/technology/) |
icon_img | string | Subreddit icon URL |
banner_img | string | Subreddit banner URL |