Social news aggregation and discussion platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://oauth.reddit.com/ | link | — | — | — |
Actions (59)
Subreddits · 25
- Add subreddit emojiPOST /api/v1/subreddit/emoji.json
Add or update a subreddit emoji.
documented - Autocomplete subredditsPOST /api/subreddit_autocomplete
Suggest subreddits based on a query.
documented - Delete subreddit emojiDELETE /api/v1/subreddit/emoji/emoji_name
Delete a subreddit emoji.
documented - Edit subreddit aboutPOST /r/subreddit/about/edit
Edit subreddit description and settings.
documented - Edit subreddit about/descriptionPOST /r/subreddit/about/edit
Edit the subreddit description and related metadata.
documented - Get subreddit aboutGET /r/subreddit/about
Return information about the subreddit.
documented - Get subreddit rulesGET /r/subreddit/about/rules
Retrieve subreddit rules.
documented - Get subreddit streamsGET /subreddits/mine/streams
Retrieve active streams for subreddits the user moderates.
documented - Get subreddit stylesheetGET /api/subreddit_stylesheet
Retrieve the subreddit stylesheet.
documented - Get subreddit traffic statsGET /r/subreddit/about/traffic
Retrieve subreddit traffic statistics.
documented - List all subreddit emojisGET /api/v1/subreddit/emojis/all
Get all emojis for a subreddit.
documented - List new subredditsGET /subreddits/new
List newly created subreddits.
documented - List new subredditsGET /subreddits/new
List newly created subreddits.
documented - List popular subredditsGET /subreddits/popular
List currently popular subreddits.
documented - List popular subredditsGET /subreddits/popular
List currently popular subreddits.
documented - List subreddits moderated by the userGET /subreddits/mine/moderator
List subreddits where the user is a moderator.
documented - List subreddits the user subscribes toGET /subreddits/mine/subscriber
List subreddits to which the user is subscribed.
documented - Query subreddits by contextGET /subreddits/where
List subreddits by context/category.
documented - Search subredditsGET /subreddits/search
Search for subreddits by name or topic.
documented - Search subreddits (legacy)GET /api/search_subreddits
Search for subreddits by name/description (legacy endpoint).
documented - Set subreddit emoji sizePOST /api/v1/subreddit/emoji_custom_size
Set custom emoji size.
documented - Set subreddit stylesheetPOST /api/subreddit_stylesheet
Upload or update the subreddit stylesheet.
documented - Subreddit emoji asset upload to S3POST /api/v1/subreddit/emoji_asset_upload_s3.json
Acquire an S3 lease for uploading emoji assets.
documented - Subscribe to subredditPOST /api/subscribe
Subscribe or unsubscribe a user to a subreddit.
documented - Upload subreddit imagePOST /api/upload_sr_img
Upload an image for a subreddit's appearance.
documented
Users · 10
- Get current user identityGET /api/v1/me
Returns the identity of the authenticated user.
documented - Get current user's karmaGET /api/v1/me/karma
Return a breakdown of subreddit karma.
documented - Get current user's preferencesGET /api/v1/me/prefs
Return the preference settings of the logged in user.
documented - Get current user's trophiesGET /api/v1/me/trophies
Return a list of trophies for the current user.
documented - List blocked preferencesGET /prefs/blocked
List items in the blocked preferences (as exposed by Reddit).
documented - List friends preferencesGET /prefs/friends
List friend-related preferences.
documented - List messaging preferencesGET /prefs/messaging
List messaging preferences.
documented - List preferences indexGET /prefs/where
Listing of preference sections and links to them.
documented - List trusted preferencesGET /prefs/trusted
List trusted user-related preferences.
documented - Update current user's preferencesPATCH /api/v1/me/prefs
Update the authenticated user's preference settings.
documented
Links & Comments · 8
- Get information for a thingGET /api/info
Return data for one or more things by fullname.
documented - Load more commentsPOST /api/morechildren
Fetch more children for a listing.
documented - Mark as NSFWPOST /api/marknsfw
Mark a post as NSFW.
documented - Mark as spoilerPOST /api/spoiler
Mark a post as spoiler.
documented - Post a commentPOST /api/comment
Submit a comment to a post or reply to a message.
documented - Report a post or commentPOST /api/report
Submit a report about a post or comment.
documented - Submit a linkPOST /api/submit
Submit a new post (link or text) to a subreddit.
documented - Vote on a post or commentPOST /api/vote
Cast an upvote, downvote, or remove vote on a link/comment.
documented
Notifications · 5
- Get announcementsGET /api/announcements/v1
Fetch announcements from Reddit.
documented - Hide announcementsPOST /api/announcements/v1/hide
Accepts a list of announcement fullnames and marks them hidden for the authenticated user.
documented - List unread announcementsGET /api/announcements/v1/unread
List unread announcements.
documented - Mark all announcements readPOST /api/announcements/v1/read_all
Marks all unread announcements as read for the authenticated user.
documented - Mark announcements as readPOST /api/announcements/v1/read
Accepts a list of announcement fullnames and marks them read.
documented
Widgets · 5
- Create a widgetPOST /api/widget
Create a new widget.
documented - Delete a widgetDELETE /api/widget/{widget_id}
Delete a widget.
documented - Get a widgetGET /api/widget/{widget_id}
Retrieve a specific widget by ID.
documented - List widgetsGET /api/widget
List widgets for the authenticated user/subreddits.
documented - Update a widgetPUT /api/widget/{widget_id}
Update an existing widget.
documented