Returns the identity of the user currently authenticated via OAuth.

Return a breakdown of subreddit karma.

Return the preference settings of the logged in user

Return a list of trophies for the current user.

This endpoint is a listing.

Check whether ReCAPTCHAs are needed for API methods

Change the flair of multiple users in the same subreddit with a single API call.

Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored).

If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair.

Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.

This endpoint is a listing.

Return information about a users's flair options.

If link is given, return link flair options. Otherwise, return user flair options for this subreddit.

The logged in user's flair is also returned. Subreddit moderators may give a user by name to instead retrieve that user's flair.

Return list of available link flair for the current subreddit.

Will not return flair if the user cannot set their own link flair and they are not a moderator that can set flair.

Submit a new comment or reply to a message.

parent is the fullname of the thing being replied to. Its value changes the kind of object created by this request:

• the fullname of a Link: a top-level comment in that Link's thread. (requires submit scope)
• the fullname of a Comment: a comment reply to that comment. (requires submit scope)
• the fullname of a Message: a message reply to that message. (requires privatemessages scope)

text should be the raw markdown body of the comment or message.

To start a new message thread, use /api/compose.

Delete a Link or Comment.

Edit the body text of a comment or self-post.

Hide a link.

This removes it from the user's default view of subreddit listings.

See also: /api/unhide.

Return a listing of things specified by their fullnames.

Only Links, Comments, and Subreddits are allowed.

Lock a link.

Prevents a post from receiving new comments.

See also: /api/unlock.

Mark a link NSFW.

See also: /api/unmarknsfw.

Retrieve additional comments omitted from a base comment tree.

When a comment tree is rendered, the most relevant comments are selected for display first. Remaining comments are stubbed out with "MoreComments" links. This API call is used to retrieve the additional comments represented by those stubs, up to 100 at a time.

The two core parameters required are link and children. link is the fullname of the link whose comments are being fetched. children is a comma-delimited list of comment ID36s that need to be fetched.

If id is passed, it should be the ID of the MoreComments object this call is replacing. This is needed only for the HTML UI's purposes and is optional otherwise.

NOTE: you may only make one request at a time to this API endpoint. Higher concurrency will result in an error being returned.

Report a link, comment or message.

Reporting a thing brings it to the attention of the subreddit's moderators. Reporting a message sends it to a system for admin review.

For links and comments, the thing is implicitly hidden as well (see /api/hide for details).

Save a link or comment.

Saved things are kept in the user's saved listing for later perusal.

See also: /api/unsave.

Get a list of categories in which things are currently saved.

See also: /api/save.

Enable or disable inbox replies for a link or comment.

state is a boolean that indicates whether you are enabling or disabling inbox replies - true to enable, false to disable.

Set or unset "contest mode" for a link's comments.

state is a boolean that indicates whether you are enabling or disabling contest mode - true to enable, false to disable.

Set or unset a Link as the sticky in its subreddit.

state is a boolean that indicates whether to sticky or unsticky this post - true to sticky, false to unsticky.

The num argument is optional, and only used when stickying a post. It allows specifying a particular "slot" to sticky the post into, and if there is already a post stickied in that slot it will be replaced. If there is no post in the specified slot to replace, or num is None, the bottom-most slot will be used.

Set a suggested sort for a link.

Suggested sorts are useful to display comments in a certain preferred way for posts. For example, casual conversation may be better sorted by new by default, or AMAs may be sorted by Q&A. A sort of an empty string clears the default sort.

Requires a subscription to reddit gold

Submit a link to a subreddit.

Submit will create a link or self-post in the subreddit sr with the title title. If kind is "link", then url is expected to be a valid URL to link to. Otherwise, text, if present, will be the body of the self-post unless richtext is present, in which case it will be converted into the body of the self-post. An error is thrown if both text and richtext are present.

If a link with the same URL has already been submitted to the specified subreddit an error will be returned unless resubmit is true. extension is used for determining which view-type (e.g. json, compact etc.) to use for the redirect that is generated if the resubmit error occurs.

Unhide a link.

See also: /api/hide.

Unlock a link.

Allow a post to receive new comments.

See also: /api/lock.

Remove the NSFW marking from a link.

