v1

latestOpenAPI 3.0.12026-07-134082641.7 MB

LiveTv

Gets available live tv epgs.

post/LiveTv/Programs

Request body

ChannelIdsstring[] nullable

Gets or sets the channels to return guide information for.

UserIdstring uuid

Gets or sets optional. Filter by user id.

MinStartDatestring date-time nullable

Gets or sets the minimum premiere start date. Optional.

HasAiredboolean nullable

Gets or sets filter by programs that have completed airing, or not. Optional.

IsAiringboolean nullable

Gets or sets filter by programs that are currently airing, or not. Optional.

MaxStartDatestring date-time nullable

Gets or sets the maximum premiere start date. Optional.

MinEndDatestring date-time nullable

Gets or sets the minimum premiere end date. Optional.

MaxEndDatestring date-time nullable

Gets or sets the maximum premiere end date. Optional.

IsMovieboolean nullable

Gets or sets filter for movies. Optional.

IsSeriesboolean nullable

Gets or sets filter for series. Optional.

IsNewsboolean nullable

Gets or sets filter for news. Optional.

IsKidsboolean nullable

Gets or sets filter for kids. Optional.

IsSportsboolean nullable

Gets or sets filter for sports. Optional.

StartIndexinteger nullable

Gets or sets the record index to start at. All items with a lower index will be dropped from the results. Optional.

Limitinteger nullable

Gets or sets the maximum number of records to return. Optional.

SortBystring nullable

Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate. Optional.

SortOrderstring nullable

Gets or sets sort Order - Ascending,Descending.

Genresstring[] nullable

Gets or sets the genres to return guide information for.

GenreIdsstring[] nullable

Gets or sets the genre ids to return guide information for.

EnableImagesboolean nullable

Gets or sets include image information in output. Optional.

EnableTotalRecordCountboolean

Gets or sets a value indicating whether retrieve total record count.

ImageTypeLimitinteger nullable

Gets or sets the max number of images to return, per image type. Optional.

EnableImageTypesImageType[] nullable

Gets or sets the image types to include in the output. Optional.

EnableUserDataboolean nullable

Gets or sets include user data. Optional.

SeriesTimerIdstring nullable

Gets or sets filter by series timer id. Optional.

LibrarySeriesIdstring uuid

Gets or sets filter by library series id. Optional.

FieldsItemFields[] nullable

Gets or sets specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. Optional.

Response

Live tv epgs returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.