Subreddit¶

class praw.models.Subreddit(reddit, display_name=None, _data=None)¶

A class for Subreddits.

To obtain an instance of this class for r/test execute:

subreddit = reddit.subreddit("test")

While r/all is not a real subreddit, it can still be treated like one. The following outputs the titles of the 25 hottest submissions in r/all:

for submission in reddit.subreddit("all").hot(limit=25):
    print(submission.title)

Multiple subreddits can be combined with a + like so:

for submission in reddit.subreddit("redditdev+learnpython").top(time_filter="all"):
    print(submission)

Subreddits can be filtered from combined listings as follows.

Note

These filters are ignored by certain methods, including comments, and SubredditStream.comments().

for submission in reddit.subreddit("all-redditdev").new():
    print(submission)

Typical Attributes

Note

This table describes attributes that typically belong to objects of this class. PRAW dynamically provides the attributes that Reddit returns via the API. Since those attributes are subject to change on Reddit’s end, PRAW makes no effort to document any new/removed/changed attributes, other than to instruct you on how to discover what is available. As a result, this table of attributes may not be complete. See Determine Available Attributes of an Object for detailed information.

If you would like to add an attribute to this table, feel free to open a pull request.

Attribute	Description
`can_assign_link_flair`	Whether users can assign their own link flair.
`can_assign_user_flair`	Whether users can assign their own user flair.
`created_utc`	Time the subreddit was created, represented in Unix Time.
`description`	Subreddit description, in Markdown.
`description_html`	Subreddit description, in HTML.
`display_name`	Name of the subreddit.
`icon_img`	The URL of the subreddit icon image.
`id`	ID of the subreddit.
`name`	Fullname of the subreddit.
`over18`	Whether the subreddit is NSFW.
`public_description`	Description of the subreddit, shown in searches and on the “You must be invited to visit this community” page (if applicable).
`spoilers_enabled`	Whether the spoiler tag feature is enabled.
`subscribers`	Count of subscribers.
`user_is_banned`	Whether the authenticated user is banned.
`user_is_moderator`	Whether the authenticated user is a moderator.
`user_is_subscriber`	Whether the authenticated user is subscribed.

Note

Trying to retrieve attributes of quarantined or private subreddits will result in a 403 error. Trying to retrieve attributes of a banned subreddit will result in a 404 error.

Parameters:

reddit (praw.Reddit)
display_name (str | None)
_data (dict[str, Any] | None)

__init__(reddit, display_name=None, _data=None)¶

Initialize a Subreddit instance.

Parameters:

reddit (Reddit) – An instance of Reddit.
display_name (str | None) – The name of the subreddit.
_data (dict[str, Any] | None)

Return type:

None

Note

This class should not be initialized directly. Instead, obtain an instance via:

subreddit = reddit.subreddit("test")

banned()¶

Provide an instance of SubredditRelationship.

For example, to ban a user try:

reddit.subreddit("test").banned.add("spez", ban_reason="...")

To list the banned users along with any notes, try:

for ban in reddit.subreddit("test").banned():
    print(f"{ban}: {ban.note}")

Return type:: SubredditRelationship

collections()¶

Provide an instance of SubredditCollections.

To see the permalinks of all Collections that belong to a subreddit, try:

for collection in reddit.subreddit("test").collections:
    print(collection.permalink)

To get a specific Collection by its UUID or permalink, use one of the following:

collection = reddit.subreddit("test").collections("some_uuid")
collection = reddit.subreddit("test").collections(
    permalink="https://reddit.com/r/SUBREDDIT/collection/some_uuid"
)

Return type:: SubredditCollections

comments()¶

Provide an instance of CommentHelper.

For example, to output the author of the 25 most recent comments of r/test execute:

for comment in reddit.subreddit("test").comments(limit=25):
    print(comment.author)

Return type:: CommentHelper

contributor()¶

Provide an instance of ContributorRelationship.

Contributors are also known as approved submitters.

To add a contributor try:

reddit.subreddit("test").contributor.add("spez")

