Plex-API
SDK Installation
NuGet
To add the NuGet package to a .NET project:
dotnet add package LukeHagar.PlexAPI.SDK
Locally
To add a reference to a local instance of the SDK in a .NET project:
dotnet add reference LukeHagar/PlexAPI/SDK/LukeHagar.PlexAPI.SDK.csproj
SDK Example Usage
Example
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(
accessToken: "<YOUR_API_KEY_HERE>",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux"
);
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
Available Resources and Operations
Available methods
Activities
- GetServerActivities - Get Server Activities
- CancelServerActivities - Cancel Server Activities
Authentication
- GetTransientToken - Get a Transient Token
- GetSourceConnectionInformation - Get Source Connection Information
- GetTokenDetails - Get Token Details
- PostUsersSignInData - Get User Sign In Data
Butler
- GetButlerTasks - Get Butler tasks
- StartAllTasks - Start all Butler tasks
- StopAllTasks - Stop all Butler tasks
- StartTask - Start a single Butler task
- StopTask - Stop a single Butler task
Hubs
- GetGlobalHubs - Get Global Hubs
- GetRecentlyAdded - Get Recently Added
- GetLibraryHubs - Get library specific hubs
Library
- GetFileHash - Get Hash Value
- GetRecentlyAddedLibrary - Get Recently Added
- GetAllLibraries - Get All Libraries
- GetLibraryDetails - Get Library Details
- DeleteLibrary - Delete Library Section
- GetLibraryItems - Get Library Items
- GetRefreshLibraryMetadata - Refresh Metadata Of The Library
- GetSearchLibrary - Search Library
- GetMetaDataByRatingKey - Get Metadata by RatingKey
- GetMetadataChildren - Get Items Children
- GetTopWatchedContent - Get Top Watched Content
- GetOnDeck - Get On Deck
Log
- LogLine - Logging a single line message.
- LogMultiLine - Logging a multi-line message
- EnablePaperTrail - Enabling Papertrail
Media
- MarkPlayed - Mark Media Played
- MarkUnplayed - Mark Media Unplayed
- UpdatePlayProgress - Update Media Play Progress
- GetBannerImage - Get Banner Image
- GetThumbImage - Get Thumb Image
Playlists
- CreatePlaylist - Create a Playlist
- GetPlaylists - Get All Playlists
- GetPlaylist - Retrieve Playlist
- DeletePlaylist - Deletes a Playlist
- UpdatePlaylist - Update a Playlist
- GetPlaylistContents - Retrieve Playlist Contents
- ClearPlaylistContents - Delete Playlist Contents
- AddPlaylistContents - Adding to a Playlist
- UploadPlaylist - Upload Playlist
Plex
- GetCompanionsData - Get Companions Data
- GetUserFriends - Get list of friends of the user logged in
- GetGeoData - Get Geo Data
- GetHomeData - Get Plex Home Data
- GetServerResources - Get Server Resources
- GetPin - Get a Pin
- GetTokenByPinId - Get Access Token by PinId
Search
- PerformSearch - Perform a search
- PerformVoiceSearch - Perform a voice search
- GetSearchResults - Get Search Results
Server
- GetServerCapabilities - Get Server Capabilities
- GetServerPreferences - Get Server Preferences
- GetAvailableClients - Get Available Clients
- GetDevices - Get Devices
- GetServerIdentity - Get Server Identity
- GetMyPlexAccount - Get MyPlex Account
- GetResizedPhoto - Get a Resized Photo
- GetMediaProviders - Get Media Providers
- GetServerList - Get Server List
Sessions
- GetSessions - Get Active Sessions
- GetSessionHistory - Get Session History
- GetTranscodeSessions - Get Transcode Sessions
- StopTranscodeSession - Stop a Transcode Session
Statistics
- GetStatistics - Get Media Statistics
- GetResourcesStatistics - Get Resources Statistics
- GetBandwidthStatistics - Get Bandwidth Statistics
Updater
- GetUpdateStatus - Querying status of updates
- CheckForUpdates - Checking for updates
- ApplyUpdates - Apply Updates
Video
- GetTimeline - Get the timeline for a media item
- StartUniversalTranscode - Start Universal Transcode
Watchlist
- GetWatchList - Get User Watchlist
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIndex: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | {protocol}://{ip}:{port} |
protocol (default is https), ip (default is 10.10.10.47), port (default is 32400) |
Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:
protocol: ServerProtocolip: stringport: string
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverUrl: str optional parameter when initializing the SDK client instance. For example:
Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(
accessToken: "<YOUR_API_KEY_HERE>",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux"
);
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2");
// handle response
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
AccessToken |
apiKey | API key |
To authenticate with the API the AccessToken parameter must be set when initializing the SDK client instance. For example:
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(
accessToken: "<YOUR_API_KEY_HERE>",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux"
);
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
Global Parameters
Global Parameters
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set ClientID to "gcgzw5rz2xovp84b4vha3a40" at SDK initialization and then you do not have to pass the same value on calls to operations like GetPin. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
Available Globals
The following global parameters are available.
| Name | Type | Required | Description |
|---|---|---|---|
| clientID | string | The unique identifier for the client application | |
| This is used to track the client application and its usage | |||
| (UUID, serial number, or other number unique per device) | |||
| clientName | string | The ClientName parameter. | |
| clientVersion | string | The ClientVersion parameter. | |
| clientPlatform | string | The ClientPlatform parameter. | |
| deviceName | string | The DeviceName parameter. |
Example
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;
var sdk = new PlexAPI(
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux"
);
GetPinRequest req = new GetPinRequest() {};
var res = await sdk.Plex.GetPinAsync(req);
// handle response
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
| Error Object | Status Code | Content Type |
|---|---|---|
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesBadRequest | 400 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | / |
Example
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using System;
using LukeHagar.PlexAPI.SDK.Models.Errors;
var sdk = new PlexAPI(
accessToken: "<YOUR_API_KEY_HERE>",
clientID: "gcgzw5rz2xovp84b4vha3a40",
clientName: "Plex Web",
clientVersion: "4.133.0",
clientPlatform: "Chrome",
deviceName: "Linux"
);
try
{
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
}
catch (Exception ex)
{
if (ex is GetServerCapabilitiesBadRequest)
{
// Handle exception data
throw;
}
else if (ex is GetServerCapabilitiesUnauthorized)
{
// Handle exception data
throw;
}
else if (ex is Models.Errors.SDKException)
{
// Handle default exception
throw;
}
}
Summary
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
Plex Media Server OpenAPI Specification
An Open Source OpenAPI Specification for Plex Media Server
Automation and SDKs provided by Speakeasy
Documentation
SDKs
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the respective repository.
| Language | Repository | Releases | Other |
|---|---|---|---|
| Python | GitHub | PyPI | - |
| JavaScript/TypeScript | GitHub | NPM \ JSR | - |
| Go | GitHub | Releases | GoDoc |
| Ruby | GitHub | Releases | - |
| Swift | GitHub | Releases | - |
| PHP | GitHub | Releases | - |
| Java | GitHub | Releases | - |
| C# | GitHub | Releases | - |
Table of Contents
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Global Parameters
- Error Handling
- Server Selection
- Authentication
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!