How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Plex EPG API

The EPG (Electronic Program Guide) is responsible for obtaining metadata for what is airing on each channel and when

Plex EPG API is one of 31 APIs that Plex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include EPG. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 13 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.2.2 .

Requests are made against a single base URL, https://{IP-description}.{identifier}.plex.direct:{port}.

13 operations 13 paths 14 schemas 13 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.2
Base URL
https://1-2-3-4.0123456789abcdef0123456789abcdef.plex.direct:32400
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Plex EPG API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Plex-Token (user_token). By default, every request must be authenticated.

  • user_token — The token which identifies the user accessing the PMS. This is typically provided to the client by plex.tv. This can be either a traditional access token or a…

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.

EPG 13

The EPG (Electronic Program Guide) is responsible for obtaining metadata for what is airing on each channel and when

GET
/livetv/epg/channelmap
Compute the best channel map
livetvEpgGetChannelmap 2 params → 200404500
GET
/livetv/epg/channels
Get channels for a lineup
livetvEpgGetChannels 1 param → 200404
GET
/livetv/epg/countries
Get all countries
livetvEpgGetCountries → 200
GET
/livetv/epg/countries/{country}/{epgId}/lineups
Get lineups for a country via postal code
livetvEpgGetCountriesCountryLineups 3 params → 200404
GET
/livetv/epg/countries/{country}/{epgId}/regions
Get regions for a country
livetvEpgGetCountriesCountryRegions 2 params → 200404
GET
/livetv/epg/countries/{country}/{epgId}/regions/{region}/lineups
Get lineups for a region
livetvEpgGetCountriesCountryRegionsRegionLineups 3 params → 200404
GET
/livetv/epg/languages
Get all languages
livetvEpgGetLanguages → 200
GET
/livetv/epg/lineup
Compute the best lineup
livetvEpgGetLineup 2 params → 200404500
GET
/livetv/epg/lineupchannels
Get the channels for mulitple lineups
livetvEpgGetLineupchannels 1 param → 200404
GET
/tv.plex.providers.epg.{identifier}:{deviceId}/lineups/dvr/channels
Get channels for a lineup
mediaProviderEpgChannels 3 params → 200404
GET
/tv.plex.providers.epg.{identifier}:{deviceId}/grid
Get airing information
mediaProviderEpgGrid 4 params → 200404
GET
/tv.plex.providers.epg.{identifier}:{deviceId}/watchnow
Get hubs
mediaProviderEpgWatchnow 2 params → 200404
GET
/tv.plex.providers.epg.{identifier}:{deviceId}/watchnow/all
Get currently airing
mediaProviderEpgWatchnowAll 2 params → 200404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are metadata (67 properties), stream (29 properties), media (18 properties), directory (15 properties). Each schema is shown below with its type and property counts.

MediaContainer
object
4 properties
directory
object
15 properties
image
object
Images such as movie posters and background artwork are represented by Image elements.
3 properties
part
object
Part represents a particular file or "part" of a media item. The part is the playable unit of the media hierarchy. Suppose that a movie library contains a movi…
11 properties
Lineup-items
object
5 properties
sort
channel
object
8 properties
metadata
object
Items in a library are referred to as "metadata items." These metadata items are distinct from "media items" which represent actual instances of media that can…
67 properties
stream
object
Stream represents a particular stream from a media item, such as the video stream, audio stream, or subtitle stream. The stream may either be part of the file…
29 properties
mediaContainerWithMetadata
object
MediaContainer is commonly found as the root of a response and is a pretty generic container. Common attributes include identifier and things related to paging…
1 property
media
object
Media represents an one or more media files (parts) and is a child of a metadata item. There aren't necessarily any guaranteed attributes on media elements sin…
18 properties
filter
tag
object
A variety of extra information about a metadata item is included as tags. These tags use their own element names such as Genre, Writer, Directory, and Role. In…
10 properties
mediaContainerWithLineup
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

plex-epg-api-openapi.yml Raw ↑

Other APIs Plex publishes across the network.

Plex Account and Authentication API
Plex MCP Server
Plex Activities API
Plex Butler API
Plex Collections API
Plex Content API
Plex Devices API
Plex Download Queue API
Plex DV Rs API
Plex Events API
Plex General API
Plex Hubs API
Where this information came from

This is an independent, third-party profile of Plex EPG API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.