Reddit API

https://www.reddit.com/dev/api
Admin
The Reddit API provides programmatic access to Reddit's features, allowing developers to interact...
Tokens:50,097
Snippets:314
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/me/prefs

Source: https://www.reddit.com/dev/api

Retrieves the preference settings for the logged-in user.

```APIDOC
## GET /api/v1/me/prefs

### Description
Return the preference settings of the logged in user

### Method
GET

### Endpoint
/api/v1/me/prefs

### Query Parameters
#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of items from the available set of preferences.
```

--------------------------------

### GET /live/_thread_ /about

Source: https://www.reddit.com/dev/api

Retrieves 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
```

--------------------------------

### GET /api/multi/_multipath_ /descriptionread

Source: https://www.reddit.com/dev/api

Retrieves the description of a multi-reddit.

```APIDOC
## GET /api/multi/_multipath_ /descriptionread

### Description
Get a multi's description.

### Parameters
#### Path Parameters
- **multipath** (string) - multireddit url path
```

--------------------------------

### Get Widgets

Source: https://www.reddit.com/dev/api

Retrieves all widgets for a given subreddit.

```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 images.
```

--------------------------------

### GET /r/_subreddit_/api/info

Source: https://www.reddit.com/dev/api

Returns a listing of things specified by their fullnames.

```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 /api/live/happening_now

Source: https://www.reddit.com/dev/api

Retrieves basic information about the currently featured live thread.

```APIDOC
## GET /api/live/happening_now

### Description
Retrieves 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`.

### Method
GET

### Endpoint
/api/live/happening_now

### Parameters
#### Query Parameters
- **show_announcements** (boolean) - Required - boolean value
```

--------------------------------

### Get Wiki Page Settings

Source: https://www.reddit.com/dev/api

Retrieves the current permission settings for a 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 Wiki Pages

Source: https://www.reddit.com/dev/api

Retrieves a list of all wiki pages in a 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 /api/live/by_id/{names}

Source: https://www.reddit.com/dev/api

Retrieves a listing of live threads by their IDs.

```APIDOC
## GET /api/live/by_id/{names}

### Description
Retrieves a listing of live threads by their IDs.

### Method
GET

### Endpoint
/api/live/by_id/{names}

### Parameters
#### Path Parameters
- **names** (string) - Required - a comma-delimited list of live thread fullnames or IDs
```

--------------------------------

### GET /best

Source: https://www.reddit.com/dev/api

Retrieves a listing of the best posts. Supports pagination and filtering. This endpoint is a listing.

```APIDOC
## GET /best

### Description
This endpoint is a listing. Retrieves a listing of the best posts. Supports pagination and filtering.

### 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 /duplicates/{article}

Source: https://www.reddit.com/dev/api

Returns a list of other submissions of the same URL. This endpoint is a listing.

```APIDOC
## GET /duplicates/{article}

### Description
Return a list of other submissions of the same URL. This endpoint is a listing.

### Method
GET

### Endpoint
/duplicates/{article}

### Parameters
#### Path Parameters
- **article** (string) - Required - The base 36 ID of a Link

#### Query Parameters
- **after** (string) - Optional - fullname of a thing
- **before** (string) - Optional - fullname of a thing
- **count** (integer) - Optional - a positive integer (default: 0)
- **crossposts_only** (boolean) - Optional - boolean value
- **limit** (integer) - Optional - the maximum number of items desired (default: 25, maximum: 100)
- **show** (string) - Optional - the string `all`

### Headers
- **X-Modhash**: a modhash
```

--------------------------------

### GET /users/_where_

Source: https://www.reddit.com/dev/api

Retrieves a list of users, ordered by 'popular' or 'new'. Supports pagination and optional details.

```APIDOC
## GET /users/_where_

### Description
Get all user subreddits. The `where` parameter chooses the order in which the subreddits are displayed.

### Method
GET

### Endpoint
/users/_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 /api/v1/me

Source: https://www.reddit.com/dev/api

Returns the identity of the logged-in user.

```APIDOC
## GET /api/v1/me

### Description
Returns the identity of the user.

### Method
GET

### Endpoint
/api/v1/me
```

--------------------------------

### GET /api/multi/mineread

Source: https://www.reddit.com/dev/api

Fetches a list of multi-reddits belonging to the current user.

```APIDOC
## GET /api/multi/mineread

### Description
Fetch a list of multis belonging to the current user.

