Unofficial Plex API Documentation

Thought this would be a good place to document the various API features I have found when writing this API to help others out. So without further adieu lets, begin.

First Things First

Some APIs require more parameters than others. Most all API calls require X-Plex-Token to be set in either the GET or POST arguments. You can get the token from the sign_in URL below.

MyPlex

Pages hosted on the plex.tv website.

• my.plexapp.com/users/sign_in.xml - Sign into Plex; Get an Auth Token.
• plex.tv/api/resources?includeHttps=1 - List Plex resources we can connect to.

Plex Media Server

* / - API Root, show details of the server, who is logged in, etc. * /search - Search for a title in all libraries. * /library - Root library API, not much going on here. * /library/clean/bundles - Clean library bundles (maintenance task). * /library/optimize - Optimize library items (maintenance task). * /library/sections/all/refresh - Refresh all library items. * /library/all - List or filter items in all library sections. * /library/onDeck - List or filter on deck items in all library sections. * /library/recentlyAdded - List or filter recently added items in all library sections. * /library/sections - List all library sections (note the section keys). * /library/sections/<key>/all - List or filter items in a section. * /library/sections/<key>/newest - List or filter newest items in a section. * /library/sections/<key>/onDeck - List or filter on deck items in a section. * /library/sections/<key>/recentlyAdded - List or filter recently added items in a section. * /library/sections/<key>/recentlyViewed - List or filter recently viewed items in a section. * /library/sections/<key>/unwatched - List or filter unwatched items in a section.