Differences

This shows you the differences between two versions of the page.

--- dvr:xmltv [2026/02/14 08:14] – neds
+++ dvr:xmltv [2026/02/14 08:31] (current) – [History] neds
@@ Line 3: / Line 3: @@
 <WRAP center info>
-This is a mirror of the documentation from: https://github.com/Silicondust/documentation/wiki
+This is a mirror of the documentation from: https://github.com/Silicondust/documentation/wiki/XMLTV-Guide-Data
 </WRAP>
-<lead>If you have a [[:DVR:activation|Full Guide subscription]] you can use the 14-day HDHomeRun guide data via an XMLTV file.</lead>
+<lead>14 day XMLTV guide data is available for HDHomeRun customers to use with third party apps. At least one HDHomeRun tuner and a paid [[:DVR:activation|HDHomeRun DVR guide subscription]] is required to use this API.</lead>
-===== API =====
+====API URL====
+<WRAP indent>
+GET<code>https://api.hdhomerun.com/api/xmltv</code>
-{{tag>DVR|Development}}
+</WRAP>
+====API Parameters====
+<WRAP indent>
+^ Parameter ^ Type ^ Description ^
+| DeviceAuth | string | Concatenation of the DeviceAuth strings from all HDHomeRun tuners. |
+OR
+^ Parameter ^ Type ^ Description ^
+| Email | string | Email address associated with the DVR account |
+| DeviceIDs | string | Comma-separated list of DeviceIDs |
+</WRAP>
+==== Additional requirements ====
+<WRAP indent>
+  * 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.
+</WRAP>
+==== Example ====
+<WRAP indent>
+<code>curl --compressed "https://api.hdhomerun.com/api/xmltv?DeviceAuth=xxx" > guide.xml</code>
+<code>curl --compressed "https://api.hdhomerun.com/api/xmltv?Email=xxx&DeviceIDs=xxx,xxx,xxx" > guide.xml</code>
+</WRAP>
+====History====
+<WRAP indent>
+  * 20251026:
+    * URL must be quoted in most shells.
+  * 20251025:
+    * New Email+DeviceIDs access approach.
+    * Clarifications.
+  * 20251023:
+    * Add note regarding scheduling the download.
+  * 20250928:
+    * Initial documentation.
+Copyright © 2016-2025 Silicondust USA Inc. <www.silicondust.com>.
+</WRAP>
+{{tag>DVR}}
+{{tag>development}}

dvr development