### Parameters
#### Query Parameters
- **expand_srs** (boolean) - boolean value
```

--------------------------------

### GET /r/_subreddit_ /about/rulesread

Source: https://www.reddit.com/dev/api

Fetches the rules for a specific subreddit.

```APIDOC
## GET /r/_subreddit_ /about/rulesread

### Description
Retrieves the rules for the specified subreddit.

### Method
GET

### Endpoint
/r/_subreddit_ /about/rulesread

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.
```

--------------------------------

### GET /users/search

Source: https://www.reddit.com/dev/api

Searches for user profiles by title and description. Supports pagination and sorting by relevance or activity.

```APIDOC
## GET /users/search

### Description
Search user profiles by title and description.

### Method
GET

### Endpoint
/users/search

### 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)
- **q** (string) - Required - a search query
- **search_query_id** (uuid) - Optional - a uuid
- **show** (string) - Optional - the string `all`
- **sort** (string) - Optional - one of (`relevance`, `activity`)
- **sr_detail** (boolean) - Optional - expand subreddits
- **typeahead_active** (boolean) - Optional - boolean value or None
```

--------------------------------

### Get Wiki Page Discussions

Source: https://www.reddit.com/dev/api

Retrieves a list of discussions about a specific wiki page.

```APIDOC
## GET [/r/_subreddit_]/wiki/discussions/_page_ wikiread

### Description
Retrieve a list of discussions about this wiki `page`

### Method
GET

### Endpoint
[/r/_subreddit_]/wiki/discussions/_page_

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.
- **_page_** (string) - Required - The name of an existing wiki page.

#### 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 /api/multi/_multipath_ read

Source: https://www.reddit.com/dev/api

Fetches data and subreddit list for a multi-reddit by its path.

```APIDOC
## GET /api/multi/_multipath_ read

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

### Parameters
#### Path Parameters
- **multipath** (string) - multireddit url path

#### Query Parameters
- **expand_srs** (boolean) - boolean value
```

--------------------------------

### Get Wiki Page Revisions

Source: https://www.reddit.com/dev/api

Retrieves a list of revisions for a specific wiki page.

```APIDOC
## GET [/r/_subreddit_]/wiki/revisions/_page_ wikiread

### Description
Retrieve a list of revisions of this wiki `page`

### Method
GET

### Endpoint
[/r/_subreddit_]/wiki/revisions/_page_

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.
- **_page_** (string) - Required - The name of an existing wiki page.

#### 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 /subreddits/_where_

Source: https://www.reddit.com/dev/api

Retrieves a list of subreddits, ordered by 'popular' or 'new'. Supports pagination and optional details.

```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
#### 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 /subreddits/search

Source: https://www.reddit.com/dev/api

Searches for subreddits by title and description. 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** (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)
- **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 User About Information

Source: https://www.reddit.com/dev/api

Fetches basic information about a user, including their karma and gold status. The 'username' parameter specifies the target user.

```http
GET /user/_username_ /aboutread
username: the name of an existing user
```

--------------------------------

### GET /by_id/{names}

Source: https://www.reddit.com/dev/api

Retrieves a listing of links by their fullnames. The `names` parameter should be a list of link fullnames separated by commas or spaces.

```APIDOC
## GET /by_id/{names}

### Description
Get a listing of links by fullname. `names` is a list of fullnames for links separated by commas or spaces.

### Method
GET

### Endpoint
/by_id/{names}

### Parameters
#### Path Parameters
- **names** (string) - Required - A comma-separated list of link fullnames.

### Headers
- **X-Modhash**: a modhash
```

--------------------------------

### Get Wiki Page Content

Source: https://www.reddit.com/dev/api

Retrieves the content of a wiki page. Can also show a diff between two revisions.

```APIDOC
## GET [/r/_subreddit_]/wiki/_page_ wikiread

### Description
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.

### Method
GET

### Endpoint
[/r/_subreddit_]/wiki/_page_

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.
- **_page_** (string) - Required - The name of an existing wiki page.

#### Query Parameters
- **v** (string) - Optional - A wiki revision ID.
- **v2** (string) - Optional - A wiki revision ID.
```

--------------------------------

### GET /r/{subreddit}/new

Source: https://www.reddit.com/dev/api

Retrieves a listing of 'new' posts from a specified subreddit. Supports RSS.

