TvGrid

get

Get lineups by postal code.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

PostalCodestringRequired

Postal code.

LineupTypestring · enumOptional

Filter by lineup type, valid types are OTA, SAT, CAB, IPTV.

Possible values:
ProviderIdstringOptional

Filter by provider ID

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'brief'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaLineupResponse

lineupIDstringOptional
lineupNamestringOptional
lineupTypestringOptional
providerIDstringOptional
providerNamestringOptional
serviceAreastringOptional
countrystringOptional
get
/lineups
get

Gets list of sports leagues.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaLeagueResponse

leagueIDstringOptional
leagueNamestringOptional
logostringOptional
get
/leagues
get

Starting point for lineup browser, returns available countries.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaCountryResponse

countryIDstringOptional
countryNamestringOptional
get
/lineups/browse
get

Get lineups by latitude and longitude.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Latitudenumber · floatRequired

Latitude (geographic coordinate).

Longitudenumber · floatRequired

Longitude (geographic coordinate).

LineupTypestring · enumOptional

Filter by lineup type, valid types are OTA, SAT, CAB, IPTV.

Possible values:
ProviderIdstringOptional

Filter by provider ID

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'brief'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaLineupResponse

lineupIDstringOptional
lineupNamestringOptional
lineupTypestringOptional
providerIDstringOptional
providerNamestringOptional
serviceAreastringOptional
countrystringOptional
get
/lineups/geo
get

Get lineups by specific LineupID.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
LineupIDstringRequired

Lineup ID.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaLineupResponse

lineupIDstringOptional
lineupNamestringOptional
lineupTypestringOptional
providerIDstringOptional
providerNamestringOptional
serviceAreastringOptional
countrystringOptional
get
/lineups/{LineupID}
get

Get list of generic lineup IDs that can be used. A 'generic' lineup is not a real lineup, but a collection of stations defined by TV Media. Any listing retrieved using a generic lineup will not return any channel number information, as it is irrelevant.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'brief'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaLineupResponse

lineupIDstringOptional
lineupNamestringOptional
lineupTypestringOptional
providerIDstringOptional
providerNamestringOptional
serviceAreastringOptional
countrystringOptional
get
/reference/lineups
get

Gets station details by ID.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
StationIDinteger · int32Required

Station ID. Station ID's can be found in listings, or by using the Tvmedia/lineups API

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaStationResponse

stationIDinteger · int32Optional
namestringOptional
callsignstringOptional
networkstringOptional
stationTypestringOptional
NTSC_TSIDinteger · int32Optional
DTV_TSIDinteger · int32Optional
TwitterstringOptional
webLinkstringOptional
logoFilenamestringOptional
stationHDbooleanOptional
get
/stations/{StationID}
get

Gets list of movie genres.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaGenreResponse

genreIDstringOptional
genrestringOptional
get
/genres/movies
get

Gets list of show genres.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaGenreResponse

genreIDstringOptional
genrestringOptional
get
/genres/shows
get

Gets list of sports genres.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaGenreResponse

genreIDstringOptional
genrestringOptional
get
/genres/sports
get

Gets details for a specific team.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
TeamIDinteger · int32Required

Team ID.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaTeamResponse

teamIDinteger · int32Optional
leagueIDstringOptional
longNamestringOptional
mediumNamestringOptional
shortNamestringOptional
logostringOptional
get
/teams/{TeamID}
get

Browse regions by country.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
CountryIDstringRequired

Country abbreviation. See TvMedia/lineups/browse for a list of supported countries.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaRegionResponse

regionIDstringOptional
regionNamestringOptional
get
/lineups/browse/{CountryID}
get

Retrieve individual listings for a given lineup ordered by start time (listDateTime) and channel number; unless using the search parameter, in which case they will be ordered by search term relevance.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
LineupIDstringRequired

Lineup ID.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Startstring · date-timeOptional

UTC start time in ISO8601. Defaults to current date and time.

Endstring · date-timeOptional

UTC end time in ISO8601. Defaults to 'start' time +4 hours.

TimeZoneinteger · int32Optional