Return type:: ContributorRelationship

controversial(*, time_filter='all', **generator_kwargs)¶

Return a ListingGenerator for controversial items.

Parameters:

time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year" (default: "all").
generator_kwargs (str | int | dict[str, str])

Raises:

ValueError if time_filter is invalid.

Return type:

Iterator[Any]

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").controversial(time_filter="week")
reddit.multireddit(redditor="samuraisam", name="programming").controversial(
    time_filter="day"
)
reddit.redditor("spez").controversial(time_filter="month")
reddit.redditor("spez").comments.controversial(time_filter="year")
reddit.redditor("spez").submissions.controversial(time_filter="all")
reddit.subreddit("all").controversial(time_filter="hour")

emoji()¶

Provide an instance of SubredditEmoji.

This attribute can be used to discover all emoji for a subreddit:

for emoji in reddit.subreddit("test").emoji:
    print(emoji)

A single emoji can be lazily retrieved via:

reddit.subreddit("test").emoji["emoji_name"]

Note

Attempting to access attributes of a nonexistent emoji will result in a ClientException.

Return type:: SubredditEmoji

filters()¶

Provide an instance of SubredditFilters.

For example, to add a filter, run:

reddit.subreddit("all").filters.add("test")

Return type:: SubredditFilters

flair()¶

Provide an instance of SubredditFlair.

Use this attribute for interacting with a Subreddit’s flair. For example, to list all the flair for a subreddit which you have the flair moderator permission on try:

for flair in reddit.subreddit("test").flair():
    print(flair)

Flair templates can be interacted with through this attribute via:

for template in reddit.subreddit("test").flair.templates:
    print(template)

Return type:: SubredditFlair

property fullname: str¶

Return the object’s fullname.

A fullname is an object’s kind mapping like t3 followed by an underscore and the object’s base36 ID, e.g., t1_c5s96e0.

hot(**generator_kwargs)¶

Return a ListingGenerator for hot items.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").hot()
reddit.multireddit(redditor="samuraisam", name="programming").hot()
reddit.redditor("spez").hot()
reddit.redditor("spez").comments.hot()
reddit.redditor("spez").submissions.hot()
reddit.subreddit("all").hot()

Return type:: Iterator[Any]
Parameters:: generator_kwargs (str | int | dict[str, str])

message(*, from_subreddit=None, message, subject)¶

Send a message to a Redditor or a Subreddit’s moderators (modmail).

Parameters:

from_subreddit (Subreddit | str | None) –
A Subreddit instance or string to send the message from. When provided, messages are sent from the subreddit rather than from the authenticated user.

Note

The authenticated user must be a moderator of the subreddit and have the mail moderator permission.
message (str) – The message content.
subject (str) – The subject of the message.

Return type:

None

For example, to send a private message to u/spez, try:

reddit.redditor("spez").message(subject="TEST", message="test message from PRAW")

To send a message to u/spez from the moderators of r/test try:

reddit.redditor("spez").message(
    subject="TEST", message="test message from r/test", from_subreddit="test"
)

To send a message to the moderators of r/test, try:

reddit.subreddit("test").message(subject="TEST", message="test PM from PRAW")

mod()¶

Provide an instance of SubredditModeration.

For example, to accept a moderation invite from r/test:

reddit.subreddit("test").mod.accept_invite()

Return type:: SubredditModeration

moderator()¶

Provide an instance of ModeratorRelationship.

For example, to add a moderator try:

reddit.subreddit("test").moderator.add("spez")

To list the moderators along with their permissions try:

for moderator in reddit.subreddit("test").moderator():
    print(f"{moderator}: {moderator.mod_permissions}")

Return type:: ModeratorRelationship

modmail()¶

Provide an instance of Modmail.

For example, to send a new modmail from r/test to u/spez with the subject "test" along with a message body of "hello":

reddit.subreddit("test").modmail.create(subject="test", body="hello", recipient="spez")

Return type:: Modmail

muted()¶

Provide an instance of SubredditRelationship.

For example, muted users can be iterated through like so:

for mute in reddit.subreddit("test").muted():
    print(f"{mute}: {mute.date}")

Return type:: SubredditRelationship

new(**generator_kwargs)¶

Return a ListingGenerator for new items.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").new()
reddit.multireddit(redditor="samuraisam", name="programming").new()
reddit.redditor("spez").new()
reddit.redditor("spez").comments.new()
reddit.redditor("spez").submissions.new()
reddit.subreddit("all").new()

Return type:: Iterator[Any]
Parameters:: generator_kwargs (str | int | dict[str, str])

classmethod parse(data, reddit)¶

Return an instance of cls from data.

Parameters:

data (dict[str, Any]) – The structured data.
reddit (Reddit) – An instance of Reddit.

Return type:

PRAWBase

post_requirements()¶

Get the post requirements for a subreddit.

Return type:: dict[str, str | int | bool]
Returns:: A dict with the various requirements.

The returned dict contains the following keys:

domain_blacklist
body_restriction_policy
domain_whitelist
title_regexes
body_blacklisted_strings
body_required_strings
title_text_min_length
is_flair_required
title_text_max_length
body_regexes
link_repost_age
body_text_min_length
link_restriction_policy
body_text_max_length
title_required_strings
title_blacklisted_strings
guidelines_text
guidelines_display_policy

For example, to fetch the post requirements for r/test:

print(reddit.subreddit("test").post_requirements)

quaran()¶

Provide an instance of SubredditQuarantine.

This property is named quaran because quarantine is a subreddit attribute returned by Reddit to indicate whether or not a subreddit is quarantined.

To opt-in into a quarantined subreddit:

reddit.subreddit("test").quaran.opt_in()

Return type:: SubredditQuarantine

rising(**generator_kwargs)¶

Return a ListingGenerator for rising submissions.

Additional keyword arguments are passed in the initialization of ListingGenerator.

For example, to get rising submissions for r/test:

for submission in reddit.subreddit("test").rising():
    print(submission.title)

Return type:: Iterator[Submission]
Parameters:: generator_kwargs (str | int | dict[str, str])

rules()¶

Provide an instance of SubredditRules.

Use this attribute for interacting with a Subreddit’s rules.

For example, to list all the rules for a subreddit:

for rule in reddit.subreddit("test").rules:
    print(rule)

Moderators can also add rules to the subreddit. For example, to make a rule called "No spam" in r/test:

reddit.subreddit("test").rules.mod.add(
    short_name="No spam", kind="all", description="Do not spam. Spam bad"
)

Return type:: SubredditRules

search(query, *, sort='relevance', syntax='lucene', time_filter='all', **generator_kwargs)¶

Return a ListingGenerator for items that match query.

Parameters:

query (str) – The query string to search for.
sort (str) – Can be one of: "relevance", "hot", "top", "new", or "comments". (default: "relevance").
syntax (str) – Can be one of: "cloudsearch", "lucene", or "plain" (default: "lucene").
time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year" (default: "all").
generator_kwargs (Any)

Return type:

Iterator[Submission]

For more information on building a search query see: https://www.reddit.com/wiki/search

For example, to search all subreddits for "praw" try:

for submission in reddit.subreddit("all").search("praw"):
    print(submission.title)

sticky(*, number=1)¶

Return a Submission object for a sticky of the subreddit.

Parameters:: number (int) – Specify which sticky to return. 1 appears at the top (default: 1).
Raises:: prawcore.NotFound if the sticky does not exist.
Return type:: Submission

For example, to get the stickied post on r/test:

reddit.subreddit("test").sticky()

stream()¶

Provide an instance of SubredditStream.

Streams can be used to indefinitely retrieve new comments made to a subreddit, like:

for comment in reddit.subreddit("test").stream.comments():
    print(comment)

Additionally, new submissions can be retrieved via the stream. In the following example all submissions are fetched via the special r/all:

for submission in reddit.subreddit("all").stream.submissions():
    print(submission)

Return type:: SubredditStream

stylesheet()¶

Provide an instance of SubredditStylesheet.

