Class MyPlexAccount

MyPlex account and profile information. This object represents the data found Account on the myplex.tv servers at the url https://plex.tv/users/account. You may create this object directly by passing in your username & password (or token). There is also a convenience method provided at PlexServer.myPlexAccount which will create and return this object.

Index

Constructors

constructor

Constructors

constructor

new MyPlexAccount(
    options?: {
        baseUrl?: string | null;
        password?: string;
        server?: PlexServer;
        timeout?: number;
        token?: string;
        username?: string;
        verificationCode?: string;
    },
): MyPlexAccount
Parameters
- options: {
      baseUrl?: string | null;
      password?: string;
      server?: PlexServer;
      timeout?: number;
      token?: string;
      username?: string;
      verificationCode?: string;
  } = {}
  Connection + auth options.
  - OptionalbaseUrl?: string | null
  - Optionalpassword?: string
  - Optionalserver?: PlexServer
  - Optionaltimeout?: number
  - Optionaltoken?: string
  - Optionalusername?: string
  - OptionalverificationCode?: string
    
    Two-factor authentication code for password sign-in.
Returns MyPlexAccount
- Defined in src/myplex.ts:170

Properties

`Optional`authenticationToken

authenticationToken?: string

auth token for user by plex

baseUrl

baseUrl: string | null = null

`Optional`certificateVersion

certificateVersion?: number

Unknown

DISCOVER

DISCOVER: string = 'https://discover.provider.plex.tv'

`Optional`email

email?: string

Your current Plex email address

`Optional`entitlements

entitlements?: string[]

List of devices your allowed to use with this account

EXISTINGUSER

EXISTINGUSER: string = 'https://plex.tv/api/home/users?invitedEmail={username}'

FRIENDINVITE

FRIENDINVITE: string = 'https://plex.tv/api/servers/{machineId}/shared_servers'

FRIENDSERVERS

FRIENDSERVERS: string = 'https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}'

FRIENDUPDATE

FRIENDUPDATE: string = 'https://plex.tv/api/v2/sharings/{userId}'

`Optional`guest

guest?: boolean

Unknown

`Optional`home

home?: boolean

Unknown

`Optional`homeSize

homeSize?: number

Unknown

HOMEUSER

HOMEUSER: string = 'https://plex.tv/api/home/users/{userId}'

HOMEUSERCREATE

HOMEUSERCREATE: string = 'https://plex.tv/api/home/users?title={title}'

HOMEUSERS

HOMEUSERS: string = 'https://plex.tv/api/home/users'

`Optional`id

id?: number

Your Plex account ID

`Optional`locale

locale?: string | null

Your Plex locale

`Optional`mailingListActive

mailingListActive?: boolean

`Optional`mailingListStatus

mailingListStatus?: "active" | "inactive"

Your current mailing list status.

MANAGEDHOMEUSER

MANAGEDHOMEUSER: string = 'https://plex.tv/api/v2/home/users/restricted/{userId}'

`Optional`maxHomeSize

maxHomeSize?: number

Unknown

METADATA

METADATA: string = 'https://metadata.provider.plex.tv'

`Optional`password

password?: string

PLEXSERVERS

PLEXSERVERS: string = 'https://plex.tv/api/v2/servers/{machineId}'

`Optional`queueEmail

queueEmail?: string

Email address to add items to your Watch Later queue.

REMOVEINVITE

REMOVEINVITE: string = 'https://plex.tv/api/invites/requested/{userId}?friend=0&server=1&home=0'

REQUESTED

REQUESTED: string = 'https://plex.tv/api/invites/requested'

REQUESTS

REQUESTS: string = 'https://plex.tv/api/invites/requests'

`Optional`restricted

restricted?: boolean

Unknown

roles

roles: string[]

`Optional`scrobbleTypes

scrobbleTypes?: string

Description

`Optional`server

server?: PlexServer

SIGNIN: string = 'https://plex.tv/users/sign_in.json'

`Optional`subscriptionActive

subscriptionActive?: boolean | null

True if your subsctiption is active

`Optional`subscriptionFeatures

subscriptionFeatures?: string[]

List of features allowed on your subscription

`Optional`subscriptionPlan

subscriptionPlan?: string | null

Name of subscription plan

`Optional`subscriptionStatus

subscriptionStatus?: "active" | "inactive"

String representation of subscriptionActive

`Optional`thumb

thumb?: string

URL of your account thumbnail

timeout

timeout: number = TIMEOUT

`Optional`title

title?: string

Unknown. - Looks like an alias for username

