plexswift

An Open API Spec for interacting with Plex.tv and Plex Servers

Requirements

The SDK supports iOS 13 and later.

Summary

Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Global Parameters
• Authentication

SDK Installation

The SDK uses the Swift Package Manager to handle dependencies, which is included in Swift 3.0 and above.

You can add plexswift to your project directly in Xcode (File > Add Packages...) or by adding it to your project's Package.swift file:

dependencies: [
    .package(url: "https://github.com/LukeHagar/plexswift.git", .upToNextMajor(from: "0.6.3"))
]

SDK Example Usage

Example

import Foundation
import Plexswift

let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))

let response = try await client.server.getServerCapabilities()

switch response.data {
case .object(let object):
    // Handle response
    break
case .badRequest(let badRequest):
    // Handle response
    break
case .unauthorized(let unauthorized):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

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

Library

• getFileHash - Get Hash Value
• getRecentlyAdded - 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

Authentication

Global Security Schemes

The SDK supports the following security scheme globally through the Shared.Security type:

Name	Type	Scheme
.accessToken	apiKey	API key

You can set the appropriate security parameters by passing a Shared.Security value for the security parameter when initializing the Client instance. For example:

import Foundation
import Plexswift

let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))

let response = try await client.server.getServerCapabilities()

switch response.data {
case .object(let object):
    // Handle response
    break
case .badRequest(let badRequest):
    // Handle response
    break
case .unauthorized(let unauthorized):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

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 getServerResources. 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

import Foundation
import Plexswift

let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))

let response = try await client.plex.getServerResources(
    request: Operations.GetServerResourcesRequest(
        includeHttps: .one, 
        includeIPv6: .one, 
        includeRelay: .one
    )
)

switch response.data {
case .plexDevices(let plexDevices):
    // Handle response
    break
case .badRequest(let badRequest):
    // Handle response
    break
case .unauthorized(let unauthorized):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

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