Plex-API

SDK Installation

Nuget

dotnet add package Plex-API

SDK Example Usage

Example

using PlexAPI;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(AccessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Server.GetServerCapabilitiesAsync();

// handle response

Available Resources and Operations

Server

• GetServerCapabilities - 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
• GetServerList - Get Server List

Media

• MarkPlayed - Mark Media Played
• MarkUnplayed - Mark Media Unplayed
• UpdatePlayProgress - Update Media Play Progress

Video

• GetTimeline - Get the timeline for a media item
• StartUniversalTranscode - Start Universal Transcode

Activities

• GetServerActivities - Get Server Activities
• CancelServerActivities - Cancel Server Activities

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
• GetLibraryHubs - Get library specific hubs

Search

• PerformSearch - Perform a search
• PerformVoiceSearch - Perform a voice search
• GetSearchResults - Get Search Results

Library

• GetFileHash - Get Hash Value
• GetRecentlyAdded - Get Recently Added
• GetLibraries - Get All Libraries
• GetLibrary - Get Library Details
• DeleteLibrary - Delete Library Section
• GetLibraryItems - Get Library Items
• RefreshLibrary - Refresh Library
• SearchLibrary - Search Library
• GetMetadata - Get Items Metadata
• GetMetadataChildren - Get Items Children
• GetOnDeck - Get On Deck

Log

• LogLine - Logging a single line message.
• LogMultiLine - Logging a multi-line message
• EnablePaperTrail - Enabling Papertrail

Plex

• GetPin - Get a Pin
• GetToken - Get Access Token

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

Authentication

• GetTransientToken - Get a Transient Token.
• GetSourceConnectionInformation - Get Source Connection Information

Statistics

• GetStatistics - Get Media Statistics

Sessions

• GetSessions - Get Active Sessions
• GetSessionHistory - Get Session History
• GetTranscodeSessions - Get Transcode Sessions
• StopTranscodeSession - Stop a Transcode Session

Updater

• GetUpdateStatus - Querying status of updates
• CheckForUpdates - Checking for updates
• ApplyUpdates - Apply Updates

Server Selection

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 http), 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: ServerProtocol
• ip: string
• port: 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 PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;

var sdk = new PlexAPISDK();

var res = await sdk.Plex.GetPinAsync(
    serverUrl: "https://plex.tv/api/v2",
    xPlexClientIdentifier: "<value>",
    strong: false);

// 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 PlexAPI;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(AccessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Server.GetServerCapabilitiesAsync();

// handle response

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!

SDK Created by Speakeasy