For example, to add the css data .test{color:blue} to the existing stylesheet:

subreddit = reddit.subreddit("test")
stylesheet = subreddit.stylesheet()
stylesheet.stylesheet += ".test{color:blue}"
subreddit.stylesheet.update(stylesheet.stylesheet)

Return type:: SubredditStylesheet

submit(title, *, collection_id=None, discussion_type=None, draft_id=None, flair_id=None, flair_text=None, gallery=None, image=None, inline_media=None, nsfw=False, poll=None, resubmit=True, selftext=None, send_replies=True, spoiler=False, timeout=10, url=None, video=None, without_websockets=False)¶

Overloads:

self, title (str), collection_id (str | None), discussion_type (str | None), draft_id (str | None), flair_id (str | None), flair_text (str | None), inline_media (dict[str, models.InlineMedia] | None), nsfw (bool), resubmit (bool), selftext (str), send_replies (bool), spoiler (bool) → models.Submission
self, title (str), collection_id (str | None), discussion_type (str | None), draft_id (str | None), flair_id (str | None), flair_text (str | None), nsfw (bool), resubmit (bool), selftext (str | None), send_replies (bool), spoiler (bool), url (str) → models.Submission
self, title (str), collection_id (str | None), discussion_type (str | None), flair_id (str | None), flair_text (str | None), image (models.PostMedia), nsfw (bool), resubmit (bool), selftext (str | None), send_replies (bool), spoiler (bool), timeout (int), without_websockets (bool) → models.Submission | None
self, title (str), collection_id (str | None), discussion_type (str | None), flair_id (str | None), flair_text (str | None), gallery (list[models.PostMedia | dict[str, str | models.PostMedia]]), nsfw (bool), selftext (str | None), send_replies (bool), spoiler (bool) → models.Submission
self, title (str), collection_id (str | None), discussion_type (str | None), flair_id (str | None), flair_text (str | None), nsfw (bool), poll (dict[str, int | list[str]]), resubmit (bool), selftext (str | None), send_replies (bool), spoiler (bool) → models.Submission
self, title (str), collection_id (str | None), discussion_type (str | None), flair_id (str | None), flair_text (str | None), nsfw (bool), resubmit (bool), selftext (str | None), send_replies (bool), spoiler (bool), timeout (int), video (models.PostMedia | dict[str, bool | models.PostMedia]), without_websockets (bool) → models.Submission | None

Parameters:

title (str)
collection_id (str | None)
discussion_type (str | None)
draft_id (str | None)
flair_id (str | None)
flair_text (str | None)
gallery (list[PostMedia | dict[str, str | PostMedia]] | None)
image (PostMedia | None)
inline_media (dict[str, InlineMedia] | None)
nsfw (bool)
poll (dict[str, int | list[str]] | None)
resubmit (bool)
selftext (str | None)
send_replies (bool)
spoiler (bool)
timeout (int)
url (str | None)
video (PostMedia | dict[str, bool | PostMedia] | None)
without_websockets (bool)

Return type:

Submission | None

Add a submission to the Subreddit.

Parameters:

