Skip to content

Latest commit

 

History

History
285 lines (259 loc) · 38.2 KB

ENDPOINTS.md

File metadata and controls

285 lines (259 loc) · 38.2 KB

#Endpoints

This file contains a list of all the endpoints (regardless of if they have been implemented) that can be found at the official Reddit API docs. To update this file, run ./gradlew endpoints:update.

So far 112 endpoints (out of 183 total) have been implemented.

##(any scope)

Method Endpoint Implemented?
GET /api/needs_captcha.json RedditClient.needsCaptcha()
POST /api/new_captcha RedditClient.getNewCaptcha()
POST /captcha/{iden} RedditClient.getCaptcha(String)

##(not available through oauth)

Method Endpoint Implemented?
POST /api/clear_sessions No
POST /api/revokeapp No
POST /api/set_force_https No
POST /api/setappicon No
POST /api/setpermissions No
POST /api/unfriend No
POST /api/update No
POST /api/update_email No
POST /api/update_password No
POST /api/adddeveloper [AccountManager.addDeveloper(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#addDeveloper(java.lang.String, java.lang.String))
POST /api/deleteapp AccountManager.deleteApp(String)
POST /api/login RedditClient.login(Credentials)
GET /api/me.json RedditClient.me()
POST /api/register [RedditClient.register(String, String, String, Captcha, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/RedditClient#register(java.lang.String, java.lang.String, java.lang.String, net.dean.jraw.models.Captcha, java.lang.String))
POST /api/removedeveloper [AccountManager.removeDeveloper(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#removeDeveloper(java.lang.String, java.lang.String))
POST /api/updateapp [AccountManager.createOrUpdateApp(String, String, AppType, String, String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#createOrUpdateApp(java.lang.String, java.lang.String, net.dean.jraw.AppType, java.lang.String, java.lang.String, java.lang.String))
GET /api/username_available.json RedditClient.isUsernameAvailable(String)

##account

Method Endpoint Implemented?
PATCH /api/v1/me/prefs RedditOAuth2Client.updatePreferences(AccountPreferencesEditor)

##creddits

Method Endpoint Implemented?
POST /api/v1/gold/gild/{fullname} No
POST /api/v1/gold/give/{username} No

##edit

Method Endpoint Implemented?
POST /api/live/{thread}/delete_update No
POST /api/live/{thread}/strike_update No
POST /api/del AccountManager.delete(String)
POST /api/editusertext [AccountManager.updateSelfpost(Submission, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#updateSelfpost(net.dean.jraw.models.Submission, java.lang.String))
POST /api/sendreplies [AccountManager.sendRepliesToInbox(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#sendRepliesToInbox(net.dean.jraw.models.Submission, boolean))

##flair

Method Endpoint Implemented?
POST /api/flairselector AccountManager.getFlairChoices(String)
POST /api/selectflair [AccountManager.setFlair(String, FlairTemplate, String, Submission, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setFlair(java.lang.String, net.dean.jraw.models.FlairTemplate, java.lang.String, net.dean.jraw.models.Submission, java.lang.String))
POST /api/setflairenabled [AccountManager.setFlairEnabled(String, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setFlairEnabled(java.lang.String, boolean))

##history

Method Endpoint Implemented?
GET /user/{username}/comments UserContributionPaginator.getListing(boolean)
GET /user/{username}/disliked UserContributionPaginator.getListing(boolean)
GET /user/{username}/gilded UserContributionPaginator.getListing(boolean)
GET /user/{username}/hidden UserContributionPaginator.getListing(boolean)
GET /user/{username}/liked UserContributionPaginator.getListing(boolean)
GET /user/{username}/overview UserContributionPaginator.getListing(boolean)
GET /user/{username}/saved UserContributionPaginator.getListing(boolean)
GET /user/{username}/submitted UserContributionPaginator.getListing(boolean)
GET /user/{username}/where UserContributionPaginator.getListing(boolean)

##identity

Method Endpoint Implemented?
GET /api/v1/me RedditOAuth2Client.me()
GET /api/v1/me/prefs RedditOAuth2Client.getPreferences(String[])
GET /api/v1/me/trophies RedditOAuth2Client.getTrophies(String)

##livemanage

Method Endpoint Implemented?
POST /api/live/{thread}/accept_contributor_invite No
POST /api/live/{thread}/close_thread No
POST /api/live/{thread}/edit No
POST /api/live/{thread}/invite_contributor No
POST /api/live/{thread}/leave_contributor No
POST /api/live/{thread}/rm_contributor No
POST /api/live/{thread}/rm_contributor_invite No
POST /api/live/{thread}/set_contributor_permissions No

##modconfig

Method Endpoint Implemented?
POST /api/delete_sr_header No
POST /api/delete_sr_img No
POST /api/site_admin No
POST /api/subreddit_stylesheet No
POST /api/upload_sr_img No
GET /r/{subreddit}/about/edit.json No
GET /stylesheet RedditClient.getStylesheet(String)

##modflair

Method Endpoint Implemented?
POST /api/clearflairtemplates No
POST /api/deleteflair No
POST /api/deleteflairtemplate No
POST /api/flair No
POST /api/flairconfig No
POST /api/flaircsv No
GET /api/flairlist No
POST /api/flairtemplate No

##modlog

Method Endpoint Implemented?
GET /about/log ModLogPaginator.getListing(boolean)

##modposts

Method Endpoint Implemented?
POST /api/approve No
POST /api/distinguish No
POST /api/ignore_reports No
POST /api/remove No
POST /api/set_contest_mode No
POST /api/unignore_reports No
POST /api/marknsfw [AccountManager.setNsfw(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setNsfw(net.dean.jraw.models.Submission, boolean))
POST /api/set_subreddit_sticky [AccountManager.setSticky(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setSticky(net.dean.jraw.models.Submission, boolean))
POST /api/unmarknsfw [AccountManager.setNsfw(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setNsfw(net.dean.jraw.models.Submission, boolean))

##modwiki

Method Endpoint Implemented?
POST /api/wiki/alloweditor/add No
POST /api/wiki/alloweditor/del No
POST /api/wiki/alloweditor/{act} No
POST /api/wiki/hide No
POST /api/wiki/revert No
POST /wiki/settings/{page} No
GET /wiki/settings/{page} [WikiManager.getSettings(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/WikiManager#getSettings(java.lang.String, java.lang.String))

##mysubreddits

Method Endpoint Implemented?
GET /api/v1/me/friends/{username} RedditOAuth2Client.getFriend(String)
GET /api/v1/me/karma RedditOAuth2Client.getKarmaBreakdown()
GET /subreddits/mine/contributor UserSubredditsPaginator.getListing(boolean)
GET /subreddits/mine/moderator UserSubredditsPaginator.getListing(boolean)
GET /subreddits/mine/subscriber UserSubredditsPaginator.getListing(boolean)
GET /subreddits/mine/{where} UserSubredditsPaginator.getListing(boolean)

##privatemessages

Method Endpoint Implemented?
POST /api/block No
POST /api/read_all_messages No
POST /api/unblock_subreddit No
POST /api/compose [InboxManager.compose(String, String, String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/InboxManager#compose(java.lang.String, java.lang.String, java.lang.String, java.lang.String))
POST /api/read_message [InboxManager.setRead(Message, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/InboxManager#setRead(net.dean.jraw.models.Message, boolean))
POST /api/unread_message [InboxManager.setRead(Message, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/InboxManager#setRead(net.dean.jraw.models.Message, boolean))
GET /message/inbox InboxPaginator.getListing(boolean)
GET /message/sent InboxPaginator.getListing(boolean)
GET /message/unread InboxPaginator.getListing(boolean)
GET /message/{where} InboxPaginator.getListing(boolean)

##read

Method Endpoint Implemented?
GET /api/filter/{filterpath} No
GET /api/filter/{filterpath}/r/{srname} No
GET /api/info No
GET /api/recommend/sr/{srnames} No
GET /live/{thread}/contributors.json No
GET /live/{thread}/discussions No
GET /about/banned UserRecordPaginator.getListing(boolean)
GET /about/contributors UserRecordPaginator.getListing(boolean)
GET /about/edited ModeratorPaginator.getListing(boolean)
GET /about/moderators UserRecordPaginator.getListing(boolean)
GET /about/modqueue ModeratorPaginator.getListing(boolean)
GET /about/reports ModeratorPaginator.getListing(boolean)
GET /about/spam ModeratorPaginator.getListing(boolean)
GET /about/unmoderated ModeratorPaginator.getListing(boolean)
GET /about/wikibanned UserRecordPaginator.getListing(boolean)
GET /about/wikicontributors UserRecordPaginator.getListing(boolean)
GET /about/{location} ModeratorPaginator.getListing(boolean)
GET /about/{where} UserRecordPaginator.getListing(boolean)
POST /api/morechildren [RedditClient.getMoreChildren(Submission, CommentSort, More)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/RedditClient#getMoreChildren(net.dean.jraw.models.Submission, net.dean.jraw.models.CommentSort, net.dean.jraw.models.More))
GET /api/multi/mine MultiRedditManager.mine()
GET /api/multi/{multipath} [MultiRedditManager.get(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#get(java.lang.String, java.lang.String))
GET /api/multi/{multipath}/description [MultiRedditManager.getDescription(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#getDescription(java.lang.String, java.lang.String))
PUT /api/multi/{multipath}/description [MultiRedditManager.updateDescription(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#updateDescription(java.lang.String, java.lang.String))
GET /api/multi/{multipath}/r/{srname} [MultiRedditManager.get(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#get(java.lang.String, java.lang.String))
POST /api/search_reddit_names.json [RedditClient.searchSubreddits(String, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/RedditClient#searchSubreddits(java.lang.String, boolean))
GET /api/subreddits_by_topic.json RedditClient.getSubredditsByTopic(String)
GET /api/v1/me/blocked ImportantUserPaginator.getListing(boolean)
GET /api/v1/me/friends ImportantUserPaginator.getListing(boolean)
GET /api/v1/user/{username}/trophies RedditOAuth2Client.getTrophies(String)
GET /by_id/names SpecificPaginator.getListing(boolean)
GET /comments/article RedditClient.getSubmission(SubmissionRequest)
GET /controversial SubredditPaginator.getListing(boolean)
GET /hot SubredditPaginator.getListing(boolean)
GET /live/{thread} LiveThreadPaginator.getListing(boolean)
GET /live/{thread}/about.json RedditClient.getLiveThread(String)
GET /new SubredditPaginator.getListing(boolean)
GET /prefs/blocked ImportantUserPaginator.getListing(boolean)
GET /prefs/friends ImportantUserPaginator.getListing(boolean)
GET /prefs/where ImportantUserPaginator.getListing(boolean)
GET /r/subreddit/about.json RedditClient.getSubreddit(String)
GET /random RedditClient.getRandomSubmission(String)
GET /search SubmissionSearchPaginator.getListing(boolean)
GET /sort SubredditPaginator.getListing(boolean)
GET /subreddits/new AllSubredditsPaginator.getListing(boolean)
GET /subreddits/popular AllSubredditsPaginator.getListing(boolean)
GET /subreddits/search SubredditSearchPaginator.getListing(boolean)
GET /subreddits/where AllSubredditsPaginator.getListing(boolean)
GET /top SubredditPaginator.getListing(boolean)
GET /user/{username}/about.json RedditClient.getUser(String)

##report

Method Endpoint Implemented?
POST /api/live/thread/report No
POST /api/report No
POST /api/hide [AccountManager.hide(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#hide(net.dean.jraw.models.Submission, boolean))
POST /api/unhide [AccountManager.hide(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#hide(net.dean.jraw.models.Submission, boolean))

##save

Method Endpoint Implemented?
GET /api/saved_categories.json No
POST /api/store_visits No
POST /api/save [AccountManager.setSaved(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setSaved(net.dean.jraw.models.Submission, boolean))
POST /api/unsave [AccountManager.setSaved(Submission, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#setSaved(net.dean.jraw.models.Submission, boolean))

##submit

Method Endpoint Implemented?
POST /api/live/create No
POST /api/live/thread/update No
POST /api/comment [AccountManager.reply(Contribution, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#reply(net.dean.jraw.models.Contribution, java.lang.String))
POST /api/submit [AccountManager.submit(SubmissionBuilder, Captcha, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#submit(net.dean.jraw.managers.AccountManager$SubmissionBuilder, net.dean.jraw.models.Captcha, java.lang.String))
GET /api/submit_text.json RedditClient.getSubmitText(String)

##subscribe

Method Endpoint Implemented?
DELETE /api/filter/{filterpath} No
PUT /api/filter/{filterpath} No
DELETE /api/filter/{filterpath}/r/{srname} No
PUT /api/filter/{filterpath}/r/{srname} No
POST /api/multi/{filterpath} No
DELETE /api/multi/{multipath} MultiRedditManager.delete(String)
POST /api/multi/{multipath} [MultiRedditManager.createOrUpdate(String, List, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#createOrUpdate(java.lang.String, java.util.List, boolean))
PUT /api/multi/{multipath} [MultiRedditManager.createOrUpdate(String, List, boolean)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#createOrUpdate(java.lang.String, java.util.List, boolean))
POST /api/multi/{multipath}/copy [MultiRedditManager.copy(String, String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#copy(java.lang.String, java.lang.String, java.lang.String))
DELETE /api/multi/{multipath}/r/{srname} [MultiRedditManager.removeSubreddit(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#removeSubreddit(java.lang.String, java.lang.String))
PUT /api/multi/{multipath}/r/{srname} [MultiRedditManager.addSubreddit(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#addSubreddit(java.lang.String, java.lang.String))
POST /api/multi/{multipath}/rename [MultiRedditManager.rename(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/MultiRedditManager#rename(java.lang.String, java.lang.String))
POST /api/subscribe AccountManager.subscribe(Subreddit)
DELETE /api/v1/me/friends/{username} RedditOAuth2Client.deleteFriend(String)
PUT /api/v1/me/friends/{username} RedditOAuth2Client.updateFriend(String)

##vote

Method Endpoint Implemented?
POST /api/vote [AccountManager.vote(Thing, VoteDirection)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/AccountManager#vote(net.dean.jraw.models.Thing, net.dean.jraw.models.VoteDirection))

##wikiedit

Method Endpoint Implemented?
POST /api/wiki/edit No

##wikiread

Method Endpoint Implemented?
GET /wiki/discussions/page No
GET /wiki/revisions No
GET /wiki/revisions/page No
GET /wiki/page [WikiManager.get(String, String)](https://thatjavanerd.github.io/JRAW/docs/git/latest/net/dean/jraw/managers/WikiManager#get(java.lang.String, java.lang.String))
GET /wiki/pages WikiManager.getPages(String)