`Optional`token

token?: string

`Optional`username

username?: string

`Optional`uuid

uuid?: string

Unknown

VIEWSTATESYNC

VIEWSTATESYNC: string = 'https://plex.tv/api/v2/user/view_state_sync'

WEBHOOKS

WEBHOOKS: string = 'https://plex.tv/api/v2/user/webhooks'

`Static`key

key: string = 'https://plex.tv/api/v2/user'

Methods

_headers

_headers(): Record<string, string>
Returns Record<string, string>
- Defined in src/myplex.ts:1014

acceptInvite

acceptInvite(inviteOrIdentifier: string | number | MyPlexInvite): Promise<void>
Accept a pending invite received by this account.
Parameters
- inviteOrIdentifier: string | number | MyPlexInvite
Returns Promise<void>
- Defined in src/myplex.ts:401

addToWatchlist

addToWatchlist(
items: WatchlistTarget | readonly WatchlistTarget[],
): Promise<MyPlexAccount>
Add one or more movies or shows to this account's watchlist.
Parameters
- items: WatchlistTarget | readonly WatchlistTarget[]
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:713

addUserToHome

addUserToHome(
user: string | MyPlexUser,
sharing?: InviteFriendOptions,
): Promise<void>
Add an existing Plex user to this Plex Home.
Parameters
- user: string | MyPlexUser
- Optionalsharing: InviteFriendOptions
Returns Promise<void>
- Defined in src/myplex.ts:489

addWebhook

addWebhook(url: string): Promise<string[]>
Add one webhook while preserving the account's existing URLs.
Parameters
- url: string
Returns Promise<string[]>
- Defined in src/myplex.ts:768

cancelInvite

cancelInvite(inviteOrIdentifier: string | number | MyPlexInvite): Promise<void>
Cancel a pending invite sent by this account.
Parameters
- inviteOrIdentifier: string | number | MyPlexInvite
Returns Promise<void>
- Defined in src/myplex.ts:417

claimServer

claimServer(token: string): Promise<unknown>
Parameters
- token: string
  pass token from claimToken
Returns Promise<unknown>
- Defined in src/myplex.ts:1000

claimToken

claimToken(): Promise<string>
Returns a str, a new "claim-token", which you can use to register your new Plex Server instance to your account.

Returns Promise<string>

Link
https://hub.docker.com/r/plexinc/pms-docker/

Link
https://www.plex.tv/claim/
- Defined in src/myplex.ts:991

connect

connect(): Promise<MyPlexAccount>
Sign in with the username and password when no token was provided, then load the account details.

Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:217

createHomeUser

createHomeUser(title: string, options: InviteFriendOptions): Promise<void>
Create a managed Plex Home user and assign their shared libraries.
Parameters
- title: string
- options: InviteFriendOptions
Returns Promise<void>
- Defined in src/myplex.ts:465

device

device(__namedParameters: DeviceLookupOptions): Promise<MyPlexDevice>
Find one of the account's devices by name (case-insensitive) or client identifier.
Parameters
- __namedParameters: DeviceLookupOptions
Returns Promise<MyPlexDevice>
- Defined in src/myplex.ts:854

devices

devices(): Promise<MyPlexDevice[]>
Returns a list of all MyPlexDevice objects connected to the server.

Returns Promise<MyPlexDevice[]>
- Defined in src/myplex.ts:870

geoip

geoip(ipAddress: string): Promise<GeoLocation>
Parameters
- ipAddress: string
Returns Promise<GeoLocation>
- Defined in src/myplex.ts:301

history

history(
options?: Pick<HistoryOptions, "maxResults" | "minDate">,
): Promise<HistoryResult[]>
Owner history across owned servers; maxResults applies to each server.
Parameters
- options: Pick<HistoryOptions, "maxResults" | "minDate"> = {}
Returns Promise<HistoryResult[]>
- Defined in src/myplex.ts:250

inviteFriend

inviteFriend(
user: string | MyPlexUser,
options: InviteFriendOptions,
): Promise<void>
Invite a Plex user and share selected libraries with them.
Parameters
- user: string | MyPlexUser
- options: InviteFriendOptions
Returns Promise<void>
- Defined in src/myplex.ts:433

isPlayed

isPlayed(item: WatchlistTarget): Promise<boolean>
Return whether an item is marked as played in Plex Discover.
Parameters
- item: WatchlistTarget
Returns Promise<boolean>
- Defined in src/myplex.ts:671

linkPin

