"Reddit" (Service Connection)
Connecting & Authenticating
Requests
Private Account Information
"AccountData" — data about the authenticated user's account
"AccountFriends" — list of authenticated user's friends
"AccountKarma" — dataset of authenticated user's karma
Private Messages
"PrivateMessages" — retrieves the mailbox from the authenticated user's account
| "Source" | "Inbox" | mailbox source | |
| MaxItems | 25 | maximum number of messages to retrieve | |
| "StartIndex" | 1 | starting position of results | |
| "ShowThumbnails" | True | import thumbnail images |
Public Account Information
"UserData" — profile information for a specified user
| "User" | authenticated user | username |
"UserTrophies" — earned trophies for a specified user
| "User" | authenticated user | username | |
| "Elements" | "FullData" | one of "FullData" or "Icon" | |
| "ShowThumbnails" | True | import thumbnail images |
"UserActivity" — get recent user activity data
| "User" | authenticated user | username | |
| "SortBy" | "New" | sorting method | |
| "Type" | "Overview" | type of user activity | |
| MaxItems | 25 | maximum number of results to retrieve | |
| "StartIndex" | 1 | starting position of results | |
| "ShowThumbnails" | False | import thumbnail images |
Detailed Information on Subreddits and Posts
"GlobalIDInformation" — get data for a "GlobalID"
| "GlobalID" | (required) | "GlobalID" list of kinds t1_, t3_, or t5_ | |
| "ShowThumbnails" | False | import thumbnail images |
"PostInformation" — get data for posts
| "Post" | (required) | URL or "GlobalID" of a post | |
| "ShowThumbnails" | False | import thumbnail images |
"SubredditInformation" — get data for a subreddit
| "Subreddit" | (required) | URL or "GlobalID" of a subreddit | |
| "ShowThumbnails" | False | import thumbnail images |
Contents of Posts and Comments
"SubredditPosts" — retrieves the posts from a subreddit
| "Subreddit" | (required) | URL or "GlobalID" of a subreddit | |
| "SortBy" | "New" | sorting method | |
| MaxItems | 25 | maximum number of posts to retrieve | |
| "StartIndex" | 1 | starting position of results | |
| "ShowThumbnails" | False | import thumbnail images |
"PostCommentsData" — retrieves the comments from a post
| "Post" | (required) | URL or "GlobalID" of a post | |
| "Depth" | 1 | depth of the comment tree | |
| MaxItems | 25 | number of posts to retrieve, to a maximum of 500; only works with depth set to 1 | |
| "StartIndex" | 1 | starting position of results | |
| "ShowThumbnails" | False | import thumbnail images |
"CommentReplyData" — retrieves the replies to a comment
| "Comment" | (required) | URL or "GlobalID" of a comment | |
| "Depth" | 1 | depth of the comment tree | |
| MaxItems | 25 | number of posts to retrieve, to a maximum of 500; only works with depth set to 1 | |
| "StartIndex" | 1 | starting position of results | |
| "ShowThumbnails" | False | import thumbnail images |
Parameter Details
| "Icon" | return a list of images | |
| "FullData" | return a dataset with all available fields | |
| "Source" | one from Inbox, Unread, or Sent | |
| "SortBy" | one from New, Top, "Hot", or "Controversial"; "Rising" is also available for "SubredditPosts" request | |
| "Type" | one from "Overview", "Submitted", "Comments", "Upvoted", "Downvoted", "Hidden", "Saved", or "Gilded" |
Examples
open all close allBasic Examples (2)
Scope (15)
Use a "GlobalID" instead of a URL:
Get information about a specific user:
Get information about multiple users:
Get information on your account karma by subreddit:
Get basic information about your trophies:
Get trophies from a list of users:
Get detailed trophy information about a specific user:
Get information about several users' recent activity:
Retrieve data for several posts:
Get information about a specific subreddit:
Retrieve data on several subreddits:
Get posts from different subreddits:
Retrieve comments on a specific post:
Create a WordCloud from the comments, removing profanity with the built-in "Profanity" classifier: