### GET /live/_thread_ /about Source: https://www.reddit.com/dev/api Get some basic information about a live thread. ```APIDOC ## GET /live/_thread_ /about ### Description Get some basic information about the live thread. See also: /api/live/_thread_ /edit. ### Method GET ### Endpoint /live/_thread_ /about ``` -------------------------------- ### Comment Contribution Settings Example Source: https://www.reddit.com/dev/api Example JSON structure for configuring allowed media types in comments. This is part of the broader subreddit configuration. ```json { "allowed_media_types": [ one of (`unknown`, `giphy`, `static`, `video`, `animated`, `expression`), ... ] } ``` -------------------------------- ### Subreddit Discovery Settings Example Source: https://www.reddit.com/dev/api Example JSON structure for disabling specific subreddit discovery types. This is used within the subreddit configuration endpoint. ```json { "disabled_discovery_types": [ one of (`unknown`, `onboarding`), ... ] } ``` -------------------------------- ### GET /r/_subreddit_/about/rules Source: https://www.reddit.com/dev/api Get the rules for the current subreddit. ```APIDOC ## GET /r/_subreddit_/about/rules ### Description Get the rules for the current subreddit. ### Method GET ### Endpoint /r/_subreddit_/about/rules ``` -------------------------------- ### GET /subreddits/{where} Source: https://www.reddit.com/dev/api Get all subreddits, ordered by popularity or creation date. The `where` parameter specifies the ordering: `popular` for activity-based sorting, and `new` for sorting by creation date. ```APIDOC ## GET /subreddits/{where} ### Description Get all subreddits. The `where` parameter chooses the order in which the subreddits are displayed. ### Method GET ### Endpoint /subreddits/{where} ### Parameters #### Path Parameters - **where** (string) - Required - One of `popular`, `new`, `gold`, or `default`. #### Query Parameters - **after** (fullname) - Optional - fullname of a thing - **before** (fullname) - Optional - fullname of a thing - **count** (integer) - Optional - a positive integer (default: 0) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **show** (string) - Optional - the string `all` - **sr_detail** (boolean) - Optional - expand subreddits ``` -------------------------------- ### GET /live/_thread_ /discussions Source: https://www.reddit.com/dev/api Get a list of reddit submissions linking to a live thread. This is a listing endpoint. ```APIDOC ## GET /live/_thread_ /discussions ### Description Get a list of reddit submissions linking to this thread. _This endpoint isa listing._ See also: /api/live/_thread_ /hide_discussion. ### Method GET ### Endpoint /live/_thread_ /discussions ### Parameters #### Query Parameters - **after** (string) - Optional - fullname of a thing - **before** (string) - Optional - fullname of a thing - **count** (integer) - Optional - a positive integer (default: 0) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **show** (string) - Optional - the string `all` - **sr_detail** (boolean) - Optional - expand subreddits ``` -------------------------------- ### GET [/r/_subreddit_]/sidebar Source: https://www.reddit.com/dev/api Get the sidebar content for the current subreddit. ```APIDOC ## GET [/r/_subreddit_]/sidebar ### Description Get the sidebar for the current subreddit. ### Method GET ### Endpoint /r/_subreddit_/sidebar ``` -------------------------------- ### GET /prefs/_where_ Source: https://www.reddit.com/dev/api This endpoint is a listing endpoint for preferences, with several sub-paths available for specific preference types. ```APIDOC ## GET /prefs/_where_ ### Description This endpoint is a listing. ### Method GET ### Endpoint /prefs/_where_ ### Parameters #### Query Parameters - **after** (string) - Optional - fullname of a thing - **before** (string) - Optional - fullname of a thing - **count** (integer) - Optional - a positive integer (default: 0) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **show** (string) - Optional - the string `all` - **sr_detail** (boolean) - Optional - expand subreddits ``` -------------------------------- ### GET /live/_thread_ /contributors Source: https://www.reddit.com/dev/api Get a list of users that contribute to a live thread. ```APIDOC ## GET /live/_thread_ /contributors ### Description Get a list of users that contribute to this thread. See also: /api/live/_thread_ /invite_contributor, and /api/live/_thread_ /rm_contributor. ### Method GET ### Endpoint /live/_thread_ /contributors ``` -------------------------------- ### GET /api/v1/me/prefs Source: https://www.reddit.com/dev/api Returns the preference settings of the logged-in user. Allows specifying which preference fields to retrieve. ```APIDOC ## GET /api/v1/me/prefs ### Description Return the preference settings of the logged in user. ### Method GET ### Endpoint /api/v1/me/prefs ### Parameters #### Query Parameters - **fields** (string) - Optional - A comma-separated list of preference items to retrieve. Example: `threaded_messages,activity_relevant_ads` ``` -------------------------------- ### GET /r/_subreddit_/wiki/pageswikiread Source: https://www.reddit.com/dev/api Retrieves a list of all wiki pages within a given subreddit. ```APIDOC ## GET [/r/_subreddit_/wiki/pageswikiread] ### Description Retrieve a list of wiki pages in this subreddit. ### Method GET ### Endpoint /r/_subreddit_/wiki/pageswikiread ### Parameters #### Path Parameters - **_subreddit_** (string) - Required - The name of the subreddit. ``` -------------------------------- ### Get Wiki Page Settings Source: https://www.reddit.com/dev/api Retrieves the current permission settings for a wiki page. Requires the page name. ```json { "page": "page" } ``` -------------------------------- ### GET /api/multi/_multipath_ /descriptionread Source: https://www.reddit.com/dev/api Retrieves the markdown description of a specified multireddit. ```APIDOC ## GET /api/multi/_multipath_ /descriptionread ### Description Get a multi's description. ### Method GET ### Endpoint /api/multi/_multipath_ /descriptionread ### Parameters #### Path Parameters - **multipath** (string) - Required - Multireddit url path ``` -------------------------------- ### GET /r/_subreddit_/wiki/settings/_page_ modwiki Source: https://www.reddit.com/dev/api Retrieves the current permission settings for a specific wiki page. ```APIDOC ## GET [/r/_subreddit_/wiki/settings/_page_ modwiki] ### Description Retrieve the current permission settings for `page`. ### Method GET ### Endpoint /r/_subreddit_/wiki/settings/_page_ ### Parameters #### Path Parameters - **_subreddit_** (string) - Required - The name of the subreddit. - **_page_** (string) - Required - The name of an existing wiki page. ``` -------------------------------- ### GET /live/_thread_ /updates Source: https://www.reddit.com/dev/api Get a list of updates posted in a live thread. This is a listing endpoint. ```APIDOC ## GET /live/_thread_ /updates ### Description Get a list of updates posted in this thread. See also: /api/live/_thread_ /update. _This endpoint isa listing._ ### Method GET ### Endpoint /live/_thread_ /updates ### Parameters #### Query Parameters - **after** (string) - Optional - the ID of a single update. e.g. `LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603` - **before** (string) - Optional - the ID of a single update. e.g. `LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603` - **count** (integer) - Optional - a positive integer (default: 0) - **is_embed** (boolean) - Optional - (internal use only) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **stylesr** (string) - Optional - subreddit name ``` -------------------------------- ### GET /best Source: https://www.reddit.com/dev/api Retrieves a listing of the best content. This endpoint is useful for discovering popular or highly-rated items on Reddit. ```APIDOC ## GET /best ### Description Retrieves a listing of the best content. ### Method GET ### Endpoint /best ### Parameters #### Query Parameters - **after** (string) - Optional - fullname of a thing - **before** (string) - Optional - fullname of a thing - **count** (integer) - Optional - a positive integer (default: 0) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **show** (string) - Optional - the string `all` - **sr_detail** (boolean) - Optional - expand subreddits ``` -------------------------------- ### GET /r/_subreddit_/about Source: https://www.reddit.com/dev/api Return information about the subreddit. This includes details such as the subscriber count, description, and header image. ```APIDOC ## GET /r/_subreddit_/about ### Description Return information about the subreddit. Data includes the subscriber count, description, and header image. ### Method GET ### Endpoint /r/_subreddit_/about ``` -------------------------------- ### Get User Data by Account IDs Source: https://www.reddit.com/dev/api Retrieve user data for a comma-separated list of account fullnames. ```http GET /api/user_data_by_account_ids?ids=t2_accountid1,t2_accountid2 ``` -------------------------------- ### GET /api/v1/me Source: https://www.reddit.com/dev/api Returns the identity of the currently authenticated user. ```APIDOC ## GET /api/v1/me ### Description Returns the identity of the user. ### Method GET ### Endpoint /api/v1/me ``` -------------------------------- ### GET /subreddits/search Source: https://www.reddit.com/dev/api Search subreddits by title and description. This endpoint supports pagination and sorting by relevance or activity. ```APIDOC ## GET /subreddits/search ### Description Search subreddits by title and description. ### Method GET ### Endpoint /subreddits/search ### Parameters #### Query Parameters - **after** (fullname) - Optional - fullname of a thing - **before** (fullname) - Optional - fullname of a thing - **count** (integer) - Optional - a positive integer (default: 0) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **q** (string) - Required - a search query - **search_query_id** (uuid) - Optional - a uuid - **show** (string) - Optional - the string `all` - **show_users** (boolean) - Optional - boolean value - **sort** (string) - Optional - one of (`relevance`, `activity`) - **sr_detail** (boolean) - Optional - expand subreddits - **typeahead_active** (boolean) - Optional - boolean value or None ``` -------------------------------- ### GET /r/{subreddit}/api/flairlistmodflair Source: https://www.reddit.com/dev/api Retrieves a list of flair options available in a subreddit. This endpoint is a listing. ```APIDOC ## GET /r/{subreddit}/api/flairlistmodflair ### Description Retrieves a list of flair options available in a subreddit. This endpoint is a listing. ### Method GET ### Endpoint /r/{subreddit}/api/flairlistmodflair ### Parameters #### Query Parameters - **after** (string) - Optional - Fullname of a thing to paginate after. - **before** (string) - Optional - Fullname of a thing to paginate before. - **count** (integer) - Optional - A positive integer (default: 0). - **limit** (integer) - Optional - The maximum number of items desired (default: 25, maximum: 1000). - **name** (string) - Optional - Filter by a specific user name. - **show** (string) - Optional - The string `all`. - **sr_detail** (boolean) - Optional - Expand subreddits. ``` -------------------------------- ### GET [/r/_subreddit_]/stylesheetmodconfig Source: https://www.reddit.com/dev/api Redirect to the subreddit's stylesheet if one exists. This endpoint provides access to the subreddit's styling configuration. ```APIDOC ## GET [/r/_subreddit_]/stylesheetmodconfig ### Description Redirect to the subreddit's stylesheet if one exists. See also: /api/subreddit_stylesheet. ### Endpoint `/r/_subreddit_/stylesheet` ``` -------------------------------- ### GET /r/_subreddit_/api/widgetsstructuredstyles Source: https://www.reddit.com/dev/api Retrieves all widgets for a given subreddit. Optionally, you can specify `progressive_images` to include progressive image data. ```APIDOC ## GET [/r/_subreddit_/api/widgetsstructuredstyles] ### Description Return all widgets for the given subreddit. ### Method GET ### Endpoint /r/_subreddit_/api/widgetsstructuredstyles ### Parameters #### Path Parameters - **_subreddit_** (string) - Required - The name of the subreddit. #### Query Parameters - **progressive_images** (boolean) - Optional - Whether to include progressive image data. ``` -------------------------------- ### GET /r/_subreddit_/api/inforead Source: https://www.reddit.com/dev/api Return a listing of things specified by their fullnames. Only Links, Comments, and Subreddits are allowed. ```APIDOC ## GET /r/_subreddit_/api/inforead ### Description Return a listing of things specified by their fullnames. Only Links, Comments, and Subreddits are allowed. ### Parameters #### Query Parameters - **id** (string) - Required - A comma-separated list of thing fullnames - **sr_name** (string) - Optional - comma-delimited list of subreddit names - **url** (string) - Optional - a valid URL ``` -------------------------------- ### Get User Data by Account IDs Source: https://www.reddit.com/dev/api Retrieve user data for a given list of account fullnames. ```APIDOC ## GET /api/user_data_by_account_ids ### Description Get user data by account IDs. ### Method GET ### Endpoint /api/user_data_by_account_ids ### Parameters #### Query Parameters - **ids** (string) - Required - A comma-separated list of account fullnames ``` -------------------------------- ### GET /r/_subreddit_/wiki/revisionswikiread Source: https://www.reddit.com/dev/api Retrieves a list of recently changed wiki pages in the subreddit. Supports pagination and filtering. ```APIDOC ## GET [/r/_subreddit_/wiki/revisionswikiread] ### Description Retrieve a list of recently changed wiki pages in this subreddit. ### Method GET ### Endpoint /r/_subreddit_/wiki/revisionswikiread ### Parameters #### Path Parameters - **_subreddit_** (string) - Required - The name of the subreddit. #### Query Parameters - **after** (string) - Optional - fullname of a thing - **before** (string) - Optional - fullname of a thing - **count** (integer) - Optional - A positive integer (default: 0). - **limit** (integer) - Optional - The maximum number of items desired (default: 25, maximum: 100). - **show** (string) - Optional - The string `all`. - **sr_detail** (boolean) - Optional - Expand subreddits. ``` -------------------------------- ### Get Live Threads by ID Source: https://www.reddit.com/dev/api Retrieves a listing of live events by their IDs. This endpoint is useful for fetching specific live threads when you have their identifiers. ```APIDOC ## GET /api/live/by_id/_names_ ### Description Get a listing of live events by id. ### Parameters #### Path Parameters - **names** (string) - Required - A comma-delimited list of live thread fullnames or IDs. ``` -------------------------------- ### POST /r/_subreddit_/api/widget_image_upload_s3structuredstyles Source: https://www.reddit.com/dev/api Acquires and returns an upload lease to an S3 temporary bucket for uploading assets. The response includes credentials, the S3 URL for the upload request, and the key to use. ```APIDOC ## POST [/r/_subreddit_/api/widget_image_upload_s3structuredstyles] ### Description Acquire and return an upload lease to s3 temp bucket. The return value of this function is a json object containing credentials for uploading assets to S3 bucket, S3 url for upload request and the key to use for uploading. Using this lease the client will upload the emoji image to S3 temp bucket (included as part of the S3 URL). This lease is used by S3 to verify that the upload is authorized. ### Method POST ### Endpoint /r/_subreddit_/api/widget_image_upload_s3structuredstyles ### Parameters #### Path Parameters - **_subreddit_** (string) - Required - The name of the subreddit. #### Query Parameters - **filepath** (string) - Required - Name and extension of the image file e.g. image1.png - **mimetype** (string) - Required - Mime type of the image e.g. image/png ``` -------------------------------- ### GET /live/_thread_ /updates/{update_id} Source: https://www.reddit.com/dev/api Get details about a specific update in a live thread. ```APIDOC ## GET /live/_thread_ /updates/{update_id} ### Description Get details about a specific update in a live thread. ### Method GET ### Endpoint /live/_thread_ /updates/{update_id} ``` -------------------------------- ### GET /api/saved_categoriessave Source: https://www.reddit.com/dev/api Get a list of categories in which things are currently saved. See also: /api/save. ```APIDOC ## GET /api/saved_categoriessave ### Description Get a list of categories in which things are currently saved. See also: /api/save. ### Method GET ### Endpoint /api/saved_categoriessave ``` -------------------------------- ### Edit Live Thread Settings Source: https://www.reddit.com/dev/api Configures the settings for a live thread. This action requires the 'settings' permission for the thread and allows modification of description, NSFW status, resources, and title. ```APIDOC ## POST /api/live/_thread_ /editlivemanage ### Description Configure the thread. Requires the `settings` permission for this thread. ### Parameters #### Request Body - **api_type** (string) - Required - The string `json` - **description** (string) - Optional - Raw markdown text for the thread description. - **nsfw** (boolean) - Optional - Boolean value indicating if the thread is NSFW. - **resources** (string) - Optional - Raw markdown text for thread resources. - **title** (string) - Optional - A string no longer than 120 characters for the thread title. ### Headers - **X-Modhash** (string) - Required - A modhash value. ``` -------------------------------- ### GET /api/mod/conversationsmodmail Source: https://www.reddit.com/dev/api Get conversations for a logged-in user or subreddits. Supports filtering by after, entity, limit, sort, and state. ```APIDOC ## GET /api/mod/conversationsmodmail ### Description Get conversations for a logged in user or subreddits ### Parameters #### Query Parameters - **after** (string) - Optional - A Modmail Conversation ID, in the form ModmailConversation_. - **entity** (string) - Required - Comma-delimited list of subreddit names. - **limit** (integer) - Optional - An integer between 1 and 100 (default: 25). - **sort** (string) - Optional - One of (`recent`, `mod`, `user`, `unread`). - **state** (string) - Optional - One of (`all`, `appeals`, `notifications`, `inbox`, `filtered`, `inprogress`, `mod`, `archived`, `default`, `highlighted`, `admin`, `join_requests`, `new`). ``` -------------------------------- ### Invite User to Contribute to Live Thread Source: https://www.reddit.com/dev/api Invites another user to contribute to a live thread. Requires 'manage' permission. The invited user can be granted specific permissions upon accepting. ```APIDOC ## POST /api/live/_thread_ /invite_contributorlivemanage ### Description 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. ### Parameters #### Request Body - **api_type** (string) - Required - The string `json` - **name** (string) - Required - The name of an existing user. - **permissions** (string) - Required - Permission description e.g. `+update,+edit,-manage` - **type** (string) - Required - One of (`liveupdate_contributor_invite`, `liveupdate_contributor`) ### Headers - **X-Modhash** (string) - Required - A modhash value. ``` -------------------------------- ### Configure Subreddit Settings Source: https://www.reddit.com/dev/api This endpoint allows for the creation or modification of subreddit settings. All current settings must be provided in the request, even if only a subset is being changed. Consider fetching current settings first if modifying. ```http POST /api/site_adminmodconfig ``` -------------------------------- ### POST /api/set_subreddit_stickymodposts Source: https://www.reddit.com/dev/api 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. ```APIDOC ## POST /api/set_subreddit_stickymodposts ### Description 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. ### Method POST ### Endpoint /api/set_subreddit_stickymodposts ### Parameters #### Query Parameters - **api_type** (string) - Description: the string `json` - **id** (string) - **num** (integer) - Description: an integer between 1 and 4 - **state** (boolean) - Description: boolean value - **to_profile** (boolean) - Description: boolean value ### Headers - **X-Modhash** (string) - Description: a modhash ``` -------------------------------- ### GET /r/_subreddit_/about/editmodconfig Source: https://www.reddit.com/dev/api Get the current settings of a subreddit. This endpoint returns the current settings as used by /api/site_admin and displays a form for editing the subreddit on the HTML site. ```APIDOC ## GET /r/_subreddit_/about/editmodconfig ### Description 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. ### Method GET ### Endpoint /r/_subreddit_/about/editmodconfig ### Parameters #### Query Parameters - **created** (boolean) - Optional - one of (`true`, `false`) - **location** (string) - Optional ``` -------------------------------- ### GET /subreddits/mine/{where} Source: https://www.reddit.com/dev/api Get subreddits the user has a relationship with. The `where` parameter filters the results to show subreddits the user is subscribed to, is a contributor in, is a moderator of, or that contain hosted video links. ```APIDOC ## GET /subreddits/mine/{where} ### Description Get subreddits the user has a relationship with. The `where` parameter chooses which subreddits are returned. ### Method GET ### Endpoint /subreddits/mine/{where} ### Parameters #### Path Parameters - **where** (string) - Required - One of `subscriber`, `contributor`, `moderator`, or `streams`. #### Query Parameters - **after** (fullname) - Optional - fullname of a thing - **before** (fullname) - Optional - fullname of a thing - **count** (integer) - Optional - a positive integer (default: 0) - **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100) - **show** (string) - Optional - the string `all` - **sr_detail** (boolean) - Optional - expand subreddits ``` -------------------------------- ### GET /r/_subreddit_/about/traffic Source: https://www.reddit.com/dev/api Retrieve traffic configuration information for a subreddit. ```APIDOC ## GET /r/_subreddit_/about/traffic ### Description Retrieve traffic configuration information for a subreddit. ### Method GET ### Endpoint /r/_subreddit_/about/traffic ``` -------------------------------- ### POST /r/{subreddit}/api/flairconfigmodflair Source: https://www.reddit.com/dev/api Configures flair settings for a subreddit, including enabling/disabling flair, setting positions, and controlling self-assignment. ```APIDOC ## POST /r/{subreddit}/api/flairconfigmodflair ### Description Configures flair settings for a subreddit. ### Method POST ### Endpoint /r/{subreddit}/api/flairconfigmodflair ### Parameters #### Query Parameters - **api_type** (string) - Required - The string `json`. - **flair_enabled** (boolean) - Required - Enables or disables flair. - **flair_position** (string) - Optional - One of (`left`, `right`). - **flair_self_assign_enabled** (boolean) - Optional - Enables or disables self-assignable flair. - **link_flair_position** (string) - Optional - One of (``, `left`, `right`). - **link_flair_self_assign_enabled** (boolean) - Optional - Enables or disables self-assignable link flair. ### Headers - **X-Modhash** - Required - A modhash value. ``` -------------------------------- ### Create New Live Thread Source: https://www.reddit.com/dev/api Creates a new live thread. After creation, the thread's settings can be modified, and updates can be posted using other API endpoints. ```APIDOC ## POST /api/live/createsubmit ### Description 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. ### Parameters #### Request Body - **api_type** (string) - Required - The string `json` - **description** (string) - Required - Raw markdown text for the thread description. - **nsfw** (boolean) - Required - Boolean value indicating if the thread is NSFW. - **resources** (string) - Required - Raw markdown text for thread resources. - **title** (string) - Required - A string no longer than 120 characters for the thread title. ### Headers - **X-Modhash** (string) - Required - A modhash value. ``` -------------------------------- ### GET /api/search_reddit_names Source: https://www.reddit.com/dev/api Lists subreddit names that begin with a query string. ```APIDOC ## GET /api/search_reddit_names ### Description Lists subreddit names that begin with a specified query string. Allows filtering by over-18 content and unadvertisable subreddits. ### Method GET ### Endpoint /api/search_reddit_names ### Parameters #### Query Parameters - **query** (string) - Required - The string to search subreddit names for (up to 50 characters). - **exact** (boolean) - Optional - If true, only an exact match will be returned. - **include_over_18** (boolean) - Optional - Whether to include subreddits with over-18 content restrictions. - **include_unadvertisable** (boolean) - Optional - Whether to include subreddits that are hidden from ads. - **search_query_id** (uuid) - Optional - A unique identifier for the search query. - **typeahead_active** (boolean) - Optional - Indicates if typeahead is active. ``` -------------------------------- ### POST /api/site_adminmodconfig Source: https://www.reddit.com/dev/api Creates or configures a subreddit. This endpoint allows for comprehensive modification of subreddit settings, including content restrictions, display options, and moderation tools. ```APIDOC ## POST /api/site_adminmodconfig ### Description 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. ### Method POST ### Endpoint /api/site_adminmodconfig ### Parameters #### Path Parameters - **sr** (fullname) - Optional - Fullname of the subreddit to modify. #### Query Parameters - **name** (string) - Optional - Subreddit name to create if `sr` is not specified. - **api_type** (string) - Required - The string `json`. - **uh / X-Modhash header** (string) - Required - A modhash. #### Request Body - **accept_followers** (boolean) - Optional - - **admin_override_spam_comments** (boolean) - Optional - - **admin_override_spam_links** (boolean) - Optional - - **admin_override_spam_selfposts** (boolean) - Optional - - **all_original_content** (boolean) - Optional - - **allow_chat_post_creation** (boolean) - Optional - - **allow_discovery** (boolean) - Optional - - **allow_galleries** (boolean) - Optional - - **allow_images** (boolean) - Optional - - **allow_polls** (boolean) - Optional - - **allow_post_crossposts** (boolean) - Optional - - **allow_prediction_contributors** (boolean) - Optional - - **allow_predictions** (boolean) - Optional - - **allow_predictions_tournament** (boolean) - Optional - - **allow_talks** (boolean) - Optional - - **allow_top** (boolean) - Optional - - **allow_videos** (boolean) - Optional - - **collapse_deleted_comments** (boolean) - Optional - - **comment_contribution_settings** (json) - Optional - - **comment_score_hide_mins** (integer) - Optional - An integer between 0 and 1440 (default: 0). - **crowd_control_chat_level** (integer) - Optional - An integer between 0 and 3. - **crowd_control_filter** (boolean) - Optional - - **crowd_control_level** (integer) - Optional - An integer between 0 and 3. - **crowd_control_mode** (boolean) - Optional - - **crowd_control_post_level** (integer) - Optional - An integer between 0 and 3. - **description** (string) - Optional - Raw markdown text for the sidebar. - **disable_contributor_requests** (boolean) - Optional - - **exclude_banned_modqueue** (boolean) - Optional - - **free_form_reports** (boolean) - Optional - - **g-recaptcha-response** (string) - Optional - - **hateful_content_threshold_abuse** (integer) - Optional - An integer between 0 and 3. - **hateful_content_threshold_identity** (integer) - Optional - An integer between 0 and 3. - **header-title** (string) - Optional - A string no longer than 500 characters. - **hide_ads** (boolean) - Optional - - **key_color** (string) - Optional - A 6-digit rgb hex color, e.g. `#AABBCC`. - **link_type** (string) - Optional - One of (`any`, `link`, `self`). - **modmail_harassment_filter_enabled** (boolean) - Optional - - **new_pinned_post_pns_enabled** (boolean) - Optional - - **original_content_tag_enabled** (boolean) - Optional - - **over_18** (boolean) - Optional - - **prediction_leaderboard_entry_type** (integer) - Optional - An integer between 0 and 2. - **public_description** (string) - Optional - Raw markdown text for the public description. - **restrict_commenting** (boolean) - Optional - - **restrict_posting** (boolean) - Optional - - **should_archive_posts** (boolean) - Optional - - **show_media** (boolean) - Optional - - **show_media_preview** (boolean) - Optional - - **spam_comments** (string) - Optional - One of (`low`, `high`, `all`). - **spam_links** (string) - Optional - One of (`low`, `high`, `all`). - **spam_selfposts** (string) - Optional - One of (`low`, `high`, `all`). - **spoilers_enabled** (boolean) - Optional - - **submit_link_label** (string) - Optional - A string no longer than 60 characters. - **submit_text** (string) - Optional - Raw markdown text. - **submit_text_label** (string) - Optional - A string no longer than 60 characters. - **subreddit_discovery_settings** (json) - Optional - - **suggested_comment_sort** (string) - Optional - One of (`confidence`, `top`, `new`, `controversial`, `old`, `random`, `qa`, `live`). - **title** (string) - Optional - A string no longer than 100 characters. - **toxicity_threshold_chat_level** (integer) - Optional - An integer between 0 and 1. - **type** (string) - Optional - One of (`gold_restricted`, `archived`, `restricted`, `private`, `employees_only`, `gold_only`, `public`, `user`). - **user_flair_pns_enabled** (boolean) - Optional - - **welcome_message_enabled** (boolean) - Optional - - **welcome_message_text** (string) - Optional - Raw markdown text. - **wiki_edit_age** (integer) - Optional - An integer between 0 and 36600 (default: 0). - **wiki_edit_karma** (integer) - Optional - An integer between 0 and 1000000000 (default: 0). - **wikimode** (string) - Optional - One of (`disabled`, `modonly`, `anyone`). ### Request Example ```json { "name": "newsubreddit", "public_description": "Welcome to the new subreddit!", "over_18": false, "api_type": "json" } ``` ### Response #### Success Response (200) - **json** (object) - Contains the result of the operation. #### Response Example ```json { "json": { "errors": [] } } ``` ``` -------------------------------- ### POST /r/{subreddit}/api/flairtemplatemodflair Source: https://www.reddit.com/dev/api Creates or updates a flair template for a subreddit. ```APIDOC ## POST /r/{subreddit}/api/flairtemplatemodflair ### Description Creates or updates a flair template for a subreddit. ### Method POST ### Endpoint /r/{subreddit}/api/flairtemplatemodflair ### Parameters #### Query Parameters - **api_type** (string) - Required - The string `json`. - **css_class** (string) - Optional - A valid subreddit image name. - **flair_template_id** (string) - Optional - The ID of the flair template to update. - **flair_type** (string) - Required - One of (`USER_FLAIR`, `LINK_FLAIR`). - **text** (string) - Required - A string no longer than 64 characters. - **text_editable** (boolean) - Optional - Whether the flair text is editable. ### Headers - **X-Modhash** - Required - A modhash value. ``` -------------------------------- ### GET /api/needs_captcha Source: https://www.reddit.com/dev/api Checks whether ReCAPTCHAs are needed for API methods. ```APIDOC ## GET /api/needs_captcha ### Description Check whether ReCAPTCHAs are needed for API methods. ### Method GET ### Endpoint /api/needs_captcha ``` -------------------------------- ### POST /api/marknsfwmodposts Source: https://www.reddit.com/dev/api Mark a link NSFW. See also: /api/unmarknsfw. ```APIDOC ## POST /api/marknsfwmodposts ### Description Mark a link NSFW. See also: /api/unmarknsfw. ### Parameters #### Query Parameters - **id** (string) - Required - fullname of a thing ### Headers - **X-Modhash** (string) - Required - a modhash ``` -------------------------------- ### GET /api/recommend/sr/{srnames} Source: https://www.reddit.com/dev/api DEPRECATED: Returns subreddits recommended for the given subreddit(s). ```APIDOC ## GET /api/recommend/sr/{srnames} ### Description DEPRECATED: Returns a list of subreddits recommended for the specified subreddit(s), filtering out any listed in the `omit` parameter. ### Method GET ### Endpoint /api/recommend/sr/{srnames} ### Parameters #### Query Parameters - **srnames** (string) - Required - A comma-delimited list of subreddit names. - **omit** (string) - Optional - A comma-delimited list of subreddit names to exclude from recommendations. - **over_18** (boolean) - Optional - Whether to include over-18 subreddits in recommendations. ``` -------------------------------- ### POST /api/v1/{subreddit}/emoji_asset_upload_s3.json Source: https://www.reddit.com/dev/api Acquires and returns an upload lease to the S3 temporary bucket for uploading emoji assets. Provides credentials and URL for the upload. ```APIDOC ## POST /api/v1/{subreddit}/emoji_asset_upload_s3.json ### Description Acquire and return an upload lease to s3 temp bucket. The return value of this function is a json object containing credentials for uploading assets to S3 bucket, S3 url for upload request and the key to use for uploading. Using this lease the client will upload the emoji image to S3 temp bucket (included as part of the S3 URL). This lease is used by S3 to verify that the upload is authorized. ### Method POST ### Endpoint /api/v1/{subreddit}/emoji_asset_upload_s3.json ### Parameters #### Request Body - **filepath** (string) - Required - name and extension of the image file e.g. image1.png - **mimetype** (string) - Required - mime type of the image e.g. image/png ``` -------------------------------- ### GET /api/multi/_multipath_ read Source: https://www.reddit.com/dev/api Fetches the data and subreddit list for a specified multireddit. ```APIDOC ## GET /api/multi/_multipath_ read ### Description Fetch a multi's data and subreddit list by name. ### Method GET ### Endpoint /api/multi/_multipath_ read ### Parameters #### Path Parameters - **multipath** (string) - Required - Multireddit url path #### Query Parameters - **expand_srs** (boolean) - Optional ``` -------------------------------- ### GET /api/multi/mineread Source: https://www.reddit.com/dev/api Fetches a list of multireddits belonging to the current authenticated user. ```APIDOC ## GET /api/multi/mineread ### Description Fetch a list of multis belonging to the current user. ### Method GET ### Endpoint /api/multi/mineread ### Parameters #### Query Parameters - **expand_srs** (boolean) - Optional ``` -------------------------------- ### POST /api/multi/_multipath_ subscribe Source: https://www.reddit.com/dev/api Creates a new multireddit. Responds with 409 Conflict if it already exists. ```APIDOC ## POST /api/multi/_multipath_ subscribe ### Description Create a multi. Responds with 409 Conflict if it already exists. ### Method POST ### Endpoint /api/multi/_multipath_ subscribe ### Parameters #### Path Parameters - **multipath** (string) - Required - Multireddit url path #### Request Body - **description_md** (string) - Optional - Raw markdown text - **display_name** (string) - Optional - A string no longer than 50 characters - **icon_img** (string) - Optional - One of (`png`, `jpg`, `jpeg`) - **key_color** (string) - Optional - A 6-digit rgb hex color, e.g. `#AABBCC` - **subreddits** (array) - Optional - An array of subreddit objects, each with a `name` field. - **visibility** (string) - Optional - One of (`private`, `public`, `hidden`) ### Headers - **X-Modhash** (string) - Required - A modhash #### Query Parameters - **expand_srs** (boolean) - Optional ``` -------------------------------- ### GET /api/v1/me/trophies Source: https://www.reddit.com/dev/api Retrieves a list of trophies associated with the currently authenticated user. ```APIDOC ## GET /api/v1/me/trophies ### Description Return a list of trophies for the current user. ### Method GET ### Endpoint /api/v1/me/trophies ``` -------------------------------- ### Get User Trophies Source: https://www.reddit.com/dev/api Retrieve a list of trophies associated with a given Reddit user. ```APIDOC ## GET /api/v1/user/{username}/trophies ### Description Return a list of trophies for the a given user. ### Method GET ### Endpoint /api/v1/user/{username}/trophies ### Parameters #### Path Parameters - **username** (string) - Required - A valid, existing reddit username ``` -------------------------------- ### POST /api/multi/copysubscribe Source: https://www.reddit.com/dev/api Copies an existing multireddit to a new one. A "copied from ..." line is automatically appended to the description of the new multireddit. ```APIDOC ## POST /api/multi/copysubscribe ### Description Copy a multi. Responds with 409 Conflict if the target already exists. A "copied from ..." line will automatically be appended to the description. ### Method POST ### Endpoint /api/multi/copysubscribe ### Parameters #### Request Body - **description_md** (string) - Required - Raw markdown text - **display_name** (string) - Required - A string no longer than 50 characters - **expand_srs** (boolean) - Optional - **from** (string) - Required - Multireddit url path - **to** (string) - Required - Destination multireddit url path ### Headers - **X-Modhash** (string) - Required - A modhash ``` -------------------------------- ### Get User Trophies Source: https://www.reddit.com/dev/api Retrieve a list of trophies associated with a given Reddit user. ```http GET /api/v1/user/USERNAME/trophies ``` -------------------------------- ### Get Wiki Page Content Source: https://www.reddit.com/dev/api Retrieves the content of a wiki page. Optionally, specific revisions can be fetched using 'v' or 'v2' parameters to show content or a diff. ```json { "page": "page", "v": "a wiki revision ID", "v2": "a wiki revision ID" } ``` -------------------------------- ### GET /api/multi/_multipath_ /r/_srname_ read Source: https://www.reddit.com/dev/api Retrieves data about a specific subreddit within a multireddit. ```APIDOC ## GET /api/multi/_multipath_ /r/_srname_ read ### Description Get data about a subreddit in a multi. ### Method GET ### Endpoint /api/multi/_multipath_ /r/_srname_ read ### Parameters #### Path Parameters - **multipath** (string) - Required - Multireddit url path - **srname** (string) - Required - Subreddit name ``` -------------------------------- ### GET /api/multi/user/_username_ read Source: https://www.reddit.com/dev/api Fetches a list of public multireddits belonging to a specified user. ```APIDOC ## GET /api/multi/user/_username_ read ### Description Fetch a list of public multis belonging to `username` ### Method GET ### Endpoint /api/multi/user/_username_ read ### Parameters #### Path Parameters - **username** (string) - Required - A valid, existing reddit username #### Query Parameters - **expand_srs** (boolean) - Optional ``` -------------------------------- ### Accept Live Thread Contributor Invite Source: https://www.reddit.com/dev/api Accepts a pending invitation to contribute to a live thread. This allows the user to post updates or manage the thread based on the invite permissions. ```APIDOC ## POST /api/live/_thread_ /accept_contributor_invitelivemanage ### Description Accept a pending invitation to contribute to the thread. ### Parameters #### Request Body - **api_type** (string) - Required - The string `json` ### Headers - **X-Modhash** (string) - Required - A modhash value. ``` -------------------------------- ### GET /api/mod/notes/recentmodnote Source: https://www.reddit.com/dev/api Fetches the most recent moderator notes for specified subreddit and user pairs. ```APIDOC ## GET /api/mod/notes/recentmodnote ### Description Fetch the most recent notes written by a moderator. Both parameters should be comma separated lists of equal lengths. The first subreddit will be paired with the first account to represent a query for a mod written note for that account in that subreddit and so forth for all subsequent pairs of subreddits and accounts. This request accepts up to 500 pairs of subreddit names and usernames. Parameters should be passed as query parameters. The response will be a list of mod notes in the order that subreddits and accounts were given. If no note exist for a given subreddit/account pair, then null will take its place in the list. ### Method GET ### Endpoint /api/mod/notes/recentmodnote ### Parameters #### Query Parameters - **subreddits** (string) - Required - A comma delimited list of subreddits by name - **users** (string) - Required - A comma delimited list of usernames ```