linkPin(__namedParameters: LinkPlexPinOptions): Promise<void>
Link a pending client PIN to this Plex account.
Parameters
- __namedParameters: LinkPlexPinOptions
Returns Promise<void>
- Defined in src/myplex.ts:567

markPlayed

markPlayed(item: WatchlistTarget): Promise<MyPlexAccount>
Mark an item as played in Plex Discover.
Parameters
- item: WatchlistTarget
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:676

markUnplayed

markUnplayed(item: WatchlistTarget): Promise<MyPlexAccount>
Mark an item as unplayed in Plex Discover.
Parameters
- item: WatchlistTarget
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:681

onlineMediaSources

onlineMediaSources(): Promise<AccountOptOut[]>
Returns Promise<AccountOptOut[]>
- Defined in src/myplex.ts:324

onWatchlist

onWatchlist(item: WatchlistTarget): Promise<boolean>
Return whether a movie or show is currently on this account's watchlist.
Parameters
- item: WatchlistTarget
Returns Promise<boolean>
- Defined in src/myplex.ts:708

optOut

optOut(options: { library?: boolean; playback?: boolean }): Promise<void>
Change the account's playback and library-statistics privacy choices.
Parameters
- options: { library?: boolean; playback?: boolean }
Returns Promise<void>
- Defined in src/myplex.ts:310

pendingInvite

pendingInvite(
identifier: string | number,
options?: PendingInvitesOptions,
): Promise<MyPlexInvite>
Find a pending invite by username, email, friendly name, or account id.
Parameters
- identifier: string | number
- options: PendingInvitesOptions = {}
Returns Promise<MyPlexInvite>
- Defined in src/myplex.ts:383

pendingInvites

pendingInvites(options?: PendingInvitesOptions): Promise<MyPlexInvite[]>
Return pending invites sent from or received by this account.
Parameters
- options: PendingInvitesOptions = {}
Returns Promise<MyPlexInvite[]>
- Defined in src/myplex.ts:369

ping

ping(): Promise<boolean>
Keep the account token active.

Returns Promise<boolean>
- Defined in src/myplex.ts:292

publicIP

publicIP(): Promise<string>
Returns Promise<string>
- Defined in src/myplex.ts:297

query

query(options: AccountQueryOptions & { responseType: "text" }): Promise<string>
Send an authenticated request to plex.tv or another Plex service. JSON responses are parsed, XML responses are converted to the same shape, and responseType: 'text' returns the body.
Parameters
- options: AccountQueryOptions & { responseType: "text" }
Returns Promise<string>
- Defined in src/myplex.ts:886
query<T = unknown>(
options: AccountQueryOptions & { responseType?: undefined },
): Promise<T>
Send an authenticated request to plex.tv or another Plex service. JSON responses are parsed, XML responses are converted to the same shape, and responseType: 'text' returns the body.
Type Parameters
- T = unknown
Parameters
- options: AccountQueryOptions & { responseType?: undefined }
Returns Promise<T>
- Defined in src/myplex.ts:887

removeFriend

removeFriend(userOrIdentifier: string | number | MyPlexUser): Promise<void>
Remove a user from this account's friends.
Parameters
- userOrIdentifier: string | number | MyPlexUser
Returns Promise<void>
- Defined in src/myplex.ts:834

removeFromWatchlist

removeFromWatchlist(
items: WatchlistTarget | readonly WatchlistTarget[],
): Promise<MyPlexAccount>
Remove one or more movies or shows from this account's watchlist.
Parameters
- items: WatchlistTarget | readonly WatchlistTarget[]
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:728

removeHomeUser

removeHomeUser(userOrIdentifier: string | number | MyPlexUser): Promise<void>
Remove a managed user from this Plex Home.
Parameters
- userOrIdentifier: string | number | MyPlexUser
Returns Promise<void>
- Defined in src/myplex.ts:844

removeManagedUserPin

removeManagedUserPin(
userOrIdentifier: string | number | MyPlexUser,
): Promise<void>
Remove a managed Plex Home user's PIN.
Parameters
- userOrIdentifier: string | number | MyPlexUser
Returns Promise<void>
- Defined in src/myplex.ts:557

removePin

removePin(options: RemoveAccountPinOptions): Promise<void>
Remove the signed-in account's Plex Home PIN.
Parameters
- options: RemoveAccountPinOptions
Returns Promise<void>
- Defined in src/myplex.ts:538

removeWebhook

removeWebhook(url: string): Promise<string[]>
Remove one webhook while preserving the account's remaining URLs.
Parameters
- url: string
Returns Promise<string[]>
- Defined in src/myplex.ts:777