See also: /api/marknsfw.

Unsave a link or comment.

This removes the thing from the user's saved listings as well.

See also: /api/save.

Cast a vote on a thing.

id should be the fullname of the Link or Comment to vote on.

dir indicates the direction of the vote. Voting 1 is an upvote, -1 is a downvote, and 0 is equivalent to "un-voting" by clicking again on a highlighted arrow.

Note: votes must be cast by humans. That is, API clients proxying a human's action one-for-one are OK, but bots deciding how to vote on content or amplifying a human's vote are not. See the reddit rules for more details on what constitutes vote cheating.

Return a list of trending subreddits, link to the comment in r/trendingsubreddits, and the comment count of that link.

Get a listing of links by fullname.

names is a list of fullnames for links separated by commas or spaces.

Get the comment tree for a given Link article.

If supplied, comment is the ID36 of a comment in the comment tree for article. This comment will be the (highlighted) focal point of the returned view and context will be the number of parents shown.

depth is the maximum depth of subtrees in the thread.

limit is the maximum number of comments to return.

See also: /api/morechildren and /api/comment.

Return a list of other submissions of the same URL

This endpoint is a listing.

This endpoint is a listing.

This endpoint is a listing.

The Serendipity button

This endpoint is a listing.

This endpoint is a listing.

Get a listing of live events by id.

Create a new live thread.

Once created, the initial settings can be modified with /api/live/thread/edit and new updates can be posted with /api/live/thread/update.

Get some basic information about the currently featured live thread.

Returns an empty 204 response for api requests if no thread is currently featured.

See also: /api/live/thread/about.

Accept a pending invitation to contribute to the thread.

See also: /api/live/thread/leave_contributor.

Permanently close the thread, disallowing future updates.

Requires the close permission for this thread.

Delete an update from the thread.

Requires that specified update must have been authored by the user or that you have the edit permission for this thread.

See also: /api/live/thread/update.

Configure the thread.

Requires the settings permission for this thread.

See also: /live/thread/about.json.

Invite another user to contribute to the thread.

Requires the manage permission for this thread. If the recipient accepts the invite, they will be granted the permissions specified.

See also: /api/live/thread/accept_contributor_invite, and /api/live/thread/rm_contributor_invite.

Abdicate contributorship of the thread.

See also: /api/live/thread/accept_contributor_invite, and /api/live/thread/invite_contributor.

Report the thread for violating the rules of reddit.

Revoke another user's contributorship.

Requires the manage permission for this thread.

See also: /api/live/thread/invite_contributor.

Revoke an outstanding contributor invite.

Requires the manage permission for this thread.

See also: /api/live/thread/invite_contributor.

Change a contributor or contributor invite's permissions.

Requires the manage permission for this thread.

See also: /api/live/thread/invite_contributor and /api/live/thread/rm_contributor.

Strike (mark incorrect and cross out) the content of an update.

Requires that specified update must have been authored by the user or that you have the edit permission for this thread.

See also: /api/live/thread/update.

Post an update to the thread.

Requires the update permission for this thread.

See also: /api/live/thread/strike_update, and /api/live/thread/delete_update.

Get a list of updates posted in this thread.

See also: /api/live/thread/update.

This endpoint is a listing.

Get some basic information about the live thread.

See also: /api/live/thread/edit.

Get a list of users that contribute to this thread.

See also: /api/live/thread/invite_contributor, and /api/live/thread/rm_contributor.

Get a list of reddit submissions linking to this thread.

This endpoint is a listing.

For blocking via inbox.

Collapse a message

See also: /api/uncollapse_message

Handles message composition under /message/compose.

Delete messages from the recipient's view of their inbox.

Queue up marking all messages for a user as read.

This may take some time, and returns 202 to acknowledge acceptance of the request.

Uncollapse a message

See also: /api/collapse_message

This endpoint is a listing.

Retrieve descriptions of reddit's OAuth2 scopes.

If no scopes are given, information on all scopes are returned.

Invalid scope(s) will result in a 400 error with body that indicates the invalid scope(s).

Get a list of recent moderation actions.

Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information.

The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit.

The type parameter is optional and if sent limits the log entries returned to only those of the type specified.

This endpoint is a listing.

Return a listing of posts relevant to moderators.

• reports: Things that have been reported.
• spam: Things that have been marked as spam or otherwise removed.
• modqueue: Things requiring moderator review, such as reported things and items caught by the spam filter.
• unmoderated: Things that have yet to be approved/removed by a mod.
• edited: Things that have been edited recently.

Requires the "posts" moderator permission for the subreddit.

This endpoint is a listing.

Accept an invite to moderate the specified subreddit.

The authenticated user must have been invited to moderate the subreddit by one of its current moderators.

See also: /api/friend and /subreddits/mine.

Approve a link or comment.

If the thing was removed, it will be re-inserted into appropriate listings. Any reports on the approved thing will be discarded.

See also: /api/remove.

Distinguish a thing's author with a sigil.

This can be useful to draw attention to and confirm the identity of the user in the context of a link or comment of theirs. The options for distinguish are as follows:

• yes - add a moderator distinguish ([M]). only if the user is a moderator of the subreddit the thing is in.
• no - remove any distinguishes.
• admin - add an admin distinguish ([A]). admin accounts only.
• special - add a user-specific distinguish. depends on user.

The first time a top-level comment is moderator distinguished, the author of the link the comment is in reply to will get a notification in their inbox.

Prevent future reports on a thing from causing notifications.

Any reports made about a thing after this flag is set on it will not cause notifications or make the thing show up in the various moderation listings.

See also: /api/unignore_reports.

Abdicate approved submitter status in a subreddit.

See also: /api/friend.

Abdicate moderator status in a subreddit.

See also: /api/friend.

For muting user via modmail.

Remove a link, comment, or modmail message.

If the thing is a link, it will be removed from all subreddit listings. If the thing is a comment, it will be redacted and removed from all subreddit comment listings.

See also: /api/approve.

Allow future reports on a thing to cause notifications.

See also: /api/ignore_reports.

For unmuting user via modmail.

Redirect to the subreddit's stylesheet if one exists.

See also: /api/subreddit_stylesheet.

Marks all conversations read for a particular conversation state within the passed list of subreddits.

Get conversations for a logged in user or subreddits

Creates a new conversation for a particular SR

This endpoint will create a ModmailConversation object as well as the first ModmailMessage within the ModmailConversation object.

Returns all messages, mod actions and conversation metadata for a given conversation id

Creates a new message for a particular conversation

Marks a conversation as archived.

Removes a highlight from a conversation.

Marks a conversation as highlighted.

Mutes the non mod user associated with a particular conversation.

Marks conversation as unarchived.

Unmutes the non mod user associated with a particular conversation.

Returns recent posts, comments and modmail conversations for a given user.

Marks a conversations as read for the user.

Returns a list of srs that the user moderates that are also enrolled in the new modmail

Marks conversations as unread for the user.

Endpoint to retrieve the unread conversation count by conversation state.

Copy a multi.

Responds with 409 Conflict if the target already exists.

A "copied from ..." line will automatically be appended to the description.

Fetch a list of multis belonging to the current user.

Rename a multi.

Fetch a list of public multis belonging to username

Delete a multi.

Fetch a multi's data and subreddit list by name.

Create a multi. Responds with 409 Conflict if it already exists.

{
  "description_md": raw markdown text,
  "display_name": a string no longer than 50 characters,
  "icon_name": one of (`art and design`, `ask`, `books`, `business`, `cars`, `comics`, `cute animals`, `diy`, `entertainment`, `food and drink`, `funny`, `games`, `grooming`, `health`, `life advice`, `military`, `models pinup`, `music`, `news`, `philosophy`, `pictures and gifs`, `science`, `shopping`, `sports`, `style`, `tech`, `travel`, `unusual stories`, `video`, ``, `None`),
  "key_color": a 6-digit rgb hex color, e.g. `#AABBCC`,
  "subreddits": [
    {
      "name": subreddit name,
    },
    ...
  ],
  "visibility": one of (`private`, `public`, `hidden`),
  "weighting_scheme": one of (`classic`, `fresh`),
}

Create or update a multi.

{
  "description_md": raw markdown text,
  "display_name": a string no longer than 50 characters,
  "icon_name": one of (`art and design`, `ask`, `books`, `business`, `cars`, `comics`, `cute animals`, `diy`, `entertainment`, `food and drink`, `funny`, `games`, `grooming`, `health`, `life advice`, `military`, `models pinup`, `music`, `news`, `philosophy`, `pictures and gifs`, `science`, `shopping`, `sports`, `style`, `tech`, `travel`, `unusual stories`, `video`, ``, `None`),
  "key_color": a 6-digit rgb hex color, e.g. `#AABBCC`,
  "subreddits": [
    {
      "name": subreddit name,
    },
    ...
  ],
  "visibility": one of (`private`, `public`, `hidden`),
  "weighting_scheme": one of (`classic`, `fresh`),
}

Get a multi's description.

Change a multi's markdown description.

{
  "body_md": raw markdown text,
}

Remove a subreddit from a multi.

Get data about a subreddit in a multi.

Add a subreddit to a multi.

{
  "name": subreddit name,
}

Search links page.

This endpoint is a listing.

This endpoint is a listing.

Remove the subreddit's custom mobile banner.

See also: /api/upload_sr_img.

Remove the subreddit's custom header image.

The sitewide-default header image will be shown again after this call.

See also: /api/upload_sr_img.

Remove the subreddit's custom mobile icon.

See also: /api/upload_sr_img.

Remove an image from the subreddit's custom image set.

The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed.

See also: /api/upload_sr_img.

Return subreddits recommended for the given subreddit(s).

Gets a list of subreddits recommended for srnames, filtering out any that appear in the optional omit param.

List subreddit names that begin with a query string.

Subreddits whose names begin with query will be returned. If include_over_18 is false, subreddits with over-18 content restrictions will be filtered from the results.

If include_unadvertisable is False, subreddits that have hide_ads set to True or are on the anti_ads_subreddits list will be filtered.

If exact is true, only an exact match will be returned. Exact matches are inclusive of over_18 subreddits, but not hide_ad subreddits when include_unadvertisable is False.

List subreddits that begin with a query string.

Subreddits whose names begin with query will be returned. If include_over_18 is false, subreddits with over-18 content restrictions will be filtered from the results.

If include_unadvertisable is False, subreddits that have hide_ads set to True or are on the anti_ads_subreddits list will be filtered.

If exact is true, only an exact match will be returned. Exact matches are inclusive of over_18 subreddits, but not hide_ad subreddits when include_unadvertisable is False.

Create or configure a subreddit.

If sr is specified, the request will attempt to modify the specified subreddit. If not, a subreddit with name name will be created.

This endpoint expects all values to be supplied on every request. If modifying a subset of options, it may be useful to get the current settings from /about/edit.json first.

For backwards compatibility, description is the sidebar text and public_description is the publicly visible subreddit description.

Most of the parameters for this endpoint are identical to options visible in the user interface and their meanings are best explained there.

See also: /about/edit.json.

Get the submission text for the subreddit.

This text is set by the subreddit moderators and intended to be displayed on the submission form.

See also: /api/site_admin.

Update a subreddit's stylesheet.

op should be save to update the contents of the stylesheet.

Return a list of subreddits that are relevant to a search query.

Subscribe to or unsubscribe from a subreddit.

To subscribe, action should be sub. To unsubscribe, action should be unsub. The user must have access to the subreddit to be able to subscribe to it.

The skip_initial_defaults param can be set to True to prevent automatically subscribing the user to the current set of defaults when they take their first subscription action. Attempting to set it for an unsubscribe action will result in an error.

See also: /subreddits/mine/.

Add or replace a subreddit image, custom header logo, custom mobile icon, or custom mobile banner.

• If the upload_type value is img, an image for use in the subreddit stylesheet is uploaded with the name specified in name.
• If the upload_type value is header then the image uploaded will be the subreddit's new logo and name will be ignored.
• If the upload_type value is icon then the image uploaded will be the subreddit's new mobile icon and name will be ignored.
• If the upload_type value is banner then the image uploaded will be the subreddit's new mobile banner and name will be ignored.

For backwards compatibility, if upload_type is not specified, the header field will be used instead:

• If the header field has value 0, then upload_type is img.
• If the header field has value 1, then upload_type is header.

The img_type field specifies whether to store the uploaded image as a PNG or JPEG.

Subreddits have a limited number of images that can be in use at any given time. If no image with the specified name already exists, one of the slots will be consumed.

If an image with the specified name already exists, it will be replaced. This does not affect the stylesheet immediately, but will take effect the next time the stylesheet is saved.

See also: /api/delete_sr_img, /api/delete_sr_header, /api/delete_sr_icon, and /api/delete_sr_banner.

Return information about the subreddit.

Data includes the subscriber count, description, and header image.

Get the current settings of a subreddit.

In the API, this returns the current settings of the subreddit as used by /api/site_admin. On the HTML site, it will display a form for editing the subreddit.

Get the rules for the current subreddit

Get the sidebar for the current subreddit

Redirect to one of the posts stickied in the current subreddit

The "num" argument can be used to select a specific sticky, and will default to 1 (the top sticky) if not specified. Will 404 if there is not currently a sticky post in this subreddit.

Get subreddits the user has a relationship with.

The where parameter chooses which subreddits are returned as follows:

• subscriber - subreddits the user is subscribed to
• contributor - subreddits the user is an approved submitter in
• moderator - subreddits the user is a moderator of

See also: /api/subscribe, /api/friend, and /api/accept_moderator_invite.

This endpoint is a listing.

Search subreddits by title and description.

This endpoint is a listing.

Get all subreddits.

The where parameter chooses the order in which the subreddits are displayed. popular sorts on the activity of the subreddit and the position of the subreddits can shift around. new sorts the subreddits based on their creation date, newest first.

This endpoint is a listing.

Get all user subreddits.

The where parameter chooses the order in which the subreddits are displayed. popular sorts on the activity of the subreddit and the position of the subreddits can shift around. new sorts the user subreddits based on their creation date, newest first.

This endpoint is a listing.

Create a relationship between a user and another user or subreddit

OAuth2 use requires appropriate scope based on the 'type' of the relationship:

• moderator: Use "moderator_invite"
• moderator_invite: modothers
• contributor: modcontributors
• banned: modcontributors
• muted: modcontributors
• wikibanned: modcontributors and modwiki
• wikicontributor: modcontributors and modwiki
• friend: Use /api/v1/me/friends/{username}
• enemy: Use /api/block

Complement to POST_unfriend

Report a user. Reporting a user brings it to the attention of a Reddit admin.

Remove a relationship between a user and another user or subreddit

The user can either be passed in by name (nuser) or by fullname (iuser). If type is friend or enemy, 'container' MUST be the current user's fullname; for other types, the subreddit must be set via URL (e.g., /r/funny/api/unfriend)

OAuth2 use requires appropriate scope based on the 'type' of the relationship:

• moderator: modothers
• moderator_invite: modothers
• contributor: modcontributors
• banned: modcontributors
• muted: modcontributors
• wikibanned: modcontributors and modwiki
• wikicontributor: modcontributors and modwiki
• friend: Use /api/v1/me/friends/{username}
• enemy: privatemessages

Complement to POST_friend

Check whether a username is available for registration.

Stop being friends with a user.

Get information about a specific 'friend', such as notes.

Create or update a "friend" relationship.

This operation is idempotent. It can be used to add a new friend, or update an existing friend (e.g., add/change the note on that friend)

{
  "name": A valid, existing reddit username,
  "note": a string no longer than 300 characters,
}

Return a list of trophies for the a given user.

Return information about the user, including karma and gold status.

This endpoint is a listing.

Allow/deny username to edit this wiki page

Edit a wiki page

Toggle the public visibility of a wiki page revision

Revert a wiki page to revision

Retrieve a list of discussions about this wiki page

This endpoint is a listing.

Retrieve a list of wiki pages in this subreddit

Retrieve a list of recently changed wiki pages in this subreddit

Retrieve a list of revisions of this wiki page

This endpoint is a listing.

Retrieve the current permission settings for page

Update the permissions and visibility of wiki page

Return the content of a wiki page

If v is given, show the wiki page as it was at that version If both v and v2 are given, show a diff of the two