Skip to content

Latest commit

 

History

History
250 lines (233 loc) · 25.6 KB

ENDPOINTS.md

File metadata and controls

250 lines (233 loc) · 25.6 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 54 endpoints (out of 184 total) have been implemented.

##account

Method Endpoint Implemented?
POST /api/clear_sessions No
POST /api/delete_user No
POST /api/register No
POST /api/set_force_https No
POST /api/update No
POST /api/update_email No
POST /api/update_password No
GET /api/v1/me No
GET /api/v1/me/blocked No
GET /api/v1/me/friends No
GET /api/v1/me/karma No
PATCH /api/v1/me/prefs No
GET /api/v1/me/trophies No
GET /prefs/blocked No
GET /prefs/friends No
GET /prefs/{where} No
POST /api/login RedditClient.login()
GET /api/me.json RedditClient.me()

##apps

Method Endpoint Implemented?
POST /api/deleteapp No
POST /api/revokeapp No
POST /api/setappicon No
POST /api/updateapp No
POST /api/adddeveloper LoggedInAccount.addDeveloper()
POST /api/removedeveloper LoggedInAccount.removeDeveloper()

##captcha

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

##flair

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/flairselector No
POST /api/flairtemplate No
POST /api/selectflair No
POST /api/setflairenabled No

##links & comments

Method Endpoint Implemented?
POST /api/editusertext No
GET /api/info No
POST /api/morechildren No
POST /api/report No
GET /api/saved_categories.json No
POST /api/set_contest_mode No
POST /api/set_subreddit_sticky No
POST /api/store_visits No
POST /api/comment LoggedInAccount.reply()
POST /api/del LoggedInAccount.delete()
POST /api/hide LoggedInAccount.setHidden()
POST /api/marknsfw LoggedInAccount.setNsfw()
POST /api/save LoggedInAccount.setSaved()
POST /api/sendreplies LoggedInAccount.setSendRepliesToInbox()
POST /api/submit LoggedInAccount.submitContent()
POST /api/unhide LoggedInAccount.setHidden()
POST /api/unmarknsfw LoggedInAccount.setNsfw()
POST /api/unsave LoggedInAccount.setSaved()
POST /api/vote LoggedInAccount.vote()

##listings

Method Endpoint Implemented?
GET /comments/{article} No
GET /by_id/{names} SpecificPaginator.getListing()
GET /controversial SubredditPaginator.getListing()
GET /hot SubredditPaginator.getListing()
GET /new SubredditPaginator.getListing()
GET /random RedditClient.getRandom()
GET /sort SubredditPaginator.getListing()
GET /top SubredditPaginator.getListing()

##live threads

Method Endpoint Implemented?
POST /api/live/create No
POST /api/live/{thread}/accept_contributor_invite No
POST /api/live/{thread}/close_thread No
POST /api/live/{thread}/delete_update 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}/report No
POST /api/live/{thread}/rm_contributor No
POST /api/live/{thread}/rm_contributor_invite No
POST /api/live/{thread}/set_contributor_permissions No
POST /api/live/{thread}/strike_update No
POST /api/live/{thread}/update No
GET /live/{thread} No
GET /live/{thread}/about.json No
GET /live/{thread}/contributors.json No
GET /live/{thread}/discussions No

##moderation

Method Endpoint Implemented?
GET /about/edited No
GET /about/log No
GET /about/modqueue No
GET /about/reports No
GET /about/spam No
GET /about/unmoderated No
GET /about/{location} No
POST /api/accept_moderator_invite No
POST /api/approve No
POST /api/distinguish No
POST /api/ignore_reports No
POST /api/leavecontributor No
POST /api/leavemoderator No
POST /api/remove No
POST /api/unignore_reports No
GET /stylesheet RedditClient.getStylesheet()

##multis

