Endpoints

June 9, 2018 · View on GitHub

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 :meta:update

So far, API completion is at 49.45%. 90 out of 182 endpoints (ignoring 7 endpoints not planned) have been implemented

(any scope)

25.00% completion (1 implemented, 4 planned, and 1 not planned)

Method	Endpoint	Implementation
`POST`	`/api/comment`	`ReplyableReference.reply()`
`POST`	`[/r/{subreddit}]/api/friend`	None
`POST`	`[/r/{subreddit}]/api/unfriend`	None
`GET`	`/api/username_available`	None
`GET`	`/api/v1/scopes`	None
`GET`	`/api/needs_captcha`	Not planned

account

50.00% completion (1 implemented, 1 planned, and 0 not planned)

Method	Endpoint	Implementation
`PATCH`	`/api/v1/me/prefs`	`SelfUserReference.patchPrefs()`
`POST`	`/api/block_user`	None

creddits

0.00% completion (0 implemented, 2 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/v1/gold/gild/{fullname}`	None
`POST`	`/api/v1/gold/give/{username}`	None

edit

100.00% completion (5 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/del`	`PublicContributionReference.delete()`
`POST`	`/api/editusertext`	`PublicContributionReference.edit()`
`POST`	`/api/live/{thread}/delete_update`	`LiveThreadReference.deleteUpdate()`
`POST`	`/api/live/{thread}/strike_update`	`LiveThreadReference.strikeUpdate()`
`POST`	`/api/sendreplies`	`PublicContributionReference.sendReplies()`

flair

71.43% completion (5 implemented, 2 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/flairselector`	`UserFlairReference.current()`
`GET`	`[/r/{subreddit}]/api/link_flair`	`SubredditReference.linkFlairOptions()`
`POST`	`[/r/{subreddit}]/api/selectflair`	`FlairReference.updateToTemplate()`
`POST`	`[/r/{subreddit}]/api/setflairenabled`	`SelfUserFlairReference.setFlairEnabled()`
`GET`	`[/r/{subreddit}]/api/user_flair`	`SubredditReference.userFlairOptions()`
`GET`	`[/r/{subreddit}]/api/link_flair_v2`	None
`GET`	`[/r/{subreddit}]/api/user_flair_v2`	None

history

100.00% completion (1 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`GET`	`/user/{username}/{where}`	`UserReference.history()`

identity

100.00% completion (3 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`GET`	`/api/v1/me`	`UserReference.query()`
`GET`	`/api/v1/me/prefs`	`SelfUserReference.prefs()`
`GET`	`/api/v1/me/trophies`	`UserReference.trophies()`

livemanage

20.00% completion (2 implemented, 8 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/live/{thread}/close_thread`	`LiveThreadReference.close()`
`POST`	`/api/live/{thread}/edit`	`LiveThreadReference.edit()`
`POST`	`/api/live/{thread}/accept_contributor_invite`	None
`POST`	`/api/live/{thread}/hide_discussion`	None
`POST`	`/api/live/{thread}/invite_contributor`	None
`POST`	`/api/live/{thread}/leave_contributor`	None
`POST`	`/api/live/{thread}/rm_contributor`	None
`POST`	`/api/live/{thread}/rm_contributor_invite`	None
`POST`	`/api/live/{thread}/set_contributor_permissions`	None
`POST`	`/api/live/{thread}/unhide_discussion`	None

modconfig

20.00% completion (2 implemented, 8 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/subreddit_stylesheet`	`SubredditReference.updateStylesheet()`
`GET`	`[/r/{subreddit}]/stylesheet`	`SubredditReference.stylesheet()`
`POST`	`[/r/{subreddit}]/api/delete_sr_banner`	None
`POST`	`[/r/{subreddit}]/api/delete_sr_header`	None
`POST`	`[/r/{subreddit}]/api/delete_sr_icon`	None
`POST`	`[/r/{subreddit}]/api/delete_sr_img`	None
`POST`	`/api/site_admin`	None
`POST`	`[/r/{subreddit}]/api/upload_sr_img`	None
`GET`	`/r/{subreddit}/about/edit`	None
`GET`	`/r/{subreddit}/about/traffic`	None

modcontributors

0.00% completion (0 implemented, 2 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/mute_message_author`	None
`POST`	`/api/unmute_message_author`	None

modflair

30.00% completion (3 implemented, 7 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/flair`	`FlairReference.updateToCssClass()`
`POST`	`[/r/{subreddit}]/api/flaircsv`	`SubredditReference.patchFlairList()`
`GET`	`[/r/{subreddit}]/api/flairlist`	`SubredditReference.flairList()`
`POST`	`[/r/{subreddit}]/api/clearflairtemplates`	None
`POST`	`[/r/{subreddit}]/api/deleteflair`	None
`POST`	`[/r/{subreddit}]/api/deleteflairtemplate`	None
`PATCH`	`[/r/{subreddit}]/api/flair_template_order`	None
`POST`	`[/r/{subreddit}]/api/flairconfig`	None
`POST`	`[/r/{subreddit}]/api/flairtemplate`	None
`POST`	`[/r/{subreddit}]/api/flairtemplate_v2`	None

modlog

0.00% completion (0 implemented, 1 planned, and 0 not planned)

Method	Endpoint	Implementation
`GET`	`[/r/{subreddit}]/about/log`	None

modmail

0.00% completion (0 implemented, 16 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/mod/bulk_read`	None
`GET`	`/api/mod/conversations`	None
`POST`	`/api/mod/conversations`	None
`POST`	`/api/mod/conversations/read`	None
`GET`	`/api/mod/conversations/subreddits`	None
`POST`	`/api/mod/conversations/unread`	None
`GET`	`/api/mod/conversations/unread/count`	None
`GET`	`/api/mod/conversations/{conversation_id}`	None
`POST`	`/api/mod/conversations/{conversation_id}`	None
`POST`	`/api/mod/conversations/{conversation_id}/archive`	None
`DELETE`	`/api/mod/conversations/{conversation_id}/highlight`	None
`POST`	`/api/mod/conversations/{conversation_id}/highlight`	None
`POST`	`/api/mod/conversations/{conversation_id}/mute`	None
`POST`	`/api/mod/conversations/{conversation_id}/unarchive`	None
`POST`	`/api/mod/conversations/{conversation_id}/unmute`	None
`GET`	`/api/mod/conversations/{conversation_id}/user`	None

modothers

0.00% completion (0 implemented, 1 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/setpermissions`	None

modposts

42.86% completion (6 implemented, 8 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/approve`	`PublicContributionReference.approve()`
`POST`	`/api/distinguish`	`PublicContributionReference.distinguish()`
`POST`	`/api/remove`	`PublicContributionReference.remove()`
`POST`	`/api/set_subreddit_sticky`	`SubmissionReference.stickyPost()`
`POST`	`/api/spoiler`	`SubmissionReference.flagAsSpoiler()`
`POST`	`/api/unspoiler`	`SubmissionReference.flagAsSpoiler()`
`POST`	`/api/ignore_reports`	None
`POST`	`/api/lock`	None
`POST`	`/api/marknsfw`	None
`POST`	`/api/set_contest_mode`	None
`POST`	`/api/set_suggested_sort`	None
`POST`	`/api/unignore_reports`	None
`POST`	`/api/unlock`	None
`POST`	`/api/unmarknsfw`	None

modself

0.00% completion (0 implemented, 3 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/accept_moderator_invite`	None
`POST`	`/api/leavecontributor`	None
`POST`	`/api/leavemoderator`	None

modwiki

0.00% completion (0 implemented, 5 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/wiki/alloweditor/{act}`	None
`POST`	`[/r/{subreddit}]/api/wiki/hide`	None
`POST`	`[/r/{subreddit}]/api/wiki/revert`	None
`GET`	`[/r/{subreddit}]/wiki/settings/{page}`	None
`POST`	`[/r/{subreddit}]/wiki/settings/{page}`	None

mysubreddits

66.67% completion (2 implemented, 1 planned, and 0 not planned)

Method	Endpoint	Implementation
`GET`	`/api/v1/me/karma`	`SelfUserReference.karma()`
`GET`	`/subreddits/mine/{where}`	`SelfUserReference.subreddits()`
`GET`	`/api/v1/me/friends/{username}`	None

privatemessages

66.67% completion (6 implemented, 4 planned, and 1 not planned)

Method	Endpoint	Implementation
`POST`	`/api/compose`	`InboxReference.compose()`
`POST`	`/api/del_msg`	`InboxReference.delete()`
`POST`	`/api/read_all_messages`	`InboxReference.markAllRead()`
`POST`	`/api/read_message`	`InboxReference.markRead()`
`POST`	`/api/unread_message`	`InboxReference.markRead()`
`GET`	`/message/{where}`	`InboxReference.iterate()`
`POST`	`/api/block`	None
`POST`	`/api/collapse_message`	None
`POST`	`/api/unblock_subreddit`	None
`POST`	`/api/uncollapse_message`	None
`GET`	`/api/user_data_by_account_ids`	Not planned

read

69.23% completion (27 implemented, 15 planned, and 3 not planned)

Method	Endpoint	Implementation
`GET`	`[/r/{subreddit}]/api/info`	`RedditClient.lookup()`
`GET`	`/api/live/happening_now`	`RedditClient.happeningNow()`
`GET`	`/api/morechildren`	`CommentNode.loadMore()`
`GET`	`/api/multi/mine`	`UserReference.listMultis()`
`GET`	`/api/multi/user/{username}`	`UserReference.listMultis()`
`GET`	`/api/multi/{multipath}`	`MultiredditReference.about()`
`GET`	`/api/multi/{multipath}/description`	`MultiredditReference.description()`
`PUT`	`/api/multi/{multipath}/description`	`MultiredditReference.updateDescription()`
`GET`	`/api/multi/{multipath}/r/{srname}`	`MultiredditReference.subredditInfo()`
`POST`	`/api/search_subreddits`	`RedditClient.searchSubredditsByName()`
`GET`	`/api/v1/user/{username}/trophies`	`UserReference.trophies()`
`GET`	`/api/v1/{subreddit}/emojis/all`	`EmojiReference.list()`
`GET`	`/best`	`SubredditReference.posts()`
`GET`	`[/r/{subreddit}]/comments/{article}`	`SubmissionReference.comments()`
`GET`	`[/r/{subreddit}]/hot`	`SubredditReference.posts()`
`GET`	`/live/{thread}`	`LiveThreadReference.latestUpdates()`
`GET`	`/live/{thread}/about`	`LiveThreadReference.about()`
`GET`	`[/r/{subreddit}]/new`	`SubredditReference.posts()`
`GET`	`/r/{subreddit}/about`	`SubredditReference.about()`
`GET`	`/r/{subreddit}/about/rules`	`SubredditReference.rules()`
`GET`	`[/r/{subreddit}]/random`	`RedditClient.randomSubreddit()`
`GET`	`[/r/{subreddit}]/rising`	`SubredditReference.posts()`
`GET`	`[/r/{subreddit}]/search`	`SearchPaginator.createNextRequest()`
`GET`	`/subreddits/search`	`RedditClient.searchSubreddits()`
`GET`	`/user/{username}/about`	`UserReference.query()`
`GET`	`/users/{where}`	`RedditClient.userSubreddits()`
`GET`	`[/r/{subreddit}]/{sort}`	`SubredditReference.posts()`
`GET`	`[/r/{subreddit}]/about/{location}`	None
`GET`	`[/r/{subreddit}]/about/{where}`	None
`GET`	`/api/recommend/sr/{srnames}`	None
`GET`	`/api/subreddit_autocomplete`	None
`GET`	`/api/subreddit_autocomplete_v2`	None
`GET`	`/by_id/{names}`	None
`GET`	`/duplicates/{article}`	None
`GET`	`/live/{thread}/contributors`	None
`GET`	`/live/{thread}/discussions`	None
`GET`	`/live/{thread}/updates/{update_id}`	None
`GET`	`/prefs/{where}`	None
`GET`	`/profiles/search`	None
`GET`	`[/r/{subreddit}]/sidebar`	None
`GET`	`[/r/{subreddit}]/sticky`	None
`GET`	`/subreddits/{where}`	None
`GET`	`/api/live/by_id/{names}`	Not planned
`GET`	`/api/search_reddit_names`	Not planned
`POST`	`/api/search_reddit_names`	Not planned

report

66.67% completion (2 implemented, 2 planned, and 1 not planned)

Method	Endpoint	Implementation
`POST`	`/api/hide`	`SubmissionReference.setHidden()`
`POST`	`/api/unhide`	`SubmissionReference.setHidden()`
`POST`	`/api/live/{thread}/report`	None
`POST`	`/api/report`	None
`POST`	`/api/report_user`	Not planned

save

100.00% completion (2 implemented, 1 planned, and 1 not planned)

Method	Endpoint	Implementation
`POST`	`/api/save`	`PublicContributionReference.setSaved()`
`POST`	`/api/unsave`	`PublicContributionReference.setSaved()`
`GET`	`/api/saved_categories`	None
`POST`	`/api/store_visits`	Not planned

structuredstyles

33.33% completion (3 implemented, 6 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/v1/{subreddit}/emoji.json`	`EmojiReference.upload()`
`DELETE`	`/api/v1/{subreddit}/emoji/{emoji_name}`	`EmojiReference.delete()`
`POST`	`/api/v1/{subreddit}/emoji_asset_upload_s3.json`	`EmojiReference.upload()`
`POST`	`/api/widget`	None
`DELETE`	`/api/widget/{widget_id}`	None
`PUT`	`/api/widget/{widget_id}`	None
`POST`	`/api/widget_image_upload_s3`	None
`PATCH`	`/api/widget_order/{section}`	None
`GET`	`/api/widgets`	None

submit

100.00% completion (4 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/live/create`	`SelfUserReference.createLiveThread()`
`POST`	`/api/live/{thread}/update`	`LiveThreadReference.postUpdate()`
`POST`	`/api/submit`	`SubredditReference.submit()`
`GET`	`[/r/{subreddit}]/api/submit_text`	`SubredditReference.submitText()`

80.00% completion (8 implemented, 2 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/multi/copy`	`MultiredditReference.copyTo()`
`POST`	`/api/multi/rename`	`MultiredditReference.rename()`
`DELETE`	`/api/multi/{multipath}`	`MultiredditReference.delete()`
`POST`	`/api/multi/{multipath}`	`MultiredditReference.createOrUpdate()`
`PUT`	`/api/multi/{multipath}`	`MultiredditReference.createOrUpdate()`
`DELETE`	`/api/multi/{multipath}/r/{srname}`	`MultiredditReference.removeSubreddit()`
`PUT`	`/api/multi/{multipath}/r/{srname}`	`MultiredditReference.addSubreddit()`
`POST`	`/api/subscribe`	`SubredditReference.setSubscribed()`
`DELETE`	`/api/v1/me/friends/{username}`	None
`PUT`	`/api/v1/me/friends/{username}`	None

vote

100.00% completion (1 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`/api/vote`	`PublicContributionReference.setVote()`

wikiedit

100.00% completion (1 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`POST`	`[/r/{subreddit}]/api/wiki/edit`	`WikiReference.update()`

wikiread

100.00% completion (5 implemented, 0 planned, and 0 not planned)

Method	Endpoint	Implementation
`GET`	`[/r/{subreddit}]/wiki/discussions/{page}`	`WikiReference.discussionsAbout()`
`GET`	`[/r/{subreddit}]/wiki/pages`	`WikiReference.pages()`
`GET`	`[/r/{subreddit}]/wiki/revisions`	`WikiReference.revisions()`
`GET`	`[/r/{subreddit}]/wiki/revisions/{page}`	`WikiReference.revisionsFor()`
`GET`	`[/r/{subreddit}]/wiki/{page}`	`WikiReference.page()`