@datafire/reddit
Client library for Reddit
Installation and Usage
npm install --save @datafire/reddit
let reddit = require('@datafire/reddit').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Reddit API
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
reddit.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
reddit.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
sort.get
This endpoint is a listing.
reddit.sort.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - t
string
: one of (hour, day, week, month, year, all) - sort
string
- after
Output
Output schema unknown
wiki.page.get
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
reddit.wiki.page.get({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - v
string
: a wiki revision ID - v2
string
: a wiki revision ID
- page
Output
Output schema unknown
wiki.settings.page.post
Update the permissions and visibility of wiki page
reddit.wiki.settings.page.post({}, context)
Input
- input
object
- listed
string
: boolean value - page
string
: the name of an existing wiki page - permlevel
string
: an integer - uh
string
: a modhash
- listed
Output
Output schema unknown
wiki.settings.page.get
Retrieve the current permission settings for page
reddit.wiki.settings.page.get({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page
- page
Output
Output schema unknown
wiki.revisions.page.get
Retrieve a list of revisions of this wiki page
This endpoint is a listing.
reddit.wiki.revisions.page.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - page
string
: the name of an existing wiki page - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
wiki.revisions.get
Retrieve a list of recently changed wiki pages in this subreddit
reddit.wiki.revisions.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
wiki.pages.get
Retrieve a list of wiki pages in this subreddit
reddit.wiki.pages.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
wiki.discussions.page.get
Retrieve a list of discussions about this wiki page
This endpoint is a listing.
reddit.wiki.discussions.page.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - page
string
: the name of an existing wiki page - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
user.username.where.get
This endpoint is a listing.
reddit.user.username.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: one of (given) - sort
string
: one of (hot, new, top, controversial) - sr_detail
string
: (optional) expand subreddits - t
string
: one of (hour, day, week, month, year, all) - username
string
: the name of an existing user - where
string
- after
Output
Output schema unknown
user.username.about.get
Return information about the user, including karma and gold status.
reddit.user.username.about.get({}, context)
Input
- input
object
- username
string
: the name of an existing user
- username
Output
Output schema unknown
subreddits.where.get
Get all subreddits.
The where parameter chooses the order in which the subreddits are displayed. popular sorts on the activity of the subreddit and the position of the subreddits can shift around. new sorts the subreddits based on their creation date, newest first.
This endpoint is a listing.
reddit.subreddits.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - where
string
- after
Output
Output schema unknown
subreddits.search.get
Search subreddits by title and description.
This endpoint is a listing.
reddit.subreddits.search.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - q
string
: a search query - show
string
: (optional) the string all - sort
string
: one of (relevance, activity) - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
subreddits.mine.where.get
Get subreddits the user has a relationship with.
The where parameter chooses which subreddits are returned as follows:
subscriber - subreddits the user is subscribed to contributor - subreddits the user is an approved submitter in moderator - subreddits the user is a moderator of
See also: /api/subscribe, /api/friend, and /api/accept_moderator_invite.
This endpoint is a listing.
reddit.subreddits.mine.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - where
string
- after
Output
Output schema unknown
stylesheet.get
Redirect to the subreddit's stylesheet if one exists.
See also: /api/subreddit_stylesheet.
reddit.stylesheet.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
sticky.get
Redirect to one of the posts stickied in the current subreddit
The "num" argument can be used to select a specific sticky, and will default to 1 (the top sticky) if not specified. Will 404 if there is not currently a sticky post in this subreddit.
reddit.sticky.get({}, context)
Input
- input
object
- num
string
: an integer between 1 and 2 (default: 1)
- num
Output
Output schema unknown
sidebar.get
Get the sidebar for the current subreddit
reddit.sidebar.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
search.get
Search links page.
This endpoint is a listing.
reddit.search.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - include_facets
string
: boolean value - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - q
string
: a string no longer than 512 characters - restrict_sr
string
: boolean value - show
string
: (optional) the string all - sort
string
: one of (relevance, hot, top, new, comments) - sr_detail
string
: (optional) expand subreddits - syntax
string
: one of (cloudsearch, lucene, plain) - t
string
: one of (hour, day, week, month, year, all) - type
string
: (optional) comma-delimited list of result types (sr, link)
- after
Output
Output schema unknown
rules.get
Get the rules for the current subreddit
reddit.rules.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
related.article.get
Related page: performs a search using title of article as the search query.
This endpoint is a listing.
reddit.related.article.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - article
string
: The base 36 ID of a Link - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
random.get
The Serendipity button
reddit.random.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
r.subreddit.sort.get
This endpoint is a listing.
reddit.r.subreddit.sort.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - t
string
: one of (hour, day, week, month, year, all) - subreddit
string
- sort
string
- after
Output
Output schema unknown
r.subreddit.wiki.page.get
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
reddit.r.subreddit.wiki.page.get({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - v
string
: a wiki revision ID - v2
string
: a wiki revision ID - subreddit
string
- page
Output
Output schema unknown
r.subreddit.wiki.settings.page.post
Update the permissions and visibility of wiki page
reddit.r.subreddit.wiki.settings.page.post({}, context)
Input
- input
object
- listed
string
: boolean value - page
string
: the name of an existing wiki page - permlevel
string
: an integer - uh
string
: a modhash - subreddit
string
- listed
Output
Output schema unknown
r.subreddit.wiki.settings.page.get
Retrieve the current permission settings for page
reddit.r.subreddit.wiki.settings.page.get({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - subreddit
string
- page
Output
Output schema unknown
r.subreddit.wiki.revisions.page.get
Retrieve a list of revisions of this wiki page
This endpoint is a listing.
reddit.r.subreddit.wiki.revisions.page.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - page
string
: the name of an existing wiki page - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.wiki.revisions.get
Retrieve a list of recently changed wiki pages in this subreddit
reddit.r.subreddit.wiki.revisions.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.wiki.pages.get
Retrieve a list of wiki pages in this subreddit
reddit.r.subreddit.wiki.pages.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
r.subreddit.wiki.discussions.page.get
Retrieve a list of discussions about this wiki page
This endpoint is a listing.
reddit.r.subreddit.wiki.discussions.page.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - page
string
: the name of an existing wiki page - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.stylesheet.get
Redirect to the subreddit's stylesheet if one exists.
See also: /api/subreddit_stylesheet.
reddit.r.subreddit.stylesheet.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
r.subreddit.sticky.get
Redirect to one of the posts stickied in the current subreddit
The "num" argument can be used to select a specific sticky, and will default to 1 (the top sticky) if not specified. Will 404 if there is not currently a sticky post in this subreddit.
reddit.r.subreddit.sticky.get({}, context)
Input
- input
object
- num
string
: an integer between 1 and 2 (default: 1) - subreddit
string
- num
Output
Output schema unknown
r.subreddit.sidebar.get
Get the sidebar for the current subreddit
reddit.r.subreddit.sidebar.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
r.subreddit.search.get
Search links page.
This endpoint is a listing.
reddit.r.subreddit.search.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - include_facets
string
: boolean value - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - q
string
: a string no longer than 512 characters - restrict_sr
string
: boolean value - show
string
: (optional) the string all - sort
string
: one of (relevance, hot, top, new, comments) - sr_detail
string
: (optional) expand subreddits - syntax
string
: one of (cloudsearch, lucene, plain) - t
string
: one of (hour, day, week, month, year, all) - type
string
: (optional) comma-delimited list of result types (sr, link) - subreddit
string
- after
Output
Output schema unknown
r.subreddit.rules.get
Get the rules for the current subreddit
reddit.r.subreddit.rules.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
r.subreddit.random.get
The Serendipity button
reddit.r.subreddit.random.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
r.subreddit.new.get
This endpoint is a listing.
reddit.r.subreddit.new.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.hot.get
This endpoint is a listing.
reddit.r.subreddit.hot.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.comments.article.get
Get the comment tree for a given Link article.
If supplied, comment is the ID36 of a comment in the comment tree for article. This comment will be the (highlighted) focal point of the returned view and context will be the number of parents shown.
depth is the maximum depth of subtrees in the thread.
limit is the maximum number of comments to return.
See also: /api/morechildren and /api/comment.
reddit.r.subreddit.comments.article.get({}, context)
Input
- input
object
- article
string
: ID36 of a link - comment
string
: (optional) ID36 of a comment - context
string
: an integer between 0 and 8 - depth
string
: (optional) an integer - limit
string
: (optional) an integer - showedits
string
: boolean value - showmore
string
: boolean value - sort
string
: one of (confidence, top, new, hot, controversial, old, random, qa) - sr_detail
string
: (optional) expand subreddits - subreddit
string
- article
Output
Output schema unknown
r.subreddit.api.wiki.revert.post
Revert a wiki page to revision
reddit.r.subreddit.api.wiki.revert.post({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - revision
string
: a wiki revision ID - uh
string
: a modhash - subreddit
string
- page
Output
Output schema unknown
r.subreddit.api.wiki.hide.post
Toggle the public visibility of a wiki page revision
reddit.r.subreddit.api.wiki.hide.post({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - revision
string
: a wiki revision ID - uh
string
: a modhash - subreddit
string
- page
Output
Output schema unknown
r.subreddit.api.wiki.edit.post
Edit a wiki page
reddit.r.subreddit.api.wiki.edit.post({}, context)
Input
- input
object
- content
string
- page
string
: the name of an existing page or a new page to create - previous
string
: the starting point revision for this edit - reason
string
: a string up to 256 characters long, consisting of printable characters. - uh
string
: a modhash - subreddit
string
- content
Output
Output schema unknown
r.subreddit.api.wiki.alloweditor.act.post
Allow/deny username to edit this wiki page
reddit.r.subreddit.api.wiki.alloweditor.act.post({}, context)
Input
- input
object
- act
string
: one of (del, add) - page
string
: the name of an existing wiki page - uh
string
: a modhash - username
string
: the name of an existing user - subreddit
string
- act
Output
Output schema unknown
r.subreddit.api.upload_sr_img.post
Add or replace a subreddit image, custom header logo, custom mobile icon, or custom mobile banner.
If the upload_type value is img, an image for use in the subreddit stylesheet is uploaded with the name specified in name. If the upload_type value is header then the image uploaded will be the subreddit's new logo and name will be ignored. If the upload_type value is icon then the image uploaded will be the subreddit's new mobile icon and name will be ignored. If the upload_type value is banner then the image uploaded will be the subreddit's new mobile banner and name will be ignored.
For backwards compatibility, if upload_type is not specified, the header field will be used instead:
If the header field has value 0, then upload_type is img. If the header field has value 1, then upload_type is header.
The img_type field specifies whether to store the uploaded image as a PNG or JPEG.
Subreddits have a limited number of images that can be in use at any given time. If no image with the specified name already exists, one of the slots will be consumed.
If an image with the specified name already exists, it will be replaced. This does not affect the stylesheet immediately, but will take effect the next time the stylesheet is saved.
See also: /api/delete_sr_img, /api/delete_sr_header, /api/delete_sr_icon, and /api/delete_sr_banner.
reddit.r.subreddit.api.upload_sr_img.post({}, context)
Input
- input
object
- file
string
: file upload with maximum size of 500 KiB - formid
string
: (optional) can be ignored - header
string
: an integer between 0 and 1 - img_type
string
: one of png or jpg (default: png) - name
string
: a valid subreddit image name - uh
string
: a modhash - upload_type
string
: one of (img, header, icon, banner) - subreddit
string
- file
Output
Output schema unknown
r.subreddit.api.unfriend.post
Remove a relationship between a user and another user or subreddit
The user can either be passed in by name (nuser) or by fullname (iuser). If type is friend or enemy, 'container' MUST be the current user's fullname; for other types, the subreddit must be set via URL (e.g., /r/funny/api/unfriend)
OAuth2 use requires appropriate scope based on the 'type' of the relationship:
moderator: modothers moderator_invite: modothers contributor: modcontributors banned: modcontributors muted: modcontributors wikibanned: modcontributors and modwiki wikicontributor: modcontributors and modwiki friend: Use /api/v1/me/friends/{username} enemy: privatemessages
Complement to POST_friend
reddit.r.subreddit.api.unfriend.post({}, context)
Input
- input
object
- container
string
- id
string
: fullname of a thing - name
string
: the name of an existing user - type
string
: one of (friend, enemy, moderator, moderator_invite, contributor, banned, muted, wikibanned, wikicontributor) - uh
string
: a modhash - subreddit
string
- container
Output
Output schema unknown
r.subreddit.api.subreddit_stylesheet.post
Update a subreddit's stylesheet.
op should be save to update the contents of the stylesheet.
reddit.r.subreddit.api.subreddit_stylesheet.post({}, context)
Input
- input
object
- api_type
string
: the string json - op
string
: one of (save, preview) - reason
string
: a string up to 256 characters long, consisting of printable characters. - stylesheet_contents
string
: the new stylesheet content - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.submit_text.get
Get the submission text for the subreddit.
This text is set by the subreddit moderators and intended to be displayed on the submission form.
See also: /api/site_admin.
reddit.r.subreddit.api.submit_text.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
r.subreddit.api.setpermissions.post
reddit.r.subreddit.api.setpermissions.post({}, context)
Input
- input
object
- api_type
string
: the string json - name
string
: the name of an existing user - permissions
string
- type
string
- uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.setflairenabled.post
reddit.r.subreddit.api.setflairenabled.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_enabled
string
: boolean value - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.selectflair.post
reddit.r.subreddit.api.selectflair.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_template_id
string
- link
string
: a fullname of a link - name
string
: a user by name - text
string
: a string no longer than 64 characters - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.info.get
Return a listing of things specified by their fullnames.
Only Links, Comments, and Subreddits are allowed.
reddit.r.subreddit.api.info.get({}, context)
Input
- input
object
- id
string
: A comma-separated list of thing fullnames - url
string
: a valid URL - subreddit
string
- id
Output
Output schema unknown
r.subreddit.api.friend.post
Create a relationship between a user and another user or subreddit
OAuth2 use requires appropriate scope based on the 'type' of the relationship:
moderator: Use "moderator_invite" moderator_invite: modothers contributor: modcontributors banned: modcontributors muted: modcontributors wikibanned: modcontributors and modwiki wikicontributor: modcontributors and modwiki friend: Use /api/v1/me/friends/{username} enemy: Use /api/block
Complement to POST_unfriend
reddit.r.subreddit.api.friend.post({}, context)
Input
- input
object
- api_type
string
: the string json - ban_message
string
: raw markdown text - ban_reason
string
: a string no longer than 100 characters - container
string
- duration
string
: an integer between 1 and 999 - name
string
: the name of an existing user - note
string
: a string no longer than 300 characters - permissions
string
- type
string
: one of (friend, moderator, moderator_invite, contributor, banned, muted, wikibanned, wikicontributor) - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.flairtemplate.post
reddit.r.subreddit.api.flairtemplate.post({}, context)
Input
- input
object
- api_type
string
: the string json - css_class
string
: a valid subreddit image name - flair_template_id
string
- flair_type
string
: one of (USER_FLAIR, LINK_FLAIR) - text
string
: a string no longer than 64 characters - text_editable
string
: boolean value - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.flairselector.post
Return information about a users's flair options.
If link is given, return link flair options. Otherwise, return user flair options for this subreddit.
The logged in user's flair is also returned. Subreddit moderators may give a user by name to instead retrieve that user's flair.
reddit.r.subreddit.api.flairselector.post({}, context)
Input
- input
object
- link
string
: a fullname of a link - name
string
: a user by name - subreddit
string
- link
Output
Output schema unknown
r.subreddit.api.flairlist.get
This endpoint is a listing.
reddit.r.subreddit.api.flairlist.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 1000) - name
string
: a user by name - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.api.flaircsv.post
Change the flair of multiple users in the same subreddit with a single API call.
Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored).
If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair.
Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.
reddit.r.subreddit.api.flaircsv.post({}, context)
Input
- input
object
- flair_csv
string
: comma-seperated flair information - uh
string
: a modhash - subreddit
string
- flair_csv
Output
Output schema unknown
r.subreddit.api.flairconfig.post
reddit.r.subreddit.api.flairconfig.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_enabled
string
: boolean value - flair_position
string
: one of (left, right) - flair_self_assign_enabled
string
: boolean value - link_flair_position
string
: one of (,left,right
) - link_flair_self_assign_enabled
string
: boolean value - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.flair.post
reddit.r.subreddit.api.flair.post({}, context)
Input
- input
object
- api_type
string
: the string json - css_class
string
: a valid subreddit image name - link
string
: a fullname of a link - name
string
: a user by name - text
string
: a string no longer than 64 characters - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.deleteflairtemplate.post
reddit.r.subreddit.api.deleteflairtemplate.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_template_id
string
- uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.deleteflair.post
reddit.r.subreddit.api.deleteflair.post({}, context)
Input
- input
object
- api_type
string
: the string json - name
string
: a user by name - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.delete_sr_img.post
Remove an image from the subreddit's custom image set.
The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed.
See also: /api/upload_sr_img.
reddit.r.subreddit.api.delete_sr_img.post({}, context)
Input
- input
object
- api_type
string
: the string json - img_name
string
: a valid subreddit image name - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.delete_sr_icon.post
Remove the subreddit's custom mobile icon.
See also: /api/upload_sr_img.
reddit.r.subreddit.api.delete_sr_icon.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.delete_sr_header.post
Remove the subreddit's custom header image.
The sitewide-default header image will be shown again after this call.
See also: /api/upload_sr_img.
reddit.r.subreddit.api.delete_sr_header.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.delete_sr_banner.post
Remove the subreddit's custom mobile banner.
See also: /api/upload_sr_img.
reddit.r.subreddit.api.delete_sr_banner.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.clearflairtemplates.post
reddit.r.subreddit.api.clearflairtemplates.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_type
string
: one of (USER_FLAIR, LINK_FLAIR) - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.api.accept_moderator_invite.post
Accept an invite to moderate the specified subreddit.
The authenticated user must have been invited to moderate the subreddit by one of its current moderators.
See also: /api/friend and /subreddits/mine.
reddit.r.subreddit.api.accept_moderator_invite.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
r.subreddit.about.where.get
This endpoint is a listing.
reddit.r.subreddit.about.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - user
string
: A valid, existing reddit username - subreddit
string
- where
string
- after
Output
Output schema unknown
r.subreddit.about.location.get
Return a listing of posts relevant to moderators.
reports: Things that have been reported. spam: Things that have been marked as spam or otherwise removed. modqueue: Things requiring moderator review, such as reported things and items caught by the spam filter. unmoderated: Things that have yet to be approved/removed by a mod. edited: Things that have been edited recently.
Requires the "posts" moderator permission for the subreddit.
This endpoint is a listing.
reddit.r.subreddit.about.location.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - location
string
- only
string
: one of (links, comments) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - subreddit
string
- after
Output
Output schema unknown
r.subreddit.about.log.get
Get a list of recent moderation actions.
Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information.
The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit.
The type parameter is optional and if sent limits the log entries returned to only those of the type specified.
This endpoint is a listing.
reddit.r.subreddit.about.log.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 500) - mod
string
: (optional) a moderator filter - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - type
string
: one of (banuser, unbanuser, removelink, approvelink, removecomment, approvecomment, addmoderator, 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, deleterule) - subreddit
string
- after
Output
Output schema unknown
r.subreddit.about.edit.get
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.
reddit.r.subreddit.about.edit.get({}, context)
Input
- input
object
- created
string
: one of (true, false) - location
string
- subreddit
string
- created
Output
Output schema unknown
r.subreddit.about.get
Return information about the subreddit.
Data includes the subscriber count, description, and header image.
reddit.r.subreddit.about.get({}, context)
Input
- input
object
- subreddit
string
- subreddit
Output
Output schema unknown
prefs.where.get
This endpoint is a listing.
reddit.prefs.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - where
string
- after
Output
Output schema unknown
new.get
This endpoint is a listing.
reddit.new.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
message.where.get
This endpoint is a listing.
reddit.message.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - mark
string
: one of (true, false) - mid
string
- show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - where
string
- after
Output
Output schema unknown
live.thread.discussions.get
Get a list of reddit submissions linking to this thread.
This endpoint is a listing.
reddit.live.thread.discussions.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - thread
string
- after
Output
Output schema unknown
live.thread.contributors.get
Get a list of users that contribute to this thread.
See also: /api/live/thread/invite_contributor, and /api/live/thread/rm_contributor.
reddit.live.thread.contributors.get({}, context)
Input
- input
object
- thread
string
- thread
Output
Output schema unknown
live.thread.about.get
Get some basic information about the live thread.
See also: /api/live/thread/edit.
reddit.live.thread.about.get({}, context)
Input
- input
object
- thread
string
- thread
Output
Output schema unknown
live.thread.get
Get a list of updates posted in this thread.
See also: /api/live/thread/update.
This endpoint is a listing.
reddit.live.thread.get({}, context)
Input
- input
object
- after
string
: the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603 - before
string
: the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603 - count
string
: a positive integer (default: 0) - is_embed
string
: (internal use only) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - stylesr
string
: subreddit name - thread
string
- after
Output
Output schema unknown
hot.get
This endpoint is a listing.
reddit.hot.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
duplicates.article.get
Return a list of other submissions of the same URL
This endpoint is a listing.
reddit.duplicates.article.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - article
string
: The base 36 ID of a Link - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
comments.article.get
Get the comment tree for a given Link article.
If supplied, comment is the ID36 of a comment in the comment tree for article. This comment will be the (highlighted) focal point of the returned view and context will be the number of parents shown.
depth is the maximum depth of subtrees in the thread.
limit is the maximum number of comments to return.
See also: /api/morechildren and /api/comment.
reddit.comments.article.get({}, context)
Input
- input
object
- article
string
: ID36 of a link - comment
string
: (optional) ID36 of a comment - context
string
: an integer between 0 and 8 - depth
string
: (optional) an integer - limit
string
: (optional) an integer - showedits
string
: boolean value - showmore
string
: boolean value - sort
string
: one of (confidence, top, new, hot, controversial, old, random, qa) - sr_detail
string
: (optional) expand subreddits
- article
Output
Output schema unknown
captcha.iden.get
Request a CAPTCHA image given an iden.
An iden is given as the captcha field with a BAD_CAPTCHA error, you should use this endpoint if you get a BAD_CAPTCHA error response.
Responds with a 120x50 image/png which should be displayed to the user.
The user's response to the CAPTCHA should be sent as captcha along with your request.
To request a new CAPTCHA, use /api/new_captcha.
reddit.captcha.iden.get({}, context)
Input
- input
object
- iden
string
- iden
Output
Output schema unknown
by_id.names.get
Get a listing of links by fullname.
names is a list of fullnames for links separated by commas or spaces.
reddit.by_id.names.get({}, context)
Input
- input
object
- names
string
: A comma-separated list of link fullnames
- names
Output
Output schema unknown
api.subreddit_stylesheet.post
Update a subreddit's stylesheet.
op should be save to update the contents of the stylesheet.
reddit.api.subreddit_stylesheet.post({}, context)
Input
- input
object
- api_type
string
: the string json - op
string
: one of (save, preview) - reason
string
: a string up to 256 characters long, consisting of printable characters. - stylesheet_contents
string
: the new stylesheet content - uh
string
: a modhash - subreddit
string
- api_type
Output
Output schema unknown
api.wiki.revert.post
Revert a wiki page to revision
reddit.api.wiki.revert.post({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - revision
string
: a wiki revision ID - uh
string
: a modhash
- page
Output
Output schema unknown
api.wiki.hide.post
Toggle the public visibility of a wiki page revision
reddit.api.wiki.hide.post({}, context)
Input
- input
object
- page
string
: the name of an existing wiki page - revision
string
: a wiki revision ID - uh
string
: a modhash
- page
Output
Output schema unknown
api.wiki.edit.post
Edit a wiki page
reddit.api.wiki.edit.post({}, context)
Input
- input
object
- content
string
- page
string
: the name of an existing page or a new page to create - previous
string
: the starting point revision for this edit - reason
string
: a string up to 256 characters long, consisting of printable characters. - uh
string
: a modhash
- content
Output
Output schema unknown
api.wiki.alloweditor.act.post
Allow/deny username to edit this wiki page
reddit.api.wiki.alloweditor.act.post({}, context)
Input
- input
object
- act
string
: one of (del, add) - page
string
: the name of an existing wiki page - uh
string
: a modhash - username
string
: the name of an existing user
- act
Output
Output schema unknown
api.vote.post
Cast a vote on a thing.
id should be the fullname of the Link or Comment to vote on.
dir indicates the direction of the vote. Voting 1 is an upvote, -1 is a downvote, and 0 is equivalent to "un-voting" by clicking again on a highlighted arrow.
Note: votes must be cast by humans. That is, API clients proxying a human's action one-for-one are OK, but bots deciding how to vote on content or amplifying a human's vote are not. See the reddit rules for more details on what constitutes vote cheating.
reddit.api.vote.post({}, context)
Input
- input
object
- dir
string
: vote direction. one of (1, 0, -1) - id
string
: fullname of a thing - uh
string
: a modhash
- dir
Output
Output schema unknown
api.v1.user.username.trophies.get
Return a list of trophies for the a given user.
reddit.api.v1.user.username.trophies.get({}, context)
Input
- input
object
- id
string
: A valid, existing reddit username - username
string
- id
Output
Output schema unknown
api.v1.scopes.get
Retrieve descriptions of reddit's OAuth2 scopes.
If no scopes are given, information on all scopes are returned.
Invalid scope(s) will result in a 400 error with body that indicates the invalid scope(s).
reddit.api.v1.scopes.get({}, context)
Input
- input
object
- scopes
string
: (optional) An OAuth2 scope string
- scopes
Output
Output schema unknown
api.v1.me.trophies.get
Return a list of trophies for the current user.
reddit.api.v1.me.trophies.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
api.v1.me.prefs.patch
reddit.api.v1.me.prefs.patch({}, context)
Input
- input
object
- This
string
: {
- This
Output
Output schema unknown
api.v1.me.prefs.get
Return the preference settings of the logged in user
reddit.api.v1.me.prefs.get({}, context)
Input
- input
object
- fields
string
: A comma-separated list of items from this set:
- fields
Output
Output schema unknown
api.v1.me.notifications.id.patch
reddit.api.v1.me.notifications.id.patch({}, context)
Input
- input
object
- This
string
: { - id
string
- This
Output
Output schema unknown
api.v1.me.notifications.get
Get my notifications.
reddit.api.v1.me.notifications.get({}, context)
Input
- input
object
- count
string
: an integer between 0 and 1000 (default: 30) - end_date
string
- sort
string
: one of (new, old, None) - start_date
string
- count
Output
Output schema unknown
api.v1.me.karma.get
Return a breakdown of subreddit karma.
reddit.api.v1.me.karma.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
api.v1.me.friends.username.put
Create or update a "friend" relationship.
This operation is idempotent. It can be used to add a new friend, or update an existing friend (e.g., add/change the note on that friend)
reddit.api.v1.me.friends.username.put({}, context)
Input
- input
object
- This
string
: { - username
string
- This
Output
Output schema unknown
api.v1.me.friends.username.get
Get information about a specific 'friend', such as notes.
reddit.api.v1.me.friends.username.get({}, context)
Input
- input
object
- id
string
: A valid, existing reddit username - username
string
- id
Output
Output schema unknown
api.v1.me.friends.username.delete
Stop being friends with a user.
reddit.api.v1.me.friends.username.delete({}, context)
Input
- input
object
- id
string
: A valid, existing reddit username - username
string
- id
Output
Output schema unknown
api.v1.me.get
Returns the identity of the user currently authenticated via OAuth.
reddit.api.v1.me.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
api.v1.gold.give.username.post
reddit.api.v1.gold.give.username.post({}, context)
Input
- input
object
- months
string
: an integer between 1 and 36 - username
string
: A valid, existing reddit username
- months
Output
Output schema unknown
api.v1.gold.gild.fullname.post
reddit.api.v1.gold.gild.fullname.post({}, context)
Input
- input
object
- fullname
string
: fullname of a thing
- fullname
Output
Output schema unknown
api.username_available.get
Check whether a username is available for registration.
reddit.api.username_available.get({}, context)
Input
- input
object
- user
string
: a valid, unused, username
- user
Output
Output schema unknown
api.upload_sr_img.post
Add or replace a subreddit image, custom header logo, custom mobile icon, or custom mobile banner.
If the upload_type value is img, an image for use in the subreddit stylesheet is uploaded with the name specified in name. If the upload_type value is header then the image uploaded will be the subreddit's new logo and name will be ignored. If the upload_type value is icon then the image uploaded will be the subreddit's new mobile icon and name will be ignored. If the upload_type value is banner then the image uploaded will be the subreddit's new mobile banner and name will be ignored.
For backwards compatibility, if upload_type is not specified, the header field will be used instead:
If the header field has value 0, then upload_type is img. If the header field has value 1, then upload_type is header.
The img_type field specifies whether to store the uploaded image as a PNG or JPEG.
Subreddits have a limited number of images that can be in use at any given time. If no image with the specified name already exists, one of the slots will be consumed.
If an image with the specified name already exists, it will be replaced. This does not affect the stylesheet immediately, but will take effect the next time the stylesheet is saved.
See also: /api/delete_sr_img, /api/delete_sr_header, /api/delete_sr_icon, and /api/delete_sr_banner.
reddit.api.upload_sr_img.post({}, context)
Input
- input
object
- file
string
: file upload with maximum size of 500 KiB - formid
string
: (optional) can be ignored - header
string
: an integer between 0 and 1 - img_type
string
: one of png or jpg (default: png) - name
string
: a valid subreddit image name - uh
string
: a modhash - upload_type
string
: one of (img, header, icon, banner)
- file
Output
Output schema unknown
api.unsave.post
Unsave a link or comment.
This removes the thing from the user's saved listings as well.
See also: /api/save.
reddit.api.unsave.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.unread_message.post
reddit.api.unread_message.post({}, context)
Input
- input
object
- id
string
: A comma-separated list of thing fullnames - uh
string
: a modhash
- id
Output
Output schema unknown
api.unmute_message_author.post
For unmuting user via modmail.
reddit.api.unmute_message_author.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.unmarknsfw.post
Remove the NSFW marking from a link.
See also: /api/marknsfw.
reddit.api.unmarknsfw.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.unlock.post
Unlock a link.
Allow a post to receive new comments.
See also: /api/lock.
reddit.api.unlock.post({}, context)
Input
- input
object
- id
string
: fullname of a link - uh
string
: a modhash
- id
Output
Output schema unknown
api.unignore_reports.post
Allow future reports on a thing to cause notifications.
See also: /api/ignore_reports.
reddit.api.unignore_reports.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.unhide.post
Unhide a link.
See also: /api/hide.
reddit.api.unhide.post({}, context)
Input
- input
object
- id
string
: A comma-separated list of link fullnames - uh
string
: a modhash
- id
Output
Output schema unknown
api.unfriend.post
Remove a relationship between a user and another user or subreddit
The user can either be passed in by name (nuser) or by fullname (iuser). If type is friend or enemy, 'container' MUST be the current user's fullname; for other types, the subreddit must be set via URL (e.g., /r/funny/api/unfriend)
OAuth2 use requires appropriate scope based on the 'type' of the relationship:
moderator: modothers moderator_invite: modothers contributor: modcontributors banned: modcontributors muted: modcontributors wikibanned: modcontributors and modwiki wikicontributor: modcontributors and modwiki friend: Use /api/v1/me/friends/{username} enemy: privatemessages
Complement to POST_friend
reddit.api.unfriend.post({}, context)
Input
- input
object
- container
string
- id
string
: fullname of a thing - name
string
: the name of an existing user - type
string
: one of (friend, enemy, moderator, moderator_invite, contributor, banned, muted, wikibanned, wikicontributor) - uh
string
: a modhash
- container
Output
Output schema unknown
api.uncollapse_message.post
Uncollapse a message
See also: /api/collapse_message
reddit.api.uncollapse_message.post({}, context)
Input
- input
object
- id
string
: A comma-separated list of thing fullnames - uh
string
: a modhash
- id
Output
Output schema unknown
api.unblock_subreddit.post
reddit.api.unblock_subreddit.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.subscribe.post
Subscribe to or unsubscribe from a subreddit.
To subscribe, action should be sub. To unsubscribe, action should be unsub. The user must have access to the subreddit to be able to subscribe to it.
See also: /subreddits/mine/.
reddit.api.subscribe.post({}, context)
Input
- input
object
- action
string
: one of (sub, unsub) - sr
string
: the name of a subreddit - uh
string
: a modhash
- action
Output
Output schema unknown
api.subreddits_by_topic.get
Return a list of subreddits that are relevant to a search query.
reddit.api.subreddits_by_topic.get({}, context)
Input
- input
object
- query
string
: a string no longer than 50 characters
- query
Output
Output schema unknown
api.submit_text.get
Get the submission text for the subreddit.
This text is set by the subreddit moderators and intended to be displayed on the submission form.
See also: /api/site_admin.
reddit.api.submit_text.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
api.submit.post
Submit a link to a subreddit.
Submit will create a link or self-post in the subreddit sr with the title title. If kind is "link", then url is expected to be a valid URL to link to. Otherwise, text, if present, will be the body of the self-post.
If a link with the same URL has already been submitted to the specified subreddit an error will be returned unless resubmit is true. extension is used for determining which view-type (e.g. json, compact etc.) to use for the redirect that is generated if the resubmit error occurs.
reddit.api.submit.post({}, context)
Input
- input
object
- api_type
string
: the string json - captcha
string
: the user's response to the CAPTCHA challenge - extension
string
: extension used for redirects - iden
string
: the identifier of the CAPTCHA challenge - kind
string
: one of (link, self) - resubmit
string
: boolean value - sendreplies
string
: boolean value - sr
string
: name of a subreddit - text
string
: raw markdown text - title
string
: title of the submission. up to 300 characters long - uh
string
: a modhash - url
string
: a valid URL
- api_type
Output
Output schema unknown
api.store_visits.post
Requires a subscription to reddit gold
reddit.api.store_visits.post({}, context)
Input
- input
object
- links
string
: A comma-separated list of link fullnames - uh
string
: a modhash
- links
Output
Output schema unknown
api.site_admin.post
Create or configure a subreddit.
If sr is specified, the request will attempt to modify the specified subreddit. If not, a subreddit with name name will be created.
This endpoint expects all values to be supplied on every request. If modifying a subset of options, it may be useful to get the current settings from /about/edit.json first.
For backwards compatibility, description is the sidebar text and public_description is the publicly visible subreddit description.
Most of the parameters for this endpoint are identical to options visible in the user interface and their meanings are best explained there.
See also: /about/edit.json.
reddit.api.site_admin.post({}, context)
Input
- input
object
- allow_top
string
: boolean value - api_type
string
: the string json - captcha
string
: the user's response to the CAPTCHA challenge - collapse_deleted_comments
string
: boolean value - comment_score_hide_mins
string
: an integer between 0 and 1440 (default: 0) - description
string
: raw markdown text - exclude_banned_modqueue
string
: boolean value - header-title
string
: a string no longer than 500 characters - hide_ads
string
: boolean value - iden
string
: the identifier of the CAPTCHA challenge - lang
string
: a valid IETF language tag (underscore separated) - link_type
string
: one of (any, link, self) - modmail_email_address
string
- modmail_email_enabled
string
: boolean value - name
string
: subreddit name - over_18
string
: boolean value - public_description
string
: raw markdown text - public_traffic
string
: boolean value - show_media
string
: boolean value - spam_comments
string
: one of (low, high, all) - spam_links
string
: one of (low, high, all) - spam_selfposts
string
: one of (low, high, all) - sr
string
: fullname of a thing - submit_link_label
string
: a string no longer than 60 characters - submit_text
string
: raw markdown text - submit_text_label
string
: a string no longer than 60 characters - suggested_comment_sort
string
: one of (confidence, top, new, hot, controversial, old, random, qa) - title
string
: a string no longer than 100 characters - type
string
: one of (gold_restricted, archived, restricted, gold_only, employees_only, private, public) - uh
string
: a modhash - wiki_edit_age
string
: an integer greater than 0 (default: 0) - wiki_edit_karma
string
: an integer greater than 0 (default: 0) - wikimode
string
: one of (disabled, modonly, anyone)
- allow_top
Output
Output schema unknown
api.setpermissions.post
reddit.api.setpermissions.post({}, context)
Input
- input
object
- api_type
string
: the string json - name
string
: the name of an existing user - permissions
string
- type
string
- uh
string
: a modhash
- api_type
Output
Output schema unknown
api.setflairenabled.post
reddit.api.setflairenabled.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_enabled
string
: boolean value - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.set_suggested_sort.post
Set a suggested sort for a link.
Suggested sorts are useful to display comments in a certain preferred way for posts. For example, casual conversation may be better sorted by new by default, or AMAs may be sorted by Q&A. A sort of an empty string clears the default sort.
reddit.api.set_suggested_sort.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
- sort
string
: one of (confidence, top, new, hot, controversial, old, random, qa, blank) - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.set_subreddit_sticky.post
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.
reddit.api.set_subreddit_sticky.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
- num
string
: an integer between 1 and 2 - state
string
: boolean value - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.set_contest_mode.post
Set or unset "contest mode" for a link's comments.
state is a boolean that indicates whether you are enabling or disabling contest mode - true to enable, false to disable.
reddit.api.set_contest_mode.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
- state
string
: boolean value - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.sendreplies.post
Enable or disable inbox replies for a link or comment.
state is a boolean that indicates whether you are enabling or disabling inbox replies - true to enable, false to disable.
reddit.api.sendreplies.post({}, context)
Input
- input
object
- id
string
: fullname of a thing created by the user - state
string
: boolean value - uh
string
: a modhash
- id
Output
Output schema unknown
api.selectflair.post
reddit.api.selectflair.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_template_id
string
- link
string
: a fullname of a link - name
string
: a user by name - text
string
: a string no longer than 64 characters - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.search_reddit_names.post
List subreddit names that begin with a query string.
Subreddits whose names begin with query will be returned. If include_over_18 is false, subreddits with over-18 content restrictions will be filtered from the results.
If exact is true, only an exact match will be returned.
reddit.api.search_reddit_names.post({}, context)
Input
- input
object
- exact
string
: boolean value - include_over_18
string
: boolean value - query
string
: a string up to 50 characters long, consisting of printable characters.
- exact
Output
Output schema unknown
api.saved_categories.get
Get a list of categories in which things are currently saved.
See also: /api/save.
reddit.api.saved_categories.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
api.save.post
Save a link or comment.
Saved things are kept in the user's saved listing for later perusal.
See also: /api/unsave.
reddit.api.save.post({}, context)
Input
- input
object
- category
string
: a category name - id
string
: fullname of a thing - uh
string
: a modhash
- category
Output
Output schema unknown
api.report.post
Report a link, comment or message.
Reporting a thing brings it to the attention of the subreddit's moderators. Reporting a message sends it to a system for admin review.
For links and comments, the thing is implicitly hidden as well (see /api/hide for details).
reddit.api.report.post({}, context)
Input
- input
object
- api_type
string
: the string json - other_reason
string
: a string no longer than 100 characters - reason
string
: a string no longer than 100 characters - site_reason
string
: a string no longer than 100 characters - thing_id
string
: fullname of a thing - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.remove.post
Remove a link, comment, or modmail message.
If the thing is a link, it will be removed from all subreddit listings. If the thing is a comment, it will be redacted and removed from all subreddit comment listings.
See also: /api/approve.
reddit.api.remove.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - spam
string
: boolean value - uh
string
: a modhash
- id
Output
Output schema unknown
api.recommend.sr.srnames.get
Return subreddits recommended for the given subreddit(s).
Gets a list of subreddits recommended for srnames, filtering out any that appear in the optional omit param.
reddit.api.recommend.sr.srnames.get({}, context)
Input
- input
object
- omit
string
: comma-delimited list of subreddit names - srnames
string
: comma-delimited list of subreddit names
- omit
Output
Output schema unknown
api.read_message.post
reddit.api.read_message.post({}, context)
Input
- input
object
- id
string
: A comma-separated list of thing fullnames - uh
string
: a modhash
- id
Output
Output schema unknown
api.read_all_messages.post
Queue up marking all messages for a user as read.
This may take some time, and returns 202 to acknowledge acceptance of the request.
reddit.api.read_all_messages.post({}, context)
Input
- input
object
- uh
string
: a modhash
- uh
Output
Output schema unknown
api.new_captcha.post
Responds with an iden of a new CAPTCHA.
Use this endpoint if a user cannot read a given CAPTCHA, and wishes to receive a new CAPTCHA.
To request the CAPTCHA image for an iden, use /captcha/iden.
reddit.api.new_captcha.post({}, context)
Input
- input
object
- api_type
string
: the string json
- api_type
Output
Output schema unknown
api.needs_captcha.get
Check whether CAPTCHAs are needed for API methods that define the "captcha" and "iden" parameters.
reddit.api.needs_captcha.get(null, context)
Input
This action has no parameters
Output
Output schema unknown
api.mute_message_author.post
For muting user via modmail.
reddit.api.mute_message_author.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.multi.multipath.r.srname.put
Add a subreddit to a multi.
reddit.api.multi.multipath.r.srname.put({}, context)
Input
- input
object
- model
string
: json data: - multipath
string
: multireddit url path - srname
string
: subreddit name - uh
string
: a modhash
- model
Output
Output schema unknown
api.multi.multipath.r.srname.get
Get data about a subreddit in a multi.
reddit.api.multi.multipath.r.srname.get({}, context)
Input
- input
object
- multipath
string
: multireddit url path - srname
string
: subreddit name
- multipath
Output
Output schema unknown
api.multi.multipath.r.srname.delete
Remove a subreddit from a multi.
reddit.api.multi.multipath.r.srname.delete({}, context)
Input
- input
object
- multipath
string
: multireddit url path - srname
string
: subreddit name - uh
string
: a modhash
- multipath
Output
Output schema unknown
api.multi.multipath.description.put
Change a multi's markdown description.
reddit.api.multi.multipath.description.put({}, context)
Input
- input
object
- model
string
: json data: - multipath
string
: multireddit url path - uh
string
: a modhash
- model
Output
Output schema unknown
api.multi.multipath.description.get
Get a multi's description.
reddit.api.multi.multipath.description.get({}, context)
Input
- input
object
- multipath
string
: multireddit url path
- multipath
Output
Output schema unknown
api.multi.multipath.put
Create or update a multi.
reddit.api.multi.multipath.put({}, context)
Input
- input
object
- expand_srs
string
: boolean value - model
string
: json data: - multipath
string
: multireddit url path - uh
string
: a modhash
- expand_srs
Output
Output schema unknown
api.multi.multipath.post
Create a multi. Responds with 409 Conflict if it already exists.
reddit.api.multi.multipath.post({}, context)
Input
- input
object
- expand_srs
string
: boolean value - model
string
: json data: - multipath
string
: multireddit url path - uh
string
: a modhash
- expand_srs
Output
Output schema unknown
api.multi.multipath.get
Fetch a multi's data and subreddit list by name.
reddit.api.multi.multipath.get({}, context)
Input
- input
object
- expand_srs
string
: boolean value - multipath
string
: multireddit url path
- expand_srs
Output
Output schema unknown
api.multi.multipath.delete
Delete a multi.
reddit.api.multi.multipath.delete({}, context)
Input
- input
object
- expand_srs
string
: boolean value - multipath
string
: multireddit url path - uh
string
: a modhash
- expand_srs
Output
Output schema unknown
api.multi.user.username.get
Fetch a list of public multis belonging to username
reddit.api.multi.user.username.get({}, context)
Input
- input
object
- expand_srs
string
: boolean value - username
string
: A valid, existing reddit username
- expand_srs
Output
Output schema unknown
api.multi.rename.post
Rename a multi.
reddit.api.multi.rename.post({}, context)
Input
- input
object
- display_name
string
: a string no longer than 50 characters - from
string
: multireddit url path - to
string
: destination multireddit url path - uh
string
: a modhash
- display_name
Output
Output schema unknown
api.multi.mine.get
Fetch a list of multis belonging to the current user.
reddit.api.multi.mine.get({}, context)
Input
- input
object
- expand_srs
string
: boolean value
- expand_srs
Output
Output schema unknown
api.multi.copy.post
Copy a multi.
Responds with 409 Conflict if the target already exists.
A "copied from ..." line will automatically be appended to the description.
reddit.api.multi.copy.post({}, context)
Input
- input
object
- display_name
string
: a string no longer than 50 characters - from
string
: multireddit url path - to
string
: destination multireddit url path - uh
string
: a modhash
- display_name
Output
Output schema unknown
api.morechildren.get
Retrieve additional comments omitted from a base comment tree.
When a comment tree is rendered, the most relevant comments are selected for display first. Remaining comments are stubbed out with "MoreComments" links. This API call is used to retrieve the additional comments represented by those stubs, up to 20 at a time.
The two core parameters required are link and children. link is the fullname of the link whose comments are being fetched. children is a comma-delimited list of comment ID36s that need to be fetched.
If id is passed, it should be the ID of the MoreComments object this call is replacing. This is needed only for the HTML UI's purposes and is optional otherwise.
NOTE: you may only make one request at a time to this API endpoint. Higher concurrency will result in an error being returned.
reddit.api.morechildren.get({}, context)
Input
- input
object
- api_type
string
: the string json - children
string
: a comma-delimited list of comment ID36s - id
string
: (optional) id of the associated MoreChildren object - link_id
string
: fullname of a thing - sort
string
: one of (confidence, top, new, hot, controversial, old, random, qa)
- api_type
Output
Output schema unknown
api.marknsfw.post
Mark a link NSFW.
See also: /api/unmarknsfw.
reddit.api.marknsfw.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.lock.post
Lock a link.
Prevents a post from receiving new comments.
See also: /api/unlock.
reddit.api.lock.post({}, context)
Input
- input
object
- id
string
: fullname of a link - uh
string
: a modhash
- id
Output
Output schema unknown
api.live.thread.update.post
Post an update to the thread.
Requires the update permission for this thread.
See also: /api/live/thread/strike_update, and /api/live/thread/delete_update.
reddit.api.live.thread.update.post({}, context)
Input
- input
object
- api_type
string
: the string json - body
string
: raw markdown text - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.strike_update.post
Strike (mark incorrect and cross out) the content of an update.
Requires that specified update must have been authored by the user or that you have the edit permission for this thread.
See also: /api/live/thread/update.
reddit.api.live.thread.strike_update.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
: the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603 - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.set_contributor_permissions.post
Change a contributor or contributor invite's permissions.
Requires the manage permission for this thread.
See also: /api/live/thread/invite_contributor and /api/live/thread/rm_contributor.
reddit.api.live.thread.set_contributor_permissions.post({}, context)
Input
- input
object
- api_type
string
: the string json - name
string
: the name of an existing user - permissions
string
: permission description e.g. +update,+edit,-manage - type
string
: one of (liveupdate_contributor_invite, liveupdate_contributor) - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.rm_contributor_invite.post
Revoke an outstanding contributor invite.
Requires the manage permission for this thread.
See also: /api/live/thread/invite_contributor.
reddit.api.live.thread.rm_contributor_invite.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
: fullname of a account - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.rm_contributor.post
Revoke another user's contributorship.
Requires the manage permission for this thread.
See also: /api/live/thread/invite_contributor.
reddit.api.live.thread.rm_contributor.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
: fullname of a account - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.report.post
Report the thread for violating the rules of reddit.
reddit.api.live.thread.report.post({}, context)
Input
- input
object
- api_type
string
: the string json - type
string
: one of (spam, vote-manipulation, personal-information, sexualizing-minors, site-breaking) - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.leave_contributor.post
Abdicate contributorship of the thread.
See also: /api/live/thread/accept_contributor_invite, and /api/live/thread/invite_contributor.
reddit.api.live.thread.leave_contributor.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.invite_contributor.post
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.
reddit.api.live.thread.invite_contributor.post({}, context)
Input
- input
object
- api_type
string
: the string json - name
string
: the name of an existing user - permissions
string
: permission description e.g. +update,+edit,-manage - type
string
: one of (liveupdate_contributor_invite, liveupdate_contributor) - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.edit.post
Configure the thread.
Requires the settings permission for this thread.
See also: /live/thread/about.json.
reddit.api.live.thread.edit.post({}, context)
Input
- input
object
- api_type
string
: the string json - description
string
: raw markdown text - nsfw
string
: boolean value - resources
string
: raw markdown text - title
string
: a string no longer than 120 characters - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.delete_update.post
Delete an update from the thread.
Requires that specified update must have been authored by the user or that you have the edit permission for this thread.
See also: /api/live/thread/update.
reddit.api.live.thread.delete_update.post({}, context)
Input
- input
object
- api_type
string
: the string json - id
string
: the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603 - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.close_thread.post
Permanently close the thread, disallowing future updates.
Requires the close permission for this thread.
reddit.api.live.thread.close_thread.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.thread.accept_contributor_invite.post
Accept a pending invitation to contribute to the thread.
See also: /api/live/thread/leave_contributor.
reddit.api.live.thread.accept_contributor_invite.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash - thread
string
- api_type
Output
Output schema unknown
api.live.create.post
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.
reddit.api.live.create.post({}, context)
Input
- input
object
- api_type
string
: the string json - description
string
: raw markdown text - nsfw
string
: boolean value - resources
string
: raw markdown text - title
string
: a string no longer than 120 characters - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.leavemoderator.post
Abdicate moderator status in a subreddit.
See also: /api/friend.
reddit.api.leavemoderator.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.leavecontributor.post
Abdicate approved submitter status in a subreddit.
See also: /api/friend.
reddit.api.leavecontributor.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.info.get
Return a listing of things specified by their fullnames.
Only Links, Comments, and Subreddits are allowed.
reddit.api.info.get({}, context)
Input
- input
object
- id
string
: A comma-separated list of thing fullnames - url
string
: a valid URL
- id
Output
Output schema unknown
api.ignore_reports.post
Prevent future reports on a thing from causing notifications.
Any reports made about a thing after this flag is set on it will not cause notifications or make the thing show up in the various moderation listings.
See also: /api/unignore_reports.
reddit.api.ignore_reports.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.hide.post
Hide a link.
This removes it from the user's default view of subreddit listings.
See also: /api/unhide.
reddit.api.hide.post({}, context)
Input
- input
object
- id
string
: A comma-separated list of link fullnames - uh
string
: a modhash
- id
Output
Output schema unknown
api.friend.post
Create a relationship between a user and another user or subreddit
OAuth2 use requires appropriate scope based on the 'type' of the relationship:
moderator: Use "moderator_invite" moderator_invite: modothers contributor: modcontributors banned: modcontributors muted: modcontributors wikibanned: modcontributors and modwiki wikicontributor: modcontributors and modwiki friend: Use /api/v1/me/friends/{username} enemy: Use /api/block
Complement to POST_unfriend
reddit.api.friend.post({}, context)
Input
- input
object
- api_type
string
: the string json - ban_message
string
: raw markdown text - ban_reason
string
: a string no longer than 100 characters - container
string
- duration
string
: an integer between 1 and 999 - name
string
: the name of an existing user - note
string
: a string no longer than 300 characters - permissions
string
- type
string
: one of (friend, moderator, moderator_invite, contributor, banned, muted, wikibanned, wikicontributor) - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.flairtemplate.post
reddit.api.flairtemplate.post({}, context)
Input
- input
object
- api_type
string
: the string json - css_class
string
: a valid subreddit image name - flair_template_id
string
- flair_type
string
: one of (USER_FLAIR, LINK_FLAIR) - text
string
: a string no longer than 64 characters - text_editable
string
: boolean value - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.flairselector.post
Return information about a users's flair options.
If link is given, return link flair options. Otherwise, return user flair options for this subreddit.
The logged in user's flair is also returned. Subreddit moderators may give a user by name to instead retrieve that user's flair.
reddit.api.flairselector.post({}, context)
Input
- input
object
- link
string
: a fullname of a link - name
string
: a user by name
- link
Output
Output schema unknown
api.flairlist.get
This endpoint is a listing.
reddit.api.flairlist.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 1000) - name
string
: a user by name - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
api.flaircsv.post
Change the flair of multiple users in the same subreddit with a single API call.
Requires a string 'flair_csv' which has up to 100 lines of the form 'user,flairtext,cssclass' (Lines beyond the 100th are ignored).
If both cssclass and flairtext are the empty string for a given user, instead clears that user's flair.
Returns an array of objects indicating if each flair setting was applied, or a reason for the failure.
reddit.api.flaircsv.post({}, context)
Input
- input
object
- flair_csv
string
: comma-seperated flair information - uh
string
: a modhash
- flair_csv
Output
Output schema unknown
api.flairconfig.post
reddit.api.flairconfig.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_enabled
string
: boolean value - flair_position
string
: one of (left, right) - flair_self_assign_enabled
string
: boolean value - link_flair_position
string
: one of (,left,right
) - link_flair_self_assign_enabled
string
: boolean value - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.flair.post
reddit.api.flair.post({}, context)
Input
- input
object
- api_type
string
: the string json - css_class
string
: a valid subreddit image name - link
string
: a fullname of a link - name
string
: a user by name - text
string
: a string no longer than 64 characters - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.editusertext.post
Edit the body text of a comment or self-post.
reddit.api.editusertext.post({}, context)
Input
- input
object
- api_type
string
: the string json - text
string
: raw markdown text - thing_id
string
: fullname of a thing created by the user - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.distinguish.post
Distinguish a thing's author with a sigil.
This can be useful to draw attention to and confirm the identity of the user in the context of a link or comment of theirs. The options for distinguish are as follows:
yes - add a moderator distinguish ([M]). only if the user is a moderator of the subreddit the thing is in. no - remove any distinguishes. admin - add an admin distinguish ([A]). admin accounts only. special - add a user-specific distinguish. depends on user.
The first time a top-level comment is moderator distinguished, the author of the link the comment is in reply to will get a notification in their inbox.
reddit.api.distinguish.post({}, context)
Input
- input
object
- api_type
string
: the string json - how
string
: one of (yes, no, admin, special) - id
string
: fullname of a thing - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.deleteflairtemplate.post
reddit.api.deleteflairtemplate.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_template_id
string
- uh
string
: a modhash
- api_type
Output
Output schema unknown
api.deleteflair.post
reddit.api.deleteflair.post({}, context)
Input
- input
object
- api_type
string
: the string json - name
string
: a user by name - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.delete_sr_img.post
Remove an image from the subreddit's custom image set.
The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed.
See also: /api/upload_sr_img.
reddit.api.delete_sr_img.post({}, context)
Input
- input
object
- api_type
string
: the string json - img_name
string
: a valid subreddit image name - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.delete_sr_icon.post
Remove the subreddit's custom mobile icon.
See also: /api/upload_sr_img.
reddit.api.delete_sr_icon.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.delete_sr_header.post
Remove the subreddit's custom header image.
The sitewide-default header image will be shown again after this call.
See also: /api/upload_sr_img.
reddit.api.delete_sr_header.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.delete_sr_banner.post
Remove the subreddit's custom mobile banner.
See also: /api/upload_sr_img.
reddit.api.delete_sr_banner.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.del.post
Delete a Link or Comment.
reddit.api.del.post({}, context)
Input
- input
object
- id
string
: fullname of a thing created by the user - uh
string
: a modhash
- id
Output
Output schema unknown
api.compose.post
Handles message composition under /message/compose.
reddit.api.compose.post({}, context)
Input
- input
object
- api_type
string
: the string json - captcha
string
: the user's response to the CAPTCHA challenge - from_sr
string
: subreddit name - iden
string
: the identifier of the CAPTCHA challenge - subject
string
: a string no longer than 100 characters - text
string
: raw markdown text - to
string
: the name of an existing user - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.comment.post
Submit a new comment or reply to a message.
parent is the fullname of the thing being replied to. Its value changes the kind of object created by this request:
the fullname of a Link: a top-level comment in that Link's thread. (requires submit scope) the fullname of a Comment: a comment reply to that comment. (requires submit scope) the fullname of a Message: a message reply to that message. (requires privatemessages scope)
text should be the raw markdown body of the comment or message.
To start a new message thread, use /api/compose.
reddit.api.comment.post({}, context)
Input
- input
object
- api_type
string
: the string json - text
string
: raw markdown text - thing_id
string
: fullname of parent thing - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.collapse_message.post
Collapse a message
See also: /api/uncollapse_message
reddit.api.collapse_message.post({}, context)
Input
- input
object
- id
string
: A comma-separated list of thing fullnames - uh
string
: a modhash
- id
Output
Output schema unknown
api.clearflairtemplates.post
reddit.api.clearflairtemplates.post({}, context)
Input
- input
object
- api_type
string
: the string json - flair_type
string
: one of (USER_FLAIR, LINK_FLAIR) - uh
string
: a modhash
- api_type
Output
Output schema unknown
api.block.post
For blocking via inbox.
reddit.api.block.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.approve.post
Approve a link or comment.
If the thing was removed, it will be re-inserted into appropriate listings. Any reports on the approved thing will be discarded.
See also: /api/remove.
reddit.api.approve.post({}, context)
Input
- input
object
- id
string
: fullname of a thing - uh
string
: a modhash
- id
Output
Output schema unknown
api.accept_moderator_invite.post
Accept an invite to moderate the specified subreddit.
The authenticated user must have been invited to moderate the subreddit by one of its current moderators.
See also: /api/friend and /subreddits/mine.
reddit.api.accept_moderator_invite.post({}, context)
Input
- input
object
- api_type
string
: the string json - uh
string
: a modhash
- api_type
Output
Output schema unknown
about.where.get
This endpoint is a listing.
reddit.about.where.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - user
string
: A valid, existing reddit username - where
string
- after
Output
Output schema unknown
about.location.get
Return a listing of posts relevant to moderators.
reports: Things that have been reported. spam: Things that have been marked as spam or otherwise removed. modqueue: Things requiring moderator review, such as reported things and items caught by the spam filter. unmoderated: Things that have yet to be approved/removed by a mod. edited: Things that have been edited recently.
Requires the "posts" moderator permission for the subreddit.
This endpoint is a listing.
reddit.about.location.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 100) - location
string
- only
string
: one of (links, comments) - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits
- after
Output
Output schema unknown
about.log.get
Get a list of recent moderation actions.
Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information.
The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit.
The type parameter is optional and if sent limits the log entries returned to only those of the type specified.
This endpoint is a listing.
reddit.about.log.get({}, context)
Input
- input
object
- after
string
: fullname of a thing - before
string
: fullname of a thing - count
string
: a positive integer (default: 0) - limit
string
: the maximum number of items desired (default: 25, maximum: 500) - mod
string
: (optional) a moderator filter - show
string
: (optional) the string all - sr_detail
string
: (optional) expand subreddits - type
string
: one of (banuser, unbanuser, removelink, approvelink, removecomment, approvecomment, addmoderator, 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, deleterule)
- after
Output
Output schema unknown
Definitions
This integration has no definitions