Method Endpoint Implemented?
GET /api/filter/{filterpath} No
POST /api/filter/{filterpath} No
PUT /api/filter/{filterpath} No
DELETE /api/filter/{filterpath} No
GET /api/filter/{filterpath}/r/srname No
PUT /api/filter/{filterpath}/r/srname No
DELETE /api/filter/{filterpath}/r/srname No
POST /api/multi/{multipath} No
PUT /api/multi/{multipath} No
DELETE /api/multi/{multipath} No
POST /api/multi/{multipath}/copy No
PUT /api/multi/{multipath}/description No
PUT /api/multi/{multipath}/r/srname No
DELETE /api/multi/{multipath}/r/srname No
POST /api/multi/{multipath}/rename No
GET /api/multi/mine LoggedInAccount.getMyMultiReddits()
GET /api/multi/{multipath} RedditClient.getPublicMulti()
GET /api/multi/{multipath}/description RedditClient.getPublicMultiDescription()
GET /api/multi/{multipath}/r/srname RedditClient.getPublicMulti()

##private messages

Method Endpoint Implemented?
POST /api/block No
POST /api/compose No
POST /api/read_message No
POST /api/unread_message No
POST /message/inbox No
GET /message/sent No
GET /message/unread No
GET /message/{where} No

##reddit gold

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

##search

Method Endpoint Implemented?
GET /search No

##subreddits

Method Endpoint Implemented?
GET /about/banned No
GET /about/contributors No
GET /about/moderators No
GET /about/wikibanned No
GET /about/wikicontributors No
GET /about/{where} No
POST /api/delete_sr_header No
POST /api/delete_sr_img No
GET /api/recommend/sr/{srnames} No
POST /api/site_admin No
POST /api/subreddit_stylesheet No
POST /api/subscribe No
POST /api/upload_sr_img No
GET /r/{subreddit}/about/edit.json No
GET /subreddits/search No
POST /api/search_reddit_names.json RedditClient.searchSubreddits()
GET /api/submit_text.json RedditClient.getSubmitText()
GET /api/subreddits_by_topic.json RedditClient.getSubredditsByTopic()
GET /r/{subreddit}/about.json RedditClient.getSubreddit()
GET /subreddits/mine/contributor MySubredditsPaginator.getListing()
GET /subreddits/mine/moderator MySubredditsPaginator.getListing()
GET /subreddits/mine/subscriber MySubredditsPaginator.getListing()
GET /subreddits/mine/{where} MySubredditsPaginator.getListing()
GET /subreddits/new AllSubredditsPaginator.getListing()
GET /subreddits/popular AllSubredditsPaginator.getListing()
GET /subreddits/{where} AllSubredditsPaginator.getListing()

##users

Method Endpoint Implemented?
POST /api/friend No
POST /api/setpermissions No
POST /api/unfriend No
GET /api/v1/me/friends/{username} No
PUT /api/v1/me/friends/{username} No
DELETE /api/v1/me/friends/{username} No
GET /api/v1/user/{username}/trophies No
GET /api/username_available.json RedditClient.isUsernameAvailable()
GET /user/{username}/about.json RedditClient.getUser()
GET /user/{username}/comments UserContributionPaginator.getListing()
GET /user/{username}/disliked UserContributionPaginator.getListing()
GET /user/{username}/gilded UserContributionPaginator.getListing()
GET /user/{username}/hidden UserContributionPaginator.getListing()
GET /user/{username}/liked UserContributionPaginator.getListing()
GET /user/{username}/overview UserContributionPaginator.getListing()
GET /user/{username}/saved UserContributionPaginator.getListing()
GET /user/{username}/submitted UserContributionPaginator.getListing()
GET /user/{username}/{where} UserContributionPaginator.getListing()

##wiki

Method Endpoint Implemented?
POST /api/wiki/alloweditor/act No
POST /api/wiki/alloweditor/add No
POST /api/wiki/alloweditor/del No
POST /api/wiki/edit No
POST /api/wiki/hide No
POST /api/wiki/revert No
GET /wiki/discussions/{page} No
GET /wiki/revisions No
POST /wiki/revisions/{page} No
GET /wiki/settings/{page} No
GET /wiki/pages RedditClient.getWikiPages()
GET /wiki/{page} RedditClient.getWikiPage()