resource

resource(name: string): Promise<MyPlexResource>
Parameters
- name: string
Returns Promise<MyPlexResource>
- Defined in src/myplex.ts:329

resources

resources(): Promise<MyPlexResource[]>
Returns Promise<MyPlexResource[]>
- Defined in src/myplex.ts:342

searchDiscover

searchDiscover(
options: DiscoverSearchOptions & { type: "movie" },
): Promise<DiscoverMovie[]>
Parameters
- options: DiscoverSearchOptions & { type: "movie" }
Returns Promise<DiscoverMovie[]>
- Defined in src/myplex.ts:612
searchDiscover(
options: DiscoverSearchOptions & { type: "show" },
): Promise<DiscoverShow[]>
Parameters
- options: DiscoverSearchOptions & { type: "show" }
Returns Promise<DiscoverShow[]>
- Defined in src/myplex.ts:615
searchDiscover(options: DiscoverSearchOptions): Promise<DiscoverSearchItem[]>
Parameters
- options: DiscoverSearchOptions
Returns Promise<DiscoverSearchItem[]>
- Defined in src/myplex.ts:616

setManagedUserPin

setManagedUserPin(
userOrIdentifier: string | number | MyPlexUser,
options: SetManagedUserPinOptions,
): Promise<void>
Set or change a managed Plex Home user's PIN.
Parameters
- userOrIdentifier: string | number | MyPlexUser
- options: SetManagedUserPinOptions
Returns Promise<void>
- Defined in src/myplex.ts:543

setPin

setPin(options: SetAccountPinOptions): Promise<void>
Set or change the signed-in account's Plex Home PIN.
Parameters
- options: SetAccountPinOptions
Returns Promise<void>
- Defined in src/myplex.ts:526

setViewStateSync

setViewStateSync(
__namedParameters: SetViewStateSyncOptions,
): Promise<ViewStateSyncStatus>
Enable or disable account-wide watch-state and ratings sync.
Parameters
- __namedParameters: SetViewStateSyncOptions
Returns Promise<ViewStateSyncStatus>
- Defined in src/myplex.ts:698

setWebhooks

setWebhooks(urls: readonly string[]): Promise<string[]>
Replace all webhook URLs configured for this Plex account.
Parameters
- urls: readonly string[]
Returns Promise<string[]>
- Defined in src/myplex.ts:749

sharingSections

sharingSections(
server: string | PlexServer,
): Promise<MyPlexLibraryShareSection[]>
Return the server libraries available to account-sharing APIs.
Parameters
- server: string | PlexServer
Returns Promise<MyPlexLibraryShareSection[]>
- Defined in src/myplex.ts:451

signout

signout(): Promise<void>
Invalidate this account's authentication token.

Returns Promise<void>
- Defined in src/myplex.ts:287

sonosSpeaker

sonosSpeaker(
identifier: { name: string } | { id: string },
): Promise<PlexSonosClient | undefined>
Parameters
- identifier: { name: string } | { id: string }
Returns Promise<PlexSonosClient | undefined>
- Defined in src/myplex.ts:275

sonosSpeakers

sonosSpeakers(): Promise<PlexSonosClient[]>
Linked Sonos speakers available to this account.

Returns Promise<PlexSonosClient[]>
- Defined in src/myplex.ts:265

streamingServices

streamingServices(item: WatchlistTarget): Promise<StreamingAvailability[]>
List streaming providers offering this discover or watchlist item.
Parameters
- item: WatchlistTarget
Returns Promise<StreamingAvailability[]>
- Defined in src/myplex.ts:230

switchHomeUser

switchHomeUser(
userOrIdentifier: string | number | MyPlexUser,
options?: SwitchHomeUserOptions,
): Promise<MyPlexAccount>
Switch authentication to a managed Plex Home user.
Parameters
- userOrIdentifier: string | number | MyPlexUser
- options: SwitchHomeUserOptions = {}
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:499

updateFriend

updateFriend(
userOrIdentifier: string | number | MyPlexUser,
options: UpdateFriendOptions,
): Promise<void>
Update a user's shared libraries and account-level sharing settings.
Parameters
- userOrIdentifier: string | number | MyPlexUser
- options: UpdateFriendOptions
Returns Promise<void>
- Defined in src/myplex.ts:786

user

user(identifier: string | number): Promise<MyPlexUser>
Find an account user by title, username, email, or account id.
Parameters
- identifier: string | number
Returns Promise<MyPlexUser>
- Defined in src/myplex.ts:354

