forked from pushingkarmaorg/python-plexapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Unofficial Plex API Documentation
Michael Shepanski edited this page Jun 9, 2015
·
49 revisions
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.
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.
- 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.
- / - 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/all - List items in all library sections.
- /library/onDeck - List on deck items in all library sections.
- /library/recentlyAdded - List recently added items in all library sections.
- /library/clean/bundles - Clean library bundles (maintenance task).
- /library/optimize - Optimize library items (maintenance task).
- /library/sections/all/refresh - Refresh all library items.
- /library/sections - List all library sections (note the section keys).
- /library/sections/<key>/all - List items in a section.
- /library/sections/<key>/newest - List newest items in a section.
- /library/sections/<key>/onDeck - List on deck items in a section.
- /library/sections/<key>/recentlyAdded - List recently added items in a section.
- /library/sections/<key>/recentlyViewed - List recently viewed items in a section.
- /library/sections/<key>/unwatched - List unwatched items in a section.
- /library/sections/<key>/contentRating - List items by content rating.
- /library/sections/<key>/firstCharacter - List items by first character.
- /library/sections/<key>/genre - List items by genre.
- /library/sections/<key>/year - List items by year.
- /library/sections/<key>/analyze - Analyze library section.
- /library/sections/<key>/emptyTrash - Empty Trash.
- /library/sections/<key>/refresh - Refresh items in section.