Set a timezone or time offset for listing times (listDateTime property). Defaults to UTC, accepts time offsets (+/-HH:MM) or named time zones (see IANA Time Zone Database). If an invalid value is set, listDateTime will be returned as empty. NOTE: this parameter does not affect input values; start and end times must still be provided in UTC.

Channelstring[]Optional

Include only channel(s) with this number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property , NOT channel.channelNumber property).

ExcludeChanstring[]Optional

Exclude channels by number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property, NOT the channel.channelNumber property).

StartChanstring[]Optional

Lowest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1.

EndChanstring[]Optional

Highest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1. In general this parameter should rarely be used, for shaping the grid size see the 'maxchan' parameter.

Stationinteger · int32[]Optional

Filter by station ID. Array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

ExcludeStationinteger · int32[]Optional

Filter out station IDs; array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

SearchstringOptional

search value: can be a show, episode, movie, team, league, person, etc. Results will be sorted by relevance rather than time.

ShowTypestring[]Optional

Include only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

ExcludeShowTypestring[]Optional

Exclude only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

Idstring[]Optional

ListingID, array or single values accepted. to return a single listing it should be used in combination with a stationID (station parameter).

SportTypestring[]Optional

Get only sports listings of type sportTypeID. Array or single values accepted. For a list of possible values see /genres/sports.

Leaguestring[]Optional

Get only sports listings in the given league ID(s). Array or single values accepted. For a list of possible values see /leagues.

Teamstring[]Optional

Filter by teams playing by name(teams.longName). Array or single values accepted, for a list of possible values see /leagues/teams. (NOTE: league parameter is required when using this parameter).

NotYetStartedbooleanOptional

Only displays listings which are starting on or after the given start time. No value necessary.

SportEventsOnlybooleanOptional

Get sporting events only. No value necessary.

DescriptiveVideoOnlybooleanOptional

Only displays listings which are flagged as being broadcast with Descriptive Video. No value necessary.

LiveOnlybooleanOptional

Only displays live listings. No value necessary.

NewShowsOnlybooleanOptional

Get new shows only. No value necessary.

AdultContentbooleanOptional

Defaults to 1 (allowed). Set to 0 to hide adult content.

DisplayArtworkbooleanOptional

Displays the Artwork information. Set to 1 to include, 1 is default. 0 to hide (will improve performance).

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaListingResponse

PremieresAndFinalesOnlybooleanOptional
numberstringOptional
channelNumberinteger · int32Optional
subChannelNumberinteger · int32Optional
stationIDinteger · int32Optional
namestringOptional
callsignstringOptional
networkstringOptional
stationTypestringOptional
webLinkstringOptional
logoFilenamestringOptional
listingIDinteger · int32Optional
listDateTimestringOptional
durationinteger · int32Optional
showIDinteger · int32Optional
seriesIDinteger · int32Optional
showNamestringOptional
episodeTitlestringOptional
episodeNumberstringOptional
partsinteger · int32Optional
partNuminteger · int32Optional
seriesPremierebooleanOptional
seasonPremierebooleanOptional
seriesFinalebooleanOptional
seasonFinalebooleanOptional
repeatbooleanOptional
isNewbooleanOptional
ratingstringOptional
captionedbooleanOptional
educationalbooleanOptional
blackWhitebooleanOptional
subtitledbooleanOptional
livebooleanOptional
hdbooleanOptional
descriptiveVideobooleanOptional
inProgressbooleanOptional
showTypeIDstringOptional
breakoutLevelinteger · int32Optional
showTypestringOptional
yearstringOptional
gueststringOptional
caststringOptional
directorstringOptional
starRatinginteger · int32Optional
descriptionstringOptional
leaguestringOptional
team1IDinteger · int32Optional
team2IDinteger · int32Optional
team1stringOptional
team2stringOptional
eventNamestringOptional
locationstringOptional
showPicturestringOptional
showHoststringOptional
get
/lineups/{LineupID}/listings

Stations are not tied to lineups, therefore no channel numbers will be present in the response, unlike most other listing operations.

get

Get listings for a given station.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
StationIDinteger · int32Required

Station ID. Station ID's can be found in listings, or by using the Tvmedia/lineups API

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Startstring · date-timeOptional

UTC start time in ISO8601. Defaults to current date and time.

Endstring · date-timeOptional

UTC end time in ISO8601. Defaults to 'start' time +4 hours.

TimeZoneinteger · int32Optional

Set a timezone or time offset for listing times (listDateTime property). Defaults to UTC, accepts time offsets (+/-HH:MM) or named time zones (see IANA Time Zone Database). If an invalid value is set, listDateTime will be returned as empty. NOTE: this parameter does not affect input values; start and end times must still be provided in UTC.

SearchstringOptional

search value: can be a show, episode, movie, team, league, person, etc. Results will be sorted by relevance rather than time.

ShowTypestring[]Optional

Include only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

ExcludeShowTypestring[]Optional

Exclude only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

Idstring[]Optional

ListingID, array or single values accepted. to return a single listing it should be used in combination with a stationID (station parameter).

Showstring[]Optional

Get listings for a specific showID, or array of showID's. ShowID's represent a single episode, movie, or event. a showID, episodeID and movieID are all valid parameters.

Seriesstring[]Optional

Get listings for a specific seriesID or array of seriesID's. A seriesID represents a collection of showID's, such as a TV Series.

SportTypestring[]Optional

Get only sports listings of type sportTypeID. Array or single values accepted. For a list of possible values see /genres/sports.

Leaguestring[]Optional

Get only sports listings in the given league ID(s). Array or single values accepted. For a list of possible values see /leagues.

Teamstring[]Optional

Filter by teams playing by name(teams.longName). Array or single values accepted, for a list of possible values see /leagues/teams. (NOTE: league parameter is required when using this parameter).

NotYetStartedbooleanOptional

Only displays listings which are starting on or after the given start time. No value necessary.

SportEventsOnlybooleanOptional

Get sporting events only. No value necessary.

DescriptiveVideoOnlybooleanOptional

Only displays listings which are flagged as being broadcast with Descriptive Video. No value necessary.

LiveOnlybooleanOptional

Only displays live listings. No value necessary.

NewShowsOnlybooleanOptional

Get new shows only. No value necessary.

AdultContentbooleanOptional

Defaults to 1 (allowed). Set to 0 to hide adult content.

DisplayArtworkbooleanOptional

Displays the Artwork information. Set to 1 to include, 1 is default. 0 to hide (will improve performance).

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaShortListingResponse

listingIDinteger · int32Optional
listDateTimestringOptional
durationinteger · int32Optional
showIDinteger · int32Optional
seriesIDinteger · int32Optional
showNamestringOptional
episodeTitlestringOptional
episodeNumberstringOptional
partsinteger · int32Optional
partNuminteger · int32Optional
seriesPremierebooleanOptional
seasonPremierebooleanOptional
seriesFinalebooleanOptional
seasonFinalebooleanOptional
repeatbooleanOptional
isNewbooleanOptional
ratingstringOptional
captionedbooleanOptional
educationalbooleanOptional
blackWhitebooleanOptional
subtitledbooleanOptional
livebooleanOptional
hdbooleanOptional
descriptiveVideobooleanOptional
inProgressbooleanOptional
showTypeIDstringOptional
breakoutLevelinteger · int32Optional
showTypestringOptional
yearstringOptional
gueststringOptional
caststringOptional
directorstringOptional
starRatinginteger · int32Optional
descriptionstringOptional
leaguestringOptional
team1IDinteger · int32Optional
team2IDinteger · int32Optional
team1stringOptional
team2stringOptional
eventNamestringOptional
locationstringOptional
showPicturestringOptional
showHoststringOptional
get
/stations/{StationID}/listings
get

Gets list of teams in a league.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
LeagueIDstringRequired

League ID. See /TvMedia/leagues for a list of all available sports leagues.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaTeamResponse

teamIDinteger · int32Optional
leagueIDstringOptional
longNamestringOptional
mediumNamestringOptional
shortNamestringOptional
logostringOptional
get
/leagues/{LeagueID}/teams
get

Retrieve listings for a given leagueID.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
LeagueIDstringRequired

League ID. See /leagues for a list of all available sports leagues.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

LineupIDstringRequired

Lineup ID. Lineups can be found through the /TvMedia/lineups method.

Startstring · date-timeOptional

UTC start time in ISO8601. Defaults to current date and time.

Endstring · date-timeOptional

UTC end time in ISO8601. Defaults to 'start' time +4 hours.

TimeZoneinteger · int32Optional

Set a timezone or time offset for listing times (listDateTime property). Defaults to UTC, accepts time offsets (+/-HH:MM) or named time zones (see IANA Time Zone Database). If an invalid value is set, listDateTime will be returned as empty. NOTE: this parameter does not affect input values; start and end times must still be provided in UTC.

Channelstring[]Optional

Include only channel(s) with this number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property , NOT channel.channelNumber property).

ExcludeChanstring[]Optional

Exclude channels by number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property, NOT the channel.channelNumber property).

StartChanstring[]Optional

Lowest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1.

EndChanstring[]Optional

Highest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1. In general this parameter should rarely be used, for shaping the grid size see the 'maxchan' parameter.

Stationinteger · int32[]Optional

Filter by station ID. Array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

ExcludeStationinteger · int32[]Optional

Filter out station IDs; array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

SearchstringOptional

search value: can be a show, episode, movie, team, league, person, etc. Results will be sorted by relevance rather than time.

ShowTypestring[]Optional

Include only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

ExcludeShowTypestring[]Optional

Exclude only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

Idstring[]Optional

ListingID, array or single values accepted. to return a single listing it should be used in combination with a stationID (station parameter).

NotYetStartedbooleanOptional

Only displays listings which are starting on or after the given start time. No value necessary.

SportEventsOnlybooleanOptional

Get sporting events only. No value necessary.

DescriptiveVideoOnlybooleanOptional

Only displays listings which are flagged as being broadcast with Descriptive Video. No value necessary.

LiveOnlybooleanOptional

Only displays live listings. No value necessary.

AdultContentbooleanOptional

Defaults to 1 (allowed). Set to 0 to hide adult content.

DisplayArtworkbooleanOptional

Displays the Artwork information. Set to 1 to include, 1 is default. 0 to hide (will improve performance).

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaListingResponse

PremieresAndFinalesOnlybooleanOptional
numberstringOptional
channelNumberinteger · int32Optional
subChannelNumberinteger · int32Optional
stationIDinteger · int32Optional
namestringOptional
callsignstringOptional
networkstringOptional
stationTypestringOptional
webLinkstringOptional
logoFilenamestringOptional
listingIDinteger · int32Optional
listDateTimestringOptional
durationinteger · int32Optional
showIDinteger · int32Optional
seriesIDinteger · int32Optional
showNamestringOptional
episodeTitlestringOptional
episodeNumberstringOptional
partsinteger · int32Optional
partNuminteger · int32Optional
seriesPremierebooleanOptional
seasonPremierebooleanOptional
seriesFinalebooleanOptional
seasonFinalebooleanOptional
repeatbooleanOptional
isNewbooleanOptional
ratingstringOptional
captionedbooleanOptional
educationalbooleanOptional
blackWhitebooleanOptional
subtitledbooleanOptional
livebooleanOptional
hdbooleanOptional
descriptiveVideobooleanOptional
inProgressbooleanOptional
showTypeIDstringOptional
breakoutLevelinteger · int32Optional
showTypestringOptional
yearstringOptional
gueststringOptional
caststringOptional
directorstringOptional
starRatinginteger · int32Optional
descriptionstringOptional
leaguestringOptional
team1IDinteger · int32Optional
team2IDinteger · int32Optional
team1stringOptional
team2stringOptional
eventNamestringOptional
locationstringOptional
showPicturestringOptional
showHoststringOptional
get
/leagues/{LeagueID}/listings
get

Retrieve listings for a given TeamID.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
TeamIDinteger · int32Required

Team ID. See /teams for a list of all available sports teams.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

LineupIDstringRequired

Lineup ID. Lineups can be found through the /TvMedia/lineups method.

Startstring · date-timeOptional

UTC start time in ISO8601. Defaults to current date and time.

Endstring · date-timeOptional

UTC end time in ISO8601. Defaults to 'start' time +4 hours.

TimeZoneinteger · int32Optional

Set a timezone or time offset for listing times (listDateTime property). Defaults to UTC, accepts time offsets (+/-HH:MM) or named time zones (see IANA Time Zone Database). If an invalid value is set, listDateTime will be returned as empty. NOTE: this parameter does not affect input values; start and end times must still be provided in UTC.

Channelstring[]Optional

Include only channel(s) with this number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property , NOT channel.channelNumber property).

ExcludeChanstring[]Optional

Exclude channels by number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property, NOT the channel.channelNumber property).

StartChanstring[]Optional

Lowest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1.

EndChanstring[]Optional

Highest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1. In general this parameter should rarely be used, for shaping the grid size see the 'maxchan' parameter.

Stationinteger · int32[]Optional

Filter by station ID. Array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

ExcludeStationinteger · int32[]Optional

Filter out station IDs; array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

SearchstringOptional

search value: can be a show, episode, movie, team, league, person, etc. Results will be sorted by relevance rather than time.

ShowTypestring[]Optional

Include only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

ExcludeShowTypestring[]Optional

Exclude only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

Idstring[]Optional

ListingID, array or single values accepted. to return a single listing it should be used in combination with a stationID (station parameter).

NotYetStartedbooleanOptional

Only displays listings which are starting on or after the given start time. No value necessary.

SportEventsOnlybooleanOptional

Get sporting events only. No value necessary.

DescriptiveVideoOnlybooleanOptional

Only displays listings which are flagged as being broadcast with Descriptive Video. No value necessary.

LiveOnlybooleanOptional

Only displays live listings. No value necessary.

AdultContentbooleanOptional

Defaults to 1 (allowed). Set to 0 to hide adult content.

DisplayArtworkbooleanOptional

Displays the Artwork information. Set to 1 to include, 1 is default. 0 to hide (will improve performance).

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaListingResponse

PremieresAndFinalesOnlybooleanOptional
numberstringOptional
channelNumberinteger · int32Optional
subChannelNumberinteger · int32Optional
stationIDinteger · int32Optional
namestringOptional
callsignstringOptional
networkstringOptional
stationTypestringOptional
webLinkstringOptional
logoFilenamestringOptional
listingIDinteger · int32Optional
listDateTimestringOptional
durationinteger · int32Optional
showIDinteger · int32Optional
seriesIDinteger · int32Optional
showNamestringOptional
episodeTitlestringOptional
episodeNumberstringOptional
partsinteger · int32Optional
partNuminteger · int32Optional
seriesPremierebooleanOptional
seasonPremierebooleanOptional
seriesFinalebooleanOptional
seasonFinalebooleanOptional
repeatbooleanOptional
isNewbooleanOptional
ratingstringOptional
captionedbooleanOptional
educationalbooleanOptional
blackWhitebooleanOptional
subtitledbooleanOptional
livebooleanOptional
hdbooleanOptional
descriptiveVideobooleanOptional
inProgressbooleanOptional
showTypeIDstringOptional
breakoutLevelinteger · int32Optional
showTypestringOptional
yearstringOptional
gueststringOptional
caststringOptional
directorstringOptional
starRatinginteger · int32Optional
descriptionstringOptional
leaguestringOptional
team1IDinteger · int32Optional
team2IDinteger · int32Optional
team1stringOptional
team2stringOptional
eventNamestringOptional
locationstringOptional
showPicturestringOptional
showHoststringOptional
get
/teams/{TeamID}/listings
get

Get service areas for a specific country and region.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
CountryIDstringRequired

Country abbreviation. See TvMedia/lineups/browse for a list of supported countries.

RegionIDstringRequired

Region abbreviation. See TvMedia/lineups/browse/{CountryID} for a list of regions.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaServiceAreaResponse

areaIDstringOptional
areaNamestringOptional
get
/lineups/browse/{CountryID}/{RegionID}
get

Retrieves featured listings. setting a start and/or end time for every request is a highly recommended.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
LineupIDstringRequired

Lineup ID.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Startstring · date-timeOptional

UTC start time in ISO8601. Defaults to current date and time.

Endstring · date-timeOptional

UTC end time in ISO8601. Defaults to 'start' time +4 hours.

TimeZoneinteger · int32Optional

Set a timezone or time offset for listing times (listDateTime property). Defaults to UTC, accepts time offsets (+/-HH:MM) or named time zones (see IANA Time Zone Database). If an invalid value is set, listDateTime will be returned as empty. NOTE: this parameter does not affect input values; start and end times must still be provided in UTC.

Channelstring[]Optional

Include only channel(s) with this number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property , NOT channel.channelNumber property).

ExcludeChanstring[]Optional

Exclude channels by number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property, NOT the channel.channelNumber property).

StartChanstring[]Optional

Lowest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1.

EndChanstring[]Optional

Highest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1. In general this parameter should rarely be used, for shaping the grid size see the 'maxchan' parameter.

Stationinteger · int32[]Optional

Filter by station ID. Array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

ExcludeStationinteger · int32[]Optional

Filter out station IDs; array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

SearchstringOptional

search value: can be a show, episode, movie, team, league, person, etc. Results will be sorted by relevance rather than time.

ShowTypestring[]Optional

Include only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

ExcludeShowTypestring[]Optional

Exclude only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

Idstring[]Optional

ListingID, array or single values accepted. to return a single listing it should be used in combination with a stationID (station parameter).

Seriesstring[]Optional

Get listings for a specific seriesID or array of seriesID's. A seriesID represents a collection of showID's, such as a TV Series.

NotYetStartedbooleanOptional

Only displays listings which are starting on or after the given start time. No value necessary.

NewShowstsOnlybooleanOptional

Get new shows only. no value necessary.

DescriptiveVideoOnlybooleanOptional

Only displays listings which are flagged as being broadcast with Descriptive Video. No value necessary.

LiveOnlybooleanOptional

Only displays live listings. No value necessary.

IncludeNewShowsbooleanOptional

Get new shows only. No value necessary.

AdultContentbooleanOptional

Defaults to 1 (allowed). Set to 0 to hide adult content.

DisplayArtworkbooleanOptional

Displays the Artwork information. Set to 1 to include, 1 is default. 0 to hide (will improve performance).

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaListingResponse

PremieresAndFinalesOnlybooleanOptional
numberstringOptional
channelNumberinteger · int32Optional
subChannelNumberinteger · int32Optional
stationIDinteger · int32Optional
namestringOptional
callsignstringOptional
networkstringOptional
stationTypestringOptional
webLinkstringOptional
logoFilenamestringOptional
listingIDinteger · int32Optional
listDateTimestringOptional
durationinteger · int32Optional
showIDinteger · int32Optional
seriesIDinteger · int32Optional
showNamestringOptional
episodeTitlestringOptional
episodeNumberstringOptional
partsinteger · int32Optional
partNuminteger · int32Optional
seriesPremierebooleanOptional
seasonPremierebooleanOptional
seriesFinalebooleanOptional
seasonFinalebooleanOptional
repeatbooleanOptional
isNewbooleanOptional
ratingstringOptional
captionedbooleanOptional
educationalbooleanOptional
blackWhitebooleanOptional
subtitledbooleanOptional
livebooleanOptional
hdbooleanOptional
descriptiveVideobooleanOptional
inProgressbooleanOptional
showTypeIDstringOptional
breakoutLevelinteger · int32Optional
showTypestringOptional
yearstringOptional
gueststringOptional
caststringOptional
directorstringOptional
starRatinginteger · int32Optional
descriptionstringOptional
leaguestringOptional
team1IDinteger · int32Optional
team2IDinteger · int32Optional
team1stringOptional
team2stringOptional
eventNamestringOptional
locationstringOptional
showPicturestringOptional
showHoststringOptional
get
/lineups/{LineupID}/listings/highlights
get

A collection of listings grouped by channel and ordered by listDateTime. The grid dimensions ( time x channels ) can be modified by using the start, end, startchan and maxchan parameters. Channels without any listings will be returned with an empty listings collection.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
LineupIDstringRequired

Lineup ID.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

Startstring · date-timeOptional

UTC start time in ISO8601. Defaults to current date and time.

Endstring · date-timeOptional

UTC end time in ISO8601. Defaults to 'start' time +4 hours.

TimeZoneinteger · int32Optional

