Skip to content

Guide API Guide

nickkelsey edited this page Sep 29, 2025 · 5 revisions

Introduction:

The guide API returns airing information grouped by channel suitable for displaying Live TV guide. Data is available looking forward up to 2 weeks (typical) and looking back up to 2 weeks (typical).

API URL:

GET https://api.hdhomerun.com/api/guide

API Parameters:

Parameter Type Description
DeviceAuth string Concatenation of the DeviceAuth strings from all HDHomeRun tuners
Start int64 Optional. Unix timestamp of the start of the time range requested. Default = current time
Duration uint Optional. Number of seconds of the time range requested. Default = 4 hours, Max = 24 hours
Channel string Optional. Channel number to request guide for. Default = all channels

Result format:

[
    {
        "GuideNumber": "3.1",
        "GuideName": "KTVKDT",
        "ImageURL": "https://img.hdhomerun.com/channels/US30817.png",
        "Guide": [
            {
                "StartTime": 1759111200,
                "EndTime": 1759114800,
                "Title": "Fire Country",
                "EpisodeNumber": "S01E06",
                "EpisodeTitle": "Like Old Times",
                "Synopsis": "After a hiker falls from a steep cliff, Bode and Jake put aside their differences to make a daring rescue; Sharon reveals devasting news to Bode.",
                "OriginalAirdate": 1668729600,
                "SeriesID": "C22213607ENALMC",
                "ImageURL": "https://img.hdhomerun.com/titles/C22213607ENALMC.jpg",
                "RecordingRule": 1,
                "Filter": [
                    "Drama"
                ]
            },
            {
                ...
            }
    {
        ...
    }
]

Additional Details:

Do not use this API to bulk download guide data. Third party apps that maintain guide data should use the XMLTV Guide Data API.

History:

20250928:

  • Initial documentation.

Copyright © 2016-2025 Silicondust USA Inc. <www.silicondust.com>.

Clone this wiki locally