This is an old revision of the document!
HDHomeRun DVR XMLTV API access
This is a mirror of the documentation from: https://github.com/Silicondust/documentation/wiki/XMLTV-Guide-Data
If you have a Full Guide subscription you can use the 14-day HDHomeRun guide data via an XMLTV file.
API
14 day XMLTV guide data is available for HDHomeRun customers to use with third party apps. At least one HDHomeRun tuner and a paid HDHomeRun DVR guide subscription is required to use this API.
API URL
GET
https://api.hdhomerun.com/api/xmltv
API Parameters
| Parameter | Type | Description |
|---|---|---|
| DeviceAuth | string | Concatenation of the DeviceAuth strings from all HDHomeRun tuners. |
OR
| Parameter | Type | Description |
|---|---|---|
| string | Email address associated with the DVR account | |
| DeviceIDs | string | Comma-separated list of DeviceIDs |
Additional requirements
- The HDHomeRun device(s) must be associated with a paid HDHomeRun DVR account to access XMLTV guide data.
- The HTTP client must accept gzip encoding.
- The DeviceAuth changes regularly and is valid for 16-24 hours. If using the DeviceAuth access approach the DeviceAuth must be read from the HDHomeRun tuner(s) to get the latest value each time this API is invoked.
- Do not schedule the download for midnight or a fixed time each day - requests should be made at a random interval. For example, after downloading the xmltv guide, schedule the next download for 20 to 28 hours (randomized delay) in the future.
Example
curl --compressed "https://api.hdhomerun.com/api/xmltv?DeviceAuth=xxx" > guide.xml
curl --compressed "https://api.hdhomerun.com/api/xmltv?Email=xxx&DeviceIDs=xxx,xxx,xxx" > guide.xml