Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Users can request programs scheduled on channels. Programs are imported by importers. Programs are returned based on channels and within a window starting from 04:00 AM on the given date until 04:00 AM on the following date. The result is cacheable.

...

EndpointHttp methodPurpose
/api/metadata/v1/channels/{channel_id}/{date}/broadcast_slotsGETGet a list of broadcast slots based on channel_id within a window starting from 04:00 AM on the given date until 04:00 AM on the following date.

This is a public API that requires no authentication.

...

Each API call returns the broadcast schedule for one channel starting from 04:00 in the morning of the requested day to 04:00 the following day. Clients should query only the data that is displayed on screen or is expected to be displayed soon, asynchronously querying more data as the user scrolls it into view. Data should be cached locally according to the cache control header. ETag should be used for cache validation to save bandwidth.

Info

The timezone for the request will be the local timezone of the server, not the client. That means that the API will return the same schedule regardless of the timezone that the request is coming from. This ought to be the timezone that makes most sense for the channel's viewing schedule.


Each broadcast slot has a related Meta program that contains detailed data about the content aired in that slot. For convenience, some of that metadata is included in the broadcast slot object in the "program" attribute. This data can be used to display content information in the schedule view. If more detailed data is needed, it can be retrieved from the Program Metadata API.

...