title (str) – The title of the submission.
collection_id (str | None) – The UUID of a Collection to add the newly-submitted post to.
discussion_type (str | None) – Set to "CHAT" to enable live discussion instead of traditional comments (default: None).
draft_id (str | None) – The ID of a draft to submit. Only applies to text and link submissions.
flair_id (str | None) – The flair template to select (default: None).
flair_text (str | None) – If the template’s flair_text_editable value is True, this value will set a custom text (default: None). flair_id is required when flair_text is provided.
gallery (list[PostMedia | dict[str, str | PostMedia]] | None) – A list of images to post as a gallery. Each item is either a PostMedia or a dict with the structure {"media": PostMedia("path"), "caption": "caption", "outbound_url": "url"}, where only media is required.
image (PostMedia | None) – The PostMedia image to upload and post.
inline_media (dict[str, InlineMedia] | None) – A dict of InlineMedia objects where the key is the placeholder name in selftext. Only supported for text submissions.
nsfw (bool) – Whether the submission should be marked NSFW (default: False).
poll (dict[str, int | list[str]] | None) – A dict with the structure {"duration": 3, "options": ["Yes", "No"]}, where duration is the number of days the poll should accept votes (between 1 and 7, inclusive) and options is a list of two to six poll options as str. Both keys are required.
resubmit (bool) – When False, an error will occur if the URL has already been submitted (default: True).
selftext (str | None) – The Markdown formatted content for a text submission or optional Markdown-formatted body text for any other kind of submission. Use an empty string, "", to make a title-only submission.
send_replies (bool) – When True, messages will be sent to the submission author when comments are made to the submission (default: True).
spoiler (bool) – Whether the submission should be marked as a spoiler (default: False).
timeout (int) – Specifies a particular timeout, in seconds, for the WebSockets connection used by image and video submissions. Use to avoid “Websocket error” exceptions (default: 10).
url (str | None) – The URL for a link submission.
video (PostMedia | dict[str, bool | PostMedia] | None) – The video to upload and post. Either a PostMedia or a dict with the structure {"media": PostMedia("path"), "gif": True, "thumbnail": PostMedia("path")}, where only media is required. Set "gif" to True to submit the video as a videogif, which is essentially a silent video (default: False). When "thumbnail" is not provided, the PRAW logo will be used as the thumbnail.
without_websockets (bool) – Set to True to disable use of WebSockets for image and video submissions (see note below for an explanation). If True, this method doesn’t return anything (default: False).

Returns:

A Submission object for the newly created submission, unless without_websockets is True for an image or video submission.

Raises:

ClientException if image or a gallery item’s media refers to a file that is not an image, or if the video (or its media) refers to a file that is not a video.

Return type:

Submission | None

At least one of gallery, image, poll, selftext, url, or video must be provided. gallery, image, poll, url, and video are mutually exclusive, while selftext may accompany any of them as optional Markdown-formatted body text. selftext that accompanies another kind of submission does not support inline_media.

For example, to submit a URL to r/test do:

title = "PRAW documentation"
url = "https://praw.readthedocs.io"
reddit.subreddit("test").submit(title, url=url)

To submit an image to r/test do:

from praw.models import PostMedia

title = "My favorite picture"
image = PostMedia("/path/to/image.png")
reddit.subreddit("test").submit(title, image=image)

To submit an image gallery to r/test do:

from praw.models import PostMedia

title = "My favorite pictures"
gallery = [
    PostMedia("/path/to/image.png"),
    {
        "media": PostMedia("/path/to/image2.png"),
        "caption": "Image caption 2",
    },
    {
        "media": PostMedia("/path/to/image3.png"),
        "caption": "Image caption 3",
        "outbound_url": "https://example.com/link3",
    },
]
reddit.subreddit("test").submit(title, gallery=gallery)

To submit a video to r/test do:

from praw.models import PostMedia

title = "My favorite movie"
video = PostMedia("/path/to/video.mp4")
reddit.subreddit("test").submit(title, video=video)

To submit a videogif with a custom thumbnail instead, do:

from praw.models import PostMedia

title = "My favorite gif"
video = {
    "gif": True,
    "media": PostMedia("/path/to/video.mp4"),
    "thumbnail": PostMedia("/path/to/thumbnail.png"),
}
reddit.subreddit("test").submit(title, video=video)

To submit a poll to r/test do:

title = "Do you like PRAW?"
poll = {"duration": 3, "options": ["Yes", "No"]}
reddit.subreddit("test").submit(title, poll=poll)

To submit a self post with inline media do:

from praw.models import InlineGif, InlineImage, InlineVideo, PostMedia

gif = InlineGif(caption="optional caption", media=PostMedia("path/to/image.gif"))
image = InlineImage(caption="optional caption", media=PostMedia("path/to/image.jpg"))
video = InlineVideo(caption="optional caption", media=PostMedia("path/to/video.mp4"))
selftext = "Text with a gif {gif1} an image {image1} and a video {video1} inline"
media = {"gif1": gif, "image1": image, "video1": video}
reddit.subreddit("test").submit("title", inline_media=media, selftext=selftext)

