Skip to main content

​
Get Live TV Channels

Retrieves a list of available live TV channels with optional filtering and sorting. 
curl -X GET "https://your-server/LiveTv/Channels?limit=50&addCurrentProgram=true" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY"

​
Endpoint

​
method
string
required
GET
​
endpoint
string
required
/LiveTv/Channels

​
Authentication

Requires LiveTvAccess policy authorization.

​
Query Parameters

​
type
ChannelType
Filter by channel type (TV or Radio)
​
userId
string (Guid)
Filter by user and attach user data
​
startIndex
integer
The record index to start at. All items with a lower index will be dropped from the results
​
limit
integer
The maximum number of records to return
​
isMovie
boolean
Filter for movies
​
isSeries
boolean
Filter for series
​
isNews
boolean
Filter for news
​
isKids
boolean
Filter for kids content
​
isSports
boolean
Filter for sports
​
isFavorite
boolean
Filter by channels that are favorites, or not
​
isLiked
boolean
Filter by channels that are liked, or not
​
isDisliked
boolean
Filter by channels that are disliked, or not
​
enableImages
boolean
Include image information in output
​
imageTypeLimit
integer
The max number of images to return, per image type
​
enableImageTypes
array
The image types to include in the output (comma-delimited)
​
fields
array
Additional fields of information to return in the output (comma-delimited)
​
enableUserData
boolean
Include user data
​
sortBy
array
Key to sort by (comma-delimited)
​
sortOrder
string
Sort order: Ascending or Descending
​
enableFavoriteSorting
boolean
default:"false"
Incorporate favorite and like status into channel sorting
​
addCurrentProgram
boolean
default:"true"
Adds current program info to each channel

​
Response

​
Items
array
Array of channel items
​
TotalRecordCount
integer
Total number of available channels
​
StartIndex
integer
Starting index of the returned results

​
Status Codes

  • 200 - Available live TV channels returned successfully
  • 401 - Unauthorized (missing or invalid authentication)
  • 403 - Forbidden (user lacks LiveTvAccess policy)

​
Get Live TV Channel

Retrieves detailed information about a specific live TV channel. 
curl -X GET "https://your-server/LiveTv/Channels/{channelId}" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY"

​
Endpoint

​
method
string
required
GET
​
endpoint
string
required
/LiveTv/Channels/{channelId}

​
Authentication

Requires LiveTvAccess policy authorization.

​
Path Parameters

​
channelId
string (Guid)
required
The channel ID

​
Query Parameters

​
userId
string (Guid)
Attach user data for this user

​
Response

​
BaseItemDto
object
Detailed channel information

​
Status Codes

  • 200 - Live TV channel returned successfully
  • 404 - Channel not found
  • 401 - Unauthorized
  • 403 - Forbidden

​
Get Channel Mapping Options

Retrieves available channel mapping options for a listings provider. 
curl -X GET "https://your-server/LiveTv/ChannelMappingOptions?providerId=PROVIDER_ID" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY"

​
Endpoint

​
method
string
required
GET
​
endpoint
string
required
/LiveTv/ChannelMappingOptions

​
Authentication

Requires LiveTvAccess policy authorization.

​
Query Parameters

​
providerId
string
The provider ID to get mapping options for

​
Response

​
ChannelMappingOptionsDto
object
Channel mapping options

​
Status Codes

  • 200 - Channel mapping options returned successfully
  • 401 - Unauthorized
  • 403 - Forbidden

​
Set Channel Mappings

Creates or updates channel mappings between tuner channels and provider channels. 
curl -X POST "https://your-server/LiveTv/ChannelMappings" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "providerId": "provider-id",
    "tunerChannelId": "tuner-channel-id",
    "providerChannelId": "provider-channel-id"
  }'

​
Endpoint

​
method
string
required
POST
​
endpoint
string
required
/LiveTv/ChannelMappings

​
Authentication

Requires LiveTvManagement policy authorization.

​
Request Body

​
providerId
string
required
The provider ID
​
tunerChannelId
string
required
The tuner channel ID
​
providerChannelId
string
required
The provider channel ID

​
Response

​
TunerChannelMapping
object
Created channel mapping information

​
Status Codes

  • 200 - Channel mapping created successfully
  • 401 - Unauthorized
  • 403 - Forbidden (requires LiveTvManagement policy)
  • 400 - Bad request (invalid data)

Build docs developers (and LLMs) love

Get started for freeTalk to us