v1

latestSwagger 2.02026-07-1318080.4 KB
Channel

Channel Collection

If you are interested in a list of channels that have had there schedule updated you can filter by the following query params.

  • scheduleStart
  • scheduleEnd
  • scheduleUpdatedSince

adding these query params will filter the channel collection to only return channels that have been updated within the given range, updatedSince stores the state of your previous call.

Example Usage: Every 10 minutes get me the channels that have updated schedules for the next 2 weeks.

/channel?platform={uuid}&scheduleStart={today}&scheduleEnd={today + 2 weeks}&updatedSince={10 minutes ago}

Also please note epg numbers are only exposed when a platform and region are passed to the query.

get/channel

Query parameters

platformIdstring

The identifier for the selected platform. Multiple platforms can be passed to the API without a region Id. Passing multiple platforms without a region will not return epg numbers as these are linked to a platform and region.

regionIdstring

The platform region ID for the channel selection.

aliasesboolean

Flag to display Legacy and Provider Ids.

datestring

Date of the Channel State to select, this will display channel names and attributes in the future or past.

scheduleStartstring

The Start Date for the schedule.

scheduleEndstring

The End Date for the schedule.

scheduleUpdatedSincestring

Schedule Updated Since

Response

OK

object required