```APIDOC
## GET /r/{subreddit}/new

### Description
Retrieves a listing of 'new' posts from a specified subreddit. Supports RSS.

### Method
GET

### Endpoint
/r/{subreddit}/new

### 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/{location}

Source: https://www.reddit.com/dev/api

Return a listing of posts relevant to moderators, categorized by location.

```APIDOC
## GET /r/{subreddit}/about/{location}

### Description
Return a listing of posts relevant to moderators, categorized by location.

### Method
GET

### Endpoint
/r/{subreddit}/about/{location}

### Parameters
#### Path Parameters
- **location** (string) - Required - Specifies the type of listing. Can be one of: `reports`, `spam`, `modqueue`, `unmoderated`, `edited`.
```

--------------------------------

### GET /live/_thread_ /discussions/ /rss

Source: https://www.reddit.com/dev/api

Retrieves a list of Reddit submissions linking to a live thread, presented in RSS format.

```APIDOC
## GET /live/_thread_ /discussions/ /rss

### Description
Get a list of reddit submissions linking to this thread.
_This endpoint is a listing._

### Method
GET

### Endpoint
/live/_thread_ /discussions/ /rss

### 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_ read

Source: https://www.reddit.com/dev/api

Retrieves a list of updates posted in a live thread. This endpoint is a listing.

```APIDOC
## GET /live/_thread_ read

### 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_/read

### Parameters
#### Query Parameters
- **after** (string) - Optional - the ID of a single update. e.g. `LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603`
```

--------------------------------

### GET /r/_subreddit_ /aboutread

Source: https://www.reddit.com/dev/api

Retrieves general information about a subreddit, including its subscriber count, description, and header image.

```APIDOC
## GET /r/_subreddit_ /aboutread

### Description
Returns information about the subreddit, including subscriber count, description, and header image.

### Method
GET

### Endpoint
/r/_subreddit_ /aboutread

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.
```

--------------------------------

### GET [/r/_subreddit_]/stickyread

Source: https://www.reddit.com/dev/api

Retrieves one of the posts that are stickied in the current subreddit. Defaults to the top sticky post.

```APIDOC
## GET [/r/_subreddit_]/stickyread

### Description
Retrieves a sticky post from the specified subreddit. By default, it returns the top sticky post (num=1). Returns 404 if no sticky post exists.

### Method
GET

### Endpoint
/r/_subreddit_ /stickyread

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.

#### Query Parameters
- **num** (integer) - Optional - The sticky post number to retrieve (1 or 2). Defaults to 1.
```

--------------------------------

### GET /r/{subreddit}/about/log/modlog

Source: https://www.reddit.com/dev/api

Get a list of recent moderation actions within a subreddit. This endpoint provides a view of the moderation log with filtering capabilities.

```APIDOC
## GET /r/{subreddit}/about/log/modlog

### Description
Get a list of recent moderation actions within a subreddit. This endpoint provides a view of the moderation log with filtering capabilities.

### Method
GET

### Endpoint
/r/{subreddit}/about/log/modlog

### Parameters
#### Query Parameters
- **after** (string) - Optional - A ModAction ID.
- **before** (string) - Optional - A ModAction ID.
- **count** (integer) - Optional - A positive integer (default: 0).
- **limit** (integer) - Optional - The maximum number of items desired (default: 25, maximum: 500).
- **mod** (string) - Optional - A comma-delimited list of moderator names or the string `a` for admin actions.
- **show** (string) - Optional - The string `all`.
- **sr_detail** (boolean) - Optional - Expand subreddits.
- **type** (string) - Optional - One of the following values: `banuser`, `unbanuser`, `spamlink`, `removelink`, `approvelink`, `spamcomment`, `removecomment`, `approvecomment`, `addmoderator`, `showcomment`, `invitemoderator`, `uninvitemoderator`, `acceptmoderatorinvite`, `removemoderator`, `addcontributor`, `removecontributor`, `editsettings`, `editflair`, `distinguish`, `marknsfw`, `wikibanned`, `wikicontributor`, `wikiunbanned`, `wikipagelisted`, `removewikicontributor`, `wikirevise`, `wikipermlevel`, `ignorereports`, `unignorereports`, `setpermissions`, `setsuggestedsort`, `sticky`, `unsticky`, `setcontestmode`, `unsetcontestmode`, `lock`, `unlock`, `muteuser`, `unmuteuser`, `createrule`, `editrule`, `reorderrules`, `deleterule`, `spoiler`, `unspoiler`, `modmail_enrollment`, `community_status`, `community_styling`, `community_welcome_page`, `community_widgets`, `markoriginalcontent`, `collections`, `events`, `hidden_award`, `add_community_topics`, `remove_community_topics`, `create_scheduled_post`, `edit_scheduled_post`, `delete_scheduled_post`, `submit_scheduled_post`, `edit_comment_requirements`, `edit_post_requirements`, `invitesubscriber`, `submit_content_rating_survey`, `adjust_post_crowd_control_level`, `enable_post_crowd_control_filter`, `disable_post_crowd_control_filter`, `deleteoverriddenclassification`, `overrideclassification`, `reordermoderators`, `request_assistance`, `snoozereports`, `unsnoozereports`, `addnote`, `deletenote`, `addremovalreason`, `createremovalreason`, `updateremovalreason`, `deleteremovalreason`, `reorderremovalreason`, `dev_platform_app_changed`, `dev_platform_app_disabled`, `dev_platform_app_enabled`, `dev_platform_app_installed`, `dev_platform_app_uninstalled`, `edit_saved_response`, `chat_approve_message`, `chat_remove_message`, `chat_ban_user`, `chat_unban_user`, `chat_invite_host`, `chat_remove_host`, `approve_award`.
```

