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.

MyPlex (hosted on plex.tv)

• my.plexapp.com/users/sign_in.xml - Sign into Plex; Get an Auth Token.
• plex.tv/api/resources - List Plex resources we can connect to.
• plex.tv/api/servers - List Severs (possibly deprecated now, use resources above)

API Request Headers

Some APIs require more parameters than others. I found providing all of the following has given me good results.

• X-Plex-Token - USUALLY REQUIRED; Auth token from sign_in link above.
• X-Plex-Platform - Platform name, eg iOS, MacOSX, Android, LG, etc.
• X-Plex-Platform-Version - OS version, eg 4.3.1, 10.6.7, 3.2.
• X-Plex-Provides - One or more of {player,controller,server}.
• X-Plex-Product - Plex app name, eg Laika, Plex Media Server, Media Link.
• X-Plex-Version - Plex app version number (any string?).
• X-Plex-Device - Device name and model number, eg iPhone3, Motorola XOOM.
• X-Plex-Client-Identifier - UUID, SN, or other number unique per device.

Plex Media Server

• / - API Root, show details of the server, who is logged in, etc.
• /myplex/account - Display myPlex account details.
• /status/sessions - List currently playing items.
• /clients - List connected clients.
• /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/sections - List all library sections (note the section keys).
• /library/sections/all/refresh - Refresh all library items.
• /library/clean/bundles - Clean library bundles (maintenance task).
• /library/optimize - Optimize library items (maintenance task).

Library Sections

• /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.

Movie Section

• /library/sections/<key>/actor - List items by actor.
• /library/sections/<key>/country - List items by country.
• /library/sections/<key>/decade - List items by decade.
• /library/sections/<key>/director - List items by director.
• /library/sections/<key>/rating - List items by rating.
• /library/sections/<key>/resolution - List items by resolution.

Show Section

• /library/sections/<key>/recentlyViewedShows - List recently viewed shows.

Videos

• /<key>/analyze - Analyze a video.
• /video/:/transcode/universal/start - Start streaming video.
• /:/scrobble - Mark video watched.
• /:/unscrobble - Mark video unwatched.

Show & Season

• /library/metadata/<ratingKey>/children - List children.
• /library/metadata/<ratingKey>/allLeaves - List all episodes.
• /library/metadata/<ratingKey>/refresh - Refresh library.

Plex Client (via Plex Media Server)

Navigation

• /system/players/navigation/moveUp/<path> - Nav Up
• /system/players/navigation/moveDown/<path> - Nav Down
• /system/players/navigation/moveLeft/<path> - Nav Left
• /system/players/navigation/moveRight/<path> - Nav Right
• /system/players/navigation/pageUp/<path> - Page Up
• /system/players/navigation/pageDown/<path> - Page Down
• /system/players/navigation/nextLetter/<path> - Next Letter
• /system/players/navigation/previousLetter/<path> - Prev Letter
• /system/players/navigation/select/<path> - Select
• /system/players/navigation/back/<path> - Back
• /system/players/navigation/contextMenu/<path> - Context Menu
• /system/players/navigation/toggleOSD/<path> - Toggle OSD

Playback

• /system/players/playback/play/<path> - Play
• /system/players/playback/pause/<path> - Pause
• /system/players/playback/stop/<path> - Stop
• /system/players/playback/stepForward/<path> - Step Forward
• /system/players/playback/bigStepForward/<path> - Big Step Forward
• /system/players/playback/stepBack/<path> - Step Back
• /system/players/playback/bigStepBack/<path> - Big Step Back
• /system/players/playback/skipNext/<path> - Skip Next
• /system/players/playback/skipPrevious/<path> - Skip Prev
• /system/players/playback/playMedia/<path> - Play Media
• /system/players/timeline/poll - ???