Note

Inserted media will have a padding of \\n\\n automatically added. This is due to the weirdness with Reddit’s API. Using the example above, the result selftext body will look like so:

Text with a gif

![gif](u1rchuphryq51 "optional caption")

an image

![img](srnr8tshryq51 "optional caption")

and video

![video](gmc7rvthryq51 "optional caption")

inline

Note

For image and video submissions, Reddit’s API uses WebSockets to respond with the link of the newly created post. If this fails, the method will raise WebSocketException. Occasionally, the Reddit post will still be created. More often, there is an error with the media file. If you frequently get exceptions but successfully created posts, try setting the timeout parameter to a value above 10.

To disable the use of WebSockets, set without_websockets=True. This will make the method return None, though the post will still be created. You may wish to do this if you are running your program in a restricted network environment, or using a proxy that doesn’t support WebSockets connections.

Note

To submit a post to a subreddit with the "news" flair, you can get the flair id like this:

choices = list(subreddit.flair.link_templates.user_selectable())
template_id = next(x for x in choices if x["flair_text"] == "news")["flair_template_id"]
subreddit.submit("title", flair_id=template_id, url="https://www.news.com/")

subscribe(*, other_subreddits=None)¶

Subscribe to the subreddit.

Parameters:: other_subreddits (list[Subreddit] | None) – When provided, also subscribe to the provided list of subreddits.
Return type:: None

For example, to subscribe to r/test:

reddit.subreddit("test").subscribe()

top(*, time_filter='all', **generator_kwargs)¶

Return a ListingGenerator for top items.

Parameters:

time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year" (default: "all").
generator_kwargs (str | int | dict[str, str])

Raises:

ValueError if time_filter is invalid.

Return type:

Iterator[Any]

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").top(time_filter="week")
reddit.multireddit(redditor="samuraisam", name="programming").top(time_filter="day")
reddit.redditor("spez").top(time_filter="month")
reddit.redditor("spez").comments.top(time_filter="year")
reddit.redditor("spez").submissions.top(time_filter="all")
reddit.subreddit("all").top(time_filter="hour")

traffic()¶

Return a dictionary of the Subreddit’s traffic statistics.

Raises:: prawcore.NotFound when the traffic stats aren’t available to the authenticated user, that is, they are not public and the authenticated user is not a moderator of the subreddit.
Return type:: dict[str, list[list[int]]]

The traffic method returns a dict with three keys. The keys are day, hour and month. Each key contains a list of lists with 3 or 4 values. The first value is a timestamp indicating the start of the category (start of the day for the day key, start of the hour for the hour key, etc.). The second, third, and fourth values indicate the unique pageviews, total pageviews, and subscribers, respectively.

Note

The hour key does not contain subscribers, and therefore each sub-list contains three values.

For example, to get the traffic stats for r/test:

stats = reddit.subreddit("test").traffic()

Return type:: dict[str, list[list[int]]]

unsubscribe(*, other_subreddits=None)¶

Unsubscribe from the subreddit.

Parameters:: other_subreddits (list[Subreddit] | None) – When provided, also unsubscribe from the provided list of subreddits.
Return type:: None

To unsubscribe from r/test:

reddit.subreddit("test").unsubscribe()

widgets()¶

Provide an instance of SubredditWidgets.

Example usage

Get all sidebar widgets:

for widget in reddit.subreddit("test").widgets.sidebar:
    print(widget)

Get ID card widget:

print(reddit.subreddit("test").widgets.id_card)

Return type:: SubredditWidgets

wiki()¶

Provide an instance of SubredditWiki.

This attribute can be used to discover all wikipages for a subreddit:

for wikipage in reddit.subreddit("test").wiki:
    print(wikipage)

To fetch the content for a given wikipage try:

wikipage = reddit.subreddit("test").wiki["proof"]
print(wikipage.content_md)

Return type:: SubredditWiki