--------------------------------

### Create a Multi

Source: https://www.reddit.com/dev/api

Use this endpoint to create a new multi. It requires a display name, and can optionally include a description, icon, key color, subreddits, and visibility settings. Responds with 409 Conflict if the multi already exists.

```json
{
  "description_md": "raw markdown text",
  "display_name": "a string no longer than 50 characters",
  "icon_img": "one of (png, jpg, jpeg)",
  "key_color": "a 6-digit rgb hex color, e.g. `#AABBCC`",
  "subreddits": [
    {
      "name": "subreddit name"
    },
    ...
  ],
  "visibility": "one of (private, public, hidden)"
}
```

--------------------------------

### POST /api/live/create

Source: https://www.reddit.com/dev/api

Creates a new live thread. The initial settings can be modified later.

```APIDOC
## POST /api/live/create

### Description
Creates 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`.

### Method
POST

### Endpoint
/api/live/create

### Parameters
#### Query Parameters
- **api_type** (string) - Required - the string `json`
- **description** (string) - Required - raw markdown text
- **nsfw** (boolean) - Required - boolean value
- **resources** (string) - Required - raw markdown text
- **title** (string) - Required - a string no longer than 120 characters

### Headers
- **X-Modhash** - Required - a modhash
```

--------------------------------

### GET /api/recommend/sr/_srnames_ read

Source: https://www.reddit.com/dev/api

DEPRECATED: Returns 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.

```APIDOC
## GET /api/recommend/sr/_srnames_ read

### Description
DEPRECATED: Returns 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.

### Method
GET

### Endpoint
/api/recommend/sr/_srnames_ read

### Parameters
#### Query Parameters
- **srnames** (string) - Required - Comma-delimited list of subreddit names.
- **omit** (string) - Optional - Comma-delimited list of subreddit names.
- **over_18** (boolean) - Optional - Boolean value to filter by over 18 content.
```

--------------------------------

### POST /api/live/_thread_ /edit

Source: https://www.reddit.com/dev/api

Configures a live thread. Requires the `settings` permission for this thread.

```APIDOC
## POST /api/live/_thread_ /edit

### Description
Configure the thread.
Requires the `settings` permission for this thread.
See also: /live/_thread_ /about.json.

### Method
POST

### Endpoint
/api/live/_thread_/edit

### Parameters
#### Request Body
- **description** (string) - Optional - raw markdown text
- **nsfw** (boolean) - Optional - boolean value
- **resources** (string) - Optional - raw markdown text
- **title** (string) - Optional - a string no longer than 120 characters
#### Headers
- **api_type** (string) - Required - the string `json`
- **X-Modhash** (string) - Required - a modhash
```

--------------------------------

### GET /r/{subreddit}/{sort}

Source: https://www.reddit.com/dev/api

Retrieves a listing of posts from a specified subreddit, sorted by a given criteria. Supports RSS.

```APIDOC
## GET /r/{subreddit}/{sort}

### Description
Retrieves a listing of posts from a specified subreddit, sorted by a given criteria. Supports RSS.

### Method
GET

### Endpoint
/r/{subreddit}/{sort}

### Parameters
#### Path Parameters
- **sort** (string) - Required - one of (`top`, `controversial`)

#### Query Parameters
- **t** (string) - Optional - one of (`hour`, `day`, `week`, `month`, `year`, `all`)
- **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
```

--------------------------------

### POST /api/site_adminmodconfig

Source: https://www.reddit.com/dev/api

Creates or configures 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.

```APIDOC
## POST /api/site_adminmodconfig

### Description
Creates or configures 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
#### Request Body
- **name** (string) - Required - The name of the subreddit to create (if not modifying).
- **sr** (string) - Optional - The name of the subreddit to modify.
- **accept_followers** (boolean) - Optional - Boolean value.
- **admin_override_spam_comments** (boolean) - Optional - Boolean value.
- **admin_override_spam_links** (boolean) - Optional - Boolean value.
- **admin_override_spam_selfposts** (boolean) - Optional - Boolean value.
- **description** (string) - Optional - The sidebar text.
- **public_description** (string) - Optional - The publicly visible subreddit description.
```

--------------------------------

### POST /api/multi/_multipath_ subscribe

Source: https://www.reddit.com/dev/api

Creates a multi-reddit. 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.

### Parameters
#### Path Parameters
- **multipath** (string) - multireddit url path

#### Request Body
- **model** (object) - json data:
  ```json
  {
    "description_md": "raw markdown text",
    "display_name": "a string no longer than 50 characters",
    "icon_img": "one of (png, jpg, jpeg)",
    "key_color": "a 6-digit rgb hex color, e.g. #AABBCC",
    "subreddits": [
      {
        "name": "subreddit name"
      },
      ...
    ],
    "visibility": "one of (private, public, hidden)"
  }
  ```

### Headers
- **X-Modhash** (string) - a modhash

### Query Parameters
- **expand_srs** (boolean) - boolean value
```

--------------------------------

### GET [/r/_subreddit_]/sidebarread

Source: https://www.reddit.com/dev/api

Retrieves the sidebar content for a given subreddit.

```APIDOC
## GET [/r/_subreddit_]/sidebarread

### Description
Retrieves the sidebar content for the specified subreddit.

### Method
GET

### Endpoint
/r/_subreddit_ /sidebarread

### Parameters
#### Path Parameters
- **_subreddit_** (string) - Required - The name of the subreddit.
```

--------------------------------

### POST /api/live/{thread}/accept_contributor_invite

Source: https://www.reddit.com/dev/api

Accepts a pending invitation to contribute to a live thread.

```APIDOC
## POST /api/live/{thread}/accept_contributor_invite

### Description
Accepts a pending invitation to contribute to the thread. See also: `/api/live/{thread}/leave_contributor`.

### Method
POST

### Endpoint
/api/live/{thread}/accept_contributor_invite

### Parameters
#### Query Parameters
- **api_type** (string) - Required - the string `json`

### Headers
- **X-Modhash** - Required - a modhash
```

--------------------------------

### POST /r/_subreddit_/api/widgetstructuredstyles

Source: https://www.reddit.com/dev/api

Creates a new widget with structured styles for a specified subreddit.

```APIDOC
## POST /r/_subreddit_/api/widgetstructuredstyles

### Description
Creates a new widget with structured styles for a specified subreddit.

### Method
POST

### Endpoint
/r/_subreddit_/api/widgetstructuredstyles
```

--------------------------------

### 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. The response contains credentials for uploading assets to S3, the S3 URL for the upload request, and the key to use for uploading.

```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.

### 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
```

--------------------------------

### PUT /api/multi/_multipath_ /descriptionread

Source: https://www.reddit.com/dev/api

Updates the markdown description of a multi-reddit.

```APIDOC
## PUT /api/multi/_multipath_ /descriptionread

### Description
Change a multi's markdown description.

### Parameters
#### Path Parameters
- **multipath** (string) - multireddit url path

#### Request Body
- **model** (object) - json data:
  ```json
  {
    "body_md": "raw markdown text"
  }
  ```

### Headers
- **X-Modhash** (string) - a modhash
```

--------------------------------

### GET /r/_subreddit_/api/user_flairflair

Source: https://www.reddit.com/dev/api

Retrieves a list of available user flair for the current subreddit.

```APIDOC
## GET [/r/_subreddit_]/api/user_flairflair

### Description
Returns a list of available user flair for the current subreddit. Will not return flair if flair is disabled on the subreddit, the user cannot set their own flair, or they are not a moderator that can set flair.
```

--------------------------------

### GET /r/_subreddit_/api/link_flairflair

Source: https://www.reddit.com/dev/api

Retrieves a list of available link flair for the current subreddit.

```APIDOC
## GET [/r/_subreddit_]/api/link_flairflair

### Description
Returns a 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.
```

--------------------------------

### POST /api/live/_thread_ /invite_contributor

Source: https://www.reddit.com/dev/api

Invites 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 specified permissions.

```APIDOC
## POST /api/live/_thread_ /invite_contributor

### 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.
See also: /api/live/_thread_ /accept_contributor_invite, and /api/live/_thread_ /rm_contributor_invite.

### Method
POST

### Endpoint
/api/live/_thread_/invite_contributor

### Parameters
#### Query Parameters
- **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
- **api_type** (string) - Required - the string `json`
- **X-Modhash** (string) - Required - a modhash
```

--------------------------------

### POST /r/_subreddit_/api/flairtemplate_v2modflair

Source: https://www.reddit.com/dev/api

Creates or updates a flair template, primarily for the redesign.

```APIDOC
## POST [/r/_subreddit_]/api/flairtemplate_v2modflair

### Description
Creates or updates a flair template. This new endpoint is primarily used for the redesign.

### Parameters
#### Request Body
- **allowable_content** (string) - Optional - One of (`all`, `emoji`, `text`).
- **api_type** (string) - Required - The string `json`.
- **background_color** (string) - Optional - A 6-digit rgb hex color, e.g. `#AABBCC`.
- **css_class** (string) - Optional - A valid subreddit image name.
- **flair_template_id** (string) - Optional - The ID of the flair template.
- **flair_type** (string) - Required - One of (`USER_FLAIR`, `LINK_FLAIR`).
- **max_emojis** (integer) - Optional - An integer between 1 and 10 (default: 10).
- **mod_only** (boolean) - Optional - Boolean value indicating if the flair is mod-only.
- **override_css** (string) - Optional - CSS override value.
- **text** (string) - Required - A string no longer than 64 characters.
- **text_color** (string) - Optional - One of (`light`, `dark`).
- **text_editable** (boolean) - Optional - Boolean value indicating if the text is editable.
- **uh / X-Modhash header** (string) - Required - A modhash.
```

--------------------------------

### GET /subreddits/mine/_where_

Source: https://www.reddit.com/dev/api

Retrieves a list of subreddits that the user has a relationship with, based on the 'where' parameter.

```APIDOC
## GET /subreddits/mine/_where_

### Description
Fetches subreddits the user has a relationship with. The `where` parameter determines the type of relationship to filter by.

### Method
GET

### Endpoint
/subreddits/mine/_where_

### Parameters
#### Path Parameters
- **_where_** (string) - Required - Specifies the type of subreddits to retrieve. Accepted values are `subscriber`, `contributor`, `moderator`, or `streams`.
  - `subscriber`: Subreddits the user is subscribed to.
  - `contributor`: Subreddits where the user is an approved user.
  - `moderator`: Subreddits where the user is a moderator.
  - `streams`: Subreddits the user is subscribed to that contain hosted video links.
```

--------------------------------

### POST [/r/_subreddit_]/api/flairconfig

Source: https://www.reddit.com/dev/api

Configures flair settings for a subreddit, including enabling/disabling flair, setting positions, and enabling self-assignment for users and links.

```APIDOC
## POST [/r/_subreddit_]/api/flairconfig

### Description
Configures flair settings for a subreddit.

### Parameters
#### Request Body
- **api_type** (string) - Required - The string `json`
- **flair_enabled** (boolean) - Optional - 
- **flair_position** (string) - Optional - One of (`left`, `right`)
- **flair_self_assign_enabled** (boolean) - Optional - 
- **link_flair_position** (string) - Optional - One of (``, `left`, `right`)
- **link_flair_self_assign_enabled** (boolean) - Optional - 
- **X-Modhash header** (string) - Required - A modhash
```

--------------------------------

### GET [/r/_subreddit_]/searchreadrss support

Source: https://www.reddit.com/dev/api

Searches for links within a subreddit. This endpoint is a listing.

```APIDOC
## GET [/r/_subreddit_]/searchreadrss support

### Description
Search links page.
_This endpoint isa listing._

### Parameters
#### Query Parameters
- **after** (string) - fullname of a thing
- **before** (string) - fullname of a thing
- **category** (string) - a string no longer than 5 characters
- **count** (integer) - a positive integer (default: 0)
- **include_facets** (boolean) - boolean value
- **limit** (integer) - the maximum number of items desired (default: 25, maximum: 100)
- **q** (string) - a string no longer than 512 characters
- **restrict_sr** (boolean) - boolean value
- **show** (string) - (optional) the string `all`
- **sort** (string) - one of (`relevance`, `hot`, `top`, `new`, `comments`)
- **sr_detail** (boolean) - (optional) expand subreddits
- **t** (string) - one of (`hour`, `day`, `week`, `month`, `year`, `all`)
- **type** (string) - (optional) comma-delimited list of result types (`sr`, `link`, `user`)
```

--------------------------------

### 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.

### Parameters
#### Request Body
- **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.
- **flair_type** (string) - Required - One of (`USER_FLAIR`, `LINK_FLAIR`).
- **text** (string) - Required - A string no longer than 64 characters.
- **text_editable** (boolean) - Optional - Boolean value indicating if the text is editable.
- **uh / X-Modhash header** (string) - Required - A modhash.
```

--------------------------------

### GET /api/multi/_multipath_ /r/_srname_ read

Source: https://www.reddit.com/dev/api

Retrieves data about a specific subreddit within a multi-reddit.

```APIDOC
## GET /api/multi/_multipath_ /r/_srname_ read

### Description
Get data about a subreddit in a multi.

### Parameters
#### Path Parameters
- **multipath** (string) - multireddit url path
- **srname** (string) - subreddit name
```

--------------------------------

### GET /api/multi/user/_username_ read

Source: https://www.reddit.com/dev/api

Fetches a list of public multi-reddits belonging to a specific user.

```APIDOC
## GET /api/multi/user/_username_ read

### Description
Fetch a list of public multis belonging to `username`

### Parameters
#### Path Parameters
- **username** (string) - A valid, existing reddit username

#### Query Parameters
- **expand_srs** (boolean) - boolean value
```

--------------------------------

### GET /api/mod/notes/recentmodnote

Source: https://www.reddit.com/dev/api

Fetches the most recent notes written by a moderator for specified subreddits and accounts.

```APIDOC
## GET /api/mod/notes/recentmodnote

### Description
Fetch the most recent notes written by a moderator

### Method
GET

### Endpoint
/api/mod/notes/recentmodnote

### Parameters
#### Query Parameters
- **subreddits** (string) - Required - A comma-separated list of subreddit names.
- **users** (string) - Required - A comma-separated list of account usernames.

### Notes
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. 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.
```

--------------------------------

### PATCH /api/v1/me/prefs

Source: https://www.reddit.com/dev/api

Updates the authenticated user's preferences. Requires an X-Modhash header.

```APIDOC
## PATCH /api/v1/me/prefs

### Description
Updates the authenticated user's preferences. Requires an X-Modhash header.

### Method
PATCH

### Endpoint
/api/v1/me/prefs

### Headers
- **X-Modhash**: a modhash
```

--------------------------------

### GET /api/mod/notesmodnote

Source: https://www.reddit.com/dev/api

Retrieves moderator notes for a specific user within a given subreddit.

```APIDOC
## GET /api/mod/notesmodnote

### Description
Get mod notes for a specific user in a given subreddit.

### Method
GET

### Endpoint
/api/mod/notesmodnote

### Parameters
#### Query Parameters
- **subreddit** (string) - Required - Subreddit name.
- **user** (string) - Required - Account username.
- **before** (string) - Optional - An encoded string used for pagination with mod notes.
- **filter** (string) - Optional - One of (NOTE, APPROVAL, REMOVAL, BAN, MUTE, INVITE, SPAM, CONTENT_CHANGE, MOD_ACTION, ALL), to be used for querying specific types of mod notes (default: all).
- **limit** (integer) - Optional - The number of mod notes to return in the response payload (default: 25, max: 100).
```

--------------------------------

### GET /api/mod/conversations/unread/countmodmail

Source: https://www.reddit.com/dev/api

Retrieves the unread Modmail conversation count, categorized by conversation state.

```APIDOC
## GET /api/mod/conversations/unread/countmodmail

### Description
Endpoint to retrieve the unread conversation count by conversation state.

### Method
GET

### Endpoint
/api/mod/conversations/unread/countmodmail
```
Tokens:
Raw