Set a timezone or time offset for listing times (listDateTime property). Defaults to UTC, accepts time offsets (+/-HH:MM) or named time zones (see IANA Time Zone Database). If an invalid value is set, listDateTime will be returned as empty. NOTE: this parameter does not affect input values; start and end times must still be provided in UTC.

Channelstring[]Optional

Include only channel(s) with this number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property , NOT channel.channelNumber property).

ExcludeChanstring[]Optional

Exclude channels by number, single or array values accepted. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1 (use the channel.number property, NOT the channel.channelNumber property).

StartChanstring[]Optional

Lowest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1.

EndChanstring[]Optional

Highest channel. sub channel numbers can be hyphenated to the end of the string: e.g. 1-2 for sub channel 2 of channel 1. In general this parameter should rarely be used, for shaping the grid size see the 'maxchan' parameter.

Stationinteger · int32[]Optional

Filter by station ID. Array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

ExcludeStationinteger · int32[]Optional

Filter out station IDs; array or single value accepted. Station ID's can be found in listings, or by using the /lineups Entertainment.

SearchstringOptional

search value: can be a show, episode, movie, team, league, person, etc. Results will be sorted by relevance rather than time.

ShowTypestring[]Optional

Include only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

ExcludeShowTypestring[]Optional

Exclude only these show type ID(s), array or single values accepted. Must be URL encoded. For a list of possible show type's and their ID's see /genres/shows, or the showTypeID property of a listing object.

Idstring[]Optional

ListingID, array or single values accepted. to return a single listing it should be used in combination with a stationID (station parameter).

Showstring[]Optional

Get listings for a specific showID, or array of showID's. ShowID's represent a single episode, movie, or event. a showID, episodeID and movieID are all valid parameters.

Seriesstring[]Optional

Get listings for a specific seriesID or array of seriesID's. A seriesID represents a collection of showID's, such as a TV Series.

SportTypestring[]Optional

Get only sports listings of type sportTypeID. Array or single values accepted. For a list of possible values see /genres/sports.

Leaguestring[]Optional

Get only sports listings in the given league ID(s). Array or single values accepted. For a list of possible values see /leagues.

Teamstring[]Optional

Filter by teams playing by name(teams.longName). Array or single values accepted, for a list of possible values see /leagues/teams. (NOTE: league parameter is required when using this parameter).

NotYetStartedbooleanOptional

Only displays listings which are starting on or after the given start time. No value necessary.

SportEventsOnlybooleanOptional

Get sporting events only. No value necessary.

DescriptiveVideoOnlybooleanOptional

Only displays listings which are flagged as being broadcast with Descriptive Video. No value necessary.

LiveOnlybooleanOptional

Only displays live listings. No value necessary.

NewShowsOnlybooleanOptional

Get new shows only. No value necessary.

AdultContentbooleanOptional

Defaults to 1 (allowed). Set to 0 to hide adult content.

DisplayArtworkbooleanOptional

Displays the Artwork information. Set to 1 to include, 1 is default. 0 to hide (will improve performance).

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'full'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaGridResponse

get
/lineups/{LineupID}/listings/grid
get

Get lineups by AreaID.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Path parameters
CountryIDstringRequired

Country abbreviation. See TvMedia/lineups/browse for a list of supported countries.

RegionIDstringRequired

Region abbreviation. See TvMedia/lineups/browse/{CountryID} for a list of regions.

AreaIDstringRequired

Service area ID. See TvMedia/lineups/browse/{CountryID}/{RegionID} for a list of service areas.

Query parameters
TvMediaApiKeystringRequired

API Key supplied by TvMedia.ca

LineupTypestring · enumOptional

Filter by lineup type, valid types are OTA, SAT, CAB, IPTV.

Possible values:
ProviderIdstringOptional

Filter by provider ID

Detailstring · enumOptional

Set level of detail for response. values are 'full' or 'brief', defaults to 'brief'. 'full' will include all properties, 'brief' will exclude optional properties.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

TvMediaLineupResponse

lineupIDstringOptional
lineupNamestringOptional
lineupTypestringOptional
providerIDstringOptional
providerNamestringOptional
serviceAreastringOptional
countrystringOptional
get
/lineups/browse/{CountryID}/{RegionID}/{AreaID}

Last updated