Skip to main content
All endpoints need an admin token. Create endpoints (POST) and updates (PUT) return the saved object.

Sources

Xtream Codes, M3U and HDHomeRun sources. Main fields: name, type, url, username, password (Xtream Codes), enabled, connection_limit, backup_channels, http_origin, http_referer, preferred_output_format, enable_vod. Account details such as account_status, expiration_date and active_connections are read-only.

EPG sources

EPG categories

Your own guide categories. These become the guide’s tabs on every app.
string
required
integer
Tab position
boolean
Mark this as a live event category. On each source refresh, new provider channels whose group matches the category name are enabled automatically, so one-off event channels appear without manual mapping.

Channels and mapping

PUT /channels/mapping takes an array of channels. For each one send its id plus enabled, sort_order, epg_category and filter_group. PUT /channels/{id} accepts any of: name, custom_name, tvg_id / epg_tvg_id and tvg_name / epg_tvg_name (map the channel to guide data), tvg_logo, live_event, channel_type and pip_layout. A channel’s live_event overrides its category’s setting; send null to go back to the category default. Event channels whose names follow the provider pattern (for example NBA 01 Celtics vs. Pistons @ 20 Oct 02:58 PM ET) come back with a cleaned-up display_name (Celtics vs. Pistons) for clients to show.

Channel filters

Rules that include or exclude provider channels automatically. Fields: source_id, filter_type, filter_value, action, enabled.

Picture in Picture channels

A PiP channel is a virtual channel that shows two existing channels at once. Body: name, main_channel_id, pip_channel_id, pip_layout, and optionally epg_category, sort_order and tvg_logo.

Settings and bitrate fallback

With bitrate fallback on, everyone gets the original stream. When one viewer keeps buffering, the channel also starts sending the lighter fallback streams and only that viewer drops to one. Each fallback stream has a resolution, video_bitrate, audio_bitrate and sort_order.

Refresh and sessions

Start times New in 0.9.0

Kernel learns how much buffer each channel needs before its first frame. A channel that stalls on start is moved to a safer tier with a bigger cushion.

Sports team logos New in 0.9.0

Used for the generated matchup artwork on game channels.