users

users(): Promise<MyPlexUser[]>
Return users connected to this Plex account, including managed home users.

Returns Promise<MyPlexUser[]>
- Defined in src/myplex.ts:348

userState

userState(item: WatchlistTarget): Promise<PlexUserState>
Return Plex Discover user state for a movie or show.
Parameters
- item: WatchlistTarget
Returns Promise<PlexUserState>
- Defined in src/myplex.ts:658

videoOnDemand

videoOnDemand(): Promise<Hub[]>
Browse Plex's on-demand video hubs.

Returns Promise<Hub[]>
- Defined in src/myplex.ts:239

viewStateSync

viewStateSync(): Promise<ViewStateSyncStatus>
Return this account's watch-state and ratings sync status.

Returns Promise<ViewStateSyncStatus>
- Defined in src/myplex.ts:686

watchlist

watchlist(options?: WatchlistOptions): Promise<WatchlistItem[]>
Return movies and shows in this account's Plex Discover watchlist.
Parameters
- options: WatchlistOptions = {}
Returns Promise<WatchlistItem[]>
- Defined in src/myplex.ts:580

webhooks

webhooks(): Promise<string[]>
Return webhook URLs configured for this Plex account.

Returns Promise<string[]>
- Defined in src/myplex.ts:743

`Static`getWebLogin

getWebLogin(forwardUrl?: string | null): Promise<WebLogin>
Create an OAuth PIN and return its Plex authentication URL.
Parameters
- forwardUrl: string | null = null
Returns Promise<WebLogin>
- Defined in src/myplex.ts:72

`Static`webLoginCheck

webLoginCheck(
webLogin: WebLogin,
__namedParameters?: { timeoutSeconds?: number },
): Promise<MyPlexAccount>
Wait for a web login and return the connected Plex account.
Parameters
- webLogin: WebLogin
- __namedParameters: { timeoutSeconds?: number } = {}
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:82

Class MyPlexAccount

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalbaseUrl?: string | null

Optionalpassword?: string

Optionalserver?: PlexServer

Optionaltimeout?: number

Optionaltoken?: string

Optionalusername?: string

OptionalverificationCode?: string

Returns MyPlexAccount

Properties

OptionalauthenticationToken

baseUrl

OptionalcertificateVersion

DISCOVER

Optionalemail

Optionalentitlements

EXISTINGUSER

FRIENDINVITE

FRIENDSERVERS

FRIENDUPDATE

Optionalguest

Optionalhome

OptionalhomeSize

HOMEUSER

HOMEUSERCREATE

HOMEUSERS

Optionalid

Optionallocale

OptionalmailingListActive

OptionalmailingListStatus

MANAGEDHOMEUSER

OptionalmaxHomeSize

METADATA

Optionalpassword

PLEXSERVERS

OptionalqueueEmail

REMOVEINVITE

REQUESTED

REQUESTS

Optionalrestricted

roles

OptionalscrobbleTypes

Optionalserver

SIGNIN

OptionalsubscriptionActive

OptionalsubscriptionFeatures

OptionalsubscriptionPlan

OptionalsubscriptionStatus

Optionalthumb

timeout

Optionaltitle

Optionaltoken

Optionalusername

Optionaluuid

VIEWSTATESYNC

WEBHOOKS

Statickey

Methods

_headers

Returns Record<string, string>

acceptInvite

Parameters

Returns Promise<void>

addToWatchlist

Parameters

Returns Promise<MyPlexAccount>

addUserToHome

Parameters

Returns Promise<void>

addWebhook

Parameters

Returns Promise<string[]>

cancelInvite

`Optional`baseUrl?: string | null

`Optional`password?: string

`Optional`server?: PlexServer

`Optional`timeout?: number

`Optional`token?: string

`Optional`username?: string

`Optional`verificationCode?: string

`Optional`authenticationToken

`Optional`certificateVersion

`Optional`email

`Optional`entitlements

`Optional`guest

`Optional`home

`Optional`homeSize

`Optional`id

`Optional`locale

`Optional`mailingListActive

`Optional`mailingListStatus

`Optional`maxHomeSize

`Optional`password

`Optional`queueEmail

`Optional`restricted

`Optional`scrobbleTypes

`Optional`server

`Optional`subscriptionActive

`Optional`subscriptionFeatures

`Optional`subscriptionPlan

`Optional`subscriptionStatus

`Optional`thumb

`Optional`title

`Optional`token

`Optional`username

`